File size: 8,092 Bytes
4e23b01 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | /**
* IPC host — serves one engine scope over a unix domain socket. Incoming
* frames are bridged to the shared in-process dispatcher (the same code the
* memory transport uses), so ipc and in-memory behavior are identical by
* construction; only serialization separates them.
*/
import { createServer, type Server, type Socket } from 'node:net';
import { unlink } from 'node:fs/promises';
import type { EventSourceRef, IDisposable, ScopeRef } from '../../core/channel.js';
import { RPCError } from '../../core/errors.js';
import { createMemoryDispatcher, type ScopeLike } from '../memory/dispatcher.js';
import { encodeFrame, NdjsonDecoder, type IpcFrame } from './codec.js';
const REQUEST_INVALID = 40001;
const UNAUTHORIZED = 40100;
export interface ServeKlientIpcOptions {
/** A bootstrapped engine app scope (same value `createKlient({ scope })` takes). */
readonly scope: ScopeLike;
/** Unix socket path to listen on. A stale file at the path is removed first. */
readonly socketPath: string;
/** Optional token; when set, the client's `hello` must carry the same token. */
readonly token?: string;
}
export interface KlientIpcHost {
readonly socketPath: string;
close(): Promise<void>;
}
function scopeRefFromFrame(frame: IpcFrame): ScopeRef {
const scope: { workspaceId?: string; sessionId?: string; agentId?: string } = {};
if (typeof frame.workspaceId === 'string') scope.workspaceId = frame.workspaceId;
if (typeof frame.sessionId === 'string') scope.sessionId = frame.sessionId;
if (typeof frame.agentId === 'string') scope.agentId = frame.agentId;
return scope;
}
function eventSourceFromFrame(frame: IpcFrame): EventSourceRef {
if (typeof frame.service === 'string' && typeof frame.event === 'string') {
return { kind: 'emitter', service: frame.service, event: frame.event };
}
if (typeof frame.event === 'string' && frame.event.length > 0) {
return { kind: 'stream', name: frame.event };
}
throw new RPCError(REQUEST_INVALID, `unknown event stream: ${String(frame.event)}`);
}
export async function serveKlientIpc(options: ServeKlientIpcOptions): Promise<KlientIpcHost> {
const dispatcher = createMemoryDispatcher(options.scope);
// Best-effort cleanup of a stale socket file; ignore everything but a real
// leftover (ENOENT = nothing to remove).
try {
await unlink(options.socketPath);
} catch (error) {
if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error;
}
const connections = new Set<Socket>();
const server: Server = createServer((socket) => {
connections.add(socket);
const decoder = new NdjsonDecoder();
const listens = new Map<string, IDisposable>();
const activeStreams = new Map<string, AbortController>();
let helloDone = false;
const send = (frame: IpcFrame): void => {
if (!socket.destroyed) socket.write(encodeFrame(frame));
};
const sendError = (id: string, error: unknown): void => {
if (error instanceof RPCError) {
send({ type: 'error', id, code: error.code, msg: error.message });
} else {
send({
type: 'error',
id,
code: 50001,
msg: error instanceof Error ? error.message : String(error),
});
}
};
const sendStreamError = (id: string, error: unknown): void => {
if (error instanceof RPCError) {
send({ type: 'stream_error', id, code: error.code, msg: error.message });
} else {
send({
type: 'stream_error',
id,
code: 50001,
msg: error instanceof Error ? error.message : String(error),
});
}
};
const handleFrame = (frame: IpcFrame): void => {
const id = typeof frame.id === 'string' ? frame.id : '';
switch (frame.type) {
case 'hello': {
if (options.token !== undefined && frame.token !== options.token) {
send({ type: 'error', id: 'hello', code: UNAUTHORIZED, msg: 'unauthorized' });
socket.end();
return;
}
helloDone = true;
return;
}
case 'call': {
if (!helloDone) {
sendError(id, new RPCError(REQUEST_INVALID, 'expected hello first'));
return;
}
const args = Array.isArray(frame.arg) ? frame.arg : frame.arg === undefined ? [] : [frame.arg];
dispatcher
.call(scopeRefFromFrame(frame), String(frame.service), String(frame.method), args)
.then((data) => {
send({ type: 'result', id, data });
})
.catch((error: unknown) => {
sendError(id, error);
});
return;
}
case 'listen': {
if (!helloDone) {
sendError(id, new RPCError(REQUEST_INVALID, 'expected hello first'));
return;
}
try {
const source = eventSourceFromFrame(frame);
const sub = dispatcher.listen(
scopeRefFromFrame(frame),
source,
(data) => {
send({ type: 'event', id, data });
},
(error) => {
sendError(id, error);
},
);
listens.set(id, sub);
send({ type: 'listen_result', id });
} catch (error) {
sendError(id, error);
}
return;
}
case 'unlisten': {
listens.get(id)?.dispose();
listens.delete(id);
return;
}
case 'stream': {
if (!helloDone) {
sendStreamError(id, new RPCError(REQUEST_INVALID, 'expected hello first'));
return;
}
const args = Array.isArray(frame.arg) ? frame.arg : frame.arg === undefined ? [] : [frame.arg];
const ac = new AbortController();
activeStreams.set(id, ac);
const iterable = dispatcher.stream(
scopeRefFromFrame(frame),
String(frame.service),
String(frame.method),
args,
);
void (async () => {
try {
for await (const chunk of iterable) {
if (ac.signal.aborted || socket.destroyed) break;
send({ type: 'stream_data', id, data: chunk });
}
if (!ac.signal.aborted && !socket.destroyed) {
send({ type: 'stream_end', id });
}
} catch (error) {
if (!ac.signal.aborted && !socket.destroyed) {
sendStreamError(id, error);
}
} finally {
activeStreams.delete(id);
}
})();
return;
}
case 'stream_cancel': {
const ac = activeStreams.get(id);
if (ac !== undefined) {
ac.abort();
activeStreams.delete(id);
}
return;
}
default:
return;
}
};
socket.on('data', (chunk) => {
for (const frame of decoder.push(chunk.toString('utf8'))) {
handleFrame(frame);
}
});
const teardown = (): void => {
for (const sub of listens.values()) sub.dispose();
listens.clear();
for (const ac of activeStreams.values()) ac.abort();
activeStreams.clear();
connections.delete(socket);
};
socket.on('close', teardown);
socket.on('error', teardown);
send({ type: 'ready' });
});
await new Promise<void>((resolve, reject) => {
server.once('error', reject);
server.listen(options.socketPath, resolve);
});
return {
socketPath: options.socketPath,
close: () => {
for (const socket of connections) {
socket.destroy();
}
connections.clear();
return new Promise<void>((resolve) => {
server.close(() => {
void unlink(options.socketPath).then(
() => {
resolve();
},
() => {
resolve();
},
);
});
});
},
};
}
|