lighthouse 11.7.0-dev.20240406 → 11.7.0-dev.20240408

package/core/audits/layout-shift-elements.js

@@ -1,101 +0,0 @@
-/**
- * @license Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Audit} from './audit.js';
-import * as i18n from '../lib/i18n/i18n.js';
-import {CumulativeLayoutShift as CumulativeLayoutShiftComputed} from '../computed/metrics/cumulative-layout-shift.js';
-import CumulativeLayoutShift from './metrics/cumulative-layout-shift.js';
-
-const UIStrings = {
-  /** Descriptive title of a diagnostic audit that provides the top elements affected by layout shifts. */
-  title: 'Avoid large layout shifts',
-  /** Description of a diagnostic audit that provides the top elements affected by layout shifts. "windowing" means the metric value is calculated using the subset of events in a small window of time during the run. "normalization" is a good substitute for "windowing". The last sentence starting with 'Learn' becomes link text to additional documentation. */
-  description: 'These DOM elements were most affected by layout shifts. Some layout shifts may not be included in the CLS metric value due to [windowing](https://web.dev/articles/cls#what_is_cls). [Learn how to improve CLS](https://web.dev/articles/optimize-cls)',
-  /**  Label for a column in a data table; entries in this column will be the amount that the corresponding element affected by layout shifts. */
-  columnContribution: 'Layout shift impact',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-class LayoutShiftElements extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'layout-shift-elements',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS,
-      guidanceLevel: 2,
-      requiredArtifacts: ['traces', 'TraceElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const {cumulativeLayoutShift: clsSavings, impactByNodeId} =
-      await CumulativeLayoutShiftComputed.request(artifacts.traces[Audit.DEFAULT_PASS], context);
-
-    /** @type {Array<{node: LH.Audit.Details.ItemValue, score: number}>} */
-    const clsElementData = artifacts.TraceElements
-      .filter(element => element.traceEventType === 'layout-shift-element')
-      .map(element => ({
-        node: Audit.makeNodeItem(element.node),
-        score: impactByNodeId.get(element.nodeId) || 0,
-      }));
-
-    if (clsElementData.length < impactByNodeId.size) {
-      const displayedNodeImpact = clsElementData.reduce((sum, {score}) => sum += score, 0);
-
-      // This is not necessarily the same as CLS due to normalization.
-      const totalNodeImpact = Array.from(impactByNodeId.values())
-        .reduce((sum, score) => sum + score);
-
-      clsElementData.push({
-        node: {
-          type: 'code',
-          value: str_(i18n.UIStrings.otherResourceType),
-        },
-        score: totalNodeImpact - displayedNodeImpact,
-      });
-    }
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'node', valueType: 'node', label: str_(i18n.UIStrings.columnElement)},
-      {key: 'score', valueType: 'numeric',
-        granularity: 0.001, label: str_(UIStrings.columnContribution)},
-    ];
-
-    const details = Audit.makeTableDetails(headings, clsElementData);
-
-    let displayValue;
-    if (impactByNodeId.size > 0) {
-      displayValue = str_(i18n.UIStrings.displayValueElementsFound,
-        {nodeCount: impactByNodeId.size});
-    }
-
-    const passed = clsSavings <= CumulativeLayoutShift.defaultOptions.p10;
-
-    return {
-      score: passed ? 1 : 0,
-      scoreDisplayMode: passed ? Audit.SCORING_MODES.INFORMATIVE : undefined,
-      metricSavings: {
-        CLS: clsSavings,
-      },
-      notApplicable: details.items.length === 0,
-      displayValue,
-      details,
-    };
-  }
-}
-
-export default LayoutShiftElements;
-export {UIStrings};

package/core/audits/seo/plugins.d.ts

@@ -1,15 +0,0 @@
-export default Plugins;
-declare class Plugins extends Audit {
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @return {LH.Audit.Product}
-     */
-    static audit(artifacts: LH.Artifacts): LH.Audit.Product;
-}
-export namespace UIStrings {
-    const title: string;
-    const failureTitle: string;
-    const description: string;
-}
-import { Audit } from '../audit.js';
-//# sourceMappingURL=plugins.d.ts.map

package/core/audits/seo/plugins.js

