Code improvemnt: Rm CacheDistributor.cacheDependencyPath field and pass back from computeKeys instead, simplifying CacheDistributor.restoreCache error check. Rm now uneeded constant.ts file.

sgpinkus · sgpinkus · commit d99639b3c5aa · 2025-02-19T17:13:15.000+10:00
diff --git a/src/cache-distributions/cache-distributor.ts b/src/cache-distributions/cache-distributor.ts
@@ -1,6 +1,5 @@
 import * as cache from '@actions/cache';
 import * as core from '@actions/core';
-import {CACHE_DEPENDENCY_BACKUP_PATH} from './constants';
 
 export enum State {
   STATE_CACHE_PRIMARY_KEY = 'cache-primary-key',
@@ -11,24 +10,19 @@ export enum State {
 abstract class CacheDistributor {
   protected CACHE_KEY_PREFIX = 'setup-python';
   protected abstract readonly packageManager: string;
-  protected abstract readonly cacheDependencyPath: string;
 
   protected abstract getCacheGlobalDirectories(): Promise<string[]>;
   protected abstract computeKeys(): Promise<{
     primaryKey: string;
     restoreKey: string[] | undefined;
+    cacheDependencyPath: string;
   }>;
   protected async handleLoadedCache() {}
 
   public async restoreCache() {
-    const {primaryKey, restoreKey} = await this.computeKeys();
+    const {primaryKey, restoreKey, cacheDependencyPath} = await this.computeKeys();
     if (primaryKey.endsWith('-')) {
-      const file =
-        this.packageManager === 'pip'
-          ? `${this.cacheDependencyPath
-              .split('\n')
-              .join(',')} or ${CACHE_DEPENDENCY_BACKUP_PATH}`
-          : this.cacheDependencyPath.split('\n').join(',');
+      const file = cacheDependencyPath.split('\n').join(',');
       throw new Error(
         `No file in ${process.cwd()} matched to [${file}], make sure you have checked out the target repository`
       );
diff --git a/src/cache-distributions/constants.ts b/src/cache-distributions/constants.ts
diff --git a/src/cache-distributions/pip-cache.ts b/src/cache-distributions/pip-cache.ts
@@ -8,10 +8,9 @@ import os from 'os';
 
 import CacheDistributor from './cache-distributor';
 import {getLinuxInfo, IS_LINUX, IS_WINDOWS} from '../utils';
-import {CACHE_DEPENDENCY_BACKUP_PATH} from './constants';
 
 class PipCache extends CacheDistributor {
-  private cacheDependencyBackupPath: string = CACHE_DEPENDENCY_BACKUP_PATH;
+  private cacheDependencyBackupPath = '**/pyproject.toml';
   protected readonly packageManager = 'pip';
 
   constructor(
@@ -60,9 +59,12 @@ class PipCache extends CacheDistributor {
   }
 
   protected async computeKeys() {
-    const hash =
-      (await glob.hashFiles(this.cacheDependencyPath)) ||
-      (await glob.hashFiles(this.cacheDependencyBackupPath));
+    let cacheDependencyPath = this.cacheDependencyPath;
+    let hash = await glob.hashFiles(this.cacheDependencyPath);
+    if(!hash) {
+      hash = await glob.hashFiles(this.cacheDependencyBackupPath);
+      cacheDependencyPath = this.cacheDependencyBackupPath;
+    }
     let primaryKey = '';
     let restoreKey = '';
 
@@ -77,7 +79,8 @@ class PipCache extends CacheDistributor {
 
     return {
       primaryKey,
-      restoreKey: [restoreKey]
+      restoreKey: [restoreKey],
+      cacheDependencyPath,
     };
   }
 }
diff --git a/src/cache-distributions/pipenv-cache.ts b/src/cache-distributions/pipenv-cache.ts
@@ -38,7 +38,8 @@ class PipenvCache extends CacheDistributor {
     const restoreKey = undefined;
     return {
       primaryKey,
-      restoreKey
+      restoreKey,
+      cacheDependencyPath: this.cacheDependencyPath,
     };
   }
 }
diff --git a/src/cache-distributions/poetry-cache.ts b/src/cache-distributions/poetry-cache.ts
@@ -54,7 +54,8 @@ class PoetryCache extends CacheDistributor {
     const restoreKey = undefined;
     return {
       primaryKey,
-      restoreKey
+      restoreKey,
+      cacheDependencyPath: this.cacheDependencyPath,
     };
   }
 

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,8 @@ class PipenvCache extends CacheDistributor {`
`38`	`38`	`const restoreKey = undefined;`
`39`	`39`	`return {`
`40`	`40`	`primaryKey,`
`41`		`- restoreKey`
	`41`	`+ restoreKey,`
	`42`	`+ cacheDependencyPath: this.cacheDependencyPath,`
`42`	`43`	`};`
`43`	`44`	`}`
`44`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,8 @@ class PoetryCache extends CacheDistributor {`
`54`	`54`	`const restoreKey = undefined;`
`55`	`55`	`return {`
`56`	`56`	`primaryKey,`
`57`		`- restoreKey`
	`57`	`+ restoreKey,`
	`58`	`+ cacheDependencyPath: this.cacheDependencyPath,`
`58`	`59`	`};`
`59`	`60`	`}`
`60`	`61`