Merge branch 'main' into robertbrignull/convert-ResultsApp

Author: robertbrignull

docs/test-plan.md

@@ -378,6 +378,7 @@ This requires running a MRVA query and seeing the results view.
 1. Make changes via config file (ensure JSON schema is helping out)
 1. Close and re-open VS Code (ensure lists are there)
 1. Collapse/expand tree nodes
+1. Create a new list, right click and select "Add repositories with GitHub Code Search". Enter the language 'python' and the query "UserMixin". This should show a rate limiting notification after a while but eventually populate the list with roughly 770 items.
 
 Error cases that trigger an error notification:
 

extensions/ql-vscode/CHANGELOG.md

@@ -1,5 +1,7 @@
 # CodeQL for Visual Studio Code: Changelog
 
+## [UNRELEASED]
+
 ## 1.8.7 - 29 June 2023
 
 - Show a run button on the file tab for query files, that will start a local query. This button will only show when a local database is selected in the extension. [#2544](https://github.com/github/vscode-codeql/pull/2544)

extensions/ql-vscode/package-lock.json

@@ -4,7 +4,7 @@
   "description": "CodeQL for Visual Studio Code",
   "author": "GitHub",
   "private": true,
-  "version": "1.8.7",
+  "version": "1.8.8",
   "publisher": "GitHub",
   "license": "MIT",
   "icon": "media/VS-marketplace-CodeQL-icon.png",
@@ -1699,7 +1699,7 @@
       },
       {
         "view": "codeQLQueries",
-        "contents": "This workspace doesn't contain any CodeQL queries at the moment."
+        "contents": "Looking for queries..."
       },
       {
         "view": "codeQLDatabases",
@@ -1780,7 +1780,7 @@
     "vscode-languageclient": "^8.0.2",
     "vscode-test-adapter-api": "~1.7.0",
     "vscode-test-adapter-util": "~0.7.0",
-    "zip-a-folder": "~1.1.3"
+    "zip-a-folder": "~2.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.18.13",

extensions/ql-vscode/package.json

@@ -1,10 +1,10 @@
-import { AppCommandManager } from "./common/commands";
+import { AppCommandManager } from "../common/commands";
 import { Uri, workspace } from "vscode";
 import { join } from "path";
 import { pathExists } from "fs-extra";
-import { isCodespacesTemplate } from "./config";
-import { showBinaryChoiceDialog } from "./common/vscode/dialog";
-import { extLogger } from "./common/logging/vscode";
+import { isCodespacesTemplate } from "../config";
+import { showBinaryChoiceDialog } from "../common/vscode/dialog";
+import { extLogger } from "../common/logging/vscode";
 
 /**
  * Check if the current workspace is the CodeTour and open the workspace folder.

extensions/ql-vscode/src/code-tour.ts …ons/ql-vscode/src/code-tour/code-tour.tsextensions/ql-vscode/src/code-tour.ts renamed to extensions/ql-vscode/src/code-tour/code-tour.ts extensions/ql-vscode/src/code-tour.ts renamed to extensions/ql-vscode/src/code-tour/code-tour.ts

@@ -34,6 +34,12 @@ interface PathData {
  * relevant, and what extra data to compute for each file.
  */
 export abstract class FilePathDiscovery<T extends PathData> extends Discovery {
+  /**
+   * Has `discover` been called. This allows distinguishing between
+   * "no paths found" and not having scanned yet.
+   */
+  private discoverHasCompletedOnce = false;
+
   /** The set of known paths and associated data that we are tracking */
   private pathData: T[] = [];
 
@@ -73,7 +79,10 @@ export abstract class FilePathDiscovery<T extends PathData> extends Discovery {
     this.push(this.watcher.onDidChange(this.fileChanged.bind(this)));
   }
 
-  protected getPathData(): ReadonlyArray<Readonly<T>> {
+  protected getPathData(): ReadonlyArray<Readonly<T>> | undefined {
+    if (!this.discoverHasCompletedOnce) {
+      return undefined;
+    }
     return this.pathData;
   }
 
@@ -118,7 +127,8 @@ export abstract class FilePathDiscovery<T extends PathData> extends Discovery {
     });
 
     this.updateWatchers();
-    return this.refresh();
+    await this.refresh();
+    this.onDidChangePathDataEmitter.fire();
   }
 
   private workspaceFoldersChanged(event: WorkspaceFoldersChangeEvent) {
@@ -171,6 +181,7 @@ export abstract class FilePathDiscovery<T extends PathData> extends Discovery {
       }
     }
 
+    this.discoverHasCompletedOnce = true;
     if (pathsUpdated) {
       this.onDidChangePathDataEmitter.fire();
     }

extensions/ql-vscode/src/common/vscode/file-path-discovery.ts

@@ -11,13 +11,24 @@ export type ExternalApiUsage = {
    */
   library: string;
   /**
-   * Contains the full method signature, e.g. `org.sql2o.Connection#createQuery(String)`
+   * A unique signature that can be used to identify this external API usage.
+   *
+   * The signature contains the package name, type name, method name, and method parameters
+   * in the form "packageName.typeName#methodName(methodParameters)".
+   * e.g. `org.sql2o.Connection#createQuery(String)`
    */
   signature: string;
   packageName: string;
   typeName: string;
   methodName: string;
+  /**
+   * The method parameters, including enclosing parentheses, e.g. `(String, String)`
+   */
   methodParameters: string;
+  /**
+   * Is this method already supported by CodeQL standard libraries.
+   * If so, there is no need for the user to model it themselves.
+   */
   supported: boolean;
   usages: Call[];
 };

extensions/ql-vscode/src/data-extensions-editor/external-api-usage.ts

@@ -21,7 +21,7 @@ import {
 } from "../../common/vscode/workspace-folders";
 import { isQueryLanguage } from "../../common/query-language";
 import { existsSync } from "fs";
-import { QlPackGenerator } from "../../qlpack-generator";
+import { QlPackGenerator } from "../../local-queries/qlpack-generator";
 import { asError, getErrorMessage } from "../../common/helpers-pure";
 import { DatabaseItem, PersistedDatabaseItem } from "./database-item";
 import { redactableError } from "../../common/errors";

extensions/ql-vscode/src/databases/local-databases/database-manager.ts

@@ -56,7 +56,7 @@ import {
   GithubRateLimitedError,
 } from "./codeql-cli/distribution";
 import { tmpDir, tmpDirDisposal } from "./tmp-dir";
-import { prepareCodeTour } from "./code-tour";
+import { prepareCodeTour } from "./code-tour/code-tour";
 import {
   showBinaryChoiceDialog,
   showInformationMessageWithAction,

extensions/ql-vscode/src/extension.ts

@@ -44,7 +44,7 @@ import { CliVersionConstraint, CodeQLCliServer } from "../codeql-cli/cli";
 import { LocalQueryCommands } from "../common/commands";
 import { App } from "../common/app";
 import { DisposableObject } from "../common/disposable-object";
-import { SkeletonQueryWizard } from "../skeleton-query-wizard";
+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";
@@ -132,15 +132,20 @@ export class LocalQueries extends DisposableObject {
   private async runQueryFromQueriesPanel(
     queryTreeViewItem: QueryTreeViewItem,
   ): Promise<void> {
-    await this.runQuery(Uri.file(queryTreeViewItem.path));
+    if (queryTreeViewItem.path !== undefined) {
+      await this.runQuery(Uri.file(queryTreeViewItem.path));
+    }
   }
 
   private async runQueriesFromQueriesPanel(
     queryTreeViewItem: QueryTreeViewItem,
   ): Promise<void> {
-    const uris = queryTreeViewItem.children.map((child) =>
-      Uri.file(child.path),
-    );
+    const uris = [];
+    for (const child of queryTreeViewItem.children) {
+      if (child.path !== undefined) {
+        uris.push(Uri.file(child.path));
+      }
+    }
     await this.runQueries(uris);
   }