microsoft__playwright/tests/library/browsercontext-clearcookies.spec.ts

/**
 * Copyright 2018 Google Inc. All rights reserved.
 * Modifications copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { contextTest as it, expect } from '../config/browserTest';

it('should clear cookies', async ({ context, page, server }) => {
  await page.goto(server.EMPTY_PAGE);
  await context.addCookies([{
    url: server.EMPTY_PAGE,
    name: 'cookie1',
    value: '1'
  }]);
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1');
  await context.clearCookies();
  expect(await context.cookies()).toEqual([]);
  await page.reload();
  expect(await page.evaluate('document.cookie')).toBe('');
});

it('should isolate cookies when clearing', async ({ context, server, browser }) => {
  const anotherContext = await browser.newContext();
  await context.addCookies([{ url: server.EMPTY_PAGE, name: 'page1cookie', value: 'page1value' }]);
  await anotherContext.addCookies([{ url: server.EMPTY_PAGE, name: 'page2cookie', value: 'page2value' }]);

  expect((await context.cookies()).length).toBe(1);
  expect((await anotherContext.cookies()).length).toBe(1);

  await context.clearCookies();
  expect((await context.cookies()).length).toBe(0);
  expect((await anotherContext.cookies()).length).toBe(1);

  await anotherContext.clearCookies();
  expect((await context.cookies()).length).toBe(0);
  expect((await anotherContext.cookies()).length).toBe(0);
  await anotherContext.close();
});

it('should remove cookies by name', async ({ context, page, server }) => {
  await context.addCookies([{
    name: 'cookie1',
    value: '1',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  },
  {
    name: 'cookie2',
    value: '2',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  }
  ]);
  await page.goto(server.PREFIX);
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1; cookie2=2');
  await context.clearCookies({ name: 'cookie1' });
  expect(await page.evaluate('document.cookie')).toBe('cookie2=2');
});

it('should remove cookies by name regex', async ({ context, page, server }) => {
  await context.addCookies([{
    name: 'cookie1',
    value: '1',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  },
  {
    name: 'cookie2',
    value: '2',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  }
  ]);
  await page.goto(server.PREFIX);
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1; cookie2=2');
  await context.clearCookies({ name: /coo.*1/ });
  expect(await page.evaluate('document.cookie')).toBe('cookie2=2');
});

it('should remove cookies by domain', async ({ context, page, server }) => {
  await context.addCookies([{
    name: 'cookie1',
    value: '1',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  },
  {
    name: 'cookie2',
    value: '2',
    domain: new URL(server.CROSS_PROCESS_PREFIX).hostname,
    path: '/',
  }
  ]);
  await page.goto(server.PREFIX);
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1');
  await page.goto(server.CROSS_PROCESS_PREFIX);
  expect(await page.evaluate('document.cookie')).toBe('cookie2=2');
  await context.clearCookies({ domain: new URL(server.CROSS_PROCESS_PREFIX).hostname });
  expect(await page.evaluate('document.cookie')).toBe('');
  await page.goto(server.PREFIX);
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1');
});

it('should remove cookies by path', async ({ context, page, server }) => {
  await context.addCookies([{
    name: 'cookie1',
    value: '1',
    domain: new URL(server.PREFIX).hostname,
    path: '/api/v1',
  },
  {
    name: 'cookie2',
    value: '2',
    domain: new URL(server.PREFIX).hostname,
    path: '/api/v2',
  },
  {
    name: 'cookie3',
    value: '3',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  }
  ]);
  await page.goto(server.PREFIX + '/api/v1');
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1; cookie3=3');
  await context.clearCookies({ path: '/api/v1' });
  expect(await page.evaluate('document.cookie')).toBe('cookie3=3');
  await page.goto(server.PREFIX + '/api/v2');
  expect(await page.evaluate('document.cookie')).toBe('cookie2=2; cookie3=3');
  await page.goto(server.PREFIX + '/');
  expect(await page.evaluate('document.cookie')).toBe('cookie3=3');
});

it('should remove cookies by name and domain', async ({ context, page, server }) => {
  await context.addCookies([{
    name: 'cookie1',
    value: '1',
    domain: new URL(server.PREFIX).hostname,
    path: '/',
  },
  {
    name: 'cookie1',
    value: '1',
    domain: new URL(server.CROSS_PROCESS_PREFIX).hostname,
    path: '/',
  }
  ]);
  await page.goto(server.PREFIX);
  expect(await page.evaluate('document.cookie')).toBe('cookie1=1');
  await context.clearCookies({ name: 'cookie1', domain: new URL(server.PREFIX).hostname });
  expect(await page.evaluate('document.cookie')).toBe('');
  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, isWindows, isFrozenWebkit }) => {
  it.skip(browserName === 'webkit' && isWindows, 'cookieStore change events not supported on WebKit/Windows (curl backend lacks cookie change notifications)');
  it.skip(isFrozenWebkit);

  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);

  const eventsHandle = await page.evaluateHandle(() => {
    const events: string[] = [];
    cookieStore.addEventListener('change', event => {
      for (const changed of event.changed)
        events.push(`changed ${changed.name}`);
      for (const deleted of event.deleted)
        events.push(`deleted ${deleted.name}`);
    });
    return events;
  });

  await context.clearCookies({ name: 'delete_me' });
  await expect.poll(() => eventsHandle.jsonValue()).toEqual(['deleted delete_me']);
  expect(await page.evaluate('document.cookie')).toBe('keep_me=1');
});

it('should remove partitioned cookies by name', {
  annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/40953' },
}, async ({ browser, httpsServer, browserName }) => {
  it.skip(browserName !== 'chromium', 'Partitioned cookies (CHIPS) are Chromium-specific');
  const context = await browser.newContext({ ignoreHTTPSErrors: true });
  await context.addCookies([
    {
      name: 'delete_me',
      value: '1',
      domain: httpsServer.HOSTNAME,
      path: '/',
      secure: true,
      sameSite: 'None',
      partitionKey: `https://${httpsServer.HOSTNAME}`,
    },
    {
      name: 'keep_me',
      value: '2',
      domain: httpsServer.HOSTNAME,
      path: '/',
      secure: true,
      sameSite: 'None',
      partitionKey: `https://${httpsServer.HOSTNAME}`,
    },
  ]);
  const before = await context.cookies();
  expect(before).toEqual([
    expect.objectContaining({ name: 'delete_me', partitionKey: `https://${httpsServer.HOSTNAME}` }),
    expect.objectContaining({ name: 'keep_me', partitionKey: `https://${httpsServer.HOSTNAME}` }),
  ]);

  await context.clearCookies({ name: 'delete_me' });
  expect(await context.cookies()).toEqual([
    expect.objectContaining({ name: 'keep_me', partitionKey: `https://${httpsServer.HOSTNAME}` }),
  ]);
  await context.close();
});