Replace custom tool download method with the one in the tool cache library.

lib/codeql.js

@@ -12,14 +12,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
-const stream = __importStar(require("stream"));
-const globalutil = __importStar(require("util"));
 const toolrunner = __importStar(require("@actions/exec/lib/toolrunner"));
-const http = __importStar(require("@actions/http-client"));
 const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
 const query_string_1 = __importDefault(require("query-string"));
 const semver = __importStar(require("semver"));
-const uuid_1 = require("uuid");
 const actions_util_1 = require("./actions-util");
 const api = __importStar(require("./api-client"));
 const defaults = __importStar(require("./defaults.json")); // Referenced from codeql-action-sync-tool!
@@ -142,21 +138,6 @@ async function getCodeQLBundleDownloadURL(apiDetails, variant, logger) {
     }
     return `https://github.com/${CODEQL_DEFAULT_ACTION_REPOSITORY}/releases/download/${CODEQL_BUNDLE_VERSION}/${codeQLBundleName}`;
 }
-// We have to download CodeQL manually because the toolcache doesn't support Accept headers.
-// This can be removed once https://github.com/actions/toolkit/pull/530 is merged and released.
-async function toolcacheDownloadTool(url, headers, tempDir, logger) {
-    const client = new http.HttpClient("CodeQL Action");
-    const dest = path.join(tempDir, uuid_1.v4());
-    const response = await client.get(url, headers);
-    if (response.message.statusCode !== 200) {
-        logger.info(`Failed to download from "${url}". Code(${response.message.statusCode}) Message(${response.message.statusMessage})`);
-        throw new Error(`Unexpected HTTP response: ${response.message.statusCode}`);
-    }
-    const pipeline = globalutil.promisify(stream.pipeline);
-    fs.mkdirSync(path.dirname(dest), { recursive: true });
-    await pipeline(response.message, fs.createWriteStream(dest));
-    return dest;
-}
 async function setupCodeQL(codeqlURL, apiDetails, tempDir, toolCacheDir, variant, logger) {
     try {
         // We use the special value of 'latest' to prioritize the version in the
@@ -205,7 +186,7 @@ async function setupCodeQL(codeqlURL, apiDetails, tempDir, toolCacheDir, variant
                 logger.debug("Downloading CodeQL bundle without token.");
             }
             logger.info(`Downloading CodeQL tools from ${codeqlURL}. This may take a while.`);
-            const codeqlPath = await toolcacheDownloadTool(codeqlURL, headers, tempDir, logger);
+            const codeqlPath = await toolcache.downloadTool(codeqlURL, tempDir, headers);
             logger.debug(`CodeQL bundle download to ${codeqlPath} complete.`);
             const codeqlExtracted = await toolcache.extractTar(codeqlPath, tempDir, logger);
             codeqlFolder = await toolcache.cacheDir(codeqlExtracted, "CodeQL", codeqlURLSemVer, toolCacheDir, logger);

lib/toolcache.js

@@ -15,6 +15,7 @@ const io = __importStar(require("@actions/io"));
 const actionsToolcache = __importStar(require("@actions/tool-cache"));
 const safeWhich = __importStar(require("@chrisgavin/safe-which"));
 const semver = __importStar(require("semver"));
+const uuid_1 = require("uuid");
 const util_1 = require("./util");
 /*
  * This file acts as an interface to the functionality of the actions toolcache.
@@ -204,6 +205,12 @@ function findAllVersions(toolName, toolCacheDir, logger) {
     }
 }
 exports.findAllVersions = findAllVersions;
+async function downloadTool(url, tempDir, headers) {
+    const dest = path.join(tempDir, uuid_1.v4());
+    const finalHeaders = Object.assign({ "User-Agent": "CodeQL Action" }, headers);
+    return await actionsToolcache.downloadTool(url, dest, undefined, finalHeaders);
+}
+exports.downloadTool = downloadTool;
 function createExtractFolder(tempDir) {
     // create a temp dir
     const dest = path.join(tempDir, "toolcache-temp");

src/codeql.ts

@@ -1,15 +1,11 @@
 import * as fs from "fs";
 import * as path from "path";
-import * as stream from "stream";
-import * as globalutil from "util";
 
 import * as toolrunner from "@actions/exec/lib/toolrunner";
-import * as http from "@actions/http-client";
 import { IHeaders } from "@actions/http-client/interfaces";
 import { default as deepEqual } from "fast-deep-equal";
 import { default as queryString } from "query-string";
 import * as semver from "semver";
-import { v4 as uuidV4 } from "uuid";
 
 import { isRunningLocalAction, getRelativeScriptPath } from "./actions-util";
 import * as api from "./api-client";
@@ -297,29 +293,6 @@ async function getCodeQLBundleDownloadURL(
   return `https://github.com/${CODEQL_DEFAULT_ACTION_REPOSITORY}/releases/download/${CODEQL_BUNDLE_VERSION}/${codeQLBundleName}`;
 }
 
-// We have to download CodeQL manually because the toolcache doesn't support Accept headers.
-// This can be removed once https://github.com/actions/toolkit/pull/530 is merged and released.
-async function toolcacheDownloadTool(
-  url: string,
-  headers: IHeaders | undefined,
-  tempDir: string,
-  logger: Logger
-): Promise<string> {
-  const client = new http.HttpClient("CodeQL Action");
-  const dest = path.join(tempDir, uuidV4());
-  const response: http.HttpClientResponse = await client.get(url, headers);
-  if (response.message.statusCode !== 200) {
-    logger.info(
-      `Failed to download from "${url}". Code(${response.message.statusCode}) Message(${response.message.statusMessage})`
-    );
-    throw new Error(`Unexpected HTTP response: ${response.message.statusCode}`);
-  }
-  const pipeline = globalutil.promisify(stream.pipeline);
-  fs.mkdirSync(path.dirname(dest), { recursive: true });
-  await pipeline(response.message, fs.createWriteStream(dest));
-  return dest;
-}
-
 export async function setupCodeQL(
   codeqlURL: string | undefined,
   apiDetails: api.GitHubApiDetails,
@@ -404,11 +377,10 @@ export async function setupCodeQL(
       logger.info(
         `Downloading CodeQL tools from ${codeqlURL}. This may take a while.`
       );
-      const codeqlPath = await toolcacheDownloadTool(
+      const codeqlPath = await toolcache.downloadTool(
         codeqlURL,
-        headers,
         tempDir,
-        logger
+        headers
       );
       logger.debug(`CodeQL bundle download to ${codeqlPath} complete.`);
 

src/toolcache.ts

@@ -3,10 +3,12 @@ import * as os from "os";
 import * as path from "path";
 
 import * as toolrunner from "@actions/exec/lib/toolrunner";
+import { IHeaders } from "@actions/http-client/interfaces";
 import * as io from "@actions/io";
 import * as actionsToolcache from "@actions/tool-cache";
 import * as safeWhich from "@chrisgavin/safe-which";
 import * as semver from "semver";
+import { v4 as uuidV4 } from "uuid";
 
 import { Logger } from "./logging";
 import { isActions } from "./util";
@@ -224,6 +226,24 @@ export function findAllVersions(
   }
 }
 
+export async function downloadTool(
+  url: string,
+  tempDir: string,
+  headers: IHeaders
+): Promise<string> {
+  const dest = path.join(tempDir, uuidV4());
+  const finalHeaders = Object.assign(
+    { "User-Agent": "CodeQL Action" },
+    headers
+  );
+  return await actionsToolcache.downloadTool(
+    url,
+    dest,
+    undefined,
+    finalHeaders
+  );
+}
+
 function createExtractFolder(tempDir: string): string {
   // create a temp dir
   const dest = path.join(tempDir, "toolcache-temp");