feat: add cache-restore-timeout to cap entire restore operation (#156)

The existing segmentTimeoutInMs (5 min) only covers individual download
segments. If the extraction phase (gtar/unzstd) hangs, there is no
timeout — we observed a macOS runner hang for 1h25m on cache extraction.

Add a cache-restore-timeout input (in milliseconds, default 0/disabled)
that wraps the entire restoreCache() call with Promise.race, covering
both download and extraction.

Author: mani-muon

action.yml

@@ -45,6 +45,10 @@ inputs:
     description: Cache repositories based on MODULE.bazel/WORKSPACE
     required: false
     default: "false"
+  cache-restore-timeout:
+    description: Timeout in milliseconds for each cache restore operation (download + extraction). Set to 0 to disable.
+    required: false
+    default: "0"
   token:
     description: GitHub token to query Bazelisk releases
     required: false

config.js

@@ -133,12 +133,15 @@ if (externalCacheConfig) {
   }
 }
 
+const cacheRestoreTimeoutMs = parseInt(core.getInput('cache-restore-timeout')) || 0
+
 const token = core.getInput('token')
 core.exportVariable('BAZELISK_GITHUB_TOKEN', token)
 
 export default {
   baseCacheKey,
   cacheSave,
+  cacheRestoreTimeoutMs,
   bazeliskCache: {
     enabled: core.getBooleanInput('bazelisk-cache'),
     files: [`${moduleRoot}/.bazelversion`],

dist/main/index.js

@@ -128381,12 +128381,15 @@ if (externalCacheConfig) {
   }
 }
 
+const cacheRestoreTimeoutMs = parseInt(getInput('cache-restore-timeout')) || 0
+
 const token = getInput('token')
 exportVariable('BAZELISK_GITHUB_TOKEN', token)
 
 /* harmony default export */ const config = ({
   baseCacheKey,
   cacheSave,
+  cacheRestoreTimeoutMs,
   bazeliskCache: {
     enabled: getBooleanInput('bazelisk-cache'),
     files: [`${moduleRoot}/.bazelversion`],
@@ -128581,20 +128584,36 @@ async function index_restoreCache(cacheConfig) {
   await (0,promises_namespaceObject.setTimeout)(delay)
 
   startGroup(`Restore cache for ${cacheConfig.name}`)
+  const name = cacheConfig.name
   try {
     const hash = await glob_hashFiles(cacheConfig.files.join('\n'))
-    const name = cacheConfig.name
     const paths = cacheConfig.paths
     const restoreKey = `${config.baseCacheKey}-${name}-`
     const key = `${restoreKey}${hash}`
 
     core_debug(`Attempting to restore ${name} cache from ${key}`)
 
-    const restoredKey = await restoreCache(
+    const restorePromise = restoreCache(
       paths, key, [restoreKey],
-      { segmentTimeoutInMs: 300000 } // 5 minutes
+      { segmentTimeoutInMs: 300000 } // 5 minutes per download segment
     )
 
+    let restoredKey
+    if (config.cacheRestoreTimeoutMs > 0) {
+      const ac = new AbortController()
+      const timeoutPromise = (0,promises_namespaceObject.setTimeout)(config.cacheRestoreTimeoutMs, null, { signal: ac.signal })
+        .then(() => { throw new Error(`Timed out restoring ${name} cache after ${config.cacheRestoreTimeoutMs}ms`) })
+      timeoutPromise.catch(() => {})
+
+      try {
+        restoredKey = await Promise.race([restorePromise, timeoutPromise])
+      } finally {
+        ac.abort()
+      }
+    } else {
+      restoredKey = await restorePromise
+    }
+
     if (restoredKey) {
       info(`Successfully restored cache from ${restoredKey}`)
 

dist/main/index.js.map

@@ -127583,12 +127583,15 @@ if (externalCacheConfig) {
   }
 }
 
+const cacheRestoreTimeoutMs = parseInt(getInput('cache-restore-timeout')) || 0
+
 const token = getInput('token')
 exportVariable('BAZELISK_GITHUB_TOKEN', token)
 
 /* harmony default export */ const config = ({
   baseCacheKey,
   cacheSave,
+  cacheRestoreTimeoutMs,
   bazeliskCache: {
     enabled: getBooleanInput('bazelisk-cache'),
     files: [`${moduleRoot}/.bazelversion`],

dist/post/index.js

@@ -164,11 +164,27 @@ async function restoreCache(cacheConfig) {
 
     core.debug(`Attempting to restore ${name} cache from ${key}`)
 
-    const restoredKey = await cache.restoreCache(
+    const restorePromise = cache.restoreCache(
       paths, key, [restoreKey],
-      { segmentTimeoutInMs: 300000 } // 5 minutes
+      { segmentTimeoutInMs: 300000 } // 5 minutes per download segment
     )
 
+    let restoredKey
+    if (config.cacheRestoreTimeoutMs > 0) {
+      const ac = new AbortController()
+      const timeoutPromise = setTimeout(config.cacheRestoreTimeoutMs, null, { signal: ac.signal })
+        .then(() => { throw new Error(`Timed out restoring ${name} cache after ${config.cacheRestoreTimeoutMs}ms`) })
+      timeoutPromise.catch(() => {})
+
+      try {
+        restoredKey = await Promise.race([restorePromise, timeoutPromise])
+      } finally {
+        ac.abort()
+      }
+    } else {
+      restoredKey = await restorePromise
+    }
+
     if (restoredKey) {
       core.info(`Successfully restored cache from ${restoredKey}`)