Merge branch 'stage' into Dot-4961

Author: parthlambdatest

src/lib/ctx.ts

@@ -104,7 +104,8 @@ export default (options: Record<string, string>): Context => {
             useGlobalCache: config.useGlobalCache ?? false,
             ignoreHTTPSErrors: config.ignoreHTTPSErrors ?? false,
             skipBuildCreation: config.skipBuildCreation ?? false,
-            tunnel: tunnelObj
+            tunnel: tunnelObj,
+            userAgent: config.userAgent || ''
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/processSnapshot.ts

@@ -180,7 +180,7 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
                     ctx.log.debug(`Resource had a disallowed status for retry as well  ${requestUrl} disallowed status [${responseOfRetry.status()}]`);
                     if (responseOfRetry && responseOfRetry.headers()) {
                         const responseHeadersRetry = responseOfRetry.headers();
-                        ctx.log.debug(`Response headers for ${requestUrl}: ${JSON.stringify(responseHeadersRetry, null, 2)}`);
+                        ctx.log.debug(`Response headers for retry ${requestUrl}: ${JSON.stringify(responseHeadersRetry, null, 2)}`);
                     }
 
                     let data = {
@@ -203,8 +203,6 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
                         discoveryErrors.browsers[globalBrowser][globalViewport]?.push(data);
                     }
                 }
-
-
             } else {
                 ctx.log.debug(`Handling request ${requestUrl}\n - content-type ${response.headers()['content-type']}`);
 

src/lib/schemaValidation.ts

@@ -244,6 +244,10 @@ const ConfigSchema = {
             required: ["type"],
             additionalProperties: false
         },
+        userAgent: {
+            type: "string",
+            errorMessage: "User Agent value must be a valid string"
+        },
     },
     anyOf: [
         { required: ["web"] },
@@ -274,6 +278,10 @@ const WebStaticConfigSchema: JSONSchemaType<WebStaticConfig> = {
                 maximum: 30000,
                 errorMessage: "waitForTimeout must be > 0 and <= 30000"
             },
+            userAgent: {
+                type: "string",
+                errorMessage: "User Agent value must be a valid string"
+            },
             execute: {
                 type: "object",
                 properties: {

src/lib/screenshot.ts

@@ -16,12 +16,12 @@ async function captureScreenshotsForConfig(
 ): Promise<void> {
     ctx.log.debug(`*** urlConfig  ${JSON.stringify(urlConfig)}`);
 
-    let {name, url, waitForTimeout, execute, pageEvent} = urlConfig;
+    let {name, url, waitForTimeout, execute, pageEvent, userAgent} = urlConfig;
     let afterNavigationScript = execute?.afterNavigation;
     let beforeSnapshotScript = execute?.beforeSnapshot;
     let waitUntilEvent = pageEvent || process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || 'load';
 
-    let pageOptions = { waitUntil: waitUntilEvent, timeout: ctx.config.waitForPageRender || constants.DEFAULT_PAGE_LOAD_TIMEOUT };
+    let pageOptions = { waitUntil: waitUntilEvent, timeout: ctx.config.waitForPageRender || constants.DEFAULT_PAGE_LOAD_TIMEOUT};
     ctx.log.debug(`url:  ${url}  pageOptions: ${JSON.stringify(pageOptions)}`);
     let ssId = name.toLowerCase().replace(/\s/g, '_');
     let context: BrowserContext;
@@ -31,6 +31,14 @@ async function captureScreenshotsForConfig(
     else if (browserName == constants.FIREFOX) contextOptions.userAgent = constants.FIREFOX_USER_AGENT;
     else if (browserName == constants.SAFARI) contextOptions.userAgent = constants.SAFARI_USER_AGENT;
     else if (browserName == constants.EDGE) contextOptions.userAgent = constants.EDGE_USER_AGENT;
+    if (ctx.config.userAgent || userAgent) {
+        if(ctx.config.userAgent !== ""){
+        contextOptions.userAgent = ctx.config.userAgent;
+        }
+        if (userAgent && userAgent !== "") {
+            contextOptions.userAgent = userAgent;
+        }
+    }
 
     try {
         const browser = browsers[browserName];

src/types.ts

@@ -34,6 +34,7 @@ export interface Context {
         ignoreHTTPSErrors : boolean;
         skipBuildCreation?: boolean;
         tunnel: tunnelConfig | undefined;
+        userAgent?: string;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -175,7 +176,8 @@ export interface MobileConfig {
 export type WebStaticConfig = Array<{
     name: string;
     url: string;
-    waitForTimeout?: number
+    waitForTimeout?: number;
+    userAgent?: string;
 }>;
 
 export type FigmaConfigItem = {