Write toolcache marker file

Author: henrymercer

lib/setup-codeql.js

@@ -23,6 +23,7 @@ import {
   downloadAndExtract,
   getToolcacheDirectory,
   ToolsDownloadStatusReport,
+  writeToolcacheMarkerFile,
 } from "./tools-download";
 import * as util from "./util";
 import { cleanUpGlob, isGoodVersion } from "./util";
@@ -571,31 +572,37 @@ export const downloadCodeQL = async function (
     };
   }
 
-  logger.debug("Caching CodeQL bundle.");
-  const toolcacheStart = performance.now();
-  const toolcachedBundlePath = await toolcache.cacheDir(
-    extractedBundlePath,
-    "CodeQL",
-    toolcacheInfo.version,
-  );
-
-  logger.info(
-    `Added CodeQL bundle to the tool cache (${formatDuration(
-      performance.now() - toolcacheStart,
-    )}).`,
-  );
+  let codeqlFolder = extractedBundlePath;
 
-  // Defensive check: we expect `cacheDir` to copy the bundle to a new location.
-  if (toolcachedBundlePath !== extractedBundlePath) {
-    await cleanUpGlob(
+  if (extractToToolcache) {
+    writeToolcacheMarkerFile(toolcacheInfo.path, logger);
+  } else {
+    logger.debug("Caching CodeQL bundle.");
+    const toolcacheStart = performance.now();
+    codeqlFolder = await toolcache.cacheDir(
       extractedBundlePath,
-      "CodeQL bundle from temporary directory",
-      logger,
+      "CodeQL",
+      toolcacheInfo.version,
+    );
+
+    logger.info(
+      `Added CodeQL bundle to the tool cache (${formatDuration(
+        performance.now() - toolcacheStart,
+      )}).`,
     );
+
+    // Defensive check: we expect `cacheDir` to copy the bundle to a new location.
+    if (codeqlFolder !== extractedBundlePath) {
+      await cleanUpGlob(
+        extractedBundlePath,
+        "CodeQL bundle from temporary directory",
+        logger,
+      );
+    }
   }
 
   return {
-    codeqlFolder: toolcachedBundlePath,
+    codeqlFolder,
     statusReport,
     toolsVersion: maybeCliVersion ?? toolcacheInfo.version,
   };

lib/setup-codeql.js.map

@@ -1,3 +1,4 @@
+import * as fs from "fs";
 import { IncomingMessage, OutgoingHttpHeaders, RequestOptions } from "http";
 import * as os from "os";
 import * as path from "path";
@@ -217,6 +218,15 @@ export function getToolcacheDirectory(version: string): string {
   );
 }
 
+export function writeToolcacheMarkerFile(
+  extractedPath: string,
+  logger: Logger,
+): void {
+  const markerFilePath = `${extractedPath}.complete`;
+  fs.writeFileSync(markerFilePath, "");
+  logger.debug(`Wrote marker file to ${markerFilePath}`);
+}
+
 function sanitizeUrlForStatusReport(url: string): string {
   return ["github/codeql-action", "dsp-testing/codeql-cli-nightlies"].some(
     (repo) => url.startsWith(`https://github.com/${repo}/releases/download/`),