lighthouse 9.5.0-dev.20230115 → 9.5.0-dev.20230117

package/.codecov.yml

@@ -20,3 +20,8 @@ coverage:
     patch:
       default:
         if_not_found: success
+
+# docs:
+#   https://docs.codecov.com/docs/ignoring-paths
+ignore:
+- "core/util.cjs" # file is a copy of report/renderer/util.js

package/core/gather/base-artifacts.js

@@ -39,10 +39,7 @@ async function getBaseArtifacts(resolvedConfig, driver, context) {
     PageLoadError: null,
     GatherContext: context,
     // Artifacts that have been replaced by regular gatherers in Fraggle Rock.
-    Stacks: [],
     NetworkUserAgent: '',
-    WebAppManifest: null,
-    InstallabilityErrors: {errors: []},
     traces: {},
     devtoolsLogs: {},
   };

package/core/gather/gatherers/installability-errors.js

@@ -38,10 +38,18 @@ class InstallabilityErrors extends FRGatherer {
    * @param {LH.Gatherer.FRTransitionalContext} context
    * @return {Promise<LH.Artifacts['InstallabilityErrors']>}
    */
-  getArtifact(context) {
+  async getArtifact(context) {
     const driver = context.driver;
 
-    return InstallabilityErrors.getInstallabilityErrors(driver.defaultSession);
+    try {
+      return await InstallabilityErrors.getInstallabilityErrors(driver.defaultSession);
+    } catch {
+      return {
+        errors: [
+          {errorId: 'protocol-timeout', errorArguments: []},
+        ],
+      };
+    }
   }
 }
 

package/core/gather/gatherers/stacks.js

@@ -126,7 +126,11 @@ class Stacks extends FRGatherer {
    * @return {Promise<LH.Artifacts['Stacks']>}
    */
   async getArtifact(context) {
-    return Stacks.collectStacks(context.driver.executionContext);
+    try {
+      return await Stacks.collectStacks(context.driver.executionContext);
+    } catch {
+      return [];
+    }
   }
 }
 

package/core/gather/gatherers/web-app-manifest.js

@@ -92,10 +92,14 @@ class WebAppManifest extends FRGatherer {
    * @param {LH.Gatherer.FRTransitionalContext} context
    * @return {Promise<LH.Artifacts['WebAppManifest']>}
    */
-  getArtifact(context) {
+  async getArtifact(context) {
     const driver = context.driver;
     const {finalDisplayedUrl} = context.baseArtifacts.URL;
-    return WebAppManifest.getWebAppManifest(driver.defaultSession, finalDisplayedUrl);
+    try {
+      return await WebAppManifest.getWebAppManifest(driver.defaultSession, finalDisplayedUrl);
+    } catch {
+      return null;
+    }
   }
 }
 

package/core/legacy/config/config.js

@@ -41,10 +41,7 @@ const BASE_ARTIFACT_BLANKS = {
   NetworkUserAgent: '',
   BenchmarkIndex: '',
   BenchmarkIndexes: '',
-  WebAppManifest: '',
   GatherContext: '',
-  InstallabilityErrors: '',
-  Stacks: '',
   traces: '',
   devtoolsLogs: '',
   settings: '',
@@ -54,6 +51,15 @@ const BASE_ARTIFACT_BLANKS = {
 };
 const BASE_ARTIFACT_NAMES = Object.keys(BASE_ARTIFACT_BLANKS);
 
+// These were legacy base artifacts, but we need certain gatherers (e.g. bfcache) to run after them.
+// The order is controlled by the config, but still need to force them to run every time.
+const alwaysRunArtifactIds = [
+  'WebAppManifest',
+  'InstallabilityErrors',
+  'Stacks',
+  'FullPageScreenshot',
+];
+
 /**
  * @param {LegacyResolvedConfig['passes']} passes
  * @param {LegacyResolvedConfig['audits']} audits
@@ -79,7 +85,8 @@ function assertValidPasses(passes, audits) {
       const gatherer = gathererDefn.instance;
       foundGatherers.add(gatherer.name);
       const isGatherRequiredByAudits = requestedGatherers.has(gatherer.name);
-      if (!isGatherRequiredByAudits && gatherer.name !== 'FullPageScreenshot') {
+      const isAlwaysRunArtifact = alwaysRunArtifactIds.includes(gatherer.name);
+      if (!isGatherRequiredByAudits && !isAlwaysRunArtifact) {
         const msg = `${gatherer.name} gatherer requested, however no audit requires it.`;
         log.warn('config', msg);
       }
@@ -328,10 +335,13 @@ class LegacyResolvedConfig {
 
     // 3. Resolve which gatherers will need to run
     const requestedGathererIds = LegacyResolvedConfig.getGatherersRequestedByAudits(audits);
+    for (const gathererId of alwaysRunArtifactIds) {
+      requestedGathererIds.add(gathererId);
+    }
 
-    // Always include FullPageScreenshot, unless explictly told not to.
-    if (!settings.disableFullPageScreenshot) {
-      requestedGathererIds.add('FullPageScreenshot');
+    // Remove FullPageScreenshot if we explicitly exclude it.
+    if (settings.disableFullPageScreenshot) {
+      requestedGathererIds.delete('FullPageScreenshot');
     }
 
     // 4. Filter to only the neccessary passes

package/core/legacy/config/legacy-default-config.js

@@ -70,6 +70,9 @@ legacyDefaultConfig.passes = [{
     'trace-elements',
     'inspector-issues',
     'source-maps',
+    'web-app-manifest',
+    'installability-errors',
+    'stacks',
     'full-page-screenshot',
     'bf-cache-failures',
   ],

package/core/legacy/gather/gather-runner.js

@@ -16,10 +16,7 @@ import * as prepare from '../../gather/driver/prepare.js';
 import * as storage from '../../gather/driver/storage.js';
 import * as navigation from '../../gather/driver/navigation.js';
 import * as serviceWorkers from '../../gather/driver/service-workers.js';
-import WebAppManifest from '../../gather/gatherers/web-app-manifest.js';
-import InstallabilityErrors from '../../gather/gatherers/installability-errors.js';
 import NetworkUserAgent from '../../gather/gatherers/network-user-agent.js';
-import Stacks from '../../gather/gatherers/stacks.js';
 import {finalizeArtifacts} from '../../gather/base-artifacts.js';
 import UrlUtils from '../../lib/url-utils.js';
 
@@ -395,9 +392,6 @@ class GatherRunner {
       HostUserAgent: hostUserAgent,
       NetworkUserAgent: '', // updated later
       BenchmarkIndex: 0, // updated later
-      WebAppManifest: null, // updated later
-      InstallabilityErrors: {errors: []}, // updated later
-      Stacks: [], // updated later
       traces: {},
       devtoolsLogs: {},
       settings: options.settings,
@@ -424,37 +418,6 @@ class GatherRunner {
 
     const baseArtifacts = passContext.baseArtifacts;
 
-    // Fetch the manifest, if it exists.
-    try {
-      baseArtifacts.WebAppManifest = await WebAppManifest.getWebAppManifest(
-        passContext.driver.defaultSession, passContext.url);
-    } catch (err) {
-      log.error('GatherRunner WebAppManifest', err);
-      baseArtifacts.WebAppManifest = null;
-    }
-
-    try {
-      baseArtifacts.InstallabilityErrors = await InstallabilityErrors.getInstallabilityErrors(
-        passContext.driver.defaultSession);
-    } catch (err) {
-      log.error('GatherRunner InstallabilityErrors', err);
-      baseArtifacts.InstallabilityErrors = {
-        errors: [
-          {
-            errorId: 'protocol-timeout',
-            errorArguments: [],
-          },
-        ],
-      };
-    }
-
-    try {
-      baseArtifacts.Stacks = await Stacks.collectStacks(passContext.driver.executionContext);
-    } catch (err) {
-      log.error('GatherRunner Stacks', err);
-      baseArtifacts.Stacks = [];
-    }
-
     // Find the NetworkUserAgent actually used in the devtoolsLogs.
     const devtoolsLog = baseArtifacts.devtoolsLogs[passContext.passConfig.passName];
     baseArtifacts.NetworkUserAgent = NetworkUserAgent.getNetworkUserAgent(devtoolsLog);

package/core/lib/stack-packs.js

@@ -63,10 +63,12 @@ const stackPacksToInclude = [
 
 /**
  * Returns all packs that match the stacks found in the page.
- * @param {LH.Artifacts['Stacks']} pageStacks
+ * @param {LH.Artifacts['Stacks']|undefined} pageStacks
  * @return {LH.RawIcu<Array<LH.Result.StackPack>>}
  */
 function getStackPacks(pageStacks) {
+  if (!pageStacks) return [];
+
   /** @type {LH.RawIcu<Array<LH.Result.StackPack>>} */
   const packs = [];
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "9.5.0-dev.20230115",
+  "version": "9.5.0-dev.20230117",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/types/artifacts.d.ts

@@ -79,12 +79,6 @@ interface ContextualBaseArtifacts {
 interface LegacyBaseArtifacts {
   /** 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. */
-  Stacks: Artifacts.DetectedStack[];
-  /** Parsed version of the page's Web App Manifest, or null if none found. This moved to a regular artifact in Fraggle Rock. */
-  WebAppManifest: Artifacts.Manifest | null;
-  /** Errors preventing page being installable as PWA. This moved to a regular artifact in Fraggle Rock. */
-  InstallabilityErrors: Artifacts.InstallabilityErrors;
   /** A set of page-load traces, keyed by passName. */
   traces: {[passName: string]: Trace};
   /** A set of DevTools debugger protocol records, keyed by passName. */
@@ -151,6 +145,8 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   GlobalListeners: Array<Artifacts.GlobalListener>;
   /** The issues surfaced in the devtools Issues panel */
   InspectorIssues: Artifacts.InspectorIssues;
+  /** Errors preventing page being installable as PWA. */
+  InstallabilityErrors: Artifacts.InstallabilityErrors;
   /** JS coverage information for code used during audit. Keyed by script id. */
   // 'url' is excluded because it can be overriden by a magic sourceURL= comment, which makes keeping it a dangerous footgun!
   JsUsage: Record<string, Omit<LH.Crdp.Profiler.ScriptCoverage, 'url'>>;
@@ -172,6 +168,8 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   ServiceWorker: {versions: LH.Crdp.ServiceWorker.ServiceWorkerVersion[], registrations: LH.Crdp.ServiceWorker.ServiceWorkerRegistration[]};
   /** Source maps of scripts executed in the page. */
   SourceMaps: Array<Artifacts.SourceMap>;
+  /** Information on detected tech stacks (e.g. JS libraries) used by the page. */
+  Stacks: Artifacts.DetectedStack[];
   /** Information on <script> and <link> tags blocking first paint. */
   TagsBlockingFirstPaint: Artifacts.TagBlockingFirstPaint[];
   /** Information about tap targets including their position and size. */
@@ -180,6 +178,8 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   Trace: Trace;
   /** Elements associated with metrics (ie: Largest Contentful Paint element). */
   TraceElements: Artifacts.TraceElement[];
+  /** Parsed version of the page's Web App Manifest, or null if none found. */
+  WebAppManifest: Artifacts.Manifest | null;
 }
 
 declare module Artifacts {