✨ Add support for ignoreStyleSheetSerializationErrors in percySnapshot (#676)

pankaj443 · web-flow · commit 8b96272b4e83 · 2025-10-15T13:04:52.000+05:30
diff --git a/index.js b/index.js
@@ -109,14 +109,21 @@ function ignoreCanvasSerializationErrors(options) {
          false;
 }
 
+function ignoreStyleSheetSerializationErrors(options) {
+  return options?.ignoreStyleSheetSerializationErrors ??
+         utils.percy?.config?.snapshot?.ignoreStyleSheetSerializationErrors ??
+         false;
+}
+
 async function captureSerializedDOM(driver, options) {
   /* istanbul ignore next: no instrumenting injected code */
   let { domSnapshot } = await driver.executeScript(options => ({
     /* eslint-disable-next-line no-undef */
     domSnapshot: PercyDOM.serialize(options)
   }), {
     ...options,
-    ignoreCanvasSerializationErrors: ignoreCanvasSerializationErrors(options)
+    ignoreCanvasSerializationErrors: ignoreCanvasSerializationErrors(options),
+    ignoreStyleSheetSerializationErrors: ignoreStyleSheetSerializationErrors(options)
   });
 
   /* istanbul ignore next: no instrumenting injected code */
diff --git a/test/index.test.mjs b/test/index.test.mjs
@@ -387,6 +387,99 @@ describe('percySnapshot', () => {
       );
     });
   });
+
+  describe('ignoreStyleSheetSerializationErrors via percySnapshot', () => {
+
+    it('should default to false when no options are provided', async () => {
+      spyOn(driver, 'executeScript').and.returnValue(Promise.resolve({
+        domSnapshot: { html: '<html></html>', resources: [] }
+      }));
+
+      await percySnapshot(driver, 'Default canvas test');
+
+      expect(driver.executeScript).toHaveBeenCalledWith(
+        jasmine.any(Function),
+        jasmine.objectContaining({
+          ignoreStyleSheetSerializationErrors: false
+        })
+      );
+    });
+
+    it('should use value from options when provided as true', async () => {
+      spyOn(driver, 'executeScript').and.returnValue(Promise.resolve({
+        domSnapshot: { html: '<html></html>', resources: [] }
+      }));
+
+      await percySnapshot(driver, 'Options true test', { 
+        ignoreStyleSheetSerializationErrors: true 
+      });
+
+      expect(driver.executeScript).toHaveBeenCalledWith(
+        jasmine.any(Function),
+        jasmine.objectContaining({
+          ignoreStyleSheetSerializationErrors: true
+        })
+      );
+    });
+
+    it('should use value from options when provided as false', async () => {
+      spyOn(driver, 'executeScript').and.returnValue(Promise.resolve({
+        domSnapshot: { html: '<html></html>', resources: [] }
+      }));
+
+      await percySnapshot(driver, 'Options false test', { 
+        ignoreStyleSheetSerializationErrors: false 
+      });
+
+      expect(driver.executeScript).toHaveBeenCalledWith(
+        jasmine.any(Function),
+        jasmine.objectContaining({
+          ignoreStyleSheetSerializationErrors: false
+        })
+      );
+    });
+
+    it('should prefer options value over config value', async () => {
+      utils.percy.config = { snapshot: { ignoreStyleSheetSerializationErrors: true } };
+
+      spyOn(driver, 'executeScript').and.returnValue(Promise.resolve({
+        domSnapshot: { html: '<html></html>', resources: [] }
+      }));
+
+      await percySnapshot(driver, 'Options override test', { 
+        ignoreStyleSheetSerializationErrors: false 
+      });
+
+      expect(driver.executeScript).toHaveBeenCalledWith(
+        jasmine.any(Function),
+        jasmine.objectContaining({
+          ignoreStyleSheetSerializationErrors: false
+        })
+      );
+    });
+
+    it('should return false when both options and config are undefined', async () => {
+      utils.percy.config = {
+        ...utils.percy.config,
+        snapshot: {
+          ...utils.percy.config?.snapshot,
+        }
+      };
+
+      spyOn(driver, 'executeScript').and.returnValue(Promise.resolve({
+        domSnapshot: { html: '<html></html>', resources: [] }
+      }));
+
+      await percySnapshot(driver, 'Both undefined test', {});
+
+      expect(driver.executeScript).toHaveBeenCalledWith(
+        jasmine.any(Function),
+        jasmine.objectContaining({
+          ignoreStyleSheetSerializationErrors: false
+        })
+      );
+    });
+  });
 });
 
 describe('#slowScrollToBottom', () => {
