Cache .rye and remove os version dependency (#192)

To speed up runs on hosted runners also cache the .rye directory. Also remove the os version from the cache key to be more robust. This especially fixes issues with macos14.
eifinger · Mar 1, 2024 · ad84597 · ad84597
1 parent 9d83a60
commit ad84597
Show file tree

Hide file tree

Showing 8 changed files with 118 additions and 118 deletions.
diff --git a/.github/workflows/test-cache.yml b/.github/workflows/test-cache.yml
@@ -49,6 +49,8 @@ jobs:
           fi
         env:
           CACHE_HIT: ${{ steps.restore.outputs.cache-hit }}
+      - run: rye sync
+        working-directory: __tests__/fixtures/rye-project
 
   test-setup-cache-local:
     runs-on: oracle-aarch64
@@ -85,3 +87,5 @@ jobs:
           fi
         env:
           CACHE_HIT: ${{ steps.restore.outputs.cache-hit }}
+      - run: rye sync
+        working-directory: __tests__/fixtures/rye-project
diff --git a/dist/save-cache/index.js b/dist/save-cache/index.js
diff --git a/dist/save-cache/index.js.map b/dist/save-cache/index.js.map
diff --git a/dist/setup/index.js b/dist/setup/index.js
diff --git a/dist/setup/index.js.map b/dist/setup/index.js.map
diff --git a/src/restore-cache.ts b/src/restore-cache.ts
@@ -4,26 +4,25 @@ import * as glob from '@actions/glob'
 import * as core from '@actions/core'
 import {cp} from '@actions/io/'
 import {exists} from '@actions/io/lib/io-util'
+import {getArch} from './utils'
 
-import {IS_MAC, getLinuxInfo, getMacOSInfo} from './utils'
-
-export const STATE_CACHE_PRIMARY_KEY = 'cache-primary-key'
+export const STATE_CACHE_KEY = 'cache-key'
 export const STATE_CACHE_MATCHED_KEY = 'cache-matched-key'
-const CACHE_VERSION = '1'
-const CACHE_DEPENDENCY_PATH = 'requirements**.lock'
-const workingDirInput = core.getInput('working-directory')
-const workingDir = workingDirInput ? `/${workingDirInput}` : ''
-const cachePath = `${process.env['GITHUB_WORKSPACE']}${workingDir}/.venv`
+export const workingDirInput = core.getInput('working-directory')
+export const workingDir = workingDirInput ? `/${workingDirInput}` : ''
+export const venvPath = `${process.env['GITHUB_WORKSPACE']}${workingDir}/.venv`
+export const ryeHomePath = `${process.env['GITHUB_WORKSPACE']}${workingDir}/.rye`
+const CACHE_VERSION = '2'
 const cacheLocalStoragePath =
   `${core.getInput('cache-local-storage-path')}` || ''
-const cacheDependencyPath = `${process.env['GITHUB_WORKSPACE']}${workingDir}/${CACHE_DEPENDENCY_PATH}`
+const cacheDependencyPath = `${process.env['GITHUB_WORKSPACE']}${workingDir}/requirements**.lock`
 
 export async function restoreCache(
   cachePrefix: string,
   version: string
 ): Promise<void> {
-  const {primaryKey, restoreKey} = await computeKeys(cachePrefix, version)
-  if (primaryKey.endsWith('-')) {
+  const cacheKey = await computeKeys(cachePrefix, version)
+  if (cacheKey.endsWith('-')) {
     throw new Error(
       `No file in ${process.cwd()} matched to [${cacheDependencyPath}], make sure you have checked out the target repository`
     )
@@ -32,34 +31,30 @@ export async function restoreCache(
   let matchedKey: string | undefined
   try {
     matchedKey = cacheLocalStoragePath
-      ? await restoreCacheLocal(primaryKey)
-      : await cache.restoreCache([cachePath], primaryKey, [restoreKey])
+      ? await restoreCacheLocal(cacheKey)
+      : await cache.restoreCache([venvPath, ryeHomePath], cacheKey)
   } catch (err) {
     const message = (err as Error).message
     core.warning(message)
     core.setOutput('cache-hit', false)
     return
   }
 
-  core.saveState(STATE_CACHE_PRIMARY_KEY, primaryKey)
+  core.saveState(STATE_CACHE_KEY, cacheKey)
 
-  handleMatchResult(matchedKey, primaryKey)
+  handleMatchResult(matchedKey, cacheKey)
 }
 
 async function computeKeys(
   cachePrefix: string,
   version: string
-): Promise<{primaryKey: string; restoreKey: string}> {
-  core.debug(`Computing cache key for ${cacheDependencyPath}`)
-  const dependencyPathHash = await glob.hashFiles(cacheDependencyPath)
+): Promise<string> {
+  const cacheDependencyPathHash = await glob.hashFiles(cacheDependencyPath)
   const workingDirHash = workingDir
     ? `-${crypto.createHash('sha256').update(workingDir).digest('hex')}`
     : ''
-  const osInfo = IS_MAC ? await getMacOSInfo() : await getLinuxInfo()
   const prefix = cachePrefix ? `${cachePrefix}-` : ''
-  const primaryKey = `${prefix}setup-rye-${CACHE_VERSION}-${osInfo.osVersion}-${osInfo.osName}-rye-${version}${workingDirHash}-${dependencyPathHash}`
-  const restoreKey = `${prefix}setup-rye-${CACHE_VERSION}-${osInfo.osVersion}-${osInfo.osName}-rye-${version}${workingDirHash}`
-  return {primaryKey, restoreKey}
+  return `${prefix}setup-rye-${CACHE_VERSION}-${process.env['RUNNER_OS']}-${getArch()}-rye-${version}${workingDirHash}-${cacheDependencyPathHash}`
 }
 
 function handleMatchResult(
@@ -83,8 +78,10 @@ async function restoreCacheLocal(
     core.info(`Local cache is not found: ${storedCache}`)
     return
   }
-  await cp(storedCache, cachePath, {
-    copySourceDirectory: false,
+  await cp(`${storedCache}/.venv`, venvPath, {
+    recursive: true
+  })
+  await cp(`${storedCache}/.rye`, ryeHomePath, {
     recursive: true
   })
   return primaryKey