Document how an array of urls interacts with the puppeteerScript flag

Hi!

I’ve been trying to set up a puppeteer-script to bypass authentication. However, I am having some trouble figuring out how the puppeteerScript flag interacts with the URL list I have. lighthouserc.json

      "puppeteerScript": "puppeteer-login-script.js",
      "url": [
        "http://127.0.0.1:8181/",
        "http://127.0.0.1:8181/about",
        "http://127.0.0.1:8181/contact",
        "http://127.0.0.1:8181/donate",
        "http://127.0.0.1:8181/get-started",
        "http://127.0.0.1:8181/community-library",
        "http://127.0.0.1:8181/privacy-policy",
        "http://127.0.0.1:8181/teach",
        "http://127.0.0.1:8181/terms",
        "http://127.0.0.1:8181/thanks"
      ]
    },

I can get it to work with one URL, but I think my config currently runs the Puppeteer script before each URL collection and keeps trying to log in even though I am already logged in. Is there a way I make it so that the lighthouserc config will only run the script on certain URLs. Or do I need to handle it in the puppeteer-login-script

[patrickhulce]

A snippet in the docs near the description of puppeteerScript option would be great, or perhaps even a complete configuration example in the “Examples” section? A recipe feels like overkill here.

When using puppeteer, the browser is kept open across all URLs so if you’re keeping state in cookies then everything should be remembered between URLs. If you’re using anything other than cookies though, you might have trouble. There’s no real way to support sessionStorage because new tabs are created and other storage types are cleared by Lighthouse in between runs so you’ll need to use --collect.settings.disableStorageReset as well.

Basic flow with puppeteer script.

|- puppeteer launches browser
|- LHCI runs the puppeteerScript
|- LHCI runs Lighthouse on URL A, run 1
|- LHCI runs Lighthouse on URL A, run 2
|- LHCI runs Lighthouse on URL A, run n
|- LHCI runs the puppeteerScript
|- LHCI runs Lighthouse on URL B, run 1
|- LHCI runs Lighthouse on URL B, run 2
...

[patrickhulce]

it might be helpful to clarify that a general puppeteer script won’t work with the lighthouse config

This shouldn’t be the case. You can definitely use a custom config along with puppeteer. What gave you this impression?

I thought that a standard puppeteer script could just log into the website, and that the lighthouse config would just use that instance.

This is what happens 😃

I didn’t know that using the parameters and structure below was necessary.

Do you have suggestions on how to improve the documentation for this setting? AFAICT, it offers nearly that identical JSDoc of what the parameters and structure are so I’m not sure how to make it any clearer 😕