Merge pull request #305 from parthlambdatest/req_headers

Add request headers config

Author: sushobhit-lt

src/lib/ctx.ts

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

src/lib/processSnapshot.ts

@@ -19,6 +19,9 @@ export async function prepareSnapshot(snapshot: Snapshot, ctx: Context): Promise
     if (ctx.config.basicAuthorization) {
         processedOptions.basicAuthorization = ctx.config.basicAuthorization;
     }
+    if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
+        processedOptions.requestHeaders = ctx.config.requestHeaders
+    }
     ctx.config.allowedHostnames.push(new URL(snapshot.url).hostname);
     processedOptions.allowedHostnames = ctx.config.allowedHostnames;
     processedOptions.skipCapturedCookies = ctx.env.SMARTUI_DO_NOT_USE_CAPTURED_COOKIES;
@@ -181,6 +184,9 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
       };
 
     let processedOptions: Record<string, any> = {};
+    if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
+        processedOptions.requestHeaders = ctx.config.requestHeaders
+    }
 
     let globalViewport = ""
     let globalBrowser = constants.CHROME
@@ -266,6 +272,13 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
                 let token = Buffer.from(`${ctx.config.basicAuthorization.username}:${ctx.config.basicAuthorization.password}`).toString('base64');
                 requestOptions.headers.Authorization = `Basic ${token}`;
             }
+            if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
+                ctx.config.requestHeaders.forEach((headerObj) => {
+                    Object.entries(headerObj).forEach(([key, value]) => {
+                        requestOptions.headers[key] = value;
+                    });
+                });
+            }
 
             // get response
             let response, body;

src/lib/schemaValidation.ts

@@ -161,7 +161,6 @@ const ConfigSchema = {
             errorMessage: {
                 uniqueItems: "Invalid config; duplicates in allowedAssets"
             }
-
         },
         basicAuthorization: {
             type: "object",
@@ -248,6 +247,18 @@ const ConfigSchema = {
             type: "string",
             errorMessage: "User Agent value must be a valid string"
         },
+        requestHeaders: {
+            type: "array",
+            items: {
+                type: "object",
+                minProperties: 1,
+                additionalProperties: { type: "string" }
+            },
+            uniqueItems: true,
+            errorMessage: {
+                uniqueItems: "Invalid config; duplicates in requestHeaders"
+            }
+        }
     },
     anyOf: [
         { required: ["web"] },

src/types.ts

@@ -35,6 +35,7 @@ export interface Context {
         skipBuildCreation?: boolean;
         tunnel: tunnelConfig | undefined;
         userAgent?: string;
+        requestHeaders?: Array<Record<string, string>>;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;