Skip to content

fix(routeFromHAR): hack harRouter to merge set-cookie headers #38255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+24 −1
Closed

fix(routeFromHAR): hack harRouter to merge set-cookie headers #38255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion packages/playwright-core/src/client/harRouter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,16 @@ export class HarRouter {
// test when HAR was recorded but we'd abort it immediately.
if (response.status === -1)
return;

// route.fulfill does not support multiple set-cookie headers. We need to merge them into one.
const setCookieHeaders = response.headers!.filter(h => h.name.toLowerCase() === 'set-cookie');
const transformedHeaders = response.headers!.filter(h => h.name.toLowerCase() !== 'set-cookie');
if (setCookieHeaders.length > 1)
Copy link
Member

@yury-s yury-s Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will delete set-cookie header if there is only one entry. Let's add a test for that case. Also let's not take original headers array if there is no set-cookie header.

transformedHeaders.push({ name: 'set-cookie', value: setCookieHeaders.map(h => h.value).join('\n') });

await route.fulfill({
status: response.status,
headers: Object.fromEntries(response.headers!.map(h => [h.name, h.value])),
headers: Object.fromEntries(transformedHeaders.map(h => [h.name, h.value])),
body: response.body!
});
return;
Expand Down
8 changes: 8 additions & 0 deletions tests/assets/har-fulfill.har
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@
{
"name": "content-type",
"value": "text/html"
},
{
"name": "Set-Cookie",
"value": "playwright=works;"
},
{
"name": "Set-Cookie",
"value": "with=multiple-set-cookie-headers;"
}
],
"content": {
Expand Down
8 changes: 8 additions & 0 deletions tests/library/browsercontext-har.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,14 @@ it('should record overridden requests to har', async ({ contextFactory, server }
expect(await page2.evaluate(fetchFunction, { path: '/echo', body: '12' })).toBe('12');
});

it('should replay requests with multiple set-cookie headers properly', async ({ context, asset }) => {
Copy link
Member

@yury-s yury-s Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also add a test for recording and replaying a multicookie:

diff --git i/tests/library/browsercontext-har.spec.ts w/tests/library/browsercontext-har.spec.ts
index 6e6404590..4f5c39581 100644
--- i/tests/library/browsercontext-har.spec.ts
+++ w/tests/library/browsercontext-har.spec.ts
@@ -452,6 +452,33 @@ it('should ignore boundary when matching multipart/form-data body', {
   await expect(page2.locator('div')).toHaveText('done');
 });
 
+it('should record multiple set-cookie headers', {
+  annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/31495' }
+}, async ({ contextFactory, server }, testInfo) => {
+  server.setRoute('/empty.html', (req, res) => {
+    res.setHeader('Content-Type', 'text/html');
+    res.setHeader('set-cookie', ['first=foo', 'second=bar']);
+    res.end();
+  });
+
+  const harPath = testInfo.outputPath('har.zip');
+  console.log('HAR path:', harPath);
+  const context1 = await contextFactory();
+  await context1.routeFromHAR(harPath, { update: true });
+  const page1 = await context1.newPage();
+  await page1.goto(server.EMPTY_PAGE);
+  const cookie1 = await page1.evaluate(() => document.cookie);
+  expect(cookie1.split('; ').sort().join('; ')).toBe('first=foo; second=bar');
+  await context1.close();
+
+  const context2 = await contextFactory();
+  await context2.routeFromHAR(harPath, { notFound: 'abort' });
+  const page2 = await context2.newPage();
+  await page2.goto(server.EMPTY_PAGE);
+  const cookie2 = await page2.evaluate(() => document.cookie);
+  expect(cookie2.split('; ').sort().join('; ')).toBe('first=foo; second=bar');
+});
+
 it('should update har.zip for page', async ({ contextFactory, server }, testInfo) => {
   const harPath = testInfo.outputPath('har.zip');
   const context1 = await contextFactory();

const path = asset('har-fulfill.har');
await context.routeFromHAR(path);
const page = await context.newPage();
await page.goto('http://no.playwright/');
expect(await page.context().cookies()).toEqual([expect.objectContaining({ name: 'playwright', value: 'works' }), expect.objectContaining({ name: 'with', value: 'multiple-set-cookie-headers' })]);
});

it('should disambiguate by header', async ({ contextFactory, server }, testInfo) => {
server.setRoute('/echo', async (req, res) => {
res.end(req.headers['baz']);
Expand Down