Merge pull request #1978 from github/robertbrignull/compare_view_telemetry

Telemetry for compare view

Author: robertbrignull

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

@@ -16,9 +16,10 @@ import {
 } from "../pure/bqrs-cli-types";
 import resultsDiff from "./resultsDiff";
 import { CompletedLocalQueryInfo } from "../query-results";
-import { getErrorMessage } from "../pure/helpers-pure";
+import { assertNever, getErrorMessage } from "../pure/helpers-pure";
 import { HistoryItemLabelProvider } from "../history-item-label-provider";
 import { AbstractWebview, WebviewPanelConfig } from "../abstract-webview";
+import { telemetryListener } from "../telemetry";
 
 interface ComparePair {
   from: CompletedLocalQueryInfo;
@@ -118,6 +119,9 @@ export class CompareView extends AbstractWebview<
 
       case "changeCompare":
         await this.changeTable(msg.newResultSetName);
+        telemetryListener?.sendUIInteraction(
+          "compare-view-change-table-to-compare",
+        );
         break;
 
       case "viewSourceFile":
@@ -126,7 +130,17 @@ export class CompareView extends AbstractWebview<
 
       case "openQuery":
         await this.openQuery(msg.kind);
+        telemetryListener?.sendUIInteraction(
+          `compare-view-open-${msg.kind}-query`,
+        );
         break;
+
+      case "telemetry":
+        telemetryListener?.sendUIInteraction(msg.action);
+        break;
+
+      default:
+        assertNever(msg);
     }
   }
 

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

@@ -307,7 +307,8 @@ export type FromCompareViewMessage =
   | ViewLoadedMsg
   | ChangeCompareMessage
   | ViewSourceFileMsg
-  | OpenQueryMessage;
+  | OpenQueryMessage
+  | TelemetryMessage;
 
 /**
  * Message from the compare view to request opening a query.

extensions/ql-vscode/src/view/compare/CompareTable.tsx

@@ -6,6 +6,7 @@ import { className } from "../results/result-table-utils";
 import { ResultRow } from "../../pure/bqrs-cli-types";
 import RawTableRow from "../results/RawTableRow";
 import { vscode } from "../vscode-api";
+import { sendTelemetry } from "../common/telemetry";
 
 interface Props {
   comparison: SetComparisonsMessage;
@@ -31,6 +32,9 @@ export default function CompareTable(props: Props) {
             rowIndex={rowIndex}
             row={row}
             databaseUri={databaseUri}
+            onSelected={() => {
+              sendTelemetry("comapre-view-result-clicked");
+            }}
           />
         ))}
       </tbody>