summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Ben Holmes <hey@bholmes.dev> 2024-05-21 12:36:58 -0400
committerGravatar GitHub <noreply@github.com> 2024-05-21 12:36:58 -0400
commita5d79ddeb2d592de9eb2468471fdcf3eea5ef730 (patch)
treea3ee2a366cec7faeed63be339c585e2d5ba00112
parent3cc3e2ccba062749a6bd8469bc88ff797bea0abc (diff)
downloadastro-a5d79ddeb2d592de9eb2468471fdcf3eea5ef730.tar.gz
astro-a5d79ddeb2d592de9eb2468471fdcf3eea5ef730.tar.zst
astro-a5d79ddeb2d592de9eb2468471fdcf3eea5ef730.zip
Actions: stop warning about `headers` usage on prerendered routes (#11111)
* fix: handle GET requests and prerendered routes * chore: changeset
-rw-r--r--.changeset/wild-hounds-repair.md5
-rw-r--r--packages/astro/src/actions/runtime/middleware.ts27
2 files changed, 32 insertions, 0 deletions
diff --git a/.changeset/wild-hounds-repair.md b/.changeset/wild-hounds-repair.md
new file mode 100644
index 000000000..f9966f826
--- /dev/null
+++ b/.changeset/wild-hounds-repair.md
@@ -0,0 +1,5 @@
+---
+"astro": patch
+---
+
+Fix unexpected `headers` warning on prerendered routes when using Astro Actions.
diff --git a/packages/astro/src/actions/runtime/middleware.ts b/packages/astro/src/actions/runtime/middleware.ts
index a416974b6..192e7410c 100644
--- a/packages/astro/src/actions/runtime/middleware.ts
+++ b/packages/astro/src/actions/runtime/middleware.ts
@@ -3,6 +3,7 @@ import { defineMiddleware } from '../../core/middleware/index.js';
import { ApiContextStorage } from './store.js';
import { formContentTypes, getAction, hasContentType } from './utils.js';
import { callSafely } from './virtual/shared.js';
+import { yellow } from 'kleur/colors';
export type Locals = {
_actionsInternal: {
@@ -12,6 +13,16 @@ export type Locals = {
export const onRequest = defineMiddleware(async (context, next) => {
const locals = context.locals as Locals;
+ if (context.request.method === 'GET') {
+ return nextWithLocalsStub(next, locals);
+ }
+
+ // Heuristic: If body is null, Astro might've reset this for prerendering.
+ // Stub with warning when `getActionResult()` is used.
+ if (context.request.method === 'POST' && context.request.body === null) {
+ return nextWithStaticStub(next, locals);
+ }
+
// Actions middleware may have run already after a path rewrite.
// See https://github.com/withastro/roadmap/blob/feat/reroute/proposals/0047-rerouting.md#ctxrewrite
// `_actionsInternal` is the same for every page,
@@ -58,6 +69,22 @@ export const onRequest = defineMiddleware(async (context, next) => {
return response;
});
+function nextWithStaticStub(next: MiddlewareNext, locals: Locals) {
+ Object.defineProperty(locals, '_actionsInternal', {
+ writable: false,
+ value: {
+ getActionResult: () => {
+ console.warn(
+ yellow('[astro:actions]'),
+ '`getActionResult()` should not be called on prerendered pages. Astro can only handle actions for pages rendered on-demand.'
+ );
+ return undefined;
+ },
+ },
+ });
+ return next();
+}
+
function nextWithLocalsStub(next: MiddlewareNext, locals: Locals) {
Object.defineProperty(locals, '_actionsInternal', {
writable: false,