Cookies: Retrieving and filtering by URLs

[robingustafsson]

Add support for BrowserContext.cookies([urls]), to return all cookies or only cookies for specified URLs in browser context.

Relevant links:

• Playwright docs
• Playwright code: 1 and 2
• Playwright browserContext.cookies tests

Tasks

Beta Give feedback

1. Stabilize cookie handling #1008
   cookies refactor +2
   
2. Retrieve all cookies #1005
   cookies feature +2
   
3. Provide a consistent cookie API #1030
   refactor security tests +3
   
4. Cookies: Setting the expiration property fails while adding cookies #1025
   bug cookies +2
   
5. Filter cookies by URLs #1016
   cookies feature +2
   
6. Cookies: Fix Goja conversions #1039
   bug cookies +2
   
7. Docs: Browser cookies k6-docs#1328
   Area: browser +1
   
8. [k6/experimental/browser] Add context.cookies and improve cookie TS definitions k6-DefinitelyTyped#14
   browser +1
   
9. Add improved cookie API release notes k6#3352
   area: browser +1
   

[robingustafsson]

It might be neat if these cookies could be easily transferred to the protocol-level http.* APIs.

[robingustafsson]

A possible workaround until this API is implemented if the cookie you're trying to access is not a HttpOnly cookie you can use something like this:

import launcher from 'k6/x/browser';

export default function() {
  const browser = launcher.launch('chromium', {
        headless: __ENV.XK6_HEADLESS ? true : false,
	slowMo: '500ms' // slow down by 500ms
  });
  const context = browser.newContext();
  const page = context.newPage();

  page.goto('https://google.com/', { waitUntil: 'networkidle' });
  const cookies = page.evaluate(_ => {
      return Object.fromEntries(document.cookie.split('; ').map(x => x.split(/=(.*)$/,2).map(decodeURIComponent)));
  });
  console.log(JSON.stringify(cookies));

  page.close();
  browser.close();
}