benchmark impact of mdx parsing code #10471

slorber · 2024-09-02T16:47:51Z

Motivation

This PR is not meant to be merged. It serves as history to document the build time impact of MDX parsing time (excluding remark plugin processing).

We compare the bundle time of regular mdx vs mdx that runs against a representative pre-parsed static tree.

This is not an accurate benchmark, but gives interesting numbers when using hyperfine:

yarn clear && yarn install
hyperfine --prepare 'yarn clear:website' --runs 3 'DOCUSAURUS_AB_BENCHMARK=false yarn build:website:fast' 'DOCUSAURUS_AB_BENCHMARK=true yarn build:website:fast'

hyperfine --prepare 'yarn clear:website' --runs 3 'DOCUSAURUS_AB_BENCHMARK=false yarn build:website:fast' 'DOCUSAURUS_AB_BENCHMARK=true yarn build:website:fast'
Benchmark 1: DOCUSAURUS_AB_BENCHMARK=false yarn build:website:fast
  Time (mean ± σ):     34.518 s ±  0.316 s    [User: 58.098 s, System: 9.194 s]
  Range (min … max):   34.174 s … 34.796 s    3 runs

Benchmark 2: DOCUSAURUS_AB_BENCHMARK=true yarn build:website:fast
  Time (mean ± σ):     31.563 s ±  0.428 s    [User: 50.612 s, System: 7.667 s]
  Range (min … max):   31.120 s … 31.974 s    3 runs

Summary
  DOCUSAURUS_AB_BENCHMARK=true yarn build:website:fast ran
    1.09 ± 0.02 times faster than DOCUSAURUS_AB_BENCHMARK=false yarn build:website:fast

My intuition: there's an impact, but it's probably not significant enough to justify migrating the MDX parsing to Rust (see related discussion: mdx-js/mdx#2529)

netlify · 2024-09-02T16:51:08Z

✅ [V2]

Name	Link
🔨 Latest commit	`4ccff4c`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/66d5ec39f791490008a6dd9d
😎 Deploy Preview	https://deploy-preview-10471--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2024-09-02T16:54:53Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	Report
/	🟠 81	🟢 98	🟢 96	🟢 100	Report
/docs/installation	🟠 57	🟢 97	🟢 100	🟢 100	Report
/docs/category/getting-started	🟠 74	🟢 100	🟢 100	🟠 86	Report
/blog	🟠 64	🟢 96	🟢 100	🟠 86	Report
/blog/preparing-your-site-for-docusaurus-v3	🔴 47	🟢 92	🟢 100	🟢 100	Report
/blog/tags/release	🟠 64	🟢 96	🟢 100	🟠 86	Report
/blog/tags	🟠 74	🟢 100	🟢 100	🟠 86	Report

github-actions · 2024-09-02T16:55:36Z

Size Change: -10.4 MB (-90%) 🏆

Total Size: 1.15 MB

Filename	Change
`website/build/blog.html`	-61.4 kB (removed)	🏆
`website/build/blog/2017/12/14/introducing-docusaurus.html`	-74.8 kB (removed)	🏆
`website/build/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus.html`	-47.3 kB (removed)	🏆
`website/build/blog/2018/09/11/Towards-Docusaurus-2.html`	-51.7 kB (removed)	🏆
`website/build/blog/2018/12/14/Happy-First-Birthday-Slash.html`	-30.4 kB (removed)	🏆
`website/build/blog/2019/12/30/docusaurus-2019-recap.html`	-39.6 kB (removed)	🏆
`website/build/blog/2020/01/07/tribute-to-endi.html`	-34 kB (removed)	🏆
`website/build/blog/2021/01/19/docusaurus-2020-recap.html`	-48.9 kB (removed)	🏆
`website/build/blog/2021/03/09/releasing-docusaurus-i18n.html`	-45.1 kB (removed)	🏆
`website/build/blog/2021/05/12/announcing-docusaurus-two-beta.html`	-47.5 kB (removed)	🏆
`website/build/blog/2021/11/21/algolia-docsearch-migration.html`	-52.9 kB (removed)	🏆
`website/build/blog/2022/01/24/docusaurus-2021-recap.html`	-44.5 kB (removed)	🏆
`website/build/blog/2022/08/01/announcing-docusaurus-2.0.html`	-139 kB (removed)	🏆
`website/build/blog/2022/09/01/docusaurus-2.1.html`	-50.9 kB (removed)	🏆
`website/build/blog/archive.html`	-24.7 kB (removed)	🏆
`website/build/blog/authors.html`	-46.5 kB (removed)	🏆
`website/build/blog/authors/j-marcey.html`	-65 kB (removed)	🏆
`website/build/blog/authors/josh-cena.html`	-43 kB (removed)	🏆
`website/build/blog/authors/lex-111.html`	-50.2 kB (removed)	🏆
`website/build/blog/authors/slorber.html`	-61.5 kB (removed)	🏆
`website/build/blog/authors/slorber/authors/2.html`	-65.4 kB (removed)	🏆
`website/build/blog/authors/slorber/authors/3.html`	-77.7 kB (removed)	🏆
`website/build/blog/authors/slorber/authors/4.html`	-44.7 kB (removed)	🏆
`website/build/blog/authors/yangshun.html`	-57.8 kB (removed)	🏆
`website/build/blog/authors/zpao.html`	-43.5 kB (removed)	🏆
`website/build/blog/page/2.html`	-66 kB (removed)	🏆
`website/build/blog/page/3.html`	-71.7 kB (removed)	🏆
`website/build/blog/page/4.html`	-64.2 kB (removed)	🏆
`website/build/blog/page/5.html`	-41.9 kB (removed)	🏆
`website/build/blog/preparing-your-site-for-docusaurus-v3.html`	-138 kB (removed)	🏆
`website/build/blog/releases/2.2.html`	-49.6 kB (removed)	🏆
`website/build/blog/releases/2.3.html`	-60.8 kB (removed)	🏆
`website/build/blog/releases/2.4.html`	-65.3 kB (removed)	🏆
`website/build/blog/releases/3.0.html`	-111 kB (removed)	🏆
`website/build/blog/releases/3.1.html`	-52 kB (removed)	🏆
`website/build/blog/releases/3.2.html`	-48.8 kB (removed)	🏆
`website/build/blog/releases/3.3.html`	-55.5 kB (removed)	🏆
`website/build/blog/releases/3.4.html`	-55.8 kB (removed)	🏆
`website/build/blog/releases/3.5.html`	-58 kB (removed)	🏆
`website/build/blog/tags.html`	-28.6 kB (removed)	🏆
`website/build/blog/upgrading-frontend-dependencies-with-confidence-using-visual-regression-testing.html`	-128 kB (removed)	🏆
`website/build/docs.html`	-49.4 kB (removed)	🏆
`website/build/docs/advanced.html`	-31.1 kB (removed)	🏆
`website/build/docs/advanced/architecture.html`	-30.7 kB (removed)	🏆
`website/build/docs/advanced/client.html`	-76 kB (removed)	🏆
`website/build/docs/advanced/plugins.html`	-58.6 kB (removed)	🏆
`website/build/docs/advanced/routing.html`	-73.9 kB (removed)	🏆
`website/build/docs/advanced/ssg.html`	-81.5 kB (removed)	🏆
`website/build/docs/api/docusaurus-config.html`	-202 kB (removed)	🏆
`website/build/docs/api/misc/@docusaurus/eslint-plugin.html`	-48.3 kB (removed)	🏆
`website/build/docs/api/misc/@docusaurus/eslint-plugin/no-html-links.html`	-38.1 kB (removed)	🏆
`website/build/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text.html`	-37 kB (removed)	🏆
`website/build/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading.html`	-38.3 kB (removed)	🏆
`website/build/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages.html`	-41.9 kB (removed)	🏆
`website/build/docs/api/misc/@docusaurus/logger.html`	-39.8 kB (removed)	🏆
`website/build/docs/api/misc/create-docusaurus.html`	-34.9 kB (removed)	🏆
`website/build/docs/api/plugin-methods.html`	-67.4 kB (removed)	🏆
`website/build/docs/api/plugin-methods/extend-infrastructure.html`	-63 kB (removed)	🏆
`website/build/docs/api/plugin-methods/i18n-lifecycles.html`	-60.7 kB (removed)	🏆
`website/build/docs/api/plugin-methods/lifecycle-apis.html`	-170 kB (removed)	🏆
`website/build/docs/api/plugin-methods/static-methods.html`	-46.5 kB (removed)	🏆
`website/build/docs/api/plugins.html`	-31.7 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-client-redirects.html`	-62.6 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-content-blog.html`	-198 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-content-docs.html`	-202 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-content-pages.html`	-78 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-debug.html`	-50.5 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-google-analytics.html`	-51.5 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-google-gtag.html`	-51 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-google-tag-manager.html`	-49.8 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-ideal-image.html`	-51.1 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-pwa.html`	-122 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-sitemap.html`	-68.5 kB (removed)	🏆
`website/build/docs/api/plugins/@docusaurus/plugin-vercel-analytics.html`	-42.2 kB (removed)	🏆
`website/build/docs/api/themes.html`	-30.4 kB (removed)	🏆
`website/build/docs/api/themes/@docusaurus/theme-classic.html`	-46.4 kB (removed)	🏆
`website/build/docs/api/themes/@docusaurus/theme-live-codeblock.html`	-38.6 kB (removed)	🏆
`website/build/docs/api/themes/@docusaurus/theme-mermaid.html`	-37.5 kB (removed)	🏆
`website/build/docs/api/themes/@docusaurus/theme-search-algolia.html`	-34.7 kB (removed)	🏆
`website/build/docs/api/themes/configuration.html`	-256 kB (removed)	🏆
`website/build/docs/blog.html`	-219 kB (removed)	🏆
`website/build/docs/browser-support.html`	-51 kB (removed)	🏆
`website/build/docs/category/getting-started.html`	-28.3 kB (removed)	🏆
`website/build/docs/category/guides.html`	-36.4 kB (removed)	🏆
`website/build/docs/cli.html`	-63.8 kB (removed)	🏆
`website/build/docs/configuration.html`	-98.5 kB (removed)	🏆
`website/build/docs/create-doc.html`	-65.3 kB (removed)	🏆
`website/build/docs/creating-pages.html`	-59.1 kB (removed)	🏆
`website/build/docs/deployment.html`	-211 kB (removed)	🏆
`website/build/docs/docs-introduction.html`	-53.6 kB (removed)	🏆
`website/build/docs/docs-multi-instance.html`	-78.7 kB (removed)	🏆
`website/build/docs/docusaurus-core.html`	-245 kB (removed)	🏆
`website/build/docs/guides/whats-next.html`	-32.8 kB (removed)	🏆
`website/build/docs/i18n/crowdin.html`	-151 kB (removed)	🏆
`website/build/docs/i18n/git.html`	-82.7 kB (removed)	🏆
`website/build/docs/i18n/introduction.html`	-50.8 kB (removed)	🏆
`website/build/docs/i18n/tutorial.html`	-171 kB (removed)	🏆
`website/build/docs/installation.html`	-73 kB (removed)	🏆
`website/build/docs/introduction/index.html`	-280 B (removed)	🏆
`website/build/docs/markdown-features.html`	-83.2 kB (removed)	🏆
`website/build/docs/markdown-features/admonitions.html`	-119 kB (removed)	🏆
`website/build/docs/markdown-features/assets.html`	-93.5 kB (removed)	🏆
`website/build/docs/markdown-features/code-blocks.html`	-245 kB (removed)	🏆
`website/build/docs/markdown-features/diagrams.html`	-56 kB (removed)	🏆
`website/build/docs/markdown-features/head-metadata.html`	-52.8 kB (removed)	🏆
`website/build/docs/markdown-features/links.html`	-43.1 kB (removed)	🏆
`website/build/docs/markdown-features/math-equations.html`	-95.4 kB (removed)	🏆
`website/build/docs/markdown-features/plugins.html`	-101 kB (removed)	🏆
`website/build/docs/markdown-features/react.html`	-144 kB (removed)	🏆
`website/build/docs/markdown-features/tabs.html`	-148 kB (removed)	🏆
`website/build/docs/markdown-features/toc.html`	-88.8 kB (removed)	🏆
`website/build/docs/migration.html`	-43 kB (removed)	🏆
`website/build/docs/migration/v2.html`	-41.3 kB (removed)	🏆
`website/build/docs/migration/v2/automated.html`	-42.6 kB (removed)	🏆
`website/build/docs/migration/v2/manual.html`	-207 kB (removed)	🏆
`website/build/docs/migration/v2/translated-sites.html`	-52.8 kB (removed)	🏆
`website/build/docs/migration/v2/versioned-sites.html`	-67.2 kB (removed)	🏆
`website/build/docs/migration/v3.html`	-218 kB (removed)	🏆
`website/build/docs/playground.html`	-32.5 kB (removed)	🏆
`website/build/docs/resources/index.html`	-325 B (removed)	🏆
`website/build/docs/search.html`	-121 kB (removed)	🏆
`website/build/docs/seo.html`	-93 kB (removed)	🏆
`website/build/docs/sidebar.html`	-136 kB (removed)	🏆
`website/build/docs/sidebar/autogenerated.html`	-156 kB (removed)	🏆
`website/build/docs/sidebar/items.html`	-188 kB (removed)	🏆
`website/build/docs/sidebar/multiple-sidebars.html`	-67.1 kB (removed)	🏆
`website/build/docs/static-assets.html`	-56.3 kB (removed)	🏆
`website/build/docs/styling-layout.html`	-141 kB (removed)	🏆
`website/build/docs/support/index.html`	-319 B (removed)	🏆
`website/build/docs/swizzling.html`	-120 kB (removed)	🏆
`website/build/docs/team/index.html`	-310 B (removed)	🏆
`website/build/docs/typescript-support.html`	-65.4 kB (removed)	🏆
`website/build/docs/using-plugins.html`	-115 kB (removed)	🏆
`website/build/docs/versioning.html`	-87.1 kB (removed)	🏆
`website/build/index.html`	-37.8 kB (removed)	🏆

ℹ️ View Unchanged

Filename	Size
`website/.docusaurus/codeTranslations.json`	2 B
`website/.docusaurus/docusaurus.config.mjs`	27.9 kB
`website/.docusaurus/globalData.json`	30.2 kB
`website/.docusaurus/i18n.json`	930 B
`website/.docusaurus/registry.js`	155 kB
`website/.docusaurus/routes.js`	74.3 kB
`website/.docusaurus/routesChunkNames.json`	81.7 kB
`website/.docusaurus/site-metadata.json`	2.17 kB
`website/build/assets/css/styles.********.css`	113 kB
`website/build/assets/js/main.********.js`	666 kB

_{compressed-size-action}

slorber added 2 commits September 2, 2024 18:38

benchmark impact of mdx parsing code

8111946

benchmark impact of mdx parsing code

4ccff4c

facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 2, 2024

slorber closed this Sep 2, 2024

slorber reopened this Sep 2, 2024

slorber added the pr: internal This PR does not touch production code, or is not meaningful enough to be in the changelog. label Sep 2, 2024

slorber closed this Sep 2, 2024

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

benchmark impact of mdx parsing code #10471

benchmark impact of mdx parsing code #10471

slorber commented Sep 2, 2024 •

edited

Loading

netlify bot commented Sep 2, 2024

github-actions bot commented Sep 2, 2024

github-actions bot commented Sep 2, 2024

benchmark impact of mdx parsing code #10471

benchmark impact of mdx parsing code #10471

Conversation

slorber commented Sep 2, 2024 • edited Loading

Motivation

netlify bot commented Sep 2, 2024

✅ [V2]

github-actions bot commented Sep 2, 2024

⚡️ Lighthouse report for the deploy preview of this PR

github-actions bot commented Sep 2, 2024

slorber commented Sep 2, 2024 •

edited

Loading