feat(core): Docusaurus Faster - Rspack Persistent Cache #10931
Merged
Conversation
This file contains 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
slorber
added
pr: new feature
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Size Change: +1.23 kB (+0.01%) Total Size: 11.1 MB
ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|
Size Change: +1.25 kB (+0.01%) Total Size: 11.5 MB
ℹ️ View Unchanged
|
tats-u
reviewed
Feb 14, 2025
|
👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎ This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. |
2 tasks
slorber
changed the title
rspackPersistentCache
slorber
changed the title
rspackPersistentCache
|
Report too large to display inline |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
This PR introduces a new Docusaurus Faster option:
siteConfig.future.experimental_faster.rspackPersistentCache.It permits Docusaurus to (re)-build your site much faster on subsequent builds.
You can turn it on globally (recommended) alongside other Docusaurus Faster options:
Or individually:
This works by creating a cache in
website/node_modules/.cache/rspackon the first build, which is used to speed up subsequent builds.It is your responsibility to configure your host/CI to "persist" that cache across CI job runs. We don't really document how to do so currently, but we plan to document how to do this for popular hosts (Vercel/Netlify/GitHub Actions) in the future.
This is a feature we already had with webpack, and is now available starting Rspack v1.2
Work in progress, it's working but cause some troubles
Fix #10823
Test Plan
CI + local + dogfood
Test links
https://deploy-preview-10931--docusaurus-2.netlify.app/
Docs: https://deploy-preview-10931--docusaurus-2.netlify.app/docs/api/docusaurus-config/#future
Benchmarks
Disclaimer: Rspack has a bug that prevents many of our files from being cached efficiently.
In practice, the cache doesn't work yet for all code-generated files, that are common to the Docusaurus ecosystem:
./docusaurusWe hope to improve these benchmarks soon. The Rspack bug is tracked here:
Until then I reverted a little bugfix that prevents Rspack from optimizing docs MDX files: #10934 (we'll re-enable it later)
Faster (no cache) vs Faster (with cache) - Warm re-builds
The Rspack persistent cache improves build time by ~25%.
This is not as impressive as we hoped, but this should improve in the future with:
Docusaurus Slower vs Docusaurus Faster - Cold builds
This change has no impact on cold builds: Docusaurus Faster is still 3-4x faster overall.
Docusaurus Slower vs Docusaurus Faster - Warm re-builds
With the latest Docusaurus Faster options coming in v3.8, rebuilding your site should be 50% faster. We hope to improve this number even more in the future.