@govtechsg/oobee 0.10.86 → 0.10.88

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

@@ -28,8 +28,11 @@ async function decodeUnzipParse(input) {
       offset += arr.length;
     }
 
-    // Step 2: Decompress with pako (GZIP)
-    const decompressed = pako.ungzip(merged, { to: 'string' });
+    // Step 2: Decompress with pako (GZIP) to bytes first to avoid large-string
+    // construction inside pako for very large payloads.
+    const decompressedBytes = pako.ungzip(merged);
+
+    const decompressed = new TextDecoder().decode(decompressedBytes);
 
     // Step 3: Parse JSON
     return JSON.parse(decompressed);
@@ -37,4 +40,4 @@ async function decodeUnzipParse(input) {
     throw new Error(`Failed to decode/unzip/parse: ${err.message}`);
   }
 }
-</script>
+</script>

package/src/static/ejs/partials/scripts/ruleModal/itemCardRenderer.ejs

@@ -1,10 +1,44 @@
 <script>
   /**
-   * Resolves item references (composite "html\x00xpath" strings) to full item data using htmlGroups.
+   * Rebuilds the item list for a page from pre-computed htmlGroups when the light report omits page.items.
+   */
+  function buildItemsFromHtmlGroupsForPage(page, ruleInCategory) {
+    const htmlGroups = ruleInCategory.htmlGroups || {};
+    const resolvedItems = [];
+
+    Object.values(htmlGroups).forEach(groupData => {
+      if (!Array.isArray(groupData.pageUrls) || !groupData.pageUrls.includes(page.url)) {
+        return;
+      }
+
+      resolvedItems.push({
+        html: groupData.html,
+        xpath: groupData.xpath,
+        message: groupData.message,
+        screenshotPath: groupData.screenshotPath,
+        displayNeedsReview: groupData.displayNeedsReview,
+        pageUrl: page.url,
+        pageTitle: page.pageTitle || page.metadata
+      });
+    });
+
+    return resolvedItems;
+  }
+
+  /**
+   * The embedded report payload now omits page.items and rebuilds occurrences from
+   * htmlGroups + page metadata. Keep the older page.items resolution logic below
+   * commented for an easy rollback if we need to restore mixed payload support.
    */
   function resolveItemReferencesForPage(page, ruleInCategory) {
+    return buildItemsFromHtmlGroupsForPage(page, ruleInCategory);
+
+    /*
     const items = page.items || [];
-    if (items.length === 0) return [];
+
+    if (items.length === 0) {
+      return buildItemsFromHtmlGroupsForPage(page, ruleInCategory);
+    }
 
     const isReference = typeof items[0] === 'string';
 
@@ -27,6 +61,7 @@
           pageTitle: page.pageTitle || page.metadata
         };
       }
+
       // Fallback: parse composite key
       const nullByteIndex = compositeKey.indexOf('\x00');
       const html = nullByteIndex !== -1 ? compositeKey.slice(0, nullByteIndex) : compositeKey;
@@ -40,6 +75,7 @@
         pageTitle: page.pageTitle || page.metadata
       };
     });
+    */
   }
 
   function buildItemCardsWithPagination(accordionId, category, ruleInCategory, page, index) {
@@ -203,14 +239,17 @@
           ${item.xpath ? createXpathSection(item.xpath) : ''}
           ${createElementSection(item)}
           ${
-            item.displayNeedsReview
-              ? `<div class="d-flex justify-content-between g-one">
+            (() => {
+              const showDetails = item.displayNeedsReview || ['color-contrast', 'color-contrast-enhanced', 'oobee-grading-text-contents', 'target-size', 'valid-lang'].includes(aiConfig.ruleInCategory.rule);
+              return showDetails && item.message
+                ? `<div class="d-flex justify-content-between g-one">
             <div class="fw-semibold page-item-card-section-title">Details</div>
             <div class="page-item-card-section-content">
-              ${generateItemMessageElement(item.displayNeedsReview, item.message)}
+              ${generateItemMessageElement(item.displayNeedsReview || true, item.message)}
             </div>
           </div>`
-              : ''
+                : '';
+            })()
           }
           ${isPurpleAiRule ? createAiSuggestionSection(item, oobeeAiQueryLabel, aiConfig) : ''}
           ${showGenAiUI ? createGenAiSuggestFixSection(item, aiConfig) : ''}

package/src/static/ejs/partials/scripts/ruleModal/pageAccordionBuilder.ejs

@@ -86,7 +86,7 @@
             // Use pre-computed htmlGroups for count if available, otherwise use pages
             const count = isHtmlGrouping && selectedCategory.htmlGroups
               ? Object.keys(selectedCategory.htmlGroups).length
-              : selectedCategory.pagesAffected.length;
+              : (selectedCategory.pagesAffectedCount || selectedCategory.pagesAffected.length);
             if (isHtmlGrouping) {
               dropdownTitle.innerText = `HTML elements affected by this issue (${count})`;
             } else {
@@ -393,14 +393,17 @@
         </div>
 
           ${
-            item.displayNeedsReview
-              ? `<div class="d-flex justify-content-between g-one modal-view">
+            (() => {
+              const showDetails = item.displayNeedsReview || ['color-contrast', 'color-contrast-enhanced', 'oobee-grading-text-contents', 'target-size', 'valid-lang'].includes(aiConfig.ruleInCategory.rule);
+              return showDetails && item.message
+                ? `<div class="d-flex justify-content-between g-one modal-view">
             <div class="fw-semibold page-item-card-section-title">Details</div>
             <div class="page-item-card-section-content">
-              ${generateItemMessageElement(item.displayNeedsReview, item.message)}
+              ${generateItemMessageElement(item.displayNeedsReview || true, item.message)}
             </div>
           </div>`
-              : ''
+                : '';
+            })()
           }
           ${isPurpleAiRule ? createAiSuggestionSection(item, oobeeAiQueryLabel, aiConfig) : ''}
         </div>

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

@@ -270,8 +270,8 @@ include('./pageAccordionBuilder') %> <%- include('./constants') %>
           if (!Array.isArray(rule.pagesAffected)) return;
 
           rule.pagesAffected.sort((a, b) => {
-            const lenA = Array.isArray(a.items) ? a.items.length : 0;
-            const lenB = Array.isArray(b.items) ? b.items.length : 0;
+            const lenA = Array.isArray(a.items) ? a.items.length : a.itemsCount || 0;
+            const lenB = Array.isArray(b.items) ? b.items.length : b.itemsCount || 0;
             return lenB - lenA; // DESC
           });
         });
