Merge pull request #433 from LambdaTest/stage

Release PR for Adding support for do not use user agents in context

Author: sushobhit-lt

package.json

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

src/commander/commander.ts

@@ -23,6 +23,8 @@ program
     .option('--baselineBranch <string>', 'Mark this build baseline')
     .option('--baselineBuild <string>', 'Mark this build baseline')
     .option('--githubURL <string>', 'GitHub URL including commitId')
+    .option('--userName <string>', 'Specify the LT username')
+    .option('--accessKey <string>', 'Specify the LT accesskey')
     .addCommand(exec)
     .addCommand(capture)
     .addCommand(configWeb)

src/commander/exec.ts

@@ -24,8 +24,6 @@ command
     .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')
     .option('--show-render-errors', 'Show render errors from SmartUI build')
     .action(async function(execCommand, _, command) {
         const options = command.optsWithGlobals();

src/lib/env.ts

@@ -26,7 +26,8 @@ export default (): Env => {
         SHOW_RENDER_ERRORS,
         SMARTUI_SSE_URL='https://server-events.lambdatest.com',
         LT_SDK_SKIP_EXECUTION_LOGS,
-        MAX_CONCURRENT_PROCESSING
+        MAX_CONCURRENT_PROCESSING,
+        DO_NOT_USE_USER_AGENT,
     } = process.env
 
     return {
@@ -55,5 +56,6 @@ export default (): Env => {
         SMARTUI_SSE_URL,
         LT_SDK_SKIP_EXECUTION_LOGS: LT_SDK_SKIP_EXECUTION_LOGS === 'true',
         MAX_CONCURRENT_PROCESSING: MAX_CONCURRENT_PROCESSING ? parseInt(MAX_CONCURRENT_PROCESSING, 10) : 0,
+        DO_NOT_USE_USER_AGENT: DO_NOT_USE_USER_AGENT === 'true',
     }
 }

src/lib/processSnapshot.ts

@@ -237,8 +237,11 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
     }
     let contextOptions: Record<string, any> = {
         javaScriptEnabled: ctx.config.cliEnableJavaScript,
-        userAgent: constants.CHROME_USER_AGENT,
-        ignoreHTTPSErrors : ctx.config.ignoreHTTPSErrors
+        ignoreHTTPSErrors: ctx.config.ignoreHTTPSErrors,
+    };
+
+    if (!ctx.env.DO_NOT_USE_USER_AGENT) {
+        contextOptions.userAgent = constants.CHROME_USER_AGENT;
     }
     if (!ctx.browser?.isConnected()) {
         if (ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY) launchOptions.proxy = { server: ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY };

src/types.ts

@@ -137,6 +137,7 @@ export interface Env {
     SMARTUI_SSE_URL: string;
     LT_SDK_SKIP_EXECUTION_LOGS: boolean;
     MAX_CONCURRENT_PROCESSING: number;
+    DO_NOT_USE_USER_AGENT: boolean;
 }
 
 export interface Snapshot {