@govtechsg/oobee 0.10.51 → 0.10.58

package/src/mergeAxeResults.ts

@@ -78,6 +78,7 @@ type AllIssues = {
     htmlETL: any;
     rules: string[];
   };
+  siteName: string;
   startTime: Date;
   endTime: Date;
   urlScanned: string;
@@ -130,7 +131,6 @@ const extractFileNames = async (directory: string): Promise<string[]> => {
     .then(allFiles => allFiles.filter(file => path.extname(file).toLowerCase() === '.json'))
     .catch(readdirError => {
       consoleLogger.info('An error has occurred when retrieving files, please try again.');
-      silentLogger.error(`(extractFileNames) - ${readdirError}`);
       throw readdirError;
     });
 };
@@ -140,7 +140,6 @@ const parseContentToJson = async rPath =>
     .then(content => JSON.parse(content))
     .catch(parseError => {
       consoleLogger.info('An error has occurred when parsing the content, please try again.');
-      silentLogger.error(`(parseContentToJson) - ${parseError}`);
     });
 
 const writeCsv = async (allIssues, storagePath) => {
@@ -684,7 +683,7 @@ async function compressJsonFileStreaming(inputPath: string, outputPath: string)
   // Pipe the streams:
   //   read -> gzip -> base64 -> write
   await pipeline(readStream, gzip, base64Encode, writeStream);
-  console.log(`File successfully compressed and saved to ${outputPath}`);
+  consoleLogger.info(`File successfully compressed and saved to ${outputPath}`);
 }
 
 const writeJsonFileAndCompressedJsonFile = async (
@@ -1559,7 +1558,7 @@ const sendWcagBreakdownToSentry = async (
     const wcagCriteriaBreakdown: Record<string, any> = {};
 
     // Tag app version
-    tags['version'] = appVersion;
+    tags.version = appVersion;
 
     // Get dynamic WCAG criteria map once
     const wcagCriteriaMap = await getWcagCriteriaMap();
@@ -1638,7 +1637,7 @@ const sendWcagBreakdownToSentry = async (
       tags['WCAG-MustFix-Occurrences'] = String(allIssues.items.mustFix.totalItems);
       tags['WCAG-GoodToFix-Occurrences'] = String(allIssues.items.goodToFix.totalItems);
       tags['WCAG-NeedsReview-Occurrences'] = String(allIssues.items.needsReview.totalItems);
-      
+
       // Add number of pages scanned tag
       tags['Pages-Scanned-Count'] = String(allIssues.totalPagesScanned);
     } else if (pagesScannedCount > 0) {
@@ -1667,7 +1666,7 @@ const sendWcagBreakdownToSentry = async (
         ...(userData && userData.userId ? { id: userData.userId } : {}),
       },
       extra: {
-        additionalScanMetadata: ruleIdJson != null ? JSON.stringify(ruleIdJson)  : "{}",
+        additionalScanMetadata: ruleIdJson != null ? JSON.stringify(ruleIdJson) : '{}',
         wcagBreakdown: wcagCriteriaBreakdown,
         reportCounts: allIssues
           ? {
@@ -1766,6 +1765,7 @@ const generateArtifacts = async (
       htmlETL: oobeeAiHtmlETL,
       rules: oobeeAiRules,
     },
+    siteName: (pagesScanned[0]?.pageTitle ?? '').replace(/^\d+\s*:\s*/, '').trim(),
     startTime: scanDetails.startTime ? scanDetails.startTime : new Date(),
     endTime: scanDetails.endTime ? scanDetails.endTime : new Date(),
     urlScanned,
@@ -1845,7 +1845,6 @@ const generateArtifacts = async (
     }),
   ).catch(flattenIssuesError => {
     consoleLogger.info('An error has occurred when flattening the issues, please try again.');
-    silentLogger.error(flattenIssuesError.stack);
   });
 
   flattenAndSortResults(allIssues, isCustomFlow);
@@ -1853,6 +1852,10 @@ const generateArtifacts = async (
   printMessage([
     'Scan Summary',
     '',
+    `Site Name: ${allIssues.siteName}`,
+    `URL: ${allIssues.urlScanned}`,
+    `Pages Scanned: ${allIssues.totalPagesScanned}`,
+    '',
     `Must Fix: ${allIssues.items.mustFix.rules.length} ${Object.keys(allIssues.items.mustFix.rules).length === 1 ? 'issue' : 'issues'} / ${allIssues.items.mustFix.totalItems} ${allIssues.items.mustFix.totalItems === 1 ? 'occurrence' : 'occurrences'}`,
     `Good to Fix: ${allIssues.items.goodToFix.rules.length} ${Object.keys(allIssues.items.goodToFix.rules).length === 1 ? 'issue' : 'issues'} / ${allIssues.items.goodToFix.totalItems} ${allIssues.items.goodToFix.totalItems === 1 ? 'occurrence' : 'occurrences'}`,
     `Manual Review Required: ${allIssues.items.needsReview.rules.length} ${Object.keys(allIssues.items.needsReview.rules).length === 1 ? 'issue' : 'issues'} / ${allIssues.items.needsReview.totalItems} ${allIssues.items.needsReview.totalItems === 1 ? 'occurrence' : 'occurrences'}`,
@@ -1882,8 +1885,13 @@ const generateArtifacts = async (
     allIssues.advancedScanOptionsSummaryItems.disableOobee,
   );
 
-  // console.log(allIssues.progressPercentage);
-  // console.log(allIssues.issuesPercentage);
+  consoleLogger.info(`Site Name: ${allIssues.siteName}`);
+  consoleLogger.info(`URL: ${allIssues.urlScanned}`);
+  consoleLogger.info(`Pages Scanned: ${allIssues.totalPagesScanned}`);
+  consoleLogger.info(`Start Time: ${allIssues.startTime}`);
+  consoleLogger.info(`End Time: ${allIssues.endTime}`);
+  const elapsedSeconds = (new Date(allIssues.endTime).getTime() - new Date(allIssues.startTime).getTime()) / 1000;
+  consoleLogger.info(`Elapsed Time: ${elapsedSeconds}s`);
 
   const getAxeImpactCount = (allIssues: AllIssues) => {
     const impactCount = {
@@ -2044,6 +2052,9 @@ const generateArtifacts = async (
     console.error('Error sending WCAG data to Sentry:', error);
   }
 
+  if (process.env.RUNNING_FROM_PH_GUI || process.env.OOBEE_VERBOSE)
+    console.log('Report generated successfully');
+
   return ruleIdJson;
 };
 

package/src/npmIndex.ts

@@ -219,7 +219,7 @@ export const init = async ({
         try {
           await page.locator(elem).click();
         } catch (e) {
-          silentLogger.info(e);
+          // do nothing if element is not found or not clickable
         }
       });
 

package/src/screenshotFunc/htmlScreenshotFunc.ts

@@ -2,7 +2,7 @@
 import { createHash } from 'crypto';
 import fs from 'fs';
 import path from 'path';
-import { consoleLogger } from '../logs.js';
+// import { silentLogger } from '../logs.js';
 import { Result } from 'axe-core';
 import { Page } from 'playwright';
 import { NodeResultWithScreenshot, ResultWithScreenshot } from '../crawlers/commonCrawlerFunc.js';
@@ -21,9 +21,11 @@ export const takeScreenshotForHTMLElements = async (
 
   for (const violation of violations) {
     if (screenshotCount >= maxScreenshots) {
-      consoleLogger.warn(
+      /*
+      silentLogger.warn(
         `Skipping screenshots for ${violation.id} as maxScreenshots (${maxScreenshots}) exceeded. You can increase it by specifying a higher value when calling takeScreenshotForHTMLElements.`,
       );
+      */
       newViolations.push(violation);
       continue;
     }
@@ -32,7 +34,7 @@ export const takeScreenshotForHTMLElements = async (
 
     // Check if rule ID is 'oobee-grading-text-contents' and skip screenshot logic
     if (rule === 'oobee-grading-text-contents') {
-      // consoleLogger.info('Skipping screenshot for rule oobee-grading-text-contents');
+      // silentLogger.info('Skipping screenshot for rule oobee-grading-text-contents');
       newViolations.push(violation); // Make sure it gets added
       continue;
     }
@@ -57,13 +59,13 @@ export const takeScreenshotForHTMLElements = async (
               nodeWithScreenshotPath.screenshotPath = screenshotPath;
               screenshotCount++;
             } else {
-              consoleLogger.info(`Element at ${currLocator} is not visible`);
+              // silentLogger.info(`Element at ${currLocator} is not visible`);
             }
 
             break; // Stop looping after finding the first visible locator
           }
         } catch (e) {
-          consoleLogger.info(`Unable to take element screenshot at ${selector}`);
+          // silentLogger.info(`Unable to take element screenshot at ${selector}`);
         }
       }
       newViolationNodes.push(nodeWithScreenshotPath);

package/src/screenshotFunc/pdfScreenshotFunc.ts

@@ -12,7 +12,7 @@ import { Canvas, createCanvas, SKRSContext2D } from '@napi-rs/canvas';
 import assert from 'assert';
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { silentLogger } from '../logs.js';
+import { consoleLogger, silentLogger } from '../logs.js';
 import { TransformedRuleObject } from '../crawlers/pdfScanFunc.js';
 import { IBboxLocation, StructureTree, ViewportSize } from '../types/types.js';
 
@@ -213,7 +213,7 @@ const annotateAndSave = (origCanvas: Canvas, screenshotPath: string, viewport: V
     try {
       fs.writeFileSync(indexedScreenshotPath, croppedImage);
     } catch (e) {
-      silentLogger.error('Error in writing screenshot:', e);
+      consoleLogger.error('Error in writing screenshot:', e);
     }
 
     canvasFactory.destroy({ canvas: croppedCanvas, context: croppedCtx });

package/src/static/ejs/partials/components/wcagCompliance.ejs

@@ -29,7 +29,7 @@
               <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
                 data-bs-target="#wcagLinksAccordionContent" aria-expanded="false"
                 aria-controls="wcagLinksAccordionContent">
-                20 (A & AA) and 5 (AAA) WCAG Success Criteria
+                20 (A & AA) and 6 (AAA) WCAG Success Criteria
               </button>
             </div>
             <div id="wcagLinksAccordionContent" class="accordion-collapse collapse"

package/src/static/ejs/partials/scripts/ruleOffcanvas.ejs

@@ -22,6 +22,7 @@ category summary is clicked %>
         // wcag1410: 'https://www.w3.org/TR/WCAG22/#reflow',
         wcag1412: 'https://www.w3.org/TR/WCAG22/#text-spacing',
         wcag211: 'https://www.w3.org/TR/WCAG22/#keyboard',
+        wcag213: 'https://www.w3.org/WAI/WCAG22/Understanding/keyboard-no-exception.html', // AAA
         wcag221: 'https://www.w3.org/TR/WCAG22/#timing-adjustable',
         wcag222: 'https://www.w3.org/TR/WCAG22/#pause-stop-hide',
         wcag224: 'https://www.w3.org/TR/WCAG22/#interruptions', // AAA

package/src/static/ejs/partials/styles/styles.ejs

@@ -668,6 +668,17 @@
   #pagesScannedModal .not-scanned-url {
     word-wrap: break-word;
   }
+  #pagesScannedModal .metadata-text {
+    word-wrap: break-word;
+    font-size: 0.875rem;
+    color: var(--coral-red-100);
+  }
+  #pagesScannedModal .metadata-inline {
+    display: flex;
+    align-items: center;
+    gap: 0.5rem;
+    height: 16px;
+  }
   #pagesScannedModal p {
     overflow: hidden;
     white-space: nowrap;

package/src/static/ejs/report.ejs

@@ -298,7 +298,20 @@
 
           pagesNotScanned.forEach((page, index) => {
             var listItem = document.createElement('li');
-            listItem.innerHTML = `<a class="not-scanned-url" href="${page.url || page }" target="_blank">${page.url || page }</a>`;
+            const url = page.url || page;
+            const metadata = page.metadata || page;
+
+            const linkHTML = `<a class="not-scanned-url" href="${url}" target="_blank">${url}</a>`;
+            const metadataHTML = `
+              <div class="metadata-inline">
+                <svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 24 24" fill="none">
+                  <path d="M12 19.875C9.91142 19.875 7.90838 19.0453 6.43153 17.5685C4.95468 16.0916 4.125 14.0886 4.125 12C4.125 9.91142 4.95468 7.90838 6.43153 6.43153C7.90838 4.95468 9.91142 4.125 12 4.125C14.0886 4.125 16.0916 4.95468 17.5685 6.43153C19.0453 7.90838 19.875 9.91142 19.875 12C19.875 14.0886 19.0453 16.0916 17.5685 17.5685C16.0916 19.0453 14.0886 19.875 12 19.875ZM12 21C14.3869 21 16.6761 20.0518 18.364 18.364C20.0518 16.6761 21 14.3869 21 12C21 9.61305 20.0518 7.32387 18.364 5.63604C16.6761 3.94821 14.3869 3 12 3C9.61305 3 7.32387 3.94821 5.63604 5.63604C3.94821 7.32387 3 9.61305 3 12C3 14.3869 3.94821 16.6761 5.63604 18.364C7.32387 20.0518 9.61305 21 12 21Z" fill="#f26949"/>
+                  <path d="M10.8772 15.3751C10.8772 15.2274 10.9063 15.0811 10.9628 14.9446C11.0194 14.8081 11.1022 14.6841 11.2067 14.5796C11.3112 14.4752 11.4352 14.3923 11.5717 14.3357C11.7082 14.2792 11.8545 14.2501 12.0022 14.2501C12.1499 14.2501 12.2962 14.2792 12.4327 14.3357C12.5692 14.3923 12.6932 14.4752 12.7977 14.5796C12.9022 14.6841 12.985 14.8081 13.0416 14.9446C13.0981 15.0811 13.1272 15.2274 13.1272 15.3751C13.1272 15.6735 13.0087 15.9596 12.7977 16.1706C12.5867 16.3816 12.3006 16.5001 12.0022 16.5001C11.7038 16.5001 11.4177 16.3816 11.2067 16.1706C10.9957 15.9596 10.8772 15.6735 10.8772 15.3751ZM10.9874 8.61949C10.9725 8.47756 10.9875 8.33407 11.0315 8.19832C11.0756 8.06257 11.1477 7.9376 11.2432 7.83152C11.3387 7.72544 11.4554 7.64062 11.5857 7.58256C11.7161 7.52449 11.8572 7.49449 11.9999 7.49449C12.1427 7.49449 12.2838 7.52449 12.4142 7.58256C12.5445 7.64062 12.6612 7.72544 12.7567 7.83152C12.8522 7.9376 12.9243 8.06257 12.9683 8.19832C13.0124 8.33407 13.0274 8.47756 13.0124 8.61949L12.6187 12.5649C12.6055 12.7199 12.5346 12.8642 12.42 12.9695C12.3054 13.0747 12.1555 13.133 11.9999 13.133C11.8444 13.133 11.6945 13.0747 11.5799 12.9695C11.4653 12.8642 11.3944 12.7199 11.3812 12.5649L10.9874 8.61949Z" fill="#f26949"/>
+                </svg>
+                <span class="metadata-text">${metadata}</span>
+              </div>`;
+
+            listItem.innerHTML = `${linkHTML}${metadataHTML}`;
             pagesNotScannedList.appendChild(listItem);
           });
         }

package/src/utils.ts

@@ -209,8 +209,8 @@ export const getWcagPassPercentage = (
   totalWcagViolationsAAandAAA: number;
 } => {
   // These AAA rules should not be counted as WCAG Pass Percentage only contains A and AA
-  const wcagAAALinks = ['WCAG 1.4.6', 'WCAG 2.2.4', 'WCAG 2.4.9', 'WCAG 3.1.5', 'WCAG 3.2.5'];
-  const wcagAAA = ['wcag146', 'wcag224', 'wcag249', 'wcag315', 'wcag325'];
+  const wcagAAALinks = ['WCAG 1.4.6', 'WCAG 2.2.4', 'WCAG 2.4.9', 'WCAG 3.1.5', 'WCAG 3.2.5', 'WCAG 2.1.3'];
+  const wcagAAA = ['wcag146', 'wcag224', 'wcag249', 'wcag315', 'wcag325', 'wcag213'];
 
   const wcagLinksAAandAAA = constants.wcagLinks;
 
@@ -783,7 +783,7 @@ export const retryFunction = async <T>(func: () => Promise<T>, maxAttempt: numbe
       const result = await func();
       return result;
     } catch (error) {
-      silentLogger.error(`(Attempt count: ${attemptCount} of ${maxAttempt}) ${error}`);
+      // do nothing, just retry  
     }
   }
   throw new Error('Maximum number of attempts reached');