lighthouse 9.6.8 → 10.0.0-dev.20230210

package/lighthouse-core/audits/dobetterweb/dom-size.js

@@ -1,123 +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 Audits a page to see how the size of DOM it creates. Stats like
- * tree depth, # children, and total elements are returned. The score is calculated
- * based solely on the total number of elements found on the page.
- */
-
-'use strict';
-
-const Audit = require('../audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a diagnostic audit that provides detail on the size of the web page's DOM. The size of a DOM is characterized by the total number of DOM elements and greatest DOM depth. This descriptive title is shown to users when the amount is acceptable and no user action is required. */
-  title: 'Avoids an excessive DOM size',
-  /** Title of a diagnostic audit that provides detail on the size of the web page's DOM. The size of a DOM is characterized by the total number of DOM elements and greatest DOM depth. This imperative title is shown to users when there is a significant amount of execution time that could be reduced. */
-  failureTitle: 'Avoid an excessive DOM size',
-  /** Description of a Lighthouse audit that tells the user *why* they should reduce the size of the web page's DOM. The size of a DOM is characterized by the total number of DOM elements and greatest DOM depth. 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 large DOM will increase memory usage, cause longer ' +
-    '[style calculations](https://developers.google.com/web/fundamentals/performance/rendering/reduce-the-scope-and-complexity-of-style-calculations), ' +
-    'and produce costly [layout reflows](https://developers.google.com/speed/articles/reflow). [Learn more](https://web.dev/dom-size/).',
-  /** Table column header for the type of statistic. These statistics describe how big the DOM is (count of DOM elements, children, depth). */
-  columnStatistic: 'Statistic',
-  /** Table column header for the observed value of the DOM statistic. */
-  columnValue: 'Value',
-  /** [ICU Syntax] Label for an audit identifying the number of DOM elements found in the page. */
-  displayValue: `{itemCount, plural,
-    =1 {1 element}
-    other {# elements}
-    }`,
-  /** Label for the total number of DOM elements found in the page. */
-  statisticDOMElements: 'Total DOM Elements',
-  /** Label for the numeric value of the maximum depth in the page's DOM tree. */
-  statisticDOMDepth: 'Maximum DOM Depth',
-  /** Label for the numeric value of the maximum number of children any DOM element in the page has. The element described will have the most children in the page. */
-  statisticDOMWidth: 'Maximum Child Elements',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class DOMSize extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'dom-size',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['DOMStats'],
-    };
-  }
-
-  /**
-   * @return {LH.Audit.ScoreOptions}
-   */
-  static get defaultOptions() {
-    return {
-      // https://bigquery.cloud.google.com/table/httparchive:lighthouse.2018_04_01_mobile?pli=1
-      // see https://www.desmos.com/calculator/tsunbwqt3f
-      p10: 818,
-      median: 1400,
-    };
-  }
-
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts, context) {
-    const stats = artifacts.DOMStats;
-
-    const score = Audit.computeLogNormalScore(
-      {p10: context.options.p10, median: context.options.median},
-      stats.totalBodyElements
-    );
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'statistic', itemType: 'text', text: str_(UIStrings.columnStatistic)},
-      {key: 'node', itemType: 'node', text: str_(i18n.UIStrings.columnElement)},
-      {key: 'value', itemType: 'numeric', text: str_(UIStrings.columnValue)},
-    ];
-
-    /** @type {LH.Audit.Details.Table['items']} */
-    const items = [
-      {
-        statistic: str_(UIStrings.statisticDOMElements),
-        value: stats.totalBodyElements,
-      },
-      {
-        node: Audit.makeNodeItem(stats.depth),
-        statistic: str_(UIStrings.statisticDOMDepth),
-        value: stats.depth.max,
-      },
-      {
-        node: Audit.makeNodeItem(stats.width),
-        statistic: str_(UIStrings.statisticDOMWidth),
-        value: stats.width.max,
-      },
-    ];
-
-    return {
-      score,
-      numericValue: stats.totalBodyElements,
-      numericUnit: 'element',
-      displayValue: str_(UIStrings.displayValue, {itemCount: stats.totalBodyElements}),
-      details: Audit.makeTableDetails(headings, items),
-    };
-  }
-}
-
-module.exports = DOMSize;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/dobetterweb/geolocation-on-start.js

