Merge pull request #757 from gradle/dd/issue-756

Sanitize workflow name when generating cache key
gradle · Jun 29, 2023 · 40b6781 · 40b6781
2 parents 8e02c82 + 626d937
commit 40b6781
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 11 deletions.
diff --git a/.github/workflows/demo-job-summary.yml b/.github/workflows/demo-job-summary.yml
@@ -1,4 +1,4 @@
-name: Demo Job Summary for Gradle builds
+name: Demo Job Summary, for Gradle builds
 
 on:
   workflow_dispatch:

diff --git a/dist/dependency-graph-generate/index.js b/dist/dependency-graph-generate/index.js
@@ -71597,7 +71597,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.tryDelete = exports.handleCacheFailure = exports.cacheDebug = exports.saveCache = exports.restoreCache = exports.hashStrings = exports.hashFileNames = exports.getCacheKeyPrefix = exports.generateCacheKey = exports.CacheKey = exports.isCacheCleanupEnabled = exports.isCacheDebuggingEnabled = exports.isCacheWriteOnly = exports.isCacheReadOnly = exports.isCacheDisabled = void 0;
+exports.tryDelete = exports.handleCacheFailure = exports.cacheDebug = exports.saveCache = exports.restoreCache = exports.hashStrings = exports.hashFileNames = exports.getCacheKeyForJob = exports.getCacheKeyPrefix = exports.generateCacheKey = exports.CacheKey = exports.isCacheCleanupEnabled = exports.isCacheDebuggingEnabled = exports.isCacheWriteOnly = exports.isCacheReadOnly = exports.isCacheDisabled = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const cache = __importStar(__nccwpck_require__(7799));
 const github = __importStar(__nccwpck_require__(5438));
@@ -71665,8 +71665,13 @@ function getCacheKeyEnvironment() {
     return process.env[CACHE_KEY_OS_VAR] || runnerOs;
 }
 function getCacheKeyJob() {
-    return process.env[CACHE_KEY_JOB_VAR] || `${github.context.workflow}-${github.context.job}`;
+    return process.env[CACHE_KEY_JOB_VAR] || getCacheKeyForJob(github.context.workflow, github.context.job);
 }
