You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Using a thread pool to distribute the SSG load over multiple workers can significantly improve the SSG execution time. According to my local tests (Mac M3 Pro), SSG can be divided by ~2 and probably more if there are enough pathnames to render.
This build benchmark only reports a 15% improvement because SSG is only a part of the full Docusaurus build. The SSG time went from 11s to 5s locally so it remains significant, and will feel even more significant once we activate Rspack persistent caching.
hyperfine --runs 3 'DOCUSAURUS_DISABLE_SSG_POOL=true yarn build:website --locale en''DOCUSAURUS_DISABLE_SSG_POOL=false yarn build:website --locale en'
Benchmark 1: DOCUSAURUS_DISABLE_SSG_POOL=true yarn build:website --locale en
Time (mean ± σ): 47.014 s ± 3.993 s [User: 105.325 s, System: 29.761 s]
Range (min … max): 43.016 s … 51.002 s 3 runs
Benchmark 2: DOCUSAURUS_DISABLE_SSG_POOL=false yarn build:website --locale en
Time (mean ± σ): 41.176 s ± 0.997 s [User: 120.113 s, System: 33.196 s]
Range (min … max): 40.186 s … 42.180 s 3 runs
Summary
DOCUSAURUS_DISABLE_SSG_POOL=false yarn build:website --locale en ran
1.14 ± 0.10 times faster than DOCUSAURUS_DISABLE_SSG_POOL=true yarn build:website --locale en
Note: we'll have to fine-tune the thread pool settings, create sensible defaults, and expose an API to customize settings.
Note: This is only a POC used to measure the impact. To merge this, we'll need to do a breaking change, because the Helmet unserializable data structure prevents the usage of worker threads. I removed the Helmet data for this POC, but it is a critical piece for Docusaurus SEO.
ArgosAdd this label to run UI visual regression tests. See argos.yml GH action.CLA SignedSigned Facebook CLApr: new featureThis PR adds a new API or behavior.pr: performanceThis PR does not add a new behavior, but existing behaviors will be more memory- / time-efficient.
4 participants
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
Using a thread pool to distribute the SSG load over multiple workers can significantly improve the SSG execution time. According to my local tests (Mac M3 Pro), SSG can be divided by ~2 and probably more if there are enough pathnames to render.
This build benchmark only reports a 15% improvement because SSG is only a part of the full Docusaurus build. The SSG time went from 11s to 5s locally so it remains significant, and will feel even more significant once we activate Rspack persistent caching.
Note: we'll have to fine-tune the thread pool settings, create sensible defaults, and expose an API to customize settings.
Note: This is only a POC used to measure the impact. To merge this, we'll need to do a breaking change, because the Helmet unserializable data structure prevents the usage of worker threads. I removed the Helmet data for this POC, but it is a critical piece for Docusaurus SEO.
Test Plan
CI + dogfood + Argos
Test links
https://deploy-preview-10826--docusaurus-2.netlify.app/
Related issues/PRs
Follow up of #10593
Also the expected next step for Docusaurus Faster: #10556