first commit

test/e2e/middleware-request-header-overrides/app/.gitignore

@@ -0,0 +1 @@
+.vercel

test/e2e/middleware-request-header-overrides/app/middleware.js

@@ -0,0 +1,30 @@
+import { NextResponse } from 'next/server'
+
+/**
+ * @param {import('next/server').NextRequest} request
+ */
+export async function middleware(request) {
+  const headers = new Headers(request.headers)
+  headers.set('x-from-middleware', 'hello-from-middleware')
+
+  const removeHeaders = request.nextUrl.searchParams.get('remove-headers')
+  if (removeHeaders) {
+    for (const key of removeHeaders.split(',')) {
+      headers.delete(key)
+    }
+  }
+
+  const updateHeader = request.nextUrl.searchParams.get('update-headers')
+  if (updateHeader) {
+    for (const kv of updateHeader.split(',')) {
+      const [key, value] = kv.split('=')
+      headers.set(key, value)
+    }
+  }
+
+  return NextResponse.next({
+    request: {
+      headers,
+    },
+  })
+}

test/e2e/middleware-request-header-overrides/app/next.config.js

@@ -0,0 +1 @@
+module.exports = {}

test/e2e/middleware-request-header-overrides/app/pages/api/dump-headers-edge.js

@@ -0,0 +1,11 @@
+export const config = {
+  runtime: 'edge',
+}
+
+export default (req) => {
+  return Response.json(Object.fromEntries(req.headers.entries()), {
+    headers: {
+      'headers-from-edge-function': '1',
+    },
+  })
+}

test/e2e/middleware-request-header-overrides/app/pages/api/dump-headers-serverless.js

@@ -0,0 +1,6 @@
+export default (req, res) => {
+  return res
+    .status(200)
+    .setHeader('headers-from-serverless', '1')
+    .json(req.headers)
+}

test/e2e/middleware-request-header-overrides/app/pages/ssr-page.js

@@ -0,0 +1,15 @@
+export default function SSRPage({ headers }) {
+  return (
+    <>
+      <p id="headers">{JSON.stringify(headers)}</p>
+    </>
+  )
+}
+
+export const getServerSideProps = (ctx) => {
+  return {
+    props: {
+      headers: ctx.req.headers,
+    },
+  }
+}

test/e2e/middleware-request-header-overrides/test/index.test.ts

@@ -0,0 +1,120 @@
+/* eslint-env jest */
+
+import { join } from 'path'
+import { NextInstance } from 'e2e-utils'
+import { fetchViaHTTP } from 'next-test-utils'
+import { createNext, FileRef } from 'e2e-utils'
+import cheerio from 'cheerio'
+import type { Response } from 'node-fetch'
+
+describe('Middleware Request Headers Overrides', () => {
+  let next: NextInstance
+
+  afterAll(() => next.destroy())
+  beforeAll(async () => {
+    next = await createNext({
+      files: {
+        pages: new FileRef(join(__dirname, '../app/pages')),
+        'next.config.js': new FileRef(join(__dirname, '../app/next.config.js')),
+        'middleware.js': new FileRef(join(__dirname, '../app/middleware.js')),
+      },
+    })
+  })
+
+  describe.each([
+    {
+      title: 'Serverless Functions',
+      path: '/api/dump-headers-serverless',
+      toJson: (res: Response) => res.json(),
+    },
+    {
+      title: 'Edge Functions',
+      path: '/api/dump-headers-edge',
+      toJson: (res: Response) => res.json(),
+    },
+    {
+      title: 'getServerSideProps',
+      path: '/ssr-page',
+      toJson: async (res: Response) => {
+        const $ = cheerio.load(await res.text())
+        return JSON.parse($('#headers').text())
+      },
+    },
+  ])('$title Backend', ({ path, toJson }) => {
+    it(`Adds new headers`, async () => {
+      const res = await fetchViaHTTP(next.url, path, null, {
+        headers: {
+          'x-from-client': 'hello-from-client',
+        },
+      })
+      expect(await toJson(res)).toMatchObject({
+        'x-from-client': 'hello-from-client',
+        'x-from-middleware': 'hello-from-middleware',
+      })
+    })
+
+    it(`Deletes headers`, async () => {
+      const res = await fetchViaHTTP(
+        next.url,
+        path,
+        {
+          'remove-headers': 'x-from-client1,x-from-client2',
+        },
+        {
+          headers: {
+            'x-from-client1': 'hello-from-client',
+            'X-From-Client2': 'hello-from-client',
+          },
+        }
+      )
+
+      const json = await toJson(res)
+      expect(json).not.toHaveProperty('x-from-client1')
+      expect(json).not.toHaveProperty('X-From-Client2')
+      expect(json).toMatchObject({
+        'x-from-middleware': 'hello-from-middleware',
+      })
+
+      // Should not be included in response headers.
+      expect(res.headers.get('x-middleware-override-headers')).toBeNull()
+      expect(
+        res.headers.get('x-middleware-request-x-from-middleware')
+      ).toBeNull()
+      expect(res.headers.get('x-middleware-request-x-from-client1')).toBeNull()
+      expect(res.headers.get('x-middleware-request-x-from-client2')).toBeNull()
+    })
+
+    it(`Updates headers`, async () => {
+      const res = await fetchViaHTTP(
+        next.url,
+        path,
+        {
+          'update-headers':
+            'x-from-client1=new-value1,x-from-client2=new-value2',
+        },
+        {
+          headers: {
+            'x-from-client1': 'old-value1',
+            'X-From-Client2': 'old-value2',
+            'x-from-client3': 'old-value3',
+          },
+        }
+      )
+      expect(await toJson(res)).toMatchObject({
+        'x-from-client1': 'new-value1',
+        'x-from-client2': 'new-value2',
+        'x-from-client3': 'old-value3',
+        'x-from-middleware': 'hello-from-middleware',
+      })
+
+      // Should not be included in response headers.
+      expect(res.headers.get('x-middleware-override-headers')).toBeNull()
+      expect(
+        res.headers.get('x-middleware-request-x-from-middleware')
+      ).toBeNull()
+      expect(res.headers.get('x-middleware-request-x-from-client1')).toBeNull()
+      expect(res.headers.get('x-middleware-request-x-from-client2')).toBeNull()
+      expect(res.headers.get('x-middleware-request-x-from-client3')).toBeNull()
+    })
+  })
+})