Add context.storyGlobals

[tmeasday]

Following on from #92 -- add context.storyGlobals.

This is added to the very initial context (ContextForEnhancers) reflecting that we know it from back then.

Later (at render time) we'll also gain context.globals; which is the story's globals combined with the current value of the "user globals". Typically this is what user code would look at.

I'm not sure if we want to also add context.userGlobals to that layer (ContextForEnhancers) -- strictly speaking you cannot infer userGlobals from globals - storyGlobals. Then again it's unclear why you'd want to know the value of an overridden "user global".

Second question: should we make context.storyGlobals nullable, if the story does not set any global overrides?

📦 Published PR as canary version: 0.1.12--canary.95.1b1fb52.0

✨ Test out this PR locally via:

npm install @storybook/[email protected]
# or 
yarn add @storybook/[email protected]

[ndelangen]

Is this change backwards compatible?

[kasperpeulen]

I thought we moved to a different model with initialGlobals and globals

[tmeasday]

@ndelangen

Is this change backwards compatible?

As much as adding anything to the context can be -- users can set arbitrary fields on the context, so theoretically it's possible someone out there is setting context.storyGlobals right now. I'd say it's pretty unlikely though.

@kasperpeulen

I thought we moved to a different model with initialGlobals and globals

globals is the name of the annotation (what you add to the CSF file) you use to set "story globals".

However, the actual calculated context.globals is a combination of context.storyGlobals (what's in the CSF) and the current value of userGlobals (the persisted globals, changed via UI) [not currently on context, see comment at the top of the ticket].

I'm pretty sure we shouldn't change the meaning of context.globals (a) because it'd be a (very) breaking change, and (b) I also think it'd be confusing.

You really only want access to context.storyGlobals to know if a global has been overridden by the current story. It's a specialized thing that typically you wouldn't look at.

[kasperpeulen]

You really only want access to context.storyGlobals to know if a global has been overridden by the current story. It's a specialized thing that typically you wouldn't look at.

But why do we need it then? Why would you want to know the global has been overridden? Except for manager concerns in storybook itself, which can just compare context.globals to the one that is persisted by storybook itself (userGlobals)?

My feeling is that context.globals is all the user needs in the context.

[tmeasday]

We could consider not making available. Certainly addons need it in the manager to determine if a global has been overridden (theoretically you can check if userGlobals.X === globals.X but that's a bit tricky so we made it more explicit). At this stage it hasn't been needed in the preview yet.

One option would be to not put it in the context just yet (and just add it to the PreparedStory type) for now. I'm OK with that if that's your preference @kasperpeulen

[kasperpeulen]

Sounds good to me @tmeasday !