lighthouse 9.6.7 → 10.0.0-dev.20230209

package/lighthouse-core/audits/long-tasks.js

@@ -1,124 +0,0 @@
-/**
- * @license Copyright 2020 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 Audit = require('./audit.js');
-const NetworkRecords = require('../computed/network-records.js');
-const i18n = require('../lib/i18n/i18n.js');
-const MainThreadTasks = require('../computed/main-thread-tasks.js');
-const PageDependencyGraph = require('../computed/page-dependency-graph.js');
-const LoadSimulator = require('../computed/load-simulator.js');
-const {getJavaScriptURLs, getAttributableURLForTask} = require('../lib/tracehouse/task-summary.js');
-
-/** We don't always have timing data for short tasks, if we're missing timing data. Treat it as though it were 0ms. */
-const DEFAULT_TIMING = {startTime: 0, endTime: 0, duration: 0};
-
-const UIStrings = {
-  /** Title of a diagnostic LH audit that provides details on the longest running tasks that occur when the page loads. */
-  title: 'Avoid long main-thread tasks',
-  /** Description of a diagnostic LH audit that shows the user the longest running tasks that occur when the page loads. */
-  description: 'Lists the longest tasks on the main thread, ' +
-    'useful for identifying worst contributors to input delay. ' +
-    '[Learn more](https://web.dev/long-tasks-devtools/)',
-  /** [ICU Syntax] Label identifying the number of long-running CPU tasks that occurred while loading a web page. */
-  displayValue: `{itemCount, plural,
-  =1 {# long task found}
-  other {# long tasks found}
-  }`,
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class LongTasks extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'long-tasks',
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['traces', 'devtoolsLogs'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const settings = context.settings || {};
-    const trace = artifacts.traces[Audit.DEFAULT_PASS];
-    const tasks = await MainThreadTasks.request(trace, context);
-    const devtoolsLog = artifacts.devtoolsLogs[LongTasks.DEFAULT_PASS];
-    const networkRecords = await NetworkRecords.request(devtoolsLog, context);
-
-    /** @type {Map<LH.TraceEvent, LH.Gatherer.Simulation.NodeTiming>} */
-    const taskTimingsByEvent = new Map();
-
-    if (settings.throttlingMethod === 'simulate') {
-      const simulatorOptions = {devtoolsLog, settings: context.settings};
-      const pageGraph = await PageDependencyGraph.request({trace, devtoolsLog}, context);
-      const simulator = await LoadSimulator.request(simulatorOptions, context);
-      const simulation = await simulator.simulate(pageGraph, {label: 'long-tasks-diagnostic'});
-      for (const [node, timing] of simulation.nodeTimings.entries()) {
-        if (node.type !== 'cpu') continue;
-        taskTimingsByEvent.set(node.event, timing);
-      }
-    } else {
-      for (const task of tasks) {
-        if (task.unbounded || task.parent) continue;
-        taskTimingsByEvent.set(task.event, task);
-      }
-    }
-
-    const jsURLs = getJavaScriptURLs(networkRecords);
-    // Only consider up to 20 long, top-level (no parent) tasks that have an explicit endTime
-    const longtasks = tasks
-      .map(t => {
-        const timing = taskTimingsByEvent.get(t.event) || DEFAULT_TIMING;
-        return {...t, duration: timing.duration, startTime: timing.startTime};
-      })
-      .filter(t => t.duration >= 50 && !t.unbounded && !t.parent)
-      .sort((a, b) => b.duration - a.duration)
-      .slice(0, 20);
-
-    // TODO(beytoven): Add start time that matches with the simulated throttling
-    const results = longtasks.map(task => ({
-      url: getAttributableURLForTask(task, jsURLs),
-      duration: task.duration,
-      startTime: task.startTime,
-    }));
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      /* eslint-disable max-len */
-      {key: 'url', itemType: 'url', text: str_(i18n.UIStrings.columnURL)},
-      {key: 'startTime', itemType: 'ms', granularity: 1, text: str_(i18n.UIStrings.columnStartTime)},
-      {key: 'duration', itemType: 'ms', granularity: 1, text: str_(i18n.UIStrings.columnDuration)},
-      /* eslint-enable max-len */
-    ];
-
-    const tableDetails = Audit.makeTableDetails(headings, results);
-
-    let displayValue;
-    if (results.length > 0) {
-      displayValue = str_(UIStrings.displayValue, {itemCount: results.length});
-    }
-
-    return {
-      score: results.length === 0 ? 1 : 0,
-      notApplicable: results.length === 0,
-      details: tableDetails,
-      displayValue,
-    };
-  }
-}
-
-module.exports = LongTasks;
-module.exports.UIStrings = UIStrings;

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

