Merge branch 'main' into robertbrignull/countSuccessfulRepos

Author: robertbrignull

docs/test-plan.md

@@ -258,10 +258,10 @@ This requires running a MRVA query and seeing the results view.
    2. When the file does not exist
 7. Can open query text
 8. Can sort repos
-   1. By name
-   2. By results
-   3. By stars
-   4. By last updated
+   1. Alphabetically
+   2. By number of results
+   3. By popularity
+   4. By most recent commit
 9. Can filter repos
 10. Shows correct statistics
     1. Total number of results

extensions/ql-vscode/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 ## [UNRELEASED]
 
+## 1.8.3 - 26 April 2023
+
+- Added ability to filter repositories for a variant analysis to only those that have results [#2343](https://github.com/github/vscode-codeql/pull/2343)
 - Add new configuration option to allow downloading databases from http, non-secure servers. [#2332](https://github.com/github/vscode-codeql/pull/2332)
+- Remove title actions from the query history panel that depended on history items being selected. [#2350](https://github.com/github/vscode-codeql/pull/2350)
 
 ## 1.8.2 - 12 April 2023
 

extensions/ql-vscode/package-lock.json

@@ -4,7 +4,7 @@
   "description": "CodeQL for Visual Studio Code",
   "author": "GitHub",
   "private": true,
-  "version": "1.8.3",
+  "version": "1.8.4",
   "publisher": "GitHub",
   "license": "MIT",
   "icon": "media/VS-marketplace-CodeQL-icon.png",
@@ -340,6 +340,12 @@
           "type": "boolean",
           "default": false,
           "description": "Allow database to be downloaded via HTTP. Warning: enabling this option will allow downloading from insecure servers."
+        },
+        "codeQL.createQuery.folder": {
+          "type": "string",
+          "default": "",
+          "patternErrorMessage": "Please enter a valid folder",
+          "markdownDescription": "The name of the folder where we want to create queries and query packs via the \"CodeQL: Create Query\" command. The folder should exist."
         }
       }
     },
@@ -627,11 +633,6 @@
         "command": "codeQL.checkForUpdatesToCLI",
         "title": "CodeQL: Check for CLI Updates"
       },
-      {
-        "command": "codeQLQueryHistory.openQueryTitleMenu",
-        "title": "View Query",
-        "icon": "$(edit)"
-      },
       {
         "command": "codeQLQueryHistory.openQueryContextMenu",
         "title": "View Query",
@@ -642,11 +643,6 @@
         "title": "Open Query Results",
         "icon": "$(preview)"
       },
-      {
-        "command": "codeQLQueryHistory.removeHistoryItemTitleMenu",
-        "title": "Delete",
-        "icon": "$(trash)"
-      },
       {
         "command": "codeQLQueryHistory.removeHistoryItemContextMenu",
         "title": "Delete",
@@ -847,21 +843,6 @@
           "when": "view == codeQLDatabases",
           "group": "navigation"
         },
-        {
-          "command": "codeQLQueryHistory.openQueryTitleMenu",
-          "when": "view == codeQLQueryHistory",
-          "group": "navigation"
-        },
-        {
-          "command": "codeQLQueryHistory.itemClicked",
-          "when": "view == codeQLQueryHistory",
-          "group": "navigation"
-        },
-        {
-          "command": "codeQLQueryHistory.removeHistoryItemTitleMenu",
-          "when": "view == codeQLQueryHistory",
-          "group": "navigation"
-        },
         {
           "command": "codeQLQueryHistory.sortByName",
           "when": "view == codeQLQueryHistory",
@@ -1304,18 +1285,10 @@
           "command": "codeQLDatabases.upgradeDatabase",
           "when": "false"
         },
-        {
-          "command": "codeQLQueryHistory.openQueryTitleMenu",
-          "when": "false"
-        },
         {
           "command": "codeQLQueryHistory.openQueryContextMenu",
           "when": "false"
         },
