Skip to content

Commit a43bd8e

Browse files
committed
refactor: add provider device runtime foundation
1 parent 0be806c commit a43bd8e

20 files changed

Lines changed: 1389 additions & 119 deletions
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
import assert from 'node:assert/strict';
2+
import { afterEach, test } from 'vitest';
3+
import {
4+
createProviderDeviceRuntimeRequestProviders,
5+
configureProviderPortReverse,
6+
getProviderDeviceInteractor,
7+
installProviderDeviceApp,
8+
removeProviderPortReverse,
9+
setActiveProviderDeviceRuntimes,
10+
type ProviderDeviceRuntime,
11+
} from '../provider-device-runtime.ts';
12+
import type { Interactor } from '../core/interactor-types.ts';
13+
import type { SimulatorLease } from '../daemon/lease-registry.ts';
14+
import type { DeviceInfo } from '../utils/device.ts';
15+
16+
afterEach(() => {
17+
setActiveProviderDeviceRuntimes([]);
18+
});
19+
20+
test('provider device runtime registry delegates lifecycle, inventory, interactors, and installs to matching providers', async () => {
21+
const world = makeProviderRuntimeWorld();
22+
setActiveProviderDeviceRuntimes([world.missRuntime, world.hitRuntime]);
23+
const requestProviders = createProviderDeviceRuntimeRequestProviders([
24+
world.missRuntime,
25+
world.hitRuntime,
26+
]);
27+
28+
assert.deepEqual(await requestProviders.leaseLifecycleProvider?.allocate?.(world.lease), {
29+
provider: 'hit',
30+
});
31+
assert.deepEqual(
32+
await requestProviders.deviceInventoryProvider?.({
33+
platform: 'ios',
34+
leaseId: world.lease.leaseId,
35+
leaseProvider: 'hit',
36+
}),
37+
[world.device],
38+
);
39+
await assertProviderRuntimeDelegates(world);
40+
});
41+
42+
function makeProviderRuntimeWorld() {
43+
const lease: SimulatorLease = {
44+
leaseId: 'lease-a',
45+
tenantId: 'team-a',
46+
runId: 'run-a',
47+
backend: 'ios-instance',
48+
leaseProvider: 'hit',
49+
createdAt: 1,
50+
heartbeatAt: 1,
51+
expiresAt: 60_001,
52+
};
53+
const device: DeviceInfo = {
54+
platform: 'ios',
55+
kind: 'simulator',
56+
id: 'provider:ios:lease-a',
57+
name: 'Provider iOS',
58+
booted: true,
59+
};
60+
const interactor = { open: async () => undefined } as unknown as Interactor;
61+
const missRuntime = makeMissingRuntime();
62+
const hitRuntime = makeRuntime({
63+
provider: 'hit',
64+
leaseResult: { provider: 'hit' },
65+
devices: [device],
66+
interactor,
67+
installResult: { bundleId: 'com.example.app' },
68+
portReverseResult: { provider: 'hit' },
69+
});
70+
return { lease, device, interactor, missRuntime, hitRuntime };
71+
}
72+
73+
function makeMissingRuntime(): ProviderDeviceRuntime {
74+
return makeRuntime({
75+
provider: 'miss',
76+
leaseResult: undefined,
77+
devices: null,
78+
interactor: undefined,
79+
installResult: undefined,
80+
portReverseResult: undefined,
81+
});
82+
}
83+
84+
async function assertProviderRuntimeDelegates(world: ReturnType<typeof makeProviderRuntimeWorld>) {
85+
assert.equal(getProviderDeviceInteractor(world.device), world.interactor);
86+
assert.deepEqual(
87+
await installProviderDeviceApp(world.device, 'com.example.app', '/tmp/app.ipa'),
88+
{
89+
bundleId: 'com.example.app',
90+
},
91+
);
92+
assert.deepEqual(
93+
await configureProviderPortReverse({
94+
leaseId: world.lease.leaseId,
95+
provider: 'hit',
96+
devicePort: 8097,
97+
hostPort: 8097,
98+
name: 'devtools',
99+
}),
100+
{ provider: 'hit' },
101+
);
102+
assert.deepEqual(
103+
await removeProviderPortReverse({
104+
leaseId: world.lease.leaseId,
105+
provider: 'hit',
106+
devicePort: 8097,
107+
hostPort: 8097,
108+
name: 'devtools',
109+
}),
110+
{ provider: 'hit' },
111+
);
112+
}
113+
114+
test('provider device install fails explicitly when an owning provider has no install hook', async () => {
115+
const device: DeviceInfo = {
116+
platform: 'android',
117+
kind: 'device',
118+
id: 'provider:android:lease-a',
119+
name: 'Provider Android',
120+
booted: true,
121+
};
122+
const runtime = makeRuntime({
123+
provider: 'hit',
124+
leaseResult: undefined,
125+
devices: [device],
126+
interactor: undefined,
127+
installResult: undefined,
128+
portReverseResult: undefined,
129+
installHook: false,
130+
});
131+
setActiveProviderDeviceRuntimes([runtime]);
132+
133+
await assert.rejects(
134+
() => installProviderDeviceApp(device, 'com.example.app', '/tmp/app.apk'),
135+
/does not support install/,
136+
);
137+
});
138+
139+
function makeRuntime(options: {
140+
provider: string;
141+
leaseResult: Record<string, unknown> | undefined;
142+
devices: DeviceInfo[] | null;
143+
interactor: Interactor | undefined;
144+
installResult: { bundleId: string } | undefined;
145+
portReverseResult: Record<string, unknown> | undefined;
146+
installHook?: boolean;
147+
}): ProviderDeviceRuntime {
148+
return {
149+
provider: options.provider,
150+
leaseLifecycle: {
151+
allocate: async () => options.leaseResult,
152+
heartbeat: async () => options.leaseResult,
153+
release: async () => options.leaseResult,
154+
},
155+
deviceInventoryProvider: async () => options.devices,
156+
ownsDevice: (device) => options.devices?.some((entry) => entry.id === device.id) ?? false,
157+
getInteractor: () => options.interactor,
158+
...(options.installHook === false ? {} : { installApp: async () => options.installResult }),
159+
configurePortReverse: async () => options.portReverseResult,
160+
removePortReverse: async () => options.portReverseResult,
161+
shutdown: async () => undefined,
162+
};
163+
}

