fix: pass target file name to state to avoid hash mutation

src/inputs.ts

@@ -8,7 +8,7 @@ export interface Inputs {
 }
 
 export function getInputs(): Inputs {
-  return {
+  const inputs = {
     bucket: core.getInput('bucket', { required: true }),
     path: core.getInput('path', { required: true }),
     key: core.getInput('key', { required: true }),
@@ -17,4 +17,8 @@ export function getInputs(): Inputs {
       .split(',')
       .filter((path) => path),
   };
+
+  core.debug(`Loaded inputs: ${JSON.stringify(inputs)}.`);
+
+  return inputs;
 }

src/main.ts

@@ -5,7 +5,7 @@ import { withFile as withTemporaryFile } from 'tmp-promise';
 
 import { ObjectMetadata } from './gcs-utils';
 import { getInputs } from './inputs';
-import { CacheHitKindState, saveState, State } from './state';
+import { CacheHitKindState, saveState } from './state';
 import { extractTar } from './tar-utils';
 
 async function getBestMatch(
@@ -18,7 +18,7 @@ async function getBestMatch(
   const exactFile = bucket.file(`${folderPrefix}/${key}.tar`);
   const [exactFileExists] = await exactFile.exists();
 
-  core.debug(exactFile.name);
+  core.debug(`Exact file name: ${exactFile.name}.`);
 
   if (exactFileExists) {
     console.log(`🙌 Found exact match from cache for key '${key}'.`);
@@ -41,12 +41,14 @@ async function getBestMatch(
 
   if (core.isDebug()) {
     core.debug(
-      JSON.stringify(
+      `Candidates: ${JSON.stringify(
         bucketFiles.map((f) => ({
           name: f.name,
-          metadata: f.metadata as ObjectMetadata,
+          metadata: {
+            updated: (f.metadata as ObjectMetadata).updated,
+          },
         })),
-      ),
+      )}.`,
     );
   }
 
@@ -72,6 +74,9 @@ async function main() {
   const inputs = getInputs();
   const bucket = new Storage().bucket(inputs.bucket);
 
+  const folderPrefix = `${github.context.repo.owner}/${github.context.repo.repo}`;
+  const exactFileName = `${folderPrefix}/${inputs.key}.tar`;
+
   const [bestMatch, bestMatchKind] = await core
     .group('🔍 Searching the best cache archive available', () =>
       getBestMatch(bucket, inputs.key, inputs.restoreKeys),
@@ -81,34 +86,37 @@ async function main() {
       throw err;
     });
 
-  core.debug(bestMatchKind);
+  core.debug(`Best match kind: ${bestMatchKind}.`);
 
   if (!bestMatch) {
     saveState({
       cacheHitKind: 'none',
+      targetFileName: exactFileName,
     });
     core.setOutput('cache-hit', 'false');
     console.log('😢 No cache candidate found.');
     return;
   }
 
-  core.debug(bestMatch.name);
+  core.debug(`Best match name: ${bestMatch.name}.`);
 
   const bestMatchMetadata = await bestMatch
     .getMetadata()
     .then(([metadata]) => metadata as ObjectMetadata);
 
-  core.debug(JSON.stringify(bestMatchMetadata));
+  core.debug(`Best match metadata: ${JSON.stringify(bestMatchMetadata)}.`);
 
   const compressionMethod =
     bestMatchMetadata?.metadata?.['Cache-Action-Compression-Method'];
 
-  core.debug(compressionMethod);
+  core.debug(`Best match compression method: ${compressionMethod}.`);
 
   if (!bestMatchMetadata || !compressionMethod) {
     saveState({
       cacheHitKind: 'none',
+      targetFileName: exactFileName,
     });
+
     core.setOutput('cache-hit', 'false');
     console.log('😢 No cache candidate found (missing metadata).');
     return;
@@ -129,13 +137,10 @@ async function main() {
       extractTar(tmpFile.path, compressionMethod, workspace),
     );
 
-    const state: State = {
+    saveState({
       cacheHitKind: bestMatchKind,
-    };
-
-    core.debug(compressionMethod);
-    saveState(state);
-
+      targetFileName: exactFileName,
+    });
     core.setOutput('cache-hit', 'true');
     console.log('✅ Successfully restored cache.');
   });

src/post.ts

@@ -1,5 +1,4 @@
 import * as core from '@actions/core';
-import * as github from '@actions/github';
 import * as glob from '@actions/glob';
 import { Storage } from '@google-cloud/storage';
 import * as path from 'path';
@@ -14,9 +13,6 @@ async function main() {
   const inputs = getInputs();
   const state = getState();
 
-  core.debug(JSON.stringify(inputs));
-  core.debug(JSON.stringify(state));
-
   if (state.cacheHitKind === 'exact') {
     console.log(
       '🌀 Skipping uploading cache as the cache was hit by exact match.',
@@ -25,12 +21,10 @@ async function main() {
   }
 
   const bucket = new Storage().bucket(inputs.bucket);
-  const folderPrefix = `${github.context.repo.owner}/${github.context.repo.repo}`;
-
-  const targetFileName = `${folderPrefix}/${inputs.key}.tar`;
+  const targetFileName = state.targetFileName;
   const [targetFileExists] = await bucket.file(targetFileName).exists();
 
-  core.debug(targetFileName);
+  core.debug(`Target file name: ${targetFileName}.`);
 
   if (targetFileExists) {
     console.log(
@@ -48,7 +42,7 @@ async function main() {
     .glob()
     .then((files) => files.map((file) => path.relative(workspace, file)));
 
-  core.debug(JSON.stringify(paths));
+  core.debug(`Paths: ${JSON.stringify(paths)}.`);
 
   return withTemporaryFile(async (tmpFile) => {
     const compressionMethod = await core.group(
@@ -60,7 +54,7 @@ async function main() {
       'Cache-Action-Compression-Method': compressionMethod,
     };
 
-    core.debug(JSON.stringify(customMetadata));
+    core.debug(`Metadata: ${JSON.stringify(customMetadata)}.`);
 
     await core.group('🌐 Uploading cache archive to bucket', async () => {
       console.log(`🔹 Uploading file '${targetFileName}'...`);

src/state.ts

@@ -4,14 +4,23 @@ export type CacheHitKindState = 'exact' | 'partial' | 'none';
 
 export interface State {
   cacheHitKind: CacheHitKindState;
+  targetFileName: string;
 }
 
 export function saveState(state: State): void {
+  core.debug(`Saving state: ${JSON.stringify(state)}.`);
+
   core.saveState('cache-hit-kind', state.cacheHitKind);
+  core.saveState('target-file-name', state.targetFileName);
 }
 
 export function getState(): State {
-  return {
+  const state = {
     cacheHitKind: core.getState('cache-hit-kind') as CacheHitKindState,
+    targetFileName: core.getState('target-file-name'),
   };
+
+  core.debug(`Loaded state: ${JSON.stringify(state)}.`);
+
+  return state;
 }