lighthouse 11.1.0-dev.20230919 → 11.1.0-dev.20230920

package/cli/bin.js

@@ -124,6 +124,7 @@ async function begin() {
     await Sentry.init({
       url: urlUnderTest,
       flags: cliFlags,
+      config,
       environmentData: {
         serverName: 'redacted', // prevent sentry from using hostname
         environment: isDev() ? 'development' : 'production',

package/core/audits/mainthread-work-breakdown.js

@@ -8,11 +8,14 @@
  * @fileoverview Audit a page to show a breakdown of execution timings on the main thread
  */
 
+import log from 'lighthouse-logger';
 
 import {Audit} from './audit.js';
 import {taskGroups} from '../lib/tracehouse/task-groups.js';
 import * as i18n from '../lib/i18n/i18n.js';
 import {MainThreadTasks} from '../computed/main-thread-tasks.js';
+import {TotalBlockingTime} from '../computed/metrics/total-blocking-time.js';
+import {Sentry} from '../lib/sentry.js';
 
 const UIStrings = {
   /** Title of a diagnostic audit that provides detail on the main thread work the browser did to load the page. This descriptive title is shown to users when the amount is acceptable and no user action is required. */
@@ -43,7 +46,7 @@ class MainThreadWorkBreakdown extends Audit {
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
       guidanceLevel: 1,
-      requiredArtifacts: ['traces'],
+      requiredArtifacts: ['traces', 'devtoolsLogs', 'URL', 'GatherContext'],
     };
   }
 
@@ -83,6 +86,19 @@ class MainThreadWorkBreakdown extends Audit {
     const settings = context.settings || {};
     const trace = artifacts.traces[MainThreadWorkBreakdown.DEFAULT_PASS];
 
+    let tbtSavings = 0;
+    try {
+      const metricComputationData = Audit.makeMetricComputationDataInput(artifacts, context);
+      const tbtResult = await TotalBlockingTime.request(metricComputationData, context);
+      tbtSavings = tbtResult.timing;
+    } catch (err) {
+      Sentry.captureException(err, {
+        tags: {audit: this.meta.id},
+        level: 'error',
+      });
+      log.error(this.meta.id, err.message);
+    }
+
     const tasks = await MainThreadTasks.request(trace, context);
     const multiplier = settings.throttlingMethod === 'simulate' ?
       settings.throttling.cpuSlowdownMultiplier : 1;
@@ -129,6 +145,9 @@ class MainThreadWorkBreakdown extends Audit {
       numericUnit: 'millisecond',
       displayValue: str_(i18n.UIStrings.seconds, {timeInMs: totalExecutionTime}),
       details: tableDetails,
+      metricSavings: {
+        TBT: tbtSavings,
+      },
     };
   }
 }

package/core/lib/sentry.d.ts

@@ -20,11 +20,12 @@ export type NodeOptions = import('@sentry/node').NodeOptions;
 export type Severity = import('@sentry/node').Severity;
 /**
  * When called, replaces noops with actual Sentry implementation.
- * @param {{url: string, flags: LH.CliFlags, environmentData: NodeOptions}} opts
+ * @param {{url: string, flags: LH.CliFlags, config?: LH.Config, environmentData: NodeOptions}} opts
  */
 declare function init(opts: {
     url: string;
     flags: LH.CliFlags;
+    config?: LH.Config;
     environmentData: NodeOptions;
 }): Promise<void>;
 declare function noop(): void;

package/core/lib/sentry.js

@@ -6,6 +6,8 @@
 
 import log from 'lighthouse-logger';
 
+import {initializeConfig} from '../config/config.js';
+
 /** @typedef {import('@sentry/node').Breadcrumb} Breadcrumb */
 /** @typedef {import('@sentry/node').NodeClient} NodeClient */
 /** @typedef {import('@sentry/node').NodeOptions} NodeOptions */
@@ -16,12 +18,6 @@ const SENTRY_URL = 'https://a6bb0da87ee048cc9ae2a345fc09ab2e:63a7029f46f74265981
 // Per-run chance of capturing errors (if enabled).
 const SAMPLE_RATE = 0.01;
 
-/** @type {Array<{pattern: RegExp, rate: number}>} */
-const SAMPLED_ERRORS = [
-  // Error code based sampling. Delete if still unused after 2019-01-01.
-  // e.g.: {pattern: /No.*node with given id/, rate: 0.01},
-];
-
 const noop = () => { };
 
 /**
@@ -45,7 +41,7 @@ const sentryDelegate = {
 
 /**
  * When called, replaces noops with actual Sentry implementation.
- * @param {{url: string, flags: LH.CliFlags, environmentData: NodeOptions}} opts
+ * @param {{url: string, flags: LH.CliFlags, config?: LH.Config, environmentData: NodeOptions}} opts
  */
 async function init(opts) {
   // If error reporting is disabled, leave the functions as a noop
@@ -65,12 +61,26 @@ async function init(opts) {
       dsn: SENTRY_URL,
     });
 
+    /** @type {LH.Config.Settings | LH.CliFlags} */
+    let settings = opts.flags;
+    try {
+      const {resolvedConfig} = await initializeConfig('navigation', opts.config, opts.flags);
+      settings = resolvedConfig.settings;
+    } catch {
+      // The config failed validation (note - probably, we don't use a specific error type for that).
+      // The actual core lighthouse library will handle this error accordingly. As we are only using this
+      // for meta data, we can ignore here.
+    }
+    const baseTags = {
+      channel: settings.channel,
+      formFactor: settings.formFactor,
+      throttlingMethod: settings.throttlingMethod,
+    };
+    Sentry.setTags(baseTags);
+
     const extras = {
-      ...opts.flags.throttling,
-      channel: opts.flags.channel || 'cli',
+      ...settings.throttling,
       url: opts.url,
-      formFactor: opts.flags.formFactor,
-      throttlingMethod: opts.flags.throttlingMethod,
     };
     Sentry.setExtras(extras);
 
@@ -103,10 +113,6 @@ async function init(opts) {
         sentryExceptionCache.set(key, true);
       }
 
-      // Sample known errors that occur at a high frequency.
-      const sampledErrorMatch = SAMPLED_ERRORS.find(sample => sample.pattern.test(err.message));
-      if (sampledErrorMatch && sampledErrorMatch.rate <= Math.random()) return;
-
       // @ts-expect-error - properties added to protocol method LighthouseErrors.
       if (err.protocolMethod) {
         // Protocol errors all share same stack trace, so add more to fingerprint

package/package.json

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