lighthouse 9.6.8 → 10.0.0

package/lighthouse-core/computed/load-simulator.js

@@ -1,92 +0,0 @@
-/**
- * @license Copyright 2018 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('./computed-artifact.js');
-const constants = require('../config/constants.js');
-const Simulator = require('../lib/dependency-graph/simulator/simulator.js');
-const NetworkAnalysis = require('./network-analysis.js');
-
-class LoadSimulator {
-  /**
-   * @param {{devtoolsLog: LH.DevtoolsLog, settings: Immutable<LH.Config.Settings>}} data
-   * @param {LH.Artifacts.ComputedContext} context
-   * @return {Promise<Simulator>}
-   */
-  static async compute_(data, context) {
-    const {throttlingMethod, throttling, precomputedLanternData} = data.settings;
-    const networkAnalysis = await NetworkAnalysis.request(data.devtoolsLog, context);
-
-    /** @type {LH.Gatherer.Simulation.Options} */
-    const options = {
-      additionalRttByOrigin: networkAnalysis.additionalRttByOrigin,
-      serverResponseTimeByOrigin: networkAnalysis.serverResponseTimeByOrigin,
-      observedThroughput: networkAnalysis.throughput,
-    };
-
-    // If we have precomputed lantern data, overwrite our observed estimates and use precomputed instead
-    // for increased stability.
-    if (precomputedLanternData) {
-      options.additionalRttByOrigin = new Map(Object.entries(
-        precomputedLanternData.additionalRttByOrigin));
-      options.serverResponseTimeByOrigin = new Map(Object.entries(
-        precomputedLanternData.serverResponseTimeByOrigin));
-    }
-
-    switch (throttlingMethod) {
-      case 'provided':
-        options.rtt = networkAnalysis.rtt;
-        options.throughput = networkAnalysis.throughput;
-        options.cpuSlowdownMultiplier = 1;
-        options.layoutTaskMultiplier = 1;
-        break;
-      case 'devtools':
-        if (throttling) {
-          options.rtt =
-            throttling.requestLatencyMs / constants.throttling.DEVTOOLS_RTT_ADJUSTMENT_FACTOR;
-          options.throughput =
-            throttling.downloadThroughputKbps * 1024 /
-            constants.throttling.DEVTOOLS_THROUGHPUT_ADJUSTMENT_FACTOR;
-        }
-
-        options.cpuSlowdownMultiplier = 1;
-        options.layoutTaskMultiplier = 1;
-        break;
-      case 'simulate':
-        if (throttling) {
-          options.rtt = throttling.rttMs;
-          options.throughput = throttling.throughputKbps * 1024;
-          options.cpuSlowdownMultiplier = throttling.cpuSlowdownMultiplier;
-        }
-        break;
-      default:
-        // intentionally fallback to simulator defaults
-        break;
-    }
-
-    return new Simulator(options);
-  }
-
-  /**
-   * @param {LH.Artifacts.NetworkAnalysis} networkAnalysis
-   * @return {LH.PrecomputedLanternData}
-   */
-  static convertAnalysisToSaveableLanternData(networkAnalysis) {
-    /** @type {LH.PrecomputedLanternData} */
-    const lanternData = {additionalRttByOrigin: {}, serverResponseTimeByOrigin: {}};
-    for (const [origin, value] of networkAnalysis.additionalRttByOrigin.entries()) {
-      if (origin.startsWith('http')) lanternData.additionalRttByOrigin[origin] = value;
-    }
-
-    for (const [origin, value] of networkAnalysis.serverResponseTimeByOrigin.entries()) {
-      if (origin.startsWith('http')) lanternData.serverResponseTimeByOrigin[origin] = value;
-    }
-
-    return lanternData;
-  }
-}
-
-module.exports = makeComputedArtifact(LoadSimulator, ['devtoolsLog', 'settings']);

package/lighthouse-core/computed/main-resource.js

