Split flows for running remote queries

This removes the `runRemoteQuery` method and instead moves all logic
specific to remote queries/variant analysis to the remote queries
manager and variant analysis manager respectively. This will make it
easier to completely remove the remote queries manager in the future.

Author: koesie10

extensions/ql-vscode/src/extension.ts

@@ -33,6 +33,7 @@ import {
   CliConfigListener,
   DistributionConfigListener,
   isCanary,
+  isVariantAnalysisLiveResultsEnabled,
   joinOrderWarningThreshold,
   MAX_QUERIES,
   QueryHistoryConfigListener,
@@ -489,13 +490,13 @@ async function activateWithInstalledDistribution(
   const variantAnalysisStorageDir = path.join(ctx.globalStorageUri.fsPath, 'variant-analyses');
   await fs.ensureDir(variantAnalysisStorageDir);
   const variantAnalysisResultsManager = new VariantAnalysisResultsManager(cliServer, logger);
-  const variantAnalysisManager = new VariantAnalysisManager(ctx, variantAnalysisStorageDir, variantAnalysisResultsManager);
+  const variantAnalysisManager = new VariantAnalysisManager(ctx, cliServer, variantAnalysisStorageDir, variantAnalysisResultsManager);
   ctx.subscriptions.push(variantAnalysisManager);
   ctx.subscriptions.push(variantAnalysisResultsManager);
   ctx.subscriptions.push(workspace.registerTextDocumentContentProvider('codeql-variant-analysis', createVariantAnalysisContentProvider(variantAnalysisManager)));
 
   void logger.log('Initializing remote queries manager.');
-  const rqm = new RemoteQueriesManager(ctx, cliServer, queryStorageDir, logger, variantAnalysisManager);
+  const rqm = new RemoteQueriesManager(ctx, cliServer, queryStorageDir, logger);
   ctx.subscriptions.push(rqm);
 
   void logger.log('Initializing query history.');
@@ -906,11 +907,20 @@ async function activateWithInstalledDistribution(
           step: 0,
           message: 'Getting credentials'
         });
-        await rqm.runRemoteQuery(
-          uri || window.activeTextEditor?.document.uri,
-          progress,
-          token
-        );
+
+        if (isVariantAnalysisLiveResultsEnabled()) {
+          await variantAnalysisManager.runVariantAnalysis(
+            uri || window.activeTextEditor?.document.uri,
+            progress,
+            token
+          );
+        } else {
+          await rqm.runRemoteQuery(
+            uri || window.activeTextEditor?.document.uri,
+            progress,
+            token
+          );
+        }
       } else {
         throw new Error('Variant analysis requires the CodeQL Canary version to run.');
       }

extensions/ql-vscode/src/remote-queries/remote-queries-manager.ts

@@ -1,4 +1,4 @@
-import { CancellationToken, commands, EventEmitter, ExtensionContext, Uri, env, window } from 'vscode';
+import { CancellationToken, commands, EventEmitter, ExtensionContext, Uri, env } from 'vscode';
 import { nanoid } from 'nanoid';
 import * as path from 'path';
 import * as fs from 'fs-extra';
@@ -9,7 +9,11 @@ import { CodeQLCliServer } from '../cli';
 import { ProgressCallback } from '../commandRunner';
 import { createTimestampFile, showAndLogErrorMessage, showAndLogInformationMessage, showInformationMessageWithAction } from '../helpers';
 import { Logger } from '../logging';
-import { runRemoteQuery } from './run-remote-query';
+import {
+  buildRemoteQueryEntity,
+  prepareRemoteQueryRun,
+  runRemoteQueriesApiRequest,
+} from './run-remote-query';
 import { RemoteQueriesView } from './remote-queries-view';
 import { RemoteQuery } from './remote-query';
 import { RemoteQueriesMonitor } from './remote-queries-monitor';
@@ -22,7 +26,6 @@ import { assertNever } from '../pure/helpers-pure';
 import { QueryStatus } from '../query-status';
 import { DisposableObject } from '../pure/disposable-object';
 import { AnalysisResults } from './shared/analysis-result';
-import { VariantAnalysisManager } from './variant-analysis-manager';
 
 const autoDownloadMaxSize = 300 * 1024;
 const autoDownloadMaxCount = 100;
