Skip to content

Commit 3518eaa

Browse files
committed
refactor: add provider device runtime foundation
1 parent ed701f3 commit 3518eaa

16 files changed

Lines changed: 927 additions & 19 deletions
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
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 lease: SimulatorLease = {
22+
leaseId: 'lease-a',
23+
tenantId: 'team-a',
24+
runId: 'run-a',
25+
backend: 'ios-instance',
26+
leaseProvider: 'hit',
27+
createdAt: 1,
28+
heartbeatAt: 1,
29+
expiresAt: 60_001,
30+
};
31+
const device: DeviceInfo = {
32+
platform: 'ios',
33+
kind: 'simulator',
34+
id: 'provider:ios:lease-a',
35+
name: 'Provider iOS',
36+
booted: true,
37+
};
38+
const interactor = { open: async () => undefined } as unknown as Interactor;
39+
const missRuntime = makeRuntime({
40+
provider: 'miss',
41+
leaseResult: undefined,
42+
devices: null,
43+
interactor: undefined,
44+
installResult: undefined,
45+
portReverseResult: undefined,
46+
});
47+
const hitRuntime = makeRuntime({
48+
provider: 'hit',
49+
leaseResult: { provider: 'hit' },
50+
devices: [device],
51+
interactor,
52+
installResult: { bundleId: 'com.example.app' },
53+
portReverseResult: { provider: 'hit' },
54+
});
55+
56+
setActiveProviderDeviceRuntimes([missRuntime, hitRuntime]);
57+
const requestProviders = createProviderDeviceRuntimeRequestProviders([missRuntime, hitRuntime]);
58+
59+
assert.deepEqual(await requestProviders.leaseLifecycleProvider?.allocate?.(lease), {
60+
provider: 'hit',
61+
});
62+
assert.deepEqual(
63+
await requestProviders.deviceInventoryProvider?.({
64+
platform: 'ios',
65+
leaseId: 'lease-a',
66+
leaseProvider: 'hit',
67+
}),
68+
[device],
69+
);
70+
assert.equal(getProviderDeviceInteractor(device), interactor);
71+
assert.deepEqual(await installProviderDeviceApp(device, 'com.example.app', '/tmp/app.ipa'), {
72+
bundleId: 'com.example.app',
73+
});
74+
assert.deepEqual(
75+
await configureProviderPortReverse({
76+
leaseId: lease.leaseId,
77+
provider: 'hit',
78+
devicePort: 8097,
79+
hostPort: 8097,
80+
name: 'devtools',
81+
}),
82+
{ provider: 'hit' },
83+
);
84+
assert.deepEqual(
85+
await removeProviderPortReverse({
86+
leaseId: lease.leaseId,
87+
provider: 'hit',
88+
devicePort: 8097,
89+
hostPort: 8097,
90+
name: 'devtools',
91+
}),
92+
{ provider: 'hit' },
93+
);
94+
});
95+
96+
function makeRuntime(options: {
97+
provider: string;
98+
leaseResult: Record<string, unknown> | undefined;
99+
devices: DeviceInfo[] | null;
100+
interactor: Interactor | undefined;
101+
installResult: { bundleId: string } | undefined;
102+
portReverseResult: Record<string, unknown> | undefined;
103+
}): ProviderDeviceRuntime {
104+
return {
105+
provider: options.provider,
106+
leaseLifecycle: {
107+
allocate: async () => options.leaseResult,
108+
heartbeat: async () => options.leaseResult,
109+
release: async () => options.leaseResult,
110+
},
111+
deviceInventoryProvider: async () => options.devices,
112+
ownsDevice: (device) => options.devices?.some((entry) => entry.id === device.id) ?? false,
113+
getInteractor: () => options.interactor,
114+
installApp: async () => options.installResult,
115+
configurePortReverse: async () => options.portReverseResult,
116+
removePortReverse: async () => options.portReverseResult,
117+
shutdown: async () => undefined,
118+
};
119+
}