@@ -1,34 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('./computed-artifact.js');
-const NetworkAnalyzer = require('../lib/dependency-graph/simulator/network-analyzer.js');
-const NetworkRecords = require('./network-records.js');
-
-/**
- * @fileoverview This artifact identifies the main resource on the page. Current solution assumes
- * that the main resource is the first non-rediected one.
- */
-class MainResource {
-  /**
-   * @param {{URL: LH.Artifacts['URL'], devtoolsLog: LH.DevtoolsLog}} data
-   * @param {LH.Artifacts.ComputedContext} context
-   * @return {Promise<LH.Artifacts.NetworkRequest>}
-   */
-  static async compute_(data, context) {
-    const finalUrl = data.URL.finalUrl;
-    const requests = await NetworkRecords.request(data.devtoolsLog, context);
-    const mainResource = NetworkAnalyzer.findMainDocument(requests, finalUrl);
-    if (!mainResource) {
-      throw new Error('Unable to identify the main resource');
-    }
-
-    return mainResource;
-  }
-}
-
-module.exports = makeComputedArtifact(MainResource, ['URL', 'devtoolsLog']);

package/lighthouse-core/computed/main-thread-tasks.js

@@ -1,25 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('./computed-artifact.js');
-const MainThreadTasks_ = require('../lib/tracehouse/main-thread-tasks.js');
-const ProcessedTrace = require('./processed-trace.js');
-
-class MainThreadTasks {
-  /**
-   * @param {LH.Trace} trace
-   * @param {LH.Artifacts.ComputedContext} context
-   * @return {Promise<Array<LH.Artifacts.TaskNode>>}
-   */
-  static async compute_(trace, context) {
-    const {mainThreadEvents, frames, timestamps} = await ProcessedTrace.request(trace, context);
-    return MainThreadTasks_.getMainThreadTasks(mainThreadEvents, frames, timestamps.traceEnd,
-        timestamps.timeOrigin);
-  }
-}
-
-module.exports = makeComputedArtifact(MainThreadTasks, null);

package/lighthouse-core/computed/manifest-values.js

