Allow warnings in tryGetFolderBytes to be suppressed

To avoid confusing run annotations when dependency caching is enabled
github · Nov 12, 2024 · 7bc6222 · 7bc6222
1 parent b0c0aad
commit 7bc6222
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 11 deletions.
diff --git a/lib/caching-utils.js b/lib/caching-utils.js
diff --git a/lib/caching-utils.js.map b/lib/caching-utils.js.map
diff --git a/lib/dependency-caching.js b/lib/dependency-caching.js
diff --git a/lib/dependency-caching.js.map b/lib/dependency-caching.js.map
diff --git a/lib/util.js b/lib/util.js
diff --git a/lib/util.js.map b/lib/util.js.map
diff --git a/src/caching-utils.ts b/src/caching-utils.ts
@@ -9,14 +9,16 @@ import { isHostedRunner, tryGetFolderBytes } from "./util";
  * Returns the total size of all the specified paths.
  * @param paths The paths for which to calculate the total size.
  * @param logger A logger to record some informational messages to.
+ * @param quiet A value indicating whether to suppress logging warnings (default: false).
  * @returns The total size of all specified paths.
  */
 export async function getTotalCacheSize(
   paths: string[],
   logger: Logger,
+  quiet: boolean = false,
 ): Promise<number> {
   const sizes = await Promise.all(
-    paths.map((cacheDir) => tryGetFolderBytes(cacheDir, logger)),
+    paths.map((cacheDir) => tryGetFolderBytes(cacheDir, logger, quiet)),
   );
   return sizes.map((a) => a || 0).reduce((a, b) => a + b, 0);
 }

diff --git a/src/dependency-caching.ts b/src/dependency-caching.ts
@@ -168,7 +168,7 @@ export async function uploadDependencyCaches(config: Config, logger: Logger) {
     //   use the cache quota that we compete with. In that case, we do not wish to use up all of the quota
     //   with the dependency caches. For this, we could use the Cache API to check whether other workflows
     //   are using the quota and how full it is.
-    const size = await getTotalCacheSize(cacheConfig.paths, logger);
+    const size = await getTotalCacheSize(cacheConfig.paths, logger, true);
 
     // Skip uploading an empty cache.
     if (size === 0) {

diff --git a/src/util.ts b/src/util.ts
@@ -785,16 +785,23 @@ export function listFolder(dir: string): string[] {
  *
  * @param cacheDir A directory to get the size of.
  * @param logger A logger to log any errors to.
+ * @param quiet A value indicating whether to suppress warnings for errors (default: false).
+ *              Ignored if the log level is `debug`.
  * @returns The size in bytes of the folder, or undefined if errors occurred.
  */
 export async function tryGetFolderBytes(
   cacheDir: string,
   logger: Logger,
+  quiet: boolean = false,
 ): Promise<number | undefined> {
   try {
     return await promisify<string, number>(getFolderSize)(cacheDir);
   } catch (e) {
-    logger.warning(`Encountered an error while getting size of folder: ${e}`);
+    if (!quiet || logger.isDebug()) {
+      logger.warning(
+        `Encountered an error while getting size of '${cacheDir}': ${e}`,
+      );
+    }
     return undefined;
   }
 }