First pass at workflow dispatch

See also: hackathon work from https://github.com/github/vscode-codeql/pull/701/files

Author: shati-patel

extensions/ql-vscode/package-lock.json

@@ -245,6 +245,10 @@
         "command": "codeQL.runQuery",
         "title": "CodeQL: Run Query"
       },
+      {
+        "command": "codeQL.runRemoteQuery",
+        "title": "CodeQL: Run Remote Query"
+      },
       {
         "command": "codeQL.runQueries",
         "title": "CodeQL: Run Queries in Selected Files"
@@ -663,6 +667,10 @@
           "command": "codeQL.runQuery",
           "when": "resourceLangId == ql && resourceExtname == .ql"
         },
+        {
+          "command": "codeQL.runRemoteQuery",
+          "when": "editorLangId == ql && resourceExtname == .ql"
+        },
         {
           "command": "codeQL.runQueries",
           "when": "false"
@@ -805,6 +813,10 @@
           "command": "codeQL.runQuery",
           "when": "editorLangId == ql && resourceExtname == .ql"
         },
+        {
+          "command": "codeQL.runRemoteQuery",
+          "when": "editorLangId == ql && resourceExtname == .ql"
+        },
         {
           "command": "codeQL.viewAst",
           "when": "resourceScheme == codeql-zip-archive"

extensions/ql-vscode/package.json

@@ -7,11 +7,16 @@ const GITHUB_AUTH_PROVIDER_ID = 'github';
 // https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps
 const SCOPES = ['repo'];
 
+interface OctokitAndToken {
+  octokit: Octokit.Octokit;
+  token: string;
+}
+
 /** 
  * Handles authentication to GitHub, using the VS Code [authentication API](https://code.visualstudio.com/api/references/vscode-api#authentication).
  */
 export class Credentials {
-  private octokit: Octokit.Octokit | undefined;
+  private octokitAndToken: OctokitAndToken | undefined;
 
   // Explicitly make the constructor private, so that we can't accidentally call the constructor from outside the class
   // without also initializing the class.
@@ -21,39 +26,56 @@ export class Credentials {
   static async initialize(context: vscode.ExtensionContext): Promise<Credentials> {
     const c = new Credentials();
     c.registerListeners(context);
-    c.octokit = await c.createOctokit(false);
+    c.octokitAndToken = await c.createOctokit(false);
     return c;
   }
 
-  private async createOctokit(createIfNone: boolean): Promise<Octokit.Octokit | undefined> {
+  private async createOctokit(createIfNone: boolean): Promise<OctokitAndToken | undefined> {
     const session = await vscode.authentication.getSession(GITHUB_AUTH_PROVIDER_ID, SCOPES, { createIfNone });
 
-    return session
-      ? new Octokit.Octokit({
-        auth: session.accessToken
-      }) : undefined;
+    if (session) {
+      return {
+        octokit: new Octokit.Octokit({
+          auth: session.accessToken
+        }),
+        token: session.accessToken
+      };
+    } else {
+      return undefined;
+    }
   }
 
   registerListeners(context: vscode.ExtensionContext): void {
     // Sessions are changed when a user logs in or logs out.
     context.subscriptions.push(vscode.authentication.onDidChangeSessions(async e => {
       if (e.provider.id === GITHUB_AUTH_PROVIDER_ID) {
-        this.octokit = await this.createOctokit(false);
+        this.octokitAndToken = await this.createOctokit(false);
       }
     }));
   }
 
   async getOctokit(): Promise<Octokit.Octokit> {
-    if (this.octokit) {
-      return this.octokit;
+    if (this.octokitAndToken) {
+      return this.octokitAndToken.octokit;
     }
 
-    this.octokit = await this.createOctokit(true);
+    this.octokitAndToken = await this.createOctokit(true);
     // octokit shouldn't be undefined, since we've set "createIfNone: true".
     // The following block is mainly here to prevent a compiler error.
-    if (!this.octokit) {
+    if (!this.octokitAndToken) {
+      throw new Error('Did not initialize Octokit.');
+    }
+    return this.octokitAndToken.octokit;
+  }
+
+  async getToken(): Promise<string> {
+    if (this.octokitAndToken) {
+      return this.octokitAndToken.token;
+    }
+    this.octokitAndToken = await this.createOctokit(true);
+    if (!this.octokitAndToken) {
       throw new Error('Did not initialize Octokit.');
     }
-    return this.octokit;
+    return this.octokitAndToken.token;
   }
 }

extensions/ql-vscode/src/authentication.ts

@@ -71,6 +71,7 @@ import {
 import { CodeQlStatusBarHandler } from './status-bar';
 
 import { Credentials } from './authentication';
+import runRemoteQuery from './run-remote-query';
 
 /**
  * extension.ts
@@ -642,6 +643,13 @@ async function activateWithInstalledDistribution(
       }
     )
   );
+  ctx.subscriptions.push(
+    commandRunner('codeQL.runRemoteQuery', async (
+      uri: Uri | undefined
+    ) => {
+      await runRemoteQuery(credentials, uri || window.activeTextEditor?.document.uri);
+    })
+  );
   ctx.subscriptions.push(
     commandRunner(
       'codeQL.openReferencedFile',
@@ -716,7 +724,7 @@ async function activateWithInstalledDistribution(
 
   /**
    * Credentials for authenticating to GitHub.
-   * Currently unused, but will be useful in the future when making API calls.
+   * These are used when making API calls.
    */
   const credentials = await Credentials.initialize(ctx);
 

extensions/ql-vscode/src/extension.ts

@@ -0,0 +1,59 @@
+import { Uri } from 'vscode';
+import * as yaml from 'js-yaml';
+import * as fs from 'fs-extra';
+import { showAndLogErrorMessage, showAndLogInformationMessage } from './helpers';
+import { Credentials } from './authentication';
+
+interface Config {
+  repositories: string[];
+  ref?: string;
+  language: string;
+}
+
+export default async function runRemoteQuery(credentials: Credentials, uri?: Uri) {
+  if (!uri || !uri.fsPath.endsWith('.ql')) {
+    return;
+  }
+
+  const octokit = await credentials.getOctokit();
+  const token = await credentials.getToken();
+
+  const queryFile = uri.fsPath;
+  const query = await fs.readFile(queryFile, 'utf8');
+
+  const repositoriesFile = queryFile.substring(0, queryFile.length - '.ql'.length) + '.repositories';
+  if (!(await fs.pathExists(repositoriesFile))) {
+    void showAndLogErrorMessage(`Missing file: '${repositoriesFile}' to specify the repositories to run against.`);
+    return;
+  }
+
+  const config = yaml.safeLoad(await fs.readFile(repositoriesFile, 'utf8')) as Config;
+
+  const ref = config.ref || 'main';
+  const language = config.language;
+  const repositories = JSON.stringify(config.repositories);
+
+  // Test "controller" repository and workflow.
+  const owner = 'dsp-testing';
+  const repo = 'qc-controller';
+  const workflow_id = 'codeql-query.yml';
+
+  try {
+    await octokit.rest.actions.createWorkflowDispatch({
+      owner: owner,
+      repo: repo,
+      workflow_id: workflow_id,
+      ref: ref,
+      inputs: {
+        language,
+        repositories,
+        query,
+        token
+      }
+    });
+    void showAndLogInformationMessage(`Successfully scheduled runs. [Click here to see the progress](https://github.com/${owner}/${repo}/actions).`);
+
+  } catch (error) {
+    void showAndLogErrorMessage(error);
+  }
+}