Fix SSR in external docs via node exports
#20083
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Our ESM compilation currently assumes a browser and makes certain optimizations accordingly. That means when SSR, we need to make sure the process uses the CJS imports.
(So it works in SSR)
tmeasday
commented
Dec 4, 2022
| @@ -2,7 +2,6 @@ import React from 'react'; | |||
| import ReactDOM from 'react-dom'; | |||
| import type { Renderer, Parameters, DocsContextProps, DocsRenderFunction } from '@storybook/types'; | |||
| import { Docs, CodeOrSourceMdx, AnchorMdx, HeadersMdx } from '@storybook/blocks'; | |||
| import { MDXProvider } from '@mdx-js/react'; | |||
There was a problem hiding this comment.
This is an ESM only package so must be imported async from CJS
There was a problem hiding this comment.
Is this a big package? would it be possible to have be bundled in by tsup?
You can still have react & react-dom be external if you do that. FYI
But there's probably some singleton module pattern in this for hooking up context? Or would that be coming from react? Probably.
There was a problem hiding this comment.
I'm open to it if you want to discussion @ndelangen. Still it is not a big deal to do it the way I am doing it here.
ndelangen
approved these changes
Dec 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: #19846
What I did
external-docsprojectMutationObserverintouseEffectnodeexports to 3 crucial packages (addon-docs,theming,blocks[1]), to ensure node (SSR) code uses the CJS exports.This is due to the fact that currently our ESM files assume they will run in a browser:
storybook/scripts/prepare/bundle.ts
Line 90 in ab4855e
For this reason it is better to force all node-side code to run through CJS.
[1] Note that strictly speaking
addon-docsand maybethemingisn't necessary, but people may still import blocks from there. We may also want to alter other packages that are imported directly from MDX files. Or we might consider just doing it for all packages. WDYT @ndelangen?What I didn't do
Resolve the
lodashissue (1. in #19846) as it doesn't show up in Nextra (as next uses webpack still I guess with lax ESM settings). We can definitely fix this though, in this branch I got it working in a "pure" SSR situation, although without thinking too hard about how to update the lodash imports: https://github.com/storybookjs/storybook/tree/tom/sb-466-external-docs-exports-from@yannbf I believe you already looked at changing the lodash imports, where did you end up with that? (In any case I don't consider this a difficult problem to solve, it seems we can solve it without doing anything drastic).
How to test
Run
yarn devin theexternal-docspackage. Check each of the pages SSRs.