Skip to content

Commit fb2a21b

Browse files
committed
Own bridge socket errors for the connection lifetime
1 parent 799e9c0 commit fb2a21b

3 files changed

Lines changed: 148 additions & 7 deletions

File tree

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,6 @@ async function connectSnapshotBridge(
118118
connected = true;
119119
clearTimeout(timer);
120120
options.signal?.removeEventListener('abort', onAbort);
121-
socket.off('error', onError);
122-
socket.off('close', onClose);
123121
socket.setTimeout(0);
124122
resolve(socket);
125123
};
@@ -128,6 +126,7 @@ async function connectSnapshotBridge(
128126
socket.destroy();
129127
};
130128
const onClose = () => {
129+
socket.off('error', onError);
131130
if (!connected)
132131
finish(snapshotSourceError('transport-failure', 'bridge-closed-before-connect'));
133132
};
@@ -142,7 +141,7 @@ async function connectSnapshotBridge(
142141
reject(error);
143142
};
144143
socket.once('connect', onConnect);
145-
socket.once('error', onError);
144+
socket.on('error', onError);
146145
socket.once('close', onClose);
147146
options.signal?.addEventListener('abort', onAbort, { once: true });
148147
if (options.signal?.aborted) onAbort();
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
import assert from 'node:assert/strict';
2+
import net from 'node:net';
3+
import path from 'node:path';
4+
import { once } from 'node:events';
5+
import { test } from 'vitest';
6+
import { createLiveTestHostEnvironment, mkdtempForTestSync } from '@agent-device/test-kit';
7+
import { createSnapshotSourceHost } from './host.ts';
8+
import { SnapshotBridgeManager } from './lifecycle.ts';
9+
import {
10+
encodeSnapshotBridgeFrame,
11+
SNAPSHOT_SOURCE_PROTOCOL_VERSION,
12+
SNAPSHOT_SOURCE_VERSION,
13+
} from './protocol.ts';
14+
import { bridge, createLifecycleFixture, deadline, limits, target } from './lifecycle.fixtures.ts';
15+
16+
test('a connected local socket owns errors before any request', async () => {
17+
const server = net.createServer();
18+
const socketPath = path.join(mkdtempForTestSync('bridge-socket-'), 's');
19+
server.listen(socketPath);
20+
await once(server, 'listening');
21+
const host = createSnapshotSourceHost(createLiveTestHostEnvironment());
22+
const socket = await host.connect(socketPath, { timeoutMs: 1000 });
23+
const closed = new Promise<void>((resolve) => socket.once('close', () => resolve()));
24+
socket.destroy(new Error('reset after connect'));
25+
await closed;
26+
assert.equal(socket.destroyed, true);
27+
await new Promise<void>((resolve) => server.close(() => resolve()));
28+
});
29+
30+
test('local socket closure between requests and in flight permits later acquisition', async () => {
31+
const server = net.createServer();
32+
const socketPath = path.join(mkdtempForTestSync('bridge-socket-'), 's');
33+
const peers: net.Socket[] = [];
34+
let reply = true;
35+
server.on('connection', (peer) => {
36+
peers.push(peer);
37+
let buffered = Buffer.alloc(0);
38+
peer.on('data', (chunk) => {
39+
buffered = Buffer.concat([buffered, chunk]);
40+
if (buffered.length < 4 || buffered.length < buffered.readUInt32BE(0) + 4) return;
41+
const size = buffered.readUInt32BE(0);
42+
const request = JSON.parse(buffered.subarray(4, size + 4).toString());
43+
buffered = buffered.subarray(size + 4);
44+
if (!reply) {
45+
peer.destroy();
46+
return;
47+
}
48+
peer.write(
49+
encodeSnapshotBridgeFrame(
50+
{
51+
protocolVersion: SNAPSHOT_SOURCE_PROTOCOL_VERSION,
52+
sourceVersion: SNAPSHOT_SOURCE_VERSION,
53+
requestId: request.requestId,
54+
ok: true,
55+
pid: request.pid,
56+
generation: request.generation,
57+
truncated: false,
58+
automationEnabled: true,
59+
tree: { XC_kAXXCAttributeElementType: 'Application', XC_kAXXCAttributeChildren: [] },
60+
},
61+
limits,
62+
),
63+
);
64+
});
65+
});
66+
server.listen(socketPath);
67+
await once(server, 'listening');
68+
const fixture = createLifecycleFixture();
69+
const realHost = createSnapshotSourceHost(createLiveTestHostEnvironment());
70+
const manager = new SnapshotBridgeManager({
71+
...fixture.host,
72+
connect: (_path, options) => realHost.connect(socketPath, options),
73+
});
74+
const request = () =>
75+
manager.request({ target, bridge, limits, maxDepth: 10, deadline: deadline(undefined, 5000) });
76+
try {
77+
await request();
78+
const closed = once(peers[0]!, 'close');
79+
peers[0]!.destroy();
80+
await closed;
81+
await new Promise<void>((resolve) => setImmediate(resolve));
82+
await request();
83+
assert.equal(peers.length, 2);
84+
reply = false;
85+
let settlements = 0;
86+
await assert.rejects(
87+
request().finally(() => {
88+
settlements++;
89+
}),
90+
);
91+
await new Promise<void>((resolve) => setImmediate(resolve));
92+
assert.equal(settlements, 1);
93+
reply = true;
94+
await request();
95+
assert.equal(peers.length, 3);
96+
} finally {
97+
await manager.close();
98+
for (const peer of peers) peer.destroy();
99+
await new Promise<void>((resolve) => server.close(() => resolve()));
100+
}
101+
});
102+
103+
test('a late error from an older socket does not invalidate its replacement', async () => {
104+
const fixture = createLifecycleFixture();
105+
const manager = new SnapshotBridgeManager(fixture.host);
106+
const request = () =>
107+
manager.request({ target, bridge, limits, maxDepth: 10, deadline: deadline(undefined, 5000) });
108+
try {
109+
await request();
110+
const old = fixture.sockets[0]!;
111+
old.destroy = () => {
112+
old.destroyed = true;
113+
};
114+
old.emit('error', new Error('first reset'));
115+
await request();
116+
old.emit('error', new Error('late reset'));
117+
await request();
118+
assert.equal(fixture.sockets.length, 2);
119+
assert.equal(fixture.sockets[1]!.writes, 2);
120+
old.emit('close');
121+
} finally {
122+
await manager.close();
123+
}
124+
});

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

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ export class SnapshotBridgeManager {
220220
if (existing) {
221221
if (existing.bridgePath === input.bridge.path && existing.process.isAlive()) {
222222
if (!existing.socket || existing.socket.destroyed) {
223-
existing.socket = await this.connectUntilReady(existing, deadline, turn.interrupt.signal);
223+
await this.connectUntilReady(existing, deadline, turn.interrupt.signal);
224224
}
225225
return existing;
226226
}
@@ -330,7 +330,7 @@ export class SnapshotBridgeManager {
330330
};
331331
entry.session = session;
332332
try {
333-
session.socket = await this.connectUntilReady(session, deadline, creation.interrupt.signal);
333+
await this.connectUntilReady(session, deadline, creation.interrupt.signal);
334334
assertOpen();
335335
this.entries.set(udid, { phase: 'live', session });
336336
return session;
@@ -386,6 +386,21 @@ export class SnapshotBridgeManager {
386386
if (stop.aborted) throw closedSourceRefusal();
387387
throw snapshotSourceError('cancelled', 'abort-signal');
388388
}
389+
const invalidate = () => {
390+
if (session.socket === socket) session.socket = undefined;
391+
};
392+
const onError = () => {
393+
invalidate();
394+
socket.destroy();
395+
};
396+
const onClose = () => {
397+
invalidate();
398+
socket.off('error', onError);
399+
socket.off('close', onClose);
400+
};
401+
socket.on('error', onError);
402+
socket.on('close', onClose);
403+
session.socket = socket;
389404
return socket;
390405
}
391406
}
@@ -468,8 +483,11 @@ export class SnapshotBridgeManager {
468483
turn: OwnedWork,
469484
): Promise<SnapshotBridgeEnvelope> {
470485
if (!session.socket || session.socket.destroyed) {
471-
session.socket = await this.connectUntilReady(session, deadline, turn.interrupt.signal);
486+
await this.connectUntilReady(session, deadline, turn.interrupt.signal);
472487
}
488+
const socket = session.socket;
489+
if (!socket || socket.destroyed)
490+
throw snapshotSourceError('transport-failure', 'bridge-connection-closed');
473491
// Nothing is sent once a close owns this turn: the bridge it would reach is being stopped.
474492
if (refusedByClose(this.closed, turn)) throw closedSourceRefusal();
475493
const requestId = randomUUID();
@@ -494,7 +512,7 @@ export class SnapshotBridgeManager {
494512
const frame = encodeSnapshotBridgeFrame(request, input.limits);
495513
return await roundTripSnapshotBridge({
496514
process: session.process,
497-
socket: session.socket,
515+
socket,
498516
frame,
499517
requestId,
500518
deadline,

0 commit comments

Comments
 (0)