lighthouse 9.6.7 → 10.0.0

package/lighthouse-core/audits/metrics/speed-index.js

@@ -1,88 +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 Audit = require('../audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-const ComputedSi = require('../../computed/metrics/speed-index.js');
-
-const UIStrings = {
-  /** Description of the Speed Index metric, which summarizes how quickly the page looked visually complete. This 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: 'Speed Index shows how quickly the contents of a page are visibly populated. ' +
-      '[Learn more](https://web.dev/speed-index/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class SpeedIndex extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'speed-index',
-      title: str_(i18n.UIStrings.speedIndexMetric),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext'],
-    };
-  }
-
-  /**
-   * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
-   */
-  static get defaultOptions() {
-    return {
-      mobile: {
-        // 25th and 5th percentiles HTTPArchive -> median and PODR, then p10 derived from them.
-        // https://bigquery.cloud.google.com/table/httparchive:lighthouse.2018_04_01_mobile?pli=1
-        // see https://www.desmos.com/calculator/dvuzvpl7mi
-        scoring: {
-          p10: 3387,
-          median: 5800,
-        },
-      },
-      desktop: {
-        // SELECT QUANTILES(SpeedIndex, 21) FROM [httparchive:summary_pages.2018_12_15_desktop] LIMIT 1000
-        scoring: {
-          p10: 1311,
-          median: 2300,
-        },
-      },
-    };
-  }
-
-  /**
-   * Audits the page to give a score for the Speed Index.
-   * @see https://github.com/GoogleChrome/lighthouse/issues/197
-   * @param {LH.Artifacts} artifacts The artifacts from the gather phase.
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const trace = artifacts.traces[Audit.DEFAULT_PASS];
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const gatherContext = artifacts.GatherContext;
-    const metricComputationData = {trace, devtoolsLog, gatherContext, settings: context.settings};
-    const metricResult = await ComputedSi.request(metricComputationData, context);
-    const options = context.options[context.settings.formFactor];
-
-
-    return {
-      score: Audit.computeLogNormalScore(
-        options.scoring,
-        metricResult.timing
-      ),
-      numericValue: metricResult.timing,
-      numericUnit: 'millisecond',
-      displayValue: str_(i18n.UIStrings.seconds, {timeInMs: metricResult.timing}),
-    };
-  }
-}
-
-module.exports = SpeedIndex;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/metrics/total-blocking-time.js

@@ -1,117 +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 ComputedTBT = require('../../computed/metrics/total-blocking-time.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Description of the Total Blocking Time (TBT) metric, which calculates the total duration of blocking time for a web page. Blocking times are time periods when the page would be blocked (prevented) from responding to user input (clicks, taps, and keypresses will feel slow to respond). This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits.*/
-  description: 'Sum of all time periods between FCP and Time to Interactive, ' +
-      'when task length exceeded 50ms, expressed in milliseconds. [Learn more](https://web.dev/lighthouse-total-blocking-time/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class TotalBlockingTime extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'total-blocking-time',
-      title: str_(i18n.UIStrings.totalBlockingTimeMetric),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext'],
-    };
-  }
-
-  /**
-   * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
-   */
-  static get defaultOptions() {
-    return {
-      mobile: {
-        // If determined from HTTP Archive data…
-        //     SELECT
-        //         APPROX_QUANTILES(tbt_value, 100)[OFFSET(8)] AS p08_tbt,
-        //         APPROX_QUANTILES(tbt_value, 100)[OFFSET(25)] AS p25_tbt
-        //     FROM (
-        //         SELECT CAST(JSON_EXTRACT_SCALAR(report, '$.audits.total-blocking-time.numericValue') AS FLOAT64) AS tbt_value
-        //         FROM `httparchive.lighthouse.2021_05_01_mobile`
-        //         WHERE report is not NULL
-        //     )
-        // …we'd use control points of 19 and 189, which leads to surprisingly harsh scoring.
-        //
-        // The following coefficients are semi-arbitrarily chosen, but start to approach the "correct" ones:
-        // See https://www.desmos.com/calculator/pwcgna1cvf go/lh8-tbt-curves
-        scoring: {
-          p10: 200,
-          median: 600,
-        },
-      },
-      desktop: {
-        // Chosen in HTTP Archive desktop results to approximate curve easing described above.
-        // SELECT
-        //   APPROX_QUANTILES(tbtValue, 100)[OFFSET(40)] AS p40_tbt,
-        //   APPROX_QUANTILES(tbtValue, 100)[OFFSET(60)] AS p60_tbt
-        // FROM (
-        //   SELECT CAST(JSON_EXTRACT_SCALAR(payload, '$._TotalBlockingTime') AS NUMERIC) AS tbtValue
-        //   FROM `httparchive.pages.2020_04_01_desktop`
-        // )
-        scoring: {
-          p10: 150,
-          median: 350,
-        },
-      },
-    };
-  }
-
-  /**
-   * Audits the page to calculate Total Blocking Time.
-   *
-   * We define Blocking Time as any time interval in the loading timeline where task length exceeds
-   * 50ms. For example, if there is a 110ms main thread task, the last 60ms of it is blocking time.
-   * Total Blocking Time is the sum of all Blocking Time between First Contentful Paint and
-   * Interactive Time (TTI).
-   *
-   * @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 devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const gatherContext = artifacts.GatherContext;
-    const metricComputationData = {trace, devtoolsLog, gatherContext, settings: context.settings};
-    if (
-      gatherContext.gatherMode === 'timespan' &&
-      context.settings.throttlingMethod === 'simulate'
-    ) {
-      return {score: 1, notApplicable: true};
-    }
-
-    const metricResult = await ComputedTBT.request(metricComputationData, context);
-
-    const options = context.options[context.settings.formFactor];
-
-
-    return {
-      score: Audit.computeLogNormalScore(
-        options.scoring,
-        metricResult.timing
-      ),
-      numericValue: metricResult.timing,
-      numericUnit: 'millisecond',
-      displayValue: str_(i18n.UIStrings.ms, {timeInMs: metricResult.timing}),
-    };
-  }
-}
-
-module.exports = TotalBlockingTime;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/metrics.js

@@ -1,73 +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 Audit = require('./audit.js');
-const ComputedTimingSummary = require('../computed/metrics/timing-summary.js');
-
-/** @type {Set<keyof LH.Artifacts.TimingSummary>} */
-const DECIMAL_METRIC_KEYS = new Set([
-  'cumulativeLayoutShift',
-  'cumulativeLayoutShiftMainFrame',
-  'totalCumulativeLayoutShift',
-  'observedCumulativeLayoutShift',
-  'observedCumulativeLayoutShiftMainFrame',
-  'observedTotalCumulativeLayoutShift',
-]);
-
-class Metrics extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'metrics',
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      title: 'Metrics',
-      description: 'Collects all available metrics.',
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const gatherContext = artifacts.GatherContext;
-    const trace = artifacts.traces[Audit.DEFAULT_PASS];
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const summary = await ComputedTimingSummary
-      .request({trace, devtoolsLog, gatherContext, settings: context.settings}, context);
-    const metrics = summary.metrics;
-    const debugInfo = summary.debugInfo;
-
-    for (const [name, value] of Object.entries(metrics)) {
-      const key = /** @type {keyof LH.Artifacts.TimingSummary} */ (name);
-      if (typeof value === 'number' && !DECIMAL_METRIC_KEYS.has(key)) {
-        metrics[key] = Math.round(value);
-      }
-    }
-
-    /** @type {LH.Audit.Details.DebugData} */
-    const details = {
-      type: 'debugdata',
-      // TODO: Consider not nesting metrics under `items`.
-      items: [metrics, debugInfo],
-    };
-
-    return {
-      score: 1,
-      numericValue: metrics.interactive || 0,
-      numericUnit: 'millisecond',
-      details,
-    };
-  }
-}
-
-module.exports = Metrics;

