@govtechsg/oobee 0.10.84 → 0.10.85

package/dist/cli.js

@@ -5,7 +5,7 @@ import printMessage from 'print-message';
 import { devices } from 'playwright';
 import { fileURLToPath } from 'url';
 import path from 'path';
-import { setHeadlessMode, getVersion, getStoragePath, listenForCleanUp, cleanUpAndExit } from './utils.js';
+import { setHeadlessMode, getVersion, getStoragePath, listenForCleanUp, cleanUpAndExit, } from './utils.js';
 import { checkUrl, prepareData, validEmail, validName, getScreenToScan, validateDirPath, validateFilePath, validateCustomFlowLabel, } from './constants/common.js';
 import constants, { ScannerTypes } from './constants/constants.js';
 import { cliOptions, messageOptions } from './constants/cliFunctions.js';
@@ -146,12 +146,13 @@ Usage: npm run cli -- -c <crawler> -d <device> -w <viewport> -u <url> OPTIONS`)
     return true;
 })
     .check(argvs => {
-    if (argvs.scanner !== ScannerTypes.WEBSITE && argvs.strategy) {
-        throw new Error('-s or --strategy is only available in website scans.');
+    const scanner = String(argvs.scanner ?? '');
+    if (argvs.strategy && scanner !== ScannerTypes.WEBSITE && scanner !== ScannerTypes.CUSTOM) {
+        throw new Error('-s or --strategy is only available in website and custom flow scans.');
     }
     return true;
 })
-    .coerce('l', (option) => {
+    .coerce('l', option => {
     const duration = Number(option);
     if (isNaN(duration) || duration < 0) {
         printMessage(['Invalid scan duration. Please provide a positive number of seconds.'], messageOptions);
@@ -160,8 +161,8 @@ Usage: npm run cli -- -c <crawler> -d <device> -w <viewport> -u <url> OPTIONS`)
     return duration;
 })
     .check(argvs => {
-    if (argvs.scanner === ScannerTypes.CUSTOM && typeof argvs.scanDuration === 'number' && argvs.scanDuration > 0) {
-        throw new Error('-l or --scanDuration is not allowed for custom flow scans.');
+    if (argvs.scanner !== ScannerTypes.WEBSITE && argvs.strategy) {
+        throw new Error('-s or --strategy is only available in website scans.');
     }
     return true;
 })

package/dist/crawlers/custom/utils.js

@@ -1,12 +1,44 @@
-/* eslint-disable no-shadow */
 /* eslint-disable no-alert */
 /* eslint-disable no-param-reassign */
 /* eslint-env browser */
 import path from 'path';
+import { getDomain } from 'tldts';
 import { runAxeScript } from '../commonCrawlerFunc.js';
 import { consoleLogger, guiInfoLog } from '../../logs.js';
 import { guiInfoStatusTypes } from '../../constants/constants.js';
 import { isSkippedUrl, validateCustomFlowLabel } from '../../constants/common.js';
+const sameRegistrableDomain = (hostA, hostB) => {
+    const domainA = getDomain(hostA);
+    const domainB = getDomain(hostB);
+    if (!domainA || !domainB)
+        return hostA === hostB;
+    return domainA === domainB;
+};
+const parseBoolEnv = (val, defaultVal) => {
+    if (val == null)
+        return defaultVal;
+    const v = String(val).trim().toLowerCase();
+    if (['1', 'true', 'yes', 'y', 'on'].includes(v))
+        return true;
+    if (['0', 'false', 'no', 'n', 'off'].includes(v))
+        return false;
+    return defaultVal;
+};
+const RESTRICT_OVERLAY_TO_ENTRY_DOMAIN = parseBoolEnv(process.env.RESTRICT_OVERLAY_TO_ENTRY_DOMAIN, false);
+const isOverlayAllowed = (currentUrl, entryUrl) => {
+    try {
+        const cur = new URL(currentUrl);
+        if (cur.protocol !== 'http:' && cur.protocol !== 'https:')
+            return false;
+        if (!RESTRICT_OVERLAY_TO_ENTRY_DOMAIN)
+            return true;
+        const base = new URL(entryUrl);
+        return sameRegistrableDomain(cur.hostname, base.hostname);
+    }
+    catch {
+        return false;
+    }
+};
 //! For Cypress Test
 // env to check if Cypress test is running
 const isCypressTest = process.env.IS_CYPRESS_TEST === 'true';
@@ -33,9 +65,7 @@ export const screenshotFullPage = async (page, screenshotsDir, screenshotIdx) =>
             const isLoadMoreContent = async () => new Promise(resolve => {
                 setTimeout(async () => {
                     await page.waitForLoadState('domcontentloaded');
-                    const newHeight = await page.evaluate(
-                    // eslint-disable-next-line no-shadow
-                    () => document.body.scrollHeight);
+                    const newHeight = await page.evaluate(() => document.body.scrollHeight);
                     const result = newHeight > prevHeight;
                     resolve(result);
                 }, 2500);
@@ -157,7 +187,7 @@ export const MENU_POSITION = {
 export const updateMenu = async (page, urlsCrawled) => {
     log(`Overlay menu: updating: ${page.url()}`);
     await page.evaluate(vars => {
-        const shadowHost = document.querySelector('#oobee-shadow-host');
+        const shadowHost = document.querySelector('#oobeeShadowHost');
         if (shadowHost) {
             const p = shadowHost.shadowRoot.querySelector('#oobee-p-pages-scanned');
             if (p) {
@@ -200,7 +230,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
           </svg>
         `;
         minBtn.innerHTML = MINBTN_SVG;
-        let currentPos = (vars.menuPos || 'RIGHT');
+        let currentPos = vars.menuPos || 'RIGHT';
         const isCollapsed = () => panel.classList.contains('collapsed');
         const setPosClass = (pos) => {
             panel.classList.remove('pos-left', 'pos-right');
@@ -217,7 +247,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             setDraggableSidebarMenu();
         };
         const toggleCollapsed = (force) => {
-            const willCollapse = (typeof force === 'boolean') ? force : !isCollapsed();
+            const willCollapse = typeof force === 'boolean' ? force : !isCollapsed();
             if (willCollapse) {
                 panel.classList.add('collapsed');
                 localStorage.setItem('oobee:overlay-collapsed', '1');
@@ -292,12 +322,12 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             }
             const ol = document.createElement('ol');
             ol.className = 'oobee-ol';
-            scanned.forEach((item) => {
+            scanned.forEach(item => {
                 const li = document.createElement('li');
                 li.className = 'oobee-li';
                 const title = document.createElement('div');
                 title.className = 'oobee-item-title';
-                title.textContent = (item.pageTitle && item.pageTitle.trim()) ? item.pageTitle : item.url;
+                title.textContent = item.pageTitle && item.pageTitle.trim() ? item.pageTitle : item.url;
                 const url = document.createElement('div');
                 url.className = 'oobee-item-url';
                 url.textContent = item.url;
@@ -596,8 +626,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             if (!icon)
                 return;
             const closed = isCollapsed();
-            const arrowPointsRight = (currentPos === 'RIGHT' && !closed) ||
-                (currentPos === 'LEFT' && closed);
+            const arrowPointsRight = (currentPos === 'RIGHT' && !closed) || (currentPos === 'LEFT' && closed);
             icon.classList.toggle('is-left', !arrowPointsRight);
             minBtn.setAttribute('aria-label', closed ? 'Expand panel' : 'Collapse panel');
         }
@@ -652,7 +681,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             borderRadius: '16px',
             overflow: 'hidden',
             boxShadow: '0 10px 40px rgba(0,0,0,.35)',
-            fontFamily: 'system-ui, -apple-system, Segoe UI, Roboto, Arial, sans-serif'
+            fontFamily: 'system-ui, -apple-system, Segoe UI, Roboto, Arial, sans-serif',
         });
         const dialogSheet = new CSSStyleSheet();
         dialogSheet.replaceSync(`
@@ -689,12 +718,17 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             display: 'flex',
             alignItems: 'center',
             justifyContent: 'space-between',
-            gap: '8px'
+            gap: '8px',
         });
         const title = document.createElement('h2');
         title.id = 'oobee-stop-title';
         title.textContent = 'Are you sure you want to stop this scan?';
-        Object.assign(title.style, { margin: '0', fontSize: '22px', fontWeight: '700', lineHeight: '1.25' });
+        Object.assign(title.style, {
+            margin: '0',
+            fontSize: '22px',
+            fontWeight: '700',
+            lineHeight: '1.25',
+        });
         const closeX = document.createElement('button');
         closeX.type = 'button';
         closeX.setAttribute('aria-label', 'Close');
@@ -711,13 +745,13 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             height: '36px',
             borderRadius: '12px',
             display: 'grid',
-            placeItems: 'center'
+            placeItems: 'center',
         });
         head.appendChild(title);
         head.appendChild(closeX);
         const bodyWrap = document.createElement('div');
         Object.assign(bodyWrap.style, {
-            padding: '12px 20px 20px 20px'
+            padding: '12px 20px 20px 20px',
         });
         const form = document.createElement('form');
         form.noValidate = true;
@@ -725,7 +759,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
         Object.assign(form.style, {
             display: 'grid',
             gridTemplateColumns: '1fr',
-            rowGap: '12px'
+            rowGap: '12px',
         });
         const label = document.createElement('label');
         label.setAttribute('for', 'oobee-stop-input');
@@ -741,7 +775,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             padding: '12px 14px',
             fontSize: '14px',
             outline: 'none',
-            boxSizing: 'border-box'
+            boxSizing: 'border-box',
         });
         input.addEventListener('focus', () => {
             input.style.borderColor = '#7b4dff';
@@ -765,7 +799,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             fontWeight: '600',
             color: '#fff',
             background: '#9021A6',
-            cursor: 'pointer'
+            cursor: 'pointer',
         });
         const cancel = document.createElement('button');
         cancel.type = 'button';
@@ -777,7 +811,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             fontSize: '14px',
             justifySelf: 'center',
             cursor: 'pointer',
-            padding: '6px'
+            padding: '6px',
         });
         actions.appendChild(primary);
         actions.appendChild(cancel);
@@ -792,10 +826,13 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
         stopDialog.appendChild(bodyWrap);
         shadowRoot.appendChild(stopDialog);
         let stopResolver = null;
-        const hideStop = () => { try {
-            stopDialog.close();
-        }
-        catch { } stopResolver = null; };
+        const hideStop = () => {
+            try {
+                stopDialog.close();
+            }
+            catch { }
+            stopResolver = null;
+        };
         const showStop = () => {
             if (!shouldHideInput)
                 input.value = '';
@@ -813,7 +850,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
                 });
             }
         };
