fix: pass through headers on middleware redirect (#273)

Author: relsunkaev

examples/app-pages-router/middleware.ts

@@ -7,7 +7,9 @@ export function middleware(request: NextRequest) {
   const protocol = host?.startsWith("localhost") ? "http" : "https";
   if (path === "/redirect") {
     const u = new URL("/redirect-destination", `${protocol}://${host}`);
-    return NextResponse.redirect(u);
+    return NextResponse.redirect(u, {
+      headers: { "set-cookie": "test=success" },
+    });
   } else if (path === "/rewrite") {
     const u = new URL("/rewrite-destination", `${protocol}://${host}`);
     return NextResponse.rewrite(u);

examples/app-router/middleware.ts

@@ -7,7 +7,9 @@ export function middleware(request: NextRequest) {
   const protocol = host?.startsWith("localhost") ? "http" : "https";
   if (path === "/redirect") {
     const u = new URL("/redirect-destination", `${protocol}://${host}`);
-    return NextResponse.redirect(u);
+    return NextResponse.redirect(u, {
+      headers: { "set-cookie": "test=success" },
+    });
   } else if (path === "/rewrite") {
     const u = new URL("/rewrite-destination", `${protocol}://${host}`);
     return NextResponse.rewrite(u);

packages/open-next/src/adapters/routing/middleware.ts

@@ -86,23 +86,6 @@ export async function handleMiddleware(
     onWarning: console.warn,
   });
   res.statusCode = result.response.status;
-  // If the middleware returned a Redirect, we set the `Location` header with
-  // the redirected url and end the response.
-  if (res.statusCode >= 300 && res.statusCode < 400) {
-    const location = result.response.headers
-      .get("location")
-      ?.replace("http://localhost:3000", `https://${req.headers.host}`);
-    // res.setHeader("Location", location);
-    return {
-      body: "",
-      type: internalEvent.type,
-      statusCode: res.statusCode,
-      headers: {
-        Location: location,
-      },
-      isBase64Encoded: false,
-    };
-  }
 
   /* Apply override headers from middleware
     NextResponse.next({
@@ -133,6 +116,25 @@ export async function handleMiddleware(
     }
   });
 
+  // If the middleware returned a Redirect, we set the `Location` header with
+  // the redirected url and end the response.
+  if (res.statusCode >= 300 && res.statusCode < 400) {
+    const location = result.response.headers
+      .get("location")
+      ?.replace("http://localhost:3000", `https://${req.headers.host}`);
+    // res.setHeader("Location", location);
+    return {
+      body: "",
+      type: internalEvent.type,
+      statusCode: res.statusCode,
+      headers: {
+        ...resHeaders,
+        Location: location,
+      },
+      isBase64Encoded: false,
+    };
+  }
+
   // If the middleware returned a Rewrite, set the `url` to the pathname of the rewrite
   // NOTE: the header was added to `req` from above
   const rewriteUrl = responseHeaders.get("x-middleware-rewrite");

packages/tests-e2e/tests/appPagesRouter/middleware.redirect.test.ts

@@ -1,17 +1,22 @@
 import { expect, test } from "@playwright/test";
 
-test("Middleware Redirect", async ({ page }) => {
+test("Middleware Redirect", async ({ page, context }) => {
   await page.goto("/");
   await page.locator('[href="/redirect"]').click();
 
   // URL is immediately redirected
-  await page.waitForURL(`/redirect-destination`);
+  await page.waitForURL("/redirect-destination");
   let el = page.getByText("Redirect Destination", { exact: true });
   await expect(el).toBeVisible();
 
   // Loading page should also redirect
-  await page.goto(`/redirect`);
-  await page.waitForURL(`/redirect-destination`);
+  await page.goto("/redirect");
+  await page.waitForURL("/redirect-destination");
+  expect(
+    await context
+      .cookies()
+      .then((res) => res.find((cookie) => cookie.name === "test")?.value),
+  ).toBe("success");
   el = page.getByText("Redirect Destination", { exact: true });
   await expect(el).toBeVisible();
 });

packages/tests-e2e/tests/appRouter/middleware.redirect.test.ts

@@ -1,6 +1,6 @@
 import { expect, test } from "@playwright/test";
 
-test("Middleware Redirect", async ({ page }) => {
+test("Middleware Redirect", async ({ page, context }) => {
   await page.goto("/");
   await page.getByRole("link", { name: "/Redirect" }).click();
 
@@ -10,8 +10,13 @@ test("Middleware Redirect", async ({ page }) => {
   await expect(el).toBeVisible();
 
   // Loading page should also redirect
-  await page.goto(`/redirect`);
-  await page.waitForURL(`/redirect-destination`);
+  await page.goto("/redirect");
+  await page.waitForURL("/redirect-destination");
+  expect(
+    await context
+      .cookies()
+      .then((res) => res.find((cookie) => cookie.name === "test")?.value),
+  ).toBe("success");
   el = page.getByText("Redirect Destination", { exact: true });
   await expect(el).toBeVisible();
 });

packages/tests-unit/tsconfig.json

@@ -28,6 +28,6 @@
   "exclude": [
     "dist",
     "build",
-    "node_modules",
+    "node_modules"
   ]
 }