package/lighthouse-core/audits/multi-check-audit.js

@@ -1,83 +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 boolean audits that can have multiple reasons for failure
- */
-
-const Audit = require('./audit.js');
-
-class MultiCheckAudit extends Audit {
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const multiProduct = await this.audit_(artifacts, context);
-    return this.createAuditProduct(multiProduct);
-  }
-
-  /**
-   * @param {{failures: Array<string>, manifestValues?: LH.Artifacts.ManifestValues}} result
-   * @return {LH.Audit.Product}
-   */
-  static createAuditProduct(result) {
-    /** @type {LH.Audit.MultiCheckAuditDetails} */
-    const detailsItem = {
-      ...result,
-      ...result.manifestValues,
-      manifestValues: undefined,
-      allChecks: undefined,
-    };
-
-    if (result.manifestValues?.allChecks) {
-      result.manifestValues.allChecks.forEach(check => {
-        detailsItem[check.id] = check.passing;
-      });
-    }
-
-    // Include the detailed pass/fail checklist as a diagnostic.
-    /** @type {LH.Audit.Details.DebugData} */
-    const details = {
-      type: 'debugdata',
-      // TODO: Consider not nesting detailsItem under `items`.
-      items: [detailsItem],
-    };
-
-    // If we fail, share the failures
-    if (result.failures.length > 0) {
-      return {
-        score: 0,
-        // TODO(#11495): make this i18n-able.
-        explanation: `Failures: ${result.failures.join(',\n')}.`,
-        details,
-      };
-    }
-
-    // Otherwise, we pass
-    return {
-      score: 1,
-      details,
-    };
-  }
-
-  /* eslint-disable no-unused-vars */
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<{failures: Array<string>, manifestValues?: LH.Artifacts.ManifestValues}>}
-   */
-  static audit_(artifacts, context) {
-    throw new Error('audit_ unimplemented');
-  }
-
-  /* eslint-enable no-unused-vars */
-}
-
-module.exports = MultiCheckAudit;

package/lighthouse-core/audits/network-requests.js

@@ -1,129 +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 Audit = require('./audit.js');
-const URL = require('../lib/url-shim.js');
-const NetworkRecords = require('../computed/network-records.js');
-const MainResource = require('../computed/main-resource.js');
-
-class NetworkRequests extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'network-requests',
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      title: 'Network Requests',
-      description: 'Lists the network requests that were made during page load.',
-      requiredArtifacts: ['devtoolsLogs', 'URL', 'GatherContext'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const records = await NetworkRecords.request(devtoolsLog, context);
-    const earliestStartTime = records.reduce(
-      (min, record) => Math.min(min, record.startTime),
-      Infinity
-    );
-
-    // Optional mainFrameId check because the main resource is only available for
-    // navigations. TODO: https://github.com/GoogleChrome/lighthouse/issues/14157
-    // for the general solution to this.
-    /** @type {string|undefined} */
-    let mainFrameId;
-    if (artifacts.GatherContext.gatherMode === 'navigation') {
-      const mainResource = await MainResource.request({devtoolsLog, URL: artifacts.URL}, context);
-      mainFrameId = mainResource.frameId;
-    }
-
-    /** @param {number} time */
-    const timeToMs = time => time < earliestStartTime || !Number.isFinite(time) ?
-      undefined : (time - earliestStartTime) * 1000;
-
-    const results = records.map(record => {
-      const endTimeDeltaMs = record.lrStatistics?.endTimeDeltaMs;
-      const TCPMs = record.lrStatistics?.TCPMs;
-      const requestMs = record.lrStatistics?.requestMs;
-      const responseMs = record.lrStatistics?.responseMs;
-      // Default these to undefined so omitted from JSON in the negative case.
-      const isLinkPreload = record.isLinkPreload || undefined;
-      const experimentalFromMainFrame = mainFrameId ?
-        ((record.frameId === mainFrameId) || undefined) :
-        undefined;
-
-      return {
-        url: URL.elideDataURI(record.url),
-        protocol: record.protocol,
-        startTime: timeToMs(record.startTime),
-        endTime: timeToMs(record.endTime),
-        finished: record.finished,
-        transferSize: record.transferSize,
-        resourceSize: record.resourceSize,
-        statusCode: record.statusCode,
-        mimeType: record.mimeType,
-        resourceType: record.resourceType,
-        priority: record.priority,
-        isLinkPreload,
-        experimentalFromMainFrame,
-        lrEndTimeDeltaMs: endTimeDeltaMs, // Only exists on Lightrider runs
-        lrTCPMs: TCPMs, // Only exists on Lightrider runs
-        lrRequestMs: requestMs, // Only exists on Lightrider runs
-        lrResponseMs: responseMs, // Only exists on Lightrider runs
-      };
-    });
-
-    // NOTE(i18n): this audit is only for debug info in the LHR and does not appear in the report.
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'url', itemType: 'url', text: 'URL'},
-      {key: 'protocol', itemType: 'text', text: 'Protocol'},
-      {key: 'startTime', itemType: 'ms', granularity: 1, text: 'Start Time'},
-      {key: 'endTime', itemType: 'ms', granularity: 1, text: 'End Time'},
-      {
-        key: 'transferSize',
-        itemType: 'bytes',
-        displayUnit: 'kb',
-        granularity: 1,
-        text: 'Transfer Size',
-      },
-      {
-        key: 'resourceSize',
-        itemType: 'bytes',
-        displayUnit: 'kb',
-        granularity: 1,
-        text: 'Resource Size',
-      },
-      {key: 'statusCode', itemType: 'text', text: 'Status Code'},
-      {key: 'mimeType', itemType: 'text', text: 'MIME Type'},
-      {key: 'resourceType', itemType: 'text', text: 'Resource Type'},
-    ];
-
-    const tableDetails = Audit.makeTableDetails(headings, results);
-
-    // Include starting timestamp to allow syncing requests with navStart/metric timestamps.
-    const networkStartTimeTs = Number.isFinite(earliestStartTime) ?
-        earliestStartTime * 1_000_000 : undefined;
-    tableDetails.debugData = {
-      type: 'debugdata',
-      networkStartTimeTs,
-    };
-
-    return {
-      score: 1,
-      details: tableDetails,
-    };
-  }
-}
-
-module.exports = NetworkRequests;

