chore: better warning (withastro#12642)

* chore: better warning * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <[email protected]> --------- Co-authored-by: Sarah Rainsberger <[email protected]>
ebfork · Dec 5, 2024 · ff18b9c · ff18b9c
1 parent 22e405a
commit ff18b9c
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/.changeset/fuzzy-pans-cough.md b/.changeset/fuzzy-pans-cough.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Provides more information when logging a warning for accessing `Astro.request.headers` in prerendered pages
diff --git a/packages/astro/src/core/build/generate.ts b/packages/astro/src/core/build/generate.ts
@@ -437,6 +437,7 @@ async function generatePath(
 		headers: new Headers(),
 		logger,
 		isPrerendered: true,
+		routePattern: route.component
 	});
 	const renderContext = await RenderContext.create({
 		pipeline,

diff --git a/packages/astro/src/core/request.ts b/packages/astro/src/core/request.ts
@@ -20,6 +20,8 @@ export interface CreateRequestOptions {
 	 * @default false
 	 */
 	isPrerendered?: boolean;
+
+	routePattern: string
 }
 
 const clientAddressSymbol = Symbol.for('astro.clientAddress');
@@ -41,6 +43,7 @@ export function createRequest({
 	logger,
 	locals,
 	isPrerendered = false,
+	routePattern
 }: CreateRequestOptions): Request {
 	// headers are made available on the created request only if the request is for a page that will be on-demand rendered
 	const headersObj = isPrerendered
@@ -82,7 +85,7 @@ export function createRequest({
 			get() {
 				logger.warn(
 					null,
-					`\`Astro.request.headers\` is not available on prerendered pages. If you need access to request headers, make sure that the page is server rendered using \`export const prerender = false;\` or by setting \`output\` to \`"server"\` in your Astro config to make all your pages server rendered.`,
+					`\`Astro.request.headers\` was used when rendering the route \`${routePattern}'\`. \`Astro.request.headers\` is not available on prerendered pages. If you need access to request headers, make sure that the page is server-rendered using \`export const prerender = false;\` or by setting \`output\` to \`"server"\` in your Astro config to make all your pages server-rendered by default.`,
 				);
 				return _headers;
 			},

diff --git a/packages/astro/src/vite-plugin-astro-server/route.ts b/packages/astro/src/vite-plugin-astro-server/route.ts
@@ -174,6 +174,7 @@ export async function handleRoute({
 		logger,
 		clientAddress: incomingRequest.socket.remoteAddress,
 		isPrerendered: route.prerender,
+		routePattern: route.component
 	});
 
 	// Set user specified headers to response object.