[Markdoc] Fix global asset bleed (#6758)

* wip: propagatedAssets flag per-component * Propagate in TreeNode * fix: remove unused inject comment * feat: make asset propagation an integration opt-in * fix: remove crawlGraph stopper * wip: logs to understand what's happening * SSR mdoc files in dev * feat: add astroPropagatedAssets flag with vite * chore: remove console logs * chore: cleanup hasContentFlag * fix: set handlePropagation default for legacy integrations * chore: changeset * temp: silence acorn type error * chore: revert pnpm-lock changes * fix: check correct flag * We need to handle propagation on markdown because of layouts * Remove use of renderStyleElement * Fix heading tests * Fix merge conflict * typeof function * Switch the check * Add comment on injection detection regexp --------- Co-authored-by: Matthew Phillips <matthew@skypack.dev>
withastro · May 22, 2023 · f558a9e · f558a9e
1 parent b41963b
commit f558a9e
Show file tree

Hide file tree

Showing 16 changed files with 290 additions and 113 deletions.
diff --git a/.changeset/polite-knives-greet.md b/.changeset/polite-knives-greet.md
@@ -0,0 +1,7 @@
+---
+'astro': patch
+'@astrojs/markdoc': patch
+'@astrojs/mdx': patch
+---
+
+Improve style and script handling across content collection files. This addresses style bleed present in `@astrojs/markdoc` v0.1.0
diff --git a/examples/with-markdoc/src/content/config.ts b/examples/with-markdoc/src/content/config.ts
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
@@ -1275,6 +1275,12 @@ export interface ContentEntryType {
 		}
 	): rollup.LoadResult | Promise<rollup.LoadResult>;
 	contentModuleTypes?: string;
