Merge "ui: Add discriminating type to {,Legacy}DetailsPanel" into main

google · Sep 23, 2024 · f1480b4 · f1480b4
2 parents f0d6bcb + f79657e
commit f1480b4
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 5 deletions.
diff --git a/ui/src/core/app_trace_impl.ts b/ui/src/core/app_trace_impl.ts
@@ -19,7 +19,7 @@ import {TimeSpan} from '../base/time';
 import {TimelineImpl} from '../core/timeline';
 import {App} from '../public/app';
 import {Command} from '../public/command';
-import {LegacyDetailsPanel} from '../public/details_panel';
+import {DetailsPanel, LegacyDetailsPanel} from '../public/details_panel';
 import {Trace} from '../public/trace';
 import {setScrollToFunction} from '../public/scroll_helper';
 import {ScrollToArgs} from 'src/public/scroll_helper';
@@ -304,8 +304,14 @@ export class TraceImpl implements Trace {
     return new TraceImpl(this.appImpl.forkForPlugin(pluginId), this.traceCtx);
   }
 
-  registerDetailsPanel(detailsPanel: LegacyDetailsPanel): Disposable {
-    return this.traceCtx.tabMgr.registerLegacyDetailsPanel(detailsPanel);
+  registerDetailsPanel(
+    detailsPanel: DetailsPanel | LegacyDetailsPanel,
+  ): Disposable {
+    if (detailsPanel.panelType === 'LegacyDetailsPanel') {
+      return this.traceCtx.tabMgr.registerLegacyDetailsPanel(detailsPanel);
+    } else {
+      return this.traceCtx.tabMgr.registerDetailsPanel(detailsPanel);
+    }
   }
 
   // TODO(primiano): there are two things here:

diff --git a/ui/src/core_plugins/cpu_profile/index.ts b/ui/src/core_plugins/cpu_profile/index.ts
@@ -95,6 +95,7 @@ class CpuProfile implements PerfettoPlugin {
 }
 
 class CpuProfileSampleFlamegraphDetailsPanel implements LegacyDetailsPanel {
+  readonly panelType = 'LegacyDetailsPanel';
   private sel?: CpuProfileSampleSelection;
   private selMonitor = new Monitor([() => this.sel?.ts, () => this.sel?.utid]);
   private flamegraphAttrs?: QueryFlamegraphAttrs;

diff --git a/ui/src/core_plugins/heap_profile/index.ts b/ui/src/core_plugins/heap_profile/index.ts
@@ -89,6 +89,7 @@ class HeapProfilePlugin implements PerfettoPlugin {
 }
 
 class HeapProfileFlamegraphDetailsPanel implements LegacyDetailsPanel {
+  readonly panelType = 'LegacyDetailsPanel';
   private sel?: HeapProfileSelection;
   private selMonitor = new Monitor([
     () => this.sel?.ts,

diff --git a/ui/src/core_plugins/perf_samples_profile/index.ts b/ui/src/core_plugins/perf_samples_profile/index.ts
@@ -129,6 +129,7 @@ class PerfSamplesProfilePlugin implements PerfettoPlugin {
 }
 
 class PerfSamplesFlamegraphDetailsPanel implements LegacyDetailsPanel {
+  readonly panelType = 'LegacyDetailsPanel';
   private sel?: PerfSamplesSelection;
   private selMonitor = new Monitor([
     () => this.sel?.leftTs,

diff --git a/ui/src/frontend/aggregation_tab.ts b/ui/src/frontend/aggregation_tab.ts
@@ -366,6 +366,7 @@ export class AggregationsTabs implements Disposable {
 
   constructor() {
     const unregister = globals.tabManager.registerDetailsPanel({
+      panelType: 'DetailsPanel',
       render(selection) {
         if (selection.kind === 'area') {
           return m(AreaDetailsPanel);

diff --git a/ui/src/frontend/notes_panel.ts b/ui/src/frontend/notes_panel.ts
@@ -370,6 +370,8 @@ export class NotesPanel implements Panel {
 }
 
 export class NotesEditorTab implements DetailsPanel {
+  readonly panelType = 'DetailsPanel';
+
   render(selection: Selection) {
     if (selection.kind !== 'note') {
       return undefined;

diff --git a/ui/src/public/details_panel.ts b/ui/src/public/details_panel.ts
@@ -16,11 +16,13 @@ import m from 'mithril';
 import {LegacySelection, Selection} from './selection';
 
 export interface LegacyDetailsPanel {
+  readonly panelType: 'LegacyDetailsPanel';
   render(selection: LegacySelection): m.Children;
   isLoading?(): boolean;
 }
 
 export interface DetailsPanel {
+  readonly panelType: 'DetailsPanel';
   render(selection: Selection): m.Children;
   isLoading?(): boolean;
 }

diff --git a/ui/src/public/trace.ts b/ui/src/public/trace.ts
@@ -20,7 +20,7 @@ import {TabManager} from './tab';
 import {TrackManager} from './track';
 import {Timeline} from './timeline';
 import {Workspace, WorkspaceManager} from './workspace';
-import {LegacyDetailsPanel} from './details_panel';
+import {DetailsPanel, LegacyDetailsPanel} from './details_panel';
 import {SelectionManager} from './selection';
 import {ScrollToArgs} from './scroll_helper';
 
@@ -50,7 +50,7 @@ export interface Trace extends App {
   // gone. This method is particularly problematic because the method called
   // registerDetailsPanel in TabManagerImpl takes a non-Legacy DetailsPanel, but
   // all plugins use a Legacy one. Keeping this as a bridge for now.
-  registerDetailsPanel(detailsPanel: LegacyDetailsPanel): void;
+  registerDetailsPanel(detailsPanel: DetailsPanel | LegacyDetailsPanel): void;
 
   // Creates and shows a tab with a tabular result for the given query.
   // TODO(primiano): I am not convinced this belongs here, this should probably

diff --git a/ui/src/public/utils.ts b/ui/src/public/utils.ts
@@ -129,6 +129,7 @@ export interface BottomTabAdapterAttrs {
     })
  */
 export class BottomTabToSCSAdapter implements LegacyDetailsPanel {
+  readonly panelType = 'LegacyDetailsPanel';
   private oldSelection?: LegacySelection;
   private bottomTab?: BottomTab;
   private attrs: BottomTabAdapterAttrs;