perf(start-plugin-core): reuse the Rsbuild dev client build when a rebuild cannot change it #8800
main fromrefs/pull/8800/head·opened 🎯 Changes#
In rsbuild dev, every rebuild normalizes the client compilation and rebuilds the Start manifest, even for a code-only edit that cannot change either. This reuses the previous result when all of these hold:
- the compilation directly follows the one that produced it
- no file was removed
- a fingerprint of the chunk graph is unchanged (chunk JS and CSS files, runtimes, module counts, chunk groups, entrypoints)
- the active static imports of rebuilt modules and their direct importers are unchanged
The fingerprint only includes files normalization reads, so *.hot-update.* files and other assets don't defeat it. Its lines are sorted because HMR rebuilds reorder chunks between compilations without changing them. Import signatures are recorded once per dev server and then updated for rebuilt modules only. When the client build and route tree are unchanged, the dev manifest isn't rebuilt either.
128-route dev rebuild (tests/rsbuild/dev-client-build-reuse.bench.ts):
| Mean | |
|---|---|
| Normalize + manifest on every rebuild (before) | 9.4 ms |
| Code-only rebuild, reused | 1.8 ms |
| First dev compilation, recording signatures (once) | 27 ms |
A rebuild that does change imports or chunks pays the before cost plus the ~1.8 ms check.
Tests: a real Rspack watch test, run with and without HotModuleReplacementPlugin, compares every captured build with a fresh normalization after code-only, shared-module, CSS, hydration-query and dynamic-import edits, and checks which ones were reused. Weakening the import check or ignoring import changes makes it fail; so did the hot-update and chunk-order problems before they were fixed.
rebuilt-modules.ts is also added by #8801; both copies are identical. Rebases cleanly with #8780. If #8588 lands first, its rebase needs to keep getChunkJsFiles and getChunkCssFiles callable, since the fingerprint here uses them.
Written with an AI coding assistant.
✅ Checklist#
- I have followed the steps in the Contributing guide.
- I have tested code changes locally with the relevant test commands, or tests do not apply to this pull request.
- I fully understand the code in this pull request, including any code generated with AI assistance.
🚀 Release Impact#
- This change affects published code, and I have generated a changeset.
- This change is docs/CI/dev-only (no release).
Summary by CodeRabbit#
- Performance Improvements
- Development rebuilds can reuse the previous client build and manifest when code-only edits leave the relevant build structure unchanged, reducing unnecessary rebuild work.
- Changes that affect imports, routes, styles, or other build structure still trigger a fresh build and manifest update. Production behavior remains unchanged.
- 1
Important
Review skipped#
Review was skipped as selected files did not have any reviewable changes.
Run configuration-
- Source mode: Auto
- Repository: TanStack/router
- Branch: main
- File: .coderabbit.yaml
- Commit: f723f3b
- Layers: Repository YAML
- Review profile: CHILL
- Plan: Advanced
- Run ID:
30c70735-7e77-4c9b-805e-bf3ac9f1e02b
Commits-
Reviewing files that changed from the base of the PR and between ac1e563b0d9aebafaca1e79ae138ff0585cd3107 and 2752a53c0c61787ca34de18acfe9b9e92547c42d.
You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.Use the checkbox below for a quick retry:
- Trigger review
No actionable comments were generated in the recent review.
Recent review info-
Run configuration-
- Source mode: Auto
- Repository: TanStack/router
- Branch: main
- File: .coderabbit.yaml
- Commit: 6b9fe6d
- Layers: Repository YAML
- Review profile: CHILL
- Plan: Advanced
- Run ID:
75f3907a-7931-4ad0-92b9-56067679f974
Commits-
Reviewing files that changed from the base of the PR and between 6b9fe6d29552270836c511bc9b343d73541f4424 and ac1e563b0d9aebafaca1e79ae138ff0585cd3107.
Files selected for processing: 7-
.changeset/rsbuild-dev-client-build-reuse.mdpackages/start-plugin-core/src/rsbuild/normalized-client-build.tspackages/start-plugin-core/src/rsbuild/rebuilt-modules.tspackages/start-plugin-core/src/rsbuild/virtual-modules.tspackages/start-plugin-core/tests/rsbuild/dev-client-build-reuse.bench.tspackages/start-plugin-core/tests/rsbuild/normalized-client-build.test.tspackages/start-plugin-core/tests/rsbuild/rebuilt-modules.test.ts
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.
-
Walkthrough
-
Development client-build capture now reuses a normalized build when rebuild checks show that imports, module edges, and chunk structure are unchanged. Development manifest updates also skip work when the client build and route manifest are unchanged.
Changes: Rsbuild development client-build reuse
Layer / File(s) Summary Rebuild eligibility and snapshot reuse
packages/start-plugin-core/src/rsbuild/rebuilt-modules.ts,packages/start-plugin-core/src/rsbuild/normalized-client-build.tsNew helpers identify rebuilt modules and detect possible import re-resolution. Development capture tracks module-edge signatures and a chunk-graph fingerprint, then reuses the prior normalized build only when its snapshot remains eligible. Development manifest update
packages/start-plugin-core/src/rsbuild/virtual-modules.tsDevelopment manifest updates return early when both the client build and route manifest match their stored references. Otherwise, the code records the route manifest and refreshes the development manifest. Reuse tests and benchmarks
packages/start-plugin-core/tests/rsbuild/normalized-client-build.test.ts,packages/start-plugin-core/tests/rsbuild/rebuilt-modules.test.ts,packages/start-plugin-core/tests/rsbuild/dev-client-build-reuse.bench.ts,.changeset/rsbuild-dev-client-build-reuse.mdTests cover rebuild eligibility and reuse across several types of edits. The benchmark measures normalization and manifest generation before and after a code-only rebuild. A patch changeset records the update. Estimated code review effort: 3 (Moderate) | ~25 minutes
Change: Refactor
Sequence Diagram(s)#
sequenceDiagram participant RspackCompiler participant registerClientBuildCapture participant mayHaveReResolvedImports participant getRebuiltModulesAndImporters participant NormalizedClientBuild participant DevelopmentManifest RspackCompiler->>registerClientBuildCapture: Advance or invalidate the prior snapshot registerClientBuildCapture->>mayHaveReResolvedImports: Check changed and removed files registerClientBuildCapture->>getRebuiltModulesAndImporters: Collect rebuilt modules and importers registerClientBuildCapture->>NormalizedClientBuild: Reuse eligible snapshot or normalize compilation NormalizedClientBuild->>DevelopmentManifest: Provide captured client build DevelopmentManifest->>DevelopmentManifest: Skip update if build and route manifest references matchPossibly related PRs
- TanStack/router#8801: Uses the same rebuilt-module and import re-resolution helpers for incremental import-protection scans.
Suggested labels:
package: start-plugin-coreSuggested reviewers:
ladybluenotes,schiller-manuel
Merge Risk:
Minimal · previous reviewac1e5-
This change speeds up Rsbuild dev rebuilds by reusing the normalized client build when a rebuild cannot change it. The checks that guard reuse are conservative and tested against real watch builds. No actionable merge-blocking risk was found.
Pre-merge checks:
4 · 1-
Failed checks: 1 warningCheck name Status Explanation Resolution Docstring Coverage Docstring coverage is 70.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 10 functions across 6 files. (1 skipped: … Write docstrings for the functions missing them to satisfy the coverage threshold. Passed checks: 4 passed-
Check name Status Explanation Title check The title clearly and concisely describes the main performance change: reusing the Rsbuild development client build when a rebuild cannot change it. Description check The description includes the required Changes, Checklist, and Release Impact sections. It explains the implementation, motivation, benchmarks, tests, changeset, and AI assistance. The checklist item c… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description includes the required Changes, Checklist, and Release Impact sections. It explains the implementation, motivation, benchmarks, tests, changeset, and AI assistance. The checklist item confirming full understanding of the code remains unchecked, but the description is otherwise substantially complete.
-
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 70.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 10 functions across 6 files. (1 skipped: 1 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
-
Sign in to join this conversation.
🦋 Changeset detected#
Latest commit: 2752a53c0c61787ca34de18acfe9b9e92547c42d
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR