Display custom text message when there are no queries found

Author: robertbrignull

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

@@ -48,7 +48,10 @@ import { SkeletonQueryWizard } from "../skeleton-query-wizard";
 import { LocalQueryRun } from "./local-query-run";
 import { createMultiSelectionCommand } from "../common/vscode/selection-commands";
 import { findLanguage } from "../codeql-cli/query-language";
-import type { QueryTreeViewItem } from "../queries-panel/query-tree-view-item";
+import {
+  QueryTreeQueryItem,
+  QueryTreeViewItem,
+} from "../queries-panel/query-tree-view-item";
 
 interface DatabaseQuickPickItem extends QuickPickItem {
   databaseItem: DatabaseItem;
@@ -130,16 +133,20 @@ export class LocalQueries extends DisposableObject {
   private async runQueryFromQueriesPanel(
     queryTreeViewItem: QueryTreeViewItem,
   ): Promise<void> {
-    await this.runQuery(Uri.file(queryTreeViewItem.path));
+    if (queryTreeViewItem instanceof QueryTreeQueryItem) {
+      await this.runQuery(Uri.file(queryTreeViewItem.path));
+    }
   }
 
   private async runQueriesFromQueriesPanel(
     queryTreeViewItem: QueryTreeViewItem,
   ): Promise<void> {
-    const uris = queryTreeViewItem.children.map((child) =>
-      Uri.file(child.path),
-    );
-    await this.runQueries(uris);
+    if (queryTreeViewItem instanceof QueryTreeQueryItem) {
+      const uris = queryTreeViewItem.children.map((child) =>
+        Uri.file(child.path),
+      );
+      await this.runQueries(uris);
+    }
   }
 
   private async runQuery(uri: Uri | undefined): Promise<void> {

extensions/ql-vscode/src/queries-panel/query-tree-data-provider.ts

@@ -1,5 +1,9 @@
 import { Event, EventEmitter, TreeDataProvider, TreeItem } from "vscode";
-import { QueryTreeViewItem } from "./query-tree-view-item";
+import {
+  QueryTreeQueryItem,
+  QueryTreeTextItem,
+  QueryTreeViewItem,
+} from "./query-tree-view-item";
 import { DisposableObject } from "../common/disposable-object";
 import { FileTreeNode } from "../common/file-tree-nodes";
 
@@ -37,21 +41,30 @@ export class QueryTreeDataProvider
     const queryTree = this.queryDiscoverer.buildQueryTree();
     if (queryTree === undefined) {
       return [];
+    } else if (queryTree.length === 0) {
+      return [this.noQueriesTreeViewItem()];
+    } else {
+      return queryTree.map(this.convertFileTreeNode.bind(this));
     }
-    return queryTree.map(this.convertFileTreeNode.bind(this));
   }
 
   private convertFileTreeNode(
     fileTreeDirectory: FileTreeNode<string>,
-  ): QueryTreeViewItem {
-    return new QueryTreeViewItem(
+  ): QueryTreeQueryItem {
+    return new QueryTreeQueryItem(
       fileTreeDirectory.name,
       fileTreeDirectory.path,
       fileTreeDirectory.data,
       fileTreeDirectory.children.map(this.convertFileTreeNode.bind(this)),
     );
   }
 
+  private noQueriesTreeViewItem(): QueryTreeViewItem {
+    return new QueryTreeTextItem(
+      "This workspace doesn't contain any CodeQL queries at the moment.",
+    );
+  }
+
   /**
    * Returns the UI presentation of the element that gets displayed in the view.
    * @param item The item to represent.
@@ -70,8 +83,10 @@ export class QueryTreeDataProvider
     if (!item) {
       // We're at the root.
       return this.queryTreeItems;
-    } else {
+    } else if (item instanceof QueryTreeQueryItem) {
       return item.children;
+    } else {
+      return [];
     }
   }
 }

extensions/ql-vscode/src/queries-panel/query-tree-view-item.ts

@@ -1,11 +1,17 @@
 import * as vscode from "vscode";
 
-export class QueryTreeViewItem extends vscode.TreeItem {
+export abstract class QueryTreeViewItem extends vscode.TreeItem {
+  protected constructor(name: string) {
+    super(name);
+  }
+}
+
+export class QueryTreeQueryItem extends QueryTreeViewItem {
   constructor(
     name: string,
     public readonly path: string,
     language: string | undefined,
-    public readonly children: QueryTreeViewItem[],
+    public readonly children: QueryTreeQueryItem[],
   ) {
     super(name);
     this.tooltip = path;
@@ -24,3 +30,9 @@ export class QueryTreeViewItem extends vscode.TreeItem {
     }
   }
 }
+
+export class QueryTreeTextItem extends QueryTreeViewItem {
+  constructor(text: string) {
+    super(text);
+  }
+}

extensions/ql-vscode/src/variant-analysis/variant-analysis-manager.ts

@@ -76,7 +76,10 @@ import {
   showAndLogInformationMessage,
   showAndLogWarningMessage,
 } from "../common/logging";
-import type { QueryTreeViewItem } from "../queries-panel/query-tree-view-item";
+import {
+  QueryTreeQueryItem,
+  QueryTreeViewItem,
+} from "../queries-panel/query-tree-view-item";
 
 const maxRetryCount = 3;
 
@@ -191,7 +194,11 @@ export class VariantAnalysisManager
   private async runVariantAnalysisFromQueriesPanel(
     queryTreeViewItem: QueryTreeViewItem,
   ): Promise<void> {
-    await this.runVariantAnalysisFromCommand(Uri.file(queryTreeViewItem.path));
+    if (queryTreeViewItem instanceof QueryTreeQueryItem) {
+      await this.runVariantAnalysisFromCommand(
+        Uri.file(queryTreeViewItem.path),
+      );
+    }
   }
 
   public async runVariantAnalysis(

extensions/ql-vscode/test/vscode-tests/minimal-workspace/queries-panel/query-tree-data-provider.test.ts

@@ -4,18 +4,35 @@ import {
   FileTreeLeaf,
 } from "../../../../src/common/file-tree-nodes";
 import { QueryTreeDataProvider } from "../../../../src/queries-panel/query-tree-data-provider";
+import {
+  QueryTreeQueryItem,
+  QueryTreeTextItem,
+} from "../../../../src/queries-panel/query-tree-view-item";
 
 describe("QueryTreeDataProvider", () => {
   describe("getChildren", () => {
-    it("returns no children when there are no queries", async () => {
+    it("returns empty array when discovery has not yet happened", async () => {
       const dataProvider = new QueryTreeDataProvider({
-        buildQueryTree: () => [],
+        buildQueryTree: () => undefined,
         onDidChangeQueries: jest.fn(),
       });
 
       expect(dataProvider.getChildren()).toEqual([]);
     });
 
+    it("returns a explanatory message when there are no queries", async () => {
+      const dataProvider = new QueryTreeDataProvider({
+        buildQueryTree: () => [],
+        onDidChangeQueries: jest.fn(),
+      });
+
+      expect(dataProvider.getChildren()).toEqual([
+        new QueryTreeTextItem(
+          "This workspace doesn't contain any CodeQL queries at the moment.",
+        ),
+      ]);
+    });
+
     it("converts FileTreeNode to QueryTreeViewItem", async () => {
       const dataProvider = new QueryTreeDataProvider({
         buildQueryTree: () => [
@@ -27,7 +44,7 @@ describe("QueryTreeDataProvider", () => {
                 "javascript",
               ),
               new FileTreeLeaf<string>(
-                "dir1/dir2/file1",
+                "dir1/dir2/file2",
                 "file2",
                 "javascript",
               ),
@@ -40,24 +57,27 @@ describe("QueryTreeDataProvider", () => {
         onDidChangeQueries: jest.fn(),
       });
 
-      expect(dataProvider.getChildren().length).toEqual(2);
-
-      expect(dataProvider.getChildren()[0].label).toEqual("dir1");
-      expect(dataProvider.getChildren()[0].children.length).toEqual(1);
-      expect(dataProvider.getChildren()[0].children[0].label).toEqual("dir2");
-      expect(dataProvider.getChildren()[0].children[0].children.length).toEqual(
-        2,
-      );
-      expect(
-        dataProvider.getChildren()[0].children[0].children[0].label,
-      ).toEqual("file1");
-      expect(
-        dataProvider.getChildren()[0].children[0].children[1].label,
-      ).toEqual("file2");
-
-      expect(dataProvider.getChildren()[1].label).toEqual("dir3");
-      expect(dataProvider.getChildren()[1].children.length).toEqual(1);
-      expect(dataProvider.getChildren()[1].children[0].label).toEqual("file3");
+      expect(dataProvider.getChildren()).toEqual([
+        new QueryTreeQueryItem("dir1", "dir1", undefined, [
+          new QueryTreeQueryItem("dir2", "dir1/dir2", undefined, [
+            new QueryTreeQueryItem(
+              "file1",
+              "dir1/dir2/file1",
+              "javascript",
+              [],
+            ),
+            new QueryTreeQueryItem(
+              "file2",
+              "dir1/dir2/file2",
+              "javascript",
+              [],
+            ),
+          ]),
+        ]),
+        new QueryTreeQueryItem("dir3", "dir3", undefined, [
+          new QueryTreeQueryItem("file3", "dir3/file3", "javascript", []),
+        ]),
+      ]);
     });
   });