Skip to content

fix(client): accept diffSensitivity 0-4 (Very Strict) in PERCY_VISUAL_CONFIG #2453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rishigupta1599 merged 2 commits into from
Oct 6, 2026
Merged

fix(client): accept diffSensitivity 0-4 (Very Strict) in PERCY_VISUAL_CONFIG #2453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfe1045
fix(client): allow diffSensitivity 0 in PERCY_VISUAL_CONFIG
rishigupta1599 Oct 6, 2026
1411b97
fix(client): limit visual-config diffSensitivity to 0-4
rishigupta1599 Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/client/src/client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ function parseVisualConfigFromEnv(log) {
validateBoolean(visualConfig.compareWithPreviousRun, 'compareWithPreviousRun');
validateBoolean(visualConfig.diffIgnoreEnabled, 'diffIgnoreEnabled');
validateNumberInRange(visualConfig.diffIgnorePercentage, 'diffIgnorePercentage');
validateIntegerRange(visualConfig.diffSensitivity, 'diffSensitivity', 1, 5);
// 0-indexed like the project setting: 0 = Very Strict ... 4 = Very Relaxed
validateIntegerRange(visualConfig.diffSensitivity, 'diffSensitivity', 0, 4);

if (visualConfig.browsers != null) {
if (!Array.isArray(visualConfig.browsers) || !visualConfig.browsers.every(b => typeof b === 'string')) {
Expand Down
19 changes: 18 additions & 1 deletion packages/client/test/client.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,13 +769,30 @@ describe('PercyClient', () => {
.toBeRejectedWithError('Invalid PERCY_VISUAL_CONFIG: value must be valid JSON');
});

it('accepts diffSensitivity 0 (Very Strict)', async () => {
process.env.PERCY_VISUAL_CONFIG = JSON.stringify({ diffSensitivity: 0 });

await expectAsync(client.createBuild({ projectType: 'web' })).toBeResolved();

expect(api.requests['/builds'][0].body.data.attributes['visual-config'])
.toEqual({ diffSensitivity: 0 });
});

it('throws when PERCY_VISUAL_CONFIG contains invalid types', async () => {
process.env.PERCY_VISUAL_CONFIG = JSON.stringify({
diffSensitivity: 'high'
});

await expectAsync(client.createBuild({ projectType: 'web' })).toBeRejectedWithError(
"Invalid PERCY_VISUAL_CONFIG: 'diffSensitivity' must be an integer between 1 and 5"
"Invalid PERCY_VISUAL_CONFIG: 'diffSensitivity' must be an integer between 0 and 4"
);
});

it('throws when PERCY_VISUAL_CONFIG diffSensitivity is out of range', async () => {
process.env.PERCY_VISUAL_CONFIG = JSON.stringify({ diffSensitivity: 5 });

await expectAsync(client.createBuild({ projectType: 'web' })).toBeRejectedWithError(
"Invalid PERCY_VISUAL_CONFIG: 'diffSensitivity' must be an integer between 0 and 4"
);
});

Expand Down
Loading