+	/**
+	 * Handle asset propagation for rendered content to avoid bleed.
+	 * Ex. MDX content can import styles and scripts, so `handlePropagation` should be true.
+	 * @default true
+	 */
+	handlePropagation?: boolean;
 }
 
 type GetContentEntryInfoReturnType = {

diff --git a/packages/astro/src/content/consts.ts b/packages/astro/src/content/consts.ts
@@ -1,11 +1,13 @@
 export const PROPAGATED_ASSET_FLAG = 'astroPropagatedAssets';
+export const CONTENT_RENDER_FLAG = 'astroRenderContent';
 export const CONTENT_FLAG = 'astroContentCollectionEntry';
 export const DATA_FLAG = 'astroDataCollectionEntry';
-export const CONTENT_FLAGS = [CONTENT_FLAG, DATA_FLAG, PROPAGATED_ASSET_FLAG] as const;
 
 export const VIRTUAL_MODULE_ID = 'astro:content';
 export const LINKS_PLACEHOLDER = '@@ASTRO-LINKS@@';
 export const STYLES_PLACEHOLDER = '@@ASTRO-STYLES@@';
 export const SCRIPTS_PLACEHOLDER = '@@ASTRO-SCRIPTS@@';
 
+export const CONTENT_FLAGS = [CONTENT_FLAG, CONTENT_RENDER_FLAG, DATA_FLAG, PROPAGATED_ASSET_FLAG] as const;
+
 export const CONTENT_TYPES_FILE = 'types.d.ts';
diff --git a/packages/astro/src/content/runtime.ts b/packages/astro/src/content/runtime.ts
@@ -270,62 +270,82 @@ async function render({
 	const baseMod = await renderEntryImport();
 	if (baseMod == null || typeof baseMod !== 'object') throw UnexpectedRenderError;
 
-	const { collectedStyles, collectedLinks, collectedScripts, getMod } = baseMod;
-	if (typeof getMod !== 'function') throw UnexpectedRenderError;
-	const mod = await getMod();
-	if (mod == null || typeof mod !== 'object') throw UnexpectedRenderError;
+	if (
+		baseMod.default != null &&
+		typeof baseMod.default === 'object' &&
+		baseMod.default.__astroPropagation === true
+	) {
+		const { collectedStyles, collectedLinks, collectedScripts, getMod } = baseMod.default;
+		if (typeof getMod !== 'function') throw UnexpectedRenderError;
+		const propagationMod = await getMod();
+		if (propagationMod == null || typeof propagationMod !== 'object') throw UnexpectedRenderError;
 
-	const Content = createComponent({
-		factory(result, baseProps, slots) {
-			let styles = '',
-				links = '',
-				scripts = '';
-			if (Array.isArray(collectedStyles)) {
-				styles = collectedStyles
-					.map((style: any) => {
-						return renderUniqueStylesheet(result, {
-							type: 'inline',
-							content: style,
-						});
-					})
-					.join('');
-			}
-			if (Array.isArray(collectedLinks)) {
-				links = collectedLinks
-					.map((link: any) => {
-						return renderUniqueStylesheet(result, {
-							type: 'external',
-							src: prependForwardSlash(link),
-						});
-					})
-					.join('');
-			}
-			if (Array.isArray(collectedScripts)) {
-				scripts = collectedScripts.map((script: any) => renderScriptElement(script)).join('');
-			}
+		const Content = createComponent({
+			factory(result, baseProps, slots) {
+				let styles = '',
+					links = '',
+					scripts = '';
+				if (Array.isArray(collectedStyles)) {
+					styles = collectedStyles
+						.map((style: any) => {
+							return renderUniqueStylesheet(result, {
+								type: 'inline',
+								content: style,
+							});
+						})
+						.join('');
+				}
+				if (Array.isArray(collectedLinks)) {
+					links = collectedLinks
+						.map((link: any) => {
+							return renderUniqueStylesheet(result, {
+								type: 'external',
+								src: prependForwardSlash(link),
+							});
+						})
+						.join('');
+				}
+				if (Array.isArray(collectedScripts)) {
+					scripts = collectedScripts.map((script: any) => renderScriptElement(script)).join('');
+				}
 
-			let props = baseProps;
-			// Auto-apply MDX components export
-			if (id.endsWith('mdx')) {
-				props = {
-					components: mod.components ?? {},
-					...baseProps,
-				};
-			}
+				let props = baseProps;
+				// Auto-apply MDX components export
+				if (id.endsWith('mdx')) {
+					props = {
+						components: propagationMod.components ?? {},
+						...baseProps,
+					};
+				}
 
-			return createHeadAndContent(
-				unescapeHTML(styles + links + scripts) as any,
-				renderTemplate`${renderComponent(result, 'Content', mod.Content, props, slots)}`
-			);
-		},
-		propagation: 'self',
-	});
+				return createHeadAndContent(
+					unescapeHTML(styles + links + scripts) as any,
+					renderTemplate`${renderComponent(
+						result,
+						'Content',
+						propagationMod.Content,
+						props,
+						slots
+					)}`
+				);
+			},
+			propagation: 'self',
+		});
 
-	return {
-		Content,
-		headings: mod.getHeadings?.() ?? [],
-		remarkPluginFrontmatter: mod.frontmatter ?? {},
-	};
+		return {
+			Content,
+			headings: propagationMod.getHeadings?.() ?? [],
+			remarkPluginFrontmatter: propagationMod.frontmatter ?? {},
+		};
+	} else if (baseMod.Content && typeof baseMod.Content === 'function') {
+		return {
+			Content: baseMod.Content,
+			headings: baseMod.getHeadings?.() ?? [],
+			remarkPluginFrontmatter: baseMod.frontmatter ?? {},
+		};
+	} else {
+		throw UnexpectedRenderError;
+	}
 }
 
 export function createReference({ lookupMap }: { lookupMap: ContentLookupMap }) {

diff --git a/packages/astro/src/content/template/virtual-mod.mjs b/packages/astro/src/content/template/virtual-mod.mjs
@@ -46,7 +46,7 @@ function createGlobLookup(glob) {
 }
 
 const renderEntryGlob = import.meta.glob('@@RENDER_ENTRY_GLOB_PATH@@', {
-	query: { astroPropagatedAssets: true },
+	query: { astroRenderContent: true },
 });
 const collectionToRenderEntryMap = createCollectionToGlobResultMap({
 	globResult: renderEntryGlob,

diff --git a/packages/astro/src/content/utils.ts b/packages/astro/src/content/utils.ts
@@ -14,6 +14,7 @@ import type {
 } from '../@types/astro.js';
 import { VALID_INPUT_FORMATS } from '../assets/consts.js';
 import { AstroError, AstroErrorData } from '../core/errors/index.js';
+
 import { formatYAMLException, isYAMLException } from '../core/errors/utils.js';
 import { CONTENT_FLAGS, CONTENT_TYPES_FILE } from './consts.js';
 import { errorMap } from './error-map.js';
@@ -328,7 +329,7 @@ export function parseFrontmatter(fileContents: string, filePath: string) {
  */
 export const globalContentConfigObserver = contentObservable({ status: 'init' });
 
-export function hasContentFlag(viteId: string, flag: (typeof CONTENT_FLAGS)[number]) {
+export function hasContentFlag(viteId: string, flag: (typeof CONTENT_FLAGS)[number]): boolean {
 	const flags = new URLSearchParams(viteId.split('?')[1] ?? '');
 	return flags.has(flag);
 }

diff --git a/packages/astro/src/content/vite-plugin-content-assets.ts b/packages/astro/src/content/vite-plugin-content-assets.ts
@@ -1,4 +1,5 @@
-import { pathToFileURL } from 'url';
+import { extname } from 'node:path';
+import { pathToFileURL } from 'node:url';
 import type { Plugin } from 'vite';
 import type { AstroSettings } from '../@types/astro.js';
 import { moduleIsTopLevelPage, walkParentInfos } from '../core/build/graph.js';
@@ -11,16 +12,13 @@ import { joinPaths, prependForwardSlash } from '../core/path.js';
 import { getStylesForURL } from '../core/render/dev/css.js';
 import { getScriptsForURL } from '../core/render/dev/scripts.js';
 import {
+	CONTENT_RENDER_FLAG,
 	LINKS_PLACEHOLDER,
 	PROPAGATED_ASSET_FLAG,
 	SCRIPTS_PLACEHOLDER,
 	STYLES_PLACEHOLDER,
 } from './consts.js';
-
-function isPropagatedAsset(viteId: string) {
-	const flags = new URLSearchParams(viteId.split('?')[1]);
-	return flags.has(PROPAGATED_ASSET_FLAG);
-}
+import { hasContentFlag } from './utils.js';
 
 export function astroContentAssetPropagationPlugin({
 	mode,
@@ -32,13 +30,31 @@ export function astroContentAssetPropagationPlugin({
 	let devModuleLoader: ModuleLoader;
 	return {
 		name: 'astro:content-asset-propagation',
+		enforce: 'pre',
+		async resolveId(id, importer, opts) {
+			if (hasContentFlag(id, CONTENT_RENDER_FLAG)) {
+				const base = id.split('?')[0];
+
+				for (const { extensions, handlePropagation = true } of settings.contentEntryTypes) {
+					if (handlePropagation && extensions.includes(extname(base))) {
+						return this.resolve(`${base}?${PROPAGATED_ASSET_FLAG}`, importer, {
+							skipSelf: true,
+							...opts,
+						});
+					}
+				}
+				// Resolve to the base id (no content flags)
+				// if Astro doesn't need to handle propagation.
+				return this.resolve(base, importer, { skipSelf: true, ...opts });
+			}
+		},
 		configureServer(server) {
 			if (mode === 'dev') {
 				devModuleLoader = createViteLoader(server);
 			}
 		},
 		async transform(_, id, options) {
-			if (isPropagatedAsset(id)) {
+			if (hasContentFlag(id, PROPAGATED_ASSET_FLAG)) {
 				const basePath = id.split('?')[0];
 				let stringifiedLinks: string, stringifiedStyles: string, stringifiedScripts: string;
 
@@ -73,14 +89,17 @@ export function astroContentAssetPropagationPlugin({
 				}
 
 				const code = `
-					export async function getMod() {
+					async function getMod() {
 						return import(${JSON.stringify(basePath)});
 					}
-					export const collectedLinks = ${stringifiedLinks};
-					export const collectedStyles = ${stringifiedStyles};
-					export const collectedScripts = ${stringifiedScripts};
+					const collectedLinks = ${stringifiedLinks};
+					const collectedStyles = ${stringifiedStyles};
+					const collectedScripts = ${stringifiedScripts};
+					const defaultMod = { __astroPropagation: true, getMod, collectedLinks, collectedStyles, collectedScripts };
+					export default defaultMod;
 				`;
-
+				// ^ Use a default export for tools like Markdoc
+				// to catch the `__astroPropagation` identifier
 				return { code, map: { mappings: '' } };
 			}
 		},

diff --git a/packages/astro/src/core/render/dev/vite.ts b/packages/astro/src/core/render/dev/vite.ts
@@ -1,7 +1,6 @@
 import type { ModuleLoader, ModuleNode } from '../../module-loader/index';
 
 import npath from 'path';
-import { PROPAGATED_ASSET_FLAG } from '../../../content/consts.js';
 import { SUPPORTED_MARKDOWN_FILE_EXTENSIONS } from '../../constants.js';
 import { unwrapId } from '../../util.js';
 import { isCSSRequest } from './util.js';
@@ -10,9 +9,10 @@ import { isCSSRequest } from './util.js';
  * List of file extensions signalling we can (and should) SSR ahead-of-time
  * See usage below
  */
-const fileExtensionsToSSR = new Set(['.astro', ...SUPPORTED_MARKDOWN_FILE_EXTENSIONS]);
+const fileExtensionsToSSR = new Set(['.astro', '.mdoc', ...SUPPORTED_MARKDOWN_FILE_EXTENSIONS]);
 
 const STRIP_QUERY_PARAMS_REGEX = /\?.*$/;
+const ASTRO_PROPAGATED_ASSET_REGEX = /\?astroPropagatedAssets/;
 
 /** recursively crawl the module graph to get all style files imported by parent id */
 export async function* crawlGraph(
@@ -23,7 +23,6 @@ export async function* crawlGraph(
 ): AsyncGenerator<ModuleNode, void, unknown> {
 	const id = unwrapId(_id);
 	const importedModules = new Set<ModuleNode>();
-	if (new URL(id, 'file://').searchParams.has(PROPAGATED_ASSET_FLAG)) return;
 
 	const moduleEntriesForId = isRootFile
 		? // "getModulesByFile" pulls from a delayed module cache (fun implementation detail),
@@ -44,6 +43,7 @@ export async function* crawlGraph(
 		if (id === entry.id) {
 			scanned.add(id);
 			const entryIsStyle = isCSSRequest(id);
+
 			for (const importedModule of entry.importedModules) {
 				// some dynamically imported modules are *not* server rendered in time
 				// to only SSR modules that we can safely transform, we check against
@@ -60,15 +60,11 @@ export async function* crawlGraph(
 					if (entryIsStyle && !isCSSRequest(importedModulePathname)) {
 						continue;
 					}
+					const isFileTypeNeedingSSR = fileExtensionsToSSR.has(npath.extname(importedModulePathname));
 					if (
-						fileExtensionsToSSR.has(
-							npath.extname(
-								// Use `id` instead of `pathname` to preserve query params.
-								// Should not SSR a module with an unexpected query param,
-								// like "?astroPropagatedAssets"
-								importedModule.id
-							)
-						)
+						isFileTypeNeedingSSR &&
+						// Should not SSR a module with ?astroPropagatedAssets
+						!ASTRO_PROPAGATED_ASSET_REGEX.test(importedModule.id)
 					) {
 						const mod = loader.getModuleById(importedModule.id);
 						if (!mod?.ssrModule) {

diff --git a/packages/astro/src/vite-plugin-head/index.ts b/packages/astro/src/vite-plugin-head/index.ts
@@ -9,7 +9,8 @@ import { getTopLevelPages, walkParentInfos } from '../core/build/graph.js';
 import type { BuildInternals } from '../core/build/internal.js';
 import { getAstroMetadata } from '../vite-plugin-astro/index.js';
 
-const injectExp = /^\/\/\s*astro-head-inject/;
+// Detect this in comments, both in .astro components and in js/ts files.
+const injectExp = /(^\/\/|\/\/!)\s*astro-head-inject/;
 
 export default function configHeadVitePlugin({
 	settings,
@@ -32,6 +33,7 @@ export default function configHeadVitePlugin({
 		seen.add(id);
 		const mod = server.moduleGraph.getModuleById(id);
 		const info = this.getModuleInfo(id);
+
 		if (info?.meta.astro) {
 			const astroMetadata = getAstroMetadata(info);
 			if (astroMetadata) {

diff --git a/packages/astro/src/vite-plugin-markdown/content-entry-type.ts b/packages/astro/src/vite-plugin-markdown/content-entry-type.ts
@@ -13,6 +13,8 @@ export const markdownContentEntryType: ContentEntryType = {
 			rawData: parsed.matter,
 		};
 	},
+	// We need to handle propagation for Markdown because they support layouts which will bring in styles.
+	handlePropagation: true,
 };
 
 /**
@@ -30,6 +32,9 @@ export const mdxContentEntryType: ContentEntryType = {
 			rawData: parsed.matter,
 		};
 	},
+	// MDX can import scripts and styles,
+	// so wrap all MDX files with script / style propagation checks
+	handlePropagation: true,
 	contentModuleTypes: `declare module 'astro:content' {
 	interface Render {
 		'.mdx': Promise<{

diff --git a/packages/integrations/markdoc/components/Renderer.astro b/packages/integrations/markdoc/components/Renderer.astro
@@ -1,4 +1,5 @@
 ---
+//! astro-head-inject
 import type { Config } from '@markdoc/markdoc';
 import Markdoc from '@markdoc/markdoc';
 import { ComponentNode, createTreeNode } from './TreeNode.js';
@@ -14,4 +15,4 @@ const ast = Markdoc.Ast.fromJSON(stringifiedAst);
 const content = Markdoc.transform(ast, config);
 ---
 
-<ComponentNode treeNode={createTreeNode(content)} />
+<ComponentNode treeNode={await createTreeNode(content)} />