@@ -1,135 +0,0 @@
-/**
- * @license Copyright 2016 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('./computed-artifact.js');
-const icons = require('../lib/icons.js');
-
-const PWA_DISPLAY_VALUES = ['minimal-ui', 'fullscreen', 'standalone'];
-
-// Historically, Chrome recommended 12 chars as the maximum short_name length to prevent truncation.
-// For more discussion, see https://github.com/GoogleChrome/lighthouse/issues/69 and https://developer.chrome.com/apps/manifest/name#short_name
-const SUGGESTED_SHORTNAME_LENGTH = 12;
-
-class ManifestValues {
-  /** @typedef {(val: NonNullable<LH.Artifacts.Manifest['value']>, errors: LH.Artifacts.InstallabilityErrors['errors']) => boolean} Validator */
-
-  /**
-   * @return {Array<{id: LH.Artifacts.ManifestValueCheckID, failureText: string, validate: Validator}>}
-   */
-  static get manifestChecks() {
-    return [
-      {
-        id: 'hasStartUrl',
-        failureText: 'Manifest does not contain a `start_url`',
-        validate: manifestValue => !!manifestValue.start_url.value,
-      },
-      {
-        id: 'hasIconsAtLeast144px',
-        failureText: 'Manifest does not have a PNG icon of at least 144px',
-        validate: manifestValue => icons.doExist(manifestValue) &&
-            icons.pngSizedAtLeast(144, manifestValue).length > 0,
-      },
-      {
-        id: 'hasIconsAtLeast512px',
-        failureText: 'Manifest does not have a PNG icon of at least 512px',
-        validate: manifestValue => icons.doExist(manifestValue) &&
-            icons.pngSizedAtLeast(512, manifestValue).length > 0,
-      },
-      {
-        id: 'fetchesIcon',
-        failureText: 'Manifest icon failed to be fetched',
-        validate: (manifestValue, errors) => {
-          const failedToFetchIconErrorIds = [
-            'cannot-download-icon',
-            'no-icon-available',
-          ];
-          return icons.doExist(manifestValue) &&
-            !errors.some(error => failedToFetchIconErrorIds.includes(error.errorId));
-        },
-      },
-      {
-        id: 'hasPWADisplayValue',
-        failureText: 'Manifest\'s `display` value is not one of: ' + PWA_DISPLAY_VALUES.join(' | '),
-        validate: manifestValue => PWA_DISPLAY_VALUES.includes(manifestValue.display.value),
-      },
-      {
-        id: 'hasBackgroundColor',
-        failureText: 'Manifest does not have `background_color`',
-        validate: manifestValue => !!manifestValue.background_color.value,
-      },
-      {
-        id: 'hasThemeColor',
-        failureText: 'Manifest does not have `theme_color`',
-        validate: manifestValue => !!manifestValue.theme_color.value,
-      },
-      {
-        id: 'hasShortName',
-        failureText: 'Manifest does not have `short_name`',
-        validate: manifestValue => !!manifestValue.short_name.value,
-      },
-      {
-        id: 'shortNameLength',
-        failureText: `Manifest's \`short_name\` is too long (>${SUGGESTED_SHORTNAME_LENGTH} ` +
-          `characters) to be displayed on a homescreen without truncation`,
-        // Pass if there's no short_name. Don't want to report a non-existent string is too long
-        validate: manifestValue => !!manifestValue.short_name.value &&
-            manifestValue.short_name.value.length <= SUGGESTED_SHORTNAME_LENGTH,
-      },
-      {
-        id: 'hasName',
-        failureText: 'Manifest does not have `name`',
-        validate: manifestValue => !!manifestValue.name.value,
-      },
-      {
-        id: 'hasMaskableIcon',
-        failureText: 'Manifest does not have at least one icon that is maskable',
-        validate: ManifestValue => icons.doExist(ManifestValue) &&
-            icons.containsMaskableIcon(ManifestValue),
-      },
-    ];
-  }
-
-  /**
-   * Returns results of all manifest checks
-   * @param {Pick<LH.Artifacts, 'WebAppManifest'|'InstallabilityErrors'>} Manifest
-   * @return {Promise<LH.Artifacts.ManifestValues>}
-   */
-  static async compute_({WebAppManifest, InstallabilityErrors}) {
-    // if the manifest isn't there or is invalid json, we report that and bail
-    if (WebAppManifest === null) {
-      return {
-        isParseFailure: true,
-        parseFailureReason: 'No manifest was fetched',
-        allChecks: [],
-      };
-    }
-    const manifestValue = WebAppManifest.value;
-    if (manifestValue === undefined) {
-      return {
-        isParseFailure: true,
-        parseFailureReason: 'Manifest failed to parse as valid JSON',
-        allChecks: [],
-      };
-    }
-
-    // manifest is valid, so do the rest of the checks
-    const remainingChecks = ManifestValues.manifestChecks.map(item => {
-      return {
-        id: item.id,
-        failureText: item.failureText,
-        passing: item.validate(manifestValue, InstallabilityErrors.errors),
-      };
-    });
-
-    return {
-      isParseFailure: false,
-      allChecks: remainingChecks,
-    };
-  }
-}
-
-module.exports = makeComputedArtifact(ManifestValues, ['InstallabilityErrors', 'WebAppManifest']);

package/lighthouse-core/computed/metrics/cumulative-layout-shift.js