@@ -57,21 +60,18 @@ export class RemoteQueriesManager extends DisposableObject {
 
   private readonly remoteQueriesMonitor: RemoteQueriesMonitor;
   private readonly analysesResultsManager: AnalysesResultsManager;
-  private readonly variantAnalysisManager: VariantAnalysisManager;
   private readonly view: RemoteQueriesView;
 
   constructor(
     private readonly ctx: ExtensionContext,
     private readonly cliServer: CodeQLCliServer,
     private readonly storagePath: string,
     logger: Logger,
-    variantAnalysisManager: VariantAnalysisManager,
   ) {
     super();
     this.analysesResultsManager = new AnalysesResultsManager(ctx, cliServer, storagePath, logger);
     this.view = new RemoteQueriesView(ctx, logger, this.analysesResultsManager);
     this.remoteQueriesMonitor = new RemoteQueriesMonitor(ctx, logger);
-    this.variantAnalysisManager = variantAnalysisManager;
 
     this.remoteQueryAddedEventEmitter = this.push(new EventEmitter<NewQueryEvent>());
     this.remoteQueryRemovedEventEmitter = this.push(new EventEmitter<RemovedQueryEvent>());
@@ -119,21 +119,47 @@ export class RemoteQueriesManager extends DisposableObject {
     uri: Uri | undefined,
     progress: ProgressCallback,
     token: CancellationToken
-  ): Promise<void> {
+  ): Promise<RemoteQuery | undefined> {
     const credentials = await Credentials.initialize(this.ctx);
 
-    const querySubmission = await runRemoteQuery(this.cliServer, credentials, uri || window.activeTextEditor?.document.uri, progress, token, this.variantAnalysisManager);
+    const {
+      actionBranch,
+      base64Pack,
+      repoSelection,
+      queryFile,
+      queryMetadata,
+      controllerRepo,
+      queryStartTime,
+      language,
+    } = await prepareRemoteQueryRun(this.cliServer, credentials, uri, progress, token);
+
+    const apiResponse = await runRemoteQueriesApiRequest(credentials, actionBranch, language, repoSelection, controllerRepo, base64Pack);
+
+    if (!apiResponse) {
+      return undefined;
+    }
 
-    if (querySubmission?.query) {
-      const query = querySubmission.query;
-      const queryId = this.createQueryId();
+    const workflowRunId = apiResponse.workflow_run_id;
+    const repositoryCount = apiResponse.repositories_queried.length;
+    const query = await buildRemoteQueryEntity(
+      queryFile,
+      queryMetadata,
+      controllerRepo,
+      queryStartTime,
+      workflowRunId,
+      language,
+      repositoryCount
+    );
 
-      await this.prepareStorageDirectory(queryId);
-      await this.storeJsonFile(queryId, 'query.json', query);
+    const queryId = this.createQueryId();
 
-      this.remoteQueryAddedEventEmitter.fire({ queryId, query });
-      void commands.executeCommand('codeQL.monitorRemoteQuery', queryId, query);
-    }
+    await this.prepareStorageDirectory(queryId);
+    await this.storeJsonFile(queryId, 'query.json', query);
+
+    this.remoteQueryAddedEventEmitter.fire({ queryId, query });
+    void commands.executeCommand('codeQL.monitorRemoteQuery', queryId, query);
+
+    return query;
   }
 
   public async monitorRemoteQuery(

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

@@ -1,4 +1,4 @@
-import { CancellationToken, commands, Uri, window } from 'vscode';
+import { CancellationToken, Uri, window } from 'vscode';
 import * as path from 'path';
 import * as yaml from 'js-yaml';
 import * as fs from 'fs-extra';
@@ -16,22 +16,17 @@ import {
 import { Credentials } from '../authentication';
 import * as cli from '../cli';
 import { logger } from '../logging';
-import { getActionBranch, getRemoteControllerRepo, isVariantAnalysisLiveResultsEnabled, setRemoteControllerRepo } from '../config';
+import { getActionBranch, getRemoteControllerRepo, setRemoteControllerRepo } from '../config';
 import { ProgressCallback, UserCancellationException } from '../commandRunner';
 import { RequestError } from '@octokit/types/dist-types';
 import { RemoteQuery } from './remote-query';
-import { RemoteQuerySubmissionResult } from './remote-query-submission-result';
 import { QueryMetadata } from '../pure/interface-types';
 import { getErrorMessage, REPO_REGEX } from '../pure/helpers-pure';
 import { pluralize } from '../pure/word';
 import * as ghApiClient from './gh-api/gh-api-client';
 import { RemoteQueriesResponse } from './gh-api/remote-queries';
 import { getRepositorySelection, isValidSelection, RepositorySelection } from './repository-selection';
-import { parseVariantAnalysisQueryLanguage, VariantAnalysisSubmission } from './shared/variant-analysis';
 import { Repository } from './shared/repository';
-import { processVariantAnalysis } from './variant-analysis-processor';
-import { VariantAnalysisManager } from './variant-analysis-manager';
-import { CodeQLCliServer } from '../cli';
 
 export interface QlPack {
   name: string;
@@ -262,98 +257,7 @@ export async function prepareRemoteQueryRun(
   };
 }
 
-export async function runRemoteQuery(
-  cliServer: CodeQLCliServer,
-  credentials: Credentials,
-  uri: Uri | undefined,
-  progress: ProgressCallback,
-  token: CancellationToken,
-  variantAnalysisManager: VariantAnalysisManager,
-): Promise<void | RemoteQuerySubmissionResult> {
-  if (!(await cliServer.cliConstraints.supportsRemoteQueries())) {
-    throw new Error(`Variant analysis is not supported by this version of CodeQL. Please upgrade to v${cli.CliVersionConstraint.CLI_VERSION_REMOTE_QUERIES
-      } or later.`);
-  }
-
-  const {
-    actionBranch,
-    base64Pack,
-    repoSelection,
-    queryFile,
-    queryMetadata,
-    controllerRepo,
-    queryStartTime,
-    language,
-  } = await prepareRemoteQueryRun(cliServer, credentials, uri, progress, token);
-
-  if (isVariantAnalysisLiveResultsEnabled()) {
-    const queryName = getQueryName(queryMetadata, queryFile);
-    const variantAnalysisLanguage = parseVariantAnalysisQueryLanguage(language);
-    if (variantAnalysisLanguage === undefined) {
-      throw new UserCancellationException(`Found unsupported language: ${language}`);
-    }
-
-    const queryText = await fs.readFile(queryFile, 'utf8');
-
-    const variantAnalysisSubmission: VariantAnalysisSubmission = {
-      startTime: queryStartTime,
-      actionRepoRef: actionBranch,
-      controllerRepoId: controllerRepo.id,
-      query: {
-        name: queryName,
-        filePath: queryFile,
-        pack: base64Pack,
-        language: variantAnalysisLanguage,
-        text: queryText,
-      },
-      databases: {
-        repositories: repoSelection.repositories,
-        repositoryLists: repoSelection.repositoryLists,
-        repositoryOwners: repoSelection.owners
-      }
-    };
-
-    const variantAnalysisResponse = await ghApiClient.submitVariantAnalysis(
-      credentials,
-      variantAnalysisSubmission
-    );
-
-    const processedVariantAnalysis = processVariantAnalysis(variantAnalysisSubmission, variantAnalysisResponse);
-
-    await variantAnalysisManager.onVariantAnalysisSubmitted(processedVariantAnalysis);
-
-    void logger.log(`Variant analysis:\n${JSON.stringify(processedVariantAnalysis, null, 2)}`);
-
-    void showAndLogInformationMessage(`Variant analysis ${processedVariantAnalysis.query.name} submitted for processing`);
-
-    void commands.executeCommand('codeQL.openVariantAnalysisView', processedVariantAnalysis.id);
-    void commands.executeCommand('codeQL.monitorVariantAnalysis', processedVariantAnalysis);
-
-    return { variantAnalysis: processedVariantAnalysis };
-  } else {
-    const apiResponse = await runRemoteQueriesApiRequest(credentials, actionBranch, language, repoSelection, controllerRepo, base64Pack);
-
-    if (!apiResponse) {
-      return;
-    }
-
-    const workflowRunId = apiResponse.workflow_run_id;
-    const repositoryCount = apiResponse.repositories_queried.length;
-    const remoteQuery = await buildRemoteQueryEntity(
-      queryFile,
-      queryMetadata,
-      controllerRepo,
-      queryStartTime,
-      workflowRunId,
-      language,
-      repositoryCount);
-
-    // don't return the path because it has been deleted
-    return { query: remoteQuery };
-  }
-}
-
-async function runRemoteQueriesApiRequest(
+export async function runRemoteQueriesApiRequest(
   credentials: Credentials,
   ref: string,
   language: string,
@@ -455,7 +359,7 @@ async function ensureNameAndSuite(queryPackDir: string, packRelativePath: string
   await fs.writeFile(packPath, yaml.dump(qlpack));
 }
 
-async function buildRemoteQueryEntity(
+export async function buildRemoteQueryEntity(
   queryFilePath: string,
   queryMetadata: QueryMetadata | undefined,
   controllerRepo: Repository,
@@ -483,7 +387,7 @@ async function buildRemoteQueryEntity(
   };
 }
 
-function getQueryName(queryMetadata: QueryMetadata | undefined, queryFilePath: string): string {
+export function getQueryName(queryMetadata: QueryMetadata | undefined, queryFilePath: string): string {
   // The query name is either the name as specified in the query metadata, or the file name.
   return queryMetadata?.name ?? path.basename(queryFilePath);
 }