Merge pull request #266 from parthlambdatest/Dot-5015

[Dot-5015] add support for allowed Assets

Author: parthlambdatest

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.7-beta.2",
+  "version": "4.1.7-beta.3",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"

src/lib/ctx.ts

@@ -93,6 +93,7 @@ export default (options: Record<string, string>): Context => {
             cliEnableJavaScript: config.cliEnableJavaScript ?? true,
             scrollTime: config.scrollTime || constants.DEFAULT_SCROLL_TIME,
             allowedHostnames: config.allowedHostnames || [],
+            allowedAssets: config.allowedAssets || [],
             basicAuthorization: basicAuthObj,
             smartIgnore: config.smartIgnore ?? false,
             delayedUpload: config.delayedUpload ?? false,

src/lib/processSnapshot.ts

@@ -387,6 +387,41 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
             ctx.log.debug(`Network idle failed due to ${error}`);
         }
 
+        if (ctx.config.allowedAssets && ctx.config.allowedAssets.length) {
+            for (let assetUrl of ctx.config.allowedAssets) {
+                if (!cache[assetUrl]) {
+                    ctx.log.debug(`Fetching asset ${assetUrl} from allowedAssets array`);
+                    try {
+                        const response = await page.request.fetch(assetUrl, {
+                            timeout: 25000,
+                            headers: {
+                                ...constants.REQUEST_HEADERS
+                            }
+                        });
+                        
+                        const body = await response.body();
+                        
+                        if (body && body.length) {
+                            ctx.log.debug(`Caching asset ${assetUrl}`);
+                            cache[assetUrl] = {
+                                body: body.toString('base64'),
+                                type: response.headers()['content-type']
+                            };
+                        } else {
+                            ctx.log.debug(`Asset ${assetUrl} returned empty or invalid body`);
+                        }
+                    } catch (error) {
+                        if (error && error.message) {
+                            ctx.log.debug(`Error fetching asset with error message ${assetUrl}: ${error.message}`);
+                        }
+                        ctx.log.debug(`Error fetching asset ${assetUrl}: ${JSON.stringify(error)}`);
+                    }
+                } else {
+                    ctx.log.debug(`Asset ${assetUrl} already cached`);
+                }
+            }
+        }
+
         // snapshot options
         if (processedOptions.element) {
             let l = await page.locator(processedOptions.element).all()

src/lib/schemaValidation.ts

@@ -147,6 +147,21 @@ const ConfigSchema = {
                 uniqueItems: "Invalid config; duplicates in allowedHostnames"
             }
 
+        },
+        allowedAssets: {
+            type: "array",
+            items: {
+                type: "string",
+                minLength: 1,
+                errorMessage: {
+                    minLength: "Invalid config; allowedAssets cannot be empty"
+                }
+            },
+            uniqueItems: true,
+            errorMessage: {
+                uniqueItems: "Invalid config; duplicates in allowedAssets"
+            }
+
         },
         basicAuthorization: {
             type: "object",

src/types.ts

@@ -25,6 +25,7 @@ export interface Context {
         cliEnableJavaScript: boolean;
         scrollTime: number;
         allowedHostnames: Array<string>;
+        allowedAssets: Array<string>;
         basicAuthorization: basicAuth | undefined;
         smartIgnore: boolean;
         delayedUpload: boolean;