Skip to content

fix: wait for inline stories before rerendering docs #35618

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
valentinpalkovic merged 2 commits into from
Oct 19, 2026
Merged

fix: wait for inline stories before rerendering docs #35618

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
6982781
fix: wait for inline stories before rerendering docs
wanxiankai Jul 28, 2026
1614215
Merge branch 'next' into fix/docs-globals-rerender-race
valentinpalkovic Oct 16, 2026
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
23 changes: 22 additions & 1 deletion code/core/src/preview-api/modules/preview-web/PreviewWeb.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,10 +963,31 @@ describe('PreviewWeb', () => {
mockChannel.emit.mockClear();
docsRenderer.render.mockClear();
emitter.emit(UPDATE_GLOBALS, { globals: { a: 'd' } });
await waitForEvents([GLOBALS_UPDATED]);
await waitForEvents([DOCS_RENDERED]);

expect(docsRenderer.render).toHaveBeenCalled();
});

it('waits for inline stories to rerender before rerendering the docs container', async () => {
document.location.search = '?id=component-one--docs&viewMode=docs';
const preview = await createAndRenderPreview();
const [inlineStoryRerender, finishInlineStoryRerender] = createGate();
const rerenderInlineStory = vi.fn(() => inlineStoryRerender);
preview.storyRenders.push({
rerender: rerenderInlineStory,
} as unknown as (typeof preview.storyRenders)[number]);
const rerenderDocs = vi.spyOn(preview.currentRender!, 'rerender');
Comment thread
valentinpalkovic marked this conversation as resolved.

const updateGlobals = preview.onUpdateGlobals({ globals: { a: 'd' } });
await vi.waitFor(() => expect(rerenderInlineStory).toHaveBeenCalled());

expect(rerenderDocs).not.toHaveBeenCalled();

finishInlineStoryRerender();
await updateGlobals;

expect(rerenderDocs).toHaveBeenCalledOnce();
});
});
});

Expand Down
2 changes: 1 addition & 1 deletion code/core/src/preview-api/modules/preview-web/PreviewWithSelection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ export class PreviewWithSelection<TRenderer extends Renderer> extends Preview<TR
async onUpdateGlobals({ globals }: { globals: Globals }) {
const currentStory =
(this.currentRender instanceof StoryRender && this.currentRender.story) || undefined;
super.onUpdateGlobals({ globals, currentStory });
await super.onUpdateGlobals({ globals, currentStory });
Comment thread
valentinpalkovic marked this conversation as resolved.
if (
this.currentRender instanceof MdxDocsRender ||
this.currentRender instanceof CsfDocsRender
Expand Down
Loading