@@ -1,129 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('../computed-artifact.js');
-const ProcessedTrace = require('../processed-trace.js');
-const LHError = require('../../lib/lh-error.js');
-
-/** @typedef {{ts: number, isMainFrame: boolean, weightedScore: number}} LayoutShiftEvent */
-
-class CumulativeLayoutShift {
-  /**
-   * Returns all LayoutShift events that had no recent input.
-   * Only a `weightedScore` per event is returned. For non-main-frame events, this is
-   * the only score that matters. For main-frame events, `weighted_score_delta === score`.
-   * @see https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/layout/layout_shift_tracker.cc;l=492-495;drc=de3b3a8a8839269c6b44403fa38a13a1ed12fed5
-   * @param {LH.TraceEvent[]} traceEvents
-   * @return {Array<LayoutShiftEvent>}
-   */
-  static getLayoutShiftEvents(traceEvents) {
-    const layoutShiftEvents = [];
-
-    // Chromium will set `had_recent_input` if there was recent user input, which
-    // skips shift events from contributing to CLS. This flag is also set when
-    // Lighthouse changes the emulation size. This results in the first few shift
-    // events having `had_recent_input` set, so ignore it for those events.
-    // See https://bugs.chromium.org/p/chromium/issues/detail?id=1094974.
-    let ignoreHadRecentInput = true;
-
-    for (const event of traceEvents) {
-      if (event.name !== 'LayoutShift' ||
-          !event.args.data ||
-          event.args.data.is_main_frame === undefined) {
-        continue;
-      }
-
-      // For all-frames CLS calculation, we rely on `weighted_score_delta`, which
-      // was added in Chrome 90: https://crbug.com/1173139
-      if (event.args.data.weighted_score_delta === undefined) {
-        throw new LHError(
-          LHError.errors.UNSUPPORTED_OLD_CHROME,
-          {featureName: 'Cumulative Layout Shift'}
-        );
-      }
-
-      if (event.args.data.had_recent_input) {
-        // `had_recent_input` events aren't used unless currently ignoring.
-        if (!ignoreHadRecentInput) continue;
-      } else {
-        // After a false `had_recent_input`, stop ignoring property.
-        ignoreHadRecentInput = false;
-      }
-
-      layoutShiftEvents.push({
-        ts: event.ts,
-        isMainFrame: event.args.data.is_main_frame,
-        weightedScore: event.args.data.weighted_score_delta,
-      });
-    }
-
-    return layoutShiftEvents;
-  }
-
-  /**
-   * Calculates cumulative layout shifts per cluster (session) of LayoutShift
-   * events -- where a new cluster is created when there's a gap of more than
-   * 1000ms since the last LayoutShift event or the cluster is greater than
-   * 5000ms long -- and returns the max LayoutShift score found.
-   * @param {Array<LayoutShiftEvent>} layoutShiftEvents
-   * @return {number}
-   */
-  static calculate(layoutShiftEvents) {
-    const gapMicroseconds = 1_000_000;
-    const limitMicroseconds = 5_000_000;
-    let maxScore = 0;
-    let currentClusterScore = 0;
-    let firstTs = Number.NEGATIVE_INFINITY;
-    let prevTs = Number.NEGATIVE_INFINITY;
-
-    for (const event of layoutShiftEvents) {
-      if (event.ts - firstTs > limitMicroseconds || event.ts - prevTs > gapMicroseconds) {
-        firstTs = event.ts;
-        currentClusterScore = 0;
-      }
-      prevTs = event.ts;
-      currentClusterScore += event.weightedScore;
-      maxScore = Math.max(maxScore, currentClusterScore);
-    }
-
-    return maxScore;
-  }
-
-  /**
-   * Sum all layout shift events from the entire trace.
-   * @param {Array<LayoutShiftEvent>} layoutShiftEvents
-   * @return {number}
-   */
-  static calculateTotalCumulativeLayoutShift(layoutShiftEvents) {
-    return layoutShiftEvents.reduce((sum, e) => sum += e.weightedScore, 0);
-  }
-
-  /**
-   * @param {LH.Trace} trace
-   * @param {LH.Artifacts.ComputedContext} context
-   * @return {Promise<{cumulativeLayoutShift: number, cumulativeLayoutShiftMainFrame: number, totalCumulativeLayoutShift: number}>}
-   */
-  static async compute_(trace, context) {
-    const processedTrace = await ProcessedTrace.request(trace, context);
-
-    const allFrameShiftEvents =
-        CumulativeLayoutShift.getLayoutShiftEvents(processedTrace.frameTreeEvents);
-    const mainFrameShiftEvents = allFrameShiftEvents.filter(e => e.isMainFrame);
-
-    // The original Cumulative Layout Shift metric, the sum of all main-frame shift events.
-    const totalCumulativeLayoutShift =
-        CumulativeLayoutShift.calculateTotalCumulativeLayoutShift(mainFrameShiftEvents);
-
-    return {
-      cumulativeLayoutShift: CumulativeLayoutShift.calculate(allFrameShiftEvents),
-      cumulativeLayoutShiftMainFrame: CumulativeLayoutShift.calculate(mainFrameShiftEvents),
-      totalCumulativeLayoutShift,
-    };
-  }
-}
-
-module.exports = makeComputedArtifact(CumulativeLayoutShift, null);

package/lighthouse-core/computed/metrics/first-contentful-paint-all-frames.js

