Skip to content

Commit 3769fed

Browse files
committed
fix(ios-runner): count nested build_xctestrun once in startup timings total
1 parent 46dae0f commit 3769fed

2 files changed

Lines changed: 71 additions & 2 deletions

File tree

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import assert from 'node:assert/strict';
33
import fs from 'node:fs';
44
import path from 'node:path';
55
import { beforeEach, test, vi } from 'vitest';
6+
import type { DeviceInfo } from '@agent-device/kernel/device';
67
import { IOS_DEVICE, IOS_SIMULATOR } from './device-fixtures.ts';
78
import { appleRunnerTestHost } from '../test-host.ts';
89
import { AppError } from '@agent-device/kernel/errors';
@@ -369,6 +370,67 @@ test('runner session startup diagnostics include logical lease context', async (
369370
assert.match(diagnostics, /"deviceKey":"runner-session-lease-context-sim"/);
370371
});
371372

373+
async function readStartupTimingsDiagnostic(
374+
device: DeviceInfo,
375+
): Promise<{ durationMs: number; timings: Record<string, number> }> {
376+
let reported: { durationMs: number; timings: Record<string, number> } | undefined;
377+
appleRunnerTestHost.update({
378+
emitDiagnostic: (event) => {
379+
if (event.phase !== 'ios_runner_session_startup_timings') return;
380+
reported = {
381+
durationMs: event.durationMs as number,
382+
timings: (event.data as { timings: Record<string, number> }).timings,
383+
};
384+
},
385+
});
386+
const session = await ensureRunnerSession(device, {});
387+
await executeRunnerCommandWithSession(
388+
device,
389+
session,
390+
{ command: 'snapshot', appBundleId: 'com.example.demo' },
391+
'/tmp/runner.log',
392+
30_000,
393+
);
394+
assert.ok(reported, 'expected ios_runner_session_startup_timings');
395+
return reported;
396+
}
397+
398+
const sumValues = (timings: Record<string, number>) =>
399+
Object.values(timings).reduce((sum, value) => sum + value, 0);
400+
401+
test('runner session startup total excludes the build nested in ensure_xctestrun on a cache miss', async () => {
402+
mockWaitForRunner.mockResolvedValue(runnerResponse({ nodes: [], truncated: false }));
403+
404+
const { durationMs, timings } = await readStartupTimingsDiagnostic({
405+
...IOS_SIMULATOR,
406+
id: 'runner-session-timings-miss-sim',
407+
});
408+
409+
assert.equal(timings.build_xctestrun, 12);
410+
assert.equal(durationMs, sumValues(timings) - 12);
411+
});
412+
413+
test('runner session startup total is the plain sum of phases on a cache hit', async () => {
414+
mockEnsureXctestrunArtifact.mockResolvedValue({
415+
xctestrunPath: '/tmp/cached-runner.xctestrun',
416+
derived: '/tmp/derived',
417+
cacheKey: RUNNER_CACHE_KEY_FIXTURE,
418+
cache: 'hit',
419+
artifact: 'valid',
420+
buildMs: 0,
421+
xctestrunPathSource: 'manifest',
422+
});
423+
mockWaitForRunner.mockResolvedValue(runnerResponse({ nodes: [], truncated: false }));
424+
425+
const { durationMs, timings } = await readStartupTimingsDiagnostic({
426+
...IOS_SIMULATOR,
427+
id: 'runner-session-timings-hit-sim',
428+
});
429+
430+
assert.equal(timings.build_xctestrun, 0);
431+
assert.equal(durationMs, sumValues(timings));
432+
});
433+
372434
test('runner session fails early for physical iOS devices when Apple developer mode is disabled', async () => {
373435
const device = { ...IOS_DEVICE, id: 'runner-session-devtools-disabled-device' };
374436
mockDevToolsSecurityDisabled();

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,10 @@ export async function ensureRunnerSession(
154154
/** How long the device-readiness probe may take, bounded by the startup budget it runs inside. */
155155
const RUNNER_DEVICE_READINESS_BUDGET_MS = 10_000;
156156

157+
const BUILD_XCTESTRUN_TIMING = 'build_xctestrun';
158+
/** Timings measured inside another phase: reported per key, never added to the startup total. */
159+
const NESTED_STARTUP_TIMINGS: ReadonlySet<string> = new Set([BUILD_XCTESTRUN_TIMING]);
160+
157161
async function startRunnerSessionWithLease(
158162
device: DeviceInfo,
159163
options: RunnerSessionOptions,
@@ -259,7 +263,7 @@ async function startRunnerSessionWithLease(
259263
budget: createRunnerPhaseBudget(resolveRunnerBuildTimeoutMs(options, budget), signal),
260264
}),
261265
);
262-
startupTimings.build_xctestrun = xctestrunArtifact.buildMs;
266+
startupTimings[BUILD_XCTESTRUN_TIMING] = xctestrunArtifact.buildMs;
263267
endpoint = await measureRunnerStartupStep(startupTimings, 'allocate_port', async () => ({
264268
port: await getFreePort(),
265269
token: mintRunnerToken(),
@@ -908,7 +912,10 @@ async function measureRunnerStartupStep<T>(
908912
function emitRunnerStartupTimings(session: RunnerSession, command: string): void {
909913
if (session.startupTimingsReported || !session.startupTimings) return;
910914
session.startupTimingsReported = true;
911-
const totalMs = Object.values(session.startupTimings).reduce((sum, value) => sum + value, 0);
915+
const totalMs = Object.entries(session.startupTimings).reduce(
916+
(sum, [phase, ms]) => (NESTED_STARTUP_TIMINGS.has(phase) ? sum : sum + ms),
917+
0,
918+
);
912919
emitDiagnostic({
913920
level: 'info',
914921
phase: 'ios_runner_session_startup_timings',

0 commit comments

Comments
 (0)