‎src/core/dispatch-context.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ export type CommandFlags = Omit<CliFlags, DaemonExcludedCliFlag> & {
2626
kind?: string;
2727
maestro?: MaestroRuntimeFlags;
2828
postGestureStabilization?: boolean;
29+
leaseProvider?: string;
30+
provider?: string;
31+
deviceKey?: string;
32+
clientId?: string;
33+
devicePort?: number;
34+
hostPort?: number;
35+
portReverseName?: string;
2936
replayBackend?: string;
3037
shardCount?: number;
3138
shardIndex?: number;

‎src/core/dispatch-resolve.ts‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,14 @@ type ResolveDeviceFlags = Pick<
2222
| 'device'
2323
| 'udid'
2424
| 'serial'
25+
| 'leaseId'
2526
| 'iosSimulatorDeviceSet'
2627
| 'androidDeviceAllowlist'
27-
>;
28+
> & {
29+
leaseProvider?: string;
30+
deviceKey?: string;
31+
clientId?: string;
32+
};
2833

2934
const resolveTargetDeviceCacheScope = new AsyncLocalStorage<Map<string, DeviceInfo>>();
3035
const deviceInventoryProviderScope = new AsyncLocalStorage<DeviceInventoryProvider>();
@@ -144,6 +149,12 @@ export async function resolveTargetDevice(flags: ResolveDeviceFlags): Promise<De
144149
udid: flags.udid,
145150
serial: flags.serial,
146151
};
152+
const leaseScope = {
153+
leaseId: flags.leaseId,
154+
leaseProvider: flags.leaseProvider,
155+
deviceKey: flags.deviceKey,
156+
clientId: flags.clientId,
157+
};
147158
if (selector.target && !selector.platform) {
148159
throw new AppError(
149160
'INVALID_ARGS',
@@ -153,6 +164,7 @@ export async function resolveTargetDevice(flags: ResolveDeviceFlags): Promise<De
153164

154165
const injectedDevices = await readInjectedDeviceInventory({
155166
...selector,
167+
...leaseScope,
156168
iosSimulatorSetPath,
157169
androidSerialAllowlist: androidSerialAllowlist
158170
? Array.from(androidSerialAllowlist).sort()
@@ -175,6 +187,7 @@ export async function resolveTargetDevice(flags: ResolveDeviceFlags): Promise<De
175187

176188
const devices = await listLocalDeviceInventory({
177189
...selector,
190+
...leaseScope,
178191
iosSimulatorSetPath,
179192
androidSerialAllowlist: androidSerialAllowlist
180193
? Array.from(androidSerialAllowlist).sort()
@@ -268,6 +281,10 @@ function buildResolveTargetDeviceCacheKey(params: {
268281
device: flags.device,
269282
udid: flags.udid,
270283
serial: flags.serial,
284+
leaseId: flags.leaseId,
285+
leaseProvider: flags.leaseProvider,
286+
deviceKey: flags.deviceKey,
287+
clientId: flags.clientId,
271288
iosSimulatorSetPath,
272289
androidSerialAllowlist: androidSerialAllowlist
273290
? Array.from(androidSerialAllowlist).sort()

‎src/core/interactors.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
import type { DeviceInfo } from '../utils/device.ts';
22
import { AppError } from '../utils/errors.ts';
3+
import { getProviderDeviceInteractor, isActiveProviderDevice } from '../provider-device-runtime.ts';
34
import type { Interactor, RunnerContext } from './interactor-types.ts';
45

56
export async function getInteractor(
67
device: DeviceInfo,
78
runnerContext: RunnerContext,
89
): Promise<Interactor> {
10+
if (isActiveProviderDevice(device)) {
11+
const providerInteractor = getProviderDeviceInteractor(device);
12+
if (providerInteractor) return providerInteractor;
13+
throw new AppError(
14+
'UNSUPPORTED_OPERATION',
15+
'Provider device runtime does not have an active interactor for this device.',
16+
{ deviceId: device.id, platform: device.platform },
17+
);
18+
}
19+
920
switch (device.platform) {
1021
case 'android': {
1122
const { createAndroidInteractor } = await import('./interactors/android.ts');

‎src/core/platform-inventory.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ export type DeviceInventoryRequest = {
66
deviceName?: string;
77
udid?: string;
88
serial?: string;
9+
leaseId?: string;
10+
leaseProvider?: string;
11+
deviceKey?: string;
12+
clientId?: string;
913
iosSimulatorSetPath?: string;
1014
androidSerialAllowlist?: string[];
1115
};

‎src/daemon/__tests__/lease-registry.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ test('heartbeatLease extends active lease and releaseLease is idempotent', () =>
5050
assert.equal(heartbeat.expiresAt, 25_000);
5151

5252
const released = registry.releaseLease({ leaseId: lease.leaseId });
53-
assert.deepEqual(released, { released: true });
53+
assert.deepEqual(released, { released: true, lease: heartbeat });
5454
const releasedAgain = registry.releaseLease({ leaseId: lease.leaseId });
5555
assert.deepEqual(releasedAgain, { released: false });
5656
});

‎src/daemon/__tests__/request-handler-catalog.test.ts‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,60 @@ test('lease handler preserves device-aware lease fields', async () => {
142142
assert.equal(heartbeatLease.leaseProvider, 'proxy');
143143
});
144144

145+
test('lease release calls provider hook using the released lease without heartbeat mutation', async () => {
146+
const leaseRegistry = new LeaseRegistry();
147+
const releaseCalls: string[] = [];
148+
const allocateResponse = await handleLeaseCommands({
149+
req: {
150+
command: INTERNAL_COMMANDS.leaseAllocate,
151+
token: 'test-token',
152+
session: 'catalog-test',
153+
meta: {
154+
tenantId: 'tenant-a',
155+
runId: 'run-a',
156+
leaseBackend: 'android-instance',
157+
leaseProvider: 'fake-provider',
158+
leaseTtlMs: 20_000,
159+
},
160+
positionals: [],
161+
},
162+
leaseRegistry,
163+
});
164+
assert.equal(allocateResponse?.ok, true);
165+
const lease = readLeaseResponse(allocateResponse);
166+
167+
const releaseResponse = await handleLeaseCommands({
168+
req: {
169+
command: INTERNAL_COMMANDS.leaseRelease,
170+
token: 'test-token',
171+
session: 'catalog-test',
172+
meta: {
173+
tenantId: 'tenant-a',
174+
runId: 'run-a',
175+
leaseId: lease.leaseId,
176+
leaseBackend: 'android-instance',
177+
leaseProvider: 'fake-provider',
178+
leaseTtlMs: 1,
179+
},
180+
positionals: [],
181+
},
182+
leaseRegistry,
183+
leaseLifecycleProvider: {
184+
release: async (releasedLease) => {
185+
releaseCalls.push(releasedLease.leaseId);
186+
return { provider: releasedLease.leaseProvider };
187+
},
188+
},
189+
});
190+
191+
assert.equal(releaseResponse?.ok, true);
192+
assert.deepEqual(releaseCalls, [lease.leaseId]);
193+
assert.deepEqual(releaseResponse.data, {
194+
released: true,
195+
provider: { provider: 'fake-provider' },
196+
});
197+
});
198+
145199
function catalogCommandsForRoute(route: Exclude<DaemonCommandRoute, 'generic'>): string[] {
146200
return [...Object.values(PUBLIC_COMMANDS), ...Object.values(INTERNAL_COMMANDS)].filter(
147201
(command) => getDaemonCommandRoute(command) === route,

‎src/daemon/device-ready.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { promises as fs } from 'node:fs';
55
import { AppError } from '../utils/errors.ts';
66
import { resolveIosDevicectlHint, IOS_DEVICECTL_DEFAULT_HINT } from '../platforms/ios/devicectl.ts';
77
import { runXcrun } from '../platforms/ios/tool-provider.ts';
8+
import { isActiveProviderDevice } from '../provider-device-runtime.ts';
89

910
const IOS_DEVICE_READY_TIMEOUT_MS = 15_000;
1011
const IOS_DEVICE_READY_COMMAND_TIMEOUT_BUFFER_MS = 3_000;
@@ -24,6 +25,8 @@ export async function ensureDeviceReady(
2425
device: DeviceInfo,
2526
options: DeviceReadyOptions = {},
2627
): Promise<void> {
28+
if (isActiveProviderDevice(device)) return;
29+
2730
const cacheKey = deviceReadyCacheKey(device);
2831
const cachedUntil = readyCache.get(cacheKey);
2932
if (cachedUntil !== undefined) {

0 commit comments

Comments
 (0)