refactor(mdx-loader): read metadata from memory (loaded content) instead of fs #10457
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
the
pr: performance
✅ [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: +381 B (0%) Total Size: 11.5 MB ℹ️ View Unchanged
|
…o slorber/mdx-loader-optimize
…o slorber/mdx-loader-optimize
slorber
added
the
Argos
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
slorber
changed the title
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.
Edit: partially reverted in #10470 which uses a different strategy
Motivation
The MDX loader performs useless IOs: we read the MDX file metadata (docs, blog pages) from the file system file that we just wrote 1 step before, while we have that data in memory.
I refactored the code so that a plugin could allow passing the in-memory data it already holds.
The solution is not super elegant but should improve performance a bit by avoiding useless IOs. I kept it mostly retro compatible in case anyone uses our MDX loader.
Rsdoctor analysis
More importantly, it makes it easier to analyze the perf of the mdx loader with Rsdoctor because IO time is reported here so we don't really know how expensive is our mdx loader in terms of compilation time.
Before:
**After:
Test Plan
CI + preview
Test links
https://deploy-preview-10457--docusaurus-2.netlify.app/