@govtechsg/oobee 0.10.76 → 0.10.78-alpha1

package/dist/generateHtmlReport.js

@@ -0,0 +1,144 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { compressJsonFileStreaming, writeHTML, flattenAndSortResults, populateScanPagesDetail, getWcagPassPercentage, getProgressPercentage, getIssuesPercentage, itemTypeDescription, oobeeAiHtmlETL, oobeeAiRules, formatAboutStartTime, } from './mergeAxeResults.js';
+import constants, { ScannerTypes, WCAGclauses, a11yRuleShortDescriptionMap, disabilityBadgesMap, a11yRuleLongDescriptionMap, } from './constants/constants.js';
+import { consoleLogger } from './logs.js';
+const ensureCategory = (categoryObj, categoryName) => {
+    const rulesRaw = categoryObj?.rules ?? [];
+    const rules = Array.isArray(rulesRaw)
+        ? rulesRaw
+        : Object.entries(rulesRaw).map(([rule, info]) => ({
+            rule,
+            ...info,
+        }));
+    rules.forEach((rule) => {
+        if (!Array.isArray(rule.pagesAffected) &&
+            rule.pagesAffected &&
+            typeof rule.pagesAffected === 'object') {
+            rule.pagesAffected = Object.entries(rule.pagesAffected).map(([url, pageInfo]) => {
+                return pageInfo?.url ? pageInfo : { url, ...pageInfo };
+            });
+        }
+        if (!Array.isArray(rule.pagesAffected)) {
+            rule.pagesAffected = [];
+        }
+        if (typeof rule.totalItems !== 'number') {
+            rule.totalItems = rule.pagesAffected.reduce((accumulate, page) => accumulate + (Array.isArray(page.items) ? page.items.length : 0), 0);
+        }
+    });
+    const totals = {
+        totalItems: typeof categoryObj?.totalItems === 'number'
+            ? categoryObj.totalItems
+            : rules.reduce((acc, rr) => acc + (rr.totalItems || 0), 0),
+        totalRuleIssues: typeof categoryObj?.totalRuleIssues === 'number' ? categoryObj.totalRuleIssues : rules.length,
+    };
+    return {
+        description: categoryObj?.description || itemTypeDescription[categoryName],
+        ...totals,
+        rules,
+    };
+};
+export const generateHtmlReport = async (resultDir) => {
+    try {
+        const storagePath = path.resolve(resultDir);
+        const scanDataJsonPath = path.join(storagePath, 'scanData.json');
+        const scanItemsJsonPath = path.join(storagePath, 'scanItems.json');
+        if (!fs.existsSync(scanDataJsonPath)) {
+            throw new Error(`Missing file: ${scanDataJsonPath}`);
+        }
+        if (!fs.existsSync(scanItemsJsonPath)) {
+            throw new Error(`Missing file: ${scanItemsJsonPath}`);
+        }
+        const scanDataB64Path = path.join(storagePath, 'scanData.json.gz.b64');
+        const scanItemsB64Path = path.join(storagePath, 'scanItems.json.gz.b64');
+        if (!fs.existsSync(scanDataB64Path)) {
+            consoleLogger.info('scanData.json.gz.b64 not found — generating from scanData.json');
+            await compressJsonFileStreaming(scanDataJsonPath, scanDataB64Path);
+        }
+        if (!fs.existsSync(scanItemsB64Path)) {
+            consoleLogger.info('scanItems.json.gz.b64 not found — generating from scanItems.json');
+            await compressJsonFileStreaming(scanItemsJsonPath, scanItemsB64Path);
+        }
+        const scanData = JSON.parse(await fs.readFile(scanDataJsonPath, 'utf8'));
+        const scanItemsAll = JSON.parse(await fs.readFile(scanItemsJsonPath, 'utf8'));
+        const { oobeeAppVersion: itemsAppVersion, mustFix = {}, goodToFix = {}, needsReview = {}, passed = {}, } = scanItemsAll;
+        const items = {
+            mustFix: ensureCategory(mustFix, 'mustFix'),
+            goodToFix: ensureCategory(goodToFix, 'goodToFix'),
+            needsReview: ensureCategory(needsReview, 'needsReview'),
+            passed: ensureCategory(passed, 'passed'),
+        };
+        const pagesScanned = Array.isArray(scanData.pagesScanned) ? scanData.pagesScanned : [];
+        const pagesNotScanned = Array.isArray(scanData.pagesNotScanned) ? scanData.pagesNotScanned : [];
+        const allIssues = {
+            storagePath,
+            oobeeAi: { htmlETL: oobeeAiHtmlETL, rules: oobeeAiRules },
+            siteName: (scanData.siteName || (pagesScanned[0]?.pageTitle ?? ''))
+                .toString()
+                .replace(/^\d+\s*:\s*/, '')
+                .trim(),
+            startTime: scanData.startTime ? new Date(scanData.startTime) : new Date(),
+            endTime: scanData.endTime ? new Date(scanData.endTime) : new Date(),
+            urlScanned: scanData.urlScanned || scanData.url || '',
+            scanType: scanData.scanType || ScannerTypes.WEBSITE,
+            deviceChosen: scanData.deviceChosen || 'Desktop',
+            formatAboutStartTime,
+            isCustomFlow: (scanData.scanType || '') === ScannerTypes.CUSTOM,
+            viewport: scanData.deviceChosen || 'Desktop',
+            pagesScanned,
+            pagesNotScanned,
+            totalPagesScanned: typeof scanData.totalPagesScanned === 'number'
+                ? scanData.totalPagesScanned
+                : pagesScanned.length,
+            totalPagesNotScanned: typeof scanData.totalPagesNotScanned === 'number'
+                ? scanData.totalPagesNotScanned
+                : pagesNotScanned.length,
+            totalItems: 0,
+            topFiveMostIssues: Array.isArray(scanData.topFiveMostIssues)
+                ? scanData.topFiveMostIssues
+                : [],
+            topTenPagesWithMostIssues: Array.isArray(scanData.topTenPagesWithMostIssues)
+                ? scanData.topTenPagesWithMostIssues
+                : [],
+            topTenIssues: Array.isArray(scanData.topTenIssues) ? scanData.topTenIssues : [],
+            wcagViolations: Array.isArray(scanData.wcagViolations) ? scanData.wcagViolations : [],
+            customFlowLabel: scanData.customFlowLabel || '',
+            oobeeAppVersion: itemsAppVersion || scanData.oobeeAppVersion || 'dev',
+            items,
+            cypressScanAboutMetadata: scanData.cypressScanAboutMetadata || {},
+            wcagLinks: scanData.wcagLinks || constants.wcagLinks,
+            wcagClauses: WCAGclauses,
+            a11yRuleShortDescriptionMap,
+            disabilityBadgesMap,
+            a11yRuleLongDescriptionMap,
+            advancedScanOptionsSummaryItems: {
+                showIncludeScreenshots: !!scanData.advancedScanOptionsSummaryItems?.showIncludeScreenshots,
+                showAllowSubdomains: !!scanData.advancedScanOptionsSummaryItems?.showAllowSubdomains,
+                showEnableCustomChecks: !!scanData.advancedScanOptionsSummaryItems?.showEnableCustomChecks,
+                showEnableWcagAaa: !!scanData.advancedScanOptionsSummaryItems?.showEnableWcagAaa,
+                showSlowScanMode: !!scanData.advancedScanOptionsSummaryItems?.showSlowScanMode,
+                showAdhereRobots: !!scanData.advancedScanOptionsSummaryItems?.showAdhereRobots,
+            },
+            scanPagesDetail: scanData.scanPagesDetail || {
+                pagesAffected: [],
+                pagesNotAffected: [],
+                scannedPagesCount: 0,
+                pagesNotScanned: [],
+                pagesNotScannedCount: 0,
+            },
+        };
+        flattenAndSortResults(allIssues, allIssues.isCustomFlow);
+        populateScanPagesDetail(allIssues);
+        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');
+    }
+    catch (err) {
+        consoleLogger.error(`generateHtmlReport failed: ${err?.message || err}`);
+        throw err;
+    }
+};
+export default generateHtmlReport;

