Merge pull request #359 from Nick-1234531/DOT-6136

Screenshot and build level threshold

Author: parthlambdatest

src/lib/ctx.ts

@@ -39,6 +39,12 @@ export default (options: Record<string, string>): Context => {
                 delete config.web.resolutions;
             }
 
+            if(config.approvalThreshold && config.rejectionThreshold) {
+                if(config.rejectionThreshold <= config.approvalThreshold) {
+                    throw new Error('Invalid config; rejectionThreshold must be greater than approvalThreshold');
+                }
+            }
+
             let validateConfigFn = options.scheduled ? validateConfigForScheduled : validateConfig;
 
             // validate config
@@ -142,6 +148,8 @@ export default (options: Record<string, string>): Context => {
             useLambdaInternal: useLambdaInternal,
             useExtendedViewport: useExtendedViewport,
             loadDomContent: loadDomContent,
+            approvalThreshold: config.approvalThreshold,
+            rejectionThreshold: config.rejectionThreshold,
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/httpClient.ts

@@ -344,24 +344,33 @@ export default class httpClient {
         }, ctx.log)
     }
 
-    processSnapshot(ctx: Context, snapshot: ProcessedSnapshot, snapshotUuid: string,  discoveryErrors: DiscoveryErrors, variantCount: number, sync: boolean = false) {
+    processSnapshot(ctx: Context, snapshot: ProcessedSnapshot, snapshotUuid: string,  discoveryErrors: DiscoveryErrors, variantCount: number, sync: boolean = false, approvalThreshold: number| undefined, rejectionThreshold: number| undefined) {
+        const requestData: any = {
+            name: snapshot.name,
+            url: snapshot.url,
+            snapshotUuid: snapshotUuid,
+            variantCount: variantCount,
+            test: {
+                type: ctx.testType,
+                source: 'cli'
+            },
+            discoveryErrors: discoveryErrors,
+            doRemoteDiscovery: snapshot.options.doRemoteDiscovery,
+            sync: sync
+        };
+
+        if (approvalThreshold !== undefined) {
+            requestData.approvalThreshold = approvalThreshold;
+        }
+        if (rejectionThreshold !== undefined) {
+            requestData.rejectionThreshold = rejectionThreshold;
+        }
+
         return this.request({
             url: `/build/${ctx.build.id}/snapshot`,
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
-            data: {
-                name: snapshot.name,
-                url: snapshot.url,
-                snapshotUuid: snapshotUuid,
-                variantCount: variantCount,
-                test: {
-                    type: ctx.testType,
-                    source: 'cli'
-                },
-                doRemoteDiscovery: snapshot.options.doRemoteDiscovery,
-                discoveryErrors: discoveryErrors,
-                sync: sync
-            }
+            data: requestData
         }, ctx.log)
     }
 

src/lib/schemaValidation.ts

@@ -279,6 +279,18 @@ const ConfigSchema = {
         loadDomContent: {
             type: "boolean",
             errorMessage: "Invalid config; loadDomContent must be true/false"
+        },
+        approvalThreshold: {
+            type: "number",
+            minimum: 0,
+            maximum: 100,
+            errorMessage: "Invalid config; approvalThreshold must be a number"
+        },
+        rejectionThreshold: {
+            type: "number",
+            minimum: 0,
+            maximum: 100,
+            errorMessage: "Invalid config; rejectionThreshold must be a number"
         }
     },
     anyOf: [
@@ -542,6 +554,18 @@ const SnapshotSchema: JSONSchemaType<Snapshot> = {
                 useExtendedViewport: {
                     type: "boolean",
                     errorMessage: "Invalid snapshot options; useExtendedViewport must be a boolean"
+                },
+                approvalThreshold: {
+                    type: "number",
+                    minimum: 0,
+                    maximum: 100,
+                    errorMessage: "Invalid snapshot options; approvalThreshold must be a number between 0 and 100"
+                },
+                rejectionThreshold: {
+                    type: "number",
+                    minimum: 0,
+                    maximum: 100,
+                    errorMessage: "Invalid snapshot options; rejectionThreshold must be a number between 0 and 100"
                 }
             },
             additionalProperties: false

src/lib/server.ts

@@ -38,6 +38,12 @@ export default async (ctx: Context): Promise<FastifyInstance<Server, IncomingMes
 		try {
 			let { snapshot, testType } = request.body;
 			if (!validateSnapshot(snapshot)) throw new Error(validateSnapshot.errors[0].message);
+
+			if(snapshot?.options?.approvalThreshold !== undefined && snapshot?.options?.rejectionThreshold !== undefined) {
+				if(snapshot?.options?.rejectionThreshold <= snapshot?.options?.approvalThreshold) {
+					throw new Error(`Invalid snapshot options; rejectionThreshold (${snapshot.options.rejectionThreshold}) must be greater than approvalThreshold (${snapshot.options.approvalThreshold})`);
+				}
+			}
 
 			// Fetch sessionId from snapshot options if present
 			const sessionId = snapshot?.options?.sessionId;

src/lib/snapshotQueue.ts

@@ -427,7 +427,9 @@ export default class Queue {
                                 }
                                 this.processNext();
                             } else {
-                                await this.ctx.client.processSnapshot(this.ctx, processedSnapshot, snapshotUuid, discoveryErrors,calculateVariantCountFromSnapshot(processedSnapshot, this.ctx.config),snapshot?.options?.sync);
+                                let approvalThreshold = snapshot?.options?.approvalThreshold || this.ctx.config.approvalThreshold;
+                                let rejectionThreshold = snapshot?.options?.rejectionThreshold || this.ctx.config.rejectionThreshold;
+                                await this.ctx.client.processSnapshot(this.ctx, processedSnapshot, snapshotUuid, discoveryErrors,calculateVariantCountFromSnapshot(processedSnapshot, this.ctx.config),snapshot?.options?.sync, approvalThreshold, rejectionThreshold);
                                 if(snapshot?.options?.contextId && this.ctx.contextToSnapshotMap?.has(snapshot.options.contextId)){
                                     this.ctx.contextToSnapshotMap.set(snapshot.options.contextId, 1);
                                 }

src/tasks/processSnapshot.ts

@@ -36,6 +36,9 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
                 }
                 task.output = output;
                 task.title = 'Processed snapshots'
+                if(ctx.snapshotQueue?.getProcessedSnapshots()?.length === 0){
+                    task.title = 'No snapshots processed';
+                }
             } catch (error: any) {
                 ctx.log.debug(error);
                 task.output = chalk.gray(error.message);

src/types.ts

@@ -40,6 +40,8 @@ export interface Context {
         useLambdaInternal?: boolean;
         useExtendedViewport?: boolean;
         loadDomContent?: boolean;
+        approvalThreshold?: number;
+        rejectionThreshold?: number;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -156,6 +158,8 @@ export interface Snapshot {
         sync?: boolean;
         contextId?: string;
         useExtendedViewport?: boolean;
+        approvalThreshold?: number;
+        rejectionThreshold?: number;
     }
 }