@@ -1,150 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Audit} from '../audit.js';
-import * as i18n from '../../lib/i18n/i18n.js';
-
-const JAVA_APPLET_TYPE = 'application/x-java-applet';
-const JAVA_BEAN_TYPE = 'application/x-java-bean';
-const TYPE_BLOCKLIST = new Set([
-  'application/x-shockwave-flash',
-  // See https://docs.oracle.com/cd/E19683-01/816-0378/using_tags/index.html
-  JAVA_APPLET_TYPE,
-  JAVA_BEAN_TYPE,
-  // See https://msdn.microsoft.com/es-es/library/cc265156(v=vs.95).aspx
-  'application/x-silverlight',
-  'application/x-silverlight-2',
-]);
-const FILE_EXTENSION_BLOCKLIST = new Set([
-  'swf',
-  'flv',
-  'class',
-  'xap',
-]);
-const SOURCE_PARAMS = new Set([
-  'code',
-  'movie',
-  'source',
-  'src',
-]);
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on the browser plugins used by the page. This descriptive title is shown when there is no plugin content on the page that would restrict search indexing. */
-  title: 'Document avoids plugins',
-  /** Descriptive title of a Lighthouse audit that provides detail on the browser plugins used by the page. This title is shown when there is plugin content on the page. */
-  failureTitle: 'Document uses plugins',
-  /** Description of a Lighthouse audit that tells the user *why* they need to avoid using browser plugins in their content. This is displayed after a user expands the section to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
-  description: 'Search engines can\'t index plugin content, and ' +
-    'many devices restrict plugins or don\'t support them. ' +
-    '[Learn more about avoiding plugins](https://developer.chrome.com/docs/lighthouse/seo/plugins/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-/**
- * Verifies if given MIME type matches any known plugin MIME type
- * @param {string} type
- * @return {boolean}
- */
-function isPluginType(type) {
-  type = type.trim().toLowerCase();
-
-  return TYPE_BLOCKLIST.has(type) ||
-    type.startsWith(JAVA_APPLET_TYPE) || // e.g. "application/x-java-applet;jpi-version=1.4"
-    type.startsWith(JAVA_BEAN_TYPE);
-}
-
-/**
- * Verifies if given url points to a file that has a known plugin extension
- * @param {string} url
- * @return {boolean}
- */
-function isPluginURL(url) {
-  try {
-    // in order to support relative URLs we need to provied a base URL
-    const filePath = new URL(url, 'http://example.com').pathname;
-    const parts = filePath.split('.');
-
-    if (parts.length < 2) {
-      return false;
-    }
-    const part = parts[parts.length - 1];
-    return FILE_EXTENSION_BLOCKLIST.has(part.trim().toLowerCase());
-  } catch (e) {
-    return false;
-  }
-}
-
-class Plugins extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'plugins',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['EmbeddedContent'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    const plugins = artifacts.EmbeddedContent
-      .filter(item => {
-        if (item.tagName === 'APPLET') {
-          return true;
-        }
-
-        if (
-          (item.tagName === 'EMBED' || item.tagName === 'OBJECT') &&
-          item.type &&
-          isPluginType(item.type)
-        ) {
-          return true;
-        }
-
-        const embedSrc = item.src || item.code;
-        if (item.tagName === 'EMBED' && embedSrc && isPluginURL(embedSrc)) {
-          return true;
-        }
-
-        if (item.tagName === 'OBJECT' && item.data && isPluginURL(item.data)) {
-          return true;
-        }
-
-        const failingParams = item.params.filter(param =>
-          SOURCE_PARAMS.has(param.name.trim().toLowerCase()) && isPluginURL(param.value)
-        );
-
-        return failingParams.length > 0;
-      })
-      .map(plugin => {
-        return {
-          source: Audit.makeNodeItem(plugin.node),
-        };
-      });
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'source', valueType: 'code', label: 'Element source'},
-    ];
-
-    const details = Audit.makeTableDetails(headings, plugins);
-
-    return {
-      score: Number(plugins.length === 0),
-      details,
-    };
-  }
-}
-
-export default Plugins;
-export {UIStrings};

package/core/gather/gatherers/seo/embedded-content.d.ts

@@ -1,10 +0,0 @@
-export default EmbeddedContent;
-declare class EmbeddedContent extends BaseGatherer {
-    /**
-     * @param {LH.Gatherer.Context} passContext
-     * @return {Promise<LH.Artifacts['EmbeddedContent']>}
-     */
-    getArtifact(passContext: LH.Gatherer.Context): Promise<LH.Artifacts['EmbeddedContent']>;
-}
-import BaseGatherer from '../../base-gatherer.js';
-//# sourceMappingURL=embedded-content.d.ts.map

package/core/gather/gatherers/seo/embedded-content.js

@@ -1,63 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/* globals getElementsInDocument getNodeDetails */
-
-import BaseGatherer from '../../base-gatherer.js';
-import {pageFunctions} from '../../../lib/page-functions.js';
-
-/**
- * @return {LH.Artifacts.EmbeddedContentInfo[]}
- */
-function getEmbeddedContent() {
-  const functions = /** @type {typeof pageFunctions} */ ({
-    // @ts-expect-error - getElementsInDocument put into scope via stringification
-    getElementsInDocument,
-    // @ts-expect-error - getNodeDetails put into scope via stringification
-    getNodeDetails,
-  });
-
-  const selector = 'object, embed, applet';
-  const elements = functions.getElementsInDocument(selector);
-  return elements
-    .map(node => ({
-      tagName: node.tagName,
-      type: node.getAttribute('type'),
-      src: node.getAttribute('src'),
-      data: node.getAttribute('data'),
-      code: node.getAttribute('code'),
-      params: Array.from(node.children)
-        .filter(el => el.tagName === 'PARAM')
-        .map(el => ({
-          name: el.getAttribute('name') || '',
-          value: el.getAttribute('value') || '',
-        })),
-      node: functions.getNodeDetails(node),
-    }));
-}
-
-class EmbeddedContent extends BaseGatherer {
-  /** @type {LH.Gatherer.GathererMeta} */
-  meta = {
-    supportedModes: ['snapshot', 'navigation'],
-  };
-
-  /**
-   * @param {LH.Gatherer.Context} passContext
-   * @return {Promise<LH.Artifacts['EmbeddedContent']>}
-   */
-  getArtifact(passContext) {
-    return passContext.driver.executionContext.evaluate(getEmbeddedContent, {
-      args: [],
-      deps: [
-        pageFunctions.getElementsInDocument,
-        pageFunctions.getNodeDetails,
-      ],
-    });
-  }
-}
-
-export default EmbeddedContent;