Merge branch 'main' into fix-lgtm-download-message

Author: marcnjaramillo

extensions/ql-vscode/CHANGELOG.md

@@ -2,8 +2,11 @@
 
 ## [UNRELEASED]
 
+
 - Remove line about selecting a language from the dropdown when downloading database from LGTM. This makes the download progress visible when the popup is not expanded. [#894](https://github.com/github/vscode-codeql/issues/894)
 
+- Fixed a bug where copying the version information fails when a CodeQL CLI cannot be found. [#958](https://github.com/github/vscode-codeql/pull/958)
+
 ## 1.5.5 - 08 September 2021
 
 - Fix bug where a query is sometimes run before the file is saved. [#947](https://github.com/github/vscode-codeql/pull/947)

extensions/ql-vscode/package.json

@@ -241,7 +241,7 @@
           "scope": "application",
           "description": "Specifies whether or not to write telemetry events to the extension log."
         },
-        "codeQL.remoteRepositoryLists": {
+        "codeQL.remoteQueries.repositoryLists": {
           "type": [
             "object",
             null
@@ -256,6 +256,13 @@
           },
           "default": null,
           "markdownDescription": "[For internal use only] Lists of GitHub repositories that you want to query remotely. This should be a JSON object where each key is a user-specified name for this repository list, and the value is an array of GitHub repositories (of the form `<owner>/<repo>`)."
+        },
+        "codeQL.remoteQueries.controllerRepo": {
+          "type": "string",
+          "default": "",
+          "pattern": "^$|^(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+/[a-zA-Z0-9-_]+$",
+          "patternErrorMessage": "Please enter a valid GitHub repository",
+          "markdownDescription": "[For internal use only] The name of the GitHub repository where you can view the progress and results of the \"Run Remote query\" command. The repository should be of the form `<owner>/<repo>`)."
         }
       }
     },

extensions/ql-vscode/src/config.ts

@@ -298,15 +298,34 @@ export function isCanary() {
  */
 export const NO_CACHE_AST_VIEWER = new Setting('disableCache', AST_VIEWER_SETTING);
 
+// Settings for remote queries
+const REMOTE_QUERIES_SETTING = new Setting('remoteQueries', ROOT_SETTING);
+
 /**
  * Lists of GitHub repositories that you want to query remotely via the "Run Remote query" command.
  * Note: This command is only available for internal users.
  * 
  * This setting should be a JSON object where each key is a user-specified name (string),
  * and the value is an array of GitHub repositories (of the form `<owner>/<repo>`).
  */
-const REMOTE_REPO_LISTS = new Setting('remoteRepositoryLists', ROOT_SETTING);
+const REMOTE_REPO_LISTS = new Setting('repositoryLists', REMOTE_QUERIES_SETTING);
 
 export function getRemoteRepositoryLists(): Record<string, string[]> | undefined {
   return REMOTE_REPO_LISTS.getValue<Record<string, string[]>>() || undefined;
 }
+
+/**
+ * The name of the "controller" repository that you want to use with the "Run Remote query" command.
+ * Note: This command is only available for internal users.
+ *
+ * This setting should be a GitHub repository of the form `<owner>/<repo>`.
+ */
+const REMOTE_CONTROLLER_REPO = new Setting('controllerRepo', REMOTE_QUERIES_SETTING);
+
+export function getRemoteControllerRepo(): string | undefined {
+  return REMOTE_CONTROLLER_REPO.getValue<string>() || undefined;
+}
+
+export async function setRemoteControllerRepo(repo: string | undefined) {
+  await REMOTE_CONTROLLER_REPO.updateValue(repo, ConfigurationTarget.Global);
+}

extensions/ql-vscode/src/extension.ts

@@ -792,11 +792,19 @@ async function activateWithInstalledDistribution(
 
   ctx.subscriptions.push(
     commandRunner('codeQL.copyVersion', async () => {
-      const text = `CodeQL extension version: ${extension?.packageJSON.version} \nCodeQL CLI version: ${await cliServer.getVersion()} \nPlatform: ${os.platform()} ${os.arch()}`;
+      const text = `CodeQL extension version: ${extension?.packageJSON.version} \nCodeQL CLI version: ${await getCliVersion()} \nPlatform: ${os.platform()} ${os.arch()}`;
       await env.clipboard.writeText(text);
       void helpers.showAndLogInformationMessage(text);
     }));
 
+  const getCliVersion = async () => {
+    try {
+      return await cliServer.getVersion();
+    } catch {
+      return '<missing>';
+    }
+  };
+
   // The "authenticateToGitHub" command is internal-only.
   ctx.subscriptions.push(
     commandRunner('codeQL.authenticateToGitHub', async () => {

extensions/ql-vscode/src/run-remote-query.ts

@@ -5,21 +5,24 @@ import { findLanguage, showAndLogErrorMessage, showAndLogInformationMessage, sho
 import { Credentials } from './authentication';
 import * as cli from './cli';
 import { logger } from './logging';
-import { getRemoteRepositoryLists } from './config';
+import { getRemoteControllerRepo, getRemoteRepositoryLists, setRemoteControllerRepo } from './config';
 interface Config {
   repositories: string[];
   ref?: string;
   language?: string;
 }
 
-// Test "controller" repository and workflow.
-const OWNER = 'dsp-testing';
-const REPO = 'qc-controller';
-
 interface RepoListQuickPickItem extends QuickPickItem {
   repoList: string[];
 }
 
+/**
+ * This regex matches strings of the form `owner/repo` where:
+ * - `owner` is made up of alphanumeric characters or single hyphens, starting and ending in an alphanumeric character
+ * - `repo` is made up of alphanumeric characters, hyphens, or underscores
+ */
+const REPO_REGEX = /^(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+\/[a-zA-Z0-9-_]+$/;
+
 /**
  * Gets the repositories to run the query against.
  */
@@ -35,7 +38,7 @@ export async function getRepositories(): Promise<string[] | undefined> {
     const quickpick = await window.showQuickPick<RepoListQuickPickItem>(
       quickPickItems,
       {
-        placeHolder: 'Select a repository list. You can define repository lists in the `codeQL.remoteRepositoryLists` setting.',
+        placeHolder: 'Select a repository list. You can define repository lists in the `codeQL.remoteQueries.repositoryLists` setting.',
         ignoreFocusOut: true,
       });
     if (quickpick?.repoList.length) {
@@ -47,22 +50,16 @@ export async function getRepositories(): Promise<string[] | undefined> {
     }
   } else {
     void logger.log('No repository lists defined. Displaying text input box.');
-    /**
-     * This regex matches strings of the form `owner/repo` where:
-     * - `owner` is made up of alphanumeric characters or single hyphens, starting and ending in an alphanumeric character
-     * - `repo` is made up of alphanumeric characters, hyphens, or underscores
-     */
-    const repoRegex = /^(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+\/[a-zA-Z0-9-_]+$/;
     const remoteRepo = await window.showInputBox({
       title: 'Enter a GitHub repository in the format <owner>/<repo> (e.g. github/codeql)',
       placeHolder: '<owner>/<repo>',
-      prompt: 'Tip: you can save frequently used repositories in the `codeql.remoteRepositoryLists` setting',
+      prompt: 'Tip: you can save frequently used repositories in the `codeQL.remoteQueries.repositoryLists` setting',
       ignoreFocusOut: true,
     });
     if (!remoteRepo) {
       void showAndLogErrorMessage('No repositories entered.');
       return;
-    } else if (!repoRegex.test(remoteRepo)) { // Check if user entered invalid input
+    } else if (!REPO_REGEX.test(remoteRepo)) { // Check if user entered invalid input
       void showAndLogErrorMessage('Invalid repository format. Must be in the format <owner>/<repo> (e.g. github/codeql)');
       return;
     }
@@ -85,7 +82,7 @@ export async function runRemoteQuery(cliServer: cli.CodeQLCliServer, credentials
   let repositories: string[] | undefined;
 
   // If the user has an explicit `.repositories` file, use that.
-  // Otherwise, prompt user to select repositories from the `codeQL.remoteRepositoryLists` setting.
+  // Otherwise, prompt user to select repositories from the `codeQL.remoteQueries.repositoryLists` setting.
   if (await fs.pathExists(repositoriesFile)) {
     void logger.log(`Found '${repositoriesFile}'. Using information from that file to run ${queryFile}.`);
 
@@ -107,18 +104,44 @@ export async function runRemoteQuery(cliServer: cli.CodeQLCliServer, credentials
     return; // No error message needed, since `getRepositories` already displays one.
   }
 
-  await runRemoteQueriesApiRequest(credentials, ref, language, repositories, query);
+  // Get the controller repo from the config, if it exists.
+  // If it doesn't exist, prompt the user to enter it, and save that value to the config.
+  let controllerRepo: string | undefined;
+  controllerRepo = getRemoteControllerRepo();
+  if (!controllerRepo || !REPO_REGEX.test(controllerRepo)) {
+    void logger.log(controllerRepo ? 'Invalid controller repository name.' : 'No controller repository defined.');
+    controllerRepo = await window.showInputBox({
+      title: 'Controller repository in which to display progress and results of remote queries',
+      placeHolder: '<owner>/<repo>',
+      prompt: 'Enter the name of a GitHub repository in the format <owner>/<repo>',
+      ignoreFocusOut: true,
+    });
+    if (!controllerRepo) {
+      void showAndLogErrorMessage('No controller repository entered.');
+      return;
+    } else if (!REPO_REGEX.test(controllerRepo)) { // Check if user entered invalid input
+      void showAndLogErrorMessage('Invalid repository format. Must be a valid GitHub repository in the format <owner>/<repo>.');
+      return;
+    }
+    void logger.log(`Setting the controller repository as: ${controllerRepo}`);
+    await setRemoteControllerRepo(controllerRepo);
+  }
+
+  void logger.log(`Using controller repository: ${controllerRepo}`);
+  const [owner, repo] = controllerRepo.split('/');
+
+  await runRemoteQueriesApiRequest(credentials, ref, language, repositories, query, owner, repo);
 }
 
-async function runRemoteQueriesApiRequest(credentials: Credentials, ref: string, language: string, repositories: string[], query: string) {
+async function runRemoteQueriesApiRequest(credentials: Credentials, ref: string, language: string, repositories: string[], query: string, owner: string, repo: string) {
   const octokit = await credentials.getOctokit();
 
   try {
     await octokit.request(
       'POST /repos/:owner/:repo/code-scanning/codeql/queries',
       {
-        owner: OWNER,
-        repo: REPO,
+        owner,
+        repo,
         data: {
           ref: ref,
           language: language,
@@ -127,15 +150,15 @@ async function runRemoteQueriesApiRequest(credentials: Credentials, ref: string,
         }
       }
     );
-    void showAndLogInformationMessage(`Successfully scheduled runs. [Click here to see the progress](https://github.com/${OWNER}/${REPO}/actions).`);
+    void showAndLogInformationMessage(`Successfully scheduled runs. [Click here to see the progress](https://github.com/${owner}/${repo}/actions).`);
 
   } catch (error) {
-    await attemptRerun(error, credentials, ref, language, repositories, query);
+    await attemptRerun(error, credentials, ref, language, repositories, query, owner, repo);
   }
 }
 
 /** Attempts to rerun the query on only the valid repositories */
-export async function attemptRerun(error: any, credentials: Credentials, ref: string, language: string, repositories: string[], query: string) {
+export async function attemptRerun(error: any, credentials: Credentials, ref: string, language: string, repositories: string[], query: string, owner: string, repo: string) {
   if (typeof error.message === 'string' && error.message.includes('Some repositories were invalid')) {
     const invalidRepos = error?.response?.data?.invalid_repos || [];
     const reposWithoutDbUploads = error?.response?.data?.repos_without_db_uploads || [];
@@ -158,7 +181,7 @@ export async function attemptRerun(error: any, credentials: Credentials, ref: st
     if (rerunQuery) {
       const validRepositories = repositories.filter(r => !invalidRepos.includes(r) && !reposWithoutDbUploads.includes(r));
       void logger.log(`Rerunning query on set of valid repositories: ${JSON.stringify(validRepositories)}`);
-      await runRemoteQueriesApiRequest(credentials, ref, language, validRepositories, query);
+      await runRemoteQueriesApiRequest(credentials, ref, language, validRepositories, query, owner, repo);
     }
 
   } else {

extensions/ql-vscode/src/vscode-tests/no-workspace/run-remote-query.test.ts

@@ -126,6 +126,8 @@ describe('run-remote-query', function() {
     const language = 'javascript';
     const credentials = getMockCredentials(0);
     const query = 'select 1';
+    const owner = 'owner';
+    const repo = 'repo';
 
     beforeEach(() => {
       sandbox = sinon.createSandbox();
@@ -152,7 +154,7 @@ describe('run-remote-query', function() {
       const repositories = ['abc/def', 'ghi/jkl', 'mno/pqr', 'stu/vwx'];
 
       // make the function call
-      await mod.attemptRerun(error, credentials, ref, language, repositories, query);
+      await mod.attemptRerun(error, credentials, ref, language, repositories, query, owner, repo);
 
       // check logging output
       expect(logSpy.firstCall.args[0]).to.contain('Unable to run query');
@@ -168,7 +170,7 @@ describe('run-remote-query', function() {
       showInformationMessageWithActionSpy.resolves(true);
 
       // make the function call
-      await mod.attemptRerun(error, credentials, ref, language, repositories, query);
+      await mod.attemptRerun(error, credentials, ref, language, repositories, query, owner, repo);
 
       // check logging output
       expect(logSpy.firstCall.args[0]).to.contain('Unable to run query');