Addon-docs: Fix react-dom/server imports breaking stories and docs

code/addons/docs/src/preset.ts

@@ -147,6 +147,8 @@ export const viteFinal = async (config: any, options: Options) => {
       resolve: {
         alias: {
           react,
+          // Vite doesn't respect export maps when resolving a path, so we need to do that manually here
+          'react-dom/server': `${reactDom}/server.browser.js`,
           'react-dom': reactDom,
           '@mdx-js/react': mdx,
           /**

code/addons/docs/template/stories/docs2/ResolvedReactVersion.jsx → code/addons/docs/template/stories/docs2/ResolvedReact.jsx

@@ -1,7 +1,8 @@
 import React, { version as reactVersion } from 'react';
 import { version as reactDomVersion } from 'react-dom';
+import { version as reactDomServerVersion } from 'react-dom/server';
 
-export const ResolvedReactVersion = () => {
+export const ResolvedReact = () => {
   return (
     <>
       <p>
@@ -10,6 +11,10 @@ export const ResolvedReactVersion = () => {
       <p>
         <code>react-dom</code>: <code data-testid="component-react-dom">{reactDomVersion}</code>
       </p>
+      <p>
+        <code>react-dom/server</code>:{' '}
+        <code data-testid="component-react-dom-server">{reactDomServerVersion}</code>
+      </p>
     </>
   );
 };

code/addons/docs/template/stories/docs2/ResolvedReact.mdx

@@ -1,13 +1,30 @@
+import { Meta } from '@storybook/blocks';
 import { version as reactVersion } from 'react';
 import { version as reactDomVersion } from 'react-dom';
-import { ResolvedReactVersion } from './ResolvedReactVersion';
+import { version as reactDomServerVersion } from 'react-dom/server';
+import * as ResolvedReactStories from './resolved-react.stories';
+import { ResolvedReact } from './ResolvedReact';
+
+<Meta of={ResolvedReactStories} name="MDX"/>
+
+This doc is used to display the resolved version of React and its related packages.
+As long as `@storybook/addon-docs` is installed, `react` and `react-dom` should be available to import from and should resolve to the same version.
+
+The MDX here ensures that it works in an MDX file.
+
+- See the [autodocs](/docs/addons-docs-docs2-resolvedreact--docs) for how it resolves in autodocs.
+- See the [Story](/story/addons-docs-docs2-resolvedreact--story) for how it resolves in the actual story.
+
+**Note: There appears to be a bug in the _production_ build of `react-dom`, where it reports version `18.2.0-next-9e3b772b8-20220608` while in fact version `18.2.0` is installed.**
 
 ## In MDX
 
 <code>react</code>: <code data-testid="mdx-react">{reactVersion}</code>
 
 <code>react-dom</code>: <code data-testid="mdx-react-dom">{reactDomVersion}</code>
 
-## In `ResolvedReactVersion` component
+<code>react-dom/server</code>: <code data-testid="mdx-react-dom-server">{reactDomServerVersion}</code>
+
+## In `ResolvedReact` component
 
-<ResolvedReactVersion />
+<ResolvedReact />

code/addons/docs/template/stories/docs2/resolved-react.stories.ts

@@ -0,0 +1,61 @@
+import { within, expect } from '@storybook/test';
+import { version as reactVersion } from 'react';
+import { version as reactDomVersion } from 'react-dom';
+import { version as reactDomServerVersion } from 'react-dom/server';
+
+/**
+ * This component is used to display the resolved version of React and its related packages.
+ * As long as `@storybook/addon-docs` is installed, `react` and `react-dom` should be available to import from and should resolve to the same version.
+ *
+ * The autodocs here ensures that it also works in the generated documentation.
+ *
+ * - See the [MDX docs](/docs/addons-docs-docs2-resolvedreact--mdx) for how it resolves in MDX.
+ * - See the [Story](/story/addons-docs-docs2-resolvedreact--story) for how it resolves in the actual story.
+ *
+ * **Note: There appears to be a bug in the _production_ build of `react-dom`, where it reports version `18.2.0-next-9e3b772b8-20220608` while in fact version `18.2.0` is installed.**
+ */
+export default {
+  title: 'Docs2/ResolvedReact',
+  component: globalThis.Components.Html,
+  tags: ['autodocs'],
+  argTypes: {
+    content: { table: { disable: true } },
+  },
+  args: {
+    content: `
+  <p>
+  <code>react</code>: <code data-testid="react">${reactVersion}</code>
+  </p>
+  <p>
+  <code>react-dom</code>: <code data-testid="react-dom">${reactDomVersion}</code>
+  </p>
+  <p>
+  <code>react-dom/server</code>: <code data-testid="react-dom-server">${reactDomServerVersion}</code>
+  </p>
+  `,
+  },
+  parameters: {
+    docs: {
+      name: 'ResolvedReact',
+    },
+  },
+};
+
+export const Story = {
+  // This test is more or less the same as the E2E test we have for MDX and autodocs entries in addon-docs.spec.ts
+  play: async ({ canvasElement, step }: any) => {
+    const canvas = await within(canvasElement);
+
+    const actualReactVersion = (await canvas.findByTestId('react')).textContent;
+    const actualReactDomVersion = (await canvas.findByTestId('react-dom')).textContent;
+    const actualReactDomServerVersion = await (
+      await canvas.findByTestId('react-dom-server')
+    ).textContent;
+
+    step('Expect React packages to all resolve to the same version', () => {
+      // react-dom has a bug in its production build, reporting version 18.2.0-next-9e3b772b8-20220608 even though version 18.2.0 is installed.
+      expect(actualReactDomVersion.startsWith(actualReactDomVersion)).toBeTruthy();
+      expect(actualReactVersion).toBe(actualReactDomServerVersion);
+    });
+  },
+};

code/e2e-tests/addon-docs.spec.ts

@@ -185,30 +185,65 @@ test.describe('addon-docs', () => {
   });
 
   test('should resolve react to the correct version', async ({ page }) => {
+    // Arrange - Navigate to MDX docs and setup expectations
     const sbPage = new SbPage(page);
-    await sbPage.navigateToUnattachedDocs('addons/docs/docs2', 'ResolvedReact');
+    await sbPage.navigateToStory('addons/docs/docs2/resolvedreact', 'mdx', 'docs');
     const root = sbPage.previewRoot();
 
-    let expectedReactVersion = /^18/;
+    let expectedReactVersionRange = /^18/;
     if (
       templateName.includes('preact') ||
       templateName.includes('react-webpack/17') ||
       templateName.includes('react-vite/17')
     ) {
-      expectedReactVersion = /^17/;
+      expectedReactVersionRange = /^17/;
     } else if (templateName.includes('react16')) {
-      expectedReactVersion = /^16/;
+      expectedReactVersionRange = /^16/;
     }
 
+    // Arrange - Get the actual versions
     const mdxReactVersion = await root.getByTestId('mdx-react');
     const mdxReactDomVersion = await root.getByTestId('mdx-react-dom');
+    const mdxReactDomServerVersion = await root.getByTestId('mdx-react-dom-server');
     const componentReactVersion = await root.getByTestId('component-react');
     const componentReactDomVersion = await root.getByTestId('component-react-dom');
-
-    await expect(mdxReactVersion).toHaveText(expectedReactVersion);
-    await expect(mdxReactDomVersion).toHaveText(expectedReactVersion);
-    await expect(componentReactVersion).toHaveText(expectedReactVersion);
-    await expect(componentReactDomVersion).toHaveText(expectedReactVersion);
+    const componentReactDomServerVersion = await root.getByTestId('component-react-dom-server');
+
+    // Assert - The versions are in the expected range
+    await expect(mdxReactVersion).toHaveText(expectedReactVersionRange);
+
+    const actualReactVersion = (await mdxReactVersion.textContent())!;
+    // Assert - The versions are all the same
+    // react-dom has a bug in its production build, reporting version 18.2.0-next-9e3b772b8-20220608 even though version 18.2.0 is installed.
+    await expect(mdxReactDomVersion).toHaveText(new RegExp(`^${actualReactVersion}`));
+    await expect(mdxReactDomServerVersion).toHaveText(actualReactVersion);
+    await expect(componentReactVersion).toHaveText(actualReactVersion);
+    await expect(componentReactDomVersion).toHaveText(new RegExp(`^${actualReactVersion}`));
+    await expect(componentReactDomServerVersion).toHaveText(actualReactVersion);
+
+    // Arrange - Navigate to autodocs
+    await sbPage.navigateToStory('addons/docs/docs2/resolvedreact', 'docs');
+
+    // Arrange - Get the actual versions
+    const autodocsReactVersion = await root.getByTestId('react');
+    const autodocsReactDomVersion = await root.getByTestId('react-dom');
+    const autodocsReactDomServerVersion = await root.getByTestId('react-dom-server');
+
+    await expect(autodocsReactVersion).toHaveText(actualReactVersion);
+    await expect(autodocsReactDomVersion).toHaveText(new RegExp(`^${actualReactVersion}`));
+    await expect(autodocsReactDomServerVersion).toHaveText(actualReactVersion);
+
+    // Arrange - Navigate to story
+    await sbPage.navigateToStory('addons/docs/docs2/resolvedreact', 'story');
+
+    // Arrange - Get the actual versions
+    const storyReactVersion = await root.getByTestId('react');
+    const storyReactDomVersion = await root.getByTestId('react-dom');
+    const storyReactDomServerVersion = await root.getByTestId('react-dom-server');
+
+    await expect(storyReactVersion).toHaveText(actualReactVersion);
+    await expect(storyReactDomVersion).toHaveText(new RegExp(`^${actualReactVersion}`));
+    await expect(storyReactDomServerVersion).toHaveText(actualReactVersion);
   });
 
   test('should have stories from multiple CSF files in autodocs', async ({ page }) => {

code/e2e-tests/util.ts

@@ -40,7 +40,7 @@ export class SbPage {
   /**
    * Visit a story by selecting it from the sidebar.
    */
-  async navigateToStory(title: string, name: string) {
+  async navigateToStory(title: string, name: string, viewMode?: 'docs' | 'story') {
     await this.openComponent(title);
 
     const titleId = toId(title);
@@ -50,11 +50,10 @@ export class SbPage {
     const storyLink = this.page.locator('*', { has: this.page.locator(`> ${storyLinkId}`) });
     await storyLink.click({ force: true });
 
-    // assert url changes
-    const viewMode = name === 'docs' ? 'docs' : 'story';
-
     await this.page.waitForURL((url) =>
-      url.search.includes(`path=/${viewMode}/${titleId}--${storyId}`)
+      url.search.includes(
+        `path=/${viewMode ?? name === 'docs' ? 'docs' : 'story'}/${titleId}--${storyId}`
+      )
     );
 
     const selected = await storyLink.getAttribute('data-selected');