-
-
Notifications
You must be signed in to change notification settings - Fork 229
fix(core): preserve page data lifecycle during HMR #3590
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
Open
SoonIter
wants to merge
1
commit into
main
Choose a base branch
from
fix/page-data-hmr-lifecycle
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
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,5 @@ | ||
| --- | ||
| '@rspress/core': patch | ||
| --- | ||
|
|
||
| Refresh page data and search indexes when documentation pages or their imported Markdown dependencies change during development. |
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
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
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
154 changes: 154 additions & 0 deletions
154
packages/core/src/node/runtimeModule/pageData/rsbuildPlugin.test.ts
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,154 @@ | ||
| import { | ||
| afterEach, | ||
| beforeEach, | ||
| describe, | ||
| expect, | ||
| rs, | ||
| test, | ||
| } from '@rstest/core'; | ||
| import { pluginVirtualModule } from 'rsbuild-plugin-virtual-module'; | ||
| import { RuntimeModuleID } from '../types'; | ||
| import { createPageData } from './createPageData'; | ||
| import { rsbuildPluginDocVM } from './rsbuildPlugin'; | ||
|
|
||
| rs.mock('rsbuild-plugin-virtual-module', () => ({ | ||
| pluginVirtualModule: rs.fn(() => ({ name: 'virtual-page-data' })), | ||
| })); | ||
|
|
||
| rs.mock('./createPageData', () => ({ | ||
| createPageData: rs.fn(), | ||
| })); | ||
|
|
||
| type ModifyBundlerChain = ( | ||
| chain: { | ||
| resolve: { alias: { entries: () => Record<string, string> } }; | ||
| }, | ||
| context: { environment: { name: string } }, | ||
| ) => void | Promise<void>; | ||
|
|
||
| const pageDataResult = { | ||
| filepaths: ['/docs/index.md'], | ||
| pageData: { pages: [] }, | ||
| searchIndex: {}, | ||
| indexHashByGroup: {}, | ||
| }; | ||
|
|
||
| async function setupPlugin() { | ||
| const plugins = await rsbuildPluginDocVM({ | ||
| config: {}, | ||
| userDocRoot: '/docs', | ||
| routeService: {}, | ||
| pluginDriver: {}, | ||
| } as never); | ||
| let modifyBundlerChainCallback: ModifyBundlerChain | undefined; | ||
| const processAssets = rs.fn(); | ||
| await plugins[0].setup?.({ | ||
| modifyBundlerChain(callback: ModifyBundlerChain) { | ||
| modifyBundlerChainCallback = callback; | ||
| }, | ||
| processAssets, | ||
| } as never); | ||
|
|
||
| const virtualModuleOptions = rs | ||
| .mocked(pluginVirtualModule) | ||
| .mock.calls.at(-1)?.[0]; | ||
| const renderPageData = | ||
| virtualModuleOptions?.virtualModules?.[RuntimeModuleID.PageData]; | ||
| if (!modifyBundlerChainCallback || typeof renderPageData !== 'function') { | ||
| throw new Error('Failed to initialize page data plugins'); | ||
| } | ||
|
|
||
| return { | ||
| async configureEnvironment(name: string, alias: Record<string, string>) { | ||
| await modifyBundlerChainCallback( | ||
| { resolve: { alias: { entries: () => alias } } }, | ||
| { environment: { name } }, | ||
| ); | ||
| if (!processAssets.mock.calls.length) { | ||
| throw new Error('Environment configuration callback did not run'); | ||
| } | ||
| }, | ||
| renderPageData: () => | ||
| renderPageData({ addDependency: rs.fn() } as never, {} as never), | ||
| }; | ||
| } | ||
|
|
||
| describe('page data rsbuild plugin', () => { | ||
| const originalNodeEnv = process.env.NODE_ENV; | ||
|
|
||
| beforeEach(() => { | ||
| process.env.NODE_ENV = 'development'; | ||
| rs.mocked(createPageData).mockResolvedValue(pageDataResult); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| process.env.NODE_ENV = originalNodeEnv; | ||
| rs.clearAllMocks(); | ||
| }); | ||
|
|
||
| test('uses the first environment alias until the web alias is available', async () => { | ||
| const plugin = await setupPlugin(); | ||
| await plugin.configureEnvironment('node', { fallback: '/fallback' }); | ||
|
|
||
| await expect(plugin.renderPageData()).resolves.toContain('"pages": []'); | ||
| expect(createPageData).toHaveBeenLastCalledWith( | ||
| expect.objectContaining({ alias: { fallback: '/fallback' } }), | ||
| ); | ||
|
|
||
| await plugin.configureEnvironment('web', { web: '/web' }); | ||
| await plugin.renderPageData(); | ||
| expect(createPageData).toHaveBeenLastCalledWith( | ||
| expect.objectContaining({ alias: { web: '/web' } }), | ||
| ); | ||
| }); | ||
|
|
||
| test('caches production generation across compiler targets', async () => { | ||
| process.env.NODE_ENV = 'production'; | ||
| const plugin = await setupPlugin(); | ||
| await plugin.configureEnvironment('web', { web: '/web' }); | ||
|
|
||
| await plugin.renderPageData(); | ||
| await plugin.renderPageData(); | ||
|
|
||
| expect(createPageData).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| test('rebuilds production data when the authoritative web alias arrives', async () => { | ||
| process.env.NODE_ENV = 'production'; | ||
| const plugin = await setupPlugin(); | ||
| await plugin.configureEnvironment('node', { fallback: '/fallback' }); | ||
| await plugin.renderPageData(); | ||
|
|
||
| await plugin.configureEnvironment('web', { web: '/web' }); | ||
|
|
||
| expect(createPageData).toHaveBeenCalledTimes(2); | ||
| expect(createPageData).toHaveBeenLastCalledWith( | ||
| expect.objectContaining({ alias: { web: '/web' } }), | ||
| ); | ||
| }); | ||
|
|
||
| test('regenerates in development and deduplicates concurrent requests', async () => { | ||
| const plugin = await setupPlugin(); | ||
| await plugin.configureEnvironment('web', { web: '/web' }); | ||
|
|
||
| await Promise.all([plugin.renderPageData(), plugin.renderPageData()]); | ||
| expect(createPageData).toHaveBeenCalledTimes(1); | ||
|
|
||
| await plugin.renderPageData(); | ||
| expect(createPageData).toHaveBeenCalledTimes(2); | ||
| }); | ||
|
|
||
| test('retries a failed production generation', async () => { | ||
| process.env.NODE_ENV = 'production'; | ||
| rs.mocked(createPageData) | ||
| .mockRejectedValueOnce(new Error('generation failed')) | ||
| .mockResolvedValueOnce(pageDataResult); | ||
| const plugin = await setupPlugin(); | ||
|
|
||
| await expect( | ||
| plugin.configureEnvironment('web', { web: '/web' }), | ||
| ).rejects.toThrow('generation failed'); | ||
| await expect(plugin.renderPageData()).resolves.toContain('"pages": []'); | ||
| expect(createPageData).toHaveBeenCalledTimes(2); | ||
| }); | ||
| }); |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the virtual module is rendered by a non-web environment before the web chain is configured, this stores the fallback aliases and initializes
flattenMdxContent's module-level resolver with them. Although the subsequent web callback regenerates page data with the authoritative aliases,packages/core/src/node/utils/flattenMdxContent.tsnever recreates its resolver oncestartFlattenis set, so Markdown imports that depend on a web-specific alias can remain unresolved or resolve to the fallback target, producing incorrect search content and omitting the dependency from HMR tracking. Reset or key that resolver when the alias source changes.Useful? React with 👍 / 👎.