Merge pull request #137 from pinanks/DOT-3925

Dot 3925

Author: arushsaxena1998

package.json

@@ -21,10 +21,10 @@
   "author": "LambdaTest <[email protected]>",
   "license": "MIT",
   "dependencies": {
-    "@playwright/browser-chromium": "^1.45.3",
-    "@playwright/browser-firefox": "^1.45.3",
-    "@playwright/browser-webkit": "^1.45.3",
-    "@playwright/test": "^1.45.3",
+    "@playwright/browser-chromium": "^1.47.2",
+    "@playwright/browser-firefox": "^1.47.2",
+    "@playwright/browser-webkit": "^1.47.2",
+    "@playwright/test": "^1.47.2",
     "@types/cross-spawn": "^6.0.4",
     "@types/node": "^20.8.9",
     "@types/which": "^3.0.2",

pnpm-lock.yaml

@@ -47,6 +47,66 @@ export default {
     EDGE_CHANNEL: 'msedge',
     WEBKIT: 'webkit',
 
+    // discovery browser launch arguments
+    LAUNCH_ARGS: [
+        // disable the translate popup and optimization downloads
+        '--disable-features=Translate,OptimizationGuideModelDownloading',
+        // disable several subsystems which run network requests in the background
+        '--disable-background-networking',
+        // disable task throttling of timer tasks from background pages
+        '--disable-background-timer-throttling',
+        // disable backgrounding renderer processes
+        '--disable-renderer-backgrounding',
+        // disable backgrounding renderers for occluded windows (reduce nondeterminism)
+        '--disable-backgrounding-occluded-windows',
+        // disable crash reporting
+        '--disable-breakpad',
+        // disable client side phishing detection
+        '--disable-client-side-phishing-detection',
+        // disable default component extensions with background pages for performance
+        '--disable-component-extensions-with-background-pages',
+        // disable installation of default apps on first run
+        '--disable-default-apps',
+        // work-around for environments where a small /dev/shm partition causes crashes
+        '--disable-dev-shm-usage',
+        // disable extensions
+        '--disable-extensions',
+        // disable hang monitor dialogs in renderer processes
+        '--disable-hang-monitor',
+        // disable inter-process communication flooding protection for javascript
+        '--disable-ipc-flooding-protection',
+        // disable web notifications and the push API
+        '--disable-notifications',
+        // disable the prompt when a POST request causes page navigation
+        '--disable-prompt-on-repost',
+        // disable syncing browser data with google accounts
+        '--disable-sync',
+        // disable site-isolation to make network requests easier to intercept
+        '--disable-site-isolation-trials',
+        // disable the first run tasks, whether or not it's actually the first run
+        '--no-first-run',
+        // disable the sandbox for all process types that are normally sandboxed
+        '--no-sandbox',
+        // specify a consistent encryption backend across platforms
+        '--password-store=basic',
+        // use a mock keychain on Mac to prevent blocking permissions dialogs
+        '--use-mock-keychain',
+        // enable remote debugging on the first available port
+        '--remote-debugging-port=0',
+        // sets navigator.webdriver to false
+        '--disable-blink-features=AutomationControlled',
+        // disable UA-CH feature
+		`--disable-features=UserAgentClientHint`,
+    ],
+
+    // discovery request headers
+    REQUEST_HEADERS: {
+        // `HeadlessChrome` is added to sec-ch-ua, `--disable-features=UserAgentClientHint` doesn't seem to work
+        'sec-ch-ua':'"Chromium";v="129", "Not=A?Brand";v="8"',
+        'sec-ch-ua-mobile': '"?0"',
+        'sec-ch-ua-platform': '"Windows"'
+    },
+
     // user agents
     CHROME_USER_AGENT: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.6312.107 Safari/537.3',
     FIREFOX_USER_AGENT: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:112.0) Gecko/20100101 Firefox/112.0',

src/lib/constants.ts

@@ -4,22 +4,22 @@ export default (): Env => {
     const {
         PROJECT_TOKEN = '',
         SMARTUI_CLIENT_API_URL = 'https://api.lambdatest.com/visualui/1.0',
-        LT_SDK_DEBUG,
         SMARTUI_GIT_INFO_FILEPATH,
+        SMARTUI_DO_NOT_USE_CAPTURED_COOKIES,
         HTTP_PROXY,
         HTTPS_PROXY,
         GITHUB_ACTIONS,
         FIGMA_TOKEN,
         LT_USERNAME,
         LT_ACCESS_KEY,
+        LT_SDK_DEBUG,
         BASELINE_BRANCH,
         CURRENT_BRANCH
     } = process.env
 
     return {
         PROJECT_TOKEN,
         SMARTUI_CLIENT_API_URL,
-        LT_SDK_DEBUG,
         SMARTUI_GIT_INFO_FILEPATH,
         HTTP_PROXY,
         HTTPS_PROXY,
@@ -29,5 +29,7 @@ export default (): Env => {
         LT_ACCESS_KEY,
         BASELINE_BRANCH,
         CURRENT_BRANCH,
+        LT_SDK_DEBUG: LT_SDK_DEBUG === 'true',
+        SMARTUI_DO_NOT_USE_CAPTURED_COOKIES: SMARTUI_DO_NOT_USE_CAPTURED_COOKIES === 'true'
     }
 }

src/lib/env.ts

@@ -17,7 +17,7 @@ export function updateLogContext(newContext: LogContext) {
 
 const logLevel = (): string => {
     let env: Env = getEnv();
-    return (env.LT_SDK_DEBUG === 'true') ? 'debug' : 'info';
+    return (env.LT_SDK_DEBUG) ? 'debug' : 'info';
 }
 
 // Create a Winston logger

src/lib/logger.ts

@@ -80,7 +80,10 @@ async function processSnapshot(snapshot: Snapshot, ctx: Context): Promise<Record
     updateLogContext({ task: 'discovery' });
     ctx.log.debug(`Processing snapshot ${snapshot.name} ${snapshot.url}`);
 
-    let launchOptions: Record<string, any> = { headless: true }
+    let launchOptions: Record<string, any> = {
+        headless: true,
+        args: constants.LAUNCH_ARGS
+    }
     let contextOptions: Record<string, any> = {
         javaScriptEnabled: ctx.config.cliEnableJavaScript,
         userAgent: constants.CHROME_USER_AGENT,
@@ -92,8 +95,8 @@ async function processSnapshot(snapshot: Snapshot, ctx: Context): Promise<Record
     }
     const context = await ctx.browser.newContext(contextOptions);
     ctx.log.debug(`Browser context created with options ${JSON.stringify(contextOptions)}`);
-    // Setting the cookies in playwright context
-    if (snapshot.dom.cookies) {
+    // Setting cookies in playwright context
+    if (!ctx.env.SMARTUI_DO_NOT_USE_CAPTURED_COOKIES && snapshot.dom.cookies) {
         const domainName = new URL(snapshot.url).hostname;
         ctx.log.debug(`Setting cookies for domain: ${domainName}`);
 
@@ -135,7 +138,13 @@ async function processSnapshot(snapshot: Snapshot, ctx: Context): Promise<Record
     await page.route('**/*', async (route, request) => {
         const requestUrl = request.url()
         const requestHostname = new URL(requestUrl).hostname;
-        let requestOptions: Record<string, any> = { timeout: REQUEST_TIMEOUT }
+        let requestOptions: Record<string, any> = {
+            timeout: REQUEST_TIMEOUT,
+            headers: {
+                ...await request.allHeaders(),
+                ...constants.REQUEST_HEADERS
+            }
+        }
 
         try {
             // abort audio/video media requests
@@ -149,10 +158,7 @@ async function processSnapshot(snapshot: Snapshot, ctx: Context): Promise<Record
             if (ctx.config.basicAuthorization) {
                 ctx.log.debug(`Adding basic authorization to the headers for root url`);
                 let token = Buffer.from(`${ctx.config.basicAuthorization.username}:${ctx.config.basicAuthorization.password}`).toString('base64');
-                requestOptions.headers = {
-                    ...request.headers(),
-                    Authorization: `Basic ${token}`
-                };
+                requestOptions.headers.Authorization = `Basic ${token}`;
             }
 
             // get response

src/lib/processSnapshot.ts

@@ -52,14 +52,15 @@ export interface Context {
 export interface Env {
     PROJECT_TOKEN: string;
     SMARTUI_CLIENT_API_URL: string;
-    LT_SDK_DEBUG: string | undefined;
+    SMARTUI_DO_NOT_USE_CAPTURED_COOKIES: boolean;
     SMARTUI_GIT_INFO_FILEPATH: string | undefined;
     HTTP_PROXY: string | undefined;
     HTTPS_PROXY: string | undefined;
     GITHUB_ACTIONS: string | undefined;
     FIGMA_TOKEN: string | undefined;
-    LT_USERNAME: string | undefined;
-    LT_ACCESS_KEY: string | undefined;
+    LT_USERNAME : string | undefined;
+    LT_ACCESS_KEY : string | undefined;
+    LT_SDK_DEBUG: boolean;
     BASELINE_BRANCH: string | undefined;
     CURRENT_BRANCH: string | undefined;
 }