Add capability to observe the cookie state

[miherlosev]

TestCafe uses the own cookie processing mechanism. It leads to a user cannot see the full cookie list same as in the browser development tools.

We need to provide such information. It will be useful for complex authentication cases.

#1721 (comment)

[alexey-lin]

#4425

[AndreyBelym]

https://stackoverflow.com/questions/59957576/how-to-get-httponly-secure-cookies-testcafe/59984223#59984223

[austinhinderer]

I'm still hitting this issue at the end of 2020. Unable to read httpOnly cookies in testCafe.

[Farfurix]

@austinhinderer

Hello,

Unfortunately, I cannot give you any time estimates on when this enhancement will be addressed.

[deepaneela]

It will be helpful to have this feature which will get all the cookies including httpOnly, secure basically all cookies we see in dev tools.

[jamesyoung1337]

For the moment, you can use a work-around to access httpOnly cookies:

My answer on Stack Overflow

Here it is again anyway:

import { Selector, RequestLogger } from 'testcafe';

// Want everything from example.com
const logger = RequestLogger(/example.com/, {
   logResponseHeaders: true,
   logResponseBody: true
   // Do not set stringify response body if your response
   // comes as gzip or brotli or whatever, instead you
   // will need to use Node's zlib to unzip it and read it
});

fixture `My test`
   .page `https://example.com`
   .requestHooks(logger);

test(`Log in and retrieve cookies`, async t => {
   
   await t
   // Do things here
   .click(...)

   const requests = logger.requests
   for (const req of requests) {
       console.log('Headers: ', req.response.headers)

       for (const cookie of req.response.headers['set-cookie']) {
          // You will have to parse the cookie yourself
          console.log(cookie)
       }
   }
});

You may need to wrap your code in a promise and await on it, especially if you access the body as JSON like I do in addition to the cookies, otherwise code after this request logger block may be executed before you read the body.

[helen-dikareva]

An advanced cookie management API was released in v1.19.0. We added new flexible cross-browser methods that allow you to manipulate browser cookies with ease even if they have the HttpOnly flag specified.

The following example demonstrates how to obtain all cookies from all testing pages:

const allCookies =  await t.getCookies();

Learn more about each cookie method in our docs:
getCookies
setCookies
deleteCookies