deps(yargs): upgrade to 17.3.1

[connorjclark]

Fixes #13589

Not sure on the root cause, but I noticed that the bug didn't happen with the latest yargs.

https://github.com/yargs/yargs/blob/main/CHANGELOG.md

Only necessary changes were for:

coerce: coerce is now applied before validation.

Which required having coerce fns return null (or undefined, based on what the settings type expected) to prevent some fields like skipAudits, extraHeaders from being undefined instead of null ... which was fine, but was an unnecessary change to the settings normalization.

[adamraine]

Looks like we need to handle null here:

lighthouse/lighthouse-core/config/config-helpers.js

Line 81 in f59499a

} else if (typeof extension === 'undefined') {

[connorjclark]

ok let's try to get cli-flags to return the exact same thing even with this version upgrade. We'll need some tests in cli-flags that assert things like keys not being present (as opposed to being null or explicitly undefined)

---

master

node lighthouse-cli/index.js https://www.example.com

{
  _: [ 'https://www.example.com' ],
  verbose: false,
  quiet: false,
  'save-assets': false,
  saveAssets: false,
  'list-all-audits': false,
  listAllAudits: false,
  'list-locales': false,
  listLocales: false,
  'list-trace-categories': false,
  listTraceCategories: false,
  'print-config': false,
  printConfig: false,
  'fraggle-rock': false,
  fraggleRock: false,
  'chrome-flags': '',
  chromeFlags: '',
  port: 0,
  hostname: '127.0.0.1',
  'enable-error-reporting': undefined,
  enableErrorReporting: undefined,
  output: [ 'html' ],
  view: false,
  channel: 'cli',
  'chrome-ignore-default-flags': false,
  chromeIgnoreDefaultFlags: false,
  '$0': 'lighthouse-cli/index.js'
}

new yargs, no changes to cli-flags

Invalid value: Argument 'screenEmulation' must be an object, specified per-property ('screenEmulation.width', 'screenEmulation.deviceScaleFactor', etc)

Specify --help for available options

new yargs, current PR state

{
  _: [ 'https://www.example.com' ],
  verbose: false,
  quiet: false,
  'save-assets': false,
  saveAssets: false,
  'list-all-audits': false,
  listAllAudits: false,
  'list-locales': false,
  listLocales: false,
  'list-trace-categories': false,
  listTraceCategories: false,
  'print-config': false,
  printConfig: false,
  'fraggle-rock': false,
  fraggleRock: false,
  'chrome-flags': '',
  chromeFlags: '',
  port: 0,
  hostname: '127.0.0.1',
  'enable-error-reporting': undefined,
  enableErrorReporting: undefined,
  output: [ 'html' ],
  view: false,
  channel: 'cli',
  'chrome-ignore-default-flags': false,
  chromeIgnoreDefaultFlags: false,
  '$0': 'lighthouse-cli/index.js',
  screenEmulation: undefined,
  'screen-emulation': undefined,
  emulatedUserAgent: undefined,
  'emulated-user-agent': undefined,
  'gather-mode': undefined,
  G: undefined,
  gatherMode: undefined,
  'audit-mode': undefined,
  A: undefined,
  auditMode: undefined,
  'only-audits': null,
  onlyAudits: null,
  'only-categories': null,
  onlyCategories: null,
  'skip-audits': null,
  skipAudits: null,
  locale: undefined,
  throttling: undefined,
  'extra-headers': null,
  extraHeaders: null,
  plugins: null
}

[connorjclark]

Not sure on the root cause, but I noticed that the bug didn't happen with the latest yargs.

must have been this yargs/yargs#2063

esm json import

we should also update our dep on yargs-parser ... we only pass it strings for chrome-flags but still we should be on the same version

[connorjclark]

seems the older yargs was overzealous in how it interprets provided config files.

[adamraine]

Can you add tests for the special handling of this flag?

[connorjclark]

That's the snapshot tests tho. I don't understand the comment in this flag's options anyway, @brendankenny may know.

[adamraine]

Hmm seems like it isn't necessary https://github.com/GoogleChrome/lighthouse/pull/11794/files#r539003671