Show informative message if filter matched nothing

Author: asgerf

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

@@ -220,6 +220,15 @@ 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.
@@ -233,6 +242,8 @@ export interface EditorSelection {
   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 {

extensions/ql-vscode/src/local-queries/results-view.ts

@@ -52,6 +52,7 @@ import {
   NavigationDirection,
   getDefaultResultSetName,
   RAW_RESULTS_LIMIT,
+  SourceArchiveRelationship,
 } from "../common/interface-types";
 import { extLogger } from "../common/logging/vscode";
 import type { Logger } from "../common/logging";
@@ -1103,6 +1104,7 @@ export class ResultsView extends AbstractWebview<
       startColumn: range.start.character + 1,
       endColumn: range.end.character + 1,
       isEmpty: range.isEmpty,
+      sourceArchiveRelationship: this.getSourceArchiveRelationship(uri),
     };
   }
 
@@ -1129,6 +1131,29 @@ export class ResultsView extends AbstractWebview<
     return undefined;
   }
 
+  /**
+   * Determines the relationship between the editor file and the query's database source archive.
+   */
+  private getSourceArchiveRelationship(
+    editorUri: Uri,
+  ): SourceArchiveRelationship {
+    if (editorUri.scheme !== zipArchiveScheme) {
+      return SourceArchiveRelationship.NotInArchive;
+    }
+    const dbItem = this._displayedQuery
+      ? this.databaseManager.findDatabaseItem(
+          Uri.parse(this._displayedQuery.initialInfo.databaseInfo.databaseUri),
+        )
+      : undefined;
+    if (
+      dbItem?.sourceArchive &&
+      dbItem.belongsToSourceArchiveExplorerUri(editorUri)
+    ) {
+      return SourceArchiveRelationship.CorrectArchive;
+    }
+    return SourceArchiveRelationship.WrongArchive;
+  }
+
   /**
    * Loads all results from the given table that reference the given file URI,
    * and sends them to the webview. Called on demand when the webview requests

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

@@ -4,10 +4,29 @@ import { RawTable } from "./RawTable";
 import type { ResultTableProps } from "./result-table-utils";
 import { AlertTableNoResults } from "./AlertTableNoResults";
 import { AlertTableHeader } from "./AlertTableHeader";
+import { SelectionFilterNoResults } from "./SelectionFilterNoResults";
 
 export function ResultTable(props: ResultTableProps) {
-  const { resultSet, userSettings, filteredRawRows, filteredSarifResults } =
-    props;
+  const {
+    resultSet,
+    userSettings,
+    selectionFilter,
+    filteredRawRows,
+    filteredSarifResults,
+  } = props;
+
+  const filteredCount = filteredRawRows?.length ?? filteredSarifResults?.length;
+  // When filtering is active and the filtered results are empty, show a
+  // message instead of forwarding to child tables (which would misleadingly
+  // say the query returned no results).
+  if (selectionFilter && filteredCount === 0) {
+    return (
+      <SelectionFilterNoResults
+        sourceArchiveRelationship={selectionFilter.sourceArchiveRelationship}
+      />
+    );
+  }
+
   switch (resultSet.t) {
     case "RawResultSet": {
       const filteredResultSet = {

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

@@ -0,0 +1,46 @@
+import { styled } from "styled-components";
+import { SourceArchiveRelationship } from "../../common/interface-types";
+
+interface Props {
+  sourceArchiveRelationship: SourceArchiveRelationship;
+}
+
+const Root = styled.div`
+  height: 300px;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+`;
+
+const Container = styled.span`
+  max-width: 80%;
+  font-size: 14px;
+  text-align: center;
+`;
+
+export function SelectionFilterNoResults({
+  sourceArchiveRelationship,
+}: Props): React.JSX.Element {
+  return (
+    <Root>
+      <Container>
+        No results match the current selection filter.
+        {sourceArchiveRelationship ===
+          SourceArchiveRelationship.NotInArchive && (
+          <>
+            <br />
+            This file is not part of a source archive for a database.
+          </>
+        )}
+        {sourceArchiveRelationship ===
+          SourceArchiveRelationship.WrongArchive && (
+          <>
+            <br />
+            This file is part of the source archive for a different database
+            than the one this query was run on.
+          </>
+        )}
+      </Container>
+    </Root>
+  );
+}