Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 20 additions & 7 deletions packages/playwright-core/src/server/browserContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -309,8 +309,11 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
}

async clearCookies(options: {name?: string | RegExp, domain?: string | RegExp, path?: string | RegExp}): Promise<void> {
const currentCookies = await this._cookies();
await this.doClearCookies();
const hasFilter = options.name !== undefined || options.domain !== undefined || options.path !== undefined;
if (!hasFilter) {
await this.doClearCookies();
return;
}

const matches = (cookie: channels.NetworkCookie, prop: 'name' | 'domain' | 'path', value: string | RegExp | undefined) => {
if (!value)
Expand All @@ -322,13 +325,23 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
return cookie[prop] === value;
};

const cookiesToReadd = currentCookies.filter(cookie => {
return !matches(cookie, 'name', options.name)
|| !matches(cookie, 'domain', options.domain)
|| !matches(cookie, 'path', options.path);
const currentCookies = await this._cookies();
const cookiesToExpire = currentCookies.filter(cookie => {
return matches(cookie, 'name', options.name)
&& matches(cookie, 'domain', options.domain)
&& matches(cookie, 'path', options.path);
});

await this.addCookies(cookiesToReadd);
if (!cookiesToExpire.length)
return;

await this.addCookies(cookiesToExpire.map(cookie => ({
name: cookie.name,
value: '',
domain: cookie.domain,
path: cookie.path,
expires: 0,
})));
}

setHTTPCredentials(progress: Progress, httpCredentials?: types.Credentials): Promise<void> {
Expand Down
42 changes: 42 additions & 0 deletions tests/library/browsercontext-clearcookies.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,45 @@ it('should remove cookies by name and domain', async ({ context, page, server })
await page.goto(server.CROSS_PROCESS_PREFIX);
expect(await page.evaluate('document.cookie')).toBe('cookie1=1');
});

it('should not transiently delete non-matching cookies when filtering', {
annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/40953' },
}, async ({ context, page, server, browserName }) => {
it.skip(browserName !== 'chromium', 'cookieStore API is only available in Chromium');

await context.addCookies([{
name: 'keep_me',
value: '1',
domain: new URL(server.PREFIX).hostname,
path: '/',
},
{
name: 'delete_me',
value: '2',
domain: new URL(server.PREFIX).hostname,
path: '/',
}
]);
await page.goto(server.PREFIX);

await page.evaluate(() => {
(window as any).__cookieEvents = [];
(window as any).cookieStore.addEventListener('change', (event: any) => {
for (const changed of event.changed)
(window as any).__cookieEvents.push({ kind: 'changed', name: changed.name });
for (const deleted of event.deleted)
(window as any).__cookieEvents.push({ kind: 'deleted', name: deleted.name });
});
});

await context.clearCookies({ name: 'delete_me' });

// Flush microtasks so any change events fired during clearCookies are observed.
await page.evaluate(() => new Promise(resolve => setTimeout(resolve, 50)));

const events: { kind: string, name: string }[] = await page.evaluate(() => (window as any).__cookieEvents);

// The kept cookie must never appear in a deletion event.
expect(events.filter(e => e.kind === 'deleted' && e.name === 'keep_me')).toEqual([]);
expect(await page.evaluate('document.cookie')).toBe('keep_me=1');
});