feat: send description to compare performance view

Author: esbena

extensions/ql-vscode/src/common/interface-types.ts

@@ -27,7 +27,10 @@ import type {
 } from "./raw-result-types";
 import type { AccessPathSuggestionOptions } from "../model-editor/suggestions";
 import type { ModelEvaluationRunState } from "../model-editor/shared/model-evaluation-run-state";
-import type { PerformanceComparisonDataFromLog } from "../log-insights/performance-comparison";
+import type {
+  ComparePerformanceDescriptionData,
+  PerformanceComparisonDataFromLog,
+} from "../log-insights/performance-comparison";
 
 /**
  * This module contains types and code that are shared between
@@ -398,9 +401,9 @@ export interface SetComparisonsMessage {
 }
 
 export type ToComparePerformanceViewMessage = SetPerformanceComparisonQueries;
-
 export interface SetPerformanceComparisonQueries {
   readonly t: "setPerformanceComparison";
+  readonly description: ComparePerformanceDescriptionData;
   readonly from: PerformanceComparisonDataFromLog;
   readonly to: PerformanceComparisonDataFromLog;
 }

extensions/ql-vscode/src/compare-performance/compare-performance-view.ts

@@ -15,6 +15,7 @@ import { AbstractWebview } from "../common/vscode/abstract-webview";
 import { telemetryListener } from "../common/vscode/telemetry";
 import type { ResultsView } from "../local-queries";
 import { scanLog } from "../log-insights/log-scanner";
+import type { ComparePerformanceDescriptionData } from "../log-insights/performance-comparison";
 import { PerformanceOverviewScanner } from "../log-insights/performance-comparison";
 import type { HistoryItemLabelProvider } from "../query-history/history-item-label-provider";
 import { RemoteLogs } from "./remote-logs";
@@ -43,7 +44,11 @@ export class ComparePerformanceView extends AbstractWebview<
     );
   }
 
-  async showResults(fromJsonLog: string, toJsonLog: string) {
+  async showResults(
+    fromJsonLog: string,
+    toJsonLog: string,
+    description: ComparePerformanceDescriptionData,
+  ) {
     const panel = await this.getPanel();
     panel.reveal(undefined, false);
 
@@ -65,6 +70,7 @@ export class ComparePerformanceView extends AbstractWebview<
 
     await this.postMessage({
       t: "setPerformanceComparison",
+      description,
       from: fromPerf.getData(),
       to: toPerf.getData(),
     });
@@ -125,6 +131,6 @@ export class ComparePerformanceView extends AbstractWebview<
       );
       return;
     }
-    await this.showResults(result.before, result.after);
+    await this.showResults(result.before, result.after, result.description);
   }
 }

extensions/ql-vscode/src/compare-performance/remote-logs.ts

@@ -23,6 +23,7 @@ import { reportStreamProgress, withProgress } from "../common/vscode/progress";
 import { downloadTimeout, GITHUB_URL } from "../config";
 import { QueryOutputDir } from "../local-queries/query-output-dir";
 import { tmpDir } from "../tmp-dir";
+import type { ComparePerformanceDescriptionData } from "../log-insights/performance-comparison";
 
 export class RemoteLogs {
   private LOG_DOWNLOAD_AND_PROCESS_PROGRESS_STEPS = 4;
@@ -252,6 +253,7 @@ export class RemoteLogs {
     | {
         before: string;
         after: string;
+        description: ComparePerformanceDescriptionData;
       }
     | undefined
   > {
@@ -268,7 +270,11 @@ export class RemoteLogs {
     if (processed.some((d) => typeof d === "undefined")) {
       throw new Error("Silently failed to download or process some logs!?");
     }
-    return { before: processed[0]!, after: processed[1]! };
+    return {
+      before: processed[0]!,
+      after: processed[1]!,
+      description: picked.description,
+    };
   }
 
   /**
@@ -638,6 +644,7 @@ export class RemoteLogs {
     | {
         before: ArtifactDownload;
         after: ArtifactDownload;
+        description: ComparePerformanceDescriptionData;
       }
     | undefined
   > {
@@ -717,10 +724,18 @@ export class RemoteLogs {
     void extLogger.log(
       `Picked ${experimentChoice} ${targetChoice1} ${targetChoice2}`,
     );
+    const targetInfoChoice2 = targetInfos.find(
+      (t) => t.info.target_id === targetChoice2,
+    )!;
     return {
       before: targetInfoChoice1.downloads["evaluator-logs"],
-      after: targetInfos.find((t) => t.info.target_id === targetChoice2)!
-        .downloads["evaluator-logs"],
+      after: targetInfoChoice2.downloads["evaluator-logs"],
+      description: {
+        kind: "remote-logs",
+        experimentName: experimentChoice,
+        fromTarget: targetInfoChoice1,
+        toTarget: targetInfoChoice2,
+      },
     };
   }
 }

extensions/ql-vscode/src/extension.ts

@@ -1223,7 +1223,11 @@ async function showPerformanceComparison(
     `Comparing performance of ${from.getQueryName()} and ${to.getQueryName()}`,
   );
 
-  await view.showResults(fromLog, toLog);
+  await view.showResults(fromLog, toLog, {
+    kind: "local-run",
+    fromQuery: from.getQueryName(),
+    toQuery: to.getQueryName(),
+  });
 }
 
 function addUnhandledRejectionListener() {