lighthouse 8.3.0-dev.20210907 → 8.3.0

package/report/test/renderer/util-test.js

@@ -6,7 +6,6 @@
 'use strict';
 
 import {strict as assert} from 'assert';
-
 import {Util} from '../../renderer/util.js';
 import {I18n} from '../../renderer/i18n.js';
 import sampleResult from '../../../lighthouse-core/test/results/sample_v2.json';

package/report/test/{generator/report-generator-test.js → report-generator-test.js}

@@ -7,12 +7,10 @@
 
 const assert = require('assert').strict;
 const fs = require('fs');
-
+const ReportGenerator = require('../report-generator.js');
+const sampleResults = require('../../lighthouse-core/test/results/sample_v2.json');
 const csvValidator = require('csv-validator');
 
-const ReportGenerator = require('../../generator/report-generator.js');
-const sampleResults = require('../../../lighthouse-core/test/results/sample_v2.json');
-
 /* eslint-env jest */
 
 describe('ReportGenerator', () => {
@@ -95,11 +93,11 @@ describe('ReportGenerator', () => {
       const lines = csvOutput.split('\n');
       expect(lines.length).toBeGreaterThan(100);
       expect(lines.slice(0, 3).join('\n')).toMatchInlineSnapshot(`
-"requestedUrl,finalUrl,category,name,title,type,score
-\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"Performance\\",\\"performance-score\\",\\"Overall Performance Category Score\\",\\"numeric\\",\\"0.26\\"
-\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"Performance\\",\\"first-contentful-paint\\",\\"First Contentful Paint\\",\\"numeric\\",\\"0.02\\"
-"
-`);
+        "requestedUrl,finalUrl,category,name,title,type,score
+        \\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"Performance\\",\\"performance-score\\",\\"Overall Performance Category Score\\",\\"numeric\\",\\"0.57\\"
+        \\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"Performance\\",\\"first-contentful-paint\\",\\"First Contentful Paint\\",\\"numeric\\",\\"0.24\\"
+        "
+      `);
 
       try {
         await csvValidator(path, headers);

package/third-party/chromium-synchronization/installability-errors-test.js

@@ -44,34 +44,33 @@ describe('installabilityErrors', () => {
 
   it('should notify us if something changed', () => {
     expect(chromiumErrorIds).toMatchInlineSnapshot(`
-Array [
-  "already-installed",
-  "cannot-download-icon",
-  "ids-do-not-match",
-  "in-incognito",
-  "manifest-display-not-supported",
-  "manifest-display-override-not-supported",
-  "manifest-empty",
-  "manifest-location-changed",
-  "manifest-missing-name-or-short-name",
-  "manifest-missing-suitable-icon",
-  "no-acceptable-icon",
-  "no-icon-available",
-  "no-id-specified",
-  "no-manifest",
-  "no-matching-service-worker",
-  "no-url-for-service-worker",
-  "not-from-secure-origin",
-  "not-offline-capable",
-  "pipeline-restarted",
-  "platform-not-supported-on-android",
-  "prefer-related-applications",
-  "prefer-related-applications-only-beta-stable",
-  "start-url-not-valid",
-  "url-not-supported-for-webapk",
-  "warn-not-offline-capable",
-]
-`);
+      Array [
+        "already-installed",
+        "cannot-download-icon",
+        "ids-do-not-match",
+        "in-incognito",
+        "manifest-display-not-supported",
+        "manifest-display-override-not-supported",
+        "manifest-empty",
+        "manifest-location-changed",
+        "manifest-missing-name-or-short-name",
+        "manifest-missing-suitable-icon",
+        "no-acceptable-icon",
+        "no-icon-available",
+        "no-id-specified",
+        "no-manifest",
+        "no-matching-service-worker",
+        "no-url-for-service-worker",
+        "not-from-secure-origin",
+        "not-offline-capable",
+        "platform-not-supported-on-android",
+        "prefer-related-applications",
+        "prefer-related-applications-only-beta-stable",
+        "start-url-not-valid",
+        "url-not-supported-for-webapk",
+        "warn-not-offline-capable",
+      ]
+    `);
   });
 
   it('are each handled explicitly in the gatherer', () => {

package/third-party/snyk/snapshot.json

@@ -129,8 +129,6 @@
       {"id":"npm:mustache:20110814","severity":"medium","semver":{"vulnerable":["< 0.3.1"]}}
     ],
     "next":[
-      {"id":"SNYK-JS-NEXT-1577139","severity":"medium","semver":{"vulnerable":[">=10.0.0 <11.1.1"]}},
-      {"id":"SNYK-JS-NEXT-1540422","severity":"medium","semver":{"vulnerable":["<11.1.0"]}},
       {"id":"SNYK-JS-NEXT-1063481","severity":"medium","semver":{"vulnerable":[">=9.5.0 <9.5.4"]}},
       {"id":"SNYK-JS-NEXT-571938","severity":"high","semver":{"vulnerable":["<5.1.0"]}},
       {"id":"SNYK-JS-NEXT-561584","severity":"medium","semver":{"vulnerable":["<9.3.2"]}},

package/tsconfig.json

@@ -6,41 +6,23 @@
     "allowJs": true,
     "checkJs": true,
     "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
     // "listFiles": true,
     // "noErrorTruncation": true,
 
     "resolveJsonModule": true,
-    "diagnostics": true,
-    "composite": true,
-    "outDir": ".tmp/tsbuildinfo/",
+    "diagnostics": true
   },
   "include": [
-    "root.js",
     "lighthouse-cli/**/*.js",
     "lighthouse-core/**/*.js",
+    "report/**/*.js",
     "clients/**/*.js",
     "build/**/*.js",
     "./types/**/*.d.ts",
     "eslint-local-rules.js",
-
-    // TODO(esmodules): JSON files included via resolveJsonModule. Removable on the switch to ES Modules.
-    "package.json",
-    "lighthouse-core/lib/i18n/locales/en-US.json",
-    "lighthouse-core/test/results/sample_v2.json",
-    "lighthouse-core/lib/sd-validation/assets/*.json",
-    "lighthouse-core/test/fixtures/unresolved-perflog.json",
-    "lighthouse-core/test/fixtures/traces/lcp-m78.devtools.log.json",
-    "third-party/snyk/snapshot.json",
-    "lighthouse-core/audits/byte-efficiency/polyfill-graph-data.json",
-  ],
-  "references": [
-    {"path": "./types/lhr/"},
-    {"path": "./report/"},
-    {"path": "./report/generator/"},
   ],
   "exclude": [
+    "lighthouse-core/lib/cdt",
     "lighthouse-core/test/audits/**/*.js",
     "lighthouse-core/test/fixtures/**/*.js",
     "lighthouse-core/test/computed/**/*.js",
@@ -49,6 +31,7 @@
     "lighthouse-core/scripts/legacy-javascript/variants",
     "lighthouse-core/test/chromium-web-tests/webtests",
     // These test files require further changes before they can be type checked.
+    "report/test/**/*.js",
     "lighthouse-core/test/config/budget-test.js",
     "lighthouse-core/test/config/config-helpers-test.js",
     "lighthouse-core/test/config/config-plugin-test.js",
@@ -120,9 +103,7 @@
     "lighthouse-core/test/scripts/i18n/collect-strings-test.js",
   ],
   "files": [
-    // Opt-in to typechecking for some core tests and test-support files.
+    // Opt-in to typechecking for some core tests.
     "lighthouse-core/test/audits/script-treemap-data-test.js",
-    "lighthouse-cli/test/fixtures/static-server.js",
-    "lighthouse-core/test/fixtures/config-plugins/lighthouse-plugin-simple/plugin-simple.js",
   ],
 }

package/types/artifacts.d.ts

@@ -14,11 +14,9 @@ import ArbitraryEqualityMap = require('../lighthouse-core/lib/arbitrary-equality
 
 type _TaskNode = import('../lighthouse-core/lib/tracehouse/main-thread-tasks.js').TaskNode;
 
-import AuditDetails from './lhr/audit-details'
 import Config from './config';
 import Gatherer from './gatherer';
-import {IcuMessage} from './lhr/i18n';
-import LHResult from './lhr/lhr'
+import {IcuMessage} from './i18n';
 import Protocol from './protocol';
 
 export interface Artifacts extends BaseArtifacts, GathererArtifacts {}
@@ -534,7 +532,14 @@ declare module Artifacts {
     };
   }
 
-  type Rect = AuditDetails.Rect;
+  interface Rect {
+    width: number;
+    height: number;
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+  }
 
   interface TapTarget {
     node: NodeDetails;
@@ -593,7 +598,15 @@ declare module Artifacts {
     }[];
   }
 
-  type MeasureEntry = LHResult.MeasureEntry;
+  interface MeasureEntry {
+    // From PerformanceEntry
+    readonly duration: number;
+    readonly entryType: string;
+    readonly name: string;
+    readonly startTime: number;
+    /** Whether timing entry was collected during artifact gathering. */
+    gather?: boolean;
+  }
 
   interface MetricComputationDataInput {
     devtoolsLog: DevtoolsLog;

package/types/{lhr/audit-details.d.ts → audit-details.d.ts}

@@ -6,6 +6,7 @@
 
 import {IcuMessage} from './i18n';
 import Treemap from './treemap';
+import {Artifacts} from './artifacts';
 
 type Details =
   Details.CriticalRequestChain |
@@ -82,24 +83,8 @@ declare module Details {
    * and the locations of interesting nodes.
    * Used by element screenshots renderer.
    */
-  interface FullPageScreenshot {
+  interface FullPageScreenshot extends Artifacts.FullPageScreenshot {
     type: 'full-page-screenshot';
-    screenshot: {
-      /** Base64 image data URL. */
-      data: string;
-      width: number;
-      height: number;
-    };
-    nodes: Record<string, Rect>;
-  }
-
-  interface Rect {
-    width: number;
-    height: number;
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
   }
 
   interface Table {
@@ -241,7 +226,7 @@ declare module Details {
     lhId?: string;
     path?: string;
     selector?: string;
-    boundingRect?: Rect;
+    boundingRect?: Artifacts.Rect;
     /** An HTML snippet used to identify the node. */
     snippet?: string;
     /** A human-friendly text descriptor that's used to identify the node more quickly. */

package/types/audit.d.ts

@@ -6,17 +6,13 @@
 
 import ArbitraryEqualityMap = require('../lighthouse-core/lib/arbitrary-equality-map.js');
 import {Artifacts} from './artifacts';
-import AuditDetails from './lhr/audit-details';
+import AuditDetails from './audit-details';
 import Config from './config';
 import Gatherer from './gatherer';
-import {FormattedIcu, IcuMessage} from './lhr/i18n';
-import * as AuditResult from './lhr/audit-result';
+import {FormattedIcu, IcuMessage} from './i18n';
 
 declare module Audit {
   export import Details = AuditDetails;
-  export type Result = AuditResult.Result;
-  export type ScoreDisplayMode = AuditResult.ScoreDisplayMode;
-  export type ScoreDisplayModes = AuditResult.ScoreDisplayModes;
 
   type Context = Immutable<{
     /** audit options */
@@ -35,6 +31,23 @@ declare module Audit {
     median: number;
   }
 
+  interface ScoreDisplayModes {
+    /** Scores of 0-1 (map to displayed scores of 0-100). */
+    NUMERIC: 'numeric';
+    /** Pass/fail audit (0 and 1 are only possible scores). */
+    BINARY: 'binary';
+    /** The audit exists only to tell you to review something yourself. Score is null and should be ignored. */
+    MANUAL: 'manual';
+    /** The audit is an FYI only, and can't be interpreted as pass/fail. Score is null and should be ignored. */
+    INFORMATIVE: 'informative';
+    /** The audit turned out to not apply to the page. Score is null and should be ignored. */
+    NOT_APPLICABLE: 'notApplicable';
+    /** There was an error while running the audit (check `errorMessage` for details). Score is null and should be ignored. */
+    ERROR: 'error';
+  }
+
+  type ScoreDisplayMode = Audit.ScoreDisplayModes[keyof Audit.ScoreDisplayModes];
+
   interface Meta {
     /** The string identifier of the audit, in kebab case. */
     id: string;
@@ -49,7 +62,7 @@ declare module Audit {
     /** A list of the members of LH.Artifacts that augment the audit, but aren't necessary. For internal use only with experimental-config. */
     __internalOptionalArtifacts?: Array<keyof Artifacts>;
     /** A string identifying how the score should be interpreted for display. */
-    scoreDisplayMode?: AuditResult.ScoreDisplayMode;
+    scoreDisplayMode?: Audit.ScoreDisplayMode;
     /** A list of gather modes that this audit is applicable to. */
     supportedModes?: Gatherer.GatherMode[],
   }
@@ -98,6 +111,44 @@ declare module Audit {
   /** Type returned by Audit.audit(). Only score is required.  */
   type Product = NonNumericProduct | NumericProduct;
 
+  /* Audit result returned in Lighthouse report. All audits offer a description and score of 0-1. */
+  interface Result {
+    displayValue?: string;
+    /** An explanation of why the audit failed on the test page. */
+    explanation?: string;
+    /** Error message from any exception thrown while running this audit. */
+    errorMessage?: string;
+    warnings?: string[];
+    /** The scored value of the audit, provided in the range `0-1`, or null if `scoreDisplayMode` indicates not scored. */
+    score: number|null;
+    /**
+     * A string identifying how the score should be interpreted:
+     * - 'binary': pass/fail audit (0 and 1 are only possible scores).
+     * - 'numeric': scores of 0-1 (map to displayed scores of 0-100).
+     * - 'informative': the audit is an FYI only, and can't be interpreted as pass/fail. Score is null and should be ignored.
+     * - 'notApplicable': the audit turned out to not apply to the page. Score is null and should be ignored.
+     * - 'manual': The audit exists only to tell you to review something yourself. Score is null and should be ignored.
+     * - 'error': There was an error while running the audit (check `errorMessage` for details). Score is null and should be ignored.
+     */
+    scoreDisplayMode: ScoreDisplayMode;
+    /** Short, user-visible title for the audit. The text can change depending on if the audit passed or failed. */
+    title: string;
+    /** The string identifier of the audit, in kebab case. */
+    id: string;
+    /** A more detailed description that describes why the audit is important and links to Lighthouse documentation on the audit; markdown links supported. */
+    description: string;
+    /** A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present. */
+    numericValue?: number;
+    /** The unit of `numericValue`, used when the consumer wishes to convert numericValue to a display string. */
+    numericUnit?: string;
+    /** Extra information about the page provided by some types of audits, in one of several possible forms that can be rendered in the HTML report. */
+    details?: FormattedIcu<AuditDetails>;
+  }
+
+  interface Results {
+    [metric: string]: Result;
+  }
+
   type MultiCheckAuditP1 = Partial<Record<Artifacts.ManifestValueCheckID, boolean>>;
   type MultiCheckAuditP2 = Partial<Artifacts.ManifestValues>;
   interface MultiCheckAuditP3 {

package/types/bundle-phobia-cli/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license Copyright 2020 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+declare module 'bundle-phobia-cli' {
+  interface Assets {
+    gzip: number;
+    name: string;
+    size: number;
+    type: string;
+  }
+
+  interface DependencySize {
+    approximateSize: number;
+    name: string;
+  }
+
+  interface BundlePhobiaLibrary {
+    assets: Assets[];
+    dependencyCount: number;
+    dependencySizes: DependencySize[];
+    description: string;
+    gzip: number;
+    hasJSModule: boolean;
+    hasJSNext: boolean;
+    hasSideEffects: boolean;
+    name: string;
+    repository: string;
+    scoped: boolean;
+    size: number;
+    version: string;
+  }
+
+  export namespace fetchPackageStats {
+    export function getPackageVersionList(packageName: string, limit: number): string[];
+    export function fetchPackageStats(packageName: string): Array<BundlePhobiaLibrary | undefined>;
+  }
+}

package/types/config.d.ts

@@ -6,9 +6,9 @@
  */
 
 import Audit = require('../lighthouse-core/audits/audit.js');
-import {SharedFlagsSettings, ConfigSettings} from './lhr/settings';
+import {ScreenEmulationSettings, SharedFlagsSettings, ThrottlingSettings} from './externs';
 import Gatherer from './gatherer';
-import {IcuMessage} from './lhr/i18n';
+import {IcuMessage} from './i18n';
 
 interface ClassOf<T> {
   new (): T;
@@ -161,7 +161,10 @@ declare module Config {
     relevantAudits?: string[];
   }
 
-  type Settings = ConfigSettings;
+  interface Settings extends Required<SharedFlagsSettings> {
+    throttling: Required<ThrottlingSettings>;
+    screenEmulation: ScreenEmulationSettings;
+  }
 
   interface Pass extends Required<PassJson> {
     gatherers: GathererDefn[];
@@ -227,6 +230,8 @@ declare module Config {
     groups?: Record<string, Config.GroupJson>;
   }
 
+  type MergeOptionsOfItems = <T extends {path?: string, options: Record<string, any>}>(items: T[]) => T[];
+
   type Merge = {
     <T extends Record<string, any>, U extends Record<string, any>>(base: T|null|undefined, extension: U, overwriteArrays?: boolean): T & U;
     <T extends Array<any>, U extends Array<any>>(base: T|null|undefined, extension: T, overwriteArrays?: boolean): T & U;

package/types/externs.d.ts

@@ -4,9 +4,31 @@
  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  */
 
+import {ParseSelectorToTagNames} from 'typed-query-selector/parser';
+import Crdp from 'devtools-protocol/types/protocol';
+
 import {Artifacts} from './artifacts';
-import LHResult from './lhr/lhr';
-import {SharedFlagsSettings, OutputMode} from './lhr/settings';
+import Budget from './budget';
+import {Locale} from './i18n';
+import LHResult from './lhr';
+
+/** Merge properties of the types in union `T`. Where properties overlap, property types becomes the union of the two (or more) possible types. */
+type MergeTypes<T> = {
+  [K in (T extends unknown ? keyof T : never)]: T extends Record<K, infer U> ? U : never;
+};
+
+// Helper types for strict querySelector/querySelectorAll that includes the overlap
+// between HTML and SVG node names (<a>, <script>, etc).
+// see https://github.com/GoogleChrome/lighthouse/issues/12011
+type HtmlAndSvgElementTagNameMap = MergeTypes<HTMLElementTagNameMap|SVGElementTagNameMap> & {
+  // Fall back to Element (base of HTMLElement and SVGElement) if no specific tag name matches.
+  [id: string]: Element;
+};
+type QuerySelectorParse<I extends string> = ParseSelectorToTagNames<I> extends infer TagNames ?
+  TagNames extends Array<string> ?
+    HtmlAndSvgElementTagNameMap[TagNames[number]] :
+    Element: // Fall back for queries typed-query-selector fails to parse, e.g. `'[alt], [aria-label]'`.
+  never;
 
 declare global {
   // Augment Intl to include
@@ -30,13 +52,16 @@ declare global {
     __lighthouseNodesDontTouchOrAllVarianceGoesAway: Map<Element, string>;
     __lighthouseExecutionContextId?: number;
 
-    /** Injected into the page when the `--debug` flag is used. */
-    continueLighthouseRun(): void;
-
     // Not defined in tsc yet: https://github.com/microsoft/TypeScript/issues/40807
     requestIdleCallback(callback: (deadline: {didTimeout: boolean, timeRemaining: () => DOMHighResTimeStamp}) => void, options?: {timeout: number}): number;
   }
 
+  // Stricter querySelector/querySelectorAll using typed-query-selector.
+  interface ParentNode {
+    querySelector<S extends string>(selector: S): QuerySelectorParse<S> | null;
+    querySelectorAll<S extends string>(selector: S): NodeListOf<QuerySelectorParse<S>>;
+  }
+
   /** Make properties K in T optional. */
   type MakeOptional<T, K extends keyof T> = {
     [P in Exclude<keyof T, K>]: T[P]
@@ -120,6 +145,95 @@ declare global {
   }
 }
 
+/** Simulation settings that control the amount of network & cpu throttling in the run. */
+export interface ThrottlingSettings {
+  /** The round trip time in milliseconds. */
+  rttMs?: number;
+  /** The network throughput in kilobits per second. */
+  throughputKbps?: number;
+  // devtools settings
+  /** The network request latency in milliseconds. */
+  requestLatencyMs?: number;
+  /** The network download throughput in kilobits per second. */
+  downloadThroughputKbps?: number;
+  /** The network upload throughput in kilobits per second. */
+  uploadThroughputKbps?: number;
+  // used by both
+  /** The amount of slowdown applied to the cpu (1/<cpuSlowdownMultiplier>). */
+  cpuSlowdownMultiplier?: number
+}
+
+export interface PrecomputedLanternData {
+  additionalRttByOrigin: {[origin: string]: number};
+  serverResponseTimeByOrigin: {[origin: string]: number};
+}
+
+export type OutputMode = 'json' | 'html' | 'csv';
+
+export type ScreenEmulationSettings = {
+  /** Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override. */
+  width: number;
+  /** Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override. */
+  height: number;
+  /** Overriding device scale factor value. 0 disables the override. */
+  deviceScaleFactor: number;
+  /** Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more. */
+  mobile: boolean;
+  /** Whether screen emulation is disabled. If true, the other emulation settings are ignored. */
+  disabled: boolean;
+};
+
+/**
+ * Options that are found in both the flags used by the Lighthouse module
+ * interface and the Config's `settings` object.
+ */
+export interface SharedFlagsSettings {
+  /** The type(s) of report output to be produced. */
+  output?: OutputMode|OutputMode[];
+  /** The locale to use for the output. */
+  locale?: Locale;
+  /** The maximum amount of time to wait for a page content render, in ms. If no content is rendered within this limit, the run is aborted with an error. */
+  maxWaitForFcp?: number;
+  /** The maximum amount of time to wait for a page to load, in ms. */
+  maxWaitForLoad?: number;
+  /** List of URL patterns to block. */
+  blockedUrlPatterns?: string[] | null;
+  /** Comma-delimited list of trace categories to include. */
+  additionalTraceCategories?: string | null;
+  /** Flag indicating the run should only audit. */
+  auditMode?: boolean | string;
+  /** Flag indicating the run should only gather. */
+  gatherMode?: boolean | string;
+  /** Flag indicating that the browser storage should not be reset for the audit. */
+  disableStorageReset?: boolean;
+
+  /** How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop. Must be set even if throttling/emulation is being applied outside of Lighthouse. */
+  formFactor?: 'mobile'|'desktop';
+  /** Screen emulation properties (width, height, dpr, mobile viewport) to apply or an object of `{disabled: true}` if Lighthouse should avoid applying screen emulation. If either emulation is applied outside of Lighthouse, or it's being run on a mobile device, it typically should be set to disabled. For desktop, we recommend applying consistent desktop screen emulation. */
+  screenEmulation?: Partial<ScreenEmulationSettings>;
+  /** User Agent string to apply, `false` to not change the host's UA string, or `true` to use Lighthouse's default UA string. */
+  emulatedUserAgent?: string | boolean;
+
+  /** The method used to throttle the network. */
+  throttlingMethod?: 'devtools'|'simulate'|'provided';
+  /** The throttling config settings. */
+  throttling?: ThrottlingSettings;
+  /** If present, the run should only conduct this list of audits. */
+  onlyAudits?: string[] | null;
+  /** If present, the run should only conduct this list of categories. */
+  onlyCategories?: string[] | null;
+  /** If present, the run should skip this list of audits. */
+  skipAudits?: string[] | null;
+  /** List of extra HTTP Headers to include. */
+  extraHeaders?: Crdp.Network.Headers | null; // See extraHeaders TODO in bin.js
+  /** How Lighthouse was run, e.g. from the Chrome extension or from the npm module */
+  channel?: string
+  /** Precomputed lantern estimates to use instead of observed analysis. */
+  precomputedLanternData?: PrecomputedLanternData | null;
+  /** The budget.json object for LightWallet. */
+  budgets?: Array<Budget> | null;
+}
+
 /**
  * Extends the flags in SharedFlagsSettings with flags used to configure the
  * Lighthouse module but will not end up in the Config settings.

package/types/gatherer.d.ts

@@ -14,8 +14,7 @@ import ArbitraryEqualityMap = require('../lighthouse-core/lib/arbitrary-equality
 
 import {Artifacts, BaseArtifacts, GathererArtifacts} from './artifacts';
 import Config from './config';
-import {IcuMessage} from './lhr/i18n';
-import Result from './lhr/lhr';
+import {IcuMessage} from './i18n';
 import Protocol from './protocol';
 import {Trace, DevtoolsLog} from './artifacts';
 
@@ -78,7 +77,7 @@ declare module Gatherer {
   type PhaseResultNonPromise = void | GathererArtifacts[keyof GathererArtifacts];
   type PhaseResult = PhaseResultNonPromise | Promise<PhaseResultNonPromise>
 
-  type GatherMode = Result.GatherMode;
+  type GatherMode = 'snapshot'|'timespan'|'navigation';
 
   type DefaultDependenciesKey = '__none__'
   type DependencyKey = keyof GathererArtifacts | DefaultDependenciesKey