@govtechsg/oobee 0.10.33 → 0.10.34

package/Dockerfile

@@ -1,6 +1,6 @@
 # Use Microsoft Playwright image as base image
 # Node version is v22
-FROM mcr.microsoft.com/playwright:v1.50.0-noble
+FROM mcr.microsoft.com/playwright:v1.50.1-noble
 
 # Installation of packages for oobee and runner
 RUN apt-get update && apt-get install -y zip git

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@govtechsg/oobee",
   "main": "dist/npmIndex.js",
-  "version": "0.10.33",
+  "version": "0.10.34",
   "type": "module",
   "author": "Government Technology Agency <info@tech.gov.sg>",
   "dependencies": {

package/src/constants/constants.ts

@@ -178,14 +178,14 @@ export const axeScript = path.join(dirname, '../../node_modules/axe-core/axe.min
 export class UrlsCrawled {
   toScan: string[] = [];
   scanned: { url: string; actualUrl: string; pageTitle: string }[] = [];
-  invalid: string[] = [];
+  invalid: { url: string; actualUrl: string; pageTitle: string }[] = [];
   scannedRedirects: { fromUrl: string; toUrl: string }[] = [];
   notScannedRedirects: { fromUrl: string; toUrl: string }[] = [];
   outOfDomain: string[] = [];
-  blacklisted: string[] = [];
+  blacklisted: { url: string; actualUrl: string; pageTitle: string }[] = [];
   error: { url: string }[] = [];
   exceededRequests: string[] = [];
-  forbidden: string[] = [];
+  forbidden: { url: string; actualUrl: string; pageTitle: string }[] = [];
   userExcluded: { url: string; actualUrl: string; pageTitle: string }[] = [];
   everything: string[] = [];
 

package/src/crawlers/crawlDomain.ts

@@ -638,7 +638,12 @@ const crawlDomain = async ({
               numScanned: urlsCrawled.scanned.length,
               urlScanned: request.url,
             });
-            urlsCrawled.blacklisted.push(request.url);
+            urlsCrawled.blacklisted.push({
+              url: request.url,
+              pageTitle: request.url,
+              actualUrl: actualUrl, // i.e. actualUrl
+            });
+
             return;
           }
           const { pdfFileName, url } = handlePdfDownload(
@@ -662,7 +667,12 @@ const crawlDomain = async ({
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.blacklisted.push(request.url);
+          urlsCrawled.blacklisted.push({
+            url: request.url,
+            pageTitle: request.url,
+            actualUrl: actualUrl, // i.e. actualUrl
+          });
+
           return;
         }
 
@@ -671,7 +681,12 @@ const crawlDomain = async ({
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.blacklisted.push(request.url);
+          urlsCrawled.blacklisted.push({
+            url: request.url,
+            pageTitle: request.url,
+            actualUrl: actualUrl, // i.e. actualUrl
+          });
+
           return;
         }
 
@@ -691,7 +706,12 @@ const crawlDomain = async ({
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.forbidden.push(request.url);
+          urlsCrawled.forbidden.push({
+            url: request.url,
+            pageTitle: request.url,
+            actualUrl: actualUrl, // i.e. actualUrl
+          });
+
           return;
         }
 
@@ -700,7 +720,12 @@ const crawlDomain = async ({
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.invalid.push(request.url);
+          urlsCrawled.invalid.push({
+            url: request.url,
+            pageTitle: request.url,
+            actualUrl: actualUrl, // i.e. actualUrl
+          });
+
           return;
         }
 
@@ -779,7 +804,12 @@ const crawlDomain = async ({
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.blacklisted.push(request.url);
+          urlsCrawled.blacklisted.push({
+            url: request.url,
+            pageTitle: request.url,
+            actualUrl: actualUrl, // i.e. actualUrl
+          });
+
         }
 
         if (followRobots) await getUrlsFromRobotsTxt(request.url, browser);

package/src/crawlers/crawlSitemap.ts

@@ -250,7 +250,12 @@ const crawlSitemap = async (
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.blacklisted.push(request.url);
+          urlsCrawled.blacklisted.push({
+            url: request.url,
+            pageTitle: request.url,
+            actualUrl: actualUrl, // i.e. actualUrl
+          });
+
           return;
         }
         // pushes download promise into pdfDownloads
@@ -297,7 +302,12 @@ const crawlSitemap = async (
           numScanned: urlsCrawled.scanned.length,
           urlScanned: request.url,
         });
-        urlsCrawled.invalid.push(request.url);
+        urlsCrawled.invalid.push({
+          url: request.url,
+          pageTitle: request.url,
+          actualUrl: actualUrl, // i.e. actualUrl
+        });
+
         return;
       }
 

package/src/crawlers/custom/flagUnlabelledClickableElements.ts

@@ -874,7 +874,6 @@ export const flagUnlabelledClickableElements = async (page: Page) => {
     }
 
     function flagElements() {
-      console.time('Accessibility Check Time');
 
       const currentFlaggedElementsByDocument: Record<string, HTMLElement[]> = {}; // Temporary object to hold current flagged elements
 
@@ -1014,7 +1013,6 @@ export const flagUnlabelledClickableElements = async (page: Page) => {
       previousFlaggedXPathsByDocument = { ...flaggedXPathsByDocument };
 
       cleanupFlaggedElements();
-      console.timeEnd('Accessibility Check Time');
       return previousAllFlaggedElementsXPaths;
     }
 

package/src/crawlers/pdfScanFunc.ts

@@ -295,7 +295,11 @@ export const handlePdfDownload = (
             numScanned: urlsCrawled.scanned.length,
             urlScanned: request.url,
           });
-          urlsCrawled.invalid.push(url);
+          urlsCrawled.invalid.push({
+            url: request.url,
+            pageTitle: url,
+            actualUrl: url, // i.e. actualUrl
+          });
         }
         resolve();
       });

package/src/static/ejs/partials/summaryMain.ejs

@@ -13,14 +13,15 @@
             <div class="d-flex justify-content-between align-items-center">
               <span class="fw-bold"> WCAG (A & AA) Passes </span>
               <span aria-label="Pass percentage" class="ms-2">
-                <%= wcagPassPercentage %>% of automated checks
+                <%= wcagPassPercentage.passPercentageAA %>% of automated checks
               </span>
             </div>
             <div class="wcag-compliance-passes-bar mb-5 d-flex">
               <svg width="500" role="none" height="6" fill="none" xmlns="http://www.w3.org/2000/svg"
                 style="display: flex; width: 100%; position: absolute">
                 <rect width="100%" height="10" rx="3" fill="#E7ECEE" style="justify-content: left"></rect>
-                <rect width="<%= wcagPassPercentage %>%" height="6" rx="3" fill="#9021a6" style=""></rect>
+                <rect width="<%= wcagPassPercentage.passPercentageAA %>%" height="6" rx="3" fill="#9021a6" style="">
+                </rect>
               </svg>
             </div>
             <ul class="unbulleted-list">

package/src/static/ejs/report.ejs

@@ -47,9 +47,9 @@
       // Scan DATA FUNCTION TO REPLACE NA
       const scanDataWCAGCompliance = () => {
         const passPecentage = document.getElementById('passPercentage');
-        passPecentage.innerHTML = scanData.wcagPassPercentage + '% of automated checks';
+        passPecentage.innerHTML = scanData.wcagPassPercentage.passPercentageAA + '% of automated checks';
         const wcagBarProgess = document.getElementById('wcag-compliance-passes-bar-progress');
-        wcagBarProgess.style.width = `${scanData.wcagPassPercentage}%`; // Set this to your desired width
+        wcagBarProgess.style.width = `${scanData.wcagPassPercentage.passPercentageAA}%`; // Set this to your desired width
 
         const wcagLinksList = document.getElementById('wcagLinksList');
 

package/src/utils.ts

@@ -190,19 +190,23 @@ export const cleanUp = async pathToDelete => {
 //     timeZoneName: "longGeneric",
 //   });
 
-export const getWcagPassPercentage = (wcagViolations: string[]): string => {
+export const getWcagPassPercentage = (wcagViolations: string[]): { passPercentageAA: string; totalWcagChecksAA: number; totalWcagViolationsAA: number } => {
 
   // These AAA rules should not be counted as WCAG Pass Percentage only contains A and AA
   const wcagAAA = ['WCAG 1.4.6', 'WCAG 2.2.4', 'WCAG 2.4.9', 'WCAG 3.1.5', 'WCAG 3.2.5'];
 
   const filteredWcagLinks = Object.keys(constants.wcagLinks).filter(key => !wcagAAA.includes(key));
   const filteredWcagViolations = wcagViolations.filter(violation => !wcagAAA.includes(violation));
-  const totalChecks = filteredWcagLinks.length;
+  const totalChecksAA = filteredWcagLinks.length;
 
-  const passedChecks = totalChecks - filteredWcagViolations.length;
-  const passPercentage = (passedChecks / totalChecks) * 100;
+  const passedChecks = totalChecksAA - filteredWcagViolations.length;
+  const passPercentageAA = (passedChecks / totalChecksAA) * 100;
 
-  return passPercentage.toFixed(2); // toFixed returns a string, which is correct here
+  return {
+    passPercentageAA: passPercentageAA.toFixed(2), // toFixed returns a string, which is correct here
+    totalWcagChecksAA: totalChecksAA,
+    totalWcagViolationsAA: filteredWcagViolations.length,
+  };
 };
 
 export const getFormattedTime = inputDate => {