Skip to content

Commit 57678db

Browse files
committed
fix(apple): preserve runner preflight state and await invalidation
1 parent a8cfe66 commit 57678db

2 files changed

Lines changed: 121 additions & 9 deletions

File tree

‎packages/platform-apple/src/runner/__tests__/runner-exchange.test.ts‎

Lines changed: 108 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,29 +57,130 @@ test('the exchange preflights a mutation and settles only its answer', async ()
5757
assert.deepEqual(invalidations, []);
5858
});
5959

60+
test('the readiness probe preserves its main-thread busy report when the command omits it', async () => {
61+
server = await startFakeRunnerServer({
62+
uptime: [{ kind: 'ok', data: { runnerMainThreadBusy: true } }],
63+
tap: [{ kind: 'ok', data: { tapped: true } }],
64+
});
65+
const session = sessionFor(server.port);
66+
67+
await executeRunnerExchange(
68+
IOS_SIMULATOR,
69+
session,
70+
{ command: 'tap', x: 10, y: 10, appBundleId: 'com.example.app' },
71+
undefined,
72+
10_000,
73+
async () => {},
74+
);
75+
76+
assert.equal(session.runnerMainThreadBusy, true);
77+
});
78+
79+
test('a preflight-exempt command still waits for a starting runner', async () => {
80+
server = await startFakeRunnerServer({
81+
uptime: [{ kind: 'ok', data: { uptimeMs: 5 } }],
82+
terminate: [{ kind: 'ok', data: { terminated: true } }],
83+
});
84+
const session = sessionFor(server.port);
85+
session.state = 'starting';
86+
87+
await executeRunnerExchange(
88+
IOS_SIMULATOR,
89+
session,
90+
{ command: 'terminate', appBundleId: 'com.example.app' },
91+
undefined,
92+
10_000,
93+
async () => {},
94+
);
95+
96+
assert.deepEqual(
97+
server.requests.map(({ command }) => command),
98+
['uptime', 'terminate'],
99+
);
100+
});
101+
60102
test('the exchange awaits owner invalidation before returning a fatal answer', async () => {
61103
server = await startFakeRunnerServer({
62104
snapshot: [{ kind: 'ok', data: { runnerFatal: true, runnerFatalReason: 'ax_failed' } }],
63105
});
64106
const session = sessionFor(server.port);
65107
session.lastHealthyMutation = { atMs: Date.now(), appBundleId: 'com.example.app' };
66-
const order: string[] = [];
108+
let signalInvalidationStarted!: () => void;
109+
const invalidationStarted = new Promise<void>((resolve) => {
110+
signalInvalidationStarted = resolve;
111+
});
112+
let releaseInvalidation!: () => void;
113+
const invalidationGate = new Promise<void>((resolve) => {
114+
releaseInvalidation = resolve;
115+
});
116+
let settled = false;
67117

68-
const result = await executeRunnerExchange(
118+
const exchange = executeRunnerExchange(
69119
IOS_SIMULATOR,
70120
session,
71121
{ command: 'snapshot', appBundleId: 'com.example.app' },
72122
undefined,
73123
10_000,
74124
async (reason) => {
75-
await Promise.resolve();
76-
order.push(reason);
125+
assert.equal(reason, 'ax_failed');
126+
signalInvalidationStarted();
127+
await invalidationGate;
77128
},
78-
);
79-
order.push('returned');
129+
).finally(() => {
130+
settled = true;
131+
});
132+
133+
try {
134+
await invalidationStarted;
135+
await new Promise<void>((resolve) => setImmediate(resolve));
136+
assert.equal(settled, false);
137+
} finally {
138+
releaseInvalidation();
139+
}
140+
const result = await exchange;
80141

81142
assert.equal(result.runnerFatal, true);
82-
assert.deepEqual(order, ['ax_failed', 'returned']);
83143
assert.equal(session.lastHealthyMutation, undefined);
84144
assert.equal(session.commandCharges.hasOutstandingCharges, false);
85145
});
146+
147+
test('the exchange awaits owner invalidation before throwing a fatal runner error', async () => {
148+
server = await startFakeRunnerServer({
149+
snapshot: [{ kind: 'runnerError', code: 'RUNNER_WEDGED', message: 'runner wedged' }],
150+
});
151+
const session = sessionFor(server.port);
152+
let signalInvalidationStarted!: () => void;
153+
const invalidationStarted = new Promise<void>((resolve) => {
154+
signalInvalidationStarted = resolve;
155+
});
156+
let releaseInvalidation!: () => void;
157+
const invalidationGate = new Promise<void>((resolve) => {
158+
releaseInvalidation = resolve;
159+
});
160+
let settled = false;
161+
162+
const exchange = executeRunnerExchange(
163+
IOS_SIMULATOR,
164+
session,
165+
{ command: 'snapshot', appBundleId: 'com.example.app' },
166+
undefined,
167+
10_000,
168+
async (reason) => {
169+
assert.equal(reason, 'runner_main_thread_wedged');
170+
signalInvalidationStarted();
171+
await invalidationGate;
172+
},
173+
).finally(() => {
174+
settled = true;
175+
});
176+
void exchange.catch(() => {});
177+
178+
try {
179+
await invalidationStarted;
180+
await new Promise<void>((resolve) => setImmediate(resolve));
181+
assert.equal(settled, false);
182+
} finally {
183+
releaseInvalidation();
184+
}
185+
await assert.rejects(exchange);
186+
});

‎packages/platform-apple/src/runner/runner-exchange.ts‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,11 @@ async function runRunnerReadinessPreflight(params: {
327327
timeoutMs: readinessTimeoutMs,
328328
},
329329
);
330-
await parseRunnerResponse(readinessResponse, session, logAttempt);
330+
const readinessData = await parseRunnerResponse(readinessResponse, session, logAttempt);
331+
const stampedMainThreadBusy = readRunnerMainThreadBusy(readinessData);
332+
if (stampedMainThreadBusy !== undefined) {
333+
session.runnerMainThreadBusy = stampedMainThreadBusy;
334+
}
331335
} catch (error) {
332336
throw markRunnerReadinessPreflightError(error);
333337
}
@@ -406,7 +410,7 @@ function resolveRunnerReadinessPreflightDecision(
406410
command: RunnerCommand,
407411
): RunnerReadinessPreflightDecision {
408412
const readOnlyCommand = isReadOnlyRunnerCommand(command);
409-
if (isRunnerReadinessPreflightExempt(command)) {
413+
if (canSkipReadySessionPreflightForExemptCommand(session, command)) {
410414
return { action: 'skip', reason: 'preflight_exempt_command' };
411415
}
412416
if (session.state !== 'ready') {
@@ -464,6 +468,13 @@ function resolveRunnerReadinessPreflightDecision(
464468
};
465469
}
466470

471+
function canSkipReadySessionPreflightForExemptCommand(
472+
session: RunnerExchangeSession,
473+
command: RunnerCommand,
474+
): boolean {
475+
return session.state === 'ready' && isRunnerReadinessPreflightExempt(command);
476+
}
477+
467478
function markRunnerReadinessPreflightError(error: unknown): AppError {
468479
return markRunnerPreflightError(error, {
469480
runnerReadinessPreflightFailed: true,

0 commit comments

Comments
 (0)