fix(mdx-loader): fix cross-compiler cache randomly loading mdx with client/server envs #10553
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: bug fix
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +228 B (0%) Total Size: 11.6 MB ℹ️ View Unchanged
|
slorber
added
the
Argos
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
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
Fix #10544
The MDX cross-compiler cache is an experimental feature introduced in #10479
It permits us to avoid transforming twice the same MD/MDX source file for both client/server environments.
It takes the assumption that both environments will compile exactly the same. This is mostly true, apart from a tiny detail that led to broken images in productions: inline file loaders.
Since the MDX compilation for both envs is run in parallel, a file might be compiled in client or server mode depending on which env compilation started first and got cached. This leads to some image inline loaders to have
?emit=trueor?emit=falserandomly for the client-side app, while we always want it to have?emit=true.The solution implemented here is a bit complex but fixes our image problem. The idea is to always give priority to the client compilation as the source of truth. Even if the server compilation starts sooner, it will "wait" for the client compilation and use its result.
?emit=true, which will lead to images being emitted inbuild/__server/assets/images. It's not a big deal in practice: the__serverfolder is deleted in the build process, and it doesn't have a significant perf impact. We'll try to get rid of these inline loaders later but we can ship with this solution now.Note: the impact of cross-compiler cache is quite significant, particularly more visible under Rspack where bundling goes from ~10s to ~7s. It's more significant than what we lose by emitting useless image assets.
Test Plan
CI + Argos + deploy preview
I'm not sure how to easily unit-test this 😅 . It's experimental for now, we'll figure out a way later if the experiment is successful.
Test links
https://deploy-preview-10553--docusaurus-2.netlify.app/