Add missing pack download and fix lock file creation.

Author: starcke

extensions/ql-vscode/src/data-extensions-editor/auto-model-codeml-queries.ts

@@ -84,6 +84,7 @@ export async function runAutoModelQueries({
     extensionPacks,
     progress,
     token: cancellationTokenSource.token,
+    createLockFile: false,
   });
 
   if (!completedQuery) {

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

@@ -134,11 +134,10 @@ export class DataExtensionsEditorModule extends DisposableObject {
 
             // Create new temporary directory for query files and pack dependencies
             const queryDir = (await dir({ unsafeCleanup: true })).path;
-            const success = await setUpPack(queryDir, language);
+            const success = await setUpPack(this.cliServer, queryDir, language);
             if (!success) {
               return;
             }
-            await this.cliServer.packInstall(queryDir);
 
             const view = new DataExtensionsEditorView(
               this.ctx,

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

@@ -3,6 +3,7 @@ import { QueryLanguage } from "../common/query-language";
 import { writeFile } from "fs-extra";
 import { dump } from "js-yaml";
 import { prepareExternalApiQuery } from "./external-api-usage-queries";
+import { CodeQLCliServer } from "../codeql-cli/cli";
 
 /**
  * setUpPack sets up a directory to use for the data extension editor queries.
@@ -11,6 +12,7 @@ import { prepareExternalApiQuery } from "./external-api-usage-queries";
  * @returns true if the setup was successful, false otherwise.
  */
 export async function setUpPack(
+  cliServer: CodeQLCliServer,
   queryDir: string,
   language: QueryLanguage,
 ): Promise<boolean> {
@@ -23,7 +25,7 @@ export async function setUpPack(
     return false;
   }
 
-  // Set up a synthetic query pack to resolve dependencies.
+  // Set up a synthetic pack so that the query can be resolved later.
   const syntheticQueryPack = {
     name: "codeql/external-api-usage",
     version: "0.0.0",
@@ -34,5 +36,10 @@ export async function setUpPack(
 
   const qlpackFile = join(queryDir, "codeql-pack.yml");
   await writeFile(qlpackFile, dump(syntheticQueryPack), "utf8");
+  await cliServer.packInstall(queryDir);
+
+  // Install the other needed query packs
+  await cliServer.packDownload([`codeql/${language}-queries`]);
+
   return true;
 }

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

@@ -94,6 +94,8 @@ export async function runExternalApiQueries(
     extensionPacks,
     progress,
     token,
+    // We need to create a lock file, becuase the query is inside our own pack
+    createLockFile: true,
   });
 
   if (!completedQuery) {

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

@@ -134,6 +134,7 @@ async function runSingleFlowQuery(
         maxStep: 4000,
       }),
     token,
+    createLockFile: false,
   });
 
   if (!completedQuery) {

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

@@ -21,6 +21,7 @@ type RunQueryOptions = {
   extensionPacks: string[] | undefined;
   progress: ProgressCallback;
   token: CancellationToken;
+  createLockFile: boolean;
 };
 
 export async function runQuery({
@@ -33,12 +34,17 @@ export async function runQuery({
   extensionPacks,
   progress,
   token,
+  createLockFile,
 }: RunQueryOptions): Promise<CoreCompletedQuery | undefined> {
-  // Create a lock file for the query. This is required to resolve dependencies and library path for the query.
-  const { cleanup: cleanupLockFile } = await createLockFileForStandardQuery(
-    cliServer,
-    queryPath,
-  );
+  let cleanupLockFile: (() => Promise<void>) | undefined = undefined;
+  if (createLockFile) {
+    // Create a lock file for the query. This is required to resolve dependencies and library path for the query.
+    const { cleanup } = await createLockFileForStandardQuery(
+      cliServer,
+      queryPath,
+    );
+    cleanupLockFile = cleanup;
+  }
 
   // Create a query run to execute
   const queryRun = queryRunner.createQueryRun(

extensions/ql-vscode/test/vscode-tests/no-workspace/data-extensions-editor/auto-model-codeml-queries.test.ts

@@ -14,7 +14,6 @@ import { mockedObject, mockedUri } from "../../utils/mocking.helpers";
 import { CodeQLCliServer } from "../../../../src/codeql-cli/cli";
 import { QueryRunner } from "../../../../src/query-server";
 import * as queryResolver from "../../../../src/local-queries/query-resolver";
-import * as standardQueries from "../../../../src/local-queries/standard-queries";
 import { MethodSignature } from "../../../../src/data-extensions-editor/external-api-usage";
 import { join } from "path";
 import { exists, readFile } from "fs-extra";
@@ -26,10 +25,6 @@ describe("runAutoModelQueries", () => {
   let resolveQueriesSpy: jest.SpiedFunction<
     typeof queryResolver.resolveQueries
   >;
-  let createLockFileForStandardQuerySpy: jest.SpiedFunction<
-    typeof standardQueries.createLockFileForStandardQuery
-  >;
-
   beforeEach(() => {
     resolveQueriesSpy = jest
       .spyOn(queryResolver, "resolveQueries")
@@ -48,10 +43,6 @@ describe("runAutoModelQueries", () => {
           return [];
         },
       );
-
-    createLockFileForStandardQuerySpy = jest
-      .spyOn(standardQueries, "createLockFileForStandardQuery")
-      .mockResolvedValue({});
   });
 
   it("should run the query and return the results", async () => {
@@ -156,11 +147,6 @@ describe("runAutoModelQueries", () => {
         "tags contain all": ["automodel", "application-mode", "candidates"],
       },
     );
-    expect(createLockFileForStandardQuerySpy).toHaveBeenCalledTimes(1);
-    expect(createLockFileForStandardQuerySpy).toHaveBeenCalledWith(
-      options.cliServer,
-      "/a/b/c/ql/candidates.ql",
-    );
     expect(options.queryRunner.createQueryRun).toHaveBeenCalledTimes(1);
     expect(options.queryRunner.createQueryRun).toHaveBeenCalledWith(
       "/a/b/c/src.zip",

extensions/ql-vscode/test/vscode-tests/no-workspace/data-extensions-editor/data-extensions-editor-queries.test.ts

@@ -6,8 +6,15 @@ import { dirSync } from "tmp-promise";
 import { fetchExternalApiQueries } from "../../../../src/data-extensions-editor/queries";
 import { QueryLanguage } from "../../../../src/common/query-language";
 import { Mode } from "../../../../src/data-extensions-editor/shared/mode";
+import { mockedObject } from "../../utils/mocking.helpers";
+import { CodeQLCliServer } from "../../../../src/codeql-cli/cli";
 
 describe("setUpPack", () => {
+  const cliServer = mockedObject<CodeQLCliServer>({
+    packDownload: jest.fn(),
+    packInstall: jest.fn(),
+  });
+
   const languages = Object.keys(fetchExternalApiQueries).flatMap((lang) => {
     const queryDir = dirSync({ unsafeCleanup: true }).name;
     const query = fetchExternalApiQueries[lang as QueryLanguage];
@@ -21,7 +28,7 @@ describe("setUpPack", () => {
   test.each(languages)(
     "should create files for $language",
     async ({ language, queryDir, query }) => {
-      await setUpPack(queryDir, language);
+      await setUpPack(cliServer, queryDir, language);
 
       const queryFiles = await readdir(queryDir);
       expect(queryFiles.sort()).toEqual(