package/dist/index.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+import printMessage from 'print-message';
+import inquirer from 'inquirer';
+import { getVersion, getUserDataTxt, writeToUserDataTxt, listenForCleanUp, cleanUpAndExit, } from './utils.js';
+import { prepareData, messageOptions, getPlaywrightDeviceDetailsObject, getScreenToScan, getClonedProfilesWithRandomToken, } from './constants/common.js';
+import questions from './constants/questions.js';
+import combineRun from './combine.js';
+import { FileTypes } from './constants/constants.js';
+const userData = getUserDataTxt();
+const runScan = async (answers) => {
+    const screenToScan = getScreenToScan(answers.deviceChosen, answers.customDevice, answers.viewportWidth);
+    answers.playwrightDeviceDetailsObject = getPlaywrightDeviceDetailsObject(answers.deviceChosen, answers.customDevice, answers.viewportWidth);
+    if (!answers.nameEmail) {
+        answers.nameEmail = `${userData.name}:${userData.email}`;
+    }
+    answers.fileTypes = FileTypes.All;
+    answers.metadata = '{}';
+    const data = await prepareData(answers);
+    // Executes cleanUp script if error encountered
+    listenForCleanUp(data.randomToken);
+    data.userDataDirectory = getClonedProfilesWithRandomToken(data.browser, data.randomToken);
+    printMessage(['Scanning website...'], messageOptions);
+    await combineRun(data, screenToScan);
+    // Delete dataset and request queues
+    cleanUpAndExit(0, data.randomToken);
+};
+if (userData) {
+    printMessage([
+        `Oobee (ver ${getVersion()})`,
+        'We recommend using Chrome browser for the best experience.',
+        '',
+        `Welcome back ${userData.name}!`,
+        `(Refer to readme.txt on how to change your profile)`,
+    ], {
+        // Note that the color is based on kleur NPM package
+        border: true,
+        borderColor: 'magenta',
+    });
+    inquirer.prompt(questions).then(async (answers) => {
+        await runScan(answers);
+    });
+}
+else {
+    printMessage([`Oobee (ver ${getVersion()})`, 'We recommend using Chrome browser for the best experience.'], {
+        // Note that the color is based on kleur NPM package
+        border: true,
+        borderColor: 'magenta',
+    });
+    printMessage([
+        `To personalise your experience, we will be collecting your name, email address and app usage data.`,
+        `Your information fully complies with GovTech's Privacy Policy.`,
+    ], {
+        border: false,
+    });
+    inquirer.prompt(questions).then(async (answers) => {
+        const { name, email } = answers;
+        answers.nameEmail = `${name}:${email}`;
+        await writeToUserDataTxt('name', name);
+        await writeToUserDataTxt('email', email);
+        await runScan(answers);
+    });
+}