package/lighthouse-core/audits/network-rtt.js

@@ -1,90 +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 i18n = require('../lib/i18n/i18n.js');
-const NetworkRecords = require('../computed/network-records.js');
-const NetworkAnalysisComputed = require('../computed/network-analysis.js');
-
-const UIStrings = {
-  /** Descriptive title of a Lighthouse audit that tells the user the round trip times to each origin the page connected to. This is displayed in a list of audit titles that Lighthouse generates. */
-  title: 'Network Round Trip Times',
-  /** Description of a Lighthouse audit that tells the user that a high network round trip time (RTT) can effect their website's performance because the server is physically far away from them thus making the RTT high. 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: 'Network round trip times (RTT) have a large impact on performance. ' +
-    'If the RTT to an origin is high, it\'s an indication that servers closer to the user could ' +
-    'improve performance. [Learn more](https://hpbn.co/primer-on-latency-and-bandwidth/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class NetworkRTT extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'network-rtt',
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['devtoolsLogs'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const records = await NetworkRecords.request(devtoolsLog, context);
-    if (!records.length) {
-      return {
-        score: 1,
-        notApplicable: true,
-      };
-    }
-
-    const analysis = await NetworkAnalysisComputed.request(devtoolsLog, context);
-
-    /** @type {number} */
-    let maxRtt = 0;
-    const baseRtt = analysis.rtt;
-    /** @type {Array<{origin: string, rtt: number}>} */
-    const results = [];
-    for (const [origin, additionalRtt] of analysis.additionalRttByOrigin.entries()) {
-      // Ignore entries that don't look like real origins, like the __SUMMARY__ entry.
-      if (!origin.startsWith('http')) continue;
-
-      const rtt = additionalRtt + baseRtt;
-      results.push({origin, rtt});
-      maxRtt = Number.isFinite(rtt) ? Math.max(rtt, maxRtt) : maxRtt;
-    }
-
-    results.sort((a, b) => b.rtt - a.rtt);
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'origin', itemType: 'text', text: str_(i18n.UIStrings.columnURL)},
-      {key: 'rtt', itemType: 'ms', granularity: 1, text: str_(i18n.UIStrings.columnTimeSpent)},
-    ];
-
-    const tableDetails = Audit.makeTableDetails(headings, results);
-
-    return {
-      score: 1,
-      numericValue: maxRtt,
-      numericUnit: 'millisecond',
-      displayValue: str_(i18n.UIStrings.ms, {timeInMs: maxRtt}),
-      details: tableDetails,
-    };
-  }
-}
-
-module.exports = NetworkRTT;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/network-server-latency.js

