Merge pull request #1748 from github/koesie10/reduce-nesting-remote-query

Reduce nesting in `runRemoteQuery`

Author: koesie10

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

@@ -46,17 +46,19 @@ export interface QlPack {
  */
 const QUERY_PACK_NAME = 'codeql-remote/query';
 
+export interface GeneratedQueryPack {
+  base64Pack: string,
+  language: string
+}
+
 /**
  * Two possibilities:
  * 1. There is no qlpack.yml in this directory. Assume this is a lone query and generate a synthetic qlpack for it.
  * 2. There is a qlpack.yml in this directory. Assume this is a query pack and use the yml to pack the query before uploading it.
  *
  * @returns the entire qlpack as a base64 string.
  */
-async function generateQueryPack(cliServer: cli.CodeQLCliServer, queryFile: string, queryPackDir: string): Promise<{
-  base64Pack: string,
-  language: string
-}> {
+async function generateQueryPack(cliServer: cli.CodeQLCliServer, queryFile: string, queryPackDir: string): Promise<GeneratedQueryPack> {
   const originalPackRoot = await findPackRoot(queryFile);
   const packRelativePath = path.relative(originalPackRoot, queryFile);
   const targetQueryFileName = path.join(queryPackDir, packRelativePath);
@@ -192,7 +194,6 @@ export async function prepareRemoteQueryRun(
   cliServer: cli.CodeQLCliServer,
   credentials: Credentials,
   uri: Uri | undefined,
-  queryPackDir: string,
   progress: ProgressCallback,
   token: CancellationToken,
 ): Promise<PreparedRemoteQuery> {
@@ -236,7 +237,17 @@ export async function prepareRemoteQueryRun(
     throw new UserCancellationException('Cancelled');
   }
 
-  const { base64Pack, language } = await generateQueryPack(cliServer, queryFile, queryPackDir);
+  const { remoteQueryDir, queryPackDir } = await createRemoteQueriesTempDirectory();
+
+  let pack: GeneratedQueryPack;
+
+  try {
+    pack = await generateQueryPack(cliServer, queryFile, queryPackDir);
+  } finally {
+    await remoteQueryDir.cleanup();
+  }
+
+  const { base64Pack, language } = pack;
 
   if (token.isCancellationRequested) {
     throw new UserCancellationException('Cancelled');
@@ -277,87 +288,81 @@ export async function runRemoteQuery(
       } 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);
+  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}`);
-      }
+  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 queryText = await fs.readFile(queryFile, 'utf8');
 
-      const variantAnalysisResponse = await ghApiClient.submitVariantAnalysis(
-        credentials,
-        variantAnalysisSubmission
-      );
+    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 processedVariantAnalysis = processVariantAnalysis(variantAnalysisSubmission, variantAnalysisResponse);
+    const variantAnalysisResponse = await ghApiClient.submitVariantAnalysis(
+      credentials,
+      variantAnalysisSubmission
+    );
 
-      await variantAnalysisManager.onVariantAnalysisSubmitted(processedVariantAnalysis);
+    const processedVariantAnalysis = processVariantAnalysis(variantAnalysisSubmission, variantAnalysisResponse);
 
-      void logger.log(`Variant analysis:\n${JSON.stringify(processedVariantAnalysis, null, 2)}`);
+    await variantAnalysisManager.onVariantAnalysisSubmitted(processedVariantAnalysis);
 
-      void showAndLogInformationMessage(`Variant analysis ${processedVariantAnalysis.query.name} submitted for processing`);
+    void logger.log(`Variant analysis:\n${JSON.stringify(processedVariantAnalysis, null, 2)}`);
 
-      void commands.executeCommand('codeQL.openVariantAnalysisView', processedVariantAnalysis.id);
-      void commands.executeCommand('codeQL.monitorVariantAnalysis', processedVariantAnalysis);
+    void showAndLogInformationMessage(`Variant analysis ${processedVariantAnalysis.query.name} submitted for processing`);
 
-      return { variantAnalysis: processedVariantAnalysis };
-    } else {
-      const apiResponse = await runRemoteQueriesApiRequest(credentials, actionBranch, language, repoSelection, controllerRepo, base64Pack);
+    void commands.executeCommand('codeQL.openVariantAnalysisView', processedVariantAnalysis.id);
+    void commands.executeCommand('codeQL.monitorVariantAnalysis', processedVariantAnalysis);
 
-      if (!apiResponse) {
-        return;
-      }
+    return { variantAnalysis: processedVariantAnalysis };
+  } else {
+    const apiResponse = await runRemoteQueriesApiRequest(credentials, actionBranch, language, repoSelection, controllerRepo, base64Pack);
 
-      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 };
+    if (!apiResponse) {
+      return;
     }
 
-  } finally {
-    await remoteQueryDir.cleanup();
+    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 };
   }
 }