Replace Jimp#1152
Merged
Merged
Conversation
|
…iate PNG encode/decode - fix restore blockout transparency and correct landscape bezel rotation -
wswebcreation
merged commit 663ce4f
into
ws/investigate-flakiness
5 of 10 checks passed
wswebcreation
added a commit
that referenced
this pull request
Jun 28, 2026
* feat: add compareEngine option and pixelmatch dependency * feat: add pixelmatch adapter and wire into executeImageCompare * test: add unit tests for pixelmatch adapter and compareEngine routing * chore: upgrade pixelmatch to v7.2.0 * fix: scope compareEngine to service level only * fix: normalize image dimensions before pixelmatch comparison * fix: align pixelmatch threshold with resemble and use consistent diff color * fix: replace contain() with buffer-level padding to prevent top-line artifact * fix: use Math.ceil for ignored region size and increase bidi padding * Merge branch 'main' into ws/investigate-flakiness * Replace Jimp (#1152) * refactor: remove resemble engine and make pixelmatch the sole comparison engine * feat: add fast-png dependency and imageUtils pure-JS pixel utility module * chore: linting fix * chore: add missing coverage * feat: overlay diff pixels on actual screenshot and eliminate intermediate PNG encode/decode - fix restore blockout transparency and correct landscape bezel rotation - * chore: add new temp images * chore:now use the pixelmatch not layout testing baseline * tests: fix tests * Merge branch 'main' into ws/replace-jimp * chore: add cron option to enable/disable trigger * chore: fix flow * Merge branch 'main' into ws/replace-jimp * Merge branch 'main' into ws/replace-jimp * Merge branch 'ws/investigate-flakiness' into ws/replace-jimp * fix: fix ocr test * chore: fix OCR test * chore: remove images * chore: revert lt config * Merge branch 'main' into ws/investigate-flakiness * chore: updated config * chore: new baseline images * chore: add changeset * chore: update pipeline config for stability
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Why
jimpis no longer actively maintained, t has seen no releases in over a year and shows minimal PR/issue activity. It was originally chosen to avoid the system-level install requirements ofnode-canvas(GTK, Cairo, etc.), but it now carries its own maintenance risk.This PR replaces jimp with an approach that keeps the same guarantee, no binary dependencies, no OS-level installs, pure JavaScript, while using actively maintained libraries. The image codec is replaced by
fast-png(v8.0.0, maintained by the image-js / Zakodium org), and all image manipulation operations are implemented as a small in-house utility module that operates directly on raw RGBA pixel buffers.User impact
There are no intentional behaviour changes for end users. The visual comparison results, blockout regions, full-page screenshot assembly, and device rotation handling all operate identically. The
compareEnginethe is introduced in the branch we are going merge this in will be removed. We believe that we can merge this as a major release without too much impact for users.Baseline compatibility
This PR is being validated against baselines that were originally generated with jimp to confirm that the pixel-level output of the new implementation is identical. Any regression there would indicate a bug in the pure-JS pixel operations (crop, composite, rotate, resize) that needs to be addressed before merging.