✨ Adding support for ignoreCanvasSerializationErrors #1948
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for making canvas serialization fail-safe by introducing an ignoreCanvasSerializationErrors configuration option. When enabled, canvas serialization errors are caught and handled gracefully by rendering a fallback broken image instead of throwing errors.
- Adds
ignoreCanvasSerializationErrorsconfiguration option at both global config and snapshot levels - Modifies canvas serialization to catch errors and create fallback image elements when the flag is enabled
- Refactors canvas serialization code to extract image element creation into a reusable helper function
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/core/src/config.js | Adds schema definition for the new ignoreCanvasSerializationErrors boolean configuration option |
| packages/core/src/page.js | Passes the ignoreCanvasSerializationErrors option through the snapshot capture pipeline |
| packages/core/src/discovery.js | Adds debug logging for the new configuration option |
| packages/dom/src/serialize-dom.js | Extracts and passes the ignoreCanvasSerializationErrors option to the serialization context |
| packages/dom/src/serialize-canvas.js | Refactors canvas serialization to handle errors gracefully and create fallback images when flag is enabled |
| packages/dom/test/serialize-dom.test.js | Adds tests for the new error handling behavior in DOM serialization |
| packages/dom/test/serialize-canvas.test.js | Adds comprehensive tests for canvas error handling and fallback image creation |
| packages/core/test/percy.test.js | Updates test expectations to include the new configuration option |
Comments suppressed due to low confidence (1)
packages/dom/test/serialize-dom.test.js:471
- This test is identical to the previous test case 'ignores canvas serialization errors when flag is enabled'. The test name suggests it should verify the flag is picked from options, but it doesn't test anything different or demonstrate how options are prioritized.
it('picks ignoreCanvasSerializationErrors flag from options', () => {
this-is-shivamsingh
approved these changes
Jul 31, 2025
pankaj443
approved these changes
Aug 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added support for making canvas serialization fail-safe.
Passing
ignoreCanvasSerializationErrorsin snapshot options or at global config. ignore any errors that occur during canvas serialization. And instead renders a broken Img.