forked from CopilotKit/CopilotKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathagent.ts
More file actions
649 lines (577 loc) · 20.2 KB
/
Copy pathagent.ts
File metadata and controls
649 lines (577 loc) · 20.2 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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
import type {
AbstractAgent,
AgentSubscriber,
BaseEvent,
HttpAgentConfig,
RunAgentInput,
RunAgentParameters,
RunAgentResult,
} from "@ag-ui/client";
import {
HttpAgent,
runHttpRequest,
transformHttpEventStream,
} from "@ag-ui/client";
import type { AgentCapabilities } from "@ag-ui/core";
import type { Observable } from "rxjs";
import { EMPTY, defer, from } from "rxjs";
import { catchError, switchMap } from "rxjs/operators";
import {
RUNTIME_MODE_SSE,
RUNTIME_MODE_INTELLIGENCE,
} from "@copilotkit/shared";
import type {
IntelligenceRuntimeInfo,
RuntimeInfo,
RuntimeMode,
ResolvedDebugConfig,
} from "@copilotkit/shared";
import { IntelligenceAgent } from "./intelligence-agent";
import type { CopilotRuntimeTransport } from "./types";
type ResolvedRuntimeMode = RuntimeMode | "pending";
interface RunnableAgent {
connect(input: RunAgentInput): Observable<BaseEvent>;
run(input: RunAgentInput): Observable<BaseEvent>;
}
function hasHeaders(
agent: AbstractAgent,
): agent is AbstractAgent & { headers?: Record<string, string> } {
return "headers" in agent;
}
function hasCredentials(
agent: AbstractAgent,
): agent is AbstractAgent & { credentials?: RequestCredentials } {
return "credentials" in agent;
}
function isZodError(error: unknown): boolean {
return (
error !== null &&
typeof error === "object" &&
"name" in error &&
(error as { name: string }).name === "ZodError"
);
}
function isAbortError(error: unknown): boolean {
return (
(error instanceof DOMException || error instanceof Error) &&
(error as Error).name === "AbortError"
);
}
function withAbortErrorHandling(
observable: Observable<BaseEvent>,
): Observable<BaseEvent> {
return observable.pipe(
catchError((error) => {
if (isZodError(error) || isAbortError(error)) {
return EMPTY;
}
throw error;
}),
);
}
export interface ProxiedCopilotRuntimeAgentConfig extends Omit<
HttpAgentConfig,
"url"
> {
runtimeUrl?: string;
transport?: CopilotRuntimeTransport;
credentials?: RequestCredentials;
runtimeMode?: ResolvedRuntimeMode;
intelligence?: IntelligenceRuntimeInfo;
capabilities?: AgentCapabilities;
debug?: ResolvedDebugConfig;
/**
* When set, runtime requests (HTTP path, single-route envelope, intelligence
* delegate) are routed to this agent on the runtime instead of `agentId`.
* The local `agentId` remains the registry key used for subscriber
* bookkeeping; only outbound routing is overridden.
*/
runtimeAgentId?: string;
}
export class ProxiedCopilotRuntimeAgent extends HttpAgent {
runtimeUrl?: string;
credentials?: RequestCredentials;
// `readonly` because `super.url` is baked at construction; mutating
// `runtimeAgentId` post-construction would desync the REST `run` URL
// (already captured) from `routedAgentId()` (consulted per-call by
// stop/connect/single-route paths).
readonly runtimeAgentId?: string;
private transport: CopilotRuntimeTransport;
private singleEndpointUrl?: string;
private runtimeMode: ResolvedRuntimeMode;
private intelligence?: IntelligenceRuntimeInfo;
private _capabilities?: AgentCapabilities;
private delegate?: AbstractAgent;
private runtimeInfoPromise?: Promise<void>;
constructor(config: ProxiedCopilotRuntimeAgentConfig) {
const normalizedRuntimeUrl = config.runtimeUrl
? config.runtimeUrl.replace(/\/$/, "")
: undefined;
const transport = config.transport ?? "auto";
const routedId = config.runtimeAgentId ?? config.agentId ?? "";
const runUrl =
transport === "single"
? (normalizedRuntimeUrl ?? config.runtimeUrl ?? "")
: `${normalizedRuntimeUrl ?? config.runtimeUrl}/agent/${encodeURIComponent(routedId)}/run`;
if (!runUrl) {
throw new Error(
"ProxiedCopilotRuntimeAgent requires a runtimeUrl when transport is set to 'single'.",
);
}
super({
...config,
url: runUrl,
});
this.runtimeUrl = normalizedRuntimeUrl ?? config.runtimeUrl;
this.credentials = config.credentials;
this.runtimeAgentId = config.runtimeAgentId;
this.transport = transport;
this.runtimeMode = config.runtimeMode ?? RUNTIME_MODE_SSE;
this.intelligence = config.intelligence;
this._capabilities = config.capabilities;
if (config.debug) {
this.debug = config.debug;
}
if (this.transport === "single") {
this.singleEndpointUrl = this.runtimeUrl;
}
}
/**
* The agent id used for outbound runtime requests — `runtimeAgentId` when
* set (manually-registered proxy), otherwise `agentId` (registry id
* matches runtime id). Subscriber bookkeeping keeps using `agentId`
* directly.
*
* Throws when both are unset: a proxy reaching an HTTP path with no
* routable id is a bug, and a missing id would otherwise produce a
* malformed `/agent//run` or `/agent/undefined/connect` URL silently.
*/
private routedAgentId(): string {
const id = this.runtimeAgentId ?? this.agentId;
if (!id) {
throw new Error(
"ProxiedCopilotRuntimeAgent: cannot make a runtime request without an agentId or runtimeAgentId.",
);
}
return id;
}
get capabilities(): AgentCapabilities | undefined {
return this._capabilities;
}
async getCapabilities(): Promise<AgentCapabilities> {
return this._capabilities ?? {};
}
override async detachActiveRun(): Promise<void> {
if (this.delegate) {
await this.delegate.detachActiveRun();
}
await super.detachActiveRun();
}
abortRun(): void {
if (this.delegate) {
this.syncDelegate(this.delegate);
this.delegate.abortRun();
// Also detach the proxy's own runAgent pipeline so the proxy's
// isRunning resets and onRunFinalized fires even if the delegate's
// observable doesn't propagate a clean completion.
void this.detachActiveRun();
return;
}
if (!this.agentId || !this.threadId) {
return;
}
if (typeof fetch === "undefined") {
return;
}
const routedId = this.routedAgentId();
if (this.transport === "single") {
if (!this.singleEndpointUrl) {
return;
}
const headers = new Headers({
...this.headers,
"Content-Type": "application/json",
});
void fetch(this.singleEndpointUrl, {
method: "POST",
headers,
body: JSON.stringify({
method: "agent/stop",
params: {
agentId: routedId,
threadId: this.threadId,
},
}),
...(this.credentials ? { credentials: this.credentials } : {}),
}).catch((error) => {
console.error("ProxiedCopilotRuntimeAgent: stop request failed", error);
});
return;
}
if (!this.runtimeUrl) {
return;
}
const stopPath = `${this.runtimeUrl}/agent/${encodeURIComponent(routedId)}/stop/${encodeURIComponent(this.threadId)}`;
const origin =
typeof window !== "undefined" && window.location
? window.location.origin
: "http://localhost";
const base = new URL(this.runtimeUrl, origin);
const stopUrl = new URL(stopPath, base);
void fetch(stopUrl.toString(), {
method: "POST",
headers: {
"Content-Type": "application/json",
...this.headers,
},
...(this.credentials ? { credentials: this.credentials } : {}),
}).catch((error) => {
console.error("ProxiedCopilotRuntimeAgent: stop request failed", error);
});
}
override async connectAgent(
parameters?: RunAgentParameters,
subscriber?: AgentSubscriber,
): Promise<RunAgentResult> {
if (this.runtimeMode !== RUNTIME_MODE_INTELLIGENCE) {
return super.connectAgent(parameters, subscriber);
}
// If the delegate already has an active run (e.g. from a previous
// connectAgent call that hasn't finished yet), detach it first. This
// ensures only one run is active on the delegate at a time — without it,
// two parallel runs would both pump events into the shared delegate,
// and both bridge subscriptions would copy the interleaved messages to
// the proxy, causing the UI to flicker between the two conversations.
if (this.delegate) {
await this.delegate.detachActiveRun();
}
// Ensure the delegate exists and is synced with the proxy's current state.
await this.resolveDelegate();
const delegate = this.delegate!;
// Subscribe a bridging observer FIRST so it fires before the forwarded
// UI subscribers. This keeps proxy.messages in sync with the delegate
// in real-time — otherwise the UI re-renders (triggered by the
// forwarded onMessagesChanged) but reads stale proxy.messages because
// the final sync only happens after connectAgent resolves.
const bridgeSub = delegate.subscribe({
onMessagesChanged: () => {
this.setMessages([...delegate.messages]);
},
onStateChanged: () => {
this.setState({ ...delegate.state });
},
// Mirror isRunning so the proxy reflects the delegate's run lifecycle.
// Without this, UI components read proxy.isRunning (always false) even
// though the delegate is actively running, causing the stop button to
// never appear.
onRunInitialized: () => {
this.isRunning = true;
},
onRunFinalized: () => {
this.isRunning = false;
},
// Local exception (network error, deserialization failure, etc.)
onRunFailed: () => {
this.isRunning = false;
},
// Protocol-level RUN_ERROR event from the backend
onRunErrorEvent: () => {
this.isRunning = false;
},
});
// Forward the proxy's subscribers to the delegate so that UI hooks
// (e.g. useAgent's onMessagesChanged) receive real-time updates as
// the delegate processes events during connectAgent.
const forwardedSubs = this.subscribers.map((s) => delegate.subscribe(s));
try {
const result = await delegate.connectAgent(parameters, subscriber);
// Final sync to guarantee the proxy reflects the delegate's end state.
this.setMessages([...delegate.messages]);
this.setState({ ...delegate.state });
return result;
} finally {
// Ensure the proxy's isRunning is reset — the bridging subscription
// may have already handled this, but if the delegate threw before
// firing onRunFinalized the proxy would be stuck in isRunning=true.
this.isRunning = false;
// Remove forwarded subscribers to avoid duplicate notifications on
// subsequent calls (they'll be re-forwarded next time).
bridgeSub.unsubscribe();
for (const sub of forwardedSubs) {
sub.unsubscribe();
}
}
}
connect(input: RunAgentInput): Observable<BaseEvent> {
if (this.runtimeMode === RUNTIME_MODE_INTELLIGENCE) {
return this.#connectViaDelegate(input);
}
return this.#connectViaHttp(input);
}
public run(input: RunAgentInput): Observable<BaseEvent> {
if (this.runtimeMode === RUNTIME_MODE_INTELLIGENCE) {
return this.#runViaDelegate(input);
}
return this.#runViaHttp(input);
}
#connectViaDelegate(input: RunAgentInput): Observable<BaseEvent> {
return defer(() => from(this.resolveDelegate())).pipe(
switchMap((delegate) => withAbortErrorHandling(delegate.connect(input))),
);
}
#connectViaHttp(input: RunAgentInput): Observable<BaseEvent> {
const routedId = this.routedAgentId();
if (this.transport === "single") {
if (!this.singleEndpointUrl) {
throw new Error("Single endpoint transport requires a runtimeUrl");
}
const requestInit = this.createSingleRouteRequestInit(
input,
"agent/connect",
{
agentId: routedId,
},
);
const httpEvents = runHttpRequest(this.singleEndpointUrl, requestInit);
return withAbortErrorHandling(transformHttpEventStream(httpEvents));
}
const httpEvents = runHttpRequest(
`${this.runtimeUrl}/agent/${routedId}/connect`,
this.requestInit(input),
);
return withAbortErrorHandling(transformHttpEventStream(httpEvents));
}
#runViaDelegate(input: RunAgentInput): Observable<BaseEvent> {
return defer(() => from(this.resolveDelegate())).pipe(
switchMap((delegate) => withAbortErrorHandling(delegate.run(input))),
);
}
#runViaHttp(input: RunAgentInput): Observable<BaseEvent> {
if (this.transport === "single") {
if (!this.singleEndpointUrl) {
throw new Error("Single endpoint transport requires a runtimeUrl");
}
const requestInit = this.createSingleRouteRequestInit(
input,
"agent/run",
{
agentId: this.routedAgentId(),
},
);
const httpEvents = runHttpRequest(this.singleEndpointUrl, requestInit);
return withAbortErrorHandling(transformHttpEventStream(httpEvents));
}
return withAbortErrorHandling(super.run(input));
}
public override clone(): ProxiedCopilotRuntimeAgent {
const cloned = new ProxiedCopilotRuntimeAgent({
runtimeUrl: this.runtimeUrl,
agentId: this.agentId,
runtimeAgentId: this.runtimeAgentId,
description: this.description,
headers: { ...this.headers },
credentials: this.credentials,
transport: this.transport,
runtimeMode: this.runtimeMode,
intelligence: this.intelligence,
capabilities: this._capabilities,
debug: this.debug,
});
cloned.threadId = this.threadId;
cloned.setState(this.state);
cloned.setMessages(this.messages);
if (this.delegate) {
cloned.delegate = this.delegate.clone();
cloned.syncDelegate(cloned.delegate);
}
return cloned;
}
/**
* Drop the delegate's cached `lastSeenEventId` for this thread so
* the next connect requests a full historical replay from the
* gateway. Used by `RunHandler.connectAgent` on a detected thread
* switch (the chat moved between threads, so its local
* messages/state are about to be cleared and need rebuilding from
* the gateway). Skipped on same-thread churn re-connects so the
* gateway can resume from the cursor instead.
*
* No-op for non-Intelligence runtime modes — the HTTP transport
* doesn't replay.
*/
public clearReplayCursor(threadId: string): void {
if (this.runtimeMode !== RUNTIME_MODE_INTELLIGENCE) return;
const delegate = this.delegate as
| { clearReconnectCursor?: (id: string) => void }
| null
| undefined;
delegate?.clearReconnectCursor?.(threadId);
}
private async resolveDelegate(): Promise<RunnableAgent> {
await this.ensureRuntimeMode();
if (!this.delegate) {
if (this.runtimeMode !== RUNTIME_MODE_INTELLIGENCE) {
throw new Error("A delegate is only created for Intelligence mode");
}
this.delegate = this.createIntelligenceDelegate();
}
this.syncDelegate(this.delegate);
// AbstractAgent declares connect() as protected, but concrete delegates
// (IntelligenceAgent, HttpAgent) expose both connect() and run() publicly.
return this.delegate as unknown as RunnableAgent;
}
private async ensureRuntimeMode(): Promise<void> {
if (this.runtimeMode !== "pending") {
return;
}
if (!this.runtimeUrl) {
throw new Error("Runtime URL is not set");
}
this.runtimeInfoPromise ??= this.fetchRuntimeInfo().then((runtimeInfo) => {
this.runtimeMode = runtimeInfo.mode ?? RUNTIME_MODE_SSE;
this.intelligence = runtimeInfo.intelligence;
});
await this.runtimeInfoPromise;
}
private async fetchRuntimeInfo(): Promise<RuntimeInfo> {
const headers: Record<string, string> = {
...this.headers,
};
if (this.transport === "auto") {
return this.fetchRuntimeInfoAutoDetect(headers);
}
let init: RequestInit;
let url: string;
if (this.transport === "single") {
if (!this.singleEndpointUrl) {
throw new Error("Single endpoint transport requires a runtimeUrl");
}
if (!headers["Content-Type"]) {
headers["Content-Type"] = "application/json";
}
url = this.runtimeUrl!;
init = { method: "POST", body: JSON.stringify({ method: "info" }) };
} else {
url = `${this.runtimeUrl}/info`;
init = {};
}
const response = await fetch(url, {
...init,
headers,
...(this.credentials ? { credentials: this.credentials } : {}),
});
if (!response.ok) {
throw new Error(
`Runtime info request failed with status ${response.status}`,
);
}
return (await response.json()) as RuntimeInfo;
}
private async fetchRuntimeInfoAutoDetect(
headers: Record<string, string>,
): Promise<RuntimeInfo> {
// Try REST first (GET /info)
try {
const response = await fetch(`${this.runtimeUrl}/info`, {
headers: { ...headers },
...(this.credentials ? { credentials: this.credentials } : {}),
});
// Only treat a successful (2xx) response as a valid REST runtime.
// 404/405 means the endpoint doesn't exist; other non-2xx errors
// (500, 403, etc.) should also fall through to single-endpoint.
if (response.status >= 200 && response.status < 300) {
this.transport = "rest";
return (await response.json()) as RuntimeInfo;
}
} catch {
// REST failed — fall through to single-endpoint attempt
}
// Try single-endpoint (POST with { method: "info" })
const singleHeaders = { ...headers };
if (!singleHeaders["Content-Type"]) {
singleHeaders["Content-Type"] = "application/json";
}
const response = await fetch(this.runtimeUrl!, {
method: "POST",
headers: singleHeaders,
body: JSON.stringify({ method: "info" }),
...(this.credentials ? { credentials: this.credentials } : {}),
});
if (!response.ok) {
throw new Error(
`Runtime info request failed with status ${response.status}`,
);
}
this.transport = "single";
this.singleEndpointUrl = this.runtimeUrl;
return (await response.json()) as RuntimeInfo;
}
private createSingleRouteRequestInit(
input: RunAgentInput,
method: string,
params?: Record<string, string>,
): RequestInit {
if (!this.agentId) {
throw new Error(
"ProxiedCopilotRuntimeAgent requires agentId to make runtime requests",
);
}
const baseInit = super.requestInit(input);
const headers = new Headers(baseInit.headers ?? {});
headers.set("Content-Type", "application/json");
headers.set("Accept", headers.get("Accept") ?? "text/event-stream");
let originalBody: unknown = undefined;
if (typeof baseInit.body === "string") {
try {
originalBody = JSON.parse(baseInit.body);
} catch (error) {
console.warn(
"ProxiedCopilotRuntimeAgent: failed to parse request body for single route transport",
error,
);
}
}
const envelope: Record<string, unknown> = { method };
if (params && Object.keys(params).length > 0) {
envelope.params = params;
}
if (originalBody !== undefined) {
envelope.body = originalBody;
}
return {
...baseInit,
headers,
body: JSON.stringify(envelope),
...(this.credentials ? { credentials: this.credentials } : {}),
};
}
private createIntelligenceDelegate(): AbstractAgent {
const routedId = this.routedAgentId();
if (!this.runtimeUrl || !routedId || !this.intelligence?.wsUrl) {
throw new Error(
"Intelligence mode requires runtimeUrl, agentId, and intelligence websocket metadata",
);
}
return new IntelligenceAgent({
url: this.intelligence.wsUrl,
runtimeUrl: this.runtimeUrl,
agentId: routedId,
headers: { ...this.headers },
credentials: this.credentials,
});
}
private syncDelegate(delegate: AbstractAgent): void {
// Delegate is the IntelligenceAgent that talks to the runtime — it must
// use the routed id so that requests reach the right runtime agent.
delegate.agentId = this.routedAgentId();
delegate.description = this.description;
delegate.threadId = this.threadId;
delegate.setMessages(this.messages);
delegate.setState(this.state);
if (hasHeaders(delegate)) {
delegate.headers = { ...this.headers };
}
if (hasCredentials(delegate)) {
delegate.credentials = this.credentials;
}
}
}