@@ -1,59 +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 Audit = require('./audit.js');
-const MainThreadTasksComputed = require('../computed/main-thread-tasks.js');
-
-class MainThreadTasks extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'main-thread-tasks',
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      title: 'Tasks',
-      description: 'Lists the toplevel main thread tasks that executed during page load.',
-      requiredArtifacts: ['traces'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const trace = artifacts.traces[Audit.DEFAULT_PASS];
-    const tasks = await MainThreadTasksComputed.request(trace, context);
-
-    const results = tasks
-      // Filter to just the sizable toplevel tasks; toplevel tasks are tasks without a parent.
-      .filter(task => task.duration > 5 && !task.parent)
-      .map(task => {
-        return {
-          duration: task.duration,
-          startTime: task.startTime,
-        };
-      });
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'startTime', itemType: 'ms', granularity: 1, text: 'Start Time'},
-      {key: 'duration', itemType: 'ms', granularity: 1, text: 'End Time'},
-    ];
-
-    const tableDetails = Audit.makeTableDetails(headings, results);
-
-    return {
-      score: 1,
-      details: tableDetails,
-    };
-  }
-}
-
-module.exports = MainThreadTasks;

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

@@ -1,134 +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.
- */
-
-/**
- * @fileoverview Audit a page to show a breakdown of execution timings on the main thread
- */
-
-'use strict';
-
-const Audit = require('./audit.js');
-const {taskGroups} = require('../lib/tracehouse/task-groups.js');
-const i18n = require('../lib/i18n/i18n.js');
-const MainThreadTasks = require('../computed/main-thread-tasks.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. */
-  title: 'Minimizes main-thread work',
-  /** Title of a diagnostic audit that provides detail on the main thread work the browser did to load the page. This imperative title is shown to users when there is a significant amount of execution time that could be reduced. */
-  failureTitle: 'Minimize main-thread work',
-  /** Description of a Lighthouse audit that tells the user *why* they should reduce JS execution times. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'Consider reducing the time spent parsing, compiling and executing JS. ' +
-    'You may find delivering smaller JS payloads helps with this. ' +
-    '[Learn more](https://web.dev/mainthread-work-breakdown/)',
-  /** Label for the Main Thread Category column in data tables, rows will have a main thread Category and main thread Task Name. */
-  columnCategory: 'Category',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/** @typedef {import('../lib/tracehouse/task-groups.js').TaskGroupIds} TaskGroupIds */
-
-class MainThreadWorkBreakdown extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'mainthread-work-breakdown',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['traces'],
-    };
-  }
-
-  /**
-   * @return {LH.Audit.ScoreOptions}
-   */
-  static get defaultOptions() {
-    return {
-      // see https://www.desmos.com/calculator/vhglu1x8zv
-      p10: 2017,
-      median: 4000,
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts.TaskNode[]} tasks
-   * @return {Map<TaskGroupIds, number>}
-   */
-  static getExecutionTimingsByGroup(tasks) {
-    /** @type {Map<TaskGroupIds, number>} */
-    const result = new Map();
-
-    for (const task of tasks) {
-      const originalTime = result.get(task.group.id) || 0;
-      result.set(task.group.id, originalTime + task.selfTime);
-    }
-
-    return result;
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const settings = context.settings || {};
-    const trace = artifacts.traces[MainThreadWorkBreakdown.DEFAULT_PASS];
-
-    const tasks = await MainThreadTasks.request(trace, context);
-    const multiplier = settings.throttlingMethod === 'simulate' ?
-      settings.throttling.cpuSlowdownMultiplier : 1;
-
-    const executionTimings = MainThreadWorkBreakdown.getExecutionTimingsByGroup(tasks);
-
-    let totalExecutionTime = 0;
-    /** @type {Record<string, number>} */
-    const categoryTotals = {};
-    const results = Array.from(executionTimings).map(([groupId, rawDuration]) => {
-      const duration = rawDuration * multiplier;
-      totalExecutionTime += duration;
-
-      const categoryTotal = categoryTotals[groupId] || 0;
-      categoryTotals[groupId] = categoryTotal + duration;
-
-      return {
-        group: groupId,
-        groupLabel: taskGroups[groupId].label,
-        duration: duration,
-      };
-    });
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'groupLabel', itemType: 'text', text: str_(UIStrings.columnCategory)},
-      {key: 'duration', itemType: 'ms', granularity: 1, text: str_(i18n.UIStrings.columnTimeSpent)},
-    ];
-
-    results.sort((a, b) => categoryTotals[b.group] - categoryTotals[a.group]);
-    const tableDetails = MainThreadWorkBreakdown.makeTableDetails(headings, results);
-
-    const score = Audit.computeLogNormalScore(
-      {p10: context.options.p10, median: context.options.median},
-      totalExecutionTime
-    );
-
-    return {
-      score,
-      numericValue: totalExecutionTime,
-      numericUnit: 'millisecond',
-      displayValue: str_(i18n.UIStrings.seconds, {timeInMs: totalExecutionTime}),
-      details: tableDetails,
-    };
-  }
-}
-
-module.exports = MainThreadWorkBreakdown;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/manual/manual-audit.js