@@ -1,70 +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.
- */
-
-/**
- * @fileoverview Audits a page to see if it is requesting the geolocation API on
- * page load. This is often a sign of poor user experience because it lacks context.
- */
-
-'use strict';
-
-const ViolationAudit = require('../violation-audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on geolocation permission requests while the page is loading. This descriptive title is shown to users when the page does not ask for geolocation permissions on load. */
-  title: 'Avoids requesting the geolocation permission on page load',
-  /** Title of a Lighthouse audit that provides detail on geolocation permissions requests. This descriptive title is shown to users when the page does ask for geolocation permissions on load. */
-  failureTitle: 'Requests the geolocation permission on page load',
-  /** Description of a Lighthouse audit that tells the user why they should not ask for geolocation permissions on load. 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: 'Users are mistrustful of or confused by sites that request their ' +
-    'location without context. Consider tying the request to a user action instead. ' +
-    '[Learn more](https://web.dev/geolocation-on-start/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class GeolocationOnStart extends ViolationAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'geolocation-on-start',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'ScriptElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    // 'Only request geolocation information in response to a user gesture.'
-    const results = await ViolationAudit.getViolationResults(artifacts, context, /geolocation/);
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'source', itemType: 'source-location', text: str_(i18n.UIStrings.columnSource)},
-    ];
-    // TODO(bckenny): there should actually be a ts error here. results[0].stackTrace
-    // should violate the results type. Shouldn't be removed from details items regardless.
-    const details = ViolationAudit.makeTableDetails(headings, results);
-
-    return {
-      score: Number(results.length === 0),
-      details,
-    };
-  }
-}
-
-module.exports = GeolocationOnStart;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/dobetterweb/inspector-issues.js

@@ -1,192 +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.
- */
-
-/**
- * @fileoverview Audits a page to determine whether it generates issues in the Issues panel of Chrome Devtools.
- * The audit is meant to maintain parity with the Chrome Devtools Issues panel front end.
- * https://source.chromium.org/chromium/chromium/src/+/main:third_party/devtools-frontend/src/front_end/sdk/
- */
-
-'use strict';
-
-/** @typedef {{url: string}} IssueSubItem */
-/** @typedef {{issueType: string|LH.IcuMessage, subItems: Array<IssueSubItem>}} IssueItem */
-
-const Audit = require('../audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on various types of problems with a website, like security or network errors. This descriptive title is shown to users when no issues were logged into the Chrome DevTools Issues panel. */
-  title: 'No issues in the `Issues` panel in Chrome Devtools',
-  /** Title of a Lighthouse audit that provides detail on various types of problems with a website, like security or network errors. This descriptive title is shown to users when issues are detected and logged into the Chrome DevTools Issues panel. */
-  failureTitle: 'Issues were logged in the `Issues` panel in Chrome Devtools',
-  /* eslint-disable max-len */
-  /** Description of a Lighthouse audit that tells the user why issues being logged to the Chrome DevTools Issues panel are a cause for concern and so should be fixed. This is displayed after a user expands the section to see more. No character length limits. */
-  description: 'Issues logged to the `Issues` panel in Chrome Devtools indicate unresolved problems. They can come from network request failures, insufficient security controls, and other browser concerns. Open up the Issues panel in Chrome DevTools for more details on each issue.',
-  /* eslint-enable max-len */
-  /** Table column header for the types of problems observed in a website, like security or network errors. */
-  columnIssueType: 'Issue type',
-  /** The type of an Issue in Chrome DevTools when a resource is blocked due to the website's cross-origin policy. */
-  issueTypeBlockedByResponse: 'Blocked by cross-origin policy',
-  /** The type of an Issue in Chrome DevTools when a site has large ads that use up a lot of the browser's resources. */
-  issueTypeHeavyAds: 'Heavy resource usage by ads',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class IssuesPanelEntries extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'inspector-issues',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['InspectorIssues'],
-    };
-  }
-
-  /**
-   * @param {Array<LH.Crdp.Audits.MixedContentIssueDetails>} mixedContentIssues
-   * @return {LH.Audit.Details.TableItem}
-   */
-  static getMixedContentRow(mixedContentIssues) {
-    const requestUrls = new Set();
-    for (const issue of mixedContentIssues) {
-      const requestUrl = issue.request?.url || issue.mainResourceURL;
-      requestUrls.add(requestUrl);
-    }
-    return {
-      issueType: 'Mixed content',
-      subItems: {
-        type: 'subitems',
-        items: Array.from(requestUrls).map(url => ({url})),
-      },
-    };
-  }
-
-  /**
-   * @param {Array<LH.Crdp.Audits.CookieIssueDetails>} CookieIssues
-   * @return {LH.Audit.Details.TableItem}
-   */
-  static getCookieRow(CookieIssues) {
-    const requestUrls = new Set();
-    for (const issue of CookieIssues) {
-      const requestUrl = (issue.request?.url) || issue.cookieUrl;
-      if (requestUrl) {
-        requestUrls.add(requestUrl);
-      }
-    }
-    return {
-      issueType: 'Cookie',
-      subItems: {
-        type: 'subitems',
-        items: Array.from(requestUrls).map(url => {
-          return {
-            url,
-          };
-        }),
-      },
-    };
-  }
-
-  /**
-   * @param {Array<LH.Crdp.Audits.BlockedByResponseIssueDetails>} blockedByResponseIssues
-   * @return {LH.Audit.Details.TableItem}
-   */
-  static getBlockedByResponseRow(blockedByResponseIssues) {
-    const requestUrls = new Set();
-    for (const issue of blockedByResponseIssues) {
-      const requestUrl = issue.request?.url;
-      if (requestUrl) {
-        requestUrls.add(requestUrl);
-      }
-    }
-    return {
-      issueType: str_(UIStrings.issueTypeBlockedByResponse),
-      subItems: {
-        type: 'subitems',
-        items: Array.from(requestUrls).map(url => {
-          return {
-            url,
-          };
-        }),
-      },
-    };
-  }
-
-  /**
-   * @param {Array<LH.Crdp.Audits.ContentSecurityPolicyIssueDetails>} cspIssues
-   * @return {LH.Audit.Details.TableItem}
-   */
-  static getContentSecurityPolicyRow(cspIssues) {
-    const requestUrls = new Set();
-    for (const issue of cspIssues) {
-      const requestUrl = issue.blockedURL;
-      if (requestUrl) {
-        requestUrls.add(requestUrl);
-      }
-    }
-    return {
-      issueType: 'Content security policy',
-      subItems: {
-        type: 'subitems',
-        items: Array.from(requestUrls).map(url => {
-          return {
-            url,
-          };
-        }),
-      },
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      /* eslint-disable max-len */
-      {key: 'issueType', itemType: 'text', subItemsHeading: {key: 'url', itemType: 'url'}, text: str_(UIStrings.columnIssueType)},
-      /* eslint-enable max-len */
-    ];
-
-    const issues = artifacts.InspectorIssues;
-    /** @type LH.Audit.Details.TableItem[] */
-    const items = [];
-
-    if (issues.mixedContentIssue.length) {
-      items.push(this.getMixedContentRow(issues.mixedContentIssue));
-    }
-    if (issues.cookieIssue.length) {
-      items.push(this.getCookieRow(issues.cookieIssue));
-    }
-    if (issues.blockedByResponseIssue.length) {
-      items.push(this.getBlockedByResponseRow(issues.blockedByResponseIssue));
-    }
-    if (issues.heavyAdIssue.length) {
-      items.push({issueType: str_(UIStrings.issueTypeHeavyAds)});
-    }
-    const cspIssues = issues.contentSecurityPolicyIssue.filter(issue => {
-      // kTrustedTypesSinkViolation and kTrustedTypesPolicyViolation aren't currently supported by the Issues panel
-      return issue.contentSecurityPolicyViolationType !== 'kTrustedTypesSinkViolation' &&
-        issue.contentSecurityPolicyViolationType !== 'kTrustedTypesPolicyViolation';
-    });
-    if (cspIssues.length) {
-      items.push(this.getContentSecurityPolicyRow(cspIssues));
-    }
-    return {
-      score: items.length > 0 ? 0 : 1,
-      details: Audit.makeTableDetails(headings, items),
-    };
-  }
-}
-
-module.exports = IssuesPanelEntries;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/dobetterweb/js-libraries.js

