chrome-devtools-frontend 1.0.1553956 → 1.0.1555174

package/front_end/panels/timeline/components/SidebarInsightsTab.ts

@@ -1,11 +1,9 @@
 // Copyright 2024 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-/* eslint-disable @devtools/no-lit-render-outside-of-view */
 
 import * as Trace from '../../../models/trace/trace.js';
 import * as Buttons from '../../../ui/components/buttons/buttons.js';
-import * as ComponentHelpers from '../../../ui/components/helpers/helpers.js';
 import * as UI from '../../../ui/legacy/legacy.js';
 import * as Lit from '../../../ui/lit/lit.js';
 import * as Utils from '../utils/utils.js';
@@ -16,9 +14,136 @@ import sidebarInsightsTabStyles from './sidebarInsightsTab.css.js';
 import {SidebarSingleInsightSet, type SidebarSingleInsightSetData} from './SidebarSingleInsightSet.js';
 
 const {html} = Lit;
+const {widgetConfig} = UI.Widget;
+
+interface ViewInput {
+  parsedTrace: Trace.TraceModel.ParsedTrace;
+  labels: string[];
+  activeInsightSet: Trace.Insights.Types.InsightSet|null;
+  activeInsight: ActiveInsight|null;
+  selectedCategory: Trace.Insights.Types.InsightCategory;
+  onInsightSetToggled: (insightSet: Trace.Insights.Types.InsightSet) => void;
+  onInsightSetHovered: (insightSet: Trace.Insights.Types.InsightSet) => void;
+  onInsightSetUnhovered: () => void;
+  onZoomClick: (insightSet: Trace.Insights.Types.InsightSet) => void;
+}
+
+type View = (input: ViewInput, output: undefined, target: HTMLElement) => void;
+
+export const DEFAULT_VIEW: View = (input, output, target) => {
+  const {
+    parsedTrace,
+    labels,
+    activeInsightSet,
+    activeInsight,
+    selectedCategory,
+    onInsightSetToggled,
+    onInsightSetHovered,
+    onInsightSetUnhovered,
+    onZoomClick,
+  } = input;
+
+  const insights = parsedTrace.insights;
+  if (!insights) {
+    return;
+  }
 
-export class SidebarInsightsTab extends HTMLElement {
-  readonly #shadow = this.attachShadow({mode: 'open'});
+  const hasMultipleInsightSets = insights.size > 1;
+
+  // clang-format off
+  Lit.render(html`
+    <style>${sidebarInsightsTabStyles}</style>
+    <div class="insight-sets-wrapper">
+      ${[...insights.values()].map((insightSet, index) => {
+        const {id, url} = insightSet;
+        const data: SidebarSingleInsightSetData = {
+          insightSetKey: id,
+          activeCategory: selectedCategory,
+          activeInsight,
+          parsedTrace,
+        };
+        const selected = insightSet === activeInsightSet;
+
+        const contents = html`
+          <devtools-widget
+            data-insight-set-key=${id}
+            .widgetConfig=${widgetConfig(SidebarSingleInsightSet, {data})}
+          ></devtools-widget>
+        `;
+
+        if (hasMultipleInsightSets) {
+          return html`<details ?open=${selected}>
+            <summary
+              @click=${() => onInsightSetToggled(insightSet)}
+              @mouseenter=${() => onInsightSetHovered(insightSet)}
+              @mouseleave=${() => onInsightSetUnhovered()}
+              title=${url.href}>
+              ${renderDropdownIcon(selected)}
+              <span>${labels[index]}</span>
+              <span class='zoom-button'
+                @click=${(event: Event) => {
+                  event.stopPropagation();
+                  onZoomClick(insightSet);
+                }}
+              >
+                ${renderZoomButton(selected)}
+              </span>
+            </summary>
+            ${contents}
+          </details>`;
+        }
+
+        return contents;
+      })}
+    </div>
+  `, target);
+  // clang-format on
+};
+
+function renderZoomButton(insightSetToggled: boolean): Lit.TemplateResult {
+  const classes = Lit.Directives.classMap({
+    'zoom-icon': true,
+    active: insightSetToggled,
+  });
+
+  // clang-format off
+  return html`
+  <div class=${classes}>
+      <devtools-button .data=${{
+        variant: Buttons.Button.Variant.ICON,
+        iconName: 'center-focus-weak',
+        size: Buttons.Button.Size.SMALL,
+      } as Buttons.Button.ButtonData}
+    ></devtools-button></div>`;
+  // clang-format on
+}
+
+function renderDropdownIcon(insightSetToggled: boolean): Lit.TemplateResult {
+  const containerClasses = Lit.Directives.classMap({
+    'dropdown-icon': true,
+    active: insightSetToggled,
+  });
+
+  // clang-format off
+  return html`
+    <div class=${containerClasses}>
+      <devtools-button .data=${{
+        variant: Buttons.Button.Variant.ICON,
+        iconName: 'chevron-right',
+        size: Buttons.Button.Size.SMALL,
+      } as Buttons.Button.ButtonData}
+    ></devtools-button></div>
+  `;
+  // clang-format on
+}
+
+export class SidebarInsightsTab extends UI.Widget.Widget {
+  static createWidgetElement(): UI.Widget.WidgetElement<SidebarInsightsTab> {
+    const widgetElement = document.createElement('devtools-widget') as UI.Widget.WidgetElement<SidebarInsightsTab>;
+    return widgetElement;
+  }
+
+  #view: View;
   #parsedTrace: Trace.TraceModel.ParsedTrace|null = null;
   #activeInsight: ActiveInsight|null = null;
   #selectedCategory = Trace.Insights.Types.InsightCategory.ALL;
@@ -26,9 +151,14 @@ export class SidebarInsightsTab extends HTMLElement {
    * When a trace has sets of insights, we show an accordion with each
    * set within. A set can be specific to a single navigation, or include the
    * beginning of the trace up to the first navigation.
-   * You can only have one of these open at any time, and we track it via this ID.
+   * You can only have one of these open at any time.
    */
-  #selectedInsightSetKey: string|null = null;
+  #selectedInsightSet: Trace.Insights.Types.InsightSet|null = null;
+
+  constructor(element?: HTMLElement, view: View = DEFAULT_VIEW) {
+    super(element, {useShadowDom: true});
+    this.#view = view;
+  }
 
   // TODO(paulirish): add back a disconnectedCallback() to avoid memory leaks that doesn't cause b/372943062
 
@@ -38,14 +168,14 @@ export class SidebarInsightsTab extends HTMLElement {
     }
 
     this.#parsedTrace = data;
-    this.#selectedInsightSetKey = null;
+    this.#selectedInsightSet = null;
 
     if (this.#parsedTrace?.insights) {
       /** Select the first set. Filtering out trivial sets was done back in {@link Trace.Processor.#computeInsightsForInitialTracePeriod} */
-      this.#selectedInsightSetKey = [...this.#parsedTrace.insights.keys()].at(0) ?? null;
+      this.#selectedInsightSet = [...this.#parsedTrace.insights.values()].at(0) ?? null;
     }
 
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#render);
+    this.requestUpdate();
   }
 
   get activeInsight(): ActiveInsight|null {
@@ -56,81 +186,39 @@ export class SidebarInsightsTab extends HTMLElement {
     if (active === this.#activeInsight) {
       return;
     }
+
     this.#activeInsight = active;
 
-    // Only update the insightSetKey if there is an active insight. Otherwise, closing an insight
+    // Only update selectedInsightSet if there is an active insight. Otherwise, closing an insight
     // would also collapse the insight set. Usually the proper insight set is already set because
     // the user has it open already in order for this setter to be called, but insights can also
     // be activated by clicking on a insight chip in the Summary panel, which may require opening
     // a different insight set.
     if (this.#activeInsight) {
-      this.#selectedInsightSetKey = this.#activeInsight.insightSetKey;
+      this.#selectedInsightSet = this.#parsedTrace?.insights?.get(this.#activeInsight.insightSetKey) ?? null;
     }
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#render);
+    this.requestUpdate();
   }
 
-  #insightSetToggled(id: string): void {
-    this.#selectedInsightSetKey = this.#selectedInsightSetKey === id ? null : id;
+  #onInsightSetToggled(insightSet: Trace.Insights.Types.InsightSet): void {
+    this.#selectedInsightSet = this.#selectedInsightSet === insightSet ? null : insightSet;
     // Update the active insight set.
-    if (this.#selectedInsightSetKey !== this.#activeInsight?.insightSetKey) {
-      this.dispatchEvent(new Insights.SidebarInsight.InsightDeactivated());
+    if (this.#selectedInsightSet?.id !== this.#activeInsight?.insightSetKey) {
+      this.element.dispatchEvent(new Insights.SidebarInsight.InsightDeactivated());
     }
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#render);
-  }
-
-  #insightSetHovered(id: string): void {
-    const data = this.#parsedTrace?.insights?.get(id);
-    data && this.dispatchEvent(new Insights.SidebarInsight.InsightSetHovered(data.bounds));
+    this.requestUpdate();
   }
 
-  #insightSetUnhovered(): void {
-    this.dispatchEvent(new Insights.SidebarInsight.InsightSetHovered());
+  #onInsightSetHovered(insightSet: Trace.Insights.Types.InsightSet): void {
+    this.element.dispatchEvent(new Insights.SidebarInsight.InsightSetHovered(insightSet.bounds));
   }
 
-  #onZoomClick(event: Event, id: string): void {
-    event.stopPropagation();
-    const data = this.#parsedTrace?.insights?.get(id);
-    if (!data) {
-      return;
-    }
-    this.dispatchEvent(new Insights.SidebarInsight.InsightSetZoom(data.bounds));
+  #onInsightSetUnhovered(): void {
+    this.element.dispatchEvent(new Insights.SidebarInsight.InsightSetHovered());
   }
 