@@ -1,37 +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';
-
-/**
- * @fileoverview Base class for audits that the user should verify manually on
- * their site.
- */
-
-const Audit = require('../audit.js');
-
-class ManualAudit extends Audit {
-  /**
-   * @return {Pick<LH.Audit.Meta, 'scoreDisplayMode'|'requiredArtifacts'>}
-   */
-  static get partialMeta() {
-    return {
-      scoreDisplayMode: Audit.SCORING_MODES.MANUAL,
-      requiredArtifacts: [],
-    };
-  }
-
-  /**
-   * @return {LH.Audit.Product}
-   */
-  static audit() {
-    return {
-      score: 0,
-      // displayValue: '(needs manual verification)'
-    };
-  }
-}
-
-module.exports = ManualAudit;

package/lighthouse-core/audits/manual/pwa-cross-browser.js

@@ -1,41 +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 ManualAudit = require('./manual-audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that prompts the user to manually check that their site works across different web browsers. */
-  title: 'Site works cross-browser',
-  /** Description of a Lighthouse audit that tells the user why they should make sites work across different browsers. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'To reach the most number of users, sites should work across ' +
-  'every major browser. [Learn more](https://web.dev/pwa-cross-browser/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * @fileoverview Manual PWA audit for cross browser support.
- */
-
-class PWACrossBrowser extends ManualAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return Object.assign({
-      id: 'pwa-cross-browser',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-    }, super.partialMeta);
-  }
-}
-
-module.exports = PWACrossBrowser;
-module.exports.UIStrings = UIStrings;
-

package/lighthouse-core/audits/manual/pwa-each-page-has-url.js

@@ -1,39 +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 ManualAudit = require('./manual-audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that prompts the user to manually check that each page on their website uses a unique URL. */
-  title: 'Each page has a URL',
-  /** Description of a Lighthouse audit that tells the user why they should use unique URLs for each web page. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'Ensure individual pages are deep linkable via URL and that URLs are ' +
-      'unique for the purpose of shareability on social media. [Learn more](https://web.dev/pwa-each-page-has-url/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * @fileoverview Manual PWA audit to ensure every page has a deep link.
- */
-
-class PWAEachPageHasURL extends ManualAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return Object.assign({
-      id: 'pwa-each-page-has-url',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-    }, super.partialMeta);
-  }
-}
-
-module.exports = PWAEachPageHasURL;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/manual/pwa-page-transitions.js

