Improve logging

github · Oct 10, 2024 · 90c42c4 · 90c42c4
1 parent df0590b
commit 90c42c4
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 9 deletions.
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
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/tools-download.js b/lib/tools-download.js
diff --git a/lib/tools-download.js.map b/lib/tools-download.js.map
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -544,7 +544,9 @@ export async function getCodeQLForCmd(
     async getVersion() {
       let result = util.getCachedCodeQlVersion();
       if (result === undefined) {
-        const output = await runCli(cmd, ["version", "--format=json"]);
+        const output = await runCli(cmd, ["version", "--format=json"], {
+          noStreamStdout: true,
+        });
         try {
           result = JSON.parse(output) as VersionInfo;
         } catch {

diff --git a/src/setup-codeql.ts b/src/setup-codeql.ts
@@ -517,9 +517,6 @@ export const downloadCodeQL = async function (
   } else {
     logger.debug("Downloading CodeQL tools without an authorization token.");
   }
-  logger.info(
-    `Downloading CodeQL tools from ${codeqlURL} . This may take a while.`,
-  );
 
   const { extractedBundlePath, statusReport } = await downloadAndExtract(
     codeqlURL,
@@ -552,12 +549,19 @@ export const downloadCodeQL = async function (
     bundleVersion,
     logger,
   );
+  const toolcacheStart = performance.now();
   const toolcachedBundlePath = await toolcache.cacheDir(
     extractedBundlePath,
     "CodeQL",
     toolcacheVersion,
   );
 
+  logger.info(
+    `Added CodeQL bundle to the tool cache (${
+      performance.now() - toolcacheStart
+    } ms).`,
+  );
+
   // Defensive check: we expect `cacheDir` to copy the bundle to a new location.
   if (toolcachedBundlePath !== extractedBundlePath) {
     await cleanUpGlob(

diff --git a/src/tools-download.ts b/src/tools-download.ts
@@ -53,12 +53,18 @@ export async function downloadAndExtract(
   extractedBundlePath: string;
   statusReport: ToolsDownloadStatusReport;
 }> {
+  logger.info(
+    `Downloading CodeQL tools from ${codeqlURL} . This may take a while.`,
+  );
+
   const compressionMethod = tar.inferCompressionMethod(codeqlURL);
 
   if (
     compressionMethod === "zstd" &&
     (await features.getValue(Feature.ZstdBundleStreamingExtraction))
   ) {
+    logger.info(`Streaming the extraction of the CodeQL bundle.`);
+
     const toolsInstallStart = performance.now();
     const extractedBundlePath = await downloadAndExtractZstdWithStreaming(
       codeqlURL,