Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 64 additions & 19 deletions src/platforms/android/__tests__/snapshot-helper-session.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,48 @@ test('starts and reuses a persistent Android snapshot helper session', async ()
);
});

test('allows a persistent session snapshot to use the helper command budget', async () => {
const calls: string[][] = [];
// The delay must stay above the previous 3s session cap to guard the regression.
const provider = createSessionProvider({ calls, responseDelayMs: 3_200 });

const output = await captureAndroidSnapshotWithHelperSession({
adb: provider.exec,
adbProvider: provider,
deviceKey: 'android:emulator-5554',
timeoutMs: 10,
commandTimeoutMs: 4_000,
});

assert.match(output?.xml ?? '', /snapshot 1/);
assert.equal(output?.metadata.transport, 'persistent-session');
assert.equal(output?.metadata.sessionReused, false);
});

test('caps a persistent session snapshot at the helper command budget', async () => {
const calls: string[][] = [];
const provider = createSessionProvider({ calls, responseDelayMs: 50 });

await assert.rejects(
() =>
captureAndroidSnapshotWithHelperSession({
adb: provider.exec,
adbProvider: provider,
deviceKey: 'android:emulator-5554',
timeoutMs: 10,
commandTimeoutMs: 20,
}),
(error) => {
assert.equal((error as Error).message, 'Android snapshot helper session request timed out');
const details = (error as { details?: Record<string, unknown> }).details;
assert.equal(details?.timeoutMs, 20);
assert.match(String(details?.command), /^snapshot snapshot-/);
assert.equal(typeof details?.port, 'number');
return true;
},
);
});

test('restarts the helper session when capture options change', async () => {
const calls: string[][] = [];
const spawnArgs: string[][] = [];
Expand Down Expand Up @@ -165,6 +207,7 @@ function createSessionProvider(options: {
calls: string[][];
spawnArgs?: string[][];
responseMode?: 'ok' | 'malformed';
responseDelayMs?: number;
}): AndroidAdbProvider {
return {
exec: async (args) => {
Expand All @@ -191,25 +234,27 @@ function createSessionProvider(options: {
}
snapshotCount += 1;
const body = `<hierarchy><node text="snapshot ${snapshotCount}" /></hierarchy>`;
socket.end(
sessionResponse({
requestId,
body,
metadata: {
waitForIdleTimeoutMs: '25',
waitForIdleQuietMs: '25',
timeoutMs: '5000',
maxDepth: '128',
maxNodes: '5000',
rootPresent: 'true',
captureMode: 'interactive-windows',
windowCount: '1',
nodeCount: '1',
truncated: 'false',
elapsedMs: '7',
},
}),
);
setTimeout(() => {
socket.end(
sessionResponse({
requestId,
body,
metadata: {
waitForIdleTimeoutMs: '25',
waitForIdleQuietMs: '25',
timeoutMs: '5000',
maxDepth: '128',
maxNodes: '5000',
rootPresent: 'true',
captureMode: 'interactive-windows',
windowCount: '1',
nodeCount: '1',
truncated: 'false',
elapsedMs: '7',
},
}),
);
}, options.responseDelayMs ?? 0);
});
});
server.listen(port, '127.0.0.1', () => {
Expand Down
8 changes: 7 additions & 1 deletion src/platforms/android/snapshot-helper-session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
const SESSION_READY_TIMEOUT_MS = 10_000;
const SESSION_STOP_TIMEOUT_MS = 1_000;
const SESSION_PROCESS_EXIT_TIMEOUT_MS = 2_000;
const SESSION_REQUEST_OVERHEAD_MS = 10_000;
const FORWARD_TIMEOUT_MS = 5_000;

type AndroidSnapshotHelperSession = {
Expand Down Expand Up @@ -248,7 +249,12 @@ async function requestSessionSnapshot(
resolved: AndroidSnapshotHelperResolvedCaptureOptions,
): Promise<AndroidSnapshotHelperOutput> {
const requestId = `snapshot-${Date.now()}-${Math.random().toString(16).slice(2)}`;
const timeoutMs = Math.max(resolved.timeoutMs + 2_000, 3_000);
// Keep the session request generous enough for slow UIAutomator captures, but never
// beyond the command budget the caller already assigned to this snapshot.
const timeoutMs = Math.min(
resolved.commandTimeoutMs,
Math.max(resolved.timeoutMs + SESSION_REQUEST_OVERHEAD_MS, 3_000),
);
const response = await sendSessionCommand(session, `snapshot ${requestId}`, timeoutMs);
return parseSessionSnapshotResponse(response, requestId);
}
Expand Down
4 changes: 3 additions & 1 deletion src/platforms/android/snapshot-helper-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ export const ANDROID_SNAPSHOT_HELPER_RUNNER =
'com.callstack.agentdevice.snapshothelper/.SnapshotInstrumentation';
export const ANDROID_SNAPSHOT_HELPER_PROTOCOL = 'android-snapshot-helper-v1';
export const ANDROID_SNAPSHOT_HELPER_OUTPUT_FORMAT = 'uiautomator-xml';
export const ANDROID_SNAPSHOT_HELPER_WAIT_FOR_IDLE_TIMEOUT_MS = 500;
// Daemon-side stabilization handles post-gesture settling; helper idle waits can
// stall on app-owned continuous animations such as React Navigation drawers.
export const ANDROID_SNAPSHOT_HELPER_WAIT_FOR_IDLE_TIMEOUT_MS = 0;
export const ANDROID_SNAPSHOT_HELPER_WAIT_FOR_IDLE_QUIET_MS = 100;
export const ANDROID_SNAPSHOT_HELPER_COMMAND_OVERHEAD_MS = 5_000;

Expand Down
Loading