|
1 | 1 | import assert from 'node:assert/strict'; |
2 | 2 | import type { ExecResult } from '@agent-device/host-kit/command'; |
| 3 | +import { createRequestCanceledError, isRequestCanceledError } from '@agent-device/kernel/errors'; |
| 4 | +import { withKeyedLock } from '@agent-device/kernel/keyed-lock'; |
3 | 5 | import { afterEach, test } from 'vitest'; |
4 | 6 | import { executeRunnerExchange } from '../runner-exchange.ts'; |
5 | 7 | import { RunnerCommandAccounting, type RunnerSession } from '../runner-session-types.ts'; |
6 | 8 | import { IOS_SIMULATOR } from './device-fixtures.ts'; |
7 | | -import { startFakeRunnerServer, type FakeRunnerServer } from './fake-runner-server.ts'; |
| 9 | +import { |
| 10 | + startFakeRunnerServer, |
| 11 | + type FakeRunnerResponse, |
| 12 | + type FakeRunnerServer, |
| 13 | +} from './fake-runner-server.ts'; |
8 | 14 |
|
9 | 15 | let server: FakeRunnerServer | undefined; |
10 | 16 |
|
@@ -184,3 +190,202 @@ test('the exchange awaits owner invalidation before throwing a fatal runner erro |
184 | 190 | } |
185 | 191 | await assert.rejects(exchange); |
186 | 192 | }); |
| 193 | + |
| 194 | +const LONG_PRESS = { |
| 195 | + command: 'longPress', |
| 196 | + x: 10, |
| 197 | + y: 10, |
| 198 | + durationMs: 5_000, |
| 199 | + appBundleId: 'com.example.app', |
| 200 | +} as const; |
| 201 | + |
| 202 | +function journalState(lifecycleState: string): FakeRunnerResponse { |
| 203 | + return { kind: 'ok', data: { lifecycleState } }; |
| 204 | +} |
| 205 | + |
| 206 | +async function abortOnceReceived( |
| 207 | + runner: FakeRunnerServer, |
| 208 | + command: string, |
| 209 | + controller: AbortController, |
| 210 | + reason: unknown = createRequestCanceledError(), |
| 211 | +): Promise<void> { |
| 212 | + while (!runner.requests.some((request) => request.command === command)) { |
| 213 | + await new Promise<void>((resolve) => setTimeout(resolve, 1)); |
| 214 | + } |
| 215 | + controller.abort(reason); |
| 216 | +} |
| 217 | + |
| 218 | +function statusPolls(runner: FakeRunnerServer): unknown[] { |
| 219 | + return runner.requests |
| 220 | + .filter((request) => request.command === 'status') |
| 221 | + .map((request) => request.body.statusCommandId); |
| 222 | +} |
| 223 | + |
| 224 | +function sentCommandId(runner: FakeRunnerServer, command: string): unknown { |
| 225 | + return runner.requests.find((request) => request.command === command)?.body.commandId; |
| 226 | +} |
| 227 | + |
| 228 | +test('a canceled exchange whose command reached the runner settles only once its journal entry is terminal', async () => { |
| 229 | + server = await startFakeRunnerServer({ |
| 230 | + longPress: [{ kind: 'hold' }], |
| 231 | + status: [journalState('started'), journalState('completed')], |
| 232 | + }); |
| 233 | + const runner = server; |
| 234 | + const session = sessionFor(runner.port); |
| 235 | + const controller = new AbortController(); |
| 236 | + let requestsWhenSettled = -1; |
| 237 | + |
| 238 | + const exchange = executeRunnerExchange( |
| 239 | + IOS_SIMULATOR, |
| 240 | + session, |
| 241 | + LONG_PRESS, |
| 242 | + undefined, |
| 243 | + 10_000, |
| 244 | + async () => {}, |
| 245 | + controller.signal, |
| 246 | + ).finally(() => { |
| 247 | + requestsWhenSettled = runner.requests.length; |
| 248 | + }); |
| 249 | + await abortOnceReceived(runner, 'longPress', controller); |
| 250 | + |
| 251 | + await assert.rejects(exchange, isRequestCanceledError); |
| 252 | + const commandId = sentCommandId(runner, 'longPress'); |
| 253 | + assert.deepEqual(statusPolls(runner), [commandId, commandId]); |
| 254 | + assert.equal(requestsWhenSettled, runner.requests.length); |
| 255 | + assert.equal(session.commandCharges.hasOutstandingCharges, false); |
| 256 | +}); |
| 257 | + |
| 258 | +test('a request on the same session lock starts only after the canceled command is terminal', async () => { |
| 259 | + server = await startFakeRunnerServer({ |
| 260 | + longPress: [{ kind: 'hold' }], |
| 261 | + status: [journalState('accepted'), journalState('started'), journalState('failed')], |
| 262 | + }); |
| 263 | + const runner = server; |
| 264 | + const session = sessionFor(runner.port); |
| 265 | + const locks = new Map<string, Promise<unknown>>(); |
| 266 | + const controller = new AbortController(); |
| 267 | + |
| 268 | + const canceled = withKeyedLock(locks, 'session:default', async () => { |
| 269 | + await executeRunnerExchange( |
| 270 | + IOS_SIMULATOR, |
| 271 | + session, |
| 272 | + LONG_PRESS, |
| 273 | + undefined, |
| 274 | + 10_000, |
| 275 | + async () => {}, |
| 276 | + controller.signal, |
| 277 | + ); |
| 278 | + }); |
| 279 | + await abortOnceReceived(runner, 'longPress', controller); |
| 280 | + const nextRequestSawPolls = withKeyedLock(locks, 'session:default', async () => |
| 281 | + statusPolls(runner), |
| 282 | + ); |
| 283 | + |
| 284 | + await assert.rejects(canceled, isRequestCanceledError); |
| 285 | + assert.equal((await nextRequestSawPolls).length, 3); |
| 286 | + assert.equal(session.commandCharges.hasOutstandingCharges, false); |
| 287 | +}); |
| 288 | + |
| 289 | +test('a request canceled before its command is sent releases without reading the journal', async () => { |
| 290 | + server = await startFakeRunnerServer({}); |
| 291 | + const session = sessionFor(server.port); |
| 292 | + session.lastHealthyMutation = { atMs: Date.now(), appBundleId: LONG_PRESS.appBundleId }; |
| 293 | + const controller = new AbortController(); |
| 294 | + controller.abort(createRequestCanceledError()); |
| 295 | + |
| 296 | + await assert.rejects( |
| 297 | + executeRunnerExchange( |
| 298 | + IOS_SIMULATOR, |
| 299 | + session, |
| 300 | + LONG_PRESS, |
| 301 | + undefined, |
| 302 | + 10_000, |
| 303 | + async () => {}, |
| 304 | + controller.signal, |
| 305 | + ), |
| 306 | + isRequestCanceledError, |
| 307 | + ); |
| 308 | + |
| 309 | + assert.deepEqual(server.requests, []); |
| 310 | + assert.equal(session.commandCharges.hasOutstandingCharges, false); |
| 311 | +}); |
| 312 | + |
| 313 | +test('a canceled command the journal never accepted releases after one read and stays abandoned', async () => { |
| 314 | + server = await startFakeRunnerServer({ |
| 315 | + longPress: [{ kind: 'hold' }], |
| 316 | + status: [journalState('notAccepted')], |
| 317 | + }); |
| 318 | + const session = sessionFor(server.port); |
| 319 | + const controller = new AbortController(); |
| 320 | + |
| 321 | + const exchange = executeRunnerExchange( |
| 322 | + IOS_SIMULATOR, |
| 323 | + session, |
| 324 | + LONG_PRESS, |
| 325 | + undefined, |
| 326 | + 10_000, |
| 327 | + async () => {}, |
| 328 | + controller.signal, |
| 329 | + ); |
| 330 | + await abortOnceReceived(server, 'longPress', controller); |
| 331 | + |
| 332 | + await assert.rejects(exchange, isRequestCanceledError); |
| 333 | + assert.equal(statusPolls(server).length, 1); |
| 334 | + assert.equal(session.commandCharges.hasAbandonedCharges, true); |
| 335 | +}); |
| 336 | + |
| 337 | +test('a drain that outlives the command deadline settles and leaves the charge abandoned', async () => { |
| 338 | + server = await startFakeRunnerServer({ |
| 339 | + longPress: [{ kind: 'hold' }], |
| 340 | + status: Array.from({ length: 50 }, () => journalState('started')), |
| 341 | + }); |
| 342 | + const session = sessionFor(server.port); |
| 343 | + const controller = new AbortController(); |
| 344 | + const timeoutMs = 300; |
| 345 | + const startedAtMs = Date.now(); |
| 346 | + |
| 347 | + const exchange = executeRunnerExchange( |
| 348 | + IOS_SIMULATOR, |
| 349 | + session, |
| 350 | + LONG_PRESS, |
| 351 | + undefined, |
| 352 | + timeoutMs, |
| 353 | + async () => {}, |
| 354 | + controller.signal, |
| 355 | + ); |
| 356 | + await abortOnceReceived(server, 'longPress', controller); |
| 357 | + |
| 358 | + await assert.rejects(exchange, isRequestCanceledError); |
| 359 | + assert.ok(statusPolls(server).length >= 1); |
| 360 | + assert.ok(Date.now() - startedAtMs < timeoutMs + 1_000); |
| 361 | + assert.equal(session.commandCharges.hasAbandonedCharges, true); |
| 362 | +}); |
| 363 | + |
| 364 | +test("a caller's own deadline abort does not wait on the runner journal", async () => { |
| 365 | + server = await startFakeRunnerServer({ |
| 366 | + longPress: [{ kind: 'hold' }], |
| 367 | + status: [journalState('started'), journalState('completed')], |
| 368 | + }); |
| 369 | + const session = sessionFor(server.port); |
| 370 | + const controller = new AbortController(); |
| 371 | + |
| 372 | + const exchange = executeRunnerExchange( |
| 373 | + IOS_SIMULATOR, |
| 374 | + session, |
| 375 | + LONG_PRESS, |
| 376 | + undefined, |
| 377 | + 10_000, |
| 378 | + async () => {}, |
| 379 | + controller.signal, |
| 380 | + ); |
| 381 | + await abortOnceReceived( |
| 382 | + server, |
| 383 | + 'longPress', |
| 384 | + controller, |
| 385 | + new DOMException('Wait deadline exceeded', 'TimeoutError'), |
| 386 | + ); |
| 387 | + |
| 388 | + await assert.rejects(exchange); |
| 389 | + assert.deepEqual(statusPolls(server), []); |
| 390 | + assert.equal(session.commandCharges.hasAbandonedCharges, true); |
| 391 | +}); |
0 commit comments