-  #renderZoomButton(insightSetToggled: boolean): Lit.TemplateResult {
-    const classes = Lit.Directives.classMap({
-      'zoom-icon': true,
-      active: insightSetToggled,
-    });
-
-    // clang-format off
-    return html`
-    <div class=${classes}>
-        <devtools-button .data=${{
-          variant: Buttons.Button.Variant.ICON,
-          iconName: 'center-focus-weak',
-          size: Buttons.Button.Size.SMALL,
-        } as Buttons.Button.ButtonData}
-      ></devtools-button></div>`;
-    // clang-format on
-  }
-
-  #renderDropdownIcon(insightSetToggled: boolean): Lit.TemplateResult {
-    const containerClasses = Lit.Directives.classMap({
-      'dropdown-icon': true,
-      active: insightSetToggled,
-    });
-
-    // clang-format off
-    return html`
-      <div class=${containerClasses}>
-        <devtools-button .data=${{
-          variant: Buttons.Button.Variant.ICON,
-          iconName: 'chevron-right',
-          size: Buttons.Button.Size.SMALL,
-        } as Buttons.Button.ButtonData}
-      ></devtools-button></div>
-    `;
-    // clang-format on
+  #onZoomClick(insightSet: Trace.Insights.Types.InsightSet): void {
+    this.element.dispatchEvent(new Insights.SidebarInsight.InsightSetZoom(insightSet.bounds));
   }
 
   highlightActiveInsight(): void {
@@ -139,76 +227,28 @@ export class SidebarInsightsTab extends HTMLElement {
     }
 
     // Find the right set for this insight via the set key.
-    const set = this.#shadow?.querySelector<UI.Widget.WidgetElement<SidebarSingleInsightSet>>(
+    const set = this.element.shadowRoot?.querySelector<UI.Widget.WidgetElement<SidebarSingleInsightSet>>(
         `[data-insight-set-key="${this.#activeInsight.insightSetKey}"]`);
     set?.getWidget()?.highlightActiveInsight();
   }
 
