Move pack setup out of fetch queries.

Author: starcke

extensions/ql-vscode/src/data-extensions-editor/data-extensions-editor-module.ts

@@ -9,22 +9,16 @@ import { join } from "path";
 import { App } from "../common/app";
 import { withProgress } from "../common/vscode/progress";
 import { pickExtensionPack } from "./extension-pack-picker";
-import {
-  showAndLogErrorMessage,
-  showAndLogExceptionWithTelemetry,
-} from "../common/logging";
+import { showAndLogErrorMessage } from "../common/logging";
 import { dir } from "tmp-promise";
-import { fetchExternalApiQueries } from "./queries";
-import { telemetryListener } from "../common/vscode/telemetry";
-import { redactableError } from "../common/errors";
-import { extLogger } from "../common/logging/vscode";
+
 import { isQueryLanguage } from "../common/query-language";
-import { setUpPack } from "./external-api-usage-queries";
 import { DisposableObject } from "../common/disposable-object";
 import { ModelDetailsPanel } from "./model-details/model-details-panel";
 import { Mode } from "./shared/mode";
 import { showResolvableLocation } from "../databases/local-databases/locations";
 import { Usage } from "./external-api-usage";
+import { setUpPack } from "./data-extensions-editor-queries";
 
 const SUPPORTED_LANGUAGES: string[] = ["java", "csharp"];
 
@@ -138,19 +132,12 @@ export class DataExtensionsEditorModule extends DisposableObject {
               return;
             }
 
-            const query = fetchExternalApiQueries[language];
-            if (!query) {
-              void showAndLogExceptionWithTelemetry(
-                extLogger,
-                telemetryListener,
-                redactableError`No external API usage query found for language ${language}`,
-              );
-              return;
-            }
-
             // Create new temporary directory for query files and pack dependencies
             const queryDir = (await dir({ unsafeCleanup: true })).path;
-            await setUpPack(queryDir, query, language);
+            const success = await setUpPack(queryDir, language);
+            if (!success) {
+              return;
+            }
             await this.cliServer.packInstall(queryDir);
 
             const view = new DataExtensionsEditorView(

extensions/ql-vscode/src/data-extensions-editor/data-extensions-editor-queries.ts

@@ -0,0 +1,38 @@
+import { join } from "path";
+import { QueryLanguage } from "../common/query-language";
+import { writeFile } from "fs-extra";
+import { dump } from "js-yaml";
+import { prepareExternalApiQuery } from "./external-api-usage-queries";
+
+/**
+ * setUpPack sets up a directory to use for the data extension editor queries.
+ * @param queryDir The directory to set up.
+ * @param language The language to use for the queries.
+ * @returns true if the setup was successful, false otherwise.
+ */
+export async function setUpPack(
+  queryDir: string,
+  language: QueryLanguage,
+): Promise<boolean> {
+  // Create the external API query
+  const externalApiQuerySuccess = await prepareExternalApiQuery(
+    queryDir,
+    language,
+  );
+  if (!externalApiQuerySuccess) {
+    return false;
+  }
+
+  // Set up a synthetic query pack to resolve dependencies.
+  const syntheticQueryPack = {
+    name: "codeql/external-api-usage",
+    version: "0.0.0",
+    dependencies: {
+      [`codeql/${language}-all`]: "*",
+    },
+  };
+
+  const qlpackFile = join(queryDir, "codeql-pack.yml");
+  await writeFile(qlpackFile, dump(syntheticQueryPack), "utf8");
+  return true;
+}

extensions/ql-vscode/src/data-extensions-editor/external-api-usage-queries.ts

@@ -12,9 +12,8 @@ import { telemetryListener } from "../common/vscode/telemetry";
 import { join } from "path";
 import { Mode } from "./shared/mode";
 import { writeFile } from "fs-extra";
-import { Query } from "./queries/query";
 import { QueryLanguage } from "../common/query-language";
-import { dump } from "js-yaml";
+import { fetchExternalApiQueries } from "./queries";
 
 type RunQueryOptions = {
   cliServer: Pick<CodeQLCliServer, "resolveQlpacks">;
@@ -27,36 +26,34 @@ type RunQueryOptions = {
   token: CancellationToken;
 };
 
-export async function setUpPack(
+export async function prepareExternalApiQuery(
   queryDir: string,
-  query: Query,
   language: QueryLanguage,
-) {
-  Object.values(Mode).map(async (mode) => {
-    const queryFile = join(
-      queryDir,
-      `FetchExternalApis${mode.charAt(0).toUpperCase() + mode.slice(1)}Mode.ql`,
+): Promise<boolean> {
+  // Resolve the query that we want to run.
+  const query = fetchExternalApiQueries[language];
+  if (!query) {
+    void showAndLogExceptionWithTelemetry(
+      extLogger,
+      telemetryListener,
+      redactableError`No external API usage query found for language ${language}`,
     );
+    return false;
+  }
+  // Create the query file.
+  Object.values(Mode).map(async (mode) => {
+    const queryFile = join(queryDir, queryNameFromMode(mode));
     await writeFile(queryFile, query[`${mode}ModeQuery`], "utf8");
   });
 
+  // Create any dependencies
   if (query.dependencies) {
     for (const [filename, contents] of Object.entries(query.dependencies)) {
       const dependencyFile = join(queryDir, filename);
       await writeFile(dependencyFile, contents, "utf8");
     }
   }
-
-  const syntheticQueryPack = {
-    name: "codeql/external-api-usage",
-    version: "0.0.0",
-    dependencies: {
-      [`codeql/${language}-all`]: "*",
-    },
-  };
-
-  const qlpackFile = join(queryDir, "codeql-pack.yml");
-  await writeFile(qlpackFile, dump(syntheticQueryPack), "utf8");
+  return true;
 }
 
 export async function runQuery(
@@ -145,3 +142,9 @@ export async function readQueryResults({
 
   return cliServer.bqrsDecode(bqrsPath, resultSet.name);
 }
+
+function queryNameFromMode(mode: Mode): string {
+  return `FetchExternalApis${
+    mode.charAt(0).toUpperCase() + mode.slice(1)
+  }Mode.ql`;
+}