‎src/core/dispatch-context.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ export type CommandFlags = Omit<CliFlags, DaemonExcludedCliFlag> & {
2626
kind?: string;
2727
maestro?: MaestroRuntimeFlags;
2828
postGestureStabilization?: boolean;
29+
leaseProvider?: string;
30+
deviceKey?: string;
31+
clientId?: string;
32+
devicePort?: number;
33+
hostPort?: number;
34+
portReverseName?: string;
2935
replayBackend?: string;
3036
shardCount?: number;
3137
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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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+
}
14+
915
switch (device.platform) {
1016
case 'android': {
1117
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/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) {

‎src/daemon/handlers/install-source.ts‎

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { installProviderDeviceInstallablePath } from '../../provider-device-runtime.ts';
12
import { resolveTargetDevice, type CommandFlags } from '../../core/dispatch.ts';
23
import { ensureDeviceReady } from '../device-ready.ts';
34
import { getRequestSignal } from '../request-cancel.ts';
@@ -184,18 +185,30 @@ export async function handleInstallFromSourceCommand(params: {
184185
signal: requestSignal,
185186
});
186187
return await completeInstall(prepared, async (retained) => {
187-
await installIosInstallablePath(device, prepared.installablePath);
188-
if (!prepared.bundleId) {
188+
const providerResult = await installProviderDeviceInstallablePath(
189+
device,
190+
prepared.installablePath,
191+
{
192+
appIdentifierHint: prepared.bundleId,
193+
},
194+
);
195+
if (!providerResult) {
196+
await installIosInstallablePath(device, prepared.installablePath);
197+
}
198+
const bundleId = providerResult?.bundleId ?? prepared.bundleId;
199+
if (!bundleId) {
189200
throw new AppError(
190201
'COMMAND_FAILED',
191202
'Installed iOS app identity could not be resolved from the artifact',
192203
);
193204
}
194205
return {
195206
...retainedInstallResultFields(retained),
196-
bundleId: prepared.bundleId,
197-
...(prepared.appName ? { appName: prepared.appName } : {}),
198-
launchTarget: prepared.bundleId,
207+
bundleId,
208+
...((providerResult?.appName ?? prepared.appName)
209+
? { appName: providerResult?.appName ?? prepared.appName }
210+
: {}),
211+
launchTarget: providerResult?.launchTarget ?? bundleId,
199212
};
200213
});
201214
}
@@ -208,11 +221,21 @@ export async function handleInstallFromSourceCommand(params: {
208221
signal: requestSignal,
209222
});
210223
return await completeInstall(prepared, async (retained) => {
211-
const packageName = await installAndroidInstallablePathAndResolvePackageName(
224+
const providerResult = await installProviderDeviceInstallablePath(
212225
device,
213226
prepared.installablePath,
214-
prepared.packageName,
227+
{
228+
packageNameHint: prepared.packageName,
229+
},
215230
);
231+
let packageName = providerResult?.packageName;
232+
if (!providerResult) {
233+
packageName = await installAndroidInstallablePathAndResolvePackageName(
234+
device,
235+
prepared.installablePath,
236+
prepared.packageName,
237+
);
238+
}
216239
if (!packageName) {
217240
throw new AppError(
218241
'COMMAND_FAILED',
@@ -224,8 +247,10 @@ export async function handleInstallFromSourceCommand(params: {
224247
return {
225248
...retainedInstallResultFields(retained),
226249
packageName,
227-
...(appName ? { appName } : {}),
228-
launchTarget: packageName,
250+
...((providerResult?.appName ?? appName)
251+
? { appName: providerResult?.appName ?? appName }
252+
: {}),
253+
launchTarget: providerResult?.launchTarget ?? packageName,
229254
};
230255
});
231256
} catch (error) {

‎src/daemon/handlers/lease.ts‎

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,81 @@
11
import type { DaemonRequest, DaemonResponse } from '../types.ts';
2-
import type { LeaseRegistry } from '../lease-registry.ts';
2+
import type { DeviceLease, LeaseRegistry } from '../lease-registry.ts';
33
import { resolveLeaseScope } from '../lease-context.ts';
44
import {
55
leaseScopeToAllocateRequest,
66
leaseScopeToHeartbeatRequest,
77
leaseScopeToReleaseRequest,
88
} from '../../core/lease-scope.ts';
99

10+
export type LeaseLifecycleProvider = {
11+
allocate?: (lease: DeviceLease) => Promise<Record<string, unknown> | undefined>;
12+
heartbeat?: (lease: DeviceLease) => Promise<Record<string, unknown> | undefined>;
13+
release?: (lease: DeviceLease) => Promise<Record<string, unknown> | undefined>;
14+
};
15+
1016
type LeaseHandlerArgs = {
1117
req: DaemonRequest;
1218
leaseRegistry: LeaseRegistry;
19+
leaseLifecycleProvider?: LeaseLifecycleProvider;
1320
};
1421

1522
export async function handleLeaseCommands(args: LeaseHandlerArgs): Promise<DaemonResponse | null> {
16-
const { req, leaseRegistry } = args;
23+
const { req, leaseRegistry, leaseLifecycleProvider } = args;
1724
const leaseScope = resolveLeaseScope(req);
1825
switch (req.command) {
1926
case 'lease_allocate': {
2027
const lease = leaseRegistry.allocateLease(leaseScopeToAllocateRequest(leaseScope));
28+
let providerData: Record<string, unknown> | undefined;
29+
try {
30+
providerData = await leaseLifecycleProvider?.allocate?.(lease);
31+
} catch (error) {
32+
leaseRegistry.releaseLease(
33+
leaseScopeToReleaseRequest({
34+
leaseId: lease.leaseId,
35+
tenantId: lease.tenantId,
36+
runId: lease.runId,
37+
leaseBackend: lease.backend,
38+
leaseProvider: lease.leaseProvider,
39+
deviceKey: lease.deviceKey,
40+
clientId: lease.clientId,
41+
}),
42+
);
43+
throw error;
44+
}
2145
return {
2246
ok: true,
23-
data: { lease },
47+
data: { lease, ...(providerData ? { provider: providerData } : {}) },
2448
};
2549
}
2650
case 'lease_heartbeat': {
2751
const lease = leaseRegistry.heartbeatLease(leaseScopeToHeartbeatRequest(leaseScope));
52+
const providerData = await leaseLifecycleProvider?.heartbeat?.(lease);
2853
return {
2954
ok: true,
30-
data: { lease },
55+
data: { lease, ...(providerData ? { provider: providerData } : {}) },
3156
};
3257
}
3358
case 'lease_release': {
59+
const lease = findLeaseForRelease(leaseRegistry, leaseScope);
60+
const providerData = lease ? await leaseLifecycleProvider?.release?.(lease) : undefined;
3461
const result = leaseRegistry.releaseLease(leaseScopeToReleaseRequest(leaseScope));
3562
return {
3663
ok: true,
37-
data: result,
64+
data: { ...result, ...(providerData ? { provider: providerData } : {}) },
3865
};
3966
}
4067
default:
4168
return null;
4269
}
4370
}
71+
72+
function findLeaseForRelease(
73+
leaseRegistry: LeaseRegistry,
74+
leaseScope: ReturnType<typeof resolveLeaseScope>,
75+
): DeviceLease | undefined {
76+
try {
77+
return leaseRegistry.heartbeatLease(leaseScopeToHeartbeatRequest(leaseScope));
78+
} catch {
79+
return undefined;
80+
}
81+
}

0 commit comments

Comments
 (0)