@@ -1,88 +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 Diagnostic audit that lists all JavaScript libraries detected on the page
- */
-
-'use strict';
-
-const Audit = require('../audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on the Javascript libraries that are used on the page. */
-  title: 'Detected JavaScript libraries',
-  /** Description of a Lighthouse audit that tells the user what this audit is detecting. This is displayed after a user expands the section to see more. No character length limits. */
-  description: 'All front-end JavaScript libraries detected on the page. [Learn more](https://web.dev/js-libraries/).',
-  /** Label for a column in a data table; entries will be the version numbers of the detected Javascript libraries.  */
-  columnVersion: 'Version',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class JsLibrariesAudit extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'js-libraries',
-      title: str_(UIStrings.title),
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['Stacks'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    const libDetails = artifacts.Stacks
-      .filter(stack => stack.detector === 'js')
-      // Don't show the fast paths in the table.
-      .filter(stack => !stack.id.endsWith('-fast'))
-      .map(stack => ({
-        name: stack.name,
-        version: stack.version,
-        npm: stack.npm,
-      }));
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'name', itemType: 'text', text: str_(i18n.UIStrings.columnName)},
-      {key: 'version', itemType: 'text', text: str_(UIStrings.columnVersion)},
-    ];
-    const details = Audit.makeTableDetails(headings, libDetails, {});
-
-    const debugData = {
-      type: /** @type {const} */ ('debugdata'),
-      stacks: artifacts.Stacks.map(stack => {
-        return {
-          id: stack.id,
-          version: stack.version,
-        };
-      }),
-    };
-
-    if (!libDetails.length) {
-      return {score: null, notApplicable: true};
-    }
-
-    return {
-      score: 1, // Always pass for now.
-      details: {
-        ...details,
-        debugData,
-      },
-    };
-  }
-}
-
-module.exports = JsLibrariesAudit;
-module.exports.UIStrings = UIStrings;