@@ -1,89 +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 i18n = require('../lib/i18n/i18n.js');
-const NetworkRecords = require('../computed/network-records.js');
-const NetworkAnalysisComputed = require('../computed/network-analysis.js');
-
-const UIStrings = {
-  /** Descriptive title of a Lighthouse audit that tells the user the server latencies observed from each origin the page connected to. This is displayed in a list of audit titles that Lighthouse generates. */
-  title: 'Server Backend Latencies',
-  /** Description of a Lighthouse audit that tells the user that server latency can effect their website's performance negatively. 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: 'Server latencies can impact web performance. ' +
-    'If the server latency of an origin is high, it\'s an indication the server is overloaded ' +
-    'or has poor backend performance. [Learn more](https://hpbn.co/primer-on-web-performance/#analyzing-the-resource-waterfall).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class NetworkServerLatency extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'network-server-latency',
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['devtoolsLogs'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const records = await NetworkRecords.request(devtoolsLog, context);
-    if (!records.length) {
-      return {
-        score: 1,
-        notApplicable: true,
-      };
-    }
-
-    const analysis = await NetworkAnalysisComputed.request(devtoolsLog, context);
-
-    /** @type {number} */
-    let maxLatency = 0;
-    /** @type {Array<{origin: string, serverResponseTime: number}>} */
-    const results = [];
-    for (const [origin, serverResponseTime] of analysis.serverResponseTimeByOrigin.entries()) {
-      // Ignore entries that don't look like real origins, like the __SUMMARY__ entry.
-      if (!origin.startsWith('http')) continue;
-
-      maxLatency = Math.max(serverResponseTime, maxLatency);
-      results.push({origin, serverResponseTime});
-    }
-
-    results.sort((a, b) => b.serverResponseTime - a.serverResponseTime);
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'origin', itemType: 'text', text: str_(i18n.UIStrings.columnURL)},
-      {key: 'serverResponseTime', itemType: 'ms', granularity: 1,
-        text: str_(i18n.UIStrings.columnTimeSpent)},
-    ];
-
-    const tableDetails = Audit.makeTableDetails(headings, results);
-
-    return {
-      score: Math.max(1 - (maxLatency / 500), 0),
-      numericValue: maxLatency,
-      numericUnit: 'millisecond',
-      displayValue: str_(i18n.UIStrings.ms, {timeInMs: maxLatency}),
-      details: tableDetails,
-    };
-  }
-}
-
-module.exports = NetworkServerLatency;
-module.exports.UIStrings = UIStrings;