Add state and messages for file-filtered results

Just adds the state and messages, and invalidation logic.
No actual filtering happens yet

Author: asgerf

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

@@ -241,6 +241,28 @@ interface SetEditorSelectionMsg {
   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;
+}
+
 /**
  * A message sent into the results view.
  */
@@ -251,6 +273,7 @@ export type IntoResultsViewMsg =
   | ShowInterpretedPageMsg
   | NavigateMsg
   | UntoggleShowProblemsMsg
+  | SetFileFilteredResultsMsg
   | SetEditorSelectionMsg;
 
 /**
@@ -263,7 +286,20 @@ export type FromResultsViewMsg =
   | ChangeRawResultsSortMsg
   | ChangeInterpretedResultsSortMsg
   | ChangePage
-  | OpenFileMsg;
+  | OpenFileMsg
+  | RequestFileFilteredResultsMsg;
+
+/**
+ * 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/local-queries/results-view.ts

@@ -348,6 +348,8 @@ export class ResultsView extends AbstractWebview<
         case "openFile":
           await this.openFile(msg.filePath);
           break;
+        case "requestFileFilteredResults":
+          break;
         case "telemetry":
           telemetryListener?.sendUIInteraction(msg.action);
           break;

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

@@ -2,6 +2,7 @@ import { assertNever, getErrorMessage } from "../../common/helpers-pure";
 import type {
   DatabaseInfo,
   EditorSelection,
+  FileFilteredResults,
   Interpretation,
   IntoResultsViewMsg,
   SortedResultSetInfo,
@@ -69,6 +70,7 @@ interface ResultsViewState {
   selectionFilterEnabled: boolean;
   editorSelection: EditorSelection | undefined;
   selectedTable: string | undefined;
+  fileFilteredResults: FileFilteredResults | undefined;
 }
 
 /**
@@ -86,12 +88,33 @@ export function ResultsApp() {
     selectionFilterEnabled: false,
     editorSelection: undefined,
     selectedTable: undefined,
+    fileFilteredResults: undefined,
   });
 
   const [userSettings, setUserSettings] = useState<UserSettings>(
     DEFAULT_USER_SETTINGS,
   );
 
+  useEffect(() => {
+    if (
+      state.selectionFilterEnabled &&
+      state.editorSelection?.fileUri != null &&
+      state.selectedTable != null &&
+      state.fileFilteredResults == null
+    ) {
+      vscode.postMessage({
+        t: "requestFileFilteredResults",
+        fileUri: state.editorSelection.fileUri,
+        selectedTable: state.selectedTable,
+      });
+    }
+  }, [
+    state.selectionFilterEnabled,
+    state.editorSelection?.fileUri,
+    state.selectedTable,
+    state.fileFilteredResults,
+  ]);
+
   const [problemsViewSelected, setProblemsViewSelected] = useState(false);
 
   const onSelectedTableChange = useCallback((tableName: string) => {
@@ -100,6 +123,7 @@ export function ResultsApp() {
       return {
         ...prev,
         selectedTable: tableName,
+        fileFilteredResults: undefined, // Discard stale results (they are from another table)
       };
     });
   }, []);
@@ -238,11 +262,30 @@ export function ResultsApp() {
               return {
                 ...prev,
                 editorSelection: selection,
+                fileFilteredResults:
+                  selection.fileUri === prev.editorSelection?.fileUri
+                    ? prev.fileFilteredResults
+                    : undefined, // Discard stale results (they are from another file)
               };
             });
           }
           break;
 
+        case "setFileFilteredResults": {
+          const results = msg.results;
+          setState((prev) => {
+            if (
+              results.fileUri === prev.editorSelection?.fileUri &&
+              results.selectedTable === prev.selectedTable &&
+              prev.fileFilteredResults === undefined
+            ) {
+              return { ...prev, fileFilteredResults: results };
+            }
+            return prev;
+          });
+          break;
+        }
+
         default:
           assertNever(msg);
       }