lighthouse 11.0.0-dev.20230809 → 11.0.0-dev.20230810

package/core/lib/asset-saver.d.ts

@@ -1,5 +1,4 @@
 export type PreparedAssets = {
-    passName: string;
     traceData: LH.Trace;
     devtoolsLog: import("../index.js").DevtoolsLog;
 };
@@ -35,7 +34,6 @@ export function saveFlowArtifacts(flowArtifacts: LH.UserFlow.FlowArtifacts, base
 export function saveLhr(lhr: LH.Result, basePath: string): void;
 /**
  * @typedef {object} PreparedAssets
- * @property {string} passName
  * @property {LH.Trace} traceData
  * @property {LH.DevtoolsLog} devtoolsLog
  */
@@ -60,7 +58,6 @@ export function loadFlowArtifacts(basePath: string): LH.UserFlow.FlowArtifacts;
  */
 export function saveAssets(artifacts: LH.Artifacts, audits: LH.Result['audits'], pathWithBasename: string): Promise<void>;
 /**
- * Filter traces and extract screenshots to prepare for saving.
  * @param {LH.Artifacts} artifacts
  * @param {LH.Result['audits']} [audits]
  * @return {Promise<Array<PreparedAssets>>}

package/core/lib/asset-saver.js

@@ -23,11 +23,12 @@ const optionsFilename = 'options.json';
 const artifactsFilename = 'artifacts.json';
 const traceSuffix = '.trace.json';
 const devtoolsLogSuffix = '.devtoolslog.json';
+const defaultPrefix = 'defaultPass';
+const errorPrefix = 'pageLoadError-defaultPass';
 const stepDirectoryRegex = /^step(\d+)$/;
 
 /**
  * @typedef {object} PreparedAssets
- * @property {string} passName
  * @property {LH.Trace} traceData
  * @property {LH.DevtoolsLog} devtoolsLog
  */
@@ -53,32 +54,30 @@ function loadArtifacts(basePath) {
 
   const filenames = fs.readdirSync(basePath);
 
-  // load devtoolsLogs
-  artifacts.devtoolsLogs = {};
   filenames.filter(f => f.endsWith(devtoolsLogSuffix)).forEach(filename => {
-    const passName = filename.replace(devtoolsLogSuffix, '');
+    if (!artifacts.devtoolsLogs) artifacts.devtoolsLogs = {};
+    const prefix = filename.replace(devtoolsLogSuffix, '');
     const devtoolsLog = JSON.parse(fs.readFileSync(path.join(basePath, filename), 'utf8'));
-    artifacts.devtoolsLogs[passName] = devtoolsLog;
-    if (passName === 'defaultPass') {
+    artifacts.devtoolsLogs[prefix] = devtoolsLog;
+    if (prefix === defaultPrefix) {
       artifacts.DevtoolsLog = devtoolsLog;
     }
-    if (passName === 'pageLoadError-defaultPass') {
+    if (prefix === errorPrefix) {
       artifacts.DevtoolsLogError = devtoolsLog;
     }
   });
 
-  // load traces
-  artifacts.traces = {};
   filenames.filter(f => f.endsWith(traceSuffix)).forEach(filename => {
+    if (!artifacts.traces) artifacts.traces = {};
     const file = fs.readFileSync(path.join(basePath, filename), {encoding: 'utf-8'});
     const trace = JSON.parse(file);
-    const passName = filename.replace(traceSuffix, '');
-    artifacts.traces[passName] = Array.isArray(trace) ? {traceEvents: trace} : trace;
-    if (passName === 'defaultPass') {
-      artifacts.Trace = artifacts.traces[passName];
+    const prefix = filename.replace(traceSuffix, '');
+    artifacts.traces[prefix] = Array.isArray(trace) ? {traceEvents: trace} : trace;
+    if (prefix === defaultPrefix) {
+      artifacts.Trace = artifacts.traces[prefix];
     }
-    if (passName === 'pageLoadError-defaultPass') {
-      artifacts.TraceError = artifacts.traces[passName];
+    if (prefix === errorPrefix) {
+      artifacts.TraceError = artifacts.traces[prefix];
     }
   });
 
@@ -220,23 +219,34 @@ async function saveArtifacts(artifacts, basePath) {
     }
   }
 
-  // `DevtoolsLog` and `Trace` will always be the 'defaultPass' version.
+  // `devtoolsLogs` and `traces` are duplicate compat artifacts.
   // We don't need to save them twice, so extract them here.
-  // eslint-disable-next-line no-unused-vars
-  const {traces, devtoolsLogs, DevtoolsLog, Trace, ...restArtifacts} = artifacts;
+  const {
+    // eslint-disable-next-line no-unused-vars
+    traces,
+    // eslint-disable-next-line no-unused-vars
+    devtoolsLogs,
+    DevtoolsLog,
+    Trace,
+    DevtoolsLogError,
+    TraceError,
+    ...restArtifacts
+  } = artifacts;
+
+  if (Trace) {
+    await saveTrace(Trace, `${basePath}/${defaultPrefix}${traceSuffix}`);
+  }
 
-  // save traces
-  if (traces) {
-    for (const [passName, trace] of Object.entries(traces)) {
-      await saveTrace(trace, `${basePath}/${passName}${traceSuffix}`);
-    }
+  if (TraceError) {
+    await saveTrace(TraceError, `${basePath}/${errorPrefix}${traceSuffix}`);
   }
 
-  // save devtools log
-  if (devtoolsLogs) {
-    for (const [passName, devtoolsLog] of Object.entries(devtoolsLogs)) {
-      await saveDevtoolsLog(devtoolsLog, `${basePath}/${passName}${devtoolsLogSuffix}`);
-    }
+  if (DevtoolsLog) {
+    await saveDevtoolsLog(DevtoolsLog, `${basePath}/${defaultPrefix}${devtoolsLogSuffix}`);
+  }
+
+  if (DevtoolsLogError) {
+    await saveDevtoolsLog(DevtoolsLogError, `${basePath}/${errorPrefix}${devtoolsLogSuffix}`);
   }
 
   // save everything else, using a replacer to serialize LighthouseErrors in the artifacts.
@@ -256,33 +266,49 @@ function saveLhr(lhr, basePath) {
 }
 
 /**
- * Filter traces and extract screenshots to prepare for saving.
+ * Filter trace and extract screenshots to prepare for saving.
+ * @param {LH.Trace} trace
+ * @param {LH.Result['audits']} [audits]
+ * @return {LH.Trace}
+ */
+function prepareTraceAsset(trace, audits) {
+  if (!trace) return trace;
+
+  const traceData = Object.assign({}, trace);
+  if (audits) {
+    const evts = new MetricTraceEvents(traceData.traceEvents, audits).generateFakeEvents();
+    traceData.traceEvents = traceData.traceEvents.concat(evts);
+  }
+  return traceData;
+}
+
+/**
  * @param {LH.Artifacts} artifacts
  * @param {LH.Result['audits']} [audits]
  * @return {Promise<Array<PreparedAssets>>}
  */
 async function prepareAssets(artifacts, audits) {
-  const passNames = Object.keys(artifacts.traces);
   /** @type {Array<PreparedAssets>} */
   const assets = [];
 
-  for (const passName of passNames) {
-    const trace = artifacts.traces[passName];
-    const devtoolsLog = artifacts.devtoolsLogs[passName];
-
-    const traceData = Object.assign({}, trace);
-    if (audits) {
-      const evts = new MetricTraceEvents(traceData.traceEvents, audits).generateFakeEvents();
-      traceData.traceEvents = traceData.traceEvents.concat(evts);
-    }
-
+  const devtoolsLog = artifacts.DevtoolsLog;
+  const traceData = prepareTraceAsset(artifacts.Trace, audits);
+  if (traceData || devtoolsLog) {
     assets.push({
-      passName,
       traceData,
       devtoolsLog,
     });
   }
 
+  const devtoolsLogError = artifacts.DevtoolsLogError;
+  const traceErrorData = prepareTraceAsset(artifacts.TraceError, audits);
+  if (devtoolsLogError || traceErrorData) {
+    assets.push({
+      traceData: traceErrorData,
+      devtoolsLog: devtoolsLogError,
+    });
+  }
+
   return assets;
 }
 

package/core/runner.js

@@ -375,9 +375,10 @@ class Runner {
 
         // If trace/devtoolsLog required, check that DEFAULT_PASS trace/devtoolsLog exists.
         // NOTE: for now, not a pass-specific check of traces or devtoolsLogs.
-        const noRequiredTrace = artifactName === 'traces' && !artifacts.traces[Audit.DEFAULT_PASS];
+        const noRequiredTrace = artifactName === 'traces' &&
+          !artifacts.traces?.[Audit.DEFAULT_PASS];
         const noRequiredDevtoolsLog = artifactName === 'devtoolsLogs' &&
-            !artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+          !artifacts.devtoolsLogs?.[Audit.DEFAULT_PASS];
 
         if (noArtifact || noRequiredTrace || noRequiredDevtoolsLog) {
           log.warn('Runner',

package/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "yarn"
+    allow:
+      - "production"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "deps"
+      include: "scope"

package/package.json

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