Set test headers via page.router API (#55087)

This change enables the test code to use `setExtraHTTPHeaders` without affecting the testmode functions. Fixes: #54706.
vercel · Sep 8, 2023 · 5b85a40 · 5b85a40
1 parent 12252c2
commit 5b85a40
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 18 deletions.
diff --git a/packages/next/src/experimental/testmode/playwright/index.ts b/packages/next/src/experimental/testmode/playwright/index.ts
@@ -40,16 +40,11 @@ export const test = base.test.extend<
   ],
 
   next: [
-    async (
-      { nextOptions, _nextWorker, page, extraHTTPHeaders },
-      use,
-      testInfo
-    ) => {
+    async ({ nextOptions, _nextWorker, page }, use, testInfo) => {
       await applyNextFixture(use, {
         testInfo,
         nextWorker: _nextWorker,
         page,
-        extraHTTPHeaders,
         nextOptions,
       })
     },

diff --git a/packages/next/src/experimental/testmode/playwright/next-fixture.ts b/packages/next/src/experimental/testmode/playwright/next-fixture.ts
@@ -17,9 +17,15 @@ class NextFixtureImpl implements NextFixture {
     private worker: NextWorkerFixture,
     private page: Page
   ) {
+    const testHeaders = {
+      'Next-Test-Proxy-Port': String(worker.proxyPort),
+      'Next-Test-Data': testId,
+    }
     const handleFetch = this.handleFetch.bind(this)
     worker.onFetch(testId, handleFetch)
-    this.page.route('**', (route) => handleRoute(route, page, handleFetch))
+    this.page.route('**', (route) =>
+      handleRoute(route, page, testHeaders, handleFetch)
+    )
   }
 
   teardown(): void {
@@ -51,13 +57,11 @@ export async function applyNextFixture(
     nextOptions,
     nextWorker,
     page,
-    extraHTTPHeaders,
   }: {
     testInfo: TestInfo
     nextOptions: NextOptions
     nextWorker: NextWorkerFixture
     page: Page
-    extraHTTPHeaders: Record<string, string> | undefined
   }
 ): Promise<void> {
   const fixture = new NextFixtureImpl(
@@ -66,11 +70,6 @@ export async function applyNextFixture(
     nextWorker,
     page
   )
-  page.setExtraHTTPHeaders({
-    ...extraHTTPHeaders,
-    'Next-Test-Proxy-Port': String(nextWorker.proxyPort),
-    'Next-Test-Data': fixture.testId,
-  })
 
   await use(fixture)
 

diff --git a/packages/next/src/experimental/testmode/playwright/page-route.ts b/packages/next/src/experimental/testmode/playwright/page-route.ts
@@ -1,24 +1,38 @@
-import type { Page, Route } from '@playwright/test'
+import type { Page, Route, Request } from '@playwright/test'
 import type { FetchHandler } from './next-worker-fixture'
 
+function continueRoute(
+  route: Route,
+  request: Request,
+  testHeaders: Record<string, string>
+): Promise<void> {
+  return route.continue({
+    headers: {
+      ...request.headers(),
+      ...testHeaders,
+    },
+  })
+}
+
 export async function handleRoute(
   route: Route,
   page: Page,
+  testHeaders: Record<string, string>,
   fetchHandler: FetchHandler | null
 ) {
   const request = route.request()
 
   // Continue the navigation and non-fetch requests.
   if (request.isNavigationRequest() || request.resourceType() !== 'fetch') {
-    return route.continue()
+    return continueRoute(route, request, testHeaders)
   }
 
   // Continue the local requests. The followup requests will be intercepted
   // on the server.
   const pageOrigin = new URL(page.url()).origin
   const requestOrigin = new URL(request.url()).origin
   if (pageOrigin === requestOrigin) {
-    return route.continue()
+    return continueRoute(route, request, testHeaders)
   }
 
   if (!fetchHandler) {
@@ -44,7 +58,7 @@ export async function handleRoute(
     return route.abort()
   }
   if (proxyResponse === 'continue') {
-    return route.continue()
+    return continueRoute(route, request, testHeaders)
   }
   const { status, headers, body } = proxyResponse
   return route.fulfill({