add new config option request headers

Author: parthlambdatest

src/lib/ctx.ts

@@ -112,7 +112,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;
@@ -266,6 +269,11 @@ 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((header: { key: string, value: string }) => {
+                    requestOptions.headers[header.key] = header.value;
+                });
+            }
 
             // get response
             let response, body;

src/lib/schemaValidation.ts

@@ -2,6 +2,7 @@ import { Snapshot, WebStaticConfig, FigmaDesignConfig } from '../types.js'
 import Ajv, { JSONSchemaType } from 'ajv'
 import addErrors from 'ajv-errors'
 import constants from './constants.js'
+import { request } from 'http';
 
 const ajv = new Ajv({ allErrors: true });
 ajv.addFormat('web-url', {
@@ -161,7 +162,6 @@ const ConfigSchema = {
             errorMessage: {
                 uniqueItems: "Invalid config; duplicates in allowedAssets"
             }
-
         },
         basicAuthorization: {
             type: "object",
@@ -248,6 +248,26 @@ const ConfigSchema = {
             type: "string",
             errorMessage: "User Agent value must be a valid string"
         },
+        requestHeaders: {
+            type: "array",
+            items: {
+                type: "object",
+                properties: {
+                    key: {
+                        type: "string",
+                        errorMessage: "Invalid config; key is mandatory"
+                    },
+                    value: {
+                        type: "string",
+                        errorMessage: "Invalid config; value is mandatory"
+                    },
+                }
+            },
+            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<reqHeaders>;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -207,6 +208,11 @@ export interface basicAuth {
     password: string;
 }
 
+export interface reqHeaders {
+    key: string;
+    value: string;
+}
+
 export interface tunnelConfig {
     type: string;
     tunnelName: string;