Allow cancelling pack download

Author: koesie10

extensions/ql-vscode/src/codeql-cli/cli.ts

@@ -480,12 +480,7 @@ export class CodeQLCliServer implements Disposable {
       });
 
       return await this.handleProcessOutput(process, {
-        handleNullTerminator: true,
-        onListenStart: (process) => {
-          // Write the command followed by a null terminator.
-          process.stdin.write(JSON.stringify(args), "utf8");
-          process.stdin.write(this.nullBuffer);
-        },
+        handleNullTerminator: false,
         description,
         args,
         silent,
@@ -1587,12 +1582,20 @@ export class CodeQLCliServer implements Disposable {
   /**
    * Downloads a specified pack.
    * @param packs The `<package-scope/name[@version]>` of the packs to download.
+   * @param token The cancellation token. If not specified, the command will be run in the CLI server.
    */
-  async packDownload(packs: string[]): Promise<PackDownloadResult> {
+  async packDownload(
+    packs: string[],
+    token?: CancellationToken,
+  ): Promise<PackDownloadResult> {
     return this.runJsonCodeQlCliCommandWithAuthentication(
       ["pack", "download"],
       packs,
       "Downloading packs",
+      {
+        runInNewProcess: !!token, // Only run in a new process if a token is provided
+        token,
+      },
     );
   }
 

extensions/ql-vscode/src/model-editor/model-evaluator.ts

@@ -58,6 +58,7 @@ export class ModelEvaluator extends DisposableObject {
       this.app.logger,
       this.cliServer,
       this.language,
+      this.cancellationSource.token,
     );
 
     if (!qlPack) {

extensions/ql-vscode/src/variant-analysis/code-scanning-pack.ts

@@ -9,16 +9,18 @@ import type { QlPackDetails } from "./ql-pack-details";
 import { getQlPackFilePath } from "../common/ql";
 import type { SuiteInstruction } from "../packaging/suite-instruction";
 import { SARIF_RESULTS_QUERY_KINDS } from "../common/query-metadata";
+import type { CancellationToken } from "vscode";
 
 export async function resolveCodeScanningQueryPack(
   logger: BaseLogger,
   cliServer: CodeQLCliServer,
   language: QueryLanguage,
+  token: CancellationToken,
 ): Promise<QlPackDetails> {
   // Get pack
   void logger.log(`Downloading pack for language: ${language}`);
   const packName = `codeql/${language}-queries`;
-  const packDownloadResult = await cliServer.packDownload([packName]);
+  const packDownloadResult = await cliServer.packDownload([packName], token);
   const downloadedPack = packDownloadResult.packs[0];
 
   const packDir = join(

extensions/ql-vscode/src/variant-analysis/variant-analysis-manager.ts

@@ -245,6 +245,7 @@ export class VariantAnalysisManager
           this.app.logger,
           this.cliServer,
           language,
+          token,
         );
 
         await this.runVariantAnalysis(

extensions/ql-vscode/test/vscode-tests/cli-integration/variant-analysis/code-scanning-pack.test.ts

@@ -1,3 +1,4 @@
+import { CancellationTokenSource } from "vscode";
 import type { CodeQLCliServer } from "../../../../src/codeql-cli/cli";
 import type { App } from "../../../../src/common/app";
 import { QueryLanguage } from "../../../../src/common/query-language";
@@ -20,6 +21,7 @@ describe("Code Scanning pack", () => {
       app.logger,
       cli,
       QueryLanguage.Javascript,
+      new CancellationTokenSource().token,
     );
     // Should include queries. Just check that at least one known query exists.
     // It doesn't particularly matter which query we check for.