Repository navigation
Expand file tree
/
Copy pathandroid.ts
More file actions
262 lines (246 loc) · 8.68 KB
/
Copy pathandroid.ts
File metadata and controls
262 lines (246 loc) · 8.68 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
import path from 'node:path';
import type Limrun from '@limrun/api';
import {
createInstanceClient as createAndroidInstanceClient,
type InstanceClient as LimrunAndroidClient,
} from '@limrun/api/instance-client';
import type { Interactor } from '@agent-device/contracts/interactor-types';
import type {
DeviceLease,
ProviderDeviceInstallOptions,
ProviderDeviceInstallResult,
ProviderPortReverseOptions,
} from '@agent-device/contracts/device';
import { AppError } from '@agent-device/kernel/errors';
import type { DeviceInfo } from '@agent-device/kernel/device';
import type {
LimrunAdbCommandOptions,
LimrunAdbCommandResult,
LimrunAdbProvider,
LimrunPortReverseEndpoint,
LimrunRuntimeDependencies,
} from './runtime-dependencies.ts';
import type { AndroidAdbInvocation } from '@agent-device/platform-android/mechanics';
import { isAttachedLimrunInstanceId } from './instance-access.ts';
import { normalizeOptionalString } from './strings.ts';
import {
awaitLimrunDeploymentOperation,
type LimrunRequestOperationDrain,
} from './request-cancellation.ts';
type LimrunAdbTunnel = Awaited<ReturnType<LimrunAndroidClient['startAdbTunnel']>>;
type LimrunAndroidAdbSession = {
platform: 'android';
lease: DeviceLease;
instanceId: string;
device: DeviceInfo;
client: LimrunAndroidClient;
/** Instance bearer token; the recording download the SDK would run inline is done by the host instead. */
readonly token: string;
adbTunnel?: LimrunAdbTunnel;
adbSerial?: string;
adbTunnelPromise?: Promise<string>;
readonly dependencies: Pick<LimrunRuntimeDependencies, 'android' | 'host'>;
};
export type LimrunAndroidSession = LimrunAndroidAdbSession & {
adbProvider: LimrunAdbProvider;
};
export async function createLimrunAndroidSession(
options: {
lease: DeviceLease;
instanceId: string;
device: DeviceInfo;
apiUrl: string;
adbUrl: string;
token: string;
},
dependencies: Pick<LimrunRuntimeDependencies, 'android' | 'host'>,
): Promise<LimrunAndroidSession> {
const client = await createAndroidInstanceClient({
apiUrl: options.apiUrl,
adbUrl: options.adbUrl,
token: options.token,
logLevel: 'warn',
});
const session: LimrunAndroidAdbSession = {
platform: 'android',
lease: options.lease,
instanceId: options.instanceId,
device: options.device,
client,
token: options.token,
dependencies,
};
const adbProvider: LimrunAdbProvider = {
exec: async (args, execOptions) => await runLimrunAndroidAdb(session, args, execOptions),
text: async (request) => {
await client.setText(request.target, request.text);
},
};
adbProvider.reverse = await dependencies.android.createPortReverse(adbProvider.exec);
return Object.assign(session, { adbProvider });
}
export function createLimrunAndroidInteractor(session: LimrunAndroidSession): Interactor {
return session.dependencies.android.createInteractor(session.device, session.adbProvider);
}
export async function installLimrunAndroidApp(
limrun: Limrun,
session: LimrunAndroidSession,
installablePath: string,
options?: ProviderDeviceInstallOptions,
signal?: AbortSignal,
operationDrain?: LimrunRequestOperationDrain,
): Promise<ProviderDeviceInstallResult> {
signal?.throwIfAborted();
const packageName = normalizeOptionalString(options?.packageNameHint);
if (options?.relaunch && packageName) {
await session.dependencies.android.forceStopApp(
async (adbArgs, adbOptions) => await runLimrunAndroidAdb(session, adbArgs, adbOptions),
packageName,
signal,
);
}
const asset = await awaitLimrunDeploymentOperation(
operationDrain,
limrun.assets.getOrUpload(
{
path: installablePath,
name: buildAndroidAssetName(packageName, installablePath),
},
{ signal },
),
signal,
);
await awaitLimrunDeploymentOperation(
operationDrain,
session.client.sendAsset(asset.signedDownloadUrl),
signal,
);
signal?.throwIfAborted();
const appName = packageName
? await session.dependencies.android.inferAppName(packageName)
: undefined;
return {
...(packageName ? { packageName, launchTarget: packageName } : {}),
...(appName ? { appName } : {}),
};
}
export async function configureLimrunAndroidPortReverse(
session: LimrunAndroidSession,
options: ProviderPortReverseOptions,
): Promise<void> {
await session.adbProvider.reverse?.ensure({
local: tcpEndpoint(options.devicePort),
remote: tcpEndpoint(options.hostPort),
ownerId: options.name,
});
}
export async function cleanupLimrunAndroidAdbTunnel(session: LimrunAndroidSession): Promise<void> {
await session.adbTunnelPromise?.catch(() => {});
const serial = session.adbSerial;
if (serial) {
await cleanupAndroidPortReverse(session);
await session.dependencies.host
.runAdb(session.dependencies.android.hostAdbInvocation(['disconnect', serial]), {
allowFailure: true,
timeoutMs: 10_000,
})
.catch(() => {});
}
session.adbTunnel?.close();
session.adbTunnel = undefined;
session.adbSerial = undefined;
session.adbTunnelPromise = undefined;
}
async function cleanupAndroidPortReverse(session: LimrunAndroidSession): Promise<void> {
const reverse = session.adbProvider.reverse;
if (!reverse?.list) return;
const mappings = await reverse.list().catch(() => []);
const owners = new Set<string>();
const unownedLocals: LimrunPortReverseEndpoint[] = [];
const sharedDevice = isAttachedLimrunInstanceId(session.instanceId);
for (const mapping of mappings) {
if (mapping.ownerId) owners.add(mapping.ownerId);
else if (!sharedDevice) unownedLocals.push(mapping.local);
}
await Promise.allSettled([
...[...owners].map(async (ownerId) => await reverse.removeAllOwned(ownerId)),
...unownedLocals.map(async (local) => await reverse.remove(local)),
]);
}
async function runLimrunAndroidAdb(
session: LimrunAndroidAdbSession,
args: readonly string[],
options?: LimrunAdbCommandOptions,
): Promise<LimrunAdbCommandResult> {
const { invocation, result } = await executeLimrunAndroidAdb(session, args, options);
return await requireSuccessfulLimrunAndroidAdb(
invocation,
result,
options?.allowFailure,
session.dependencies,
);
}
/**
* The tunnel serial is this provider's own addressing decision: it goes on the invocation's
* target, so the command array the Android cluster handed over reaches the host unchanged.
*/
async function executeLimrunAndroidAdb(
session: LimrunAndroidAdbSession,
args: readonly string[],
options?: LimrunAdbCommandOptions,
): Promise<{ invocation: AndroidAdbInvocation; result: LimrunAdbCommandResult }> {
const serial = await ensurePersistentAndroidAdbSerial(session);
const invocation = session.dependencies.android.deviceAdbInvocation(serial, args);
const result = await session.dependencies.host.runAdb(invocation, {
allowFailure: options?.allowFailure,
binaryStdout: options?.binaryStdout,
stdin: options?.stdin,
timeoutMs: options?.timeoutMs ?? 30_000,
signal: options?.signal,
});
return { invocation, result };
}
async function requireSuccessfulLimrunAndroidAdb(
invocation: AndroidAdbInvocation,
result: LimrunAdbCommandResult,
allowFailure: boolean | undefined,
dependencies: Pick<LimrunRuntimeDependencies, 'android'>,
): Promise<LimrunAdbCommandResult> {
if (result.exitCode !== 0 && allowFailure !== true) {
throw await dependencies.android.adbError(
'Limrun Android ADB command failed',
result,
invocation,
);
}
return result;
}
async function ensurePersistentAndroidAdbSerial(session: LimrunAndroidAdbSession): Promise<string> {
if (session.adbSerial) return session.adbSerial;
const pending = session.adbTunnelPromise ?? startAndroidAdbTunnel(session);
session.adbTunnelPromise = pending;
try {
return await pending;
} catch (error) {
if (session.adbTunnelPromise === pending) session.adbTunnelPromise = undefined;
throw error;
}
}
async function startAndroidAdbTunnel(session: LimrunAndroidAdbSession): Promise<string> {
const tunnel = await session.client.startAdbTunnel();
const serial = `${tunnel.address.address}:${tunnel.address.port}`;
session.adbTunnel = tunnel;
session.adbSerial = serial;
return serial;
}
function tcpEndpoint(port: number): LimrunPortReverseEndpoint {
if (!Number.isInteger(port) || port < 1 || port > 65_535) {
throw new AppError('INVALID_ARGS', `Invalid Android tcp reverse port: ${port}`);
}
return `tcp:${port}`;
}
function buildAndroidAssetName(packageName: string | undefined, artifactPath: string): string {
const extension = path.extname(artifactPath) || '.apk';
const prefix = packageName?.replaceAll(/[^a-zA-Z0-9_.-]+/g, '-') || 'android-app';
return `${prefix}${extension}`;
}