-        {
-          "command": "codeQLQueryHistory.removeHistoryItemTitleMenu",
-          "when": "false"
-        },
         {
           "command": "codeQLQueryHistory.removeHistoryItemContextMenu",
           "when": "false"
@@ -1446,7 +1419,7 @@
         },
         {
           "command": "codeQL.createQuery",
-          "when": "config.codeQL.canary"
+          "when": "config.codeQL.codespacesTemplate"
         },
         {
           "command": "codeQLTests.acceptOutputContextTestItem",

extensions/ql-vscode/package.json

@@ -171,6 +171,8 @@ export type OnLineCallback = (
   line: string,
 ) => Promise<string | undefined> | string | undefined;
 
+type VersionChangedListener = (newVersion: SemVer | undefined) => void;
+
 /**
  * This class manages a cli server started by `codeql execute cli-server` to
  * run commands without the overhead of starting a new java
@@ -188,7 +190,9 @@ export class CodeQLCliServer implements Disposable {
   nullBuffer: Buffer;
 
   /** Version of current cli, lazily computed by the `getVersion()` method */
-  private _version: Promise<SemVer> | undefined;
+  private _version: SemVer | undefined;
+
+  private _versionChangedListeners: VersionChangedListener[] = [];
 
   /**
    * The languages supported by the current version of the CLI, computed by `getSupportedLanguages()`.
@@ -1417,15 +1421,36 @@ export class CodeQLCliServer implements Disposable {
 
   public async getVersion() {
     if (!this._version) {
-      this._version = this.refreshVersion();
-      // this._version is only undefined upon config change, so we reset CLI-based context key only when necessary.
-      await this.app.commands.execute(
-        "setContext",
-        "codeql.supportsEvalLog",
-        await this.cliConstraints.supportsPerQueryEvalLog(),
-      );
+      try {
+        const newVersion = await this.refreshVersion();
+        this._version = newVersion;
+        this._versionChangedListeners.forEach((listener) =>
+          listener(newVersion),
+        );
+
+        // this._version is only undefined upon config change, so we reset CLI-based context key only when necessary.
+        await this.app.commands.execute(
+          "setContext",
+          "codeql.supportsEvalLog",
+          newVersion.compare(
+            CliVersionConstraint.CLI_VERSION_WITH_PER_QUERY_EVAL_LOG,
+          ) >= 0,
+        );
+      } catch (e) {
+        this._versionChangedListeners.forEach((listener) =>
+          listener(undefined),
+        );
+        throw e;
+      }
+    }
+    return this._version;
+  }
+
+  public addVersionChangedListener(listener: VersionChangedListener) {
+    if (this._version) {
+      listener(this._version);
     }
-    return await this._version;
+    this._versionChangedListeners.push(listener);
   }
 
   private async refreshVersion() {

extensions/ql-vscode/src/cli.ts

@@ -1,8 +1,8 @@
 import type { CommandManager } from "../packages/commands";
 import type { Uri, Range, TextDocumentShowOptions } from "vscode";
-import type { AstItem } from "../astViewer";
+import type { AstItem } from "../language-support";
 import type { DbTreeViewItem } from "../databases/ui/db-tree-view-item";
-import type { DatabaseItem } from "../local-databases";
+import type { DatabaseItem } from "../databases/local-databases";
 import type { QueryHistoryInfo } from "../query-history/query-history-info";
 import type { RepositoriesFilterSortStateWithIds } from "../pure/variant-analysis-filter-sort";
 import type { TestTreeNode } from "../test-tree-node";
@@ -13,21 +13,6 @@ import type {
 } from "../variant-analysis/shared/variant-analysis";
 import type { QLDebugConfiguration } from "../debugger/debug-configuration";
 
-// A command function matching the signature that VS Code calls when
-// a command is invoked from the title bar of a TreeView with
-// canSelectMany set to true.
-//
-// It is possible to get any combination of singleItem and multiSelect
-// to be undefined. This is because it is possible to click a title bar
-// option without interacting with any individual items first, or even
-// when there are no items present at all.
-// If both singleItem and multiSelect are defined, then singleItem will
-// be contained within multiSelect.
-export type TreeViewTitleMultiSelectionCommandFunction<Item> = (
-  singleItem: Item | undefined,
-  multiSelect: Item[] | undefined,
-) => Promise<void>;
-
 // A command function matching the signature that VS Code calls when
 // a command is invoked from a context menu on a TreeView with
 // canSelectMany set to true.
@@ -176,9 +161,7 @@ export type QueryHistoryCommands = {
   "codeQLQueryHistory.sortByCount": () => Promise<void>;
 
   // Commands in the context menu or in the hover menu
-  "codeQLQueryHistory.openQueryTitleMenu": TreeViewTitleMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.openQueryContextMenu": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
-  "codeQLQueryHistory.removeHistoryItemTitleMenu": TreeViewTitleMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.removeHistoryItemContextMenu": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.removeHistoryItemContextInline": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.renameItem": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
@@ -195,7 +178,7 @@ export type QueryHistoryCommands = {
   "codeQLQueryHistory.viewCsvAlerts": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.viewSarifAlerts": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.viewDil": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
-  "codeQLQueryHistory.itemClicked": TreeViewTitleMultiSelectionCommandFunction<QueryHistoryInfo>;
+  "codeQLQueryHistory.itemClicked": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.openOnGithub": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.copyRepoList": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
 

extensions/ql-vscode/src/common/commands.ts

@@ -0,0 +1,51 @@
+import { showAndLogErrorMessage } from "../helpers";
+import {
+  ExplorerSelectionCommandFunction,
+  TreeViewContextMultiSelectionCommandFunction,
+  TreeViewContextSingleSelectionCommandFunction,
+} from "./commands";
+
+// A hack to match types that are not an array, which is useful to help avoid
+// misusing createSingleSelectionCommand, e.g. where T accidentally gets instantiated
+// as DatabaseItem[] instead of DatabaseItem.
+type NotArray = object & { length?: never };
+
+// A way to get the type system to help assert that one type is a supertype of another.
+type CreateSupertypeOf<Super, Sub extends Super> = Sub;
+
+// This asserts that SelectionCommand is assignable to all of the different types of
+// SelectionCommand defined in commands.ts. The intention is the output from the helpers
+// in this file can be used with any of the select command types and can handle any of
+// the inputs.
+type SelectionCommand<T extends NotArray> = CreateSupertypeOf<
+  TreeViewContextMultiSelectionCommandFunction<T> &
+    TreeViewContextSingleSelectionCommandFunction<T> &
+    ExplorerSelectionCommandFunction<T>,
+  (singleItem: T, multiSelect?: T[] | undefined) => Promise<void>
+>;
+
+export function createSingleSelectionCommand<T extends NotArray>(
+  f: (argument: T) => Promise<void>,
+  itemName: string,
+): SelectionCommand<T> {
+  return async (singleItem, multiSelect) => {
+    if (multiSelect === undefined || multiSelect.length === 1) {
+      return f(singleItem);
+    } else {
+      void showAndLogErrorMessage(`Please select a single ${itemName}.`);
+      return;
+    }
+  };
+}
+
+export function createMultiSelectionCommand<T extends NotArray>(
+  f: (argument: T[]) => Promise<void>,
+): SelectionCommand<T> {
+  return async (singleItem, multiSelect) => {
+    if (multiSelect !== undefined && multiSelect.length > 0) {
+      return f(multiSelect);
+    } else {
+      return f([singleItem]);
+    }
+  };
+}

extensions/ql-vscode/src/common/selection-commands.ts

@@ -7,7 +7,7 @@ import {
 } from "../pure/interface-types";
 import { Logger } from "../common";
 import { CodeQLCliServer } from "../cli";
-import { DatabaseManager } from "../local-databases";
+import { DatabaseManager } from "../databases/local-databases";
 import { jumpToLocation } from "../interface-utils";
 import {
   transformBqrsResultSet,

extensions/ql-vscode/src/compare/compare-view.ts

@@ -619,3 +619,19 @@ export const ALLOW_HTTP_SETTING = new Setting(
 export function allowHttp(): boolean {
   return ALLOW_HTTP_SETTING.getValue<boolean>() || false;
 }
+
+/**
+ * The name of the folder where we want to create skeleton wizard QL packs.
+ **/
+const SKELETON_WIZARD_FOLDER = new Setting(
+  "folder",
+  new Setting("createQuery", ROOT_SETTING),
+);
+
+export function getSkeletonWizardFolder(): string | undefined {
+  return SKELETON_WIZARD_FOLDER.getValue<string>() || undefined;
+}
+
+export async function setSkeletonWizardFolder(folder: string | undefined) {
+  await SKELETON_WIZARD_FOLDER.updateValue(folder, ConfigurationTarget.Global);
+}

extensions/ql-vscode/src/config.ts

@@ -2,8 +2,8 @@ import { ExtensionContext } from "vscode";
 import { DataExtensionsEditorView } from "./data-extensions-editor-view";
 import { DataExtensionsEditorCommands } from "../common/commands";
 import { CliVersionConstraint, CodeQLCliServer } from "../cli";
-import { QueryRunner } from "../queryRunner";
-import { DatabaseManager } from "../local-databases";
+import { QueryRunner } from "../query-server";
+import { DatabaseManager } from "../databases/local-databases";
 import { ensureDir } from "fs-extra";
 import { join } from "path";
 import { App } from "../common/app";