Add commands for navigation of alerts

extensions/ql-vscode/package.json

@@ -601,6 +601,14 @@
         "command": "codeQLQueryResults.previousPathStep",
         "title": "CodeQL: Show Previous Step on Path"
       },
+      {
+        "command": "codeQLQueryResults.nextAlert",
+        "title": "CodeQL: Show Next Alert"
+      },
+      {
+        "command": "codeQLQueryResults.previousAlert",
+        "title": "CodeQL: Show Previous Alert"
+      },
       {
         "command": "codeQL.restartQueryServer",
         "title": "CodeQL: Restart Query Server"

extensions/ql-vscode/src/interface.ts

@@ -154,6 +154,18 @@ export class ResultsView extends AbstractWebview<IntoResultsViewMsg, FromResults
         this.navigatePathStep.bind(this, -1)
       )
     );
+    this.push(
+      commandRunner(
+        'codeQLQueryResults.nextAlert',
+        this.navigateAlert.bind(this, 1)
+      )
+    );
+    this.push(
+      commandRunner(
+        'codeQLQueryResults.previousAlert',
+        this.navigateAlert.bind(this, -1)
+      )
+    );
 
     this.push(
       this.databaseManager.onDidChangeDatabaseItem(({ kind }) => {
@@ -173,6 +185,10 @@ export class ResultsView extends AbstractWebview<IntoResultsViewMsg, FromResults
     await this.postMessage({ t: 'navigatePath', direction });
   }
 
+  async navigateAlert(direction: number): Promise<void> {
+    await this.postMessage({ t: 'navigateAlert', direction });
+  }
+
   protected getPanelConfig(): WebviewPanelConfig {
     return {
       viewId: 'resultsView',

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

@@ -141,14 +141,22 @@ export interface ShowInterpretedPageMsg {
   queryPath: string;
 }
 
-/** Advance to the next or previous path no in the path viewer */
+/** Advance to the next or previous path step in the path viewer */
 export interface NavigatePathMsg {
   t: 'navigatePath';
 
   /** 1 for next, -1 for previous */
   direction: number;
 }
 
+/** Advance to the next or previous alert in the path viewer */
+export interface NavigateAlertMsg {
+  t: 'navigateAlert';
+
+  /** 1 for next, -1 for previous */
+  direction: number;
+}
+
 /**
  * A message indicating that the results view should untoggle the
  * "Show results in Problems view" checkbox.
@@ -165,6 +173,7 @@ export type IntoResultsViewMsg =
   | SetStateMsg
   | ShowInterpretedPageMsg
   | NavigatePathMsg
+  | NavigateAlertMsg
   | UntoggleShowProblemsMsg;
 
 /**

extensions/ql-vscode/src/pure/result-keys.ts

@@ -1,33 +1,48 @@
 import * as sarif from 'sarif';
 
+/**
+ * Identifies a result, a path, or one of the nodes on a path.
+ */
+interface ResultKeyBase {
+  resultIndex: number;
+  pathIndex?: number;
+  pathNodeIndex?: number;
+}
+
 /**
  * Identifies one of the results in a result set by its index in the result list.
  */
-export interface Result {
+export interface Result extends ResultKeyBase {
   resultIndex: number;
+  pathIndex?: undefined;
+  pathNodeIndex?: undefined;
 }
 
 /**
  * Identifies one of the paths associated with a result.
  */
-export interface Path extends Result {
+export interface Path extends ResultKeyBase {
   pathIndex: number;
+  pathNodeIndex?: undefined;
 }
 
 /**
  * Identifies one of the nodes in a path.
  */
-export interface PathNode extends Path {
+export interface PathNode extends ResultKeyBase {
+  pathIndex: number;
   pathNodeIndex: number;
 }
 
+export type ResultKey = Result | Path | PathNode;
+
 /** Alias for `undefined` but more readable in some cases */
 export const none: PathNode | undefined = undefined;
 
 /**
  * Looks up a specific result in a result set.
  */
-export function getResult(sarif: sarif.Log, key: Result): sarif.Result | undefined {
+export function getResult(sarif: sarif.Log, key: Result | Path | PathNode): sarif.Result | undefined {
   if (sarif.runs.length === 0) return undefined;
   if (sarif.runs[0].results === undefined) return undefined;
   const results = sarif.runs[0].results;
@@ -37,7 +52,7 @@ export function getResult(sarif: sarif.Log, key: Result): sarif.Result | undefin
 /**
  * Looks up a specific path in a result set.
  */
-export function getPath(sarif: sarif.Log, key: Path): sarif.ThreadFlow | undefined {
+export function getPath(sarif: sarif.Log, key: Path | PathNode): sarif.ThreadFlow | undefined {
   const result = getResult(sarif, key);
   if (result === undefined) return undefined;
   let index = -1;
@@ -64,7 +79,7 @@ export function getPathNode(sarif: sarif.Log, key: PathNode): sarif.Location | u
 /**
  * Returns true if the two keys are both `undefined` or contain the same set of indices.
  */
-export function equals(key1: PathNode | undefined, key2: PathNode | undefined): boolean {
+export function equals(key1: Partial<PathNode> | undefined, key2: Partial<PathNode> | undefined): boolean {
   if (key1 === key2) return true;
   if (key1 === undefined || key2 === undefined) return false;
   return key1.resultIndex === key2.resultIndex && key1.pathIndex === key2.pathIndex && key1.pathNodeIndex === key2.pathNodeIndex;
@@ -73,7 +88,7 @@ export function equals(key1: PathNode | undefined, key2: PathNode | undefined):
 /**
  * Returns true if the two keys contain the same set of indices and neither are `undefined`.
  */
-export function equalsNotUndefined(key1: PathNode | undefined, key2: PathNode | undefined): boolean {
+export function equalsNotUndefined(key1: Partial<PathNode> | undefined, key2: Partial<PathNode> | undefined): boolean {
   if (key1 === undefined || key2 === undefined) return false;
   return key1.resultIndex === key2.resultIndex && key1.pathIndex === key2.pathIndex && key1.pathNodeIndex === key2.pathNodeIndex;
 }
@@ -93,3 +108,11 @@ export function getAllPaths(result: sarif.Result): sarif.ThreadFlow[] {
   }
   return paths;
 }
+
+/**
+ * Creates a unique string representation of the given key, suitable for use
+ * as the key in a map or set.
+ */
+export function keyToString(key: ResultKey) {
+  return key.resultIndex + '-' + (key.pathIndex ?? '') + '-' + (key.pathNodeIndex ?? '');
+}

extensions/ql-vscode/src/view/results/RawTableRow.tsx

@@ -1,25 +1,28 @@
 import * as React from 'react';
 import { ResultRow } from '../../pure/bqrs-cli-types';
-import { zebraStripe } from './result-table-utils';
+import { selectableZebraStripe } from './result-table-utils';
 import RawTableValue from './RawTableValue';
 
 interface Props {
   rowIndex: number;
   row: ResultRow;
   databaseUri: string;
   className?: string;
+  isSelected?: boolean;
+  onSelected?: (row: number, column: number) => void;
 }
 
 export default function RawTableRow(props: Props) {
   return (
-    <tr key={props.rowIndex} {...zebraStripe(props.rowIndex, props.className || '')}>
+    <tr key={props.rowIndex} {...selectableZebraStripe(props.isSelected ?? false, props.rowIndex, props.className || '')}>
       <td key={-1}>{props.rowIndex + 1}</td>
 
       {props.row.map((value, columnIndex) => (
         <td key={columnIndex}>
           <RawTableValue
             value={value}
             databaseUri={props.databaseUri}
+            onSelected={() => props.onSelected?.(props.rowIndex, columnIndex)}
           />
         </td>
       ))}

extensions/ql-vscode/src/view/results/RawTableValue.tsx

@@ -6,6 +6,7 @@ import { CellValue } from '../../pure/bqrs-cli-types';
 interface Props {
   value: CellValue;
   databaseUri: string;
+  onSelected?: () => void;
 }
 
 export default function RawTableValue(props: Props): JSX.Element {
@@ -18,5 +19,5 @@ export default function RawTableValue(props: Props): JSX.Element {
     return <span>{renderLocation(undefined, rawValue.toString())}</span>;
   }
 
-  return renderLocation(rawValue.url, rawValue.label, props.databaseUri);
+  return renderLocation(rawValue.url, rawValue.label, props.databaseUri, undefined, props.onSelected);
 }