Merge pull request #4170 from github/asgerf/comparison-names

Compare performance: Show names of query runs being compared

Author: asgerf

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

@@ -420,8 +420,8 @@ export type ToComparePerformanceViewMessage = SetPerformanceComparisonQueries;
 
 export interface SetPerformanceComparisonQueries {
   readonly t: "setPerformanceComparison";
-  readonly from: PerformanceComparisonDataFromLog;
-  readonly to: PerformanceComparisonDataFromLog;
+  readonly from: { name: string; data: PerformanceComparisonDataFromLog };
+  readonly to: { name: string; data: PerformanceComparisonDataFromLog };
   readonly comparison: boolean;
 }
 

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

@@ -19,6 +19,7 @@ import { PerformanceOverviewScanner } from "../log-insights/performance-comparis
 import type { ResultsView } from "../local-queries";
 import { readJsonlFile } from "../common/jsonl-reader";
 import type { SummaryEvent } from "../log-insights/log-summary";
+import type { CompletedLocalQueryInfo } from "../query-results";
 
 export class ComparePerformanceView extends AbstractWebview<
   ToComparePerformanceViewMessage,
@@ -33,7 +34,35 @@ export class ComparePerformanceView extends AbstractWebview<
     super(app);
   }
 
-  async showResults(fromJsonLog: string, toJsonLog: string) {
+  async showResults(
+    from: CompletedLocalQueryInfo,
+    to: CompletedLocalQueryInfo | undefined,
+  ) {
+    if (to === undefined) {
+      // For single-run comparisons, the performance viewer considers the 'from' side to be missing.
+      return this.showResultsAux(undefined, from);
+    } else {
+      return this.showResultsAux(from, to);
+    }
+  }
+
+  private async showResultsAux(
+    from: CompletedLocalQueryInfo | undefined,
+    to: CompletedLocalQueryInfo,
+  ) {
+    const fromJsonLog =
+      from === undefined ? "" : from.evaluatorLogPaths?.jsonSummary;
+    const toJsonLog = to.evaluatorLogPaths?.jsonSummary;
+
+    if (fromJsonLog === undefined || toJsonLog === undefined) {
+      return extLogger.showWarningMessage(
+        `Cannot compare performance as the structured logs are missing. Did the queries complete normally?`,
+      );
+    }
+    await extLogger.log(
+      `Comparing performance of ${from?.getQueryName() ?? "baseline"} and ${to?.getQueryName()}`,
+    );
+
     const panel = await this.getPanel();
     panel.reveal(undefined, false);
 
@@ -75,10 +104,14 @@ export class ComparePerformanceView extends AbstractWebview<
       scanLogWithProgress(toJsonLog, fromJsonLog === "" ? "1/1" : "2/2"),
     ]);
 
+    const fromName =
+      from === undefined ? "" : this.labelProvider.getLabel(from);
+    const toName = this.labelProvider.getLabel(to);
+
     await this.postMessage({
       t: "setPerformanceComparison",
-      from: fromPerf.getData(),
-      to: toPerf.getData(),
+      from: { name: fromName, data: fromPerf.getData() },
+      to: { name: toName, data: toPerf.getData() },
       comparison: fromJsonLog !== "",
     });
   }

extensions/ql-vscode/src/extension.ts

@@ -1226,23 +1226,7 @@ async function showPerformanceComparison(
   from: CompletedLocalQueryInfo,
   to: CompletedLocalQueryInfo | undefined,
 ): Promise<void> {
-  let fromLog = from.evaluatorLogPaths?.jsonSummary;
-  let toLog = to?.evaluatorLogPaths?.jsonSummary;
-
-  if (to === undefined) {
-    toLog = fromLog;
-    fromLog = "";
-  }
-  if (fromLog === undefined || toLog === undefined) {
-    return extLogger.showWarningMessage(
-      `Cannot compare performance as the structured logs are missing. Did they queries complete normally?`,
-    );
-  }
-  await extLogger.log(
-    `Comparing performance of ${from.getQueryName()} and ${to?.getQueryName() ?? "baseline"}`,
-  );
-
-  await view.showResults(fromLog, toLog);
+  await view.showResults(from, to);
 }
 
 function addUnhandledRejectionListener() {

extensions/ql-vscode/src/view/compare-performance/ComparePerformance.tsx

@@ -552,8 +552,8 @@ function ComparePerformanceWithData(props: {
 
   const { from, to } = useMemo(
     () => ({
-      from: new ComparisonDataset(data.from),
-      to: new ComparisonDataset(data.to),
+      from: new ComparisonDataset(data.from.data),
+      to: new ComparisonDataset(data.to.data),
     }),
     [data],
   );
@@ -695,6 +695,13 @@ function ComparePerformanceWithData(props: {
   return (
     <>
       <ViewTitle>Performance comparison</ViewTitle>
+      <div>
+        {comparison ? "Comparing query runs" : "Showing query run"}:
+        <ul>
+          {comparison && <li>{data.from.name}</li>}
+          <li>{data.to.name}</li>
+        </ul>
+      </div>
       {comparison && hasCacheHitMismatch.current && (
         <label>
           <input