Ability to set cookies

[Friss]

Having the ability to specify / pass cookies would be really helpful for testing pages that are behind auth or interact with authed endpoints.

[patrickhulce]

Thanks for filing @Friss! This is awaiting work on Lighthouse core (GoogleChrome/lighthouse#9170), once it's available it will be available here too :)

[patrickhulce]

Also FWIW, if you don't need any cookie merging or other functionality in GoogleChrome/lighthouse#9170, you can get this working today with a lighthouserc.json like...

{
  "ci": {
    "collect": {
      "settings": {
        "extraHeaders": "{\"Cookie\": \"session_id=whatever-session-id\"}"
      }
    }
  }
}

[patrickhulce]

Also https://github.com/GoogleChrome/lighthouse/blob/master/docs/authenticated-pages.md is a great resource for running Lighthouse on authenticated pages :)

[Friss]

Thanks for the recommendations @patrickhulce. I was unable to make the extraHeaders way work. I couldn't really debug why since the page would be redirected and the browser would close before I had a chance to look any further. So the upstream PR may help.

I was able to create a puppeteer script that worked for our auth flow (via page.setCookie's). And then I passed a port option and the underlying lighthouse cli was able to connect to it.

Here's a gist of what I got to work for me. (I dynamically create the config file from my testing with extraHeader so that part isn't exactly necessary anymore)
https://gist.github.com/Friss/6c20241725e36f2abc8d8c6d7cb5ad16

Couple things of note:

1. I had to pass the config as --rcFile instead of --config that the docs mention.
2. extraHeaders needs to be a JSON string or a file path. extraHeaders code

[patrickhulce]

Thanks so much for the troubleshooting and extra info @Friss! :)

I had to pass the config as --rcFile instead of --config that the docs mention.

This was a late breaking change in the API, 0.3.0-alpha.0 was rcFile but 0.3.0 (published late today) and newer follow the docs, sorry about that!

extraHeaders needs to be a JSON string or a file path. extraHeaders code

Ah, drat this is indeed a bug with the CLI form of Lighthouse. Will file an issue upstream 👍

[Draichi]

Not working for me

I've tried both ways:

"settings": {
        "extraHeaders": "{\"Cookie\": \"PHPSESSID=1234\"}"
      }

"settings": {
        "extraHeaders": {"Cookie": "session_id=whatever-session-id"}
      }

Not working

[patrickhulce]

Not working

Can you provide more detail on what you mean by "Not working"? Do you get an error message? Does it seem like it's totally ignored? Only the first version of what you posted should have an effect (assuming you're nesting this under ci.collect) and that latter should throw a fatal error until the PR adding support to Lighthouse is published publicly.

[patrickhulce]

Also worth noting for this thread that puppeteer scripts came out after this issue was filed and are a far superior and flexible method of handling auth at this point.

[patrickhulce]

We're considering this solved by the puppeteerScript option https://github.com/GoogleChrome/lighthouse-ci/blob/03eb7aa06ba6373bb6c6cd9804d3fa0154f40938/docs/configuration.md#puppeteerscript