-        form.addEventListener('submit', (e) => {
+        form.addEventListener('submit', e => {
             e.preventDefault();
             const v = (input.value || '').trim();
             if (stopResolver)
@@ -830,13 +867,13 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
                 stopResolver({ confirmed: false, label: '' });
             hideStop();
         });
-        stopDialog.addEventListener('cancel', (e) => {
+        stopDialog.addEventListener('cancel', e => {
             e.preventDefault();
             if (stopResolver)
                 stopResolver({ confirmed: false, label: '' });
             hideStop();
         });
-        customWindow.oobeeShowStopModal = () => new Promise((resolve) => {
+        customWindow.oobeeShowStopModal = () => new Promise(resolve => {
             stopResolver = resolve;
             showStop();
         });
@@ -861,7 +898,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
         log('Overlay menu: successfully added');
     })
         .catch(error => {
-        error('Overlay menu: failed to add', error);
+        consoleLogger.error('Overlay menu: failed to add', error);
     });
 };
 export const removeOverlayMenu = async (page) => {
@@ -910,11 +947,17 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
             await processPage(page, processPageParams);
             log('Scan: success');
             pagesDict[pageId].isScanning = false;
-            await addOverlayMenu(page, processPageParams.urlsCrawled, menuPos, {
-                inProgress: false,
-                collapsed: !!pagesDict[pageId]?.collapsed,
-                hideStopInput: !!processPageParams.customFlowLabel,
-            });
+            const allowed = isOverlayAllowed(page.url(), processPageParams.entryUrl);
+            if (allowed) {
+                await addOverlayMenu(page, processPageParams.urlsCrawled, menuPos, {
+                    inProgress: false,
+                    collapsed: !!pagesDict[pageId]?.collapsed,
+                    hideStopInput: !!processPageParams.customFlowLabel,
+                });
+            }
+            else {
+                await removeOverlayMenu(page);
+            }
         }
         catch (error) {
             log(`Scan failed ${error}`);
@@ -977,6 +1020,11 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
     };
     page.on('domcontentloaded', async () => {
         try {
+            const allowed = isOverlayAllowed(page.url(), processPageParams.entryUrl);
+            if (!allowed) {
+                await removeOverlayMenu(page);
+                return;
+            }
             const existingOverlay = await page.evaluate(() => {
                 return document.querySelector('#oobeeShadowHost');
             });
@@ -989,11 +1037,6 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
                     hideStopInput: !!processPageParams.customFlowLabel,
                 });
             }
-            setTimeout(() => {
-                // Timeout here to slow things down a little
-            }, 1000);
-            //! For Cypress Test
-            // Auto-clicks 'Scan this page' button only once
             if (isCypressTest) {
                 try {
                     await handleOnScanClick();
@@ -1003,11 +1046,9 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
                     consoleLogger.info(`Error in calling handleOnScanClick, isCypressTest: ${isCypressTest}`);
                 }
             }
-            consoleLogger.info(`Overlay state: ${existingOverlay}`);
         }
         catch {
             consoleLogger.info('Error in adding overlay menu to page');
-            consoleLogger.info('Error in adding overlay menu to page');
         }
     });
     await page.exposeFunction('handleOnScanClick', handleOnScanClick);