-  #render(): void {
+  override performUpdate(): void {
     if (!this.#parsedTrace?.insights) {
-      Lit.render(Lit.nothing, this.#shadow, {host: this});
       return;
     }
 
-    const insights = this.#parsedTrace.insights;
-    const hasMultipleInsightSets = insights.size > 1;
-    const labels = Utils.Helpers.createUrlLabels([...insights.values()].map(({url}) => url));
-
-    const contents =
-        // clang-format off
-     html`
-      <style>${sidebarInsightsTabStyles}</style>
-      <div class="insight-sets-wrapper">
-        ${[...insights.values()].map(({id, url}, index) => {
-          const data: SidebarSingleInsightSetData = {
-            insightSetKey: id,
-            activeCategory: this.#selectedCategory,
-            activeInsight: this.#activeInsight,
-            parsedTrace: this.#parsedTrace,
-          };
-
-          const contents = html`
-            <devtools-widget
-              data-insight-set-key=${id}
-              .widgetConfig=${UI.Widget.widgetConfig(SidebarSingleInsightSet, {data})}
-            ></devtools-widget>
-          `;
-
-          if (hasMultipleInsightSets) {
-            return html`<details
-              ?open=${id === this.#selectedInsightSetKey}
-            >
-              <summary
-                @click=${() => this.#insightSetToggled(id)}
-                @mouseenter=${() => this.#insightSetHovered(id)}
-                @mouseleave=${() => this.#insightSetUnhovered()}
-                title=${url.href}>
-                ${this.#renderDropdownIcon(id === this.#selectedInsightSetKey)}
-                <span>${labels[index]}</span>
-                <span class='zoom-button' @click=${(event: Event) => this.#onZoomClick(event, id)}>${this.#renderZoomButton(id === this.#selectedInsightSetKey)}</span>
-              </summary>
-              ${contents}
-            </details>`;
-          }
-
-          return contents;
-        })}
-      </div>
-    `;
-    // clang-format on
-
-    // Insight components contain state, so to prevent insights from previous trace loads breaking things we use the parsedTrace
-    // as a render key.
-    // Note: newer Lit has `keyed`, but we don't have that, so we do it manually. https://lit.dev/docs/templates/directives/#keyed
-    const result = Lit.Directives.repeat([contents], () => this.#parsedTrace, template => template);
-    Lit.render(result, this.#shadow, {host: this});
-  }
-}
-
-customElements.define('devtools-performance-sidebar-insights', SidebarInsightsTab);
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'devtools-performance-sidebar-insights': SidebarInsightsTab;
+    const insightSets = [...this.#parsedTrace.insights.values()];
+    const input: ViewInput = {
+      parsedTrace: this.#parsedTrace,
+      labels: Utils.Helpers.createUrlLabels(insightSets.map(({url}) => url)),
+      activeInsightSet: this.#selectedInsightSet,
+      activeInsight: this.#activeInsight,
+      selectedCategory: this.#selectedCategory,
+      onInsightSetToggled: this.#onInsightSetToggled.bind(this),
+      onInsightSetHovered: this.#onInsightSetHovered.bind(this),
+      onInsightSetUnhovered: this.#onInsightSetUnhovered.bind(this),
+      onZoomClick: this.#onZoomClick.bind(this),
+    };
+    this.#view(input, undefined, this.contentElement);
   }
 }

package/front_end/panels/timeline/components/insights/Checklist.ts

@@ -1,7 +1,6 @@
 // Copyright 2024 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-/* eslint-disable @devtools/no-lit-render-outside-of-view */
 
 /**
  * @file A list of pass/fail conditions for an insight.
@@ -11,11 +10,13 @@ import '../../../../ui/kit/kit.js';
 
 import * as i18n from '../../../../core/i18n/i18n.js';
 import type * as Trace from '../../../../models/trace/trace.js';
-import * as ComponentHelpers from '../../../../ui/components/helpers/helpers.js';
+import * as UI from '../../../../ui/legacy/legacy.js';
 import * as Lit from '../../../../ui/lit/lit.js';
 
 import checklistStyles from './checklist.css.js';
 
+const {html} = Lit;
+
 const UIStrings = {
   /**
    * @description Text for a screen-reader label to tell the user that the icon represents a successful insight check
@@ -32,7 +33,43 @@ const UIStrings = {
 const str_ = i18n.i18n.registerUIStrings('panels/timeline/components/insights/Checklist.ts', UIStrings);
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 
-const {html} = Lit;
+interface ViewInput {
+  checklist: GenericChecklist;
+}
+
+type View = (input: ViewInput, output: undefined, target: HTMLElement) => void;
+
+export const DEFAULT_VIEW: View = (input, output, target) => {
+  const {
+    checklist,
+  } = input;
+
+  function getIcon(check: GenericChecklist['']): Lit.TemplateResult {
+    const icon = check.value ? 'check-circle' : 'clear';
+
+    const ariaLabel = check.value ? i18nString(UIStrings.successAriaLabel, {PH1: check.label}) :
+                                    i18nString(UIStrings.failedAriaLabel, {PH1: check.label});
+    return html`
+        <devtools-icon
+          aria-label=${ariaLabel}
+          name=${icon}
+          class=${check.value ? 'check-passed' : 'check-failed'}
+        ></devtools-icon>
+      `;
+  }
+
+  // clang-format off
+  Lit.render(html`
+    <style>${checklistStyles}</style>
+    <ul>
+      ${Object.values(checklist).map(check => html`<li>
+          ${getIcon(check)}
+          <span data-checklist-label>${check.label}</span>
+      </li>`)}
+    </ul>
+  `, target);
+  // clang-format on
+};
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type GenericChecklist = Trace.Insights.Types.Checklist<any>;
@@ -46,55 +83,28 @@ export interface TableDataRow {
   overlays?: Trace.Types.Overlays.Overlay[];
 }
 
-export class Checklist extends HTMLElement {
-  readonly #shadow = this.attachShadow({mode: 'open'});
+export class Checklist extends UI.Widget.Widget {
+  #view: View;
   #checklist?: GenericChecklist;
 
-  set checklist(checklist: GenericChecklist) {
-    this.#checklist = checklist;
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#render);
-  }
-
-  connectedCallback(): void {
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#render);
+  constructor(element?: HTMLElement, view: View = DEFAULT_VIEW) {
+    super(element, {useShadowDom: true});
+    this.#view = view;
   }
 
-  #getIcon(check: GenericChecklist['']): Lit.TemplateResult {
-    const icon = check.value ? 'check-circle' : 'clear';
-
-    const ariaLabel = check.value ? i18nString(UIStrings.successAriaLabel, {PH1: check.label}) :
-                                    i18nString(UIStrings.failedAriaLabel, {PH1: check.label});
-    return html`
-        <devtools-icon
-          aria-label=${ariaLabel}
-          name=${icon}
-          class=${check.value ? 'check-passed' : 'check-failed'}
-        ></devtools-icon>
-      `;
+  set checklist(checklist: GenericChecklist) {
+    this.#checklist = checklist;
+    this.requestUpdate();
   }
 
-  async #render(): Promise<void> {
+  override performUpdate(): void {
     if (!this.#checklist) {
       return;
     }
 
-    Lit.render(
-        html`
-          <style>${checklistStyles}</style>
-          <ul>
-            ${Object.values(this.#checklist).map(check => html`<li>
-                ${this.#getIcon(check)}
-                <span data-checklist-label>${check.label}</span>
-            </li>`)}
-          </ul>`,
-        this.#shadow, {host: this});
+    const input: ViewInput = {
+      checklist: this.#checklist,
+    };
+    this.#view(input, undefined, this.contentElement);
   }
 }
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'devtools-performance-checklist': Checklist;
-  }
-}
-
-customElements.define('devtools-performance-checklist', Checklist);

package/front_end/panels/timeline/components/insights/DocumentLatency.ts

@@ -2,15 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import './Checklist.js';
-
 import type {DocumentLatencyInsightModel} from '../../../../models/trace/insights/DocumentLatency.js';
 import type * as Trace from '../../../../models/trace/trace.js';
+import * as UI from '../../../../ui/legacy/legacy.js';
 import * as Lit from '../../../../ui/lit/lit.js';
 
 import {BaseInsightComponent} from './BaseInsightComponent.js';
+import {Checklist} from './Checklist.js';
 
 const {html} = Lit;
+const {widgetConfig} = UI.Widget;
 
 export class DocumentLatency extends BaseInsightComponent<DocumentLatencyInsightModel> {
   override internalName = 'document-latency';
@@ -29,7 +30,9 @@ export class DocumentLatency extends BaseInsightComponent<DocumentLatencyInsight
     }
 
     // clang-format off
-    return html`<devtools-performance-checklist .checklist=${this.model.data.checklist}></devtools-performance-checklist>`;
+    return html`<devtools-widget .widgetConfig=${widgetConfig(Checklist, {
+      checklist: this.model.data.checklist,
+    })}></devtools-widget>`;
     // clang-format on
   }
 }

package/front_end/panels/timeline/components/insights/LCPDiscovery.ts

@@ -2,17 +2,19 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import './Checklist.js';
-
 import * as i18n from '../../../../core/i18n/i18n.js';
 import type {LCPDiscoveryInsightModel} from '../../../../models/trace/insights/LCPDiscovery.js';
 import * as Trace from '../../../../models/trace/trace.js';
 import * as uiI18n from '../../../../ui/i18n/i18n.js';
+import * as UI from '../../../../ui/legacy/legacy.js';
 import * as Lit from '../../../../ui/lit/lit.js';
 
 import {BaseInsightComponent} from './BaseInsightComponent.js';
+import {Checklist} from './Checklist.js';
 import {imageRef} from './ImageRef.js';
 
+const {widgetConfig} = UI.Widget;
+
 const {UIStrings, i18nString, getImageData} = Trace.Insights.Models.LCPDiscovery;
 
 const {html} = Lit;
@@ -89,7 +91,9 @@ export class LCPDiscovery extends BaseInsightComponent<LCPDiscoveryInsightModel>
     // clang-format off
     return html`
       <div class="insight-section">
-        <devtools-performance-checklist class="insight-section" .checklist=${imageData.checklist}></devtools-performance-checklist>
+        <devtools-widget .widgetConfig=${widgetConfig(Checklist, {
+          checklist: imageData.checklist,
+        })}></devtools-widget>
         <div class="insight-section">${imageRef(imageData.request)}${delayEl}</div>
       </div>`;
     // clang-format on