@govtechsg/oobee 0.10.85 → 0.10.87

package/dist/crawlers/custom/utils.js

@@ -25,6 +25,7 @@ const parseBoolEnv = (val, defaultVal) => {
     return defaultVal;
 };
 const RESTRICT_OVERLAY_TO_ENTRY_DOMAIN = parseBoolEnv(process.env.RESTRICT_OVERLAY_TO_ENTRY_DOMAIN, false);
+const OVERLAY_OPERATION_TIMEOUT_MS = 5000;
 const isOverlayAllowed = (currentUrl, entryUrl) => {
     try {
         const cur = new URL(currentUrl);
@@ -62,14 +63,19 @@ export const screenshotFullPage = async (page, screenshotsDir, screenshotIdx) =>
             await page.evaluate(() => {
                 window.scrollTo(0, document.body.scrollHeight);
             });
-            const isLoadMoreContent = async () => new Promise(resolve => {
-                setTimeout(async () => {
+            const isLoadMoreContent = async () => {
+                await new Promise(resolve => setTimeout(resolve, 2500));
+                if (page.isClosed())
+                    return false;
+                try {
                     await page.waitForLoadState('domcontentloaded');
                     const newHeight = await page.evaluate(() => document.body.scrollHeight);
-                    const result = newHeight > prevHeight;
-                    resolve(result);
-                }, 2500);
-            });
+                    return newHeight > prevHeight;
+                }
+                catch {
+                    return false;
+                }
+            };
             const result = await isLoadMoreContent();
             return result;
         };
@@ -201,7 +207,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
     inProgress: false,
     collapsed: false,
 }) => {
-    await page.waitForLoadState('domcontentloaded');
+    await page.waitForLoadState('domcontentloaded', { timeout: OVERLAY_OPERATION_TIMEOUT_MS });
     consoleLogger.info(`Overlay menu: adding to ${menuPos}...`);
     // Add the overlay menu with initial styling
     return page
@@ -291,22 +297,60 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
         const h2 = document.createElement('h2');
         h2.id = 'oobeeHPagesScanned';
         h2.className = 'oobee-section-title';
-        h2.textContent = 'Pages Scanned';
+        h2.textContent = `Pages Scanned (${vars.urlsCrawled.scanned.length || 0})`;
+        const scanIcon = document.createElement('span');
+        scanIcon.className = 'oobee-btn-icon';
+        const SCAN_SVG = `
+          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" fill="none">
+            <g clip-path="url(#clip0_1421_431)">
+              <path d="M12.5763 11.5472L12.2958 11.2857L12.1037 11.1005C12.776 10.3183 12.9194 9.56432 12.9194 8.45969C12.9194 5.99657 10.9228 4 8.45969 4C5.99657 4 4 5.99657 4 8.45969C4 10.9228 5.99657 12.9194 8.45969 12.9194C9.56432 12.9194 10.3183 12.776 11.1005 12.1037L11.2857 12.2958L11.5472 12.5763L14.9777 16L16 14.9777L12.5763 11.5472ZM8.45969 11.5472C6.75129 11.5472 5.37221 10.1681 5.37221 8.45969C5.37221 6.75129 6.75129 5.37221 8.45969 5.37221C10.1681 5.37221 11.5472 6.75129 11.5472 8.45969C11.5472 10.1681 10.1681 11.5472 8.45969 11.5472Z" fill="white"/>
+              <path d="M18.5 0H19.5C19.7761 0 20 0.223858 20 0.5V5H18.5V0Z" fill="white"/>
+              <path d="M19.5 2.18552e-08L19.5 1.5L15 1.5L15 -2.18556e-07L19.5 2.18552e-08Z" fill="white"/>
+              <path d="M1.5 0H0.5C0.223858 0 0 0.223858 0 0.5V5H1.5V0Z" fill="white"/>
+              <path d="M0.5 2.18552e-08L0.5 1.5L5 1.5L5 -2.18556e-07L0.5 2.18552e-08Z" fill="white"/>
+              <path d="M1.5 20H0.5C0.223858 20 0 19.7761 0 19.5V15H1.5V20Z" fill="white"/>
+              <path d="M0.5 20L0.5 18.5L5 18.5L5 20L0.5 20Z" fill="white"/>
+              <path d="M18.5 20H19.5C19.7761 20 20 19.7761 20 19.5V15H18.5V20Z" fill="white"/>
+              <path d="M19.5 20L19.5 18.5L15 18.5L15 20L19.5 20Z" fill="white"/>
+            </g>
+            <defs>
+              <clipPath id="clip0_1421_431">
+                <rect width="20" height="20" fill="white"/>
+              </clipPath>
+            </defs>
+          </svg>
+        `;
+        scanIcon.innerHTML = SCAN_SVG;
         const scanBtn = document.createElement('button');
         scanBtn.id = 'oobeeBtnScan';
         scanBtn.className = 'oobee-btn oobee-btn-primary';
-        scanBtn.innerText = 'Scan this page';
         scanBtn.disabled = inProgress;
+        scanBtn.appendChild(scanIcon);
+        const scanText = document.createElement('span');
+        scanText.className = 'oobee-btn-text';
+        scanText.innerText = 'Scan page';
+        scanBtn.appendChild(scanText);
         scanBtn.addEventListener('click', async () => customWindow.handleOnScanClick?.());
-        const stopBtn = document.createElement('button');
-        stopBtn.id = 'oobeeBtnStop';
-        stopBtn.className = 'oobee-btn oobee-btn-secondary';
-        stopBtn.innerText = 'Stop scan';
-        stopBtn.addEventListener('click', async () => customWindow.handleOnStopClick?.());
+        const endScanIcon = document.createElement('span');
+        endScanIcon.className = 'oobee-btn-icon';
+        const ENDSCAN_SVG = `<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" fill="none">
+            <path d="M10 0C4.47 0 0 4.47 0 10C0 15.53 4.47 20 10 20C15.53 20 20 15.53 20 10C20 4.47 15.53 0 10 0ZM10 18C5.59 18 2 14.41 2 10C2 5.59 5.59 2 10 2C14.41 2 18 5.59 18 10C18 14.41 14.41 18 10 18ZM13.59 5L10 8.59L6.41 5L5 6.41L8.59 10L5 13.59L6.41 15L10 11.41L13.59 15L15 13.59L11.41 10L15 6.41L13.59 5Z" fill="#9021A6"/>
+          </svg>
+        `;
+        endScanIcon.innerHTML = ENDSCAN_SVG;
+        const endScanBtn = document.createElement('button');
+        endScanBtn.id = 'oobeeBtnEndScan';
+        endScanBtn.className = 'oobee-btn oobee-btn-secondary';
+        endScanBtn.appendChild(endScanIcon);
+        const endScanText = document.createElement('span');
+        endScanText.className = 'oobee-btn-text';
+        endScanText.innerText = 'End scan';
+        endScanBtn.appendChild(endScanText);
+        endScanBtn.addEventListener('click', async () => customWindow.handleOnStopClick?.());
         const btnGroup = document.createElement('div');
         btnGroup.className = 'oobee-actions';
         btnGroup.appendChild(scanBtn);
-        btnGroup.appendChild(stopBtn);
+        btnGroup.appendChild(endScanBtn);
         const listWrap = document.createElement('div');
         listWrap.id = 'oobeeList';
         listWrap.className = 'oobee-list';
@@ -370,7 +414,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             border-right: 1px solid rgba(0,0,0,.08)
           }
           .oobee-panel.collapsed {
-            width: 56px;
+            width: 58px;
             overflow: hidden
           }
 
