Improve clean up if extraction fails

src/setup-codeql.ts

@@ -4,7 +4,6 @@ import * as path from "path";
 import { performance } from "perf_hooks";
 
 import * as toolcache from "@actions/tool-cache";
-import del from "del";
 import { default as deepEqual } from "fast-deep-equal";
 import * as semver from "semver";
 import { v4 as uuidV4 } from "uuid";
@@ -24,7 +23,7 @@ import {
 import { Logger } from "./logging";
 import * as tar from "./tar";
 import * as util from "./util";
-import { isGoodVersion } from "./util";
+import { cleanUpGlob, isGoodVersion } from "./util";
 
 export enum ToolsSource {
   Unknown = "UNKNOWN",
@@ -550,18 +549,25 @@ export const downloadCodeQL = async function (
     `Finished downloading CodeQL bundle to ${archivedBundlePath} (${downloadDurationMs} ms).`,
   );
 
-  logger.debug("Extracting CodeQL bundle.");
-  const extractionStart = performance.now();
-  const extractedBundlePath = await tar.extract(
-    archivedBundlePath,
-    compressionMethod,
-    tarVersion,
-  );
-  const extractionDurationMs = Math.round(performance.now() - extractionStart);
-  logger.debug(
-    `Finished extracting CodeQL bundle to ${extractedBundlePath} (${extractionDurationMs} ms).`,
-  );
-  await cleanUpGlob(archivedBundlePath, "CodeQL bundle archive", logger);
+  let extractedBundlePath: string;
+  let extractionDurationMs: number;
+
+  try {
+    logger.debug("Extracting CodeQL bundle.");
+    const extractionStart = performance.now();
+    extractedBundlePath = await tar.extract(
+      archivedBundlePath,
+      compressionMethod,
+      tarVersion,
+      logger,
+    );
+    extractionDurationMs = Math.round(performance.now() - extractionStart);
+    logger.debug(
+      `Finished extracting CodeQL bundle to ${extractedBundlePath} (${extractionDurationMs} ms).`,
+    );
+  } finally {
+    await cleanUpGlob(archivedBundlePath, "CodeQL bundle archive", logger);
+  }
 
   const bundleVersion =
     maybeBundleVersion ?? tryGetBundleVersionFromUrl(codeqlURL, logger);
@@ -765,6 +771,7 @@ async function setupCodeQLBundleWithCompressionMethod(
         source.codeqlTarPath,
         compressionMethod,
         zstdAvailability.version,
+        logger,
       );
       toolsSource = ToolsSource.Local;
       break;
@@ -802,24 +809,6 @@ async function setupCodeQLBundleWithCompressionMethod(
   };
 }
 
-async function cleanUpGlob(glob: string, name: string, logger: Logger) {
-  logger.debug(`Cleaning up ${name}.`);
-  try {
-    const deletedPaths = await del(glob, { force: true });
-    if (deletedPaths.length === 0) {
-      logger.warning(
-        `Failed to clean up ${name}: no files found matching ${glob}.`,
-      );
-    } else if (deletedPaths.length === 1) {
-      logger.debug(`Cleaned up ${name}.`);
-    } else {
-      logger.debug(`Cleaned up ${name} (${deletedPaths.length} files).`);
-    }
-  } catch (e) {
-    logger.warning(`Failed to clean up ${name}: ${e}.`);
-  }
-}
-
 function sanitizeUrlForStatusReport(url: string): string {
   return ["github/codeql-action", "dsp-testing/codeql-cli-nightlies"].some(
     (repo) => url.startsWith(`https://github.com/${repo}/releases/download/`),

src/tar.ts

@@ -8,7 +8,7 @@ import { v4 as uuidV4 } from "uuid";
 
 import { getTemporaryDirectory, runTool } from "./actions-util";
 import { Logger } from "./logging";
-import { assertNever } from "./util";
+import { assertNever, cleanUpGlob } from "./util";
 
 const MIN_REQUIRED_BSD_TAR_VERSION = "3.4.3";
 const MIN_REQUIRED_GNU_TAR_VERSION = "1.31";
@@ -92,6 +92,7 @@ export async function extract(
   tarPath: string,
   compressionMethod: CompressionMethod,
   tarVersion: TarVersion | undefined,
+  logger: Logger,
 ): Promise<string> {
   switch (compressionMethod) {
     case "gzip":
@@ -104,7 +105,7 @@ export async function extract(
           "Could not determine tar version, which is required to extract a Zstandard archive.",
         );
       }
-      return await extractTarZst(tarPath, tarVersion);
+      return await extractTarZst(tarPath, tarVersion, logger);
   }
 }
 
@@ -118,6 +119,7 @@ export async function extract(
 export async function extractTarZst(
   file: string,
   tarVersion: TarVersion,
+  logger: Logger,
 ): Promise<string> {
   if (!file) {
     throw new Error("parameter 'file' is required");
@@ -126,29 +128,34 @@ export async function extractTarZst(
   // Create dest
   const dest = await createExtractFolder();
 
-  // Initialize args
-  const args = ["-x", "-v"];
+  try {
+    // Initialize args
+    const args = ["-x", "-v"];
 
-  let destArg = dest;
-  let fileArg = file;
-  if (process.platform === "win32" && tarVersion.type === "gnu") {
-    args.push("--force-local");
-    destArg = dest.replace(/\\/g, "/");
+    let destArg = dest;
+    let fileArg = file;
+    if (process.platform === "win32" && tarVersion.type === "gnu") {
+      args.push("--force-local");
+      destArg = dest.replace(/\\/g, "/");
 
-    // Technically only the dest needs to have `/` but for aesthetic consistency
-    // convert slashes in the file arg too.
-    fileArg = file.replace(/\\/g, "/");
+      // Technically only the dest needs to have `/` but for aesthetic consistency
+      // convert slashes in the file arg too.
+      fileArg = file.replace(/\\/g, "/");
+    }
+
+    if (tarVersion.type === "gnu") {
+      // Suppress warnings when using GNU tar to extract archives created by BSD tar
+      args.push("--warning=no-unknown-keyword");
+      args.push("--overwrite");
+    }
+
+    args.push("-C", destArg, "-f", fileArg);
+    await runTool(`tar`, args);
+  } catch (e) {
+    await cleanUpGlob(dest, "extraction destination directory", logger);
+    throw e;
   }
 
-  if (tarVersion.type === "gnu") {
-    // Suppress warnings when using GNU tar to extract archives created by BSD tar
-    args.push("--warning=no-unknown-keyword");
-    args.push("--overwrite");
-  }
-
-  args.push("-C", destArg, "-f", fileArg);
-  await runTool(`tar`, args);
-
   return dest;
 }
 

src/util.ts

@@ -1161,3 +1161,21 @@ export async function checkSipEnablement(
     return undefined;
   }
 }
+
+export async function cleanUpGlob(glob: string, name: string, logger: Logger) {
+  logger.debug(`Cleaning up ${name}.`);
+  try {
+    const deletedPaths = await del(glob, { force: true });
+    if (deletedPaths.length === 0) {
+      logger.warning(
+        `Failed to clean up ${name}: no files found matching ${glob}.`,
+      );
+    } else if (deletedPaths.length === 1) {
+      logger.debug(`Cleaned up ${name}.`);
+    } else {
+      logger.debug(`Cleaned up ${name} (${deletedPaths.length} files).`);
+    }
+  } catch (e) {
+    logger.warning(`Failed to clean up ${name}: ${e}.`);
+  }
+}