package/dist/crawlers/runCustom.js

@@ -27,6 +27,7 @@ const runCustom = async (url, randomToken, viewportSettings, blacklistedPatterns
     const intermediateScreenshotsPath = getIntermediateScreenshotsPath(randomToken);
     const processPageParams = new ProcessPageParams(0, // scannedIdx
     blacklistedPatterns, includeScreenshots, dataset, intermediateScreenshotsPath, urlsCrawled, randomToken);
+    processPageParams.entryUrl = url;
     if (initialCustomFlowLabel && initialCustomFlowLabel.trim()) {
         processPageParams.customFlowLabel = initialCustomFlowLabel.trim();
     }
@@ -35,16 +36,18 @@ const runCustom = async (url, randomToken, viewportSettings, blacklistedPatterns
     try {
         const deviceConfig = viewportSettings.playwrightDeviceDetailsObject;
         const hasCustomViewport = !!deviceConfig;
-        const baseLaunchOptions = getPlaywrightLaunchOptions('chrome');
+        const baseLaunchOptions = getPlaywrightLaunchOptions();
         // Merge base args with custom flow specific args
         const baseArgs = baseLaunchOptions.args || [];
         const customArgs = hasCustomViewport ? ['--window-size=1920,1040'] : ['--start-maximized'];
-        const mergedArgs = [...baseArgs.filter(a => !a.startsWith('--window-size') && a !== '--start-maximized'), ...customArgs];
+        const mergedArgs = [
+            ...baseArgs.filter(a => !a.startsWith('--window-size') && a !== '--start-maximized'),
+            ...customArgs,
+        ];
         const browser = await chromium.launch({
             ...baseLaunchOptions,
             args: mergedArgs,
             headless: false,
-            channel: 'chrome',
         });
         const context = await browser.newContext({
             ignoreHTTPSErrors: true,
@@ -58,8 +61,7 @@ const runCustom = async (url, randomToken, viewportSettings, blacklistedPatterns
                 await context.close().catch(() => { });
                 await browser.close().catch(() => { });
             }
-            catch {
-            }
+            catch { }
         };
         // For handling closing playwright browser and continue generate artifacts etc
         registerSoftClose(processPageParams.stopAll);

package/dist/mergeAxeResults.js

@@ -247,35 +247,54 @@ const cleanUpJsonFiles = async (filesToDelete) => {
     });
 };
 const writeSummaryPdf = async (storagePath, pagesScanned, filename = 'summary', browser, _userDataDirectory) => {
-    const htmlFilePath = `${storagePath}/${filename}.html`;
-    const fileDestinationPath = `${storagePath}/${filename}.pdf`;
-    const launchOptions = getPlaywrightLaunchOptions(browser);
-    const browserInstance = await constants.launcher.launch({
-        ...launchOptions,
-        headless: true, // force headless for PDF
-    });
-    register(browserInstance);
-    const context = await browserInstance.newContext();
-    const page = await context.newPage();
-    const data = fs.readFileSync(htmlFilePath, { encoding: 'utf-8' });
-    await page.setContent(data, { waitUntil: 'domcontentloaded' });
-    await page.emulateMedia({ media: 'print' });
-    await page.pdf({
-        margin: { bottom: '32px' },
-        path: fileDestinationPath,
-        format: 'A4',
-        displayHeaderFooter: true,
-        footerTemplate: `
+    let browserInstance;
+    let context;
+    let page;
+    try {
+        const htmlFilePath = path.join(storagePath, `${filename}.html`);
+        const fileDestinationPath = path.join(storagePath, `${filename}.pdf`);
+        const htmlFileUrl = `file://${htmlFilePath}`;
+        const launchOptions = getPlaywrightLaunchOptions(browser);
+        browserInstance = await constants.launcher.launch({
+            ...launchOptions,
+            headless: true,
+        });
+        register(browserInstance);
+        context = await browserInstance.newContext();
+        page = await context.newPage();
+        await page.goto(htmlFileUrl, {
+            waitUntil: 'domcontentloaded',
+            timeout: 120000,
+        });
+        await page.emulateMedia({ media: 'print' });
+        await page.pdf({
+            margin: { bottom: '32px' },
+            path: fileDestinationPath,
+            format: 'A4',
+            displayHeaderFooter: true,
+            footerTemplate: `
     <div style="margin-top:50px;color:#26241b;font-family:Open Sans;text-align: center;width: 100%;font-weight:400">
       <span style="color:#26241b;font-size: 14px;font-weight:400">Page <span class="pageNumber"></span> of <span class="totalPages"></span></span>
     </div>
   `,
-    });
-    await page.close();
-    await context.close().catch(() => { });
-    await browserInstance.close().catch(() => { });
-    if (pagesScanned < 2000) {
-        fs.unlinkSync(htmlFilePath);
+        });
+        if (pagesScanned < 2000) {
+            fs.unlinkSync(htmlFilePath);
+        }
+    }
+    catch (err) {
+        consoleLogger.info(`Error at writeSummaryPDF ${err instanceof Error ? err.stack : err}`);
+    }
+    finally {
+        await page?.close().catch(err => {
+            consoleLogger.info(`Error at page close writeSummaryPDF ${err}`);
+        });
+        await context?.close().catch(err => {
+            consoleLogger.info(`Error at context close writeSummaryPDF ${err}`);
+        });
+        await browserInstance?.close().catch(err => {
+            consoleLogger.info(`Error at browserInstance close writeSummaryPDF ${err}`);
+        });
     }
 };
 // Tracking WCAG occurrences

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@govtechsg/oobee",
   "main": "dist/npmIndex.js",
-  "version": "0.10.84",
+  "version": "0.10.85",
   "type": "module",
   "author": "Government Technology Agency <info@tech.gov.sg>",
   "bin": {
@@ -36,7 +36,7 @@
     "print-message": "^3.0.1",
     "safe-regex": "^2.1.1",
     "text-readability": "^1.1.0",
-    "tldts": "^7.0.26",
+    "tldts": "^7.0.27",
     "typescript": "^5.4.5",
     "url": "^0.11.3",
     "uuid": "^11.0.3",

package/src/cli.ts

@@ -5,7 +5,13 @@ import printMessage from 'print-message';
 import { devices } from 'playwright';
 import { fileURLToPath } from 'url';
 import path from 'path';
-import { setHeadlessMode, getVersion, getStoragePath, listenForCleanUp, cleanUpAndExit } from './utils.js';
+import {
+  setHeadlessMode,
+  getVersion,
+  getStoragePath,
+  listenForCleanUp,
+  cleanUpAndExit,
+} from './utils.js';
 import {
   checkUrl,
   prepareData,
@@ -185,12 +191,14 @@ Usage: npm run cli -- -c <crawler> -d <device> -w <viewport> -u <url> OPTIONS`,
     return true;
   })
   .check(argvs => {
-    if (argvs.scanner !== ScannerTypes.WEBSITE && argvs.strategy) {
-      throw new Error('-s or --strategy is only available in website scans.');
+    const scanner = String(argvs.scanner ?? '');
+
+    if (argvs.strategy && scanner !== ScannerTypes.WEBSITE && scanner !== ScannerTypes.CUSTOM) {
+      throw new Error('-s or --strategy is only available in website and custom flow scans.');
     }
     return true;
   })
-  .coerce('l', (option) => {
+  .coerce('l', option => {
     const duration = Number(option);
     if (isNaN(duration) || duration < 0) {
       printMessage(
@@ -202,8 +210,8 @@ Usage: npm run cli -- -c <crawler> -d <device> -w <viewport> -u <url> OPTIONS`,
     return duration;
   })
   .check(argvs => {
-    if (argvs.scanner === ScannerTypes.CUSTOM && typeof argvs.scanDuration === 'number' && argvs.scanDuration > 0) {
-      throw new Error('-l or --scanDuration is not allowed for custom flow scans.');
+    if (argvs.scanner !== ScannerTypes.WEBSITE && argvs.strategy) {
+      throw new Error('-s or --strategy is only available in website scans.');
     }
     return true;
   })
@@ -235,10 +243,11 @@ const scanInit = async (argvs: Answers): Promise<string> => {
     data.userDataDirectory,
     data.playwrightDeviceDetailsObject,
     data.extraHTTPHeaders,
-    data.fileTypes
+    data.fileTypes,
   );
 
-  if (res.httpStatus) consoleLogger.info(`Connectivity Check HTTP Response Code: ${res.httpStatus}`);
+  if (res.httpStatus)
+    consoleLogger.info(`Connectivity Check HTTP Response Code: ${res.httpStatus}`);
 
   if (res.status === statuses.success.code) {
     data.url = res.url;
@@ -267,15 +276,11 @@ const scanInit = async (argvs: Answers): Promise<string> => {
     }
   }
 
-  const screenToScan = getScreenToScan(
-    data.deviceChosen,
-    data.customDevice,
-    data.viewportWidth,
-  );
+  const screenToScan = getScreenToScan(data.deviceChosen, data.customDevice, data.viewportWidth);
 
   printMessage([`Oobee version: ${appVersion}`, 'Starting scan...'], messageOptions);
-  consoleLogger.info(`Oobee version: ${appVersion}`); 
-  
+  consoleLogger.info(`Oobee version: ${appVersion}`);
+
   await combineRun(data, screenToScan);
 
   return getStoragePath(data.randomToken);

package/src/crawlers/custom/utils.ts

@@ -1,8 +1,8 @@
-/* eslint-disable no-shadow */
 /* eslint-disable no-alert */
 /* eslint-disable no-param-reassign */
 /* eslint-env browser */
 import path from 'path';
+import { getDomain } from 'tldts';
 import { runAxeScript } from '../commonCrawlerFunc.js';
 import { consoleLogger, guiInfoLog, silentLogger } from '../../logs.js';
 import { guiInfoStatusTypes } from '../../constants/constants.js';
@@ -19,6 +19,44 @@ declare global {
   }
 }
 
+const sameRegistrableDomain = (hostA: string, hostB: string) => {
+  const domainA = getDomain(hostA);
+  const domainB = getDomain(hostB);
+
+  if (!domainA || !domainB) return hostA === hostB;
+
+  return domainA === domainB;
+};
+
+const parseBoolEnv = (val: string | undefined, defaultVal: boolean) => {
+  if (val == null) return defaultVal;
+  const v = String(val).trim().toLowerCase();
+  if (['1', 'true', 'yes', 'y', 'on'].includes(v)) return true;
+  if (['0', 'false', 'no', 'n', 'off'].includes(v)) return false;
+  return defaultVal;
+};
+
+const RESTRICT_OVERLAY_TO_ENTRY_DOMAIN = parseBoolEnv(
+  process.env.RESTRICT_OVERLAY_TO_ENTRY_DOMAIN,
+  false,
+);
+
+const isOverlayAllowed = (currentUrl: string, entryUrl: string) => {
+  try {
+    const cur = new URL(currentUrl);
+
+    if (cur.protocol !== 'http:' && cur.protocol !== 'https:') return false;
+
+    if (!RESTRICT_OVERLAY_TO_ENTRY_DOMAIN) return true;
+
+    const base = new URL(entryUrl);
+
+    return sameRegistrableDomain(cur.hostname, base.hostname);
+  } catch {
+    return false;
+  }
+};
+
 //! For Cypress Test
 // env to check if Cypress test is running
 const isCypressTest = process.env.IS_CYPRESS_TEST === 'true';
@@ -67,10 +105,7 @@ export const screenshotFullPage = async (page, screenshotsDir: string, screensho
           setTimeout(async () => {
             await page.waitForLoadState('domcontentloaded');
 
-            const newHeight = await page.evaluate(
-              // eslint-disable-next-line no-shadow
-              () => document.body.scrollHeight,
-            );
+            const newHeight = await page.evaluate(() => document.body.scrollHeight);
             const result = newHeight > prevHeight;
 
             resolve(result);
@@ -248,7 +283,7 @@ export const updateMenu = async (page, urlsCrawled) => {
   log(`Overlay menu: updating: ${page.url()}`);
   await page.evaluate(
     vars => {
-      const shadowHost = document.querySelector('#oobee-shadow-host');
+      const shadowHost = document.querySelector('#oobeeShadowHost');
       if (shadowHost) {
         const p = shadowHost.shadowRoot.querySelector('#oobee-p-pages-scanned');
         if (p) {
@@ -262,7 +297,6 @@ export const updateMenu = async (page, urlsCrawled) => {
   consoleLogger.info(`Overlay menu updated`);
 };
 
-
 export const addOverlayMenu = async (
   page,
   urlsCrawled,
@@ -307,7 +341,7 @@ export const addOverlayMenu = async (
         `;
         minBtn.innerHTML = MINBTN_SVG;
 
-        let currentPos: 'LEFT' | 'RIGHT' = (vars.menuPos || 'RIGHT');
+        let currentPos: 'LEFT' | 'RIGHT' = vars.menuPos || 'RIGHT';
         const isCollapsed = () => panel.classList.contains('collapsed');
 
         const setPosClass = (pos: 'LEFT' | 'RIGHT') => {
@@ -325,7 +359,7 @@ export const addOverlayMenu = async (
         };
 
         const toggleCollapsed = (force?: boolean) => {
-          const willCollapse = (typeof force === 'boolean') ? force : !isCollapsed();
+          const willCollapse = typeof force === 'boolean' ? force : !isCollapsed();
           if (willCollapse) {
             panel.classList.add('collapsed');
             localStorage.setItem('oobee:overlay-collapsed', '1');
@@ -414,13 +448,13 @@ export const addOverlayMenu = async (
           const ol = document.createElement('ol');
           ol.className = 'oobee-ol';
 
-          scanned.forEach((item) => {
+          scanned.forEach(item => {
             const li = document.createElement('li');
             li.className = 'oobee-li';
 
             const title = document.createElement('div');
             title.className = 'oobee-item-title';
-            title.textContent = (item.pageTitle && item.pageTitle.trim()) ? item.pageTitle : item.url;
+            title.textContent = item.pageTitle && item.pageTitle.trim() ? item.pageTitle : item.url;
 
             const url = document.createElement('div');
             url.className = 'oobee-item-url';
@@ -730,8 +764,7 @@ export const addOverlayMenu = async (
 
           const closed = isCollapsed();
           const arrowPointsRight =
-            (currentPos === 'RIGHT' && !closed) ||
-            (currentPos === 'LEFT'  &&  closed);
+            (currentPos === 'RIGHT' && !closed) || (currentPos === 'LEFT' && closed);
 
           icon.classList.toggle('is-left', !arrowPointsRight);
           minBtn.setAttribute('aria-label', closed ? 'Expand panel' : 'Collapse panel');
@@ -761,11 +794,11 @@ export const addOverlayMenu = async (
 
         grip.addEventListener('pointerdown', (e: PointerEvent) => {
           startX = e.clientX;
-          grip.setPointerCapture(e.pointerId);       // <-- use the button
+          grip.setPointerCapture(e.pointerId); // <-- use the button
         });
 
         grip.addEventListener('pointermove', (e: PointerEvent) => {
-          if (!grip.hasPointerCapture?.(e.pointerId)) return;  // <-- check the button
+          if (!grip.hasPointerCapture?.(e.pointerId)) return; // <-- check the button
           const dx = e.clientX - startX;
           if (Math.abs(dx) >= THRESH) {
             const nextPos: 'LEFT' | 'RIGHT' = dx < 0 ? 'LEFT' : 'RIGHT';
@@ -779,7 +812,9 @@ export const addOverlayMenu = async (
         });
 
         grip.addEventListener('pointerup', (e: PointerEvent) => {
-          try { grip.releasePointerCapture(e.pointerId); } catch {}
+          try {
+            grip.releasePointerCapture(e.pointerId);
+          } catch {}
         });
 
         const stopDialog = document.createElement('dialog');
@@ -791,7 +826,7 @@ export const addOverlayMenu = async (
           borderRadius: '16px',
           overflow: 'hidden',
           boxShadow: '0 10px 40px rgba(0,0,0,.35)',
-          fontFamily: 'system-ui, -apple-system, Segoe UI, Roboto, Arial, sans-serif'
+          fontFamily: 'system-ui, -apple-system, Segoe UI, Roboto, Arial, sans-serif',
         });
         const dialogSheet = new CSSStyleSheet();
         dialogSheet.replaceSync(`
@@ -829,13 +864,18 @@ export const addOverlayMenu = async (
           display: 'flex',
           alignItems: 'center',
           justifyContent: 'space-between',
-          gap: '8px'
+          gap: '8px',
         });
 
         const title = document.createElement('h2');
         title.id = 'oobee-stop-title';
         title.textContent = 'Are you sure you want to stop this scan?';
-        Object.assign(title.style, { margin: '0', fontSize: '22px', fontWeight: '700', lineHeight: '1.25' });
+        Object.assign(title.style, {
+          margin: '0',
+          fontSize: '22px',
+          fontWeight: '700',
+          lineHeight: '1.25',
+        });
 
         const closeX = document.createElement('button');
         closeX.type = 'button';
@@ -853,14 +893,14 @@ export const addOverlayMenu = async (
           height: '36px',
           borderRadius: '12px',
           display: 'grid',
-          placeItems: 'center'
+          placeItems: 'center',
         });
         head.appendChild(title);
         head.appendChild(closeX);
 
         const bodyWrap = document.createElement('div');
         Object.assign(bodyWrap.style, {
-          padding: '12px 20px 20px 20px'
+          padding: '12px 20px 20px 20px',
         });
 
         const form = document.createElement('form');
@@ -869,7 +909,7 @@ export const addOverlayMenu = async (
         Object.assign(form.style, {
           display: 'grid',
           gridTemplateColumns: '1fr',
-          rowGap: '12px'
+          rowGap: '12px',
         });
 
         const label = document.createElement('label');
@@ -887,7 +927,7 @@ export const addOverlayMenu = async (
           padding: '12px 14px',
           fontSize: '14px',
           outline: 'none',
-          boxSizing: 'border-box'
+          boxSizing: 'border-box',
         });
         input.addEventListener('focus', () => {
           input.style.borderColor = '#7b4dff';
@@ -913,7 +953,7 @@ export const addOverlayMenu = async (
           fontWeight: '600',
           color: '#fff',
           background: '#9021A6',
-          cursor: 'pointer'
+          cursor: 'pointer',
         });
 
         const cancel = document.createElement('button');
@@ -926,7 +966,7 @@ export const addOverlayMenu = async (
           fontSize: '14px',
           justifySelf: 'center',
           cursor: 'pointer',
-          padding: '6px'
+          padding: '6px',
         });
 
         actions.appendChild(primary);
@@ -936,7 +976,7 @@ export const addOverlayMenu = async (
           form.appendChild(label);
           form.appendChild(input);
         }
-         form.appendChild(actions);
+        form.appendChild(actions);
         bodyWrap.appendChild(form);
 
         stopDialog.appendChild(head);
@@ -944,17 +984,27 @@ export const addOverlayMenu = async (
         shadowRoot.appendChild(stopDialog);
 
         let stopResolver: null | ((v: { confirmed: boolean; label: string }) => void) = null;
-        const hideStop = () => { try { stopDialog.close(); } catch {} stopResolver = null; };
+        const hideStop = () => {
+          try {
+            stopDialog.close();
+          } catch {}
+          stopResolver = null;
+        };
         const showStop = () => {
           if (!shouldHideInput) input.value = '';
-          try { stopDialog.showModal(); } catch {}
+          try {
+            stopDialog.showModal();
+          } catch {}
           if (!shouldHideInput) {
             requestAnimationFrame(() => {
-              try { input.focus({ preventScroll: true }); input.select(); } catch {}
+              try {
+                input.focus({ preventScroll: true });
+                input.select();
+              } catch {}
             });
           }
         };
-        form.addEventListener('submit', (e) => {
+        form.addEventListener('submit', e => {
           e.preventDefault();
           const v = (input.value || '').trim();
           if (stopResolver) stopResolver({ confirmed: true, label: v });
@@ -968,13 +1018,13 @@ export const addOverlayMenu = async (
           if (stopResolver) stopResolver({ confirmed: false, label: '' });
           hideStop();
         });
-        stopDialog.addEventListener('cancel', (e) => {
+        stopDialog.addEventListener('cancel', e => {
           e.preventDefault();
           if (stopResolver) stopResolver({ confirmed: false, label: '' });
           hideStop();
         });
         (customWindow as Window).oobeeShowStopModal = () =>
-          new Promise<{ confirmed: boolean; label: string }>((resolve) => {
+          new Promise<{ confirmed: boolean; label: string }>(resolve => {
             stopResolver = resolve;
             showStop();
           });
@@ -1000,7 +1050,7 @@ export const addOverlayMenu = async (
       log('Overlay menu: successfully added');
     })
     .catch(error => {
-      error('Overlay menu: failed to add', error);
+      consoleLogger.error('Overlay menu: failed to add', error);
     });
 };
 
@@ -1027,7 +1077,7 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
   // eslint-disable-next-line no-underscore-dangle
   const pageId = page._guid;
 
-  page.on('dialog', () => { });
+  page.on('dialog', () => {});
 
   const pageClosePromise = new Promise(resolve => {
     page.on('close', () => {
@@ -1058,11 +1108,18 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
       await processPage(page, processPageParams);
       log('Scan: success');
       pagesDict[pageId].isScanning = false;
-       await addOverlayMenu(page, processPageParams.urlsCrawled, menuPos, {
-         inProgress: false,
-         collapsed: !!pagesDict[pageId]?.collapsed,
-         hideStopInput: !!processPageParams.customFlowLabel,
-       });
+
+      const allowed = isOverlayAllowed(page.url(), processPageParams.entryUrl);
+
+      if (allowed) {
+        await addOverlayMenu(page, processPageParams.urlsCrawled, menuPos, {
+          inProgress: false,
+          collapsed: !!pagesDict[pageId]?.collapsed,
+          hideStopInput: !!processPageParams.customFlowLabel,
+        });
+      } else {
+        await removeOverlayMenu(page);
+      }
     } catch (error) {
       log(`Scan failed ${error}`);
     }
@@ -1126,6 +1183,13 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
 
   page.on('domcontentloaded', async () => {
     try {
+      const allowed = isOverlayAllowed(page.url(), processPageParams.entryUrl);
+
+      if (!allowed) {
+        await removeOverlayMenu(page);
+        return;
+      }
+
       const existingOverlay = await page.evaluate(() => {
         return document.querySelector('#oobeeShadowHost');
       });
@@ -1141,12 +1205,6 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
         });
       }
 
-      setTimeout(() => {
-        // Timeout here to slow things down a little
-      }, 1000);
-
-      //! For Cypress Test
-      // Auto-clicks 'Scan this page' button only once
       if (isCypressTest) {
         try {
           await handleOnScanClick();
@@ -1155,11 +1213,8 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
           consoleLogger.info(`Error in calling handleOnScanClick, isCypressTest: ${isCypressTest}`);
         }
       }
-
-      consoleLogger.info(`Overlay state: ${existingOverlay}`);
     } catch {
       consoleLogger.info('Error in adding overlay menu to page');
-      consoleLogger.info('Error in adding overlay menu to page');
     }
   });
 

package/src/crawlers/runCustom.ts

@@ -25,6 +25,8 @@ export class ProcessPageParams {
   randomToken: string;
   customFlowLabel?: string;
   stopAll?: () => Promise<void>;
+  entryUrl!: string;
+  strategy: string;
 
   constructor(
     scannedIdx: number,
@@ -69,6 +71,8 @@ const runCustom = async (
     randomToken,
   );
 
+  processPageParams.entryUrl = url;
+
   if (initialCustomFlowLabel && initialCustomFlowLabel.trim()) {
     processPageParams.customFlowLabel = initialCustomFlowLabel.trim();
   }
@@ -80,18 +84,20 @@ const runCustom = async (
     const deviceConfig = viewportSettings.playwrightDeviceDetailsObject;
     const hasCustomViewport = !!deviceConfig;
 
-    const baseLaunchOptions = getPlaywrightLaunchOptions('chrome');
+    const baseLaunchOptions = getPlaywrightLaunchOptions();
 
     // Merge base args with custom flow specific args
     const baseArgs = baseLaunchOptions.args || [];
     const customArgs = hasCustomViewport ? ['--window-size=1920,1040'] : ['--start-maximized'];
-    const mergedArgs = [...baseArgs.filter(a => !a.startsWith('--window-size') && a !== '--start-maximized'), ...customArgs];
+    const mergedArgs = [
+      ...baseArgs.filter(a => !a.startsWith('--window-size') && a !== '--start-maximized'),
+      ...customArgs,
+    ];
 
     const browser = await chromium.launch({
       ...baseLaunchOptions,
       args: mergedArgs,
       headless: false,
-      channel: 'chrome',
     });
 
     const context = await browser.newContext({
@@ -107,8 +113,7 @@ const runCustom = async (
       try {
         await context.close().catch(() => {});
         await browser.close().catch(() => {});
-      } catch {
-      }
+      } catch {}
     };
 
     // For handling closing playwright browser and continue generate artifacts etc

package/src/mergeAxeResults.ts

@@ -349,44 +349,61 @@ const writeSummaryPdf = async (
   browser: string,
   _userDataDirectory: string,
 ) => {
-  const htmlFilePath = `${storagePath}/${filename}.html`;
-  const fileDestinationPath = `${storagePath}/${filename}.pdf`;
+  let browserInstance;
+  let context;
+  let page;
 
-  const launchOptions = getPlaywrightLaunchOptions(browser);
+  try {
+    const htmlFilePath = path.join(storagePath, `${filename}.html`);
+    const fileDestinationPath = path.join(storagePath, `${filename}.pdf`);
+    const htmlFileUrl = `file://${htmlFilePath}`;
 
-  const browserInstance = await constants.launcher.launch({
-    ...launchOptions,
-    headless: true, // force headless for PDF
-  });
+    const launchOptions = getPlaywrightLaunchOptions(browser);
+
+    browserInstance = await constants.launcher.launch({
+      ...launchOptions,
+      headless: true,
+    });
 
-  register(browserInstance as unknown as { close: () => Promise<void> });
+    register(browserInstance as unknown as { close: () => Promise<void> });
 
-  const context = await browserInstance.newContext();
-  const page = await context.newPage();
+    context = await browserInstance.newContext();
+    page = await context.newPage();
 
-  const data = fs.readFileSync(htmlFilePath, { encoding: 'utf-8' });
-  await page.setContent(data, { waitUntil: 'domcontentloaded' });
+    await page.goto(htmlFileUrl, {
+      waitUntil: 'domcontentloaded',
+      timeout: 120000,
+    });
 
-  await page.emulateMedia({ media: 'print' });
+    await page.emulateMedia({ media: 'print' });
 
-  await page.pdf({
-    margin: { bottom: '32px' },
-    path: fileDestinationPath,
-    format: 'A4',
-    displayHeaderFooter: true,
-    footerTemplate: `
+    await page.pdf({
+      margin: { bottom: '32px' },
+      path: fileDestinationPath,
+      format: 'A4',
+      displayHeaderFooter: true,
+      footerTemplate: `
     <div style="margin-top:50px;color:#26241b;font-family:Open Sans;text-align: center;width: 100%;font-weight:400">
       <span style="color:#26241b;font-size: 14px;font-weight:400">Page <span class="pageNumber"></span> of <span class="totalPages"></span></span>
     </div>
   `,
-  });
-
-  await page.close();
-  await context.close().catch(() => {});
-  await browserInstance.close().catch(() => {});
+    });
 
-  if (pagesScanned < 2000) {
-    fs.unlinkSync(htmlFilePath);
+    if (pagesScanned < 2000) {
+      fs.unlinkSync(htmlFilePath);
+    }
+  } catch (err) {
+    consoleLogger.info(`Error at writeSummaryPDF ${err instanceof Error ? err.stack : err}`);
+  } finally {
+    await page?.close().catch(err => {
+      consoleLogger.info(`Error at page close writeSummaryPDF ${err}`);
+    });
+    await context?.close().catch(err => {
+      consoleLogger.info(`Error at context close writeSummaryPDF ${err}`);
+    });
+    await browserInstance?.close().catch(err => {
+      consoleLogger.info(`Error at browserInstance close writeSummaryPDF ${err}`);
+    });
   }
 };