Add support for extended viewport and DOM content loading in configuration

Author: lt-zeeshan

src/lib/ctx.ts

@@ -25,6 +25,8 @@ export default (options: Record<string, string>): Context => {
     let buildNameObj: string;
     let allowDuplicateSnapshotNames: boolean = false;
     let useLambdaInternal: boolean = false;
+    let useExtendedViewport: boolean = false;
+    let loadDomContent: boolean = false;
     try {
         if (options.config) {
             config = JSON.parse(fs.readFileSync(options.config, 'utf-8'));
@@ -100,6 +102,12 @@ export default (options: Record<string, string>): Context => {
     if (config.useLambdaInternal) {
         useLambdaInternal = true;
     }
+    if (config.useExtendedViewport) {
+        useExtendedViewport = true;
+    }
+    if (config.loadDomContent) {
+        loadDomContent = true;
+    }
 
     //if config.waitForPageRender has value and if its less than 30000 then make it to 30000 default
     if (config.waitForPageRender && config.waitForPageRender < 30000) {
@@ -132,6 +140,8 @@ export default (options: Record<string, string>): Context => {
             requestHeaders: config.requestHeaders || {},
             allowDuplicateSnapshotNames: allowDuplicateSnapshotNames,
             useLambdaInternal: useLambdaInternal,
+            useExtendedViewport: useExtendedViewport,
+            loadDomContent: loadDomContent,
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/processSnapshot.ts

@@ -46,7 +46,9 @@ export async function prepareSnapshot(snapshot: Snapshot, ctx: Context): Promise
         if (options.loadDomContent) {
             processedOptions.loadDomContent = true;
         }
-
+        if (options.useExtendedViewport) {
+            processedOptions.useExtendedViewport = true;
+        }
         if (options.sessionId) {
             const sessionId = options.sessionId;
             processedOptions.sessionId = sessionId
@@ -145,6 +147,13 @@ export async function prepareSnapshot(snapshot: Snapshot, ctx: Context): Promise
         }
     }
 
+    if (ctx.config.loadDomContent) {
+        processedOptions.loadDomContent = true;
+    }
+    if (ctx.config.useExtendedViewport) {
+        processedOptions.useExtendedViewport = true;
+    }
+
     processedOptions.allowedAssets = ctx.config.allowedAssets;
     processedOptions.selectors = selectors;
 
@@ -522,6 +531,13 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
         }
     }
 
+    if (ctx.config.loadDomContent) {
+        processedOptions.loadDomContent = true;
+    }
+    if (ctx.config.useExtendedViewport) {
+        processedOptions.useExtendedViewport = true;
+    }
+
     // process for every viewport
     let navigated: boolean = false;
     let previousDeviceType: string | null = null;

src/lib/schemaValidation.ts

@@ -266,6 +266,14 @@ const ConfigSchema = {
         useLambdaInternal: {
             type: "boolean",
             errorMessage: "Invalid config; useLambdaInternal must be true/false"
+        },
+        useExtendedViewport: {
+            type: "boolean",
+            errorMessage: "Invalid config; useExtendedViewport must be true/false"
+        },
+        loadDomContent: {
+            type: "boolean",
+            errorMessage: "Invalid config; loadDomContent must be true/false"
         }
     },
     anyOf: [
@@ -525,6 +533,10 @@ const SnapshotSchema: JSONSchemaType<Snapshot> = {
                 timeout: {
                     type: "number",
                     errorMessage: "Invalid snapshot options; timeout must be a number"
+                },
+                useExtendedViewport: {
+                    type: "boolean",
+                    errorMessage: "Invalid snapshot options; useExtendedViewport must be a boolean"
                 }
             },
             additionalProperties: false

src/types.ts

@@ -38,6 +38,8 @@ export interface Context {
         requestHeaders?: Array<Record<string, string>>;
         allowDuplicateSnapshotNames?: boolean;
         useLambdaInternal?: boolean;
+        useExtendedViewport?: boolean;
+        loadDomContent?: boolean;
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -153,6 +155,7 @@ export interface Snapshot {
         sessionId?: string
         sync?: boolean;
         contextId?: string;
+        useExtendedViewport?: boolean;
     }
 }