Merge pull request #118 from parthlambdatest/Dot_3790

feat: addition of cookies and basic auth

Author: pinanks

src/lib/ctx.ts

@@ -1,4 +1,4 @@
-import { Context, Env, WebConfig, MobileConfig } from '../types.js'
+import { Context, Env, WebConfig, MobileConfig, basicAuth } from '../types.js'
 import constants from './constants.js'
 import { version } from '../../package.json'
 import { validateConfig } from './schemaValidation.js'
@@ -11,6 +11,7 @@ export default (options: Record<string, string>): Context => {
     let env: Env = getEnv();
     let webConfig: WebConfig;
     let mobileConfig: MobileConfig;
+    let basicAuthObj: basicAuth
     let config = constants.DEFAULT_CONFIG;
     let port: number;
     let resolutionOff: boolean;
@@ -52,10 +53,13 @@ export default (options: Record<string, string>): Context => {
     if (config.mobile) {
         mobileConfig = {
             devices: config.mobile.devices,
-            fullPage: config.mobile.fullPage || true,
+            fullPage: config.mobile.fullPage ?? true,
             orientation: config.mobile.orientation || constants.MOBILE_ORIENTATION_PORTRAIT,
         }
     }
+    if (config.basicAuthorization){
+        basicAuthObj = config.basicAuthorization
+    }
 
     return {
         env: env,
@@ -69,7 +73,8 @@ export default (options: Record<string, string>): Context => {
             enableJavaScript: config.enableJavaScript || false,
             cliEnableJavaScript: config.cliEnableJavaScript || true,
             scrollTime: config.scrollTime || constants.DEFAULT_SCROLL_TIME,
-            allowedHostnames: config.allowedHostnames || []
+            allowedHostnames: config.allowedHostnames || [],
+            basicAuthorization: basicAuthObj
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/processSnapshot.ts

@@ -92,6 +92,21 @@ 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
+    const domainName = new URL(snapshot.url).hostname;
+    ctx.log.debug('Setting cookies in context for domain:', domainName);
+    const cookieArray = snapshot.dom.cookies.split('; ').map(cookie => {
+        const [name, value] = cookie.split('=');
+        return {
+            name: name.trim(),
+            value: value.trim(),
+            domain: domainName,
+            path: '/'
+        };
+    });
+    await context.addCookies(cookieArray);
+
     const page = await context.newPage();
     let cache: Record<string, any> = {};
 
@@ -110,11 +125,24 @@ async function processSnapshot(snapshot: Snapshot, ctx: Context): Promise<Record
             ctx.config.allowedHostnames.push(new URL(snapshot.url).hostname);
             if (ctx.config.enableJavaScript) ALLOWED_RESOURCES.push('script');
 
+            let requestOptions: Record<string, any> = {
+                timeout: REQUEST_TIMEOUT
+            }
+            if (requestUrl === snapshot.url && 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}`
+                };
+            }
+
             const response = await page.request.fetch(request, { timeout: REQUEST_TIMEOUT });
             const body = await response.body();
+
             if (!body) {
                 ctx.log.debug(`Handling request ${requestUrl}\n - skipping no response`);
-            } else if (!body.length) {
+			} else if (!body.length) {
                 ctx.log.debug(`Handling request ${requestUrl}\n - skipping empty response`);
             } else if (requestUrl === snapshot.url) {
                 ctx.log.debug(`Handling request ${requestUrl}\n - skipping root resource`);

src/lib/schemaValidation.ts

@@ -133,6 +133,19 @@ const ConfigSchema = {
                 uniqueItems: "Invalid config; duplicates in allowedHostnames"
             }
 
+        },
+        basicAuthorization: {
+            type: "object",
+            properties: {
+                username: {
+                    type: "string",
+                    errorMessage: "Invalid config; username is mandatory"
+                },
+                password: {
+                    type: "string", 
+                    errorMessage: "Invalid config; password is mandatory"
+                },
+            }
         }
     },
     anyOf: [

src/types.ts

@@ -23,6 +23,7 @@ export interface Context {
         cliEnableJavaScript: boolean;
         scrollTime: number;
         allowedHostnames: Array<string>;
+        basicAuthorization: basicAuth | undefined
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -141,3 +142,8 @@ export type FigmaDesignConfig = {
     depth: number;
     figma_config: FigmaConfigItem[];
 };
+
+export interface basicAuth {
+    username: string;
+    password: string;
+}