Skip to content

Commit 544bf2e

Browse files
committed
fix(device-pin): retain typed diagnostics for incompatible selectors
1 parent 99227f6 commit 544bf2e

6 files changed

Lines changed: 167 additions & 15 deletions

File tree

‎packages/client/src/__tests__/index-device-pin.test.ts‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,91 @@ test('a name alias and overlapping Apple platform selectors are accepted', async
116116
await runCommand(client, 'snapshot', { device: 'ipad_pro', platform: 'apple' });
117117
assert.equal(requests.length, 1);
118118
});
119+
120+
for (const [selector, input, conflict] of [
121+
[
122+
{ platform: 'ios' },
123+
{ serial: 'emulator-5554' },
124+
{ key: 'serial', pinnedKey: 'platform', pinned: 'ios', requested: 'emulator-5554' },
125+
],
126+
[
127+
{ platform: 'android' },
128+
{ udid: 'IPAD-001' },
129+
{ key: 'udid', pinnedKey: 'platform', pinned: 'android', requested: 'IPAD-001' },
130+
],
131+
[
132+
{ udid: 'IPAD-001' },
133+
{ serial: 'emulator-5554' },
134+
{ key: 'serial', pinnedKey: 'udid', pinned: 'IPAD-001', requested: 'emulator-5554' },
135+
],
136+
[
137+
{ serial: 'emulator-5554' },
138+
{ udid: 'IPAD-001' },
139+
{ key: 'udid', pinnedKey: 'serial', pinned: 'emulator-5554', requested: 'IPAD-001' },
140+
],
141+
[
142+
{ udid: 'IPAD-001' },
143+
{ platform: 'android' },
144+
{ key: 'platform', pinnedKey: 'udid', pinned: 'IPAD-001', requested: 'android' },
145+
],
146+
[
147+
{ serial: 'emulator-5554' },
148+
{ platform: 'ios' },
149+
{ key: 'platform', pinnedKey: 'serial', pinned: 'emulator-5554', requested: 'ios' },
150+
],
151+
[
152+
{ platform: 'linux' },
153+
{ udid: 'IPAD-001' },
154+
{ key: 'udid', pinnedKey: 'platform', pinned: 'linux', requested: 'IPAD-001' },
155+
],
156+
[
157+
{ platform: 'web' },
158+
{ serial: 'emulator-5554' },
159+
{ key: 'serial', pinnedKey: 'platform', pinned: 'web', requested: 'emulator-5554' },
160+
],
161+
] as const) {
162+
test(`a pin ${JSON.stringify(selector)} rejects incompatible selector ${JSON.stringify(input)} before transport`, async () => {
163+
const { client, requests } = recordingClient({ ...PIN, selector });
164+
await assert.rejects(
165+
runCommand(client, 'snapshot', input),
166+
failsWithPinConflict({ message: /conflicts with the device pin/, conflicts: [conflict] }),
167+
);
168+
assert.equal(requests.length, 0);
169+
});
170+
}
171+
172+
test('an incompatible selector in a batch step is rejected before any request is sent', async () => {
173+
const { client, requests } = recordingClient(PIN);
174+
await assert.rejects(
175+
runCommand(client, 'batch', {
176+
steps: [{ command: 'snapshot', input: { serial: 'emulator-5554' } }],
177+
}),
178+
failsWithPinConflict({
179+
message: /^Batch step 1: serial/,
180+
conflicts: [
181+
{
182+
key: 'serial',
183+
pinnedKey: 'platform',
184+
pinned: 'ios',
185+
requested: 'emulator-5554',
186+
step: 1,
187+
},
188+
],
189+
}),
190+
);
191+
assert.equal(requests.length, 0);
192+
});
193+
194+
for (const [platform, identity] of [
195+
['ios', { udid: 'IPAD-001' }],
196+
['macos', { udid: 'MAC-001' }],
197+
['android', { serial: 'emulator-5554' }],
198+
['harmonyos', { serial: 'HARMONY-001' }],
199+
['vega', { serial: 'VEGA-001' }],
200+
] as const) {
201+
test(`a ${platform} pin accepts a compatible identity selector`, async () => {
202+
const { client, requests } = recordingClient({ ...PIN, selector: { platform } });
203+
await runCommand(client, 'snapshot', identity);
204+
assert.equal(requests.length, 1);
205+
});
206+
}

‎packages/command-surface/src/schema/cli-config-device-pin.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ for (const value of [
9393
{ device: '' },
9494
{ device: 4 },
9595
{ target: 'mobile' },
96+
{ platform: 'windows' },
9697
]) {
9798
test(`invalid pin ${JSON.stringify(value)} fails with its config source`, () => {
9899
const { configPath, options } = projectWithConfig({ devicePin: value });

‎packages/command-surface/src/schema/option-schema.ts‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,23 @@ export function parseDevicePin(
182182
);
183183
}
184184
const spec = getOptionSpec(key as keyof DevicePinSelector)!;
185-
Object.assign(selector, {
186-
[key]: parseOptionValueFromSource(spec, raw, label, `devicePin.${key}`),
187-
});
185+
try {
186+
Object.assign(selector, {
187+
[key]: parseOptionValueFromSource(spec, raw, label, `devicePin.${key}`),
188+
});
189+
} catch (error) {
190+
if (!(error instanceof AppError) || error.code !== 'INVALID_ARGS') throw error;
191+
throw new AppError(
192+
error.code,
193+
error.message,
194+
{
195+
...error.details,
196+
reason: 'invalid_device_pin',
197+
pinSource: label,
198+
},
199+
error,
200+
);
201+
}
188202
}
189203
return { selector, source };
190204
}