+function getCacheKeyForJob(workflowName, jobId) {
+    const sanitizedWorkflow = workflowName.replace(/,/g, '').toLowerCase();
+    return `${sanitizedWorkflow}-${jobId}`;
+}
+exports.getCacheKeyForJob = getCacheKeyForJob;
 function getCacheKeyJobInstance() {
     const override = process.env[CACHE_KEY_JOB_INSTANCE_VAR];
     if (override) {

diff --git a/dist/dependency-graph-generate/index.js.map b/dist/dependency-graph-generate/index.js.map
diff --git a/dist/main/index.js b/dist/main/index.js
@@ -64382,7 +64382,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.tryDelete = exports.handleCacheFailure = exports.cacheDebug = exports.saveCache = exports.restoreCache = exports.hashStrings = exports.hashFileNames = exports.getCacheKeyPrefix = exports.generateCacheKey = exports.CacheKey = exports.isCacheCleanupEnabled = exports.isCacheDebuggingEnabled = exports.isCacheWriteOnly = exports.isCacheReadOnly = exports.isCacheDisabled = void 0;
+exports.tryDelete = exports.handleCacheFailure = exports.cacheDebug = exports.saveCache = exports.restoreCache = exports.hashStrings = exports.hashFileNames = exports.getCacheKeyForJob = exports.getCacheKeyPrefix = exports.generateCacheKey = exports.CacheKey = exports.isCacheCleanupEnabled = exports.isCacheDebuggingEnabled = exports.isCacheWriteOnly = exports.isCacheReadOnly = exports.isCacheDisabled = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const cache = __importStar(__nccwpck_require__(7799));
 const github = __importStar(__nccwpck_require__(5438));
@@ -64450,8 +64450,13 @@ function getCacheKeyEnvironment() {
     return process.env[CACHE_KEY_OS_VAR] || runnerOs;
 }
 function getCacheKeyJob() {
-    return process.env[CACHE_KEY_JOB_VAR] || `${github.context.workflow}-${github.context.job}`;
+    return process.env[CACHE_KEY_JOB_VAR] || getCacheKeyForJob(github.context.workflow, github.context.job);
 }
+function getCacheKeyForJob(workflowName, jobId) {
+    const sanitizedWorkflow = workflowName.replace(/,/g, '').toLowerCase();
+    return `${sanitizedWorkflow}-${jobId}`;
+}
+exports.getCacheKeyForJob = getCacheKeyForJob;
 function getCacheKeyJobInstance() {
     const override = process.env[CACHE_KEY_JOB_INSTANCE_VAR];
     if (override) {

diff --git a/dist/main/index.js.map b/dist/main/index.js.map
diff --git a/dist/post/index.js b/dist/post/index.js
@@ -63485,7 +63485,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.tryDelete = exports.handleCacheFailure = exports.cacheDebug = exports.saveCache = exports.restoreCache = exports.hashStrings = exports.hashFileNames = exports.getCacheKeyPrefix = exports.generateCacheKey = exports.CacheKey = exports.isCacheCleanupEnabled = exports.isCacheDebuggingEnabled = exports.isCacheWriteOnly = exports.isCacheReadOnly = exports.isCacheDisabled = void 0;
+exports.tryDelete = exports.handleCacheFailure = exports.cacheDebug = exports.saveCache = exports.restoreCache = exports.hashStrings = exports.hashFileNames = exports.getCacheKeyForJob = exports.getCacheKeyPrefix = exports.generateCacheKey = exports.CacheKey = exports.isCacheCleanupEnabled = exports.isCacheDebuggingEnabled = exports.isCacheWriteOnly = exports.isCacheReadOnly = exports.isCacheDisabled = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const cache = __importStar(__nccwpck_require__(7799));
 const github = __importStar(__nccwpck_require__(5438));
@@ -63553,8 +63553,13 @@ function getCacheKeyEnvironment() {
     return process.env[CACHE_KEY_OS_VAR] || runnerOs;
 }
 function getCacheKeyJob() {
-    return process.env[CACHE_KEY_JOB_VAR] || `${github.context.workflow}-${github.context.job}`;
+    return process.env[CACHE_KEY_JOB_VAR] || getCacheKeyForJob(github.context.workflow, github.context.job);
 }
+function getCacheKeyForJob(workflowName, jobId) {
+    const sanitizedWorkflow = workflowName.replace(/,/g, '').toLowerCase();
+    return `${sanitizedWorkflow}-${jobId}`;
+}
+exports.getCacheKeyForJob = getCacheKeyForJob;
 function getCacheKeyJobInstance() {
     const override = process.env[CACHE_KEY_JOB_INSTANCE_VAR];
     if (override) {

diff --git a/dist/post/index.js.map b/dist/post/index.js.map
diff --git a/src/cache-utils.ts b/src/cache-utils.ts
@@ -109,7 +109,12 @@ function getCacheKeyEnvironment(): string {
 }
 
 function getCacheKeyJob(): string {
-    return process.env[CACHE_KEY_JOB_VAR] || `${github.context.workflow}-${github.context.job}`
+    return process.env[CACHE_KEY_JOB_VAR] || getCacheKeyForJob(github.context.workflow, github.context.job)
+}
+
+export function getCacheKeyForJob(workflowName: string, jobId: string): string {
+    const sanitizedWorkflow = workflowName.replace(/,/g, '').toLowerCase()
+    return `${sanitizedWorkflow}-${jobId}`
 }
 
 function getCacheKeyJobInstance(): string {

diff --git a/test/jest/cache-utils.test.ts b/test/jest/cache-utils.test.ts
@@ -17,4 +17,10 @@ describe('cacheUtils-utils', () => {
             expect(posixHash).toBe(windowsHash)
         })
     })
+    describe('sanitizes workflow name in cache key', () => {
+        it('with comma', () => {
+            const cacheKey = cacheUtils.getCacheKeyForJob("Workflow, with,commas", "JOB_ID")
+            expect(cacheKey).toBe('workflow withcommas-JOB_ID')
+        })
+    })
 })