feat(action): Verify no matching cache before save

Prior to saving cache, verify that there is no cache with a matching key
already cached. Previously, we checked if a cache key matching our cache
was present in the load step; if not, we would then proceed to attempt
to save the cache in the save step (assuming we were not in read-only
mode and that there were indeed new Docker images to save). This was
problematic when the action was being run in parallel for multiple jobs;
in that case, there were multiple, unnecessary cache save attempts when
the cache initially missed but was subsequently saved.

Author: mwarres

dist/main/index.js

@@ -86,7 +86,9 @@ describe("Docker images", (): void => {
 
   const assertSaveDockerImages = (
     cacheHit: boolean,
+    key: string,
     readOnly = false,
+    prevSave = false,
   ): void => {
     expect(core.getInput).nthCalledWith<[string, InputOptions]>(1, "key", {
       required: true,
@@ -95,12 +97,20 @@ describe("Docker images", (): void => {
     if (!cacheHit) {
       expect(core.getInput).lastCalledWith("read-only");
       if (!readOnly) {
-        expect(core.getState).lastCalledWith(docker.DOCKER_IMAGES_LIST);
-        expect(core.info).nthCalledWith<[string]>(1, "Listing Docker images.");
-        expect(util.execBashCommand).nthCalledWith<[string]>(
-          1,
-          'docker image list --format "{{ .Repository }}:{{ .Tag }}"',
-        );
+        expect(cache.restoreCache).lastCalledWith([""], key, [], {
+          lookupOnly: true,
+        });
+        if (!prevSave) {
+          expect(core.getState).lastCalledWith(docker.DOCKER_IMAGES_LIST);
+          expect(core.info).nthCalledWith<[string]>(
+            1,
+            "Listing Docker images.",
+          );
+          expect(util.execBashCommand).nthCalledWith<[string]>(
+            1,
+            'docker image list --format "{{ .Repository }}:{{ .Tag }}"',
+          );
+        }
       }
     }
   };
@@ -109,6 +119,7 @@ describe("Docker images", (): void => {
     key: string,
     cacheHit: boolean,
     readOnly: boolean,
+    prevSave: boolean,
     preexistingImages: string[],
     newImages: string[],
   ): Promise<void> => {
@@ -117,14 +128,19 @@ describe("Docker images", (): void => {
     if (!cacheHit) {
       core.getInput.mockReturnValueOnce(readOnly.toString());
       if (!readOnly) {
-        core.getState.mockReturnValueOnce(preexistingImages.join("\n"));
-        const images = preexistingImages.concat(newImages);
-        util.execBashCommand.mockResolvedValueOnce(images.join("\n"));
+        if (prevSave) {
+          cache.restoreCache.mockResolvedValueOnce(key);
+        } else {
+          cache.restoreCache.mockResolvedValueOnce(undefined);
+          core.getState.mockReturnValueOnce(preexistingImages.join("\n"));
+          const images = preexistingImages.concat(newImages);
+          util.execBashCommand.mockResolvedValueOnce(images.join("\n"));
+        }
       }
     }
     await docker.saveDockerImages();
 
-    assertSaveDockerImages(cacheHit, readOnly);
+    assertSaveDockerImages(cacheHit, key, readOnly, prevSave);
   };
 
   const assertCacheNotSaved = (): void => {
@@ -147,6 +163,16 @@ describe("Docker images", (): void => {
     assertCacheNotSaved();
   };
 
+  const assertSavePrevSave = (key: string): void => {
+    expect(core.info).lastCalledWith(
+      "A cache miss occurred during the initial attempt to load Docker " +
+        `images. Subsequently a cache with a matching key, ${key}, was saved. ` +
+        "This can occur when docker-cache is used by multiple jobs run in " +
+        "parallel. Not saving cache.",
+    );
+    assertCacheNotSaved();
+  };
+
   const assertNoNewImagesToSave = (): void => {
     expect(util.execBashCommand).toHaveBeenCalledTimes(1);
     expect(core.info).lastCalledWith("No Docker images to save");
@@ -230,24 +256,28 @@ describe("Docker images", (): void => {
   );
 
   testProp(
-    "are saved unless cache hit, in read-only mode, or new Docker image list is empty",
+    "are saved unless cache hit, in read-only mode, cache already saved, or " +
+      "new Docker image list is empty",
     [
       fullUnicodeString(),
       boolean(),
       boolean(),
+      boolean(),
       uniquePair(dockerImages(), dockerImages()),
     ],
     async (
       key: string,
       cacheHit: boolean,
       readOnly: boolean,
+      prevSave: boolean,
       [preexistingImages, newImages]: [string[], string[]],
     ): Promise<void> => {
       jest.clearAllMocks();
       await mockedSaveDockerImages(
         key,
         cacheHit,
         readOnly,
+        prevSave,
         preexistingImages,
         newImages,
       );
@@ -256,6 +286,8 @@ describe("Docker images", (): void => {
         assertSaveCacheHit(key);
       } else if (readOnly) {
         assertSaveReadOnly(key);
+      } else if (prevSave) {
+        assertSavePrevSave(key);
       } else if (newImages.length === 0) {
         assertNoNewImagesToSave();
       } else {
@@ -264,10 +296,11 @@ describe("Docker images", (): void => {
     },
     {
       examples: [
-        ["my-key", false, false, [["preexisting-image"], ["new-image"]]],
-        ["my-key", false, false, [["preexisting-image"], []]],
-        ["my-key", false, true, [["preexisting-image"], ["new-image"]]],
-        ["my-key", true, false, [["preexisting-image"], ["new-image"]]],
+        ["my-key", false, false, false, [["preexisting-image"], ["new-image"]]],
+        ["my-key", false, false, false, [["preexisting-image"], []]],
+        ["my-key", false, true, false, [["preexisting-image"], ["new-image"]]],
+        ["my-key", true, false, false, [["preexisting-image"], ["new-image"]]],
+        ["my-key", false, false, true, [["preexisting-image"], ["new-image"]]],
       ],
     },
   );

dist/post/index.js

@@ -36,6 +36,18 @@ const saveDockerImages = async (): Promise<void> => {
       `Cache miss occurred on the primary key ${key}. Not saving cache as ` +
         "read-only option was selected.",
     );
+    /* Check if a cache with our key has been saved between when we checked in
+     * loadDockerImages and now.
+     */
+  } else if (
+    key === (await restoreCache([""], key, [], { lookupOnly: true }))
+  ) {
+    info(
+      "A cache miss occurred during the initial attempt to load Docker " +
+        `images. Subsequently a cache with a matching key, ${key}, was saved. ` +
+        "This can occur when docker-cache is used by multiple jobs run in " +
+        "parallel. Not saving cache.",
+    );
   } else {
     const preexistingImages = getState(DOCKER_IMAGES_LIST).split("\n");
     info("Listing Docker images.");