lighthouse 8.4.0 → 8.5.0-dev.20210921

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

@@ -289,6 +289,25 @@ describe('CategoryRenderer', () => {
       assert.ok(description.querySelector('a'), 'description contains converted markdown links');
     });
 
+    it('renders the category header with fraction', () => {
+      const categoryDOM = renderer.render(
+        category,
+        sampleResults.categoryGroups,
+        {gatherMode: 'snapshot'}
+      );
+
+      const gauge = categoryDOM.querySelector('.lh-fraction__content');
+      assert.equal(gauge.textContent.trim(), '49/54', 'fraction is included');
+
+      const score = categoryDOM.querySelector('.lh-category-header');
+      const title = score.querySelector('.lh-fraction__label');
+      const description = score.querySelector('.lh-category-header__description');
+
+      assert.deepEqual(score, score.firstElementChild, 'first child is a score');
+      assert.equal(title.textContent, category.title, 'title is set');
+      assert.ok(description.querySelector('a'), 'description contains converted markdown links');
+    });
+
     it('renders the failed audits grouped by group', () => {
       // Fail all the audits.
       const categoryClone = JSON.parse(JSON.stringify(category));

package/report/tsconfig.json

@@ -1,36 +1,21 @@
 {
+  "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../.tmp/tsbuildinfo/report",
-    "emitDeclarationOnly": true,
-    "declarationMap": true,
 
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
-    // Don't include any types from node_modules.
+    // Don't include any types from node_modules/.
     "types": [],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
   },
-  "include": [
-    "**/*.js",
-    "types/**/*.d.ts",
-  ],
   "references": [
     {"path": "../types/lhr/"},
     {"path": "./generator/"}
   ],
+  "include": [
+    "**/*.js",
+    "types/**/*.d.ts",
+  ],
   "exclude": [
     "generator/**/*.js",
     // These test files require further changes before they can be type checked.

package/report/types/report-result.d.ts

@@ -17,7 +17,7 @@ interface ReportResult extends LHResult {
 
 declare module ReportResult {
   interface Category extends LHResult.Category {
-    auditRefs: Array<AuditRef>
+    auditRefs: Array<AuditRef>;
   }
 
   interface AuditRef extends LHResult.AuditRef {

package/root.js

@@ -5,4 +5,6 @@
  */
 'use strict';
 
-module.exports.LH_ROOT = __dirname;
+module.exports = {
+  LH_ROOT: __dirname,
+};

package/third-party/snyk/snapshot.json

@@ -16,7 +16,7 @@
       {"id":"npm:angular:20160122","severity":"medium","semver":{"vulnerable":[">=1.3.0 <1.5.0-rc.2"]}},
       {"id":"npm:angular:20140608","severity":"low","semver":{"vulnerable":["<1.3.0"]}},
       {"id":"npm:angular:20131113","severity":"high","semver":{"vulnerable":["<1.2.2"]}},
-      {"id":"npm:angular:20140908","severity":"medium","semver":{"vulnerable":["<1.3.0-rc.4"]}},
+      {"id":"npm:angular:20140908","severity":"medium","semver":{"vulnerable":["<1.3.0-rc.5"]}},
       {"id":"npm:angular:20161101","severity":"medium","semver":{"vulnerable":[">=1.5.0 <1.5.9"]}},
       {"id":"npm:angular:20150909","severity":"high","semver":{"vulnerable":["<1.5.0-beta.2"]}},
       {"id":"npm:angular:20151205","severity":"medium","semver":{"vulnerable":["<1.5.0-rc.0"]}},
@@ -28,7 +28,7 @@
       {"id":"npm:angular:20150310","severity":"high","semver":{"vulnerable":["<1.4.0-beta.6"]}},
       {"id":"npm:angular:20141104","severity":"medium","semver":{"vulnerable":["<1.3.2"]}},
       {"id":"npm:angular:20130621","severity":"medium","semver":{"vulnerable":["<1.2.0"]}},
-      {"id":"npm:angular:20140909","severity":"high","semver":{"vulnerable":[">=1.2.19 <1.2.24"]}},
+      {"id":"npm:angular:20140909","severity":"high","semver":{"vulnerable":[">=1.2.19 <1.2.27"]}},
       {"id":"npm:angular:20130625","severity":"high","semver":{"vulnerable":["<1.1.5"]}}
     ],
     "backbone":[

package/tsconfig-all.json

@@ -0,0 +1,15 @@
+// Compilation entry point for all tsc projects within Lighthouse.
+
+{
+  "references": [
+    {"path": "./"},
+    {"path": "./types/lhr/"},
+    {"path": "./report/"},
+    {"path": "./report/generator/"},
+    {"path": "./lighthouse-viewer/"},
+    {"path": "./lighthouse-treemap/"},
+    {"path": "./flow-report/"},
+  ],
+  "files": [],
+  "include": [],
+}

package/tsconfig-base.json

@@ -0,0 +1,24 @@
+// Base compiler options for all tsconfig files.
+
+{
+  "compilerOptions": {
+    "composite": true,
+    "emitDeclarationOnly": true,
+    "declarationMap": true,
+
+    "target": "es2020",
+    "module": "es2020",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    // TODO: remove the next line to be fully `strict`.
+    "useUnknownInCatchVariables": false,
+
+    // "listFiles": true,
+    // "noErrorTruncation": true,
+    "extendedDiagnostics": true,
+  },
+}

package/tsconfig.json

@@ -1,21 +1,16 @@
 {
+  "extends": "./tsconfig-base.json",
   "compilerOptions": {
-    "noEmit": true,
-    "module": "commonjs",
-    "target": "ES2020",
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-    // "listFiles": true,
-    // "noErrorTruncation": true,
+    "outDir": ".tmp/tsbuildinfo/",
 
+    // TODO(esmodules): included to support require('file.json'). Remove on the switch to ES Modules.
     "resolveJsonModule": true,
-    "diagnostics": true,
-    "composite": true,
-    "outDir": ".tmp/tsbuildinfo/",
   },
+  "references": [
+    {"path": "./types/lhr/"},
+    {"path": "./report/"},
+    {"path": "./report/generator/"},
+  ],
   "include": [
     "root.js",
     "lighthouse-cli/**/*.js",
@@ -35,11 +30,6 @@
     "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/test/audits/**/*.js",
     "lighthouse-core/test/fixtures/**/*.js",

package/types/artifacts.d.ts

@@ -54,6 +54,12 @@ interface UniversalBaseArtifacts {
   settings: Config.Settings;
   /** The timing instrumentation of the gather portion of a run. */
   Timing: Artifacts.MeasureEntry[];
+  /** Device which Chrome is running on. */
+  HostFormFactor: 'desktop'|'mobile';
+  /** The user agent string of the version of Chrome used. */
+  HostUserAgent: string;
+  /** Information about how Lighthouse artifacts were gathered. */
+  GatherContext: {gatherMode: Gatherer.GatherMode};
 }
 
 /**
@@ -70,10 +76,6 @@ interface ContextualBaseArtifacts {
  * The set of base artifacts that were replaced by standard gatherers in Fraggle Rock.
  */
 interface LegacyBaseArtifacts {
-  /** Device which Chrome is running on. */
-  HostFormFactor: 'desktop'|'mobile';
-  /** The user agent string of the version of Chrome used. */
-  HostUserAgent: string;
   /** The user agent string that Lighthouse used to load the page. Set to the empty string if unknown. */
   NetworkUserAgent: string;
   /** Information on detected tech stacks (e.g. JS libraries) used by the page. */
@@ -144,8 +146,6 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   FormElements: Artifacts.Form[];
   /** Screenshot of the entire page (rather than just the above the fold content). */
   FullPageScreenshot: Artifacts.FullPageScreenshot | null;
-  /** Information about how Lighthouse artifacts were gathered. */
-  GatherContext: {gatherMode: Gatherer.GatherMode};
   /** Information about event listeners registered on the global object. */
   GlobalListeners: Array<Artifacts.GlobalListener>;
   /** Whether the page ended up on an HTTPS page after attempting to load the HTTP version. */
@@ -165,7 +165,7 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   /** Size info of all network records sent without compression and their size after gzipping. */
   ResponseCompression: {requestId: string, url: string, mimeType: string, transferSize: number, resourceSize: number, gzipSize?: number}[];
   /** Information on fetching and the content of the /robots.txt file. */
-  RobotsTxt: {status: number|null, content: string|null};
+  RobotsTxt: {status: number|null, content: string|null, errorMessage?: string};
   /** Version information for all ServiceWorkers active after the first page load. */
   ServiceWorker: {versions: LH.Crdp.ServiceWorker.ServiceWorkerVersion[], registrations: LH.Crdp.ServiceWorker.ServiceWorkerRegistration[]};
   /** Source maps of scripts executed in the page. */

package/types/config.d.ts

@@ -64,7 +64,7 @@ declare module Config {
   interface FRContext {
     gatherMode?: Gatherer.GatherMode;
     configPath?: string;
-    settingsOverrides?: SharedFlagsSettings;
+    settingsOverrides?: SharedFlagsSettings & Pick<LH.Flags, 'plugins'>;
   }
 
   interface SharedPassNavigationJson {

package/types/gatherer.d.ts

@@ -12,7 +12,7 @@ import ExecutionContext = require('../lighthouse-core/gather/driver/execution-co
 import Fetcher = require('../lighthouse-core/gather/fetcher');
 import ArbitraryEqualityMap = require('../lighthouse-core/lib/arbitrary-equality-map');
 
-import {Artifacts, BaseArtifacts, GathererArtifacts} from './artifacts';
+import {Artifacts, BaseArtifacts, FRBaseArtifacts, GathererArtifacts} from './artifacts';
 import Config from './config';
 import {IcuMessage} from './lhr/i18n';
 import Result from './lhr/lhr';
@@ -22,6 +22,7 @@ import {Trace, DevtoolsLog} from './artifacts';
 declare module Gatherer {
   /** The Lighthouse wrapper around a raw CDP session. */
   interface FRProtocolSession {
+    setTargetInfo(targetInfo: LH.Crdp.Target.TargetInfo): void;
     hasNextProtocolTimeout(): boolean;
     getNextProtocolTimeout(): number;
     setNextProtocolTimeout(ms: number): void;
@@ -29,8 +30,11 @@ declare module Gatherer {
     once<TEvent extends keyof LH.CrdpEvents>(event: TEvent, callback: (...args: LH.CrdpEvents[TEvent]) => void): void;
     addProtocolMessageListener(callback: (payload: Protocol.RawEventMessage) => void): void
     removeProtocolMessageListener(callback: (payload: Protocol.RawEventMessage) => void): void
+    addSessionAttachedListener(callback: (session: FRProtocolSession) => void): void
+    removeSessionAttachedListener(callback: (session: FRProtocolSession) => void): void
     off<TEvent extends keyof LH.CrdpEvents>(event: TEvent, callback: (...args: LH.CrdpEvents[TEvent]) => void): void;
     sendCommand<TMethod extends keyof LH.CrdpCommands>(method: TMethod, ...params: LH.CrdpCommands[TMethod]['paramsType']): Promise<LH.CrdpCommands[TMethod]['returnType']>;
+    dispose(): Promise<void>;
   }
 
   /** The limited driver interface shared between pre and post Fraggle Rock Lighthouse. */
@@ -48,6 +52,8 @@ declare module Gatherer {
     gatherMode: GatherMode;
     /** The connection to the page being analyzed. */
     driver: FRTransitionalDriver;
+    /** The set of base artifacts that are always collected. */
+    baseArtifacts: FRBaseArtifacts;
     /** The cached results of computed artifacts. */
     computedCache: Map<string, ArbitraryEqualityMap>;
     /** The set of available dependencies requested by the current gatherer. */

package/types/lhr/flow.d.ts

@@ -8,7 +8,6 @@ import Result from './lhr';
 
 /**
  * The full output of a Lighthouse flow. Includes a series of Lighthouse runs.
- * TODO(FR-COMPAT): Add flow specific metadata (e.g. interaction steps).
  */
 export default interface FlowResult {
   /** Ordered list of lighthouse results corresponding to a navigation, timespan, or snapshot. */

package/types/lhr/lhr.d.ts

@@ -41,7 +41,11 @@ interface Result {
   /** Execution timings for the Lighthouse run */
   timing: Result.Timing;
   /** Strings for the report and the record of all formatted string locations in the LHR and their corresponding source values. */
-  i18n: {rendererFormattedStrings: Record<string, string>, icuMessagePaths?: Result.IcuMessagePaths};
+  i18n: {
+    rendererFormattedStrings: Record<string, string>;
+    /** Optional because LR has many old LHRs that return nothing for this property. */
+    icuMessagePaths?: Result.IcuMessagePaths;
+  };
   /** An array containing the result of all stack packs. */
   stackPacks?: Result.StackPack[];
 }

package/types/lhr/tsconfig.json

@@ -1,22 +1,12 @@
 {
+  "extends": "../../tsconfig-base.json",
   "compilerOptions": {
-    "module": "esnext",
-    "target": "esnext",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-
-    "strict": true,
-    "extendedDiagnostics": true,
+    "outDir": "../../.tmp/tsbuildinfo/types/lhr",
 
-    // We only need the base JS definitions, no libs in node_modules, no DOM, etc.
+    // We only need the base JS definitions, no DOM, etc.
     "lib": ["esnext"],
+    // Don't include any types from node_modules/.
     "types": [],
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-
-    "composite": true,
-    "outDir": "../../.tmp/tsbuildinfo/types/lhr",
   },
   "include": [
     "*.d.ts",

package/types/protocol.d.ts

@@ -39,6 +39,8 @@ declare module Protocol {
   type StrictEventEmitter<TEventRecord extends Record<keyof TEventRecord, any[]>> = {
     on<E extends keyof TEventRecord>(event: E, listener: (...args: TEventRecord[E]) => void): void;
 
+    off<E extends keyof TEventRecord>(event: E, listener: Function): void;
+
     addListener<E extends keyof TEventRecord>(event: E, listener: (...args: TEventRecord[E]) => void): void;
 
     removeListener<E extends keyof TEventRecord>(event: E, listener: Function): void;

package/types/smokehouse.d.ts

@@ -14,7 +14,8 @@ declare global {
       audits: Record<string, any>;
       requestedUrl: string;
       finalUrl: string | RegExp;
-      runWarnings?: Array<string|RegExp>;
+      userAgent?: string | RegExp;
+      runWarnings?: Array<string|RegExp> | {length: string | number};
       runtimeError?: {
         code?: any;
         message?: any;