@@ -447,6 +491,12 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             padding: 1rem;
           }
 
+          .oobee-panel.collapsed .oobee-actions {
+            display: flex;
+            justify-content: center;
+            padding: 1rem 0.7rem;
+          }
+
           /* Base button */
           .oobee-btn {
             width: 100%;
@@ -457,6 +507,10 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             line-height: 1.2;
             font-weight: 400;
             cursor: pointer;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+            gap: 10px;
             transition: {
               box-shadow .12s ease,
               transform .02s ease,
@@ -470,6 +524,19 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             cursor:not-allowed
           }
 
+          .oobee-panel.collapsed .oobee-btn {
+            width: 44px !important;
+            height: 44px !important;
+            min-width: 44px !important;
+            min-height: 44px !important;
+            max-width: 44px !important;
+            max-height: 44px !important;
+            border-radius: 50% !important;
+            padding: 0 !important;
+            justify-content: center;
+            gap: 0;
+          }
+
           /* Primary (filled) */
           .oobee-btn-primary {
             background: #9021a6;
@@ -525,6 +592,25 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
             display: none;
           }
 
+          .oobee-btn-icon {
+            display: inline-flex;
+            align-items: center;
+            justify-content: center;
+            width: 20px;
+            height: 20px;
+            vertical-align: middle;
+          }
+
+          .oobee-btn-text {
+            display: inline;
+            white-space: nowrap;
+            vertical-align: middle;
+          }
+          
+          .oobee-panel.collapsed .oobee-btn-text {
+            display: none;
+          }
+
           #oobeeStopOverlay[hidden] {
             display:none !important;
           }
