Merge pull request #275 from greydaemon/DOT-5128

[DOT-5128] added support for userAgent in cli capture

Author: sushobhit-lt

src/lib/ctx.ts

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

src/lib/schemaValidation.ts

@@ -196,6 +196,10 @@ const ConfigSchema = {
             type: "string",
             errorMessage: "Invalid config; tunnelName must be string"
         },
+        userAgent: {
+            type: "string",
+            errorMessage: "Invalid config; userAgent must be string"
+        },
     },
     anyOf: [
         { required: ["web"] },
@@ -226,6 +230,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 (urlConfig.userAgent !== "" && urlConfig.userAgent !== undefined) {
+            contextOptions.userAgent = userAgent;
+        }
+    }
 
     try {
         const browser = browsers[browserName];

src/types.ts

@@ -35,6 +35,7 @@ export interface Context {
         skipBuildCreation?: boolean;
         tunnel?: boolean;
         tunnelName?: string;
+        userAgent?: string;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -174,7 +175,8 @@ export interface MobileConfig {
 export type WebStaticConfig = Array<{
     name: string;
     url: string;
-    waitForTimeout?: number
+    waitForTimeout?: number;
+    userAgent?: string;
 }>;
 
 export type FigmaConfigItem = {