Merge branch 'stage' into ping_test

lt-zeeshan · web-flow · commit f6ee8e29f219 · 2025-08-18T15:00:20.000+05:30
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.17",
+  "version": "4.1.21",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"
diff --git a/src/commander/capture.ts b/src/commander/capture.ts
@@ -20,6 +20,7 @@ command
     .option('-F, --force', 'forcefully apply the specified parallel instances per browser')
     .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
     .option('--buildName <string>', 'Specify the build name')
+    .option('--scheduled <string>', 'Specify the schedule ID')
     .option('--userName <string>', 'Specify the LT username')
     .option('--accessKey <string>', 'Specify the LT accesskey')
     .action(async function(file, _, command) {
@@ -38,7 +39,6 @@ command
         try {
             ctx.webStaticConfig = JSON.parse(fs.readFileSync(file, 'utf8'));
             if (!validateWebStaticConfig(ctx.webStaticConfig)){
-
                 ctx.log.debug(JSON.stringify(validateWebStaticConfig.errors, null, 2));
                 // Iterate and add warning for "additionalProperties"
                 validateWebStaticConfig.errors?.forEach(error => {
@@ -58,6 +58,7 @@ command
             }
         } catch (error: any) {
             ctx.log.error(`Invalid Web Static Config; ${error.message}`);
+            process.exitCode = 1;
             return;
         }
         //Print Config here in debug mode
@@ -88,6 +89,7 @@ command
         } catch (error) {
             console.log('\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/');
             process.exitCode = 1;
+            throw new Error();
         }
 
     })
diff --git a/src/commander/exec.ts b/src/commander/exec.ts
@@ -22,6 +22,7 @@ command
     .option('-P, --port <number>', 'Port number for the server')
     .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
     .option('--buildName <string>', 'Specify the build name')
+    .option('--scheduled <string>', 'Specify the schedule ID')
     .option('--userName <string>', 'Specify the LT username')
     .option('--accessKey <string>', 'Specify the LT accesskey')
     .action(async function(execCommand, _, command) {
diff --git a/src/lib/constants.ts b/src/lib/constants.ts
@@ -360,7 +360,7 @@ export default {
 
     FIGMA_API: 'https://api.figma.com/v1/',
     DEFAULT_FIGMA_CONFIG: {
-        "depth": 2,
+        "depth": 1,
         "figma_config": [
             {
                 "figma_file_token": "token_for_first_figma_file",
@@ -381,7 +381,7 @@ export default {
             ]
         },
         figma: {
-            "depth": 2,
+            "depth": 1,
             "configs": [
                 {
                     "figma_file_token": "<token>",
@@ -408,7 +408,7 @@ export default {
             }
         ],
         figma: {
-            "depth": 2,
+            "depth": 1,
             "configs": [
                 {
                     "figma_file_token": "<token>",
diff --git a/src/lib/ctx.ts b/src/lib/ctx.ts
@@ -1,7 +1,7 @@
 import { Context, Env, WebConfig, MobileConfig, basicAuth, tunnelConfig } from '../types.js'
 import constants from './constants.js'
 import { version } from '../../package.json'
-import { validateConfig } from './schemaValidation.js'
+import { validateConfig, validateConfigForScheduled } from './schemaValidation.js'
 import logger from './logger.js'
 import getEnv from './env.js'
 import httpClient from './httpClient.js'
@@ -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'));
@@ -35,9 +36,11 @@ export default (options: Record<string, string>): Context => {
                 delete config.web.resolutions;
             }
 
+            let validateConfigFn = options.scheduled ? validateConfigForScheduled : validateConfig;
+
             // validate config
-            if (!validateConfig(config)) {
-                throw new Error(validateConfig.errors[0].message);
+            if (!validateConfigFn(config)) {
+                throw new Error(validateConfigFn.errors[0].message);
             }
         } else {
             logger.info("## No config file provided. Using default config.");
@@ -70,7 +73,7 @@ export default (options: Record<string, string>): Context => {
         }
     } catch (error: any) {
         console.log(`[smartui] Error: ${error.message}`);
-        process.exit();
+        process.exit(1);
     }
 
     if (config.web) {
@@ -85,10 +88,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 +120,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: [],
@@ -142,6 +149,7 @@ export default (options: Record<string, string>): Context => {
             force: options.force ? true : false,
             markBaseline: options.markBaseline ? true : false,
             buildName: options.buildName || '',
+            scheduled: options.scheduled || '',
             port: port,
             ignoreResolutions: resolutionOff,
             fileExtension: extensionFiles,
diff --git a/src/lib/httpClient.ts b/src/lib/httpClient.ts
@@ -202,7 +202,7 @@ export default class httpClient {
         }
     }
 
-    createBuild(git: Git, config: any, log: Logger, buildName: string, isStartExec: boolean, smartGit: boolean, markBaseline: boolean, baselineBuild: string) {
+    createBuild(git: Git, config: any, log: Logger, buildName: string, isStartExec: boolean, smartGit: boolean, markBaseline: boolean, baselineBuild: string, scheduled?: string) {
         return this.request({
             url: '/build',
             method: 'POST',
@@ -214,7 +214,8 @@ export default class httpClient {
                 packageVersion: pkgJSON.version,
                 smartGit,
                 markBaseline,
-                baselineBuild
+                baselineBuild,
+                scheduled
             }
         }, log)
     }
diff --git a/src/lib/schemaValidation.ts b/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: [
@@ -508,8 +512,8 @@ const FigmaDesignConfigSchema: JSONSchemaType<FigmaDesignConfig> = {
     properties: {
         depth: {
             type: "integer",
-            minimum: 2,
-            errorMessage: "Depth must be an integer and greater than 1"
+            minimum: 1,
+            errorMessage: "Depth must be an integer and greater than 0"
         },
         figma_config: {
             type: "array",
@@ -582,8 +586,8 @@ const FigmaWebConfigSchema: JSONSchemaType<Object> = {
             "properties": {
                 depth: {
                     type: "integer",
-                    minimum: 2,
-                    errorMessage: "Depth must be an integer and greater than 1"
+                    minimum: 1,
+                    errorMessage: "Depth must be an integer and greater than 0"
                 },
                 "configs": {
                     "type": "array",
@@ -698,8 +702,8 @@ const FigmaAppConfigSchema: JSONSchemaType<Object> = {
             "properties": {
                 depth: {
                     type: "integer",
-                    minimum: 2,
-                    errorMessage: "Depth must be an integer and greater than 1"
+                    minimum: 1,
+                    errorMessage: "Depth must be an integer and greater than 0"
                 },
                 "configs": {
                     "type": "array",
@@ -759,4 +763,41 @@ export const validateWebStaticConfig = ajv.compile(WebStaticConfigSchema);
 export const validateSnapshot = ajv.compile(SnapshotSchema);
 export const validateFigmaDesignConfig = ajv.compile(FigmaDesignConfigSchema);
 export const validateWebFigmaConfig = ajv.compile(FigmaWebConfigSchema);
-export const validateAppFigmaConfig = ajv.compile(FigmaAppConfigSchema);
+export const validateAppFigmaConfig = ajv.compile(FigmaAppConfigSchema);
+
+export const validateConfigForScheduled = (config: any) => {
+    validateConfigForScheduled.errors = null;
+    
+    
+    if (!validateConfig(config)) {
+        
+        let errors = validateConfig.errors || [];
+        
+        errors = errors.filter(error => {
+            const message = error.message || '';
+            return !message.includes('max unique viewports allowed - 5')
+        });
+        
+        if (config.web && config.web.viewports && Array.isArray(config.web.viewports)) {
+            if (config.web.viewports.length > 8) {
+                errors.push({
+                    message: "Invalid config; max unique viewports allowed - 8 (scheduled build)",
+                    keyword: "maxItems",
+                    instancePath: "/web/viewports",
+                    schemaPath: "#/properties/web/properties/viewports/maxItems"
+                } as any);
+            }
+        }
+    
+        // If there are any errors remaining, set them and return false
+        if (errors.length > 0) {
+            validateConfigForScheduled.errors = errors;
+            return false;
+        }
+    }
+    
+    return true;
+};
+
+// Initialize the errors property
+validateConfigForScheduled.errors = null;
diff --git a/src/lib/snapshotQueue.ts b/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.`);
                 }
diff --git a/src/tasks/createBuild.ts b/src/tasks/createBuild.ts
@@ -10,7 +10,7 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
             updateLogContext({task: 'createBuild'});
 
             try {
-                let resp = await ctx.client.createBuild(ctx.git, ctx.config, ctx.log, ctx.build.name, ctx.isStartExec, ctx.env.SMART_GIT, ctx.options.markBaseline, ctx.options.baselineBuild);
+                let resp = await ctx.client.createBuild(ctx.git, ctx.config, ctx.log, ctx.build.name, ctx.isStartExec, ctx.env.SMART_GIT, ctx.options.markBaseline, ctx.options.baselineBuild, ctx.options.scheduled);
                 if (resp && resp.data && resp.data.buildId) {
                     ctx.build = {
                         id: resp.data.buildId,
diff --git a/src/tasks/createBuildExec.ts b/src/tasks/createBuildExec.ts
@@ -12,7 +12,7 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
 
             try {
                 if (ctx.authenticatedInitially && !ctx.config.skipBuildCreation) {
-                    let resp = await ctx.client.createBuild(ctx.git, ctx.config, ctx.log, ctx.build.name, ctx.isStartExec, ctx.env.SMART_GIT, ctx.options.markBaseline, ctx.options.baselineBuild);
+                    let resp = await ctx.client.createBuild(ctx.git, ctx.config, ctx.log, ctx.build.name, ctx.isStartExec, ctx.env.SMART_GIT, ctx.options.markBaseline, ctx.options.baselineBuild, ctx.options.scheduled);
                     if (resp && resp.data && resp.data.buildId) {
                         ctx.build = {
                             id: resp.data.buildId,
diff --git a/src/types.ts b/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;
@@ -54,6 +55,7 @@ export interface Context {
         force?: boolean,
         markBaseline?: boolean,
         buildName?: string,
+        scheduled?: string,
         port?: number,
         ignoreResolutions?: boolean,
         fileExtension?: Array<string>,

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@lambdatest/smartui-cli",`
`3`		`- "version": "4.1.17",`
	`3`	`+ "version": "4.1.21",`
`4`	`4`	`"description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",`
`5`	`5`	`"files": [`
`6`	`6`	`"dist/*/"`
Original file line number	Diff line number	Diff line change
`@@ -360,7 +360,7 @@ export default {`
`360`	`360`
`361`	`361`	`FIGMA_API: 'https://api.figma.com/v1/',`
`362`	`362`	`DEFAULT_FIGMA_CONFIG: {`
`363`		`- "depth": 2,`
	`363`	`+ "depth": 1,`
`364`	`364`	`"figma_config": [`
`365`	`365`	`{`
`366`	`366`	`"figma_file_token": "token_for_first_figma_file",`
`@@ -381,7 +381,7 @@ export default {`
`381`	`381`	`]`
`382`	`382`	`},`
`383`	`383`	`figma: {`
`384`		`- "depth": 2,`
	`384`	`+ "depth": 1,`
`385`	`385`	`"configs": [`
`386`	`386`	`{`
`387`	`387`	`"figma_file_token": "<token>",`
`@@ -408,7 +408,7 @@ export default {`
`408`	`408`	`}`
`409`	`409`	`],`
`410`	`410`	`figma: {`
`411`		`- "depth": 2,`
	`411`	`+ "depth": 1,`
`412`	`412`	`"configs": [`
`413`	`413`	`{`
`414`	`414`	`"figma_file_token": "<token>",`
Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ export default class httpClient {`
`202`	`202`	`}`
`203`	`203`	`}`
`204`	`204`
`205`		`- createBuild(git: Git, config: any, log: Logger, buildName: string, isStartExec: boolean, smartGit: boolean, markBaseline: boolean, baselineBuild: string) {`
	`205`	`+ createBuild(git: Git, config: any, log: Logger, buildName: string, isStartExec: boolean, smartGit: boolean, markBaseline: boolean, baselineBuild: string, scheduled?: string) {`
`206`	`206`	`return this.request({`
`207`	`207`	`url: '/build',`
`208`	`208`	`method: 'POST',`
`@@ -214,7 +214,8 @@ export default class httpClient {`
`214`	`214`	`packageVersion: pkgJSON.version,`
`215`	`215`	`smartGit,`
`216`	`216`	`markBaseline,`
`217`		`- baselineBuild`
	`217`	`+ baselineBuild,`
	`218`	`+ scheduled`
`218`	`219`	`}`
`219`	`220`	`}, log)`
`220`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,7 @@ export default class Queue {`
`276`	`276`	this.ctx.log.info(`Processing Snapshot: ${snapshot?.name}`);
`277`	`277`	`}`
`278`	`278`
`279`		`- if (!this.ctx.config.delayedUpload && snapshot && snapshot.name && this.snapshotNames.includes(snapshot.name)) {`
	`279`	`+ if (!this.ctx.config.delayedUpload && snapshot && snapshot.name && this.snapshotNames.includes(snapshot.name) && !this.ctx.config.allowDuplicateSnapshotNames) {`
`280`	`280`	`drop = true;`
`281`	`281`	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.`);
`282`	`282`	`}`