@@ -1,37 +0,0 @@
-/**
- * @license Copyright 2021 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('../computed-artifact.js');
-const NavigationMetric = require('./navigation-metric.js');
-
-class FirstContentfulPaintAllFrames extends NavigationMetric {
-  /**
-   * @return {Promise<LH.Artifacts.LanternMetric>}
-   */
-  static computeSimulatedMetric() {
-    // TODO: Add support for all frames in lantern.
-    throw new Error('FCP All Frames not implemented in lantern');
-  }
-
-  /**
-   * @param {LH.Artifacts.NavigationMetricComputationData} data
-   * @return {Promise<LH.Artifacts.Metric>}
-   */
-  static async computeObservedMetric(data) {
-    const {processedNavigation} = data;
-
-    return {
-      timing: processedNavigation.timings.firstContentfulPaintAllFrames,
-      timestamp: processedNavigation.timestamps.firstContentfulPaintAllFrames,
-    };
-  }
-}
-
-module.exports = makeComputedArtifact(
-  FirstContentfulPaintAllFrames,
-  ['devtoolsLog', 'gatherContext', 'settings', 'simulator', 'trace']
-);

package/lighthouse-core/computed/metrics/first-contentful-paint.js

@@ -1,40 +0,0 @@
-/**
- * @license Copyright 2018 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('../computed-artifact.js');
-const NavigationMetric = require('./navigation-metric.js');
-const LanternFirstContentfulPaint = require('./lantern-first-contentful-paint.js');
-
-class FirstContentfulPaint extends NavigationMetric {
-  /**
-   * @param {LH.Artifacts.NavigationMetricComputationData} data
-   * @param {LH.Artifacts.ComputedContext} context
-   * @return {Promise<LH.Artifacts.LanternMetric>}
-   */
-  static computeSimulatedMetric(data, context) {
-    const metricData = NavigationMetric.getMetricComputationInput(data);
-    return LanternFirstContentfulPaint.request(metricData, context);
-  }
-
-  /**
-   * @param {LH.Artifacts.NavigationMetricComputationData} data
-   * @return {Promise<LH.Artifacts.Metric>}
-   */
-  static async computeObservedMetric(data) {
-    const {processedNavigation} = data;
-
-    return {
-      timing: processedNavigation.timings.firstContentfulPaint,
-      timestamp: processedNavigation.timestamps.firstContentfulPaint,
-    };
-  }
-}
-
-module.exports = makeComputedArtifact(
-  FirstContentfulPaint,
-  ['devtoolsLog', 'gatherContext', 'settings', 'simulator', 'trace']
-);

package/lighthouse-core/computed/metrics/first-meaningful-paint.js

@@ -1,44 +0,0 @@
-/**
- * @license Copyright 2018 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-const makeComputedArtifact = require('../computed-artifact.js');
-const NavigationMetric = require('./navigation-metric.js');
-const LHError = require('../../lib/lh-error.js');
-const LanternFirstMeaningfulPaint = require('./lantern-first-meaningful-paint.js');
-
-class FirstMeaningfulPaint extends NavigationMetric {
-  /**
-   * @param {LH.Artifacts.NavigationMetricComputationData} data
-   * @param {LH.Artifacts.ComputedContext} context
-   * @return {Promise<LH.Artifacts.LanternMetric>}
-   */
-  static computeSimulatedMetric(data, context) {
-    const metricData = NavigationMetric.getMetricComputationInput(data);
-    return LanternFirstMeaningfulPaint.request(metricData, context);
-  }
-
-  /**
-   * @param {LH.Artifacts.NavigationMetricComputationData} data
-   * @return {Promise<LH.Artifacts.Metric>}
-   */
-  static async computeObservedMetric(data) {
-    const {processedNavigation} = data;
-    if (processedNavigation.timings.firstMeaningfulPaint === undefined) {
-      throw new LHError(LHError.errors.NO_FMP);
-    }
-
-    return {
-      timing: processedNavigation.timings.firstMeaningfulPaint,
-      timestamp: processedNavigation.timestamps.firstMeaningfulPaint,
-    };
-  }
-}
-
-module.exports = makeComputedArtifact(
-  FirstMeaningfulPaint,
-  ['devtoolsLog', 'gatherContext', 'settings', 'simulator', 'trace']
-);