Skip to content

feat: expose deviceDetails in healthcheck endpoint for responsive capture #2112

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
bhokaremoin merged 3 commits into from
Feb 24, 2026
+37 −5
Merged

feat: expose deviceDetails in healthcheck endpoint for responsive capture #2112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a2b13e
feat: add deviceDetails to healthcheck endpoint and SDK
bhokaremoin Feb 23, 2026
787e96f
test: add tests for deviceDetails in healthcheck and SDK
bhokaremoin Feb 23, 2026
95f4e9e
fixing tests
bhokaremoin Feb 23, 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
4 changes: 3 additions & 1 deletion packages/core/src/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ export function createPercyServer(percy, port) {
// This will only be used if width is not passed in options
config: percy.config.snapshot.widths
},
deviceDetails: percy.deviceDetails || [],
success: true,
type: percy.client.tokenType()
}))
Expand Down Expand Up @@ -216,7 +217,8 @@ export function createPercyServer(percy, port) {
percy.testing.version = body;
} else if (cmd === 'config') {
percy.config.snapshot.widths = body.config;
percy.deviceDetails = body.mobile?.map((w) => { return { width: w }; });
// Support setting deviceDetails directly or deriving from mobile widths
percy.deviceDetails = body.deviceDetails || body.mobile?.map((w) => { return { width: w }; });
Copy link
Contributor

@rahulXbrowserstack rahulXbrowserstack Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we will get height also right ? because if mobile devices are enabled then we will capture DOM at device height- like below
[{width: , height:, devicePixelRatio: }]

Copy link
Contributor Author

@bhokaremoin bhokaremoin Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deviceDetails will return [{width: , height:, devicePixelRatio: }] only.

|| body.mobile?.map((w) => { return { width: w }; }); - this is a fallback if deviceDetails for some reason comes as undefined,

It can be removed if required

Copy link
Contributor

@rahulXbrowserstack rahulXbrowserstack Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, that second part can be removed, but its on you whether to keep it or not

Copy link
Contributor Author

@bhokaremoin bhokaremoin Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually this is /test endpoint it used only in our sdk test so no worries on it.

percy.config.snapshot.responsiveSnapshotCapture = !!body.responsive;
percy.config.percy.deferUploads = !!body.deferUploads;
} else if (cmd === 'error' || cmd === 'disconnect') {
Expand Down
13 changes: 9 additions & 4 deletions packages/core/test/api.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ describe('API Server', () => {
loglevel: 'info',
config: PercyConfig.getDefaults(),
widths: { mobile: [], config: PercyConfig.getDefaults().snapshot.widths },
deviceDetails: [],
build: {
id: '123',
number: 1,
Expand Down Expand Up @@ -88,7 +89,8 @@ describe('API Server', () => {
widths: {
mobile: [390],
config: [1000]
}
},
deviceDetails: [{ width: 390, devicePixelRatio: 2 }]
}));
});

Expand Down Expand Up @@ -741,21 +743,24 @@ describe('API Server', () => {
});

it('can manipulate the config widths via /test/api/config', async () => {
let { widths, config } = await get('/percy/healthcheck');
let { widths, config, deviceDetails } = await get('/percy/healthcheck');
expect(widths.config).toEqual([375, 1280]);
expect(widths.mobile).toEqual([]);
expect(deviceDetails).toEqual([]);

await post('/test/api/config', { config: [390], deferUploads: true });
({ widths, config } = await get('/percy/healthcheck'));
({ widths, config, deviceDetails } = await get('/percy/healthcheck'));
expect(widths.config).toEqual([390]);
expect(config.snapshot.responsiveSnapshotCapture).toEqual(false);
expect(config.percy.deferUploads).toEqual(true);
expect(deviceDetails).toEqual([]);

await post('/test/api/config', { config: [375, 1280], mobile: [456], responsive: true });
({ widths, config } = await get('/percy/healthcheck'));
({ widths, config, deviceDetails } = await get('/percy/healthcheck'));
expect(widths.mobile).toEqual([456]);
expect(config.snapshot.responsiveSnapshotCapture).toEqual(true);
expect(config.percy.deferUploads).toEqual(false);
expect(deviceDetails).toEqual([{ width: 456 }]);
});

it('can make endpoints return server errors via /test/api/error', async () => {
Expand Down
1 change: 1 addition & 0 deletions packages/sdk-utils/src/percy-enabled.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export async function isPercyEnabled() {
percy.enabled = true;
percy.type = response.body.type;
percy.widths = response.body.widths;
percy.deviceDetails = response.body.deviceDetails;
} catch (e) {
percy.enabled = false;
error = e;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk-utils/test/helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const helpers = {
delete utils.percy.build;
delete utils.percy.enabled;
delete utils.percy.domScript;
delete utils.percy.deviceDetails;
delete utils.logger.log.history;
delete utils.logger.loglevel.lvl;
delete process.env.PERCY_LOGLEVEL;
Expand Down
23 changes: 23 additions & 0 deletions packages/sdk-utils/test/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ describe('SDK Utils', () => {
expect(percy.widths).toHaveProperty('config', [375, 1280]);
expect(percy.widths).toHaveProperty('mobile', []);
});

it('contains percy deviceDetails', () => {
expect(percy.deviceDetails).toEqual([]);
});
});
});

Expand Down Expand Up @@ -117,6 +121,25 @@ describe('SDK Utils', () => {
await expectAsync(utils.postSnapshot({})).toBeResolved();
await expectAsync(isPercyEnabled()).toBeResolvedTo(false);
});

it('stores deviceDetails when populated', async () => {
// Set up deviceDetails via test config
await helpers.test('config', { mobile: [390, 456] });

// Reset and refetch healthcheck data
utils.percy.enabled = null;
await expectAsync(isPercyEnabled()).toBeResolvedTo(true);

expect(utils.percy.deviceDetails).toEqual([
{ width: 390 },
{ width: 456 }
]);

// Cleanup: reset deviceDetails back to empty
await helpers.test('config', { config: [375, 1280] });
utils.percy.enabled = null;
utils.percy.deviceDetails = undefined;
});
});

describe('waitForPercyIdle()', () => {
Expand Down