Add ability to filter results to the current file or selection

A new checkbox appears above the result viewer table. When checked, only
the results from the currently-viewed file are shown. Additionally, if
the selection range is non-empty, only results whose first line overlaps
within the selection range are shown.

Author: asgerf

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

@@ -220,6 +220,60 @@ interface UntoggleShowProblemsMsg {
   t: "untoggleShowProblems";
 }
 
+export const enum SourceArchiveRelationship {
+  /** The file is in the source archive of the database the query was run on. */
+  CorrectArchive = "correct-archive",
+  /** The file is in a source archive, but for a different database. */
+  WrongArchive = "wrong-archive",
+  /** The file is not in any source archive. */
+  NotInArchive = "not-in-archive",
+}
+
+/**
+ * Information about the current editor selection, sent to the results view
+ * so it can filter results to only those overlapping the selection.
+ */
+export interface EditorSelection {
+  /** The file URI in result-compatible format, or undefined if no editor is active. */
+  fileUri: string | undefined;
+  startLine: number;
+  endLine: number;
+  startColumn: number;
+  endColumn: number;
+  /** True if the selection is empty (just a cursor), in which case we match the whole file. */
+  isEmpty: boolean;
+  /** Describes the relationship between the current file and the query's database source archive. */
+  sourceArchiveRelationship: SourceArchiveRelationship;
+}
+
+interface SetEditorSelectionMsg {
+  t: "setEditorSelection";
+  selection: EditorSelection | undefined;
+  wasFromUserInteraction?: boolean;
+}
+
+/**
+ * Results pre-filtered by file URI, sent from the extension when the
+ * selection filter is active and the editor's file changes.
+ * This bypasses pagination so the webview can apply line-range filtering
+ * on the complete set of results for the file.
+ */
+export interface FileFilteredResults {
+  /** The file URI these results were filtered for. */
+  fileUri: string;
+  /** The result set table these results were filtered for. */
+  selectedTable: string;
+  /** Raw result rows from the current result set that reference this file. */
+  rawRows?: Row[];
+  /** SARIF results that reference this file. */
+  sarifResults?: Result[];
+}
+
+interface SetFileFilteredResultsMsg {
+  t: "setFileFilteredResults";
+  results: FileFilteredResults | undefined;
+}
+
 /**
  * A message sent into the results view.
  */
@@ -229,7 +283,9 @@ export type IntoResultsViewMsg =
   | SetUserSettingsMsg
   | ShowInterpretedPageMsg
   | NavigateMsg
-  | UntoggleShowProblemsMsg;
+  | UntoggleShowProblemsMsg
+  | SetEditorSelectionMsg
+  | SetFileFilteredResultsMsg;
 
 /**
  * A message sent from the results view.
@@ -241,7 +297,31 @@ export type FromResultsViewMsg =
   | ChangeRawResultsSortMsg
   | ChangeInterpretedResultsSortMsg
   | ChangePage
-  | OpenFileMsg;
+  | OpenFileMsg
+  | RequestSelectionUpdateMsg
+  | RequestFileFilteredResultsMsg;
+
+/**
+ * Message from the results view to request the extension to re-send
+ * the current editor selection and file-filtered results. Sent when
+ * the selection filter is toggled on to ensure the filter state
+ * reflects the actual current editor, not a stale cached value.
+ */
+interface RequestSelectionUpdateMsg {
+  t: "requestSelectionUpdate";
+}
+
+/**
+ * Message from the results view to request pre-filtered results for
+ * a specific (file, table) pair. The extension loads all results from
+ * the given table that reference the given file and sends them back
+ * via setFileFilteredResults.
+ */
+interface RequestFileFilteredResultsMsg {
+  t: "requestFileFilteredResults";
+  fileUri: string;
+  selectedTable: string;
+}
 
 /**
  * Message from the results view to open a source

extensions/ql-vscode/src/databases/local-databases/locations.ts

@@ -9,6 +9,7 @@ import {
   window as Window,
   workspace,
 } from "vscode";
+import type { TextEditor } from "vscode";
 import { assertNever, getErrorMessage } from "../../common/helpers-pure";
 import type { Logger } from "../../common/logging";
 import type { DatabaseItem } from "./database-item";
@@ -76,6 +77,12 @@ function resolveWholeFileLocation(
   );
 }
 
+/** Returned from `showLocation` and related functions, to indicate which editor and location was ultimately highlighted. */
+export interface RevealedLocation {
+  editor: TextEditor;
+  location: Location;
+}
+
 /**
  * Try to resolve the specified CodeQL location to a URI into the source archive. If no exact location
  * can be resolved, returns `undefined`.
@@ -105,9 +112,9 @@ export async function showResolvableLocation(
   loc: UrlValueResolvable,
   databaseItem: DatabaseItem | undefined,
   logger: Logger,
-): Promise<void> {
+): Promise<RevealedLocation | null> {
   try {
-    await showLocation(tryResolveLocation(loc, databaseItem));
+    return showLocation(tryResolveLocation(loc, databaseItem));
   } catch (e) {
     if (e instanceof Error && e.message.match(/File not found/)) {
       void Window.showErrorMessage(
@@ -116,12 +123,15 @@ export async function showResolvableLocation(
     } else {
       void logger.log(`Unable to jump to location: ${getErrorMessage(e)}`);
     }
+    return null;
   }
 }
 
-export async function showLocation(location?: Location) {
+export async function showLocation(
+  location?: Location,
+): Promise<RevealedLocation | null> {
   if (!location) {
-    return;
+    return null;
   }
 
   const doc = await workspace.openTextDocument(location.uri);
@@ -156,17 +166,19 @@ export async function showLocation(location?: Location) {
   editor.revealRange(range, TextEditorRevealType.InCenter);
   editor.setDecorations(shownLocationDecoration, [range]);
   editor.setDecorations(shownLocationLineDecoration, [range]);
+
+  return { editor, location };
 }
 
 export async function jumpToLocation(
   databaseUri: string | undefined,
   loc: UrlValueResolvable,
   databaseManager: DatabaseManager,
   logger: Logger,
-) {
+): Promise<RevealedLocation | null> {
   const databaseItem =
     databaseUri !== undefined
       ? databaseManager.findDatabaseItem(Uri.parse(databaseUri))
       : undefined;
-  await showResolvableLocation(loc, databaseItem, logger);
+  return showResolvableLocation(loc, databaseItem, logger);
 }