feat: use-base-images-param (#640)

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

Author: danadajian

action.yml

@@ -14,8 +14,8 @@ inputs:
   diff-id:
     description: 'Alternative to commit-hash as a unique identifier for visual tests. GitHub integration will be disabled if diff-id is used.'
     required: false
-  download-base-images:
-    description: 'optionally enable downloading of base images from S3 to be skipped'
+  use-base-images:
+    description: 'Optionally disables base images from being used'
     required: false
     default: 'true'
   screenshots-directory:

action/dist/main.js

@@ -19712,7 +19712,7 @@ var require_core = __commonJS({
       return inputs.map((input) => input.trim());
     }
     exports2.getMultilineInput = getMultilineInput2;
-    function getBooleanInput2(name, options) {
+    function getBooleanInput3(name, options) {
       const trueValue = ["true", "True", "TRUE"];
       const falseValue = ["false", "False", "FALSE"];
       const val = getInput6(name, options);
@@ -19723,7 +19723,7 @@ var require_core = __commonJS({
       throw new TypeError(`Input does not meet YAML 1.2 "Core Schema" specification: ${name}
 Support boolean input list: \`true | True | TRUE | false | False | FALSE\``);
     }
-    exports2.getBooleanInput = getBooleanInput2;
+    exports2.getBooleanInput = getBooleanInput3;
     function setOutput(name, value) {
       const filePath = process.env["GITHUB_OUTPUT"] || "";
       if (filePath) {
@@ -35903,8 +35903,9 @@ var buildComparadiseUrl = () => {
   const commitHash = (0, import_core3.getInput)("commit-hash");
   const diffId = (0, import_core3.getInput)("diff-id");
   const hashParam = commitHash ? `commitHash=${commitHash}` : `diffId=${diffId}`;
+  const useBaseImages = (0, import_core3.getBooleanInput)("use-base-images") ?? true;
   const { owner, repo } = import_github2.context.repo;
-  return `${comparadiseHost}/?${hashParam}&owner=${owner}&repo=${repo}&bucket=${bucketName}`;
+  return `${comparadiseHost}/?${hashParam}&owner=${owner}&repo=${repo}&bucket=${bucketName}&useBaseImages=${useBaseImages}`;
 };
 
 // src/comment.ts
@@ -35996,8 +35997,8 @@ var run = async () => {
   }
   const hash = commitHash || diffId;
   const screenshotsDirectory = (0, import_core6.getInput)("screenshots-directory");
-  const downloadImages = (0, import_core6.getBooleanInput)("download-base-images") ?? true;
-  if (downloadImages) {
+  const useBaseImages = (0, import_core6.getBooleanInput)("use-base-images") ?? true;
+  if (useBaseImages) {
     await downloadBaseImages();
   }
   const visualTestExitCode = await Promise.all(

action/dist/main.js.map

@@ -1,4 +1,4 @@
-import { getInput } from '@actions/core';
+import { getBooleanInput, getInput } from '@actions/core';
 import { context } from '@actions/github';
 
 export const buildComparadiseUrl = () => {
@@ -9,7 +9,8 @@ export const buildComparadiseUrl = () => {
   const hashParam = commitHash
     ? `commitHash=${commitHash}`
     : `diffId=${diffId}`;
+  const useBaseImages = getBooleanInput('use-base-images') ?? true;
   const { owner, repo } = context.repo;
 
-  return `${comparadiseHost}/?${hashParam}&owner=${owner}&repo=${repo}&bucket=${bucketName}`;
+  return `${comparadiseHost}/?${hashParam}&owner=${owner}&repo=${repo}&bucket=${bucketName}&useBaseImages=${useBaseImages}`;
 };

action/src/build-comparadise-url.ts

@@ -43,8 +43,8 @@ export const run = async () => {
 
   const screenshotsDirectory = getInput('screenshots-directory');
 
-  const downloadImages = getBooleanInput('download-base-images') ?? true;
-  if (downloadImages) {
+  const useBaseImages = getBooleanInput('use-base-images') ?? true;
+  if (useBaseImages) {
     await downloadBaseImages();
   }
 

action/src/run.ts

@@ -205,7 +205,7 @@ describe('main', () => {
       state: 'failure',
       description: 'A visual regression was detected. Check Comparadise!',
       target_url:
-        'https://comparadise.app/?commitHash=sha&owner=owner&repo=repo&bucket=some-bucket'
+        'https://comparadise.app/?commitHash=sha&owner=owner&repo=repo&bucket=some-bucket&useBaseImages=true'
     });
     expect(octokit.rest.issues.createComment).toHaveBeenCalled();
   });
@@ -412,7 +412,7 @@ describe('main', () => {
     assertNoOctokitCalls();
   });
 
-  it('should download base images if download-base-images specified as true', async () => {
+  it('should download base images if use-base-images specified as true', async () => {
     const downloadBaseImages = true;
     (exec as jest.Mock).mockResolvedValue(0);
     (getInput as jest.Mock).mockImplementation(name => inputMap[name]);
@@ -428,7 +428,7 @@ describe('main', () => {
     );
   });
 
-  it('should not download base images if download-base-images specified as false', async () => {
+  it('should not download base images if use-base-images specified as false and set URL param', async () => {
     const downloadBaseImages = false;
     (exec as jest.Mock).mockResolvedValue(0);
     (getInput as jest.Mock).mockImplementation(name => inputMap[name]);
@@ -442,6 +442,16 @@ describe('main', () => {
     expect(exec).not.toHaveBeenCalledWith(
       `aws s3 cp s3://some-bucket/${BASE_IMAGES_DIRECTORY} path/to/screenshots --recursive`
     );
+    expect(octokit.rest.repos.createCommitStatus).toHaveBeenCalledWith({
+      owner: 'owner',
+      repo: 'repo',
+      sha: 'sha',
+      context: VISUAL_REGRESSION_CONTEXT,
+      state: 'failure',
+      description: 'A visual regression was detected. Check Comparadise!',
+      target_url:
+        'https://comparadise.app/?commitHash=sha&owner=owner&repo=repo&bucket=some-bucket&useBaseImages=false'
+    });
   });
 
   it('should not download base images if aws ls call fails', async () => {

action/test/run.test.ts

@@ -14,6 +14,7 @@ import { updateCommitStatus } from './updateCommitStatus';
 export const acceptVisualChanges = async ({
   commitHash,
   diffId,
+  useBaseImages,
   bucket,
   owner,
   repo
@@ -35,8 +36,10 @@ export const acceptVisualChanges = async ({
     });
   }
 
-  const s3Paths = await getKeysFromS3(hash, bucket);
-  await updateBaseImages(s3Paths, bucket);
+  if (useBaseImages) {
+    const s3Paths = await getKeysFromS3(hash, bucket);
+    await updateBaseImages(s3Paths, bucket);
+  }
   if (commitHash) {
     await updateCommitStatus({ owner, repo, commitHash });
   }

app/backend/src/acceptVisualChanges.ts

@@ -8,6 +8,7 @@ export const fetchCurrentPageInputSchema = z.object({
 export const acceptVisualChangesInputSchema = z.object({
   commitHash: z.string().min(1).optional(),
   diffId: z.string().min(1).optional(),
+  useBaseImages: z.boolean().optional().default(true),
   bucket: z.string().min(1),
   repo: z.string().min(1),
   owner: z.string().min(1)

app/backend/src/schema.ts

@@ -91,6 +91,7 @@ describe('acceptVisualChanges', () => {
       acceptVisualChanges({
         commitHash: '030928b2c4b48ab4d3b57c8e0b0f7a56db768ef5',
         bucket: expectedBucket,
+        useBaseImages: true,
         repo: 'repo',
         owner: 'owner'
       })
@@ -100,4 +101,22 @@ describe('acceptVisualChanges', () => {
     expect(S3Client.copyObject).not.toHaveBeenCalled();
     expect(updateCommitStatus).not.toHaveBeenCalled();
   });
+
+  it('should update commit status but not base images if useBaseImages is false', async () => {
+    (findReasonToPreventVisualChangeAcceptance as jest.Mock).mockResolvedValue(
+      undefined
+    );
+    const expectedBucket = 'expected-bucket-name';
+    await acceptVisualChanges({
+      commitHash: '030928b2c4b48ab4d3b57c8e0b0f7a56db768ef5',
+      bucket: expectedBucket,
+      useBaseImages: false,
+      repo: 'repo',
+      owner: 'owner'
+    });
+
+    expect(S3Client.listObjectsV2).not.toHaveBeenCalled();
+    expect(S3Client.copyObject).not.toHaveBeenCalled();
+    expect(updateCommitStatus).toHaveBeenCalled();
+  });
 });

app/backend/test/acceptVisualChanges.test.ts

@@ -50,10 +50,14 @@ export const UpdateImagesButton: React.FC<{ disabled: boolean }> = ({
     setDialogIsOpen(false);
   };
 
+  const useBaseImages = params.useBaseImages
+    ? params.useBaseImages === 'true'
+    : undefined;
   const handleUpdate = () =>
     acceptVisualChanges({
       commitHash,
       diffId,
+      useBaseImages,
       bucket,
       owner,
       repo