Merge branch 'stage' into prod

Author: parthlambdatest

src/dom/dom-serializer.js

@@ -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/ctx.ts

@@ -88,7 +88,7 @@ export default class httpClient {
 
     async request(config: AxiosRequestConfig, log: Logger): Promise<Record<string, any>> {
         log.debug(`http request: ${config.method} ${config.url}`);
-        if (config && config.data && !config.data.name) {
+        if (config && config.data && !config.data.name && !config.data.snapshot) {
             log.debug(config.data);
         }
         if (config && config.data && config.data.snapshotUuid) {
@@ -477,6 +477,7 @@ export default class httpClient {
     }
 
     processWebFigma(requestBody: any, log: Logger) {
+        requestBody.packageVersion = pkgJSON.version;
         return this.request({
             url: "figma-web/upload",
             method: "POST",

src/lib/httpClient.ts

@@ -417,6 +417,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()
@@ -506,6 +541,18 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
         discoveryErrors.timestamp = new Date().toISOString();
         // ctx.log.warn(discoveryErrors);
     }
+
+    if (ctx.config.useGlobalCache) {
+        const keys = globalCache.keys();
+        keys.forEach((key) => {
+            if (!(key in cache)) {
+                const globalCacheData = globalCache.get(key);
+                if (globalCacheData) {
+                    cache[key] = globalCacheData;
+                }
+            }
+        });
+    }
     return {
         processedSnapshot: {
             name: snapshot.name,

src/lib/processSnapshot.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/lib/schemaValidation.ts

@@ -21,7 +21,7 @@ async function captureScreenshotsForConfig(
     let beforeSnapshotScript = execute?.beforeSnapshot;
     let waitUntilEvent = pageEvent || process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || 'load';
 
-    let pageOptions = { waitUntil: waitUntilEvent, timeout: ctx.config.waitForPageRender || constants.DEFAULT_PAGE_LOAD_TIMEOUT };
+    let pageOptions = { waitUntil: waitUntilEvent, timeout: ctx.config.waitForPageRender || constants.DEFAULT_PAGE_LOAD_TIMEOUT};
     ctx.log.debug(`url:  ${url}  pageOptions: ${JSON.stringify(pageOptions)}`);
     let ssId = name.toLowerCase().replace(/\s/g, '_');
     let context: BrowserContext;

src/lib/screenshot.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;