add double check on astro file return type to display more human read…

…able error (#4857)
withastro · Sep 26, 2022 · 6fd00c4 · 6fd00c4
1 parent e948f62
commit 6fd00c4
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 2 deletions.
diff --git a/examples/ssr/src/pages/index.astro b/examples/ssr/src/pages/index.astro
@@ -6,6 +6,8 @@ import { getProducts } from '../api';
 import '../styles/common.css';
 
 const products = await getProducts(Astro.request);
+
+return;
 ---
 
 <html lang="en">

diff --git a/packages/astro/src/runtime/server/render/page.ts b/packages/astro/src/runtime/server/render/page.ts
@@ -112,7 +112,12 @@ export async function renderPage(
 
 		let response = createResponse(body, { ...init, headers });
 		return response;
-	} else {
-		return factoryReturnValue;
 	}
+
+	// We double check if the file return a Response
+	if (!(factoryReturnValue instanceof Response)) {
+		throw new Error('Only instance of Response can be returned from an Astro file');
+	}
+
+	return factoryReturnValue;
 }
diff --git a/packages/astro/test/astro-not-response.test.js b/packages/astro/test/astro-not-response.test.js
@@ -0,0 +1,35 @@
+import { expect, assert } from 'chai';
+import { loadFixture } from './test-utils.js';
+
+// Asset bundling
+describe('Not returning responses', () => {
+	let fixture;
+	/** @type {import('./test-utils').DevServer} */
+	let devServer;
+
+	before(async () => {
+		fixture = await loadFixture({
+			root: './fixtures/astro-not-response/',
+		});
+
+		devServer = await fixture.startDevServer();
+	});
+
+	after(async () => {
+		await devServer.stop();
+	});
+
+	it('Does not work from a page', async () => {
+		try {
+			await fixture.build();
+		} catch (e) {
+			expect(e).to.be.instanceOf(
+				Error,
+				'Only instance of Response can be returned from an Astro file'
+			);
+			return null;
+		}
+
+		assert.fail('Should have thrown an error');
+	});
+});
diff --git a/packages/astro/test/fixtures/astro-not-response/package.json b/packages/astro/test/fixtures/astro-not-response/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "@test/astro-not-response",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "astro": "workspace:*"
+  }
+}
diff --git a/packages/astro/test/fixtures/astro-not-response/src/pages/not-response.astro b/packages/astro/test/fixtures/astro-not-response/src/pages/not-response.astro
@@ -0,0 +1,3 @@
+---
+return null;
+---
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml