-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathprotocol.ts
More file actions
500 lines (439 loc) · 13.7 KB
/
Copy pathprotocol.ts
File metadata and controls
500 lines (439 loc) · 13.7 KB
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
import { v4 as uuidv4 } from 'uuid';
import {
ConnectionError,
ProtocolError,
SessionNotFoundError,
TimeoutError,
} from './errors.js';
import {
DEFAULT_REQUEST_TIMEOUT,
FACTORY_PROTOCOL_VERSION,
JSONRPC_VERSION,
LEGACY_FACTORY_API_VERSION,
} from './schemas/constants.js';
import {
DroidClientMethod,
JsonRpcMessageType,
JsonRpcErrorCode,
ServerRequestHandlerType,
ToolConfirmationOutcome,
} from './schemas/enums.js';
import {
AskUserRequestParamsSchema,
AskUserResultSchema,
RequestPermissionRequestParamsSchema,
RequestPermissionResultSchema,
SessionNotificationParamsSchema,
} from './schemas/server.js';
import type {
AskUserRequestParams,
AskUserResult,
RequestPermissionHandlerResult,
RequestPermissionRequestParams,
RequestPermissionResult,
} from './schemas/server.js';
import { JsonRpcMessageSchema, type JsonRpcError } from './schemas/shared.js';
import type { DroidClientTransport } from './types.js';
export type PermissionHandler = (
params: RequestPermissionRequestParams
) => RequestPermissionHandlerResult | Promise<RequestPermissionHandlerResult>;
export type AskUserHandler = (
params: AskUserRequestParams
) => AskUserResult | Promise<AskUserResult>;
export type NotificationCallback = (
notification: Record<string, unknown>
) => void;
export interface NotificationFilter {
type?: string;
}
interface PendingRequest {
readonly method: string;
readonly requestId: string;
readonly params: Record<string, unknown>;
readonly resolve: (value: unknown) => void;
readonly reject: (reason: Error) => void;
readonly timer: ReturnType<typeof setTimeout>;
}
export interface NotificationListener {
readonly callback: NotificationCallback;
readonly filter?: NotificationFilter;
}
/** Dispatch a notification to matching listeners, swallowing listener errors. */
export function dispatchNotification(
notification: Record<string, unknown>,
listeners: Iterable<NotificationListener>
): void {
let notificationType: string | undefined;
const parsed = SessionNotificationParamsSchema.safeParse(
notification['params']
);
if (parsed.success) {
notificationType = parsed.data.notification.type;
}
for (const listener of listeners) {
if (
listener.filter?.type != null &&
listener.filter.type !== notificationType
) {
continue;
}
try {
listener.callback(notification);
} catch {
// Notification listener raised — don't crash the dispatch loop
}
}
}
/** Default method map for exec-mode (droid.*) server-to-client requests. */
const DEFAULT_SERVER_REQUEST_METHOD_MAP: Record<
string,
ServerRequestHandlerType
> = {
[DroidClientMethod.REQUEST_PERMISSION]: ServerRequestHandlerType.Permission,
[DroidClientMethod.ASK_USER]: ServerRequestHandlerType.AskUser,
};
// ─── Module-level JSON-RPC metadata provider ──────────────────────────────
type MetaProvider = () => Record<string, string | undefined> | undefined;
let _metaProvider: MetaProvider | null = null;
/**
* Registers a callback that is invoked on every outgoing JSON-RPC request to
* inject metadata into the envelope _meta field. Pass null to clear.
*/
export function setGlobalMetaProvider(fn: MetaProvider | null): void {
_metaProvider = fn;
}
export class ProtocolEngine {
private readonly _transport: DroidClientTransport;
private readonly _defaultTimeout: number;
private readonly _serverRequestMethodMap: Record<
string,
ServerRequestHandlerType
>;
private readonly _pendingRequests = new Map<string, PendingRequest>();
private readonly _notificationListeners = new Set<NotificationListener>();
private _permissionHandler: PermissionHandler | null = null;
private _askUserHandler: AskUserHandler | null = null;
private _transportError: Error | null = null;
private _closed = false;
constructor(options: {
transport: DroidClientTransport;
defaultTimeout?: number;
/**
* Maps incoming server-to-client request method strings to handler types.
* Defaults to `{ 'droid.request_permission': 'permission', 'droid.ask_user': 'askUser' }`.
* Override for daemon mode: `{ 'daemon.request_permission': 'permission', ... }`.
*/
serverRequestMethodMap?: Record<string, ServerRequestHandlerType>;
}) {
this._transport = options.transport;
this._defaultTimeout = options.defaultTimeout ?? DEFAULT_REQUEST_TIMEOUT;
this._serverRequestMethodMap =
options.serverRequestMethodMap ?? DEFAULT_SERVER_REQUEST_METHOD_MAP;
this._transport.onMessage((message: Record<string, unknown>) => {
this._handleMessage(message);
});
this._transport.onError((error: Error) => {
this._handleTransportError(error);
});
}
async sendRequest(
method: string,
params: Record<string, unknown>,
timeout?: number
): Promise<unknown> {
if (this._closed) {
throw new ConnectionError('Protocol engine is closed');
}
if (this._transportError !== null) {
throw new ConnectionError(
`Transport error: ${this._transportError.message}`
);
}
const effectiveTimeout = timeout ?? this._defaultTimeout;
const requestId = uuidv4();
const _meta = _metaProvider?.();
const envelope = {
jsonrpc: JSONRPC_VERSION,
factoryApiVersion: LEGACY_FACTORY_API_VERSION,
factoryProtocolVersion: FACTORY_PROTOCOL_VERSION,
type: JsonRpcMessageType.Request,
id: requestId,
method,
params,
...(_meta ? { _meta } : {}),
};
// Create a promise that will be resolved when we get a matching response
return new Promise<unknown>((resolve, reject) => {
const timer = setTimeout(() => {
this._pendingRequests.delete(requestId);
reject(
new TimeoutError(
`Request ${method} timed out after ${effectiveTimeout}ms`
)
);
}, effectiveTimeout);
const pending: PendingRequest = {
method,
requestId,
params,
resolve,
reject,
timer,
};
this._pendingRequests.set(requestId, pending);
try {
this._transport.send(envelope);
} catch (sendError) {
clearTimeout(timer);
this._pendingRequests.delete(requestId);
if (sendError instanceof Error) {
reject(
new ConnectionError(`Failed to send request: ${sendError.message}`)
);
} else {
reject(new ConnectionError('Failed to send request'));
}
}
});
}
onNotification(
callback: NotificationCallback,
filter?: NotificationFilter
): () => void {
const listener: NotificationListener = { callback, filter };
this._notificationListeners.add(listener);
let unsubscribed = false;
return () => {
if (!unsubscribed) {
unsubscribed = true;
this._notificationListeners.delete(listener);
}
};
}
setPermissionHandler(handler: PermissionHandler): void {
this._permissionHandler = handler;
}
clearPermissionHandler(): void {
this._permissionHandler = null;
}
/**
* Register a handler for server→client ask-user requests.
*
* The handler receives the request params and should return
* a result object with `cancelled` and `answers` keys.
*
* Replaces any previously registered handler.
*/
setAskUserHandler(handler: AskUserHandler): void {
this._askUserHandler = handler;
}
clearAskUserHandler(): void {
this._askUserHandler = null;
}
get isHealthy(): boolean {
return !this._closed && this._transportError === null;
}
async close(): Promise<void> {
if (this._closed) {
return;
}
this._closed = true;
const error = new ConnectionError(
'Protocol engine closed: pending requests cancelled'
);
this._rejectAllPending(error);
this._permissionHandler = null;
this._askUserHandler = null;
this._notificationListeners.clear();
await this._transport.close();
}
private _handleMessage(raw: Record<string, unknown>): void {
const parsed = JsonRpcMessageSchema.safeParse(raw);
if (!parsed.success) {
// Malformed message — silently ignore
return;
}
const msg = parsed.data;
switch (msg.type) {
case JsonRpcMessageType.Response:
this._handleResponse(msg.id, msg.result, msg.error);
break;
case JsonRpcMessageType.Notification:
this._handleNotification(msg);
break;
case JsonRpcMessageType.Request:
void this._handleServerRequest(msg.method, msg.id, msg.params);
break;
}
}
private _handleResponse(
responseId: string | null,
result: unknown,
error: JsonRpcError | undefined
): void {
if (responseId == null) {
return;
}
const pending = this._pendingRequests.get(responseId);
if (pending == null) {
return;
}
this._pendingRequests.delete(responseId);
clearTimeout(pending.timer);
if (error != null) {
if (error.code === JsonRpcErrorCode.ENTITY_NOT_FOUND) {
const sessionId = String(
pending.params['sessionId'] ?? pending.requestId
);
pending.reject(new SessionNotFoundError(sessionId));
return;
}
pending.reject(
new ProtocolError(error.message, { code: error.code, data: error.data })
);
return;
}
pending.resolve(result);
}
private _handleNotification(notification: Record<string, unknown>): void {
dispatchNotification(notification, this._notificationListeners);
}
private async _handleServerRequest(
method: string,
requestId: string,
params: unknown
): Promise<void> {
const handlerType = this._serverRequestMethodMap[method];
if (handlerType === ServerRequestHandlerType.Permission) {
await this._handlePermissionRequest(requestId, params);
} else if (handlerType === ServerRequestHandlerType.AskUser) {
await this._handleAskUserRequest(requestId, params);
}
}
private async _handlePermissionRequest(
requestId: string,
params: unknown
): Promise<void> {
const handler = this._permissionHandler;
if (handler == null) {
// Default: Cancel
this._sendResponse(
requestId,
RequestPermissionResultSchema.parse({
selectedOption: ToolConfirmationOutcome.Cancel,
})
);
return;
}
try {
const parsedParams = RequestPermissionRequestParamsSchema.parse(params);
const selection = await Promise.resolve(handler(parsedParams));
const result =
typeof selection === 'string'
? { selectedOption: selection }
: selection;
this._sendResponse(
requestId,
RequestPermissionResultSchema.parse(result)
);
} catch (exc) {
const errorMessage = exc instanceof Error ? exc.message : String(exc);
this._sendErrorResponse(
requestId,
JsonRpcErrorCode.INTERNAL_ERROR,
'Failed to handle permission request',
errorMessage
);
}
}
private async _handleAskUserRequest(
requestId: string,
params: unknown
): Promise<void> {
const handler = this._askUserHandler;
if (handler == null) {
// Default: cancelled=true
this._sendResponse(
requestId,
AskUserResultSchema.parse({ cancelled: true, answers: [] })
);
return;
}
try {
const parsedParams = AskUserRequestParamsSchema.parse(params);
const result = await Promise.resolve(handler(parsedParams));
this._sendResponse(requestId, AskUserResultSchema.parse(result));
} catch (exc) {
const errorMessage = exc instanceof Error ? exc.message : String(exc);
this._sendErrorResponse(
requestId,
JsonRpcErrorCode.INTERNAL_ERROR,
'Failed to handle ask-user request',
errorMessage
);
}
}
/**
* Handle a transport error.
* Sets the sticky transport error and rejects all pending requests.
* The original error is preserved as `cause` on the ConnectionError.
*/
private _handleTransportError(error: Error): void {
this._transportError = error;
const connectionError = new ConnectionError(
`Transport error: ${error.message}`
);
connectionError.cause = error;
this._rejectAllPending(connectionError);
}
private _sendResponse(
requestId: string,
result: RequestPermissionResult | AskUserResult
): void {
const response: Record<string, unknown> = {
jsonrpc: JSONRPC_VERSION,
factoryApiVersion: LEGACY_FACTORY_API_VERSION,
factoryProtocolVersion: FACTORY_PROTOCOL_VERSION,
type: JsonRpcMessageType.Response,
id: requestId,
result,
};
this._sendBestEffort(response);
}
private _sendErrorResponse(
requestId: string,
code: number,
message: string,
data?: unknown
): void {
const errorObj: Record<string, unknown> = { code, message };
if (data !== undefined) {
errorObj['data'] = data;
}
const response: Record<string, unknown> = {
jsonrpc: JSONRPC_VERSION,
factoryApiVersion: LEGACY_FACTORY_API_VERSION,
factoryProtocolVersion: FACTORY_PROTOCOL_VERSION,
type: JsonRpcMessageType.Response,
id: requestId,
error: errorObj,
};
this._sendBestEffort(response);
}
private _sendBestEffort(message: Record<string, unknown>): void {
try {
this._transport.send(message);
} catch {
// The transport is already failing; dropping the reply is safer than
// throwing from a server→client callback path.
}
}
private _rejectAllPending(error: Error): void {
const pending = new Map(this._pendingRequests);
this._pendingRequests.clear();
for (const req of pending.values()) {
clearTimeout(req.timer);
req.reject(error);
}
}
}