Improve duration formatting

Author: henrymercer

lib/logging.js

@@ -40,3 +40,17 @@ export function withGroup<T>(groupName: string, f: () => T): T {
     core.endGroup();
   }
 }
+
+/** Format a duration for use in logs. */
+export function formatDuration(durationMs: number) {
+  if (durationMs < 1000) {
+    return `${durationMs}ms`;
+  }
+
+  if (durationMs < 60 * 1000) {
+    return `${(durationMs / 1000).toFixed(1)}s`;
+  }
+  const minutes = Math.floor(durationMs / (60 * 1000));
+  const seconds = Math.floor((durationMs % (60 * 1000)) / 1000);
+  return `${minutes}m${seconds}s`;
+}

lib/logging.js.map

@@ -15,7 +15,7 @@ import {
   Feature,
   FeatureEnablement,
 } from "./feature-flags";
-import { Logger } from "./logging";
+import { formatDuration, Logger } from "./logging";
 import * as tar from "./tar";
 import {
   downloadAndExtract,
@@ -557,9 +557,9 @@ export const downloadCodeQL = async function (
   );
 
   logger.info(
-    `Added CodeQL bundle to the tool cache (${Math.round(
+    `Added CodeQL bundle to the tool cache (${formatDuration(
       performance.now() - toolcacheStart,
-    )} ms).`,
+    )}).`,
   );
 
   // Defensive check: we expect `cacheDir` to copy the bundle to a new location.

lib/setup-codeql.js

@@ -7,7 +7,7 @@ import { https } from "follow-redirects";
 import { v4 as uuidV4 } from "uuid";
 
 import { Feature, FeatureEnablement } from "./feature-flags";
-import { Logger } from "./logging";
+import { formatDuration, Logger } from "./logging";
 import * as tar from "./tar";
 import { cleanUpGlob } from "./util";
 
@@ -78,7 +78,9 @@ export async function downloadAndExtract(
       performance.now() - toolsInstallStart,
     );
     logger.info(
-      `Finished downloading and extracting CodeQL bundle to ${extractedBundlePath} (${combinedDurationMs} ms).`,
+      `Finished downloading and extracting CodeQL bundle to ${extractedBundlePath} (${formatDuration(
+        combinedDurationMs,
+      )}).`,
     );
 
     return {
@@ -105,7 +107,9 @@ export async function downloadAndExtract(
   const downloadDurationMs = Math.round(performance.now() - toolsDownloadStart);
 
   logger.info(
-    `Finished downloading CodeQL bundle to ${archivedBundlePath} (${downloadDurationMs} ms).`,
+    `Finished downloading CodeQL bundle to ${archivedBundlePath} (${formatDuration(
+      downloadDurationMs,
+    )}).`,
   );
 
   let extractedBundlePath: string;
@@ -122,7 +126,9 @@ export async function downloadAndExtract(
     );
     extractionDurationMs = Math.round(performance.now() - extractionStart);
     logger.info(
-      `Finished extracting CodeQL bundle to ${extractedBundlePath} (${extractionDurationMs} ms).`,
+      `Finished extracting CodeQL bundle to ${extractedBundlePath} (${formatDuration(
+        extractionDurationMs,
+      )}).`,
     );
   } finally {
     await cleanUpGlob(archivedBundlePath, "CodeQL bundle archive", logger);