add hints array

percy · Oct 30, 2023 · 6cbaee5 · 6cbaee5
1 parent bd5f71c
commit 6cbaee5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/packages/core/src/config.js b/packages/core/src/config.js
@@ -397,6 +397,10 @@ export const snapshotSchema = {
                     mimetype: { type: 'string' }
                   }
                 }
+              },
+              hints: {
+                type: 'array',
+                items: { type: 'string' }
               }
             }
           }]

diff --git a/packages/core/src/discovery.js b/packages/core/src/discovery.js
@@ -110,9 +110,9 @@ function processSnapshotResources({ domSnapshot, resources, ...snapshot }) {
   // inject Percy CSS
   if (snapshot.percyCSS) {
     // check @percy/dom/serialize-dom.js
-    let elementsOutsideBodySerializationWarningRegex = /<\/body>/;
-    if (domSnapshot?.warnings.some(e => elementsOutsideBodySerializationWarningRegex.test(e))) {
-      log.warn('percyCSS might not work, please follow LINK');
+    let domSnapshotHints = domSnapshot?.hints ?? [];
+    if (domSnapshotHints.includes('DOM elements found outside </body>')) {
+      log.warn('DOM elements found outside </body>, percyCSS might not work');
     }
 
     let css = createPercyCSSResource(root.url, snapshot.percyCSS);

diff --git a/packages/dom/src/serialize-dom.js b/packages/dom/src/serialize-dom.js
@@ -72,6 +72,7 @@ export function serializeDOM(options) {
   let ctx = {
     resources: new Set(),
     warnings: new Set(),
+    hints: new Set(),
     cache: new Map(),
     enableJavaScript,
     disableShadowDOM
@@ -102,13 +103,14 @@ export function serializeDOM(options) {
       clonedBody.append(sibling);
     }
   } else if (ctx.clone.body.nextSibling) {
-    ctx.warnings.add('DOM elements found outside </body>');
+    ctx.hints.add('DOM elements found outside </body>');
   }
 
   let result = {
     html: serializeHTML(ctx),
     warnings: Array.from(ctx.warnings),
-    resources: Array.from(ctx.resources)
+    resources: Array.from(ctx.resources),
+    hints: Array.from(ctx.hints)
   };
 
   return stringifyResponse