package/lighthouse-core/audits/dobetterweb/no-document-write.js

@@ -1,85 +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.
- */
-
-/**
- * @fileoverview Audit a page to see if it's using document.write(). document.write() has terrible performance characteristics.
- *
- * *Intervention*
- * There is a Chrome intervention for the API: https://developers.google.com/web/updates/2016/08/removing-document-write
- * The intervention appears to only be enabled when the user is on a slow connnection. https://chromestatus.com/features#document.write
- * When it's enabled, _some_ calls to document.write() will just not do anything. They're just no-ops.
- *  - "some" == mostly third-party situations. src: https://cs.chromium.org/chromium/src/third_party/blink/renderer/core/script/document_write_intervention.cc?l=109&rcl=61a806621861e9abc07b3a57a6f2edae188d1742
- * If this happens, there will be an error message in the console. src: https://cs.chromium.org/chromium/src/third_party/blink/renderer/core/script/document_write_intervention.cc?l=51-61&rcl=61a806621861e9abc07b3a57a6f2edae188d1742
- *  - Lighthouse doesn't report here on that situation, though it'll show up in `errors-in-console`
- * The intervention may also not block the .write() (because the connection wasn't slow),
- * but it will emit a console warning.
- *  - Lighthouse will also report that here, as the .write() call succeeded.
- * Demo URL: https://output.jsbin.com/qopijux/quiet
- *
- * *This Audit*
- * This audit reports on document.write() calls which the intervention didn't stop.
- * (They worked as intended). If that happens, the browser emits a verbose-level violation
- * console message (hidden by default) that says:
- *     "Parser was blocked due to document.write(<script>)". src: https://cs.chromium.org/chromium/src/third_party/blink/renderer/core/frame/performance_monitor.cc?l=294-300&rcl=40b90cafad9f219e0845879ed8648bdcc96116dc
- */
-
-'use strict';
-
-const ViolationAudit = require('../violation-audit.js');
-const i18n = require('../../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on the page's use of the `document.write` API. This descriptive title is shown to users when the page does not use `document.write`. */
-  title: 'Avoids `document.write()`',
-  /** Title of a Lighthouse audit that provides detail on the page's use of the `document.write` API. This imperative title is shown to users when the page does use `document.write`. */
-  failureTitle: 'Avoid `document.write()`',
-  /** Description of a Lighthouse audit that tells the user why they should avoid `document.write`. 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: 'For users on slow connections, external scripts dynamically injected via ' +
-      '`document.write()` can delay page load by tens of seconds. ' +
-      '[Learn more](https://web.dev/no-document-write/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class NoDocWriteAudit extends ViolationAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'no-document-write',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'ScriptElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const results =
-      await ViolationAudit.getViolationResults(artifacts, context, /document\.write/);
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'source', itemType: 'source-location', text: str_(i18n.UIStrings.columnSource)},
-    ];
-    // TODO(bckenny): see TODO in geolocation-on-start
-    const details = ViolationAudit.makeTableDetails(headings, results);
-
-    return {
-      score: Number(results.length === 0),
-      details,
-    };
-  }
-}
-
-module.exports = NoDocWriteAudit;
-module.exports.UIStrings = UIStrings;