Merge pull request #311 from lt-zeeshan/ignore_delayed_upload_check

Add support for allowDuplicateSnapshotNames configuration

Author: parthlambdatest

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 dist
+.idea
+pnpm-lock.yaml

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.18",
+  "version": "4.1.18-beta.0",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"

src/lib/ctx.ts

@@ -23,6 +23,7 @@ export default (options: Record<string, string>): Context => {
     let fetchResultObj: boolean;
     let fetchResultsFileObj: string;
     let buildNameObj: string;
+    let allowDuplicateSnapshotNames: boolean = false;
     try {
         if (options.config) {
             config = JSON.parse(fs.readFileSync(options.config, 'utf-8'));
@@ -85,10 +86,13 @@ export default (options: Record<string, string>): Context => {
         }
     }
     if (config.basicAuthorization) {
-        basicAuthObj = config.basicAuthorization
+        basicAuthObj = config.basicAuthorization;
     }
     if (config.tunnel) {
-        tunnelObj = config.tunnel
+        tunnelObj = config.tunnel;
+    }
+    if (config.allowDuplicateSnapshotNames) {
+        allowDuplicateSnapshotNames = true;
     }
 
     return {
@@ -114,7 +118,8 @@ export default (options: Record<string, string>): Context => {
             skipBuildCreation: config.skipBuildCreation ?? false,
             tunnel: tunnelObj,
             userAgent: config.userAgent || '',
-            requestHeaders: config.requestHeaders || {}
+            requestHeaders: config.requestHeaders || {},
+            allowDuplicateSnapshotNames: allowDuplicateSnapshotNames,
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/schemaValidation.ts

@@ -258,6 +258,10 @@ const ConfigSchema = {
             errorMessage: {
                 uniqueItems: "Invalid config; duplicates in requestHeaders"
             }
+        },
+        allowDuplicateSnapshotNames: {
+            type: "boolean",
+            errorMessage: "Invalid config; allowDuplicateSnapshotNames must be true/false"
         }
     },
     anyOf: [

src/lib/snapshotQueue.ts

@@ -276,7 +276,7 @@ export default class Queue {
                     this.ctx.log.info(`Processing Snapshot: ${snapshot?.name}`);
                 }
 
-                if (!this.ctx.config.delayedUpload && snapshot && snapshot.name && this.snapshotNames.includes(snapshot.name)) {
+                if (!this.ctx.config.delayedUpload && snapshot && snapshot.name && this.snapshotNames.includes(snapshot.name) && !this.ctx.config.allowDuplicateSnapshotNames) {
                     drop = true;
                     this.ctx.log.info(`Skipping duplicate SmartUI snapshot '${snapshot.name}'. To capture duplicate screenshots, please set the 'delayedUpload' configuration as true in your config file.`);
                 }

src/types.ts

@@ -36,6 +36,7 @@ export interface Context {
         tunnel: tunnelConfig | undefined;
         userAgent?: string;
         requestHeaders?: Array<Record<string, string>>;
+        allowDuplicateSnapshotNames?: boolean;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;