Skip to content

Commit 721aa68

Browse files
committed
fix(ios): retire the acquired snapshot socket consistently
1 parent 24547b0 commit 721aa68

2 files changed

Lines changed: 25 additions & 24 deletions

File tree

‎packages/platform-apple/src/snapshot-source/lifecycle-socket.test.ts‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import net from 'node:net';
33
import path from 'node:path';
44
import { once } from 'node:events';
55
import { test } from 'vitest';
6+
import { SnapshotSourceError } from '@agent-device/capture-kit/snapshot-source-channel';
67
import { createLiveTestHostEnvironment, mkdtempForTestSync } from '@agent-device/test-kit';
78
import { createSnapshotSourceHost } from './host.ts';
89
import { SnapshotBridgeManager } from './lifecycle.ts';
@@ -32,6 +33,7 @@ test('local socket closure between requests and in flight permits later acquisit
3233
const socketPath = path.join(mkdtempForTestSync('bridge-socket-'), 's');
3334
const peers: net.Socket[] = [];
3435
let reply = true;
36+
let receivedRequests = 0;
3537
server.on('connection', (peer) => {
3638
peers.push(peer);
3739
let buffered = Buffer.alloc(0);
@@ -40,6 +42,7 @@ test('local socket closure between requests and in flight permits later acquisit
4042
if (buffered.length < 4 || buffered.length < buffered.readUInt32BE(0) + 4) return;
4143
const size = buffered.readUInt32BE(0);
4244
const request = JSON.parse(buffered.subarray(4, size + 4).toString());
45+
receivedRequests += 1;
4346
buffered = buffered.subarray(size + 4);
4447
if (!reply) {
4548
peer.destroy();
@@ -82,17 +85,18 @@ test('local socket closure between requests and in flight permits later acquisit
8285
await request();
8386
assert.equal(peers.length, 2);
8487
reply = false;
85-
let settlements = 0;
8688
await assert.rejects(
87-
request().finally(() => {
88-
settlements++;
89-
}),
89+
request(),
90+
(error: unknown) =>
91+
error instanceof SnapshotSourceError &&
92+
error.failureKind === 'transport-failure' &&
93+
error.failureCode === 'bridge-connection-closed',
9094
);
91-
await new Promise<void>((resolve) => setImmediate(resolve));
92-
assert.equal(settlements, 1);
95+
assert.equal(receivedRequests, 3);
9396
reply = true;
9497
await request();
9598
assert.equal(peers.length, 3);
99+
assert.equal(receivedRequests, 4);
96100
} finally {
97101
await manager.close();
98102
for (const peer of peers) peer.destroy();

‎packages/platform-apple/src/snapshot-source/lifecycle.ts‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,7 @@ export class SnapshotBridgeManager {
140140
} else if (normalized.failureKind === 'process-crash') {
141141
await this.removeSession(session, false);
142142
} else if (normalized.failureKind === 'transport-failure') {
143-
session.socket?.destroy();
144-
session.socket = undefined;
143+
retireBridgeSocket(session);
145144
}
146145
return normalized;
147146
}
@@ -386,17 +385,11 @@ export class SnapshotBridgeManager {
386385
if (stop.aborted) throw closedSourceRefusal();
387386
throw snapshotSourceError('cancelled', 'abort-signal');
388387
}
389-
const invalidate = () => {
390-
if (session.socket === socket) session.socket = undefined;
391-
};
392-
const onError = () => {
393-
invalidate();
394-
socket.destroy();
395-
};
388+
const onError = () => retireBridgeSocket(session, socket);
396389
const onClose = () => {
397-
invalidate();
398390
socket.off('error', onError);
399391
socket.off('close', onClose);
392+
retireBridgeSocket(session, socket);
400393
};
401394
socket.on('error', onError);
402395
socket.on('close', onClose);
@@ -482,14 +475,14 @@ export class SnapshotBridgeManager {
482475
deadline: SnapshotSourceDeadline,
483476
turn: OwnedWork,
484477
): Promise<SnapshotBridgeEnvelope> {
485-
if (!session.socket || session.socket.destroyed) {
486-
await this.connectUntilReady(session, deadline, turn.interrupt.signal);
487-
}
488-
const socket = session.socket;
489-
if (!socket || socket.destroyed)
490-
throw snapshotSourceError('transport-failure', 'bridge-connection-closed');
478+
const socket =
479+
session.socket && !session.socket.destroyed
480+
? session.socket
481+
: await this.connectUntilReady(session, deadline, turn.interrupt.signal);
491482
// Nothing is sent once a close owns this turn: the bridge it would reach is being stopped.
492483
if (refusedByClose(this.closed, turn)) throw closedSourceRefusal();
484+
if (socket.destroyed)
485+
throw snapshotSourceError('transport-failure', 'bridge-connection-closed');
493486
const requestId = randomUUID();
494487
const request = createSnapshotBridgeDescribeRequest({
495488
requestId,
@@ -574,8 +567,7 @@ export class SnapshotBridgeManager {
574567
}
575568

576569
private async dispose(session: BridgeSession, stopProcess: boolean): Promise<void> {
577-
session.socket?.destroy();
578-
session.socket = undefined;
570+
retireBridgeSocket(session);
579571
if (stopProcess && session.process.isAlive()) {
580572
session.process.signal('SIGTERM');
581573
await waitForProcess(session.process, SHUTDOWN_TERM_TIMEOUT_MS);
@@ -588,6 +580,11 @@ export class SnapshotBridgeManager {
588580
}
589581
}
590582

583+
function retireBridgeSocket(session: BridgeSession, socket = session.socket): void {
584+
if (session.socket === socket) session.socket = undefined;
585+
socket?.destroy();
586+
}
587+
591588
function liveSession(entry: BridgeEntry | undefined): BridgeSession | undefined {
592589
return entry?.phase === 'live' ? entry.session : undefined;
593590
}

0 commit comments

Comments
 (0)