Merge pull request #1745 from github/koesie10/extract-remote-query-preparation

Extract remote query preparation to separate method

Author: koesie10

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

@@ -187,72 +187,119 @@ async function getPackedBundlePath(queryPackDir: string) {
   });
 }
 
-export async function runRemoteQuery(
+export interface PreparedRemoteQuery {
+  actionBranch: string;
+  base64Pack: string;
+  repoSelection: RepositorySelection;
+  queryFile: string;
+  queryMetadata: QueryMetadata | undefined;
+  controllerRepo: Repository;
+  queryStartTime: number;
+  language: string;
+}
+
+export async function prepareRemoteQueryRun(
   cliServer: cli.CodeQLCliServer,
   credentials: Credentials,
   uri: Uri | undefined,
-  dryRun: boolean,
+  queryPackDir: string,
   progress: ProgressCallback,
   token: CancellationToken,
-  variantAnalysisManager: VariantAnalysisManager
-): Promise<void | RemoteQuerySubmissionResult> {
+): Promise<PreparedRemoteQuery> {
   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 { remoteQueryDir, queryPackDir } = await createRemoteQueriesTempDirectory();
-  try {
-    if (!uri?.fsPath.endsWith('.ql')) {
-      throw new UserCancellationException('Not a CodeQL query file.');
-    }
+  if (!uri?.fsPath.endsWith('.ql')) {
+    throw new UserCancellationException('Not a CodeQL query file.');
+  }
 
-    const queryFile = uri.fsPath;
+  const queryFile = uri.fsPath;
 
-    progress({
-      maxStep: 4,
-      step: 1,
-      message: 'Determining query target language'
-    });
+  progress({
+    maxStep: 4,
+    step: 1,
+    message: 'Determining query target language'
+  });
 
-    const repoSelection = await getRepositorySelection();
-    if (!isValidSelection(repoSelection)) {
-      throw new UserCancellationException('No repositories to query.');
-    }
+  const repoSelection = await getRepositorySelection();
+  if (!isValidSelection(repoSelection)) {
+    throw new UserCancellationException('No repositories to query.');
+  }
 
-    progress({
-      maxStep: 4,
-      step: 2,
-      message: 'Determining controller repo'
-    });
+  progress({
+    maxStep: 4,
+    step: 2,
+    message: 'Determining controller repo'
+  });
 
-    const controllerRepo = await getControllerRepo(credentials);
+  const controllerRepo = await getControllerRepo(credentials);
 
-    progress({
-      maxStep: 4,
-      step: 3,
-      message: 'Bundling the query pack'
-    });
+  progress({
+    maxStep: 4,
+    step: 3,
+    message: 'Bundling the query pack'
+  });
 
-    if (token.isCancellationRequested) {
-      throw new UserCancellationException('Cancelled');
-    }
+  if (token.isCancellationRequested) {
+    throw new UserCancellationException('Cancelled');
+  }
 
-    const { base64Pack, language } = await generateQueryPack(cliServer, queryFile, queryPackDir);
+  const { base64Pack, language } = await generateQueryPack(cliServer, queryFile, queryPackDir);
 
-    if (token.isCancellationRequested) {
-      throw new UserCancellationException('Cancelled');
-    }
+  if (token.isCancellationRequested) {
+    throw new UserCancellationException('Cancelled');
+  }
 
-    progress({
-      maxStep: 4,
-      step: 4,
-      message: 'Sending request'
-    });
+  progress({
+    maxStep: 4,
+    step: 4,
+    message: 'Sending request'
+  });
 
-    const actionBranch = getActionBranch();
-    const queryStartTime = Date.now();
-    const queryMetadata = await tryGetQueryMetadata(cliServer, queryFile);
+  const actionBranch = getActionBranch();
+  const queryStartTime = Date.now();
+  const queryMetadata = await tryGetQueryMetadata(cliServer, queryFile);
+
+  return {
+    actionBranch,
+    base64Pack,
+    repoSelection,
+    queryFile,
+    queryMetadata,
+    controllerRepo,
+    queryStartTime,
+    language,
+  };
+}
+
+export async function runRemoteQuery(
+  cliServer: cli.CodeQLCliServer,
+  credentials: Credentials,
+  uri: Uri | undefined,
+  dryRun: boolean,
+  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 { remoteQueryDir, queryPackDir } = await createRemoteQueriesTempDirectory();
+  try {
+    const {
+      actionBranch,
+      base64Pack,
+      repoSelection,
+      queryFile,
+      queryMetadata,
+      controllerRepo,
+      queryStartTime,
+      language,
+    } = await prepareRemoteQueryRun(cliServer, credentials, uri, queryPackDir, progress, token);
 
     if (isVariantAnalysisLiveResultsEnabled()) {
       const queryName = getQueryName(queryMetadata, queryFile);