-
-
Notifications
You must be signed in to change notification settings - Fork 10.1k
Manager: Keep local preview iframe on host URL when a ref story loads first #35078
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.
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
Sidnioulz
merged 3 commits into
storybookjs:next
from
TheSeydiCharyyev:fix/framesrenderer-ref-first-host-preview
Jun 9, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
code/core/src/manager/components/preview/FramesRenderer.stories.tsx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import { ManagerContext } from 'storybook/manager-api'; | ||
| import { expect, fn } from 'storybook/test'; | ||
|
|
||
| import preview from '../../../../../.storybook/preview.tsx'; | ||
| import { FramesRenderer } from './FramesRenderer.tsx'; | ||
|
|
||
| // Use the `Icons` composed ref that this Storybook already references, so the active ref frame | ||
| // renders a real story instead of a non-existent URL. | ||
| const refId = 'icons'; | ||
| const refUrl = 'https://main--64b56e737c0aeefed9d5e675.chromatic.com'; | ||
| const storyId = 'icons-accessibilityicon--default'; | ||
|
|
||
| // getStoryHrefs returns the composed ref's iframe URL whenever a refId is passed, so we can | ||
| // assert the local preview frame is requested without one (mirrors manager-api/url.ts). | ||
| const getStoryHrefs = fn((id: string, opts?: { refId?: string }) => ({ | ||
| managerHref: '', | ||
| previewHref: opts?.refId | ||
| ? `${refUrl}/iframe.html?id=${id}&refId=${opts.refId}` | ||
| : `iframe.html?id=${id}`, | ||
| })).mockName('api::getStoryHrefs'); | ||
|
|
||
| const api: any = { | ||
| getStoryHrefs, | ||
| getIsFullscreen: fn(() => false), | ||
| getIsNavShown: fn(() => true), | ||
| getCurrentParameter: fn(() => undefined), | ||
| getGlobals: fn(() => ({})), | ||
| getStoryGlobals: fn(() => ({})), | ||
| getUserGlobals: fn(() => ({})), | ||
| getUrlState: fn(() => ({ viewMode: 'story' })), | ||
| updateGlobals: fn(), | ||
| setAddonShortcut: fn(), | ||
| on: fn(), | ||
| off: fn(), | ||
| emit: fn(), | ||
| }; | ||
|
|
||
| const managerContext: any = { | ||
| state: { storyId }, | ||
| api, | ||
| }; | ||
|
|
||
| const meta = preview.meta({ | ||
| component: FramesRenderer, | ||
| args: { | ||
| api, | ||
| refId, | ||
| storyId, | ||
| viewMode: 'story', | ||
| scale: 1, | ||
| baseUrl: 'iframe.html', | ||
| queryParams: {}, | ||
| entry: { type: 'story', id: storyId } as any, | ||
| refs: { | ||
| [refId]: { id: refId, url: refUrl, type: 'lazy', title: 'Icons' }, | ||
| } as any, | ||
| }, | ||
| decorators: [ | ||
| (Story) => ( | ||
| <ManagerContext.Provider value={managerContext}> | ||
| <Story /> | ||
| </ManagerContext.Provider> | ||
| ), | ||
| ], | ||
| parameters: { layout: 'fullscreen' }, | ||
| }); | ||
|
|
||
| /** | ||
| * Regression test for #34553: when a composed-ref story is the initial selection, the local | ||
| * preview frame must still point at the host's own iframe URL. Otherwise the local frame | ||
| * stays stuck on the ref's Storybook (it is only set once) and host stories never render. | ||
| */ | ||
| export const RefStoryKeepsLocalPreviewOnHost = meta.story({ | ||
| play: async ({ canvasElement }) => { | ||
| const localFrame = canvasElement.querySelector<HTMLIFrameElement>('#storybook-preview-iframe'); | ||
| await expect(localFrame).not.toBeNull(); | ||
|
|
||
| const src = localFrame?.getAttribute('src') ?? ''; | ||
| await expect(src).not.toContain(refUrl); | ||
| await expect(src).toContain(`iframe.html?id=${storyId}`); | ||
| }, | ||
| }); |
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.