Repository navigation
Stop the frontend watch from rebuilding in a loop #4407
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
Merged
Changes from all commits
Commits
Show all changes
2 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
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,41 @@ | ||
| /** | ||
| * @jest-environment node | ||
| */ | ||
| import type { UserConfig } from 'vite' | ||
|
|
||
| jest.mock('vite', () => ({ defineConfig: (config: unknown) => config })) | ||
| jest.mock('@tailwindcss/vite', () => () => ({ name: 'tailwindcss' })) | ||
| jest.mock('@vitejs/plugin-react', () => () => ({ name: 'react' })) | ||
| jest.mock('vite-plugin-svgr', () => () => ({ name: 'svgr' })) | ||
|
|
||
| const loadConfig = async (argv: string[]): Promise<UserConfig> => { | ||
| const originalArgv = process.argv | ||
| process.argv = ['node', 'vite', ...argv] | ||
| try { | ||
| let config: UserConfig = {} | ||
| await jest.isolateModulesAsync(async () => { | ||
| config = (await import('./vite.config')).default as UserConfig | ||
| }) | ||
| return config | ||
| } finally { | ||
| process.argv = originalArgv | ||
| } | ||
| } | ||
|
|
||
| describe('vite.config build.watch', () => { | ||
| it('leaves watch unset for a one-shot build so `vite build` exits', async () => { | ||
| const config = await loadConfig(['build']) | ||
|
|
||
| expect(config.build?.watch).toBeNull() | ||
| }) | ||
|
|
||
| it('excludes the build output under --watch so writes do not trigger a rebuild', async () => { | ||
| const config = await loadConfig(['build', '--watch']) | ||
|
|
||
| expect(config.build?.watch).toEqual( | ||
| expect.objectContaining({ | ||
| exclude: expect.arrayContaining(['**/_static/**']), | ||
| }) | ||
| ) | ||
| }) | ||
| }) |
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.
Severity: P3 (Low)
Add automated regression coverage for the build/watch lifecycle. This fix has no accompanying test that verifies a normal build exits, watch mode settles after writing
_static, and a source edit triggers another build. Those are the behaviors this change must preserve, and without coverage the rebuild loop or a hanging frontend build can return unnoticed.Generated by Libra. React with 👍 or 👎 to give feedback on this comment.
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.
Added
vite.config.test.tsin c90ecf1. It covers both regressions at the config level: a one-shotvite buildkeepsbuild.watchunset (otherwise the MSBuild step hangs), and--watchexcludes_static/**(otherwise every build triggers the next). I checked that it fails when watch is forced on. A realvite build --watchlifecycle test, which edits a file and counts rebuilds, would need several seconds of real Vite and Tailwind builds and would be flaky, so I left it out of the Jest suite.