@@ -1,39 +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 ManualAudit = require('./manual-audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that prompts the user to manually check that page transitions (navigating to other pages on a website) shouldn't feel like they are waiting for the network to load. */
-  title: 'Page transitions don\'t feel like they block on the network',
-  /** Description of a Lighthouse audit that tells the user why they should make transitions in their web app feel fast. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'Transitions should feel snappy as you tap around, even on a slow network. ' +
-    'This experience is key to a user\'s perception of performance. [Learn more](https://web.dev/pwa-page-transitions/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * @fileoverview Manual PWA audit for janky-free page transitions.
- */
-
-class PWAPageTransitions extends ManualAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return Object.assign({
-      id: 'pwa-page-transitions',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-    }, super.partialMeta);
-  }
-}
-
-module.exports = PWAPageTransitions;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/maskable-icon.js

@@ -1,71 +0,0 @@
-/**
- * @license Copyright 2020 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 Audit = require('./audit.js');
-const ManifestValues = require('../computed/manifest-values.js');
-const i18n = require('../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on if the manifest contains a maskable icon. This descriptive title is shown to users when the manifest contains at least one maskable icon. */
-  title: 'Manifest has a maskable icon',
-  /** Title of a Lighthouse audit that provides detial on if the manifest contains a maskable icon. this descriptive title is shown to users when the manifest contains no icons that are maskable. */
-  failureTitle: 'Manifest doesn\'t have a maskable icon',
-  /** Description of a Lighthouse audit that tells the user why they their manifest should have at least one maskable icon. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'A maskable icon ensures that the image fills the entire ' +
-    'shape without being letterboxed when installing ' +
-    'the app on a device. [Learn more](https://web.dev/maskable-icon-audit/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * @fileoverview
- * Audits if a manifest contains at least one icon that is maskable
- *
- * Requirements:
- *    * manifest is not empty
- *    * manifest has valid icons
- *    * at least one of the icons has a purpose of 'maskable'
- */
-
-class MaskableIcon extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'maskable-icon',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const manifestValues = await ManifestValues.request(artifacts, context);
-    if (manifestValues.isParseFailure) {
-      return {
-        score: 0,
-        explanation: manifestValues.parseFailureReason,
-      };
-    }
-    const maskableIconCheck = manifestValues.allChecks.find(i => i.id === 'hasMaskableIcon');
-    return {
-      score: maskableIconCheck?.passing ? 1 : 0,
-    };
-  }
-}
-
-module.exports = MaskableIcon;
-module.exports.UIStrings = UIStrings;

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

@@ -1,79 +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 Audit = require('../audit.js');
-const ComputedCLS = require('../../computed/metrics/cumulative-layout-shift.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Description of the Cumulative Layout Shift metric that indicates how much the page changes its layout while it loads. If big segments of the page shift their location during load, the Cumulative Layout Shift will be higher. This description is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'Cumulative Layout Shift measures the movement of visible ' +
-               'elements within the viewport. [Learn more](https://web.dev/cls/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-/**
- * @fileoverview This metric represents the amount of visual shifting of DOM elements during page load.
- */
-class CumulativeLayoutShift extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'cumulative-layout-shift',
-      title: str_(i18n.UIStrings.cumulativeLayoutShiftMetric),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['traces'],
-    };
-  }
-
-  /**
-   * @return {LH.Audit.ScoreOptions}
-   */
-  static get defaultOptions() {
-    return {
-      // https://web.dev/cls/#what-is-a-good-cls-score
-      // This 0.1 target score was determined through both manual evaluation and large-scale analysis.
-      // see https://www.desmos.com/calculator/ksp7q91nop
-      p10: 0.1,
-      median: 0.25,
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const trace = artifacts.traces[Audit.DEFAULT_PASS];
-    const {cumulativeLayoutShift, ...rest} = await ComputedCLS.request(trace, context);
-
-    /** @type {LH.Audit.Details.DebugData} */
-    const details = {
-      type: 'debugdata',
-      items: [rest],
-    };
-
-    return {
-      score: Audit.computeLogNormalScore(
-        {p10: context.options.p10, median: context.options.median},
-        cumulativeLayoutShift
-      ),
-      numericValue: cumulativeLayoutShift,
-      numericUnit: 'unitless',
-      displayValue: cumulativeLayoutShift.toLocaleString(context.settings.locale),
-      details,
-    };
-  }
-}
-
-module.exports = CumulativeLayoutShift;
-module.exports.UIStrings = UIStrings;