fix(action): do not set status if it's already set for new image case (#723)

Co-authored-by: danadajian <danadajian@users.noreply.github.com>

Author: danadajian

action/dist/main.js

@@ -163926,7 +163926,8 @@ var run = async () => {
       `New visual tests found! ${newFileCount} images will be uploaded as new base images.`
     );
     await uploadBaseImages(newFilePaths);
-    if (!commitHash) return;
+    if (!commitHash || latestVisualRegressionStatus?.state === "failure")
+      return;
     return octokit.rest.repos.createCommitStatus({
       sha: commitHash,
       context: VISUAL_REGRESSION_CONTEXT,

action/dist/main.js.map

@@ -159,7 +159,8 @@ export const run = async () => {
       `New visual tests found! ${newFileCount} images will be uploaded as new base images.`
     );
     await uploadBaseImages(newFilePaths);
-    if (!commitHash) return;
+    if (!commitHash || latestVisualRegressionStatus?.state === 'failure')
+      return;
     return octokit.rest.repos.createCommitStatus({
       sha: commitHash,
       context: VISUAL_REGRESSION_CONTEXT,

action/src/run.ts

@@ -430,6 +430,27 @@ describe('main', () => {
     expect(createCommentMock).not.toHaveBeenCalled();
   });
 
+  it('should not set successful commit status if latest Visual Regression status is failure and only new images were created', async () => {
+    execMock.mockResolvedValue(0);
+    globMock.mockResolvedValue([
+      'path/to/screenshots/newTest1/new.png',
+      'path/to/screenshots/newTest2/new.png'
+    ]);
+    listCommitStatusesForRefMock.mockImplementationOnce(() => ({
+      data: [
+        {
+          context: VISUAL_REGRESSION_CONTEXT,
+          created_at: '2023-05-21T16:51:29Z',
+          state: 'failure',
+          description: 'A visual regression was detected!'
+        }
+      ]
+    }));
+    await runAction();
+    expect(putObjectMock).toHaveBeenCalled();
+    expect(createCommitStatusMock).not.toHaveBeenCalled();
+  });
+
   it('should pass and upload base images if visual tests pass and only new images were created  with diff-id input', async () => {
     getInputMock.mockImplementation(name => diffIdInputMap[name]);
     execMock.mockResolvedValue(0);