chrome-devtools-frontend 1.0.1376716 → 1.0.1386602

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

@@ -2,219 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import '../../../../ui/components/markdown_view/markdown_view.js';
-
-import * as Platform from '../../../../core/platform/platform.js';
-import type * as Trace from '../../../../models/trace/trace.js';
-import * as Marked from '../../../../third_party/marked/marked.js';
-import * as ComponentHelpers from '../../../../ui/components/helpers/helpers.js';
-import * as LitHtml from '../../../../ui/lit-html/lit-html.js';
-import * as VisualLogging from '../../../../ui/visual_logging/visual_logging.js';
-import type * as Overlays from '../../overlays/overlays.js';
-
-import sidebarInsightStyles from './sidebarInsight.css.js';
-import * as SidebarInsight from './SidebarInsight.js';
-import type {TableState} from './Table.js';
-import {type ActiveInsight, Category} from './types.js';
-
-const {html} = LitHtml;
+import * as Trace from '../../../../models/trace/trace.js';
 
 export function shouldRenderForCategory(options: {
-  activeCategory: Category,
-  insightCategory: Category,
-}): boolean {
-  return options.activeCategory === Category.ALL || options.activeCategory === options.insightCategory;
-}
-
-export function insightIsActive(options: {
-  activeInsight: ActiveInsight|null,
-  insightName: string,
-  insightSetKey: string|null,
+  activeCategory: Trace.Insights.Types.InsightCategory,
+  insightCategory: Trace.Insights.Types.InsightCategory,
 }): boolean {
-  const active = options.activeInsight && options.activeInsight.name === options.insightName &&
-      options.activeInsight.insightSetKey === options.insightSetKey;
-  return Boolean(active);
-}
-
-export interface BaseInsightData {
-  insights: Trace.Insights.Types.TraceInsightSets|null;
-  parsedTrace: Trace.Handlers.Types.ParsedTrace|null;
-  /** The key into `insights` that contains this particular insight. */
-  insightSetKey: string|null;
-  activeInsight: ActiveInsight|null;
-  activeCategory: Category;
-}
-
-// TODO(crbug.com/371615739): BaseInsight, SidebarInsight should be combined.
-// This is an abstract base class so the component naming rules do not apply.
-export abstract class BaseInsight extends HTMLElement {
-  abstract internalName: string;
-  abstract insightCategory: Category;
-  abstract userVisibleTitle: string;
-  abstract description: string;
-  // So we can use the TypeScript BaseInsight class without getting warnings
-  // about litTagName. Every child should overrwrite this.
-  static readonly litTagName = LitHtml.literal``;
-
-  protected readonly shadow = this.attachShadow({mode: 'open'});
-
-  protected data: BaseInsightData = {
-    insights: null,
-    parsedTrace: null,
-    insightSetKey: null,
-    activeInsight: null,
-    activeCategory: Category.ALL,
-  };
-
-  // eslint-disable-next-line rulesdir/no_bound_component_methods
-  readonly #boundRender = this.#baseRender.bind(this);
-  readonly sharedTableState: TableState = {
-    selectedRowEl: null,
-    selectionIsSticky: false,
-  };
-  #initialOverlays: Overlays.Overlays.TimelineOverlay[]|null = null;
-  #hasRegisteredRelatedEvents = false;
-
-  protected scheduleRender(): void {
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#boundRender);
-  }
-
-  connectedCallback(): void {
-    this.shadow.adoptedStyleSheets.push(sidebarInsightStyles);
-    this.setAttribute('jslog', `${VisualLogging.section(`timeline.insights.${this.internalName}`)}`);
-    // Used for unit test purposes when querying the DOM.
-    this.dataset.insightName = this.internalName;
-
-    // TODO(crbug.com/371615739): this should be moved to model/trace/insights
-    if (!this.#hasRegisteredRelatedEvents) {
-      this.#hasRegisteredRelatedEvents = true;
-
-      const events = this.getRelatedEvents();
-      if (events.length) {
-        this.dispatchEvent(new SidebarInsight.InsightProvideRelatedEvents(
-            this.userVisibleTitle, events, this.#dispatchInsightActivatedEvent.bind(this)));
-      }
-    }
-  }
-
-  set insights(insights: Trace.Insights.Types.TraceInsightSets|null) {
-    this.data.insights = insights;
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#boundRender);
-  }
-
-  set parsedTrace(parsedTrace: Trace.Handlers.Types.ParsedTrace|null) {
-    this.data.parsedTrace = parsedTrace;
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#boundRender);
-  }
-
-  set insightSetKey(insightSetKey: string|null) {
-    this.data.insightSetKey = insightSetKey;
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#boundRender);
-  }
-
-  set activeInsight(activeInsight: ActiveInsight|null) {
-    this.data.activeInsight = activeInsight;
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#boundRender);
-  }
-
-  set activeCategory(activeCategory: Category) {
-    this.data.activeCategory = activeCategory;
-    void ComponentHelpers.ScheduledRender.scheduleRender(this, this.#boundRender);
-  }
-
-  protected onSidebarClick(): void {
-    if (this.isActive()) {
-      this.dispatchEvent(new SidebarInsight.InsightDeactivated());
-      return;
-    }
-
-    this.#dispatchInsightActivatedEvent();
-  }
-
-  #dispatchInsightActivatedEvent(): void {
-    if (!this.data.insightSetKey) {
-      // Shouldn't happen, but needed to satisfy TS.
-      return;
-    }
-
-    this.sharedTableState.selectedRowEl?.classList.remove('selected');
-    this.sharedTableState.selectedRowEl = null;
-    this.sharedTableState.selectionIsSticky = false;
-
-    this.dispatchEvent(new SidebarInsight.InsightActivated(
-        this.internalName,
-        this.data.insightSetKey,
-        this.getInitialOverlays(),
-        // TODO: this could be cached.
-        this.getRelatedEvents(),
-        ));
-  }
-
-  /**
-   * Replaces the initial insight overlays with the ones provided.
-   *
-   * If `overlays` is null, reverts back to the initial overlays.
-   *
-   * This allows insights to provide an initial set of overlays,
-   * and later temporarily replace all of those insights with a different set.
-   * This enables the hover/click table interactions.
-   */
-  toggleTemporaryOverlays(
-      overlays: Overlays.Overlays.TimelineOverlay[]|null, options: Overlays.Overlays.TimelineOverlaySetOptions): void {
-    if (!this.isActive()) {
-      return;
-    }
-
-    this.dispatchEvent(new SidebarInsight.InsightProvideOverlays(overlays ?? this.getInitialOverlays(), options));
-  }
-
-  getInitialOverlays(): Overlays.Overlays.TimelineOverlay[] {
-    if (this.#initialOverlays) {
-      return this.#initialOverlays;
-    }
-
-    this.#initialOverlays = this.createOverlays();
-    return this.#initialOverlays;
-  }
-
-  // Should be overrided by subclasses.
-  protected getRelatedEvents(): Trace.Types.Events.Event[] {
-    return [];
-  }
-
-  protected abstract createOverlays(): Overlays.Overlays.TimelineOverlay[];
-
-  #baseRender(): void {
-    this.render();
-    if (this.isActive()) {
-      requestAnimationFrame(() => requestAnimationFrame(() => this.scrollIntoViewIfNeeded()));
-    }
-  }
-
-  abstract render(): void;
-
-  protected isActive(): boolean {
-    return insightIsActive({
-      activeInsight: this.data.activeInsight,
-      insightName: this.internalName,
-      insightSetKey: this.data.insightSetKey,
-    });
-  }
-
-  getInsightSetUrl(): URL {
-    const url = this.data.insights?.get(this.data.insightSetKey ?? '')?.url;
-    Platform.TypeScriptUtilities.assertNotNullOrUndefined(url, 'Expected url for insight set');
-    return new URL(url);
-  }
-}
-
-/**
- * Returns a rendered MarkdownView component.
- *
- * This should not be used for markdown that is not guaranteed to be valid.
- */
-export function md(markdown: string): LitHtml.TemplateResult {
-  const tokens = Marked.Marked.lexer(markdown);
-  const data = {tokens};
-  return html`<devtools-markdown-view .data=${data}></devtools-markdown-view>`;
+  return options.activeCategory === Trace.Insights.Types.InsightCategory.ALL ||
+      options.activeCategory === options.insightCategory;
 }

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

@@ -0,0 +1,142 @@
+// Copyright 2024 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import '../../../../ui/components/icon_button/icon_button.js';
+import './Table.js';
+
+import * as i18n from '../../../../core/i18n/i18n.js';
+import type {
+  ImageDeliveryInsightModel, ImageOptimizationType, OptimizableImage} from
+  '../../../../models/trace/insights/ImageDelivery.js';
+import type * as Trace from '../../../../models/trace/trace.js';
+import * as LitHtml from '../../../../ui/lit-html/lit-html.js';
+import type * as Overlays from '../../overlays/overlays.js';
+
+import {BaseInsightComponent} from './BaseInsightComponent.js';
+import {imageRef} from './EventRef.js';
+import type {TableDataRow} from './Table.js';
+
+const {html} = LitHtml;
+
+const UIStrings = {
+  /**
+   * @description Column header for a table column containing network requests for images that are not sized correctly for how they are displayed on the page.
+   */
+  sizeAppropriately: 'Size appropriately',
+  /**
+   * @description Column header for a table column containing network requests for images which can improve their file size (e.g. use a different format, increase compression, etc).
+   */
+  optimizeFile: 'Optimize file size',
+  /**
+   * @description Table row value representing the remaining items not shown in the table due to size constraints. This row will always represent at least 2 items.
+   * @example {5} PH1
+   */
+  others: '{PH1} others',
+};
+
+const str_ = i18n.i18n.registerUIStrings('panels/timeline/components/insights/ImageDelivery.ts', UIStrings);
+const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
+
+export class ImageDelivery extends BaseInsightComponent<ImageDeliveryInsightModel> {
+  static override readonly litTagName = LitHtml.literal`devtools-performance-image-delivery`;
+  override internalName: string = 'image-delivery';
+
+  override createOverlays(): Overlays.Overlays.TimelineOverlay[] {
+    if (!this.model) {
+      return [];
+    }
+
+    const {optimizableImages} = this.model;
+    return optimizableImages.map(image => this.#createOverlayForRequest(image.request));
+  }
+
+  #createOverlayForRequest(request: Trace.Types.Events.SyntheticNetworkRequest): Overlays.Overlays.EntryOutline {
+    return {
+      type: 'ENTRY_OUTLINE',
+      entry: request,
+      outlineReason: 'ERROR',
+    };
+  }
+
+  #getTopImagesAsRows(
+      optimizableImages: OptimizableImage[], typeFilter: (type: ImageOptimizationType) => boolean,
+      showDimensions?: boolean): TableDataRow[] {
+    const MAX_REQUESTS = 3;
+    const topImages =
+        optimizableImages.filter(image => image.optimizations.some(o => typeFilter(o.type)))
+            .sort((a, b) => b.request.args.data.decodedBodyLength - a.request.args.data.decodedBodyLength);
+
+    const remaining = topImages.splice(MAX_REQUESTS);
+
+    const rows: TableDataRow[] = topImages.map(image => ({
+                                                 values: [
+                                                   imageRef(
+                                                       image.request,
+                                                       showDimensions ? image.largestImagePaint : undefined,
+                                                       ),
+                                                 ],
+                                                 overlays: [this.#createOverlayForRequest(image.request)],
+                                               }));
+
+    if (remaining.length > 0) {
+      const value = remaining.length > 1 ? i18nString(UIStrings.others, {PH1: remaining.length}) :
+                                           imageRef(
+                                               remaining[0].request,
+                                               showDimensions ? remaining[0].largestImagePaint : undefined,
+                                           );
+      rows.push({
+        values: [value],
+        overlays: remaining.map(r => this.#createOverlayForRequest(r.request)),
+      });
+    }
+
+    return rows;
+  }
+
+  #renderContent(): LitHtml.LitTemplate {
+    if (!this.model) {
+      return LitHtml.nothing;
+    }
+
+    const optimizableImages = this.model.optimizableImages;
+
+    // clang-format off
+    return html`
+      <div class="insight-section">
+        <devtools-performance-table
+          .data=${{
+            insight: this,
+            headers: [i18nString(UIStrings.sizeAppropriately)],
+            rows: this.#getTopImagesAsRows(optimizableImages, type => type === 'responsive-size', true),
+          }}>
+        </devtools-performance-table>
+      </div>
+      <div class="insight-section">
+        <devtools-performance-table
+          .data=${{
+            insight: this,
+            headers: [i18nString(UIStrings.optimizeFile)],
+            rows: this.#getTopImagesAsRows(optimizableImages, type => type !== 'responsive-size'),
+          }}>
+        </devtools-performance-table>
+      </div>`;
+    // clang-format on
+  }
+
+  override render(): void {
+    if (!this.model) {
+      return;
+    }
+
+    this.renderWithContent(this.#renderContent());
+  }
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'devtools-performance-image-delivery': ImageDelivery;
+  }
+}
+
+customElements.define('devtools-performance-image-delivery', ImageDelivery);

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

@@ -6,25 +6,16 @@ import './Table.js';
 
 import * as i18n from '../../../../core/i18n/i18n.js';
 import * as Platform from '../../../../core/platform/platform.js';
+import type {INPInsightModel} from '../../../../models/trace/insights/InteractionToNextPaint.js';
 import * as Trace from '../../../../models/trace/trace.js';
 import * as LitHtml from '../../../../ui/lit-html/lit-html.js';
 import type * as Overlays from '../../overlays/overlays.js';
 
-import {BaseInsight, shouldRenderForCategory} from './Helpers.js';
-import {Category} from './types.js';
+import {BaseInsightComponent} from './BaseInsightComponent.js';
 
 const {html} = LitHtml;
 
 const UIStrings = {
-  /**
-   * @description Text to tell the user about the longest user interaction.
-   */
-  description:
-      'Start investigating with the longest phase. [Delays can be minimized](https://web.dev/articles/optimize-inp#optimize_interactions). To reduce processing duration, [optimize the main-thread costs](https://web.dev/articles/optimize-long-tasks), often JS.',
-  /**
-   * @description Title for the performance insight "INP by phase", which shows a breakdown of INP by phases / sections.
-   */
-  title: 'INP by phase',
   /**
    *@description Label used for the phase/component/stage/section of a larger duration.
    */
@@ -52,21 +43,16 @@ const UIStrings = {
 const str_ = i18n.i18n.registerUIStrings('panels/timeline/components/insights/InteractionToNextPaint.ts', UIStrings);
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 
-export class InteractionToNextPaint extends BaseInsight {
+export class InteractionToNextPaint extends BaseInsightComponent<INPInsightModel> {
   static override readonly litTagName = LitHtml.literal`devtools-performance-inp`;
-  override insightCategory: Category = Category.INP;
   override internalName: string = 'inp';
-  override userVisibleTitle: string = i18nString(UIStrings.title);
-  override description: string = i18nString(UIStrings.description);
 
   override createOverlays(): Overlays.Overlays.TimelineOverlay[] {
-    const insight =
-        Trace.Insights.Common.getInsight('InteractionToNextPaint', this.data.insights, this.data.insightSetKey);
-    if (!insight) {
+    if (!this.model) {
       return [];
     }
 
-    const event = insight.longestInteractionEvent;
+    const event = this.model.longestInteractionEvent;
     if (!event) {
       return [];
     }
@@ -108,64 +94,43 @@ export class InteractionToNextPaint extends BaseInsight {
     ];
   }
 
-  #render(event: Trace.Types.Events.SyntheticInteractionPair): LitHtml.TemplateResult {
+  #renderContent(event: Trace.Types.Events.SyntheticInteractionPair): LitHtml.LitTemplate {
     const time = (us: Trace.Types.Timing.MicroSeconds): string =>
         i18n.TimeUtilities.millisToString(Platform.Timing.microSecondsToMilliSeconds(us));
 
     // clang-format off
     return html`
-        <div class="insights">
-            <devtools-performance-sidebar-insight .data=${{
-            title: this.userVisibleTitle,
-            description: this.description,
-            internalName: this.internalName,
-            expanded: this.isActive(),
-            }}
-            @insighttoggleclick=${this.onSidebarClick}>
-                <div slot="insight-content" class="insight-section">
-                  ${html`<devtools-performance-table
-                    .data=${{
-                      insight: this,
-                      headers: [i18nString(UIStrings.phase), i18nString(UIStrings.duration)],
-                      rows: [
-                        {
-                          values: [i18nString(UIStrings.inputDelay), time(event.inputDelay)],
-                          overlays: this.#createOverlaysForPhase(event, 0),
-                        },
-                        {
-                          values: [i18nString(UIStrings.processingDuration), time(event.mainThreadHandling)],
-                          overlays: this.#createOverlaysForPhase(event, 1),
-                        },
-                        {
-                          values: [i18nString(UIStrings.presentationDelay), time(event.presentationDelay)],
-                          overlays: this.#createOverlaysForPhase(event, 2),
-                        },
-                      ],
-                    }}>
-                  </devtools-performance-table>`}
-                </div>
-            </devtools-performance-sidebar-insight>
-        </div>`;
-            // clang-format on
-  }
-
-  override getRelatedEvents(): Trace.Types.Events.Event[] {
-    const insight =
-        Trace.Insights.Common.getInsight('InteractionToNextPaint', this.data.insights, this.data.insightSetKey);
-    return insight?.relatedEvents ?? [];
+      <div class="insight-section">
+        ${html`<devtools-performance-table
+          .data=${{
+            insight: this,
+            headers: [i18nString(UIStrings.phase), i18nString(UIStrings.duration)],
+            rows: [
+              {
+                values: [i18nString(UIStrings.inputDelay), time(event.inputDelay)],
+                overlays: this.#createOverlaysForPhase(event, 0),
+              },
+              {
+                values: [i18nString(UIStrings.processingDuration), time(event.mainThreadHandling)],
+                overlays: this.#createOverlaysForPhase(event, 1),
+              },
+              {
+                values: [i18nString(UIStrings.presentationDelay), time(event.presentationDelay)],
+                overlays: this.#createOverlaysForPhase(event, 2),
+              },
+            ],
+          }}>
+        </devtools-performance-table>`}
+      </div>`;
+    // clang-format on
   }
 
   override render(): void {
-    const insight =
-        Trace.Insights.Common.getInsight('InteractionToNextPaint', this.data.insights, this.data.insightSetKey);
-    const event = insight?.longestInteractionEvent;
-
-    const matchesCategory = shouldRenderForCategory({
-      activeCategory: this.data.activeCategory,
-      insightCategory: this.insightCategory,
-    });
-    const output = event && matchesCategory ? this.#render(event) : LitHtml.nothing;
-    LitHtml.render(output, this.shadow, {host: this});
+    if (!this.model?.longestInteractionEvent) {
+      return;
+    }
+
+    this.renderWithContent(this.#renderContent(this.model.longestInteractionEvent));
   }
 }