Only rethrow renderer error when no renderer found (#4131)

* Only rethrow renderer error when no renderer found * Adds a changeset
withastro · Aug 3, 2022 · 09eca9b · 09eca9b
1 parent acd0b6d
commit 09eca9b
Show file tree

Hide file tree

Showing 13 changed files with 147 additions and 1 deletion.
diff --git a/.changeset/lazy-cameras-float.md b/.changeset/lazy-cameras-float.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Fixes use of multiple renderers when one throws
diff --git a/packages/astro/src/runtime/server/index.ts b/packages/astro/src/runtime/server/index.ts
@@ -310,7 +310,9 @@ Did you mean to add ${formatList(probableRendererNames.map((r) => '`' + r + '`')
 				}
 			}
 
-			if (error) {
+			// If no renderer is found and there is an error, throw that error because
+			// it is likely a problem with the component code.
+			if (!renderer && error) {
 				throw error;
 			}
 		}

diff --git a/packages/astro/test/fixtures/multiple-renderers/astro.config.mjs b/packages/astro/test/fixtures/multiple-renderers/astro.config.mjs
@@ -0,0 +1,6 @@
+import one from '@astrojs/renderer-one';
+import two from '@astrojs/renderer-two';
+
+export default {
+	integrations: [one(), two()]
+};
diff --git a/packages/astro/test/fixtures/multiple-renderers/package.json b/packages/astro/test/fixtures/multiple-renderers/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "@test/multiple-renderers",
+  "dependencies": {
+    "astro": "workspace:*",
+    "@astrojs/renderer-one": "file:./renderers/one",
+    "@astrojs/renderer-two": "file:./renderers/two"
+  }
+}
diff --git a/packages/astro/test/fixtures/multiple-renderers/renderers/one/index.mjs b/packages/astro/test/fixtures/multiple-renderers/renderers/one/index.mjs
@@ -0,0 +1,15 @@
+
+export default function() {
+	return {
+		name: 'renderer-one',
+		hooks: {
+			'astro:config:setup': ({ addRenderer }) => {
+				addRenderer({
+					name: 'renderer-one',
+					clientEntrypoint: null,
+					serverEntrypoint: '@astrojs/renderer-one/server.mjs',
+				});
+			}
+		}
+	};
+}
diff --git a/packages/astro/test/fixtures/multiple-renderers/renderers/one/package.json b/packages/astro/test/fixtures/multiple-renderers/renderers/one/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "@astrojs/renderer-one",
+  "version": "1.0.0",
+  "main": "index.mjs"
+}
diff --git a/packages/astro/test/fixtures/multiple-renderers/renderers/one/server.mjs b/packages/astro/test/fixtures/multiple-renderers/renderers/one/server.mjs
@@ -0,0 +1,11 @@
+
+export default {
+	check() {
+		throw new Error(`Oops this did not work`);
+	},
+	renderToStaticMarkup(Component) {
+		return {
+			html: Component()
+		};
+	},
+};
diff --git a/packages/astro/test/fixtures/multiple-renderers/renderers/two/index.mjs b/packages/astro/test/fixtures/multiple-renderers/renderers/two/index.mjs
@@ -0,0 +1,15 @@
+
+export default function() {
+	return {
+		name: 'renderer-two',
+		hooks: {
+			'astro:config:setup': ({ addRenderer }) => {
+				addRenderer({
+					name: 'renderer-two',
+					clientEntrypoint: null,
+					serverEntrypoint: '@astrojs/renderer-two/server.mjs',
+				});
+			}
+		}
+	};
+}
diff --git a/packages/astro/test/fixtures/multiple-renderers/renderers/two/package.json b/packages/astro/test/fixtures/multiple-renderers/renderers/two/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "@astrojs/renderer-two",
+  "version": "1.0.0",
+  "main": "index.mjs"
+}
diff --git a/packages/astro/test/fixtures/multiple-renderers/renderers/two/server.mjs b/packages/astro/test/fixtures/multiple-renderers/renderers/two/server.mjs
@@ -0,0 +1,11 @@
+
+export default {
+	check() {
+		return true;
+	},
+	renderToStaticMarkup(Component) {
+		return {
+			html: Component()
+		};
+	},
+};
diff --git a/packages/astro/test/fixtures/multiple-renderers/src/pages/index.astro b/packages/astro/test/fixtures/multiple-renderers/src/pages/index.astro
@@ -0,0 +1,14 @@
+---
+	function Component() {
+		return `<div id="component">works</div>`;
+	}
+---
+<html>
+	<head>
+		<title>Testing</title>
+	</head>
+	<body>
+		<h1>Testing</h1>
+		<Component />
+	</body>
+</html>
diff --git a/packages/astro/test/multiple-renderers.test.js b/packages/astro/test/multiple-renderers.test.js
@@ -0,0 +1,21 @@
+import { expect } from 'chai';
+import * as cheerio from 'cheerio';
+import { loadFixture } from './test-utils.js';
+
+describe('Multiple renderers', () => {
+	/** @type {import('./test-utils').Fixture} */
+	let fixture;
+
+	before(async () => {
+		fixture = await loadFixture({
+			root: './fixtures/multiple-renderers/',
+		});
+		await fixture.build();
+	});
+
+	it('when the first throws but the second does not, use the second renderer', async () => {
+		const html = await fixture.readFile('/index.html');
+		const $ = cheerio.load(html);
+		expect($('#component')).to.have.a.lengthOf(1);
+	});
+});
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml