chore: introduce CacheOptions{silent} to avoid logging in tests

Now that it's an esm module, we can't mock `core` like we were.

Author: pbrisbin

src/with-cache.test.ts

@@ -14,7 +14,6 @@ const cache: CacheDelegate = {
 };
 
 const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-jest.spyOn(core, "info");
 
 async function testFunction(): Promise<number> {
   return 42;
@@ -49,7 +48,7 @@ test("withCache skips on primary-key hit", async () => {
     cachePaths,
     cacheKeys,
     testFunction,
-    DEFAULT_CACHE_OPTIONS,
+    { ...DEFAULT_CACHE_OPTIONS, silent: true },
     cache,
   );
 
@@ -71,7 +70,7 @@ test("withCache acts and saves if no primary-key hit", async () => {
     cachePaths,
     cacheKeys,
     testFunction,
-    DEFAULT_CACHE_OPTIONS,
+    { ...DEFAULT_CACHE_OPTIONS, silent: true },
     cache,
   );
 
@@ -99,6 +98,7 @@ test("withCache can be configured to act and save anyway", async () => {
     {
       ...DEFAULT_CACHE_OPTIONS,
       skipOnHit: false,
+      silent: true,
     },
     cache,
   );
@@ -124,7 +124,7 @@ test("withCache does not save on error", async () => {
       cachePaths,
       cacheKeys,
       testFunctionThrows,
-      DEFAULT_CACHE_OPTIONS,
+      { ...DEFAULT_CACHE_OPTIONS, silent: true },
       cache,
     );
   }).rejects.toThrow();
@@ -152,6 +152,7 @@ test("withCache can be configured to save on error", async () => {
       {
         ...DEFAULT_CACHE_OPTIONS,
         saveOnError: true,
+        silent: true,
       },
       cache,
     );

src/with-cache.ts

@@ -5,11 +5,13 @@ import type { CacheKeys } from "./get-cache-keys.js";
 export type CacheOptions = {
   skipOnHit: boolean;
   saveOnError: boolean;
+  silent: boolean;
 };
 
 export const DEFAULT_CACHE_OPTIONS = {
   skipOnHit: true,
   saveOnError: false,
+  silent: false,
 };
 
 export interface CacheDelegate {
@@ -29,11 +31,13 @@ export async function withCache<T>(
   cache?: CacheDelegate,
 ): Promise<T | undefined> {
   const cacheImpl = cache ?? realCache;
-  const { skipOnHit, saveOnError } = options;
+  const { skipOnHit, saveOnError, silent } = options;
 
-  core.info(`Cached paths:\n - ${paths.join("\n - ")}`);
-  core.info(`Cache key: ${keys.primaryKey}`);
-  core.info(`Cache restore keys:\n - ${keys.restoreKeys.join("\n - ")}`);
+  if (!silent) {
+    core.info(`Cached paths:\n - ${paths.join("\n - ")}`);
+    core.info(`Cache key: ${keys.primaryKey}`);
+    core.info(`Cache restore keys:\n - ${keys.restoreKeys.join("\n - ")}`);
+  }
 
   const restoredKey = await cacheImpl.restoreCache(
     paths,
@@ -44,13 +48,17 @@ export async function withCache<T>(
   const primaryKeyHit = restoredKey == keys.primaryKey;
 
   if (restoredKey) {
-    core.info(`Cache restored from key: ${restoredKey}`);
+    if (!silent) {
+      core.info(`Cache restored from key: ${restoredKey}`);
+    }
   } else {
     core.warning("No cache found");
   }
 
   if (primaryKeyHit && skipOnHit && !saveOnError) {
-    core.info("Skipping due to primary key hit");
+    if (!silent) {
+      core.info("Skipping due to primary key hit");
+    }
     return;
   }