@@ -542,7 +628,10 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
           }
 
           .oobee-panel.collapsed .oobee-section-title {
-            display: none;
+            font-size: 14px;
+            display: flex;
+            justify-content: center;
+            text-align: center;
           }
 
           .oobee-ol {
@@ -899,6 +988,7 @@ export const addOverlayMenu = async (page, urlsCrawled, menuPos, opts = {
     })
         .catch(error => {
         consoleLogger.error('Overlay menu: failed to add', error);
+        throw error;
     });
 };
 export const removeOverlayMenu = async (page) => {
@@ -919,9 +1009,18 @@ export const removeOverlayMenu = async (page) => {
 };
 export const initNewPage = async (page, pageClosePromises, processPageParams, pagesDict) => {
     let menuPos = MENU_POSITION.right;
+    let overlayRefreshSeq = 0;
+    let overlayRefreshChain = Promise.resolve();
     // eslint-disable-next-line no-underscore-dangle
     const pageId = page._guid;
-    page.on('dialog', () => { });
+    page.on('dialog', async (dialog) => {
+        try {
+            await dialog.dismiss();
+        }
+        catch {
+            // dialog may already be closed
+        }
+    });
     const pageClosePromise = new Promise(resolve => {
         page.on('close', () => {
             log(`Page: close detected: ${page.url()}`);
@@ -937,6 +1036,68 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
             collapsed: false,
         };
     }
+    const reconcileOverlayMenu = async (trigger) => {
+        // Mark this as the latest refresh so older ones can stop.
+        const refreshSeq = ++overlayRefreshSeq;
+        // Serialize overlay updates so multiple navigation events do not add/remove concurrently.
+        overlayRefreshChain = overlayRefreshChain
+            .catch(() => { })
+            .then(async () => {
+            if (refreshSeq !== overlayRefreshSeq || page.isClosed())
+                return;
+            try {
+                // `framenavigated` can fire before the new document is ready for DOM inspection/injection.
+                await page.waitForLoadState('domcontentloaded', { timeout: 5000 });
+            }
+            catch {
+                // Best effort only. The page may still be mid-navigation.
+            }
+            try {
+                // Give fast redirect chains a brief chance to advance before we inject/remove the overlay.
+                await page.waitForTimeout(300);
+            }
+            catch {
+                // Best effort only. The page may already be closing.
+            }
+            // Re-check staleness after waiting because a newer navigation may have happened meanwhile.
+            if (refreshSeq !== overlayRefreshSeq || page.isClosed())
+                return;
+            const allowed = isOverlayAllowed(page.url(), processPageParams.entryUrl);
+            if (!allowed) {
+                await Promise.race([
+                    removeOverlayMenu(page),
+                    new Promise((_, reject) => {
+                        setTimeout(() => {
+                            reject(new Error(`removeOverlayMenu timed out after ${OVERLAY_OPERATION_TIMEOUT_MS}ms`));
+                        }, OVERLAY_OPERATION_TIMEOUT_MS);
+                    }),
+                ]);
+                return;
+            }
+            const hasOverlay = await page.evaluate(() => Boolean(document.querySelector('#oobeeShadowHost')));
+            consoleLogger.info(`Overlay state (${trigger}): ${hasOverlay}`);
+            if (!hasOverlay) {
+                // Recreate the overlay after allowed redirects while preserving current UI state.
+                consoleLogger.info(`Adding overlay menu to page (${trigger}): ${page.url()}`);
+                await Promise.race([
+                    addOverlayMenu(page, processPageParams.urlsCrawled, menuPos, {
+                        inProgress: !!pagesDict[pageId]?.isScanning,
+                        collapsed: !!pagesDict[pageId]?.collapsed,
+                        hideStopInput: !!processPageParams.customFlowLabel,
+                    }),
+                    new Promise((_, reject) => {
+                        setTimeout(() => {
+                            reject(new Error(`addOverlayMenu timed out after ${OVERLAY_OPERATION_TIMEOUT_MS}ms`));
+                        }, OVERLAY_OPERATION_TIMEOUT_MS);
+                    }),
+                ]);
+            }
+        })
+            .catch(() => {
+            consoleLogger.info('Error in adding overlay menu to page');
+        });
+        await overlayRefreshChain;
+    };
     // Window functions exposed in browser
     const handleOnScanClick = async () => {
         consoleLogger.info('Scan: click detected');
@@ -947,17 +1108,9 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
             await processPage(page, processPageParams);
             log('Scan: success');
             pagesDict[pageId].isScanning = false;
-            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);
-            }
+            if (page.isClosed())
+                return;
+            await reconcileOverlayMenu('scan-click');
         }
         catch (error) {
             log(`Scan failed ${error}`);
@@ -987,10 +1140,10 @@ export const initNewPage = async (page, pageClosePromises, processPageParams, pa
             });
             if (!inputValue?.confirmed) {
                 await page.evaluate(() => {
-                    const stopBtn = document.getElementById('oobeeBtnStop');
-                    if (stopBtn) {
-                        stopBtn.disabled = false;
-                        stopBtn.textContent = 'Stop';
+                    const endScanBtn = document.getElementById('oobeeBtnEndScan');
+                    if (endScanBtn) {
+                        endScanBtn.disabled = false;
+                        endScanBtn.textContent = 'Stop';
                     }
                 });
                 return;
@@ -1019,47 +1172,41 @@ 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');
-            });
-            consoleLogger.info(`Overlay state: ${existingOverlay}`);
-            if (!existingOverlay) {
-                consoleLogger.info(`Adding overlay menu to page: ${page.url()}`);
-                await addOverlayMenu(page, processPageParams.urlsCrawled, menuPos, {
-                    inProgress: !!pagesDict[pageId]?.isScanning,
-                    collapsed: !!pagesDict[pageId]?.collapsed,
-                    hideStopInput: !!processPageParams.customFlowLabel,
-                });
+        if (page.isClosed())
+            return;
+        await reconcileOverlayMenu('domcontentloaded');
+        if (isCypressTest) {
+            try {
+                await handleOnScanClick();
+                page.close();
             }
-            if (isCypressTest) {
-                try {
-                    await handleOnScanClick();
-                    page.close();
-                }
-                catch {
-                    consoleLogger.info(`Error in calling handleOnScanClick, isCypressTest: ${isCypressTest}`);
-                }
+            catch {
+                consoleLogger.info(`Error in calling handleOnScanClick, isCypressTest: ${isCypressTest}`);
             }
         }
-        catch {
-            consoleLogger.info('Error in adding overlay menu to page');
-        }
     });
-    await page.exposeFunction('handleOnScanClick', handleOnScanClick);
-    await page.exposeFunction('handleOnStopClick', handleOnStopClick);
-    // Define the updateMenuPos function
-    const updateMenuPos = newPos => {
-        const prevPos = menuPos;
-        if (prevPos !== newPos) {
-            menuPos = newPos;
-        }
-    };
-    await page.exposeFunction('updateMenuPos', updateMenuPos);
+    page.on('framenavigated', async (frame) => {
+        if (frame !== page.mainFrame() || page.isClosed())
+            return;
+        await reconcileOverlayMenu('framenavigated');
+    });
+    try {
+        if (page.isClosed())
+            return page;
+        await page.exposeFunction('handleOnScanClick', handleOnScanClick);
+        await page.exposeFunction('handleOnStopClick', handleOnStopClick);
+        // Define the updateMenuPos function
+        const updateMenuPos = newPos => {
+            const prevPos = menuPos;
+            if (prevPos !== newPos) {
+                menuPos = newPos;
+            }
+        };
+        await page.exposeFunction('updateMenuPos', updateMenuPos);
+    }
+    catch (e) {
+        log(`Error exposing functions on page: ${e}`);
+    }
+    await reconcileOverlayMenu('init');
     return page;
 };

package/dist/crawlers/guards/urlGuard.js

@@ -2,15 +2,16 @@ const ALLOWED_PROTOCOLS = new Set(['http:', 'https:']);
 export function addUrlGuardScript(context, opts = {}) {
     const { fallbackUrl } = opts;
     const lastAllowedUrlByPage = new WeakMap();
-    const attachGuardsToPage = (page) => {
+    const attachGuardsToPage = page => {
         if (!lastAllowedUrlByPage.has(page) && fallbackUrl) {
             lastAllowedUrlByPage.set(page, String(fallbackUrl));
         }
-        page.addInitScript(() => {
-            const isAllowedProtocol = (value) => {
+        page
+            .addInitScript(() => {
+            const isAllowedProtocol = value => {
                 try {
                     const s = value instanceof URL ? value.toString() : String(value);
-                    const protocol = new URL(s, window.location.href).protocol;
+                    const { protocol } = new URL(s, window.location.href);
                     return protocol === 'http:' || protocol === 'https:';
                 }
                 catch {
@@ -24,17 +25,9 @@ export function addUrlGuardScript(context, opts = {}) {
                     return null;
                 return openOriginal.call(this, targetUrl, ...args);
             };
-            const assignOriginal = win.location.assign.bind(win.location);
-            const replaceOriginal = win.location.replace.bind(win.location);
-            win.location.assign = (nextUrl) => { if (isAllowedProtocol(nextUrl))
-                assignOriginal(nextUrl); };
-            win.location.replace = (nextUrl) => { if (isAllowedProtocol(nextUrl))
-                replaceOriginal(nextUrl); };
-            Object.defineProperty(win.location, 'href', {
-                get() { return String(win.location.toString()); },
-                set(nextUrl) { if (isAllowedProtocol(nextUrl))
-                    assignOriginal(nextUrl); },
-            });
+        })
+            .catch(() => {
+            // page may have closed before addInitScript completed; safe to ignore
         });
         const restoreToSafeUrl = async (page, attemptedUrl) => {
             try {

package/dist/crawlers/runCustom.js

@@ -1,12 +1,11 @@
 /* eslint-env browser */
-import { chromium } from 'playwright';
 import { createCrawleeSubFolders } from './commonCrawlerFunc.js';
 import { cleanUpAndExit, register, registerSoftClose } from '../utils.js';
 import constants, { getIntermediateScreenshotsPath, guiInfoStatusTypes, } from '../constants/constants.js';
 import { initNewPage, log } from './custom/utils.js';
 import { guiInfoLog } from '../logs.js';
 import { addUrlGuardScript } from './guards/urlGuard.js';
-import { getPlaywrightLaunchOptions } from '../constants/common.js';
+import { getBrowserToRun, getPlaywrightLaunchOptions, initModifiedUserAgent, } from '../constants/common.js';
 // Export of classes
 export class ProcessPageParams {
     constructor(scannedIdx, blacklistedPatterns, includeScreenshots, dataset, intermediateScreenshotsPath, urlsCrawled, randomToken) {
@@ -19,7 +18,7 @@ export class ProcessPageParams {
         this.randomToken = randomToken;
     }
 }
-const runCustom = async (url, randomToken, viewportSettings, blacklistedPatterns, includeScreenshots, initialCustomFlowLabel) => {
+const runCustom = async (url, randomToken, browserToRun, userDataDirectory, viewportSettings, blacklistedPatterns, includeScreenshots, initialCustomFlowLabel) => {
     // checks and delete datasets path if it already exists
     process.env.CRAWLEE_STORAGE_DIR = randomToken;
     const urlsCrawled = { ...constants.urlsCrawledObj };
@@ -34,9 +33,13 @@ const runCustom = async (url, randomToken, viewportSettings, blacklistedPatterns
     const pagesDict = {};
     const pageClosePromises = [];
     try {
+        const { browserToRun: resolvedBrowserToRun } = getBrowserToRun(randomToken, browserToRun, false);
         const deviceConfig = viewportSettings.playwrightDeviceDetailsObject;
         const hasCustomViewport = !!deviceConfig;
-        const baseLaunchOptions = getPlaywrightLaunchOptions();
+        const rawDevice = (deviceConfig || {});
+        const { userAgent: deviceUserAgent, ...contextDeviceOptions } = rawDevice;
+        await initModifiedUserAgent(resolvedBrowserToRun, viewportSettings.playwrightDeviceDetailsObject);
+        const baseLaunchOptions = getPlaywrightLaunchOptions(resolvedBrowserToRun);
         // Merge base args with custom flow specific args
         const baseArgs = baseLaunchOptions.args || [];
         const customArgs = hasCustomViewport ? ['--window-size=1920,1040'] : ['--start-maximized'];
@@ -44,33 +47,37 @@ const runCustom = async (url, randomToken, viewportSettings, blacklistedPatterns
             ...baseArgs.filter(a => !a.startsWith('--window-size') && a !== '--start-maximized'),
             ...customArgs,
         ];
-        const browser = await chromium.launch({
+        const context = await constants.launcher.launchPersistentContext(userDataDirectory, {
             ...baseLaunchOptions,
             args: mergedArgs,
             headless: false,
-        });
-        const context = await browser.newContext({
             ignoreHTTPSErrors: true,
             serviceWorkers: 'block',
             viewport: null,
-            ...(hasCustomViewport ? deviceConfig : {}),
+            ...(hasCustomViewport ? contextDeviceOptions : {}),
+            userAgent: process.env.OOBEE_USER_AGENT || deviceUserAgent,
         });
         register(context);
         processPageParams.stopAll = async () => {
             try {
                 await context.close().catch(() => { });
-                await browser.close().catch(() => { });
             }
             catch { }
         };
         // For handling closing playwright browser and continue generate artifacts etc
         registerSoftClose(processPageParams.stopAll);
         addUrlGuardScript(context, { fallbackUrl: url });
+        const page = context.pages().find(existingPage => !existingPage.isClosed()) || (await context.newPage());
+        await initNewPage(page, pageClosePromises, processPageParams, pagesDict);
         // Detection of new page
         context.on('page', async (newPage) => {
-            await initNewPage(newPage, pageClosePromises, processPageParams, pagesDict);
+            try {
+                await initNewPage(newPage, pageClosePromises, processPageParams, pagesDict);
+            }
+            catch (e) {
+                log(`Error initializing new page: ${e}`);
+            }
         });
-        const page = await context.newPage();
         await page.goto(url, { timeout: 0 });
         // to execute and wait for all pages to close
         // idea is for promise to be pending until page.on('close') detected

package/dist/generateHtmlReport.js

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import path from 'path';
 import { compressJsonFileStreaming, writeHTML, flattenAndSortResults, populateScanPagesDetail, getWcagPassPercentage, getProgressPercentage, getIssuesPercentage, itemTypeDescription, oobeeAiHtmlETL, oobeeAiRules, formatAboutStartTime, convertItemsToReferences, } from './mergeAxeResults.js';
-import constants, { ScannerTypes, WCAGclauses, a11yRuleShortDescriptionMap, disabilityBadgesMap, a11yRuleLongDescriptionMap, } from './constants/constants.js';
+import constants, { ScannerTypes, WCAGclauses, a11yRuleShortDescriptionMap, disabilityBadgesMap, a11yRuleLongDescriptionMap, a11yRuleStepByStepGuide, } from './constants/constants.js';
 import { consoleLogger } from './logs.js';
 const ensureCategory = (categoryObj, categoryName) => {
     const rulesRaw = categoryObj?.rules ?? [];
@@ -23,7 +23,12 @@ const ensureCategory = (categoryObj, categoryName) => {
             rule.pagesAffected = [];
         }
         if (typeof rule.totalItems !== 'number') {
-            rule.totalItems = rule.pagesAffected.reduce((accumulate, page) => accumulate + (Array.isArray(page.items) ? page.items.length : 0), 0);
+            rule.totalItems = rule.pagesAffected.reduce((accumulate, page) => accumulate +
+                (Array.isArray(page.items)
+                    ? page.items.length
+                    : typeof page.itemsCount === 'number'
+                        ? page.itemsCount
+                        : 0), 0);
         }
     });
     const totals = {
@@ -38,7 +43,7 @@ const ensureCategory = (categoryObj, categoryName) => {
         rules,
     };
 };
-export const generateHtmlReport = async (resultDir) => {
+export const generateHtmlReport = async (resultDir, htmlFilename = 'report') => {
     try {
         const storagePath = path.resolve(resultDir);
         const scanDataJsonPath = path.join(storagePath, 'scanData.json');
@@ -61,17 +66,16 @@ export const generateHtmlReport = async (resultDir) => {
         }
         const scanData = JSON.parse(await fs.readFile(scanDataJsonPath, 'utf8'));
         const scanItemsAll = JSON.parse(await fs.readFile(scanItemsJsonPath, 'utf8'));
-        // Use convertItemsToReferences to normalize items structure to match scanItemsWithHtmlGroupRefs format
-        const scanItemsWithHtmlGroupRefs = convertItemsToReferences({
+        // Build the lighter scanItems payload used by the HTML report.
+        const lightScanItemsPayload = convertItemsToReferences({
             items: scanItemsAll,
-            ...scanData
         });
-        const { mustFix = {}, goodToFix = {}, needsReview = {}, passed = {}, } = scanItemsWithHtmlGroupRefs;
+        const { mustFix = {}, goodToFix = {}, needsReview = {}, } = lightScanItemsPayload;
         const items = {
             mustFix: ensureCategory(mustFix, 'mustFix'),
             goodToFix: ensureCategory(goodToFix, 'goodToFix'),
             needsReview: ensureCategory(needsReview, 'needsReview'),
-            passed: ensureCategory(passed, 'passed'),
+            passed: ensureCategory(scanItemsAll.passed || {}, 'passed'),
         };
         const pagesScanned = Array.isArray(scanData.pagesScanned) ? scanData.pagesScanned : [];
         const pagesNotScanned = Array.isArray(scanData.pagesNotScanned) ? scanData.pagesNotScanned : [];
@@ -116,6 +120,8 @@ export const generateHtmlReport = async (resultDir) => {
             a11yRuleShortDescriptionMap,
             disabilityBadgesMap,
             a11yRuleLongDescriptionMap,
+            a11yRuleStepByStepGuide,
+            wcagCriteriaLabels: constants.wcagCriteriaLabels,
             advancedScanOptionsSummaryItems: {
                 showIncludeScreenshots: !!scanData.advancedScanOptionsSummaryItems?.showIncludeScreenshots,
                 showAllowSubdomains: !!scanData.advancedScanOptionsSummaryItems?.showAllowSubdomains,
@@ -137,9 +143,10 @@ export const generateHtmlReport = async (resultDir) => {
         allIssues.wcagPassPercentage = getWcagPassPercentage(allIssues.wcagViolations, allIssues.advancedScanOptionsSummaryItems.showEnableWcagAaa);
         allIssues.progressPercentage = getProgressPercentage(allIssues.scanPagesDetail, allIssues.advancedScanOptionsSummaryItems.showEnableWcagAaa);
         allIssues.issuesPercentage = await getIssuesPercentage(allIssues.scanPagesDetail, allIssues.advancedScanOptionsSummaryItems.showEnableWcagAaa, allIssues.advancedScanOptionsSummaryItems?.disableOobee);
-        await writeHTML(allIssues, storagePath, 'report', scanDataB64Path, scanItemsB64Path);
-        consoleLogger.info(`Report generated at: ${path.join(storagePath, 'report.html')}`);
-        return path.join(storagePath, 'report.html');
+        await writeHTML(allIssues, storagePath, htmlFilename, scanDataB64Path, scanItemsB64Path);
+        const outputPath = path.join(storagePath, `${htmlFilename}.html`);
+        consoleLogger.info(`Report generated at: ${outputPath}`);
+        return outputPath;
     }
     catch (err) {
         consoleLogger.error(`generateHtmlReport failed: ${err?.message || err}`);