Prevent frontmatter errors from crashing dev server

withastro · Mar 27, 2023 · 816220c · 816220c
1 parent fc0ed9c
commit 816220c
Show file tree

Hide file tree

Showing 3 changed files with 86 additions and 1 deletion.
diff --git a/.changeset/flat-baboons-nail.md b/.changeset/flat-baboons-nail.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Prevent frontmatter errors from crashing the dev server
diff --git a/packages/astro/src/content/types-generator.ts b/packages/astro/src/content/types-generator.ts
@@ -226,8 +226,17 @@ export async function createContentTypesGenerator({
 		events.push(event);
 
 		debounceTimeout && clearTimeout(debounceTimeout);
+		const runEventsSafe = async () => {
+			try {
+				await runEvents(opts);
+			} catch {
+				// Prevent frontmatter errors from crashing the server. The errors
+				// are still reported on page reflects as desired.
+				// Errors still crash dev from *starting*.
+			}
+		};
 		debounceTimeout = setTimeout(
-			async () => runEvents(opts),
+			runEventsSafe,
 			50 /* debounce to batch chokidar events */
 		);
 	}

diff --git a/packages/astro/test/units/content-collections/frontmatter.test.js b/packages/astro/test/units/content-collections/frontmatter.test.js
@@ -0,0 +1,71 @@
+import { fileURLToPath } from 'node:url';
+import nodeFS from 'node:fs';
+import path from 'node:path';
+
+import { runInContainer } from '../../../dist/core/dev/index.js';
+import { attachContentServerListeners } from '../../../dist/content/index.js';
+import { createFs, triggerFSEvent } from '../test-utils.js';
+
+const root = new URL('../../fixtures/alias/', import.meta.url);
+
+function getTypesDts() {
+	const typesdtsURL = new URL('../../../src/content/template/types.d.ts', import.meta.url);
+	const relpath = path.relative(fileURLToPath(root), fileURLToPath(typesdtsURL));
+	return {
+		[relpath]: nodeFS.readFileSync(typesdtsURL, 'utf-8')
+	};
+}
+
+describe('frontmatter', () => {
+	it('errors in content/ does not crash server', async () => {
+		const fs = createFs(
+			{
+				...getTypesDts(),
+				'/src/content/posts/blog.md': `
+					---
+					title: One
+					---
+				`,
+				'/src/content/config.ts': `
+					import { defineCollection, z } from 'astro:content';
+
+					const posts = defineCollection({
+						schema: z.string()
+					});
+
+					export const collections = {
+						posts
+					};
+				`,
+				'/src/pages/index.astro': `
+					---
+					---
+					<html>
+						<head><title>Test</title></head>
+						<body class="one">
+							<h1>Test</h1>
+						</body>
+					</html>
+				`,
+			},
+			root
+		);
+
+		await runInContainer({ fs, root }, async (container) => {
+			await attachContentServerListeners(container);
+
+			fs.writeFileFromRootSync(
+				'/src/content/posts/blog.md',
+				`
+				---
+				title: One
+				title: two
+				---
+				`
+			);
+			triggerFSEvent(container, fs, '/src/content/posts/blog.md', 'change');
+			await new Promise(resolve => setTimeout(resolve, 100));
+			// Note, if we got here, it didn't crash
+		});
+	})
+});