Merge pull request #27 from pinanks/DOT-2310

Add env variable option for load event

Author: pinanks

src/lib/screenshot.ts

@@ -21,48 +21,54 @@ export async function captureScreenshots(ctx: Context, screenshots: WebStaticCon
         let browserName = ctx.config.browsers[i]?.toLowerCase();
         let browser: Browser;
         let launchOptions: Record<string, any> = { headless: true };
+        let pageOptions = { waitUntil: process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || 'load' }
 
-        switch (browserName) {
-            case BROWSER_CHROME:
-                browser = await chromium.launch(launchOptions)
-                break;
-            case BROWSER_SAFARI:
-                browser = await webkit.launch(launchOptions)
-                break;
-            case BROWSER_FIREFOX:
-                browser = await firefox.launch(launchOptions)
-                break;
-            case BROWSER_EDGE:
-                launchOptions.channel = EDGE_CHANNEL
-                browser = await chromium.launch(launchOptions)
-                break;
-        }
-        const context = await browser.newContext();
+        try {
+            switch (browserName) {
+                case BROWSER_CHROME:
+                    browser = await chromium.launch(launchOptions)
+                    break;
+                case BROWSER_SAFARI:
+                    browser = await webkit.launch(launchOptions)
+                    break;
+                case BROWSER_FIREFOX:
+                    browser = await firefox.launch(launchOptions)
+                    break;
+                case BROWSER_EDGE:
+                    launchOptions.channel = EDGE_CHANNEL
+                    browser = await chromium.launch(launchOptions)
+                    break;
+            }
+            const context = await browser.newContext();
 
-        for (let j = 0; j < totalScreenshots; j++) {
-            let screenshot = screenshots[j]
-            let screenshotId = screenshot.name.toLowerCase().replace(/\s/g, '-');
+            for (let j = 0; j < totalScreenshots; j++) {
+                let screenshot = screenshots[j]
+                let screenshotId = screenshot.name.toLowerCase().replace(/\s/g, '-');
 
-            const page = await context.newPage();
-            await page.goto(screenshot.url);
-            await page.waitForTimeout(screenshot.waitForTimeout || 0)
+                const page = await context.newPage();
+                await page.goto(screenshot.url, pageOptions);
+                await page.waitForTimeout(screenshot.waitForTimeout || 0)
 
-            for (let k = 0; k < totalViewports; k++) {
-                let { width, height } = ctx.config.viewports[k];
-                let ssName = `${browserName}-${width}x${height}-${screenshotId}.png`
-                let ssPath = `screenshots/${screenshotId}/${ssName}.png`
-                await page.setViewportSize({ width, height})
-                await page.screenshot({ path: ssPath, fullPage: true });
+                for (let k = 0; k < totalViewports; k++) {
+                    let { width, height } = ctx.config.viewports[k];
+                    let ssName = `${browserName}-${width}x${height}-${screenshotId}.png`
+                    let ssPath = `screenshots/${screenshotId}/${ssName}.png`
+                    await page.setViewportSize({ width, height})
+                    await page.screenshot({ path: ssPath, fullPage: true });
 
-                let completed = (i == (totalBrowsers-1) && j == (totalScreenshots-1) && k == (totalViewports-1)) ? true : false;
-                browserName = browserName === BROWSER_SAFARI ? PW_WEBKIT : browserName;
-                ctx.client.uploadScreenshot(ctx.build, ssPath, screenshot.name, browserName, `${width}x${height}`, completed);
+                    let completed = (i == (totalBrowsers-1) && j == (totalScreenshots-1) && k == (totalViewports-1)) ? true : false;
+                    browserName = browserName === BROWSER_SAFARI ? PW_WEBKIT : browserName;
+                    ctx.client.uploadScreenshot(ctx.build, ssPath, screenshot.name, browserName, `${width}x${height}`, completed);
+                }
+
+                await page.close();
             }
 
-            await page.close();
+            await browser.close();
+        } catch (error) {
+            if (browser) await browser.close();
+            throw error;
         }
-
-        await browser.close();
     }
 
     return totalBrowsers * totalViewports * totalScreenshots

src/tasks/captureScreenshots.ts

@@ -13,9 +13,8 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
                 let totalScreenshots = await captureScreenshots(ctx, screenshots);
                 task.title = 'Screenshots captured successfully'
                 task.output = chalk.gray(`total screenshots: ${totalScreenshots}`)
-            } catch (error) {
-                // log.debug(error)
-                console.error(error);
+            } catch (error: any) {
+                task.output = chalk.gray(`${error.message}`);
                 throw new Error('Capturing screenshots failed');
             }
         },