Add standard tools URLs to status report

github · Sep 5, 2024 · 0aafba9 · 0aafba9
1 parent 3b0aa30
commit 0aafba9
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 2 deletions.
diff --git a/lib/setup-codeql.js b/lib/setup-codeql.js
diff --git a/lib/setup-codeql.js.map b/lib/setup-codeql.js.map
diff --git a/lib/setup-codeql.test.js b/lib/setup-codeql.test.js
diff --git a/lib/setup-codeql.test.js.map b/lib/setup-codeql.test.js.map
diff --git a/src/setup-codeql.test.ts b/src/setup-codeql.test.ts
@@ -157,6 +157,7 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to use
       compressionMethod: "gzip",
       downloadDurationMs: 200,
       extractionDurationMs: 300,
+      toolsUrl: "toolsUrl",
     },
     toolsVersion: LINKED_CLI_VERSION.cliVersion,
   });
@@ -204,6 +205,7 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to dow
       compressionMethod: "gzip",
       downloadDurationMs: 200,
       extractionDurationMs: 300,
+      toolsUrl: bundleUrl,
     },
     toolsVersion: expectedVersion,
   });

diff --git a/src/setup-codeql.ts b/src/setup-codeql.ts
@@ -466,6 +466,7 @@ export interface ToolsDownloadStatusReport {
   compressionMethod: tar.CompressionMethod;
   downloadDurationMs: number;
   extractionDurationMs: number;
+  toolsUrl: string;
 }
 
 // Exported using `export const` for testing purposes. Specifically, we want to
@@ -553,6 +554,7 @@ export const downloadCodeQL = async function (
         compressionMethod,
         downloadDurationMs,
         extractionDurationMs,
+        toolsUrl: sanitizeUrlForStatusReport(codeqlURL),
       },
       toolsVersion: maybeCliVersion ?? "unknown",
     };
@@ -585,6 +587,7 @@ export const downloadCodeQL = async function (
       compressionMethod,
       downloadDurationMs,
       extractionDurationMs,
+      toolsUrl: sanitizeUrlForStatusReport(codeqlURL),
     },
     toolsVersion: maybeCliVersion ?? toolcacheVersion,
   };
@@ -711,3 +714,11 @@ async function cleanUpGlob(glob: string, name: string, logger: Logger) {
     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/`),
+  )
+    ? url
+    : "sanitized-value";
+}