@copilotkit/vue 1.75.1 → 1.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +1 -1
- package/dist/index.mjs +272 -157
- package/dist/index.mjs.map +1 -1
- package/dist/use-render-activity-message-BTKmd3f3.cjs +110 -0
- package/dist/use-render-activity-message-BTKmd3f3.cjs.map +1 -0
- package/dist/use-render-activity-message-Eu6R2vGT.js +12801 -0
- package/dist/use-render-activity-message-Eu6R2vGT.js.map +1 -0
- package/dist/v2/components/chat/CopilotChat.vue.d.ts.map +1 -1
- package/dist/v2/components/chat/CopilotChatAssistantMessage.vue.d.ts +8 -152
- package/dist/v2/components/chat/CopilotChatAssistantMessage.vue.d.ts.map +1 -1
- package/dist/v2/components/chat/CopilotChatMessageView.vue.d.ts.map +1 -1
- package/dist/v2/components/chat/copilotChatToolCallItemRender.d.ts.map +1 -1
- package/dist/v2/hooks/use-agent.d.ts.map +1 -1
- package/dist/v2/index.cjs +1 -1
- package/dist/v2/index.d.cts +2 -0
- package/dist/v2/index.d.mts +2 -0
- package/dist/v2/index.d.ts +2 -0
- package/dist/v2/index.d.ts.map +1 -1
- package/dist/v2/index.mjs +187 -72
- package/dist/v2/index.mjs.map +1 -1
- package/package.json +7 -7
- package/src/v2/__tests__/utils/test-helpers.ts +26 -6
- package/src/v2/components/chat/CopilotChat.vue +100 -20
- package/src/v2/components/chat/CopilotChatMessageView.vue +41 -30
- package/src/v2/components/chat/__tests__/CopilotChat.clearOnFresh.test.ts +130 -2
- package/src/v2/components/chat/__tests__/CopilotChat.e2e.test.ts +6 -1
- package/src/v2/components/chat/__tests__/CopilotChatMessageView.slotMetaCost.test.ts +187 -0
- package/src/v2/components/chat/__tests__/CopilotChatToolRendering.e2e.test.ts +22 -40
- package/src/v2/components/chat/__tests__/CopilotChatToolRerenders.e2e.test.ts +12 -24
- package/src/v2/components/chat/copilotChatToolCallItemRender.ts +3 -2
- package/src/v2/hooks/__tests__/use-agent-headers.test.ts +83 -0
- package/src/v2/hooks/__tests__/use-agent-stability.test.ts +2 -0
- package/src/v2/hooks/__tests__/use-agent.e2e.test.ts +5 -3
- package/src/v2/hooks/__tests__/use-frontend-tool.e2e.test.ts +2 -2
- package/src/v2/hooks/use-agent.ts +3 -3
- package/src/v2/index.ts +5 -0
- package/src/v2/providers/__tests__/CopilotKitProvider.renderCustomMessages.e2e.test.ts +6 -4
- package/dist/use-render-activity-message-BOPauH9X.cjs +0 -85
- package/dist/use-render-activity-message-BOPauH9X.cjs.map +0 -1
- package/dist/use-render-activity-message-xvpuaGyf.js +0 -9807
- package/dist/use-render-activity-message-xvpuaGyf.js.map +0 -1
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
2
|
+
import { defineComponent, h, nextTick, ref } from "vue";
|
|
3
|
+
import { mount } from "@vue/test-utils";
|
|
4
|
+
import type { Message } from "@ag-ui/core";
|
|
5
|
+
import { CopilotKitCore } from "@copilotkit/core";
|
|
6
|
+
import CopilotKitProvider from "../../../providers/CopilotKitProvider.vue";
|
|
7
|
+
import CopilotChatConfigurationProvider from "../../../providers/CopilotChatConfigurationProvider.vue";
|
|
8
|
+
import CopilotChatMessageView from "../CopilotChatMessageView.vue";
|
|
9
|
+
import CopilotChat from "../CopilotChat.vue";
|
|
10
|
+
import { renderWithCopilotKit } from "../../../__tests__/utils/mount";
|
|
11
|
+
import { StateCapturingAgent } from "../../../__tests__/utils/agents";
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* `getStateByRun` deep-clones the whole run state. The `#message-before` and
|
|
15
|
+
* `#message-after` slots used to resolve their meta props with six separate
|
|
16
|
+
* `getMeta()` calls per row, each of which cloned the state, whether or not
|
|
17
|
+
* the slot read `stateSnapshot` (#7507).
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
const messages: Message[] = [
|
|
21
|
+
{ id: "user-1", role: "user", content: "Hello" },
|
|
22
|
+
{ id: "assistant-1", role: "assistant", content: "Hi there" },
|
|
23
|
+
{ id: "user-2", role: "user", content: "Again" },
|
|
24
|
+
];
|
|
25
|
+
|
|
26
|
+
function installRunSpies() {
|
|
27
|
+
vi.spyOn(CopilotKitCore.prototype, "getRunIdForMessage").mockReturnValue(
|
|
28
|
+
"run-1",
|
|
29
|
+
);
|
|
30
|
+
return vi
|
|
31
|
+
.spyOn(CopilotKitCore.prototype, "getStateByRun")
|
|
32
|
+
.mockImplementation(() => ({ plan: "cloned" }));
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
function mountMessageView(
|
|
36
|
+
slots: Parameters<typeof h>[2],
|
|
37
|
+
providerProps: Record<string, unknown> = {},
|
|
38
|
+
) {
|
|
39
|
+
return mount(CopilotKitProvider, {
|
|
40
|
+
props: { runtimeUrl: "/api/copilotkit", ...providerProps },
|
|
41
|
+
slots: {
|
|
42
|
+
default: () =>
|
|
43
|
+
h(
|
|
44
|
+
CopilotChatConfigurationProvider,
|
|
45
|
+
{ threadId: "thread-1", agentId: "default" },
|
|
46
|
+
{
|
|
47
|
+
default: () => h(CopilotChatMessageView, { messages }, slots),
|
|
48
|
+
},
|
|
49
|
+
),
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
describe("CopilotChatMessageView message slot meta cost", () => {
|
|
55
|
+
afterEach(() => {
|
|
56
|
+
vi.restoreAllMocks();
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it("does not clone run state for a slot that never reads stateSnapshot", () => {
|
|
60
|
+
const getStateByRun = installRunSpies();
|
|
61
|
+
|
|
62
|
+
const wrapper = mountMessageView({
|
|
63
|
+
"message-before": ({ message }: { message: Message }) =>
|
|
64
|
+
h("span", { "data-testid": "before" }, message.id),
|
|
65
|
+
"message-after": ({ message }: { message: Message }) =>
|
|
66
|
+
h("span", { "data-testid": "after" }, message.id),
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
expect(wrapper.findAll("[data-testid='after']")).toHaveLength(3);
|
|
70
|
+
expect(wrapper.findAll("[data-testid='before']")).toHaveLength(3);
|
|
71
|
+
expect(getStateByRun).not.toHaveBeenCalled();
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("clones run state at most once per slot render when stateSnapshot is read", () => {
|
|
75
|
+
const getStateByRun = installRunSpies();
|
|
76
|
+
const received: unknown[] = [];
|
|
77
|
+
|
|
78
|
+
mountMessageView({
|
|
79
|
+
"message-after": (props: { stateSnapshot: unknown }) => {
|
|
80
|
+
received.push(props.stateSnapshot);
|
|
81
|
+
received.push(props.stateSnapshot);
|
|
82
|
+
return h("span");
|
|
83
|
+
},
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
expect(received).toHaveLength(6);
|
|
87
|
+
expect(
|
|
88
|
+
received.every((s) => (s as { plan: string }).plan === "cloned"),
|
|
89
|
+
).toBe(true);
|
|
90
|
+
expect(getStateByRun).toHaveBeenCalledTimes(3);
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it("still passes every meta prop to the slot", () => {
|
|
94
|
+
installRunSpies();
|
|
95
|
+
const received: Record<string, unknown>[] = [];
|
|
96
|
+
|
|
97
|
+
mountMessageView({
|
|
98
|
+
"message-after": (props: Record<string, unknown>) => {
|
|
99
|
+
received.push({ ...props });
|
|
100
|
+
return h("span");
|
|
101
|
+
},
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
expect(received).toHaveLength(3);
|
|
105
|
+
expect(received[1]).toMatchObject({
|
|
106
|
+
message: messages[1],
|
|
107
|
+
position: "after",
|
|
108
|
+
runId: "run-1",
|
|
109
|
+
agentId: "default",
|
|
110
|
+
stateSnapshot: { plan: "cloned" },
|
|
111
|
+
});
|
|
112
|
+
for (const props of received) {
|
|
113
|
+
expect(props).toHaveProperty("messageIndex");
|
|
114
|
+
expect(props).toHaveProperty("messageIndexInRun");
|
|
115
|
+
expect(props).toHaveProperty("numberOfMessagesInRun");
|
|
116
|
+
}
|
|
117
|
+
});
|
|
118
|
+
|
|
119
|
+
it("clones run state once per row for a provider custom message renderer", () => {
|
|
120
|
+
const getStateByRun = installRunSpies();
|
|
121
|
+
const received: unknown[] = [];
|
|
122
|
+
const renderer = defineComponent({
|
|
123
|
+
props: ["message", "position", "stateSnapshot"],
|
|
124
|
+
setup(props) {
|
|
125
|
+
return () => {
|
|
126
|
+
received.push(props.stateSnapshot);
|
|
127
|
+
return h("span", { "data-testid": "custom" });
|
|
128
|
+
};
|
|
129
|
+
},
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
const wrapper = mountMessageView(
|
|
133
|
+
{},
|
|
134
|
+
{ renderCustomMessages: [{ render: renderer }] },
|
|
135
|
+
);
|
|
136
|
+
|
|
137
|
+
// One `before` and one `after` renderer per row.
|
|
138
|
+
expect(wrapper.findAll("[data-testid='custom']")).toHaveLength(6);
|
|
139
|
+
expect(
|
|
140
|
+
received.every((s) => (s as { plan: string }).plan === "cloned"),
|
|
141
|
+
).toBe(true);
|
|
142
|
+
expect(getStateByRun).toHaveBeenCalledTimes(6);
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
it("re-renders slot content when state the slot reads changes", async () => {
|
|
146
|
+
installRunSpies();
|
|
147
|
+
const label = ref("first");
|
|
148
|
+
|
|
149
|
+
const wrapper = mountMessageView({
|
|
150
|
+
"message-after": ({ message }: { message: Message }) =>
|
|
151
|
+
h("span", { "data-testid": "after" }, `${message.id}:${label.value}`),
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
expect(wrapper.findAll("[data-testid='after']")[0]!.text()).toBe(
|
|
155
|
+
"user-1:first",
|
|
156
|
+
);
|
|
157
|
+
|
|
158
|
+
label.value = "second";
|
|
159
|
+
await nextTick();
|
|
160
|
+
|
|
161
|
+
expect(wrapper.findAll("[data-testid='after']")[0]!.text()).toBe(
|
|
162
|
+
"user-1:second",
|
|
163
|
+
);
|
|
164
|
+
});
|
|
165
|
+
|
|
166
|
+
it("keeps the snapshot lazy through CopilotChat slot forwarding", () => {
|
|
167
|
+
const getStateByRun = installRunSpies();
|
|
168
|
+
const agent = new StateCapturingAgent([], "default");
|
|
169
|
+
agent.setMessages(messages);
|
|
170
|
+
|
|
171
|
+
const { wrapper } = renderWithCopilotKit(
|
|
172
|
+
() =>
|
|
173
|
+
h(
|
|
174
|
+
CopilotChat,
|
|
175
|
+
{ welcomeScreen: false },
|
|
176
|
+
{
|
|
177
|
+
"message-after": ({ message }: { message: Message }) =>
|
|
178
|
+
h("span", { "data-testid": "after" }, message.id),
|
|
179
|
+
},
|
|
180
|
+
),
|
|
181
|
+
{ agents: { default: agent } },
|
|
182
|
+
);
|
|
183
|
+
|
|
184
|
+
expect(wrapper.findAll("[data-testid='after']")).toHaveLength(3);
|
|
185
|
+
expect(getStateByRun).not.toHaveBeenCalled();
|
|
186
|
+
});
|
|
187
|
+
});
|
|
@@ -21,6 +21,10 @@ import CopilotChatToolCallsView from "../CopilotChatToolCallsView.vue";
|
|
|
21
21
|
import { useFrontendTool } from "../../../hooks/use-frontend-tool";
|
|
22
22
|
import type { VueFrontendTool } from "../../../types";
|
|
23
23
|
import type { VueToolCallRendererRenderProps } from "../../../types/vue-tool-call-renderer";
|
|
24
|
+
import {
|
|
25
|
+
runStartedEvent,
|
|
26
|
+
runFinishedEvent,
|
|
27
|
+
} from "../../../__tests__/utils/test-helpers";
|
|
24
28
|
|
|
25
29
|
afterEach(() => {
|
|
26
30
|
cleanup();
|
|
@@ -43,7 +47,7 @@ class MockStreamingAgent extends AbstractAgent {
|
|
|
43
47
|
const messageId = `m_${Date.now()}`;
|
|
44
48
|
const toolCallId = `tc_${Date.now()}`;
|
|
45
49
|
|
|
46
|
-
observer.next(
|
|
50
|
+
observer.next(runStartedEvent(_input));
|
|
47
51
|
observer.next({
|
|
48
52
|
type: EventType.TEXT_MESSAGE_CHUNK,
|
|
49
53
|
messageId,
|
|
@@ -68,7 +72,7 @@ class MockStreamingAgent extends AbstractAgent {
|
|
|
68
72
|
messageId: `${messageId}_result`,
|
|
69
73
|
content: JSON.stringify({ temperature: 21, unit: "celsius" }),
|
|
70
74
|
} as BaseEvent);
|
|
71
|
-
observer.next(
|
|
75
|
+
observer.next(runFinishedEvent(_input));
|
|
72
76
|
observer.complete();
|
|
73
77
|
});
|
|
74
78
|
}
|
|
@@ -492,9 +496,7 @@ describe("Streaming in-progress without timers", () => {
|
|
|
492
496
|
const messageId = "m_step";
|
|
493
497
|
const toolCallId = "tc_step";
|
|
494
498
|
|
|
495
|
-
await agent.emit(
|
|
496
|
-
type: EventType.RUN_STARTED,
|
|
497
|
-
} as BaseEvent);
|
|
499
|
+
await agent.emit(runStartedEvent());
|
|
498
500
|
await agent.emit({
|
|
499
501
|
type: EventType.TEXT_MESSAGE_CHUNK,
|
|
500
502
|
messageId,
|
|
@@ -543,9 +545,7 @@ describe("Streaming in-progress without timers", () => {
|
|
|
543
545
|
expect(el.textContent).toContain("21");
|
|
544
546
|
});
|
|
545
547
|
|
|
546
|
-
await agent.emit(
|
|
547
|
-
type: EventType.RUN_FINISHED,
|
|
548
|
-
} as BaseEvent);
|
|
548
|
+
await agent.emit(runFinishedEvent());
|
|
549
549
|
await agent.complete();
|
|
550
550
|
});
|
|
551
551
|
});
|
|
@@ -586,9 +586,7 @@ describe("Executing State Transitions", () => {
|
|
|
586
586
|
const messageId = "m_exec";
|
|
587
587
|
const toolCallId = "tc_exec";
|
|
588
588
|
|
|
589
|
-
await agent.emit(
|
|
590
|
-
type: EventType.RUN_STARTED,
|
|
591
|
-
} as BaseEvent);
|
|
589
|
+
await agent.emit(runStartedEvent());
|
|
592
590
|
await agent.emit({
|
|
593
591
|
type: EventType.TOOL_CALL_CHUNK,
|
|
594
592
|
toolCallId,
|
|
@@ -603,9 +601,7 @@ describe("Executing State Transitions", () => {
|
|
|
603
601
|
expect(status.textContent).toMatch(/Value: test/);
|
|
604
602
|
});
|
|
605
603
|
|
|
606
|
-
await agent.emit(
|
|
607
|
-
type: EventType.RUN_FINISHED,
|
|
608
|
-
} as BaseEvent);
|
|
604
|
+
await agent.emit(runFinishedEvent());
|
|
609
605
|
await agent.complete();
|
|
610
606
|
|
|
611
607
|
await waitFor(() => {
|
|
@@ -653,9 +649,7 @@ describe("Multiple Tool Calls in Same Message", () => {
|
|
|
653
649
|
const toolCallId2 = "tc_2";
|
|
654
650
|
const toolCallId3 = "tc_3";
|
|
655
651
|
|
|
656
|
-
await agent.emit(
|
|
657
|
-
type: EventType.RUN_STARTED,
|
|
658
|
-
} as BaseEvent);
|
|
652
|
+
await agent.emit(runStartedEvent());
|
|
659
653
|
await agent.emit({
|
|
660
654
|
type: EventType.TOOL_CALL_CHUNK,
|
|
661
655
|
toolCallId: toolCallId1,
|
|
@@ -714,9 +708,7 @@ describe("Multiple Tool Calls in Same Message", () => {
|
|
|
714
708
|
expect(screen.getByTestId("tool1-third").textContent).toContain("C");
|
|
715
709
|
});
|
|
716
710
|
|
|
717
|
-
await agent.emit(
|
|
718
|
-
type: EventType.RUN_FINISHED,
|
|
719
|
-
} as BaseEvent);
|
|
711
|
+
await agent.emit(runFinishedEvent());
|
|
720
712
|
await agent.complete();
|
|
721
713
|
});
|
|
722
714
|
});
|
|
@@ -747,9 +739,7 @@ describe("Partial Args Accumulation", () => {
|
|
|
747
739
|
const messageId = "m_partial";
|
|
748
740
|
const toolCallId = "tc_partial";
|
|
749
741
|
|
|
750
|
-
await agent.emit(
|
|
751
|
-
type: EventType.RUN_STARTED,
|
|
752
|
-
} as BaseEvent);
|
|
742
|
+
await agent.emit(runStartedEvent());
|
|
753
743
|
await agent.emit({
|
|
754
744
|
type: EventType.TOOL_CALL_CHUNK,
|
|
755
745
|
toolCallId,
|
|
@@ -801,9 +791,7 @@ describe("Partial Args Accumulation", () => {
|
|
|
801
791
|
expect(tool.textContent).toMatch(/Status: (complete|inProgress)/i);
|
|
802
792
|
});
|
|
803
793
|
|
|
804
|
-
await agent.emit(
|
|
805
|
-
type: EventType.RUN_FINISHED,
|
|
806
|
-
} as BaseEvent);
|
|
794
|
+
await agent.emit(runFinishedEvent());
|
|
807
795
|
await agent.complete();
|
|
808
796
|
});
|
|
809
797
|
});
|
|
@@ -885,7 +873,7 @@ describe("toolCallId parity for registered renderers", () => {
|
|
|
885
873
|
const messageId = "m_id";
|
|
886
874
|
const toolCallId = "tc_id_parity";
|
|
887
875
|
|
|
888
|
-
await agent.emit(
|
|
876
|
+
await agent.emit(runStartedEvent());
|
|
889
877
|
await agent.emit({
|
|
890
878
|
type: EventType.TOOL_CALL_CHUNK,
|
|
891
879
|
toolCallId,
|
|
@@ -900,7 +888,7 @@ describe("toolCallId parity for registered renderers", () => {
|
|
|
900
888
|
expect(el.textContent).toContain(`id:${toolCallId}`);
|
|
901
889
|
});
|
|
902
890
|
|
|
903
|
-
await agent.emit(
|
|
891
|
+
await agent.emit(runFinishedEvent());
|
|
904
892
|
await agent.complete();
|
|
905
893
|
|
|
906
894
|
await waitFor(() => {
|
|
@@ -948,6 +936,8 @@ describe("toolCallId parity for registered renderers", () => {
|
|
|
948
936
|
describe("Status Persistence After Agent Stops", () => {
|
|
949
937
|
it("should remain in InProgress status after agent stops if no result", async () => {
|
|
950
938
|
const agent = new MockStepwiseAgent();
|
|
939
|
+
const firstRun = { threadId: agent.threadId, runId: "first-run" };
|
|
940
|
+
const secondRun = { threadId: agent.threadId, runId: "second-run" };
|
|
951
941
|
renderChatHarness({
|
|
952
942
|
agent,
|
|
953
943
|
frontendTools: [
|
|
@@ -967,9 +957,7 @@ describe("Status Persistence After Agent Stops", () => {
|
|
|
967
957
|
const messageId = "msg_status";
|
|
968
958
|
const toolCallId = "tc_status";
|
|
969
959
|
|
|
970
|
-
await agent.emit(
|
|
971
|
-
type: EventType.RUN_STARTED,
|
|
972
|
-
} as BaseEvent);
|
|
960
|
+
await agent.emit(runStartedEvent(firstRun));
|
|
973
961
|
await agent.emit({
|
|
974
962
|
type: EventType.TOOL_CALL_CHUNK,
|
|
975
963
|
toolCallId,
|
|
@@ -983,9 +971,7 @@ describe("Status Persistence After Agent Stops", () => {
|
|
|
983
971
|
expect(statusElement.textContent).toBe("inProgress");
|
|
984
972
|
});
|
|
985
973
|
|
|
986
|
-
await agent.emit(
|
|
987
|
-
type: EventType.RUN_FINISHED,
|
|
988
|
-
} as BaseEvent);
|
|
974
|
+
await agent.emit(runFinishedEvent(firstRun));
|
|
989
975
|
|
|
990
976
|
await waitFor(() => {
|
|
991
977
|
const statusElement = screen.getByTestId("status");
|
|
@@ -996,9 +982,7 @@ describe("Status Persistence After Agent Stops", () => {
|
|
|
996
982
|
expect(statusElement.textContent).toBe("inProgress");
|
|
997
983
|
expect(statusElement.textContent).not.toBe("complete");
|
|
998
984
|
|
|
999
|
-
await agent.emit(
|
|
1000
|
-
type: EventType.RUN_STARTED,
|
|
1001
|
-
} as BaseEvent);
|
|
985
|
+
await agent.emit(runStartedEvent(secondRun));
|
|
1002
986
|
await agent.emit({
|
|
1003
987
|
type: EventType.TOOL_CALL_RESULT,
|
|
1004
988
|
toolCallId,
|
|
@@ -1011,9 +995,7 @@ describe("Status Persistence After Agent Stops", () => {
|
|
|
1011
995
|
expect(statusEl.textContent).toBe("complete");
|
|
1012
996
|
});
|
|
1013
997
|
|
|
1014
|
-
await agent.emit(
|
|
1015
|
-
type: EventType.RUN_FINISHED,
|
|
1016
|
-
} as BaseEvent);
|
|
998
|
+
await agent.emit(runFinishedEvent(secondRun));
|
|
1017
999
|
await agent.complete();
|
|
1018
1000
|
});
|
|
1019
1001
|
});
|
|
@@ -17,6 +17,10 @@ import CopilotKitProvider from "../../../providers/CopilotKitProvider.vue";
|
|
|
17
17
|
import CopilotChatConfigurationProvider from "../../../providers/CopilotChatConfigurationProvider.vue";
|
|
18
18
|
import CopilotChat from "../CopilotChat.vue";
|
|
19
19
|
import type { VueFrontendTool } from "../../../types";
|
|
20
|
+
import {
|
|
21
|
+
runStartedEvent,
|
|
22
|
+
runFinishedEvent,
|
|
23
|
+
} from "../../../__tests__/utils/test-helpers";
|
|
20
24
|
|
|
21
25
|
afterEach(() => {
|
|
22
26
|
cleanup();
|
|
@@ -183,9 +187,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
183
187
|
const messageId = "m_rerender_test";
|
|
184
188
|
const toolCallId = "tc_rerender_test";
|
|
185
189
|
|
|
186
|
-
await agent.emit(
|
|
187
|
-
type: EventType.RUN_STARTED,
|
|
188
|
-
} as BaseEvent);
|
|
190
|
+
await agent.emit(runStartedEvent());
|
|
189
191
|
await agent.emit({
|
|
190
192
|
type: EventType.TOOL_CALL_CHUNK,
|
|
191
193
|
toolCallId,
|
|
@@ -252,9 +254,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
252
254
|
expect(screen.getByTestId("location").textContent).toBe("Paris");
|
|
253
255
|
expect(screen.getByTestId("result").textContent).toContain("temperature");
|
|
254
256
|
|
|
255
|
-
await agent.emit(
|
|
256
|
-
type: EventType.RUN_FINISHED,
|
|
257
|
-
} as BaseEvent);
|
|
257
|
+
await agent.emit(runFinishedEvent());
|
|
258
258
|
await agent.complete();
|
|
259
259
|
});
|
|
260
260
|
|
|
@@ -302,9 +302,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
302
302
|
const messageId = "m_search";
|
|
303
303
|
const toolCallId = "tc_search";
|
|
304
304
|
|
|
305
|
-
await agent.emit(
|
|
306
|
-
type: EventType.RUN_STARTED,
|
|
307
|
-
} as BaseEvent);
|
|
305
|
+
await agent.emit(runStartedEvent());
|
|
308
306
|
await agent.emit({
|
|
309
307
|
type: EventType.TOOL_CALL_CHUNK,
|
|
310
308
|
toolCallId,
|
|
@@ -334,9 +332,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
334
332
|
const renderCountAfterText = toolRenderCount;
|
|
335
333
|
expect(renderCountAfterText).toBe(renderCountAfterToolCall);
|
|
336
334
|
|
|
337
|
-
await agent.emit(
|
|
338
|
-
type: EventType.RUN_FINISHED,
|
|
339
|
-
} as BaseEvent);
|
|
335
|
+
await agent.emit(runFinishedEvent());
|
|
340
336
|
await agent.complete();
|
|
341
337
|
});
|
|
342
338
|
|
|
@@ -384,9 +380,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
384
380
|
const messageId = "m_search_update";
|
|
385
381
|
const toolCallId = "tc_search_update";
|
|
386
382
|
|
|
387
|
-
await agent.emit(
|
|
388
|
-
type: EventType.RUN_STARTED,
|
|
389
|
-
} as BaseEvent);
|
|
383
|
+
await agent.emit(runStartedEvent());
|
|
390
384
|
await agent.emit({
|
|
391
385
|
type: EventType.TOOL_CALL_CHUNK,
|
|
392
386
|
toolCallId,
|
|
@@ -422,9 +416,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
422
416
|
expect(capturedArgs).toContain("Rea");
|
|
423
417
|
expect(capturedArgs).toContain("React hooks");
|
|
424
418
|
|
|
425
|
-
await agent.emit(
|
|
426
|
-
type: EventType.RUN_FINISHED,
|
|
427
|
-
} as BaseEvent);
|
|
419
|
+
await agent.emit(runFinishedEvent());
|
|
428
420
|
await agent.complete();
|
|
429
421
|
});
|
|
430
422
|
|
|
@@ -471,9 +463,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
471
463
|
const messageId = "m_data";
|
|
472
464
|
const toolCallId = "tc_data";
|
|
473
465
|
|
|
474
|
-
await agent.emit(
|
|
475
|
-
type: EventType.RUN_STARTED,
|
|
476
|
-
} as BaseEvent);
|
|
466
|
+
await agent.emit(runStartedEvent());
|
|
477
467
|
await agent.emit({
|
|
478
468
|
type: EventType.TOOL_CALL_CHUNK,
|
|
479
469
|
toolCallId,
|
|
@@ -508,9 +498,7 @@ describe("Tool Call Re-render Prevention", () => {
|
|
|
508
498
|
expect(capturedStatuses).toContain(ToolCallStatus.InProgress);
|
|
509
499
|
expect(capturedStatuses).toContain(ToolCallStatus.Complete);
|
|
510
500
|
|
|
511
|
-
await agent.emit(
|
|
512
|
-
type: EventType.RUN_FINISHED,
|
|
513
|
-
} as BaseEvent);
|
|
501
|
+
await agent.emit(runFinishedEvent());
|
|
514
502
|
await agent.complete();
|
|
515
503
|
});
|
|
516
504
|
});
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Message, ToolCall, ToolMessage } from "@ag-ui/core";
|
|
2
|
+
import { contentToText } from "@ag-ui/core";
|
|
2
3
|
import { DEFAULT_AGENT_ID } from "@copilotkit/shared";
|
|
3
4
|
import { ToolCallStatus } from "@copilotkit/core";
|
|
4
5
|
import { partialJSONParse } from "@copilotkit/shared";
|
|
@@ -53,7 +54,7 @@ export function getToolCallRenderProps(
|
|
|
53
54
|
name: toolCall.function.name,
|
|
54
55
|
args: parsedArgs,
|
|
55
56
|
status: ToolCallStatus.Complete,
|
|
56
|
-
result: toolMessage.content,
|
|
57
|
+
result: contentToText(toolMessage.content),
|
|
57
58
|
toolCall,
|
|
58
59
|
toolMessage,
|
|
59
60
|
};
|
|
@@ -84,7 +85,7 @@ export function getCoreRenderProps(
|
|
|
84
85
|
toolCallId: toolCall.id,
|
|
85
86
|
args: parsedArgs,
|
|
86
87
|
status: ToolCallStatus.Complete,
|
|
87
|
-
result: toolMessage.content,
|
|
88
|
+
result: contentToText(toolMessage.content),
|
|
88
89
|
};
|
|
89
90
|
}
|
|
90
91
|
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { AbstractAgent, HttpAgent } from "@ag-ui/client";
|
|
2
|
+
import { defineComponent, h, nextTick } from "vue";
|
|
3
|
+
import { describe, expect, it } from "vitest";
|
|
4
|
+
import { mountWithProvider } from "../../__tests__/utils/mount";
|
|
5
|
+
import { useAgent } from "../use-agent";
|
|
6
|
+
|
|
7
|
+
// Models an HttpAgent from another installed copy of @ag-ui/client.
|
|
8
|
+
class ForeignHttpAgent extends AbstractAgent {
|
|
9
|
+
url = "https://agent.example";
|
|
10
|
+
headers: Record<string, string> = {
|
|
11
|
+
Authorization: "Bearer agent-token",
|
|
12
|
+
"X-Agent": "agent",
|
|
13
|
+
};
|
|
14
|
+
abortController = new AbortController();
|
|
15
|
+
|
|
16
|
+
run(): never {
|
|
17
|
+
throw new Error("This test does not run the agent");
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
describe("useAgent headers (Vue-specific semantics)", () => {
|
|
22
|
+
it.each([
|
|
23
|
+
[
|
|
24
|
+
"HttpAgent",
|
|
25
|
+
() =>
|
|
26
|
+
new HttpAgent({
|
|
27
|
+
url: "https://agent.example",
|
|
28
|
+
headers: { Authorization: "Bearer agent-token", "X-Agent": "agent" },
|
|
29
|
+
}),
|
|
30
|
+
],
|
|
31
|
+
["foreign HttpAgent", () => new ForeignHttpAgent()],
|
|
32
|
+
] as const)(
|
|
33
|
+
"preserves %s headers when the provider changes headers",
|
|
34
|
+
async (_name, createAgent) => {
|
|
35
|
+
const agent = createAgent();
|
|
36
|
+
let headersAfterHook: Record<string, string> | undefined;
|
|
37
|
+
const Child = defineComponent({
|
|
38
|
+
setup() {
|
|
39
|
+
useAgent();
|
|
40
|
+
headersAfterHook = { ...agent.headers };
|
|
41
|
+
return () => null;
|
|
42
|
+
},
|
|
43
|
+
});
|
|
44
|
+
const { wrapper } = mountWithProvider(() => h(Child), {
|
|
45
|
+
runtimeUrl: undefined,
|
|
46
|
+
agents__unsafe_dev_only: { default: agent },
|
|
47
|
+
headers: { "X-Core": "initial" },
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
try {
|
|
51
|
+
expect(headersAfterHook).toEqual({
|
|
52
|
+
Authorization: "Bearer agent-token",
|
|
53
|
+
"X-Agent": "agent",
|
|
54
|
+
"X-Core": "initial",
|
|
55
|
+
});
|
|
56
|
+
expect(agent.headers).toEqual({
|
|
57
|
+
Authorization: "Bearer agent-token",
|
|
58
|
+
"X-Agent": "agent",
|
|
59
|
+
"X-Core": "initial",
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
await wrapper.setProps({
|
|
63
|
+
headers: { Authorization: "Bearer core-token", "X-Core": "updated" },
|
|
64
|
+
});
|
|
65
|
+
await nextTick();
|
|
66
|
+
expect(agent.headers).toEqual({
|
|
67
|
+
Authorization: "Bearer core-token",
|
|
68
|
+
"X-Agent": "agent",
|
|
69
|
+
"X-Core": "updated",
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
await wrapper.setProps({ headers: {} });
|
|
73
|
+
await nextTick();
|
|
74
|
+
expect(agent.headers).toEqual({
|
|
75
|
+
Authorization: "Bearer agent-token",
|
|
76
|
+
"X-Agent": "agent",
|
|
77
|
+
});
|
|
78
|
+
} finally {
|
|
79
|
+
wrapper.unmount();
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
);
|
|
83
|
+
});
|
|
@@ -34,6 +34,7 @@ describe("useAgent stability during runtime connection", () => {
|
|
|
34
34
|
// need a no-op subscription object here; stability/ref-identity behavior
|
|
35
35
|
// is orthogonal to subscribe internals.
|
|
36
36
|
subscribeToAgentWithOptions: ReturnType<typeof vi.fn>;
|
|
37
|
+
applyHeadersToAgent: ReturnType<typeof vi.fn>;
|
|
37
38
|
};
|
|
38
39
|
|
|
39
40
|
let mockCopilotkit: MockCopilotkit;
|
|
@@ -49,6 +50,7 @@ describe("useAgent stability during runtime connection", () => {
|
|
|
49
50
|
headers: {},
|
|
50
51
|
agents: {},
|
|
51
52
|
subscribeToAgentWithOptions: vi.fn(() => ({ unsubscribe: vi.fn() })),
|
|
53
|
+
applyHeadersToAgent: vi.fn(),
|
|
52
54
|
});
|
|
53
55
|
mockCopilotkit = copilotkitRef.value;
|
|
54
56
|
|
|
@@ -2,7 +2,7 @@ import { defineComponent } from "vue";
|
|
|
2
2
|
import { screen, fireEvent, waitFor, cleanup } from "@testing-library/vue";
|
|
3
3
|
import { afterEach, describe, expect, it } from "vitest";
|
|
4
4
|
import { EventType } from "@ag-ui/client";
|
|
5
|
-
import type { BaseEvent, RunAgentInput } from "@ag-ui/client";
|
|
5
|
+
import type { BaseEvent, RunAgentInput, RunErrorEvent } from "@ag-ui/client";
|
|
6
6
|
import type { Observable } from "rxjs";
|
|
7
7
|
import {
|
|
8
8
|
MockStepwiseAgent,
|
|
@@ -174,9 +174,11 @@ describe("useAgent e2e", () => {
|
|
|
174
174
|
expect(screen.getByTestId("status").textContent).toBe("running");
|
|
175
175
|
});
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
const errorEvent: RunErrorEvent = {
|
|
178
178
|
type: EventType.RUN_ERROR,
|
|
179
|
-
|
|
179
|
+
message: "The agent run failed",
|
|
180
|
+
};
|
|
181
|
+
await agent.emit(errorEvent);
|
|
180
182
|
await agent.complete();
|
|
181
183
|
|
|
182
184
|
await waitFor(() => {
|
|
@@ -665,7 +665,7 @@ describe("useFrontendTool E2E - Dynamic Registration", () => {
|
|
|
665
665
|
const messageId = testId(`m-${this.runCount}`);
|
|
666
666
|
const toolCallId = testId(`tc-${this.runCount}`);
|
|
667
667
|
const valueArg = this.runCount === 1 ? "first call" : "second call";
|
|
668
|
-
observer.next(
|
|
668
|
+
observer.next(runStartedEvent(_input));
|
|
669
669
|
observer.next({
|
|
670
670
|
type: EventType.TOOL_CALL_CHUNK,
|
|
671
671
|
toolCallId,
|
|
@@ -673,7 +673,7 @@ describe("useFrontendTool E2E - Dynamic Registration", () => {
|
|
|
673
673
|
parentMessageId: messageId,
|
|
674
674
|
delta: JSON.stringify({ value: valueArg }),
|
|
675
675
|
} as BaseEvent);
|
|
676
|
-
observer.next(
|
|
676
|
+
observer.next(runFinishedEvent(_input));
|
|
677
677
|
observer.complete();
|
|
678
678
|
return () => {};
|
|
679
679
|
});
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { computed, shallowRef, toValue, triggerRef, watch } from "vue";
|
|
2
2
|
import type { MaybeRefOrGetter } from "vue";
|
|
3
3
|
import { DEFAULT_AGENT_ID } from "@copilotkit/shared";
|
|
4
|
-
import { HttpAgent } from "@ag-ui/client";
|
|
5
4
|
import type { AbstractAgent } from "@ag-ui/client";
|
|
6
5
|
import {
|
|
7
6
|
ProxiedCopilotRuntimeAgent,
|
|
8
7
|
CopilotKitCoreRuntimeConnectionStatus,
|
|
8
|
+
ɵisHttpAgent,
|
|
9
9
|
} from "@copilotkit/core";
|
|
10
10
|
import type {
|
|
11
11
|
CopilotRuntimeTransport,
|
|
@@ -392,8 +392,8 @@ export function useAgent(props: UseAgentProps = {}) {
|
|
|
392
392
|
),
|
|
393
393
|
],
|
|
394
394
|
([currentAgent]) => {
|
|
395
|
-
if (currentAgent
|
|
396
|
-
|
|
395
|
+
if (ɵisHttpAgent(currentAgent)) {
|
|
396
|
+
copilotkit.value.applyHeadersToAgent(currentAgent);
|
|
397
397
|
}
|
|
398
398
|
},
|
|
399
399
|
{ immediate: true },
|
package/src/v2/index.ts
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
// Re-export core (framework-agnostic)
|
|
2
2
|
export * from "@copilotkit/core";
|
|
3
3
|
export * from "@ag-ui/client";
|
|
4
|
+
// AG-UI 1.0 moved the zod validators from `@ag-ui/client` to this subpath.
|
|
5
|
+
// Re-export them so existing imports keep working. Both modules export
|
|
6
|
+
// PROTOCOL_VERSION, so name it once to keep it from being ambiguous.
|
|
7
|
+
export * from "@ag-ui/core/schemas";
|
|
8
|
+
export { PROTOCOL_VERSION } from "@ag-ui/client";
|
|
4
9
|
|
|
5
10
|
// Local V2 vue code
|
|
6
11
|
export * from "./components";
|