package/dist/logs.js

@@ -0,0 +1,84 @@
+/* eslint-disable no-console */
+/* eslint-disable no-shadow */
+import { createLogger, format, transports } from 'winston';
+import { guiInfoStatusTypes } from './constants/constants.js';
+import path from 'path';
+import { randomUUID } from 'crypto';
+const { combine, timestamp, printf } = format;
+// Sample output
+// {"timestamp":"2020-11-25 17:29:07","level":"error","message":"hello world"}
+const logFormat = printf(({ timestamp, level, message }) => {
+    const log = {
+        timestamp: `${timestamp}`,
+        level: `${level}`,
+        message: `${message}`,
+    };
+    return JSON.stringify(log);
+});
+// transport: storage device for logs
+// Enabled for console and storing into files; Files are overwritten each time
+// All logs in combined.txt, error in errors.txt
+const uuid = randomUUID();
+let basePath;
+if (process.env.OOBEE_LOGS_PATH) {
+    basePath = process.env.OOBEE_LOGS_PATH;
+}
+else if (process.platform === 'win32') {
+    basePath = path.join(process.env.APPDATA, 'Oobee');
+}
+else if (process.platform === 'darwin') {
+    basePath = path.join(process.env.HOME, 'Library', 'Application Support', 'Oobee');
+}
+else {
+    basePath = path.join(process.cwd());
+}
+export const errorsTxtPath = path.join(basePath, `${uuid}.txt`);
+const consoleLogger = createLogger({
+    silent: !(process.env.RUNNING_FROM_PH_GUI || process.env.OOBEE_VERBOSE),
+    format: combine(timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), logFormat),
+    transports: [
+        new transports.Console({ level: 'info' }),
+        new transports.File({
+            filename: errorsTxtPath,
+            level: 'info',
+            handleExceptions: true,
+        }),
+    ],
+});
+// No display in consoles, this will mostly be used within the interactive script to avoid disrupting the flow
+// Also used in common functions to not link internal information
+// if running from mass scanner, log out errors in console
+const silentLogger = createLogger({
+    format: combine(timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), logFormat),
+    transports: [
+        new transports.File({
+            filename: errorsTxtPath,
+            level: 'warn',
+            handleExceptions: true
+        }),
+    ].filter(Boolean),
+});
+// guiInfoLogger feeds the gui information via console log and is mainly used for scanning process
+export const guiInfoLog = (status, data) => {
+    if (process.env.RUNNING_FROM_PH_GUI || process.env.OOBEE_VERBOSE) {
+        switch (status) {
+            case guiInfoStatusTypes.COMPLETED:
+                console.log('Scan completed');
+                silentLogger.info('Scan completed');
+                break;
+            case guiInfoStatusTypes.SCANNED:
+            case guiInfoStatusTypes.SKIPPED:
+            case guiInfoStatusTypes.ERROR:
+            case guiInfoStatusTypes.DUPLICATE:
+                const msg = `crawling::${data.numScanned || 0}::${status}::${data.urlScanned || 'no url provided'}`;
+                console.log(msg);
+                silentLogger.info(msg);
+                break;
+            default:
+                console.log(`Status provided to gui info log not recognized: ${status}`);
+                break;
+        }
+    }
+};
+consoleLogger.info(`Logger writing to: ${errorsTxtPath}`);
+export { logFormat, consoleLogger, silentLogger };