Use the CLI version when caching the bundle in telemetry too

lib/codeql.test.js

@@ -187,7 +187,7 @@ function mockApiDetails(apiDetails) {
         const result = await codeql.setupCodeQL(url, sampleApiDetails, tmpDir, util.GitHubVariant.DOTCOM, false, SAMPLE_DEFAULT_CLI_VERSION, (0, logging_1.getRunnerLogger)(true), false);
         t.assert(releaseApiMock.isDone(), "Releases API should have been called");
         t.assert(toolcache.find("CodeQL", "2.10.0-20200610"));
-        t.deepEqual(result.toolsVersion, "0.0.0-20200610");
+        t.deepEqual(result.toolsVersion, "2.10.0");
     });
 });
 for (const { isCached, tagName, toolcacheCliVersion } of [

lib/setup-codeql.js

@@ -427,13 +427,17 @@ async function downloadCodeQL(codeqlURL, maybeCliVersion, apiDetails, variant, t
     // Try to compute the CLI version for this bundle
     const cliVersion = maybeCliVersion ||
         (variant === util.GitHubVariant.DOTCOM &&
-            (await tryFindCliVersionDotcomOnly(`codeql-bundle-${bundleVersion}`, logger)));
+            (await tryFindCliVersionDotcomOnly(`codeql-bundle-${bundleVersion}`, logger))) ||
+        undefined;
     // Include the bundle version in the toolcache version number so that if the user requests the
     // same URL again, we can get it from the cache without having to call any of the Releases API.
     const toolcacheVersion = cliVersion
         ? `${cliVersion}-${bundleVersion}`
         : convertToSemVer(bundleVersion, logger);
-    return await toolcache.cacheDir(codeqlExtracted, "CodeQL", toolcacheVersion);
+    return {
+        toolsVersion: cliVersion || toolcacheVersion,
+        codeqlFolder: await toolcache.cacheDir(codeqlExtracted, "CodeQL", toolcacheVersion),
+    };
 }
 exports.downloadCodeQL = downloadCodeQL;
 function getCodeQLURLVersion(url) {
@@ -461,6 +465,7 @@ exports.getCodeQLURLVersion = getCodeQLURLVersion;
 async function setupCodeQLBundle(toolsInput, apiDetails, tempDir, variant, bypassToolcache, defaultCliVersion, logger) {
     const source = await getCodeQLSource(toolsInput, bypassToolcache, defaultCliVersion, apiDetails, variant, logger);
     let codeqlFolder;
+    let toolsVersion = source.toolsVersion;
     switch (source.sourceType) {
         case "local":
             codeqlFolder = await toolcache.extractTar(source.codeqlTarPath);
@@ -469,13 +474,16 @@ async function setupCodeQLBundle(toolsInput, apiDetails, tempDir, variant, bypas
             codeqlFolder = source.codeqlFolder;
             logger.debug(`CodeQL found in cache ${codeqlFolder}`);
             break;
-        case "download":
+        case "download": {
-            codeqlFolder = await downloadCodeQL(source.codeqlURL, source.cliVersion, apiDetails, variant, tempDir, logger);
+            const result = await downloadCodeQL(source.codeqlURL, source.cliVersion, apiDetails, variant, tempDir, logger);
+            toolsVersion = result.toolsVersion;
+            codeqlFolder = result.codeqlFolder;
             break;
+        }
         default:
             util.assertNever(source);
     }
-    return { codeqlFolder, toolsVersion: source.toolsVersion };
+    return { codeqlFolder, toolsVersion };
 }
 exports.setupCodeQLBundle = setupCodeQLBundle;
 //# sourceMappingURL=setup-codeql.js.map

src/codeql.test.ts

@@ -266,7 +266,7 @@ test("tries to cache an explicitly requested bundle with its CLI version number"
     );
     t.assert(releaseApiMock.isDone(), "Releases API should have been called");
     t.assert(toolcache.find("CodeQL", "2.10.0-20200610"));
-    t.deepEqual(result.toolsVersion, "0.0.0-20200610");
+    t.deepEqual(result.toolsVersion, "2.10.0");
   });
 });
 

src/setup-codeql.ts

@@ -526,7 +526,7 @@ export async function downloadCodeQL(
   variant: util.GitHubVariant,
   tempDir: string,
   logger: Logger
-): Promise<string> {
+): Promise<{ toolsVersion: string; codeqlFolder: string }> {
   const parsedCodeQLURL = new URL(codeqlURL);
   const searchParams = new URLSearchParams(parsedCodeQLURL.search);
   const headers: OutgoingHttpHeaders = {
@@ -565,19 +565,27 @@ export async function downloadCodeQL(
 
   const bundleVersion = getBundleVersionFromUrl(codeqlURL);
   // Try to compute the CLI version for this bundle
-  const cliVersion =
+  const cliVersion: string | undefined =
     maybeCliVersion ||
     (variant === util.GitHubVariant.DOTCOM &&
       (await tryFindCliVersionDotcomOnly(
         `codeql-bundle-${bundleVersion}`,
         logger
-      )));
+      ))) ||
+    undefined;
   // Include the bundle version in the toolcache version number so that if the user requests the
   // same URL again, we can get it from the cache without having to call any of the Releases API.
   const toolcacheVersion = cliVersion
     ? `${cliVersion}-${bundleVersion}`
     : convertToSemVer(bundleVersion, logger);
-  return await toolcache.cacheDir(codeqlExtracted, "CodeQL", toolcacheVersion);
+  return {
+    toolsVersion: cliVersion || toolcacheVersion,
+    codeqlFolder: await toolcache.cacheDir(
+      codeqlExtracted,
+      "CodeQL",
+      toolcacheVersion
+    ),
+  };
 }
 
 export function getCodeQLURLVersion(url: string): string {
@@ -623,6 +631,7 @@ export async function setupCodeQLBundle(
   );
 
   let codeqlFolder: string;
+  let toolsVersion = source.toolsVersion;
   switch (source.sourceType) {
     case "local":
       codeqlFolder = await toolcache.extractTar(source.codeqlTarPath);
@@ -631,8 +640,8 @@ export async function setupCodeQLBundle(
       codeqlFolder = source.codeqlFolder;
       logger.debug(`CodeQL found in cache ${codeqlFolder}`);
       break;
-    case "download":
+    case "download": {
-      codeqlFolder = await downloadCodeQL(
+      const result = await downloadCodeQL(
         source.codeqlURL,
         source.cliVersion,
         apiDetails,
@@ -640,9 +649,12 @@ export async function setupCodeQLBundle(
         tempDir,
         logger
       );
+      toolsVersion = result.toolsVersion;
+      codeqlFolder = result.codeqlFolder;
       break;
+    }
     default:
       util.assertNever(source);
   }
-  return { codeqlFolder, toolsVersion: source.toolsVersion };
+  return { codeqlFolder, toolsVersion };
 }