Skip to content

Portable stories: Fix playwright CT to allow functions to be passed as props #31335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yannbf merged 2 commits into from
Jul 1, 2025
Merged

Portable stories: Fix playwright CT to allow functions to be passed as props #31335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e3b59e
Fixes #31150. Portable stories for playwright CT now allow functions …
adamscybot May 1, 2025
a824e72
Merge branch 'next' into fix-pass-functions-playwright-portable-stories
yannbf Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions code/core/src/preview-api/modules/store/csf/portable-stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,9 @@ export function composeStories<TModule extends Store_CSFExports>(
return composedStories;
}

type WrappedStoryRef = { __pw_type: 'jsx' | 'importRef' };
type WrappedStoryRef =
| { __pw_type: 'jsx'; props: Record<string, any> }
| { __pw_type: 'importRef' };
type UnwrappedJSXStoryRef = {
__pw_type: 'jsx';
type: UnwrappedImportStoryRef;
Expand Down Expand Up @@ -341,12 +343,16 @@ export function createPlaywrightTest<TFixture extends { extend: any }>(
`);
}

// Props are not necessarily serialisable and so can't be passed to browser via
// `page.evaluate`. Regardless they are not needed for storybook load/play steps.
const { props, ...storyRefWithoutProps } = storyRef;

await page.evaluate(async (wrappedStoryRef: WrappedStoryRef) => {
const unwrappedStoryRef = await globalThis.__pwUnwrapObject?.(wrappedStoryRef);
const story =
'__pw_type' in unwrappedStoryRef ? unwrappedStoryRef.type : unwrappedStoryRef;
return story?.load?.();
}, storyRef);
}, storyRefWithoutProps);

// mount the story
const mountResult = await mount(storyRef, ...restArgs);
Expand All @@ -358,7 +364,7 @@ export function createPlaywrightTest<TFixture extends { extend: any }>(
'__pw_type' in unwrappedStoryRef ? unwrappedStoryRef.type : unwrappedStoryRef;
const canvasElement = document.querySelector('#root');
return story?.play?.({ canvasElement });
}, storyRef);
}, storyRefWithoutProps);

return mountResult;
});
Expand Down
5 changes: 4 additions & 1 deletion test-storybooks/portable-stories-kitchen-sink/react/stories/Button.playwright.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,14 @@ test('renders with composeStory (singular)', async ({ mount }) => {
});

test('renders story with props', async ({ mount }) => {
let called = false
const component = await mount(
<stories.CSF3Button primary={true}>child from test</stories.CSF3Button>
<stories.CSF3Button primary={true} onClick={() => { called = true }}>child from test</stories.CSF3Button>
);
await expect(component).toContainText('child from test');
await expect(component.getByRole('button')).toHaveClass(/storybook-button--primary/);
await component.getByRole('button').click()
await expect(called).toBe(true)
});

test('renders story with custom render', async ({ mount }) => {
Expand Down