@@ -295,10 +295,10 @@ include('./pageAccordionBuilder') %> <%- include('./constants') %>
             dropdownToggle.innerText = `${ruleInCategory.totalItems} Total occ.`;
             dropdownToggle.setAttribute('aria-label', occurrencesText);
           document.getElementById('expandedRuleDropdownTitle').innerText =
-            `Pages affected by this issue (${ruleInCategory.pagesAffected.length})`;
+            `Pages affected by this issue (${(ruleInCategory.pagesAffectedCount || ruleInCategory.pagesAffected.length)})`;
           buildExpandedRuleCategoryContent(category, ruleInCategory);
           document.getElementById('expandedRulePageContent').innerText =
-            `Total ${ruleInCategory.pagesAffected.length} affected pages`;
+            `Total ${(ruleInCategory.pagesAffectedCount || ruleInCategory.pagesAffected.length)} affected pages`;
         }
       }
     });

package/src/static/ejs/partials/scripts/ruleModal/utilities.ejs

@@ -53,7 +53,8 @@
       if (htmlEscapedMessageArray.length === 1) {
         return `<p class="mb-0">${htmlEscapedMessageArray[0]}</p>`;
       } else {
-        return `<ul>${htmlEscapedMessageArray.map(m => `<li>${m}</li>`).join('')}</ul>`;
+        const [first, ...rest] = htmlEscapedMessageArray;
+        return `<p class="mb-0">${first}</p><ul>${rest.map(m => `<li>${m}</li>`).join('')}</ul>`;
       }
     } else {
       let i = 0;

package/src/static/ejs/summary.ejs

@@ -21,18 +21,24 @@
     %>
     <script>
       const scanItems = <%- JSON.stringify(
-        {
-          ...items,
-          ...['mustFix','goodToFix','needsReview','passed'].reduce((acc, cat) => {
-            if (items[cat]) {
-              acc[cat] = {
-                ...items[cat],
-                rules: (items[cat].rules || []).map(({ htmlGroups, ...rest }) => rest),
-              };
-            }
-            return acc;
-          }, {}),
-        }
+        ['mustFix','goodToFix','needsReview','passed'].reduce((acc, cat) => {
+          if (items[cat]) {
+            acc[cat] = {
+              description: items[cat].description,
+              totalItems: items[cat].totalItems,
+              totalRuleIssues: items[cat].totalRuleIssues,
+              rules: (items[cat].rules || []).map(rule => ({
+                rule: rule.rule,
+                description: rule.description,
+                helpUrl: rule.helpUrl,
+                conformance: rule.conformance,
+                totalItems: rule.totalItems,
+                pagesAffected: { length: (rule.pagesAffected || []).length },
+              })),
+            };
+          }
+          return acc;
+        }, {})
       ).replace(/<\//g, '<\\/') %>
     </script>
     <%- include('partials/scripts/summaryTable') %>

package/src/utils.ts

@@ -5,6 +5,7 @@ import fs from 'fs-extra';
 import axe, { Rule } from 'axe-core';
 import { v4 as uuidv4 } from 'uuid';
 import { getDomain } from 'tldts';
+import { normalizeUrl } from '@apify/utilities';
 import constants, {
   BrowserTypes,
   destinationPath,
@@ -1078,13 +1079,13 @@ export const randomThreeDigitNumberString = () => {
   return String(threeDigitNumber);
 };
 
+export const normUrl = (u: string): string => (u ? normalizeUrl(u) || u : '');
+
 export const isFollowStrategy = (link1: string, link2: string, rule: string): boolean => {
+  if (rule === 'all') return true;
   try {
     const parsedLink1 = new URL(link1);
     const parsedLink2 = new URL(link2);
-    if (rule === 'all') {
-      return true;
-    }
     if (rule === 'same-origin') {
       return parsedLink1.origin === parsedLink2.origin;
     }

package/testStaticJSScanner.html

@@ -186,7 +186,7 @@
       <li>
         <strong>Add the script</strong> — include the scanner before your closing
         <code>&lt;/body&gt;</code> tag:
-        <pre>&lt;script src="https://cdn.jsdelivr.net/gh/GovTechSG/oobee@v0.10.86/oobee-client-scanner.js"&gt;&lt;/script&gt;</pre>
+        <pre>&lt;script src="https://cdn.jsdelivr.net/gh/GovTechSG/oobee@0.10.86/oobee-client-scanner.js"&gt;&lt;/script&gt;</pre>
         
         <br>This points to the <code>v0.10.86</code> release. Update the version tag as needed for newer releases.
       </li>