lighthouse 12.8.2 → 13.0.0-dev.20251010

package/report/renderer/details-renderer.d.ts

@@ -146,9 +146,8 @@ export class DetailsRenderer {
     /**
      * @param {LH.Audit.Details.SourceLocationValue} item
      * @return {Element|null}
-     * @protected
      */
-    protected renderSourceLocation(item: LH.Audit.Details.SourceLocationValue): Element | null;
+    renderSourceLocation(item: LH.Audit.Details.SourceLocationValue): Element | null;
     /**
      * @param {LH.Audit.Details.Filmstrip} details
      * @return {Element}

package/report/renderer/details-renderer.js

@@ -656,7 +656,6 @@ export class DetailsRenderer {
   /**
    * @param {LH.Audit.Details.SourceLocationValue} item
    * @return {Element|null}
-   * @protected
    */
   renderSourceLocation(item) {
     if (!item.url) {

package/report/renderer/dom.d.ts

@@ -12,10 +12,6 @@ export class DOM {
     _componentCache: Map<string, DocumentFragment>;
     /** @type {HTMLElement} */
     rootEl: HTMLElement;
-    /** @type {WeakMap<Element, Element>} */
-    _swappableSections: WeakMap<Element, Element>;
-    _onSwap: () => void;
-    _onSwapHook: () => void;
     /**
      * @template {string} T
      * @param {T} name
@@ -141,15 +137,6 @@ export class DOM {
      * @param {string} filename
      */
     saveFile(blob: Blob | File, filename: string): void;
-    /**
-     * @param {Element} section1
-     * @param {Element} section2
-     */
-    registerSwappableSections(section1: Element, section2: Element): void;
-    /**
-     * @param {Element} section
-     */
-    swapSectionIfPossible(section: Element): void;
 }
 export type HTMLElementByTagName = HTMLElementTagNameMap & {
     [id: string]: HTMLElement;

package/report/renderer/dom.js

@@ -28,10 +28,6 @@ export class DOM {
     /** @type {HTMLElement} */
     // For legacy Report API users, this'll be undefined, but set in renderReport
     this.rootEl = rootEl;
-    /** @type {WeakMap<Element, Element>} */
-    this._swappableSections = new WeakMap();
-    this._onSwap = () => {};
-    this._onSwapHook = () => {};
   }
 
   /**
@@ -327,38 +323,4 @@ export class DOM {
     this._document.body.removeChild(a);
     setTimeout(() => URL.revokeObjectURL(a.href), 500);
   }
-
-  /**
-   * @param {Element} section1
-   * @param {Element} section2
-   */
-  registerSwappableSections(section1, section2) {
-    this._swappableSections.set(section1, section2);
-    this._swappableSections.set(section2, section1);
-  }
-
-  /**
-   * @param {Element} section
-   */
-  swapSectionIfPossible(section) {
-    const newSection = this._swappableSections.get(section);
-    if (!newSection) return;
-
-    const parent = section.parentNode;
-    if (!parent) return;
-
-    // LH Report enforces that only the first instance of a component will include the styles.
-    // If these single-instance happen to be in `section` then they could be lost once `section` is
-    // removed from the DOM.
-    // Therefore we need to transfer any styles that only exist in `section` into `newSection`.
-    const stylesToTransfer = section.querySelectorAll('style');
-    newSection.append(...stylesToTransfer);
-
-    parent.insertBefore(newSection, section);
-    section.remove();
-    this._onSwap();
-    if (this._onSwapHook) {
-      this._onSwapHook();
-    }
-  }
 }

package/report/renderer/performance-category-renderer.d.ts

@@ -1,9 +1,4 @@
-/**
- * @typedef {('DEFAULT'|'AUDITS'|'INSIGHTS')} InsightsExperimentState
- */
 export class PerformanceCategoryRenderer extends CategoryRenderer {
-    /** @type InsightsExperimentState*/
-    _memoryInsightToggleState: InsightsExperimentState;
     /**
      * @param {LH.ReportResult.AuditRef} audit
      * @return {!Element}
@@ -28,26 +23,6 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
         overallImpact: number;
         overallLinearImpact: number;
     };
-    /**
-     * @param {InsightsExperimentState} newState
-    **/
-    _persistInsightToggleToStorage(newState: InsightsExperimentState): void;
-    /**
-     * @returns {InsightsExperimentState}
-    **/
-    _getInsightToggleState(): InsightsExperimentState;
-    /**
-     * @returns {InsightsExperimentState}
-    **/
-    _getRawInsightToggleState(): InsightsExperimentState;
-    /**
-     * @param {HTMLButtonElement} button
-    **/
-    _setInsightToggleButtonText(button: HTMLButtonElement): void;
-    /**
-     * @param {HTMLElement} element
-     */
-    _renderInsightsToggle(element: HTMLElement): void;
     /**
      * @param {LH.ReportResult.Category} category
      * @param {Object<string, LH.Result.ReportGroup>} groups
@@ -79,6 +54,5 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
     renderMetricAuditFilter(filterableMetrics: LH.ReportResult.AuditRef[], categoryEl: HTMLDivElement, onFilterChange: (acronym: string) => void): void;
 }
 export type DOM = import("./dom.js").DOM;
-export type InsightsExperimentState = ("DEFAULT" | "AUDITS" | "INSIGHTS");
 import { CategoryRenderer } from './category-renderer.js';
 //# sourceMappingURL=performance-category-renderer.d.ts.map

package/report/renderer/performance-category-renderer.js

@@ -12,16 +12,7 @@ import {Globals} from './report-globals.js';
 import {Util} from '../../shared/util.js';
 import {createGauge, updateGauge} from './explodey-gauge.js';
 
-const LOCAL_STORAGE_INSIGHTS_KEY = '__lh__insights_audits_toggle_state_2';
-
-/**
- * @typedef {('DEFAULT'|'AUDITS'|'INSIGHTS')} InsightsExperimentState
- */
-
 export class PerformanceCategoryRenderer extends CategoryRenderer {
-  /** @type InsightsExperimentState*/
-  _memoryInsightToggleState = 'DEFAULT';
-
   /**
    * @param {LH.ReportResult.AuditRef} audit
    * @return {!Element}
@@ -143,84 +134,6 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
     return {overallImpact, overallLinearImpact};
   }
 
-  /**
-   * @param {InsightsExperimentState} newState
-  **/
-  _persistInsightToggleToStorage(newState) {
-    try {
-      window.localStorage.setItem(LOCAL_STORAGE_INSIGHTS_KEY, newState);
-    } finally {
-      this._memoryInsightToggleState = newState;
-    }
-  }
-
-  /**
-   * @returns {InsightsExperimentState}
-  **/
-  _getInsightToggleState() {
-    let state = this._getRawInsightToggleState();
-    if (state === 'DEFAULT') state = 'INSIGHTS';
-    return state;
-  }
-
-  /**
-   * @returns {InsightsExperimentState}
-  **/
-  _getRawInsightToggleState() {
-    try {
-      const fromStorage = window.localStorage.getItem(LOCAL_STORAGE_INSIGHTS_KEY);
-      if (fromStorage === 'AUDITS' || fromStorage === 'INSIGHTS') {
-        return fromStorage;
-      }
-    } catch {
-      return this._memoryInsightToggleState;
-    }
-    return 'DEFAULT';
-  }
-
-  /**
-   * @param {HTMLButtonElement} button
-  **/
-  _setInsightToggleButtonText(button) {
-    const state = this._getInsightToggleState();
-    button.innerText =
-      state === 'AUDITS' ? Globals.strings.tryInsights : Globals.strings.goBackToAudits;
-  }
-
-  /**
-   * @param {HTMLElement} element
-   */
-  _renderInsightsToggle(element) {
-    // Insights / Audits toggle.
-    const container = this.dom.createChildOf(element, 'div', 'lh-perf-insights-toggle');
-    const textSpan = this.dom.createChildOf(container, 'span', 'lh-perf-toggle-text');
-    const icon = this.dom.createElement('span', 'lh-perf-insights-icon insights-icon-url');
-    textSpan.appendChild(icon);
-    textSpan.appendChild(this.dom.convertMarkdownLinkSnippets(Globals.strings.insightsNotice));
-
-    const buttonClasses = 'lh-button lh-button-insight-toggle';
-    const button = this.dom.createChildOf(container, 'button', buttonClasses);
-    this._setInsightToggleButtonText(button);
-
-    button.addEventListener('click', event => {
-      event.preventDefault();
-      const swappableSection = this.dom.maybeFind('.lh-perf-audits--swappable');
-      if (swappableSection) {
-        this.dom.swapSectionIfPossible(swappableSection);
-      }
-      const currentState = this._getInsightToggleState();
-      const newState = currentState === 'AUDITS' ? 'INSIGHTS' : 'AUDITS';
-      this.dom.fireEventOn('lh-analytics', this.dom.document(), {
-        name: 'toggle_insights',
-        data: {newState},
-      });
-      this._persistInsightToggleToStorage(newState);
-      this._setInsightToggleButtonText(button);
-    });
-
-    container.appendChild(button);
-  }
-
   /**
    * @param {LH.ReportResult.Category} category
    * @param {Object<string, LH.Result.ReportGroup>} groups
@@ -288,44 +201,12 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
       filmstripEl && timelineEl.append(filmstripEl);
     }
 
-    this._renderInsightsToggle(element);
-
-    const legacyAuditsSection =
-      this.renderFilterableSection(category, groups, ['diagnostics'], metricAudits);
-    legacyAuditsSection?.classList.add('lh-perf-audits--swappable', 'lh-perf-audits--legacy');
-
-    const experimentalInsightsSection =
+    const auditsSection =
       this.renderFilterableSection(category, groups, ['insights', 'diagnostics'], metricAudits);
-    experimentalInsightsSection?.classList.add(
-      'lh-perf-audits--swappable', 'lh-perf-audits--experimental');
-
-    if (legacyAuditsSection) {
-      element.append(legacyAuditsSection);
-
-      // Many tests expect just one of these sections to be in the DOM at a given time.
-      // To prevent the hidden section from tripping up these tests, we will just remove the hidden
-      // section from the DOM and store it in memory.
-      if (experimentalInsightsSection) {
-        this.dom.registerSwappableSections(legacyAuditsSection, experimentalInsightsSection);
-      }
+    if (auditsSection) {
+      auditsSection.classList.add('lh-perf-audits');
+      element.append(auditsSection);
     }
-    // Deal with the user loading the report and having toggled to Insights
-    // which is now stored in local storage. Put in a rAF otherwise this code
-    // runs before the DOM is created.
-    if (this._getInsightToggleState() === 'INSIGHTS') {
-      requestAnimationFrame(() => {
-        const swappableSection = this.dom.maybeFind('.lh-perf-audits--swappable');
-        if (swappableSection) {
-          this.dom.swapSectionIfPossible(swappableSection);
-        }
-      });
-    }
-
-    // Log the initial state.
-    this.dom.fireEventOn('lh-analytics', this.dom.document(), {
-      name: 'initial_insights_state',
-      data: {state: this._getRawInsightToggleState()},
-    });
 
     const isNavigationMode = !options || options?.gatherMode === 'navigation';
     if (isNavigationMode && category.score !== null) {
@@ -349,31 +230,18 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
 
     const element = this.dom.createElement('div');
 
-    /** @type {Set<string>} */
-    const replacedAuditIds = new Set();
-
     /**
-     * This exists to temporarily allow showing insights - which are in the hidden
-     * group by default - when using the insights toggle.
-     * See https://github.com/GoogleChrome/lighthouse/pull/16418 for motivation.
-     *
      * @param {LH.ReportResult.AuditRef} auditRef
      */
     const getGroup = (auditRef) => {
-      return auditRef.id.endsWith('-insight') ? 'insights' : auditRef.group ?? '';
+      return auditRef.group ?? '';
     };
 
     const allGroupAudits =
       category.auditRefs.filter(audit => groupNames.includes(getGroup(audit)));
-    for (const auditRef of allGroupAudits) {
-      auditRef.result.replacesAudits?.forEach(replacedAuditId => {
-        replacedAuditIds.add(replacedAuditId);
-      });
-    }
 
     // Diagnostics
     const allFilterableAudits = allGroupAudits
-      .filter(audit => !replacedAuditIds.has(audit.id))
       .map(auditRef => {
         const {overallImpact, overallLinearImpact} = this.overallImpact(auditRef, metricAudits);
         const guidanceLevel = auditRef.result.guidanceLevel || 1;
@@ -382,7 +250,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
         return {auditRef, auditEl, overallImpact, overallLinearImpact, guidanceLevel};
       });
 
-    const filterableAudits = allFilterableAudits
+    const notPassedAudits = allFilterableAudits
       .filter(audit => !ReportUtils.showAsPassed(audit.auditRef.result));
 
     const passedAudits = allFilterableAudits
@@ -409,7 +277,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
         }
       }
 
-      filterableAudits.sort((a, b) => {
+      notPassedAudits.sort((a, b) => {
         // Performance diagnostics should only have score display modes of "informative" and "metricSavings"
         // If the score display mode is "metricSavings", the `score` will be a coarse approximation of the overall impact.
         // Therefore, it makes sense to sort audits by score first to ensure visual clarity with the score icons.
@@ -441,7 +309,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
         return b.guidanceLevel - a.guidanceLevel;
       });
 
-      for (const audit of filterableAudits) {
+      for (const audit of notPassedAudits) {
         if (!audit.auditRef.group) continue;
 
         const groupEls = groupElsMap[getGroup(audit.auditRef)];
@@ -454,7 +322,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
 
     /** @type {Set<string>} */
     const filterableMetricAcronyms = new Set();
-    for (const audit of filterableAudits) {
+    for (const audit of notPassedAudits) {
       const metricSavings = audit.auditRef.result.metricSavings || {};
       for (const [key, value] of Object.entries(metricSavings)) {
         if (typeof value === 'number') filterableMetricAcronyms.add(key);
@@ -472,7 +340,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
     refreshFilteredAudits('All');
 
     for (const groupName of groupNames) {
-      if (filterableAudits.some(audit => getGroup(audit.auditRef) === groupName)) {
+      if (notPassedAudits.some(audit => getGroup(audit.auditRef) === groupName)) {
         const groupEls = groupElsMap[groupName];
         if (!groupEls) continue;
         element.append(groupEls[0]);

package/report/renderer/report-ui-features.d.ts

@@ -10,7 +10,6 @@ export class ReportUIFeatures {
     _dom: DOM;
     _opts: import("../types/report-renderer.js").default.Options;
     _topbar: TopbarFeatures | null;
-    _tablesHandledFor3p: WeakSet<object>;
     /**
      * Handle media query change events.
      * @param {MediaQueryList|MediaQueryListEvent} mql

package/report/renderer/report-ui-features.js

@@ -40,7 +40,6 @@ export class ReportUIFeatures {
     this._opts = opts;
 
     this._topbar = opts.omitTopbar ? null : new TopbarFeatures(this, dom);
-    this._tablesHandledFor3p = new WeakSet();
     this.onMediaQueryChange = this.onMediaQueryChange.bind(this);
   }
 
@@ -61,9 +60,6 @@ export class ReportUIFeatures {
     this._setupThirdPartyFilter();
     this._setupElementScreenshotOverlay(this._dom.rootEl);
 
-    // TODO(v13): remove.
-    this._dom._onSwap = () => this._setupThirdPartyFilter();
-
     // Do not query the system preferences for DevTools - DevTools should only apply dark theme
     // if dark is selected in the settings panel.
     // TODO: set `disableDarkMode` in devtools and delete this special case.
@@ -215,6 +211,8 @@ export class ReportUIFeatures {
   }
 
   _setupThirdPartyFilter() {
+    // Note: do not remove deleted audits from the below arrays.
+
     // Some audits should not display the third party filter option.
     const thirdPartyFilterAuditExclusions = [
       // These audits deal explicitly with third party resources.
@@ -242,15 +240,6 @@ export class ReportUIFeatures {
       });
 
     tablesWithUrls.forEach((tableEl) => {
-      // The "toggle insights/audits" button means that not all tables are on the DOM on init.
-      // So we call this whole setup function multiple times for now, once every time we toggle.
-      // TODO(v13): remove.
-      if (this._tablesHandledFor3p.has(tableEl)) {
-        return;
-      }
-
-      this._tablesHandledFor3p.add(tableEl);
-
       const rowEls = getTableRows(tableEl);
       const nonSubItemRows = rowEls.filter(rowEl => !rowEl.classList.contains('lh-sub-item-row'));
       const thirdPartyRowEls = this._getThirdPartyRows(nonSubItemRows,

package/report/renderer/report-utils.d.ts

@@ -136,8 +136,7 @@ export namespace UIStrings {
     let firstPartyChipLabel: string;
     let openInANewTabTooltip: string;
     let unattributable: string;
-    let insightsNotice: string;
-    let tryInsights: string;
-    let goBackToAudits: string;
+    let unscoredLabel: string;
+    let unscoredTitle: string;
 }
 //# sourceMappingURL=report-utils.d.ts.map

package/report/renderer/report-utils.js

@@ -483,12 +483,10 @@ const UIStrings = {
   /** Generic category name for all resources that could not be attributed to a 1st or 3rd party entity. */
   unattributable: 'Unattributable',
 
-  /** Notice about upcoming planned changes to Lighthouse, to replace most performance audits with a new set of "insight" audits. */
-  insightsNotice: 'Later this year, insights will replace performance audits. [Learn more and provide feedback here](https://github.com/GoogleChrome/lighthouse/discussions/16462).',
-  /** Text for a button to try out "Performance insight audits", a new set of performance advice that will replace performance audits. */
-  tryInsights: 'Try insights',
-  /** Text for a button for going back to normal "Performance audits", instead of using the new set of performance insight audits that will replace performance audits. */
-  goBackToAudits: 'Go back to audits',
+  /** Descriptive explanation used when an audit is not part of the calculated score. */
+  unscoredLabel: 'Unscored',
+  /** Descriptive explanation used when an audit is not part of the calculated score. */
+  unscoredTitle: 'This audit does not contribute to the overall category score.',
 };
 
 export {

package/report/types/report-renderer.d.ts

@@ -5,7 +5,6 @@
  */
 
 import { Result as AuditResult } from "../../types/lhr/audit-result";
-import { ReportUIFeatures } from "../renderer/report-ui-features.js";
 
 declare module Renderer {
   function renderReport(lhr: AuditResult, options?: Options): HTMLElement;
@@ -47,11 +46,6 @@ declare module Renderer {
      * data, which can be gotten from the artifacts.
      */
     onViewTrace?: () => void;
-    /**
-     * Called when the performance audits/insights are swapped out.
-     * TODO(v13): remove
-     */
-    _onSwapHook?: () => void;
   }
 }