Cannot specify --extra-headers CLI option, errors with "Invalid parameters (headers: object expected)"

[mikehenrty]

Config / CLI options

Using a JS config file, I am correctly able to specify additional request headers, like so:

module.exports = {
  flags: {
    chromeFlags: '--headless --disable-gpu --no-sandbox"',
    extraHeaders: {
      'My-Special-Header': 'data'
    },
  }
}

But when I try to speficy these extra headers using CLI options like:

pwmetrics --extra-headers "{\"My-Special-Header\":\"data\"}" https://www.example.com --chrome-flags="--headless --disable-gpu --no-sandbox"

I see this error Protocol error (Network.setExtraHTTPHeaders): Invalid parameters (headers: object expected)

I believe the problem is here:

pwmetrics/lib/index.ts

Line 61 in f8a784f

this.flags = Object.assign({}, this.flags, opts.flags);

The option flag for pwmetrics gets captured as a string, and then pass straight into the NodeJS Lighthouse Runner as a string. Since the runner expects an object rather than string, we see the aforementioned error:

pwmetrics/lib/lh-runner.ts

Line 43 in f8a784f

lhResults = await lighthouse(this.url, this.flags, perfConfig);

One possible solution would be to special case the opts.flags.extraHeaders argument, and JSON.parse it.

Note, it seems other projects have had similar issues: sitespeedio/plugin-lighthouse#30

Environment

1. pwmetrics version:
   4.2.3 (lighthouse 5.2.0)
   Note sure if relevant, but I also have Lighthouse 6 installed globally through yarn

2. Chrome version:
   "chrome-launcher": "^0.10.2"

3. OS version:
   Linux, 5.6.15-arch