‎packages/device-selection/src/device-selection-resolver.ts‎

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import type {
66
} from '@agent-device/contracts/client';
77
import {
88
hasExplicitDeviceIdentitySelector,
9+
isApplePlatform,
910
isIosFamily,
1011
isSerialAddressablePlatform,
1112
matchesDeviceSelector,
@@ -284,6 +285,7 @@ function retrySelectorsFor(devices: readonly DeviceInfo[]) {
284285

285286
type PinConflict = {
286287
key: keyof DevicePinSelector;
288+
pinnedKey?: keyof DevicePinSelector;
287289
pinned: string;
288290
requested: string;
289291
step?: number;
@@ -303,24 +305,59 @@ export function assertRequestHonorsDevicePin(
303305
): void {
304306
const conflicts: PinConflict[] = [];
305307
const collect = (flags: Readonly<Record<string, unknown>> | undefined, step?: number) => {
306-
for (const key of Object.keys(pin.selector) as Array<keyof DevicePinSelector>) {
307-
const pinned = pin.selector[key];
308-
const requested = flags?.[key];
309-
if (pinned === undefined || typeof requested !== 'string') continue;
310-
const matches =
311-
key === 'device'
312-
? matchesDeviceNameSelector({ name: pinned }, requested)
313-
: key === 'platform'
314-
? !platformSelectorsConflict(requested as PlatformSelector, pin.selector.platform)
315-
: requested === pinned;
316-
if (!matches) conflicts.push({ key, pinned, requested, ...(step ? { step } : {}) });
308+
const location = step === undefined ? {} : { step };
309+
for (const pinnedKey of Object.keys(pin.selector) as Array<keyof DevicePinSelector>) {
310+
const pinned = pin.selector[pinnedKey];
311+
if (pinned === undefined) continue;
312+
for (const key of ['platform', 'device', 'udid', 'serial'] as const) {
313+
const requested = flags?.[key];
314+
if (
315+
typeof requested === 'string' &&
316+
pinSelectorsConflict(pinnedKey, pinned, key, requested)
317+
) {
318+
conflicts.push({
319+
key,
320+
pinned,
321+
requested,
322+
...(key === pinnedKey ? {} : { pinnedKey }),
323+
...location,
324+
});
325+
}
326+
}
317327
}
318328
};
319329
collect(request.flags);
320330
request.flags?.batchSteps?.forEach((step, index) => collect(step.flags, index + 1));
321331
if (conflicts.length) throwPinConflict(pin, conflicts);
322332
}
323333

334+
function pinSelectorsConflict(
335+
pinnedKey: keyof DevicePinSelector,
336+
pinned: string,
337+
key: keyof DevicePinSelector,
338+
requested: string,
339+
): boolean {
340+
if (pinnedKey === key) {
341+
if (key === 'device') return !matchesDeviceNameSelector({ name: pinned }, requested);
342+
if (key === 'platform')
343+
return platformSelectorsConflict(requested as PlatformSelector, pinned as PlatformSelector);
344+
return requested !== pinned;
345+
}
346+
if (pinnedKey === 'platform') return !selectorSupportsPlatform(key, pinned as PlatformSelector);
347+
if (key === 'platform')
348+
return !selectorSupportsPlatform(pinnedKey, requested as PlatformSelector);
349+
return (pinnedKey === 'udid' && key === 'serial') || (pinnedKey === 'serial' && key === 'udid');
350+
}
351+
352+
function selectorSupportsPlatform(
353+
key: keyof DevicePinSelector,
354+
platform: PlatformSelector,
355+
): boolean {
356+
if (key === 'udid') return isApplePlatform(platform);
357+
if (key === 'serial') return isSerialAddressablePlatform(platform);
358+
return true;
359+
}
360+
324361
export function assertDeviceHonorsPin(
325362
pin: DevicePin,
326363
device: DeviceInfo,

‎src/__tests__/cli-device-pin.test.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ test('a remote-config device that contradicts the pin fails before any daemon re
8989

9090
assert.equal(result.code, 1);
9191
assert.equal(result.calls.length, 0);
92-
assert.deepEqual(readJsonError(result.stdout).details.conflicts, [
92+
const error = readJsonError(result.stdout);
93+
assert.equal(error.details.reason, 'device_pin_conflict');
94+
assert.deepEqual(error.details.conflicts, [
9395
{ key: 'device', pinned: 'iPad Pro', requested: 'iPhone 16' },
9496
]);
9597
fs.rmSync(root, { recursive: true, force: true });

‎test/integration/provider-scenarios/device-pin.test.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ for (const platform of ['ios', 'android'] as const) {
2222
await withProviderScenarioResource(
2323
() => createProviderScenarioHarness({ deviceInventoryProvider: async () => [pinned, other] }),
2424
async (daemon) => {
25+
const incompatibleIdentity =
26+
platform === 'ios' ? { serial: 'ANDROID-001' } : { udid: 'IPAD-001' };
27+
const incompatible = await daemon.callCommand('capabilities', [], incompatibleIdentity, {
28+
meta: { devicePin: pin },
29+
});
30+
const refusal = assertRpcError(incompatible, 400, 'INVALID_ARGS', /device pin/);
31+
expect(refusal.details).toMatchObject({
32+
reason: 'device_pin_conflict',
33+
pinSource: 'project config file /project/agent-device.json',
34+
});
2535
const client = createAgentDeviceClient(
2636
{
2737
daemonBaseUrl: daemon.baseUrl,

0 commit comments

Comments
 (0)