Improve MDX rendering performance #8533
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@astrojs/mdx': patch | ||
| --- | ||
|
|
||
| Improve MDX rendering performance by sharing processor instance |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import type { Literal, MemberExpression } from 'estree'; | ||
| import { visit as estreeVisit } from 'estree-util-visit'; | ||
|
|
||
| export function recmaInjectImportMetaEnv({ | ||
| importMetaEnv, | ||
| }: { | ||
| importMetaEnv: Record<string, any>; | ||
| }) { | ||
| return (tree: any) => { | ||
| estreeVisit(tree, (node) => { | ||
| if (node.type === 'MemberExpression') { | ||
| // attempt to get "import.meta.env" variable name | ||
| const envVarName = getImportMetaEnvVariableName(node); | ||
| if (typeof envVarName === 'string') { | ||
| // clear object keys to replace with envVarLiteral | ||
| for (const key in node) { | ||
| delete (node as any)[key]; | ||
| } | ||
| const envVarLiteral: Literal = { | ||
| type: 'Literal', | ||
| value: importMetaEnv[envVarName], | ||
| raw: JSON.stringify(importMetaEnv[envVarName]), | ||
| }; | ||
| Object.assign(node, envVarLiteral); | ||
| } | ||
| } | ||
| }); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Check if estree entry is "import.meta.env.VARIABLE" | ||
| * If it is, return the variable name (i.e. "VARIABLE") | ||
| */ | ||
| function getImportMetaEnvVariableName(node: MemberExpression): string | Error { | ||
| try { | ||
| // check for ".[ANYTHING]" | ||
| if (node.object.type !== 'MemberExpression' || node.property.type !== 'Identifier') | ||
| return new Error(); | ||
|
|
||
| const nestedExpression = node.object; | ||
| // check for ".env" | ||
| if (nestedExpression.property.type !== 'Identifier' || nestedExpression.property.name !== 'env') | ||
| return new Error(); | ||
|
|
||
| const envExpression = nestedExpression.object; | ||
| // check for ".meta" | ||
| if ( | ||
| envExpression.type !== 'MetaProperty' || | ||
| envExpression.property.type !== 'Identifier' || | ||
| envExpression.property.name !== 'meta' | ||
| ) | ||
| return new Error(); | ||
|
|
||
| // check for "import" | ||
| if (envExpression.meta.name !== 'import') return new Error(); | ||
|
|
||
| return node.property.name; | ||
| } catch (e) { | ||
| if (e instanceof Error) { | ||
| return e; | ||
| } | ||
| return new Error('Unknown parsing error'); | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import { InvalidAstroDataError } from '@astrojs/markdown-remark'; | ||
| import { safelyGetAstroData } from '@astrojs/markdown-remark/dist/internal.js'; | ||
| import type { VFile } from 'vfile'; | ||
| import { jsToTreeNode } from './utils.js'; | ||
|
|
||
| export function rehypeApplyFrontmatterExport() { | ||
| return function (tree: any, vfile: VFile) { | ||
| const astroData = safelyGetAstroData(vfile.data); | ||
| if (astroData instanceof InvalidAstroDataError) | ||
| throw new Error( | ||
| // Copied from Astro core `errors-data` | ||
| // TODO: find way to import error data from core | ||
|
There was a problem hiding this comment. Now we have import { AstroError } from "astro/errors";There was a problem hiding this comment. I mostly copied the existing code over. We can follow-up a PR for this improvement 😬 |
||
| '[MDX] A remark or rehype plugin attempted to inject invalid frontmatter. Ensure "astro.frontmatter" is set to a valid JSON object that is not `null` or `undefined`.' | ||
| ); | ||
| const { frontmatter } = astroData; | ||
| const exportNodes = [ | ||
| jsToTreeNode(`export const frontmatter = ${JSON.stringify(frontmatter)};`), | ||
| ]; | ||
| if (frontmatter.layout) { | ||
| // NOTE(bholmesdev) 08-22-2022 | ||
| // Using an async layout import (i.e. `const Layout = (await import...)`) | ||
| // Preserves the dev server import cache when globbing a large set of MDX files | ||
| // Full explanation: 'https://github.com/withastro/astro/pull/4428' | ||
| exportNodes.unshift( | ||
| jsToTreeNode( | ||
| /** @see 'vite-plugin-markdown' for layout props reference */ | ||
| `import { jsx as layoutJsx } from 'astro/jsx-runtime'; | ||
|
|
||
| export default async function ({ children }) { | ||
| const Layout = (await import(${JSON.stringify(frontmatter.layout)})).default; | ||
| const { layout, ...content } = frontmatter; | ||
| content.file = file; | ||
| content.url = url; | ||
| return layoutJsx(Layout, { | ||
| file, | ||
| url, | ||
| content, | ||
| frontmatter: content, | ||
| headings: getHeadings(), | ||
| 'server:root': true, | ||
| children, | ||
| }); | ||
| };` | ||
| ) | ||
| ); | ||
| } | ||
| tree.children = exportNodes.concat(tree.children); | ||
| }; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All these options are moved to
createMdxProcessor