lighthouse 9.5.0-dev.20221205 → 9.5.0-dev.20221207

package/core/index.js

@@ -11,7 +11,6 @@ import {CriConnection} from './legacy/gather/connections/cri.js';
 import {Config} from './legacy/config/config.js';
 import UrlUtils from './lib/url-utils.js';
 import {Driver} from './legacy/gather/driver.js';
-import {initializeConfig} from './config/config.js';
 import {UserFlow, auditGatherSteps} from './user-flow.js';
 import {ReportGenerator} from '../report/generator/report-generator.js';
 import {startTimespanGather} from './gather/timespan-runner.js';
@@ -64,7 +63,7 @@ async function legacyNavigation(url, flags = {}, configJSON, userConnection) {
   flags.logLevel = flags.logLevel || 'error';
   log.setLevel(flags.logLevel);
 
-  const config = await generateLegacyConfig(configJSON, flags);
+  const config = await Config.fromJson(configJSON, flags);
   const computedCache = new Map();
   const options = {config, computedCache};
   const connection = userConnection || new CriConnection(flags.port, flags.hostname);
@@ -146,34 +145,6 @@ async function auditFlowArtifacts(flowArtifacts, config) {
   return await auditGatherSteps(gatherSteps, {name, config});
 }
 
-/**
- * Generate a Lighthouse Config.
- * @param {LH.Config.Json=} configJson Configuration for the Lighthouse run. If
- *   not present, the default config is used.
- * @param {LH.Flags=} flags Optional settings for the Lighthouse run. If present,
- *   they will override any settings in the config.
- * @param {LH.Gatherer.GatherMode=} gatherMode Gather mode used to collect artifacts. If present
- *   the config may override certain settings based on the mode.
- * @return {Promise<LH.Config.FRConfig>}
- */
-async function generateConfig(configJson, flags = {}, gatherMode = 'navigation') {
-  const {config} = await initializeConfig(gatherMode, configJson, flags);
-  return config;
-}
-
-/**
- * Generate a legacy Lighthouse Config.
- * @deprecated
- * @param {LH.Config.Json=} configJson Configuration for the Lighthouse run. If
- *   not present, the default config is used.
- * @param {LH.Flags=} flags Optional settings for the Lighthouse run. If present,
- *   they will override any settings in the config.
- * @return {Promise<Config>}
- */
-function generateLegacyConfig(configJson, flags) {
-  return Config.fromJson(configJson, flags);
-}
-
 function getAuditList() {
   return Runner.getAuditList();
 }
@@ -194,8 +165,6 @@ export {
   snapshot,
   generateReport,
   auditFlowArtifacts,
-  generateConfig,
-  generateLegacyConfig,
   getAuditList,
   traceCategories,
 };

package/core/lib/asset-saver.js

@@ -27,9 +27,11 @@ const {promisify} = util;
 // https://nodejs.org/api/stream.html#streams-promises-api
 const pipeline = promisify && promisify(stream.pipeline);
 
+const optionsFilename = 'options.json';
 const artifactsFilename = 'artifacts.json';
 const traceSuffix = '.trace.json';
 const devtoolsLogSuffix = '.devtoolslog.json';
+const stepDirectoryRegex = /^step(\d+)$/;
 
 /**
  * @typedef {object} PreparedAssets
@@ -65,6 +67,9 @@ function loadArtifacts(basePath) {
     const passName = filename.replace(devtoolsLogSuffix, '');
     const devtoolsLog = JSON.parse(fs.readFileSync(path.join(basePath, filename), 'utf8'));
     artifacts.devtoolsLogs[passName] = devtoolsLog;
+    if (passName === 'defaultPass') {
+      artifacts.DevtoolsLog = devtoolsLog;
+    }
   });
 
   // load traces
@@ -74,6 +79,9 @@ function loadArtifacts(basePath) {
     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];
+    }
   });
 
   if (Array.isArray(artifacts.Timing)) {
@@ -84,6 +92,52 @@ function loadArtifacts(basePath) {
   return artifacts;
 }
 
+/**
+ * @param {string} basePath
+ * @return {LH.UserFlow.FlowArtifacts}
+ */
+function loadFlowArtifacts(basePath) {
+  log.log('Reading flow artifacts from disk:', basePath);
+
+  if (!fs.existsSync(basePath)) {
+    throw new Error('No saved flow artifacts found at ' + basePath);
+  }
+
+  /** @type {LH.UserFlow.FlowArtifacts} */
+  const flowArtifacts = JSON.parse(
+    fs.readFileSync(path.join(basePath, optionsFilename), 'utf-8')
+  );
+
+  const filenames = fs.readdirSync(basePath);
+
+  flowArtifacts.gatherSteps = [];
+  for (const filename of filenames) {
+    const regexResult = stepDirectoryRegex.exec(filename);
+    if (!regexResult) continue;
+
+    const index = Number(regexResult[1]);
+    if (!Number.isFinite(index)) continue;
+
+    const stepPath = path.join(basePath, filename);
+    if (!fs.lstatSync(stepPath).isDirectory()) continue;
+
+    /** @type {LH.UserFlow.GatherStep} */
+    const gatherStep = JSON.parse(
+      fs.readFileSync(path.join(stepPath, optionsFilename), 'utf-8')
+    );
+    gatherStep.artifacts = loadArtifacts(stepPath);
+
+    flowArtifacts.gatherSteps[index] = gatherStep;
+  }
+
+  const missingStepIndex = flowArtifacts.gatherSteps.findIndex(gatherStep => !gatherStep);
+  if (missingStepIndex !== -1) {
+    throw new Error(`Could not find step with index ${missingStepIndex} at ${basePath}`);
+  }
+
+  return flowArtifacts;
+}
+
 /**
  * A replacer function for JSON.stingify of the artifacts. Used to serialize objects that
  * JSON won't normally handle.
@@ -99,6 +153,54 @@ function stringifyReplacer(key, value) {
   return value;
 }
 
+/**
+ * Saves flow artifacts with the following file structure:
+ *   flow/                             --  Directory specified by `basePath`.
+ *     options.json                    --  Flow options (e.g. flow name, flags).
+ *     step0/                          --  Directory containing artifacts for the first step.
+ *       options.json                  --  First step's options (e.g. step flags).
+ *       artifacts.json                --  First step's artifacts except the DevTools log and trace.
+ *       defaultPass.devtoolslog.json  --  First step's DevTools log.
+ *       defaultPass.trace.json        --  First step's trace.
+ *     step1/                          --  Directory containing artifacts for the second step.
+ *
+ * @param {LH.UserFlow.FlowArtifacts} flowArtifacts
+ * @param {string} basePath
+ * @return {Promise<void>}
+ */
+async function saveFlowArtifacts(flowArtifacts, basePath) {
+  const status = {msg: 'Saving flow artifacts', id: 'lh:assetSaver:saveArtifacts'};
+  log.time(status);
+  fs.mkdirSync(basePath, {recursive: true});
+
+  // Delete any previous artifacts in this directory.
+  const filenames = fs.readdirSync(basePath);
+  for (const filename of filenames) {
+    if (stepDirectoryRegex.test(filename) || filename === optionsFilename) {
+      fs.rmSync(`${basePath}/${filename}`, {recursive: true});
+    }
+  }
+
+  const {gatherSteps, ...flowOptions} = flowArtifacts;
+  for (let i = 0; i < gatherSteps.length; ++i) {
+    const {artifacts, ...stepOptions} = gatherSteps[i];
+    const stepPath = path.join(basePath, `step${i}`);
+    await saveArtifacts(artifacts, stepPath);
+    fs.writeFileSync(
+      path.join(stepPath, optionsFilename),
+      JSON.stringify(stepOptions, stringifyReplacer, 2) + '\n'
+    );
+  }
+
+  fs.writeFileSync(
+    path.join(basePath, optionsFilename),
+    JSON.stringify(flowOptions, stringifyReplacer, 2) + '\n'
+  );
+
+  log.log('Flow artifacts saved to disk in folder:', basePath);
+  log.timeEnd(status);
+}
+
 /**
  * Save artifacts object mostly to single file located at basePath/artifacts.json.
  * Also save the traces & devtoolsLogs to their own files
@@ -120,7 +222,10 @@ async function saveArtifacts(artifacts, basePath) {
     }
   }
 
-  const {traces, devtoolsLogs, ...restArtifacts} = artifacts;
+  // `DevtoolsLog` and `Trace` will always be the 'defaultPass' version.
+  // 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;
 
   // save traces
   for (const [passName, trace] of Object.entries(traces)) {
@@ -332,8 +437,10 @@ function normalizeTimingEntries(timings) {
 
 export {
   saveArtifacts,
+  saveFlowArtifacts,
   saveLhr,
   loadArtifacts,
+  loadFlowArtifacts,
   saveAssets,
   prepareAssets,
   saveTrace,

package/package.json

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

package/vercel.json

@@ -0,0 +1,6 @@
+{
+  "github": {
+    "silent": true
+  },
+  "trailingSlash": true
+}

package/now.json

@@ -1,14 +0,0 @@
-{
-  "version": 2,
-  "builds": [
-    {
-      "src": "package.json",
-      "use": "@now/static-build",
-      "config": {"distDir": "dist"}
-    }
-  ],
-  "github": {
-    "silent": true
-  },
-  "trailingSlash": true
-}