@assistant-ui/core 0.3.18 → 0.3.20

package/src/runtimes/tool-invocations/ToolInvocationTracker.test.ts

@@ -1465,6 +1465,139 @@ describe("ToolInvocationTracker", () => {
     expect(onResult).not.toHaveBeenCalled();
   });
 
+  it("keeps a resolved restored tool call historical when its snapshot is reserialized", async () => {
+    const execute = vi.fn(async () => ({ forecast: "ok" }));
+    const streamCall = vi.fn();
+    const getTools = () => ({
+      weatherSearch: {
+        parameters: { type: "object", properties: {} },
+        execute,
+        streamCall,
+      } satisfies Tool,
+    });
+    const onResult = vi.fn();
+    const tracker = new ToolInvocationTracker(getTools, {
+      onResult,
+      onStatusesChange: () => {},
+    });
+
+    tracker.setState(
+      createState([
+        createAssistantMessage(
+          '{"query":"London","page":1}',
+          { query: "London", page: 1 },
+          { result: { source: "history", revision: 1 } },
+        ),
+      ]),
+    );
+
+    tracker.setState(
+      createState([
+        createAssistantMessage(
+          '{ "page": 1, "query": "London" }',
+          { query: "London", page: 1 },
+          { result: { source: "history", revision: 2 } },
+        ),
+      ]),
+    );
+
+    await new Promise((r) => setTimeout(r, 0));
+
+    expect(streamCall).not.toHaveBeenCalled();
+    expect(execute).not.toHaveBeenCalled();
+    expect(onResult).not.toHaveBeenCalled();
+  });
+
+  it("promotes unresolved restored tool calls only for real args changes or a landed result", async () => {
+    const equivalentStreamCall = vi.fn();
+    const growingStreamCall = vi.fn();
+    const resolvedStreamCall = vi.fn();
+    const getTools = () => ({
+      equivalentTool: {
+        parameters: { type: "object", properties: {} },
+        streamCall: equivalentStreamCall,
+      } satisfies Tool,
+      growingTool: {
+        parameters: { type: "object", properties: {} },
+        streamCall: growingStreamCall,
+      } satisfies Tool,
+      resolvedTool: {
+        parameters: { type: "object", properties: {} },
+        streamCall: resolvedStreamCall,
+      } satisfies Tool,
+    });
+    const tracker = new ToolInvocationTracker(getTools, {
+      onResult: vi.fn(),
+      onStatusesChange: () => {},
+    });
+
+    tracker.setState(
+      createState([
+        createAssistantMessage(
+          '{"a":1,"b":2}',
+          { a: 1, b: 2 },
+          {
+            toolCallId: "equivalent",
+            toolName: "equivalentTool",
+          },
+        ),
+        createAssistantMessage(
+          '{"query":"Lon',
+          { query: "Lon" },
+          {
+            toolCallId: "growing",
+            toolName: "growingTool",
+          },
+        ),
+        createAssistantMessage(
+          '{"city":"London"}',
+          { city: "London" },
+          {
+            toolCallId: "resolved",
+            toolName: "resolvedTool",
+          },
+        ),
+      ]),
+    );
+
+    tracker.setState(
+      createState([
+        createAssistantMessage(
+          '{ "b": 2, "a": 1 }',
+          { a: 1, b: 2 },
+          {
+            toolCallId: "equivalent",
+            toolName: "equivalentTool",
+          },
+        ),
+        createAssistantMessage(
+          '{"query":"London"}',
+          { query: "London" },
+          {
+            toolCallId: "growing",
+            toolName: "growingTool",
+          },
+        ),
+        createAssistantMessage(
+          '{"city":"London"}',
+          { city: "London" },
+          {
+            toolCallId: "resolved",
+            toolName: "resolvedTool",
+            result: { source: "history" },
+          },
+        ),
+      ]),
+    );
+
+    await waitFor(() => {
+      expect(growingStreamCall).toHaveBeenCalledTimes(1);
+      expect(resolvedStreamCall).toHaveBeenCalledTimes(1);
+    });
+
+    expect(equivalentStreamCall).not.toHaveBeenCalled();
+  });
+
   it("promotes an in-progress tool call from the initial snapshot when it changes", async () => {
     const execute = vi.fn(async () => ({ forecast: "ok" }));
     const streamCall = vi.fn();

package/src/runtimes/tool-invocations/ToolInvocationTracker.ts

@@ -825,12 +825,16 @@ export class ToolInvocationTracker {
         this._discardedToolCallIds.delete(content.toolCallId);
 
       if (entry && !entry.controller) {
-        // Restored entry observed in a live snapshot. Promote if its
-        // signature has changed; otherwise treat as still-historical.
-        const signatureChanged =
-          content.argsText !== entry.argsText ||
-          (content.result !== undefined) !== entry.hasResult;
-        if (!signatureChanged) continue;
+        // A restored entry with a result remains historical.
+        if (entry.hasResult) continue;
+        const argsChanged =
+          content.argsText !== entry.argsText &&
+          !(
+            isArgsTextComplete(entry.argsText) &&
+            isArgsTextComplete(content.argsText) &&
+            isEquivalentCompleteArgsText(entry.argsText, content.argsText)
+          );
+        if (!argsChanged && content.result === undefined) continue;
         this._entries.delete(content.toolCallId);
         entry = undefined;
       }

package/src/store/clients/external-thread.ts

@@ -55,6 +55,7 @@ import { toMessagePartStatus } from "../../utils/normalizePartStatus";
 import { generateId } from "../../utils/id";
 import { ModelContext } from "./model-context-client";
 import { ThreadSuggestions } from "./suggestions";
+import { createTaskDeriver, getTaskKey, TaskClient } from "./thread-tasks";
 import { Tools } from "../../react/client/Tools";
 import { DataRenderers } from "../../react/client/DataRenderers";
 import { SingleThreadList } from "./single-thread-list";
@@ -141,8 +142,13 @@ type MessageClientProps = {
   onAddToolResult?: ((options: AddToolResultOptions) => void) | undefined;
   onResumeToolCall?: ((options: ResumeToolCallOptions) => void) | undefined;
   attachmentAdapter?: AttachmentAdapter | undefined;
-  submittedFeedback: "positive" | "negative" | undefined;
-  onSubmitFeedback: (feedback: { type: "positive" | "negative" }) => void;
+  submittedFeedback:
+    | { type: "positive" | "negative"; comment?: string }
+    | undefined;
+  onSubmitFeedback: (feedback: {
+    type: "positive" | "negative";
+    comment?: string;
+  }) => void;
   speech: SpeechState | undefined;
   onSpeak: () => void;
   onStopSpeaking: () => void;
@@ -235,7 +241,7 @@ const useMessageClient = ({
             ...message,
             metadata: {
               ...message.metadata,
-              submittedFeedback: { type: submittedFeedback },
+              submittedFeedback,
             },
           }
         : message;
@@ -569,7 +575,7 @@ const useComposerClientResource = ({
     await Promise.all(
       removed
         .filter((a) => a.status.type !== "complete")
-        .map((a) => attachmentAdapter.remove(a)),
+        .map(async (a) => attachmentAdapter.remove(a)),
     );
   };
 
@@ -930,16 +936,24 @@ const useExternalThread = ({
     Record<
       string,
       {
-        type: "positive" | "negative";
-        external: "positive" | "negative" | undefined;
+        feedback: { type: "positive" | "negative"; comment?: string };
+        external:
+          | {
+              readonly type: "positive" | "negative";
+              readonly comment?: string;
+            }
+          | undefined;
       }
     >
   >({});
 
   const feedbackFor = (msg: ExternalThreadMessage) => {
     const entry = submittedFeedback[msg.id];
-    return entry && msg.metadata.submittedFeedback?.type === entry.external
-      ? entry.type
+    const external = msg.metadata.submittedFeedback;
+    return entry &&
+      external?.type === entry.external?.type &&
+      external?.comment === entry.external?.comment
+      ? entry.feedback
       : undefined;
   };
 
@@ -951,7 +965,11 @@ const useExternalThread = ({
     setSubmittedFeedback((prev) => {
       const live = Object.entries(prev).filter(([id, entry]) => {
         const msg = messages.find((m) => m.id === id);
-        return !!msg && msg.metadata.submittedFeedback?.type === entry.external;
+        return (
+          !!msg &&
+          msg.metadata.submittedFeedback?.type === entry.external?.type &&
+          msg.metadata.submittedFeedback?.comment === entry.external?.comment
+        );
       });
       return live.length === Object.keys(prev).length
         ? prev
@@ -961,17 +979,21 @@ const useExternalThread = ({
 
   const handleSubmitFeedback = (
     message: ExternalThreadMessage,
-    { type }: { type: "positive" | "negative" },
+    feedback: { type: "positive" | "negative"; comment?: string },
   ) => {
-    if (!feedbackAdapter) throw new Error("Feedback adapter not configured");
-    feedbackAdapter.submit({ message, type });
+    const comment = feedback.comment?.trim();
+    const submittedFeedback = {
+      type: feedback.type,
+      ...(comment ? { comment } : undefined),
+    };
+    feedbackAdapter?.submit({ message, ...submittedFeedback });
 
     if (message.role === "assistant") {
       setSubmittedFeedback((prev) => ({
         ...prev,
         [message.id]: {
-          type,
-          external: message.metadata.submittedFeedback?.type,
+          feedback: submittedFeedback,
+          external: message.metadata.submittedFeedback,
         },
       }));
     }
@@ -1025,6 +1047,14 @@ const useExternalThread = ({
     }),
   );
 
+  const taskDeriver = useMemo(() => createTaskDeriver(), []);
+  const tasks = useMemo(() => taskDeriver(messages), [taskDeriver, messages]);
+  const taskClients = useClientLookup(
+    tasks.map((task) =>
+      withKey(getTaskKey(task), TaskClient({ task }), [task]),
+    ),
+  );
+
   const handleCancelRun = () => {
     // Nothing is aborted without a handler, so pausing the queue would hold
     // the pending items against a run that keeps going.
@@ -1109,6 +1139,7 @@ const useExternalThread = ({
         queue: hasQueue,
       },
       messages: messageStates,
+      tasks,
       state: threadState ?? {},
       suggestions: EMPTY_SUGGESTIONS,
       extras,
@@ -1134,12 +1165,20 @@ const useExternalThread = ({
     speech,
     messageClients.state,
     composerClient.state,
+    tasks,
   ]);
 
   return {
     getState: () => state,
     composer: () => composerClient.methods,
     suggestions: () => suggestionsClient.methods,
+    task: (selector) => {
+      if ("id" in selector) {
+        const task = tasks.find((candidate) => candidate.id === selector.id);
+        return taskClients.get({ key: task ? getTaskKey(task) : selector.id });
+      }
+      return taskClients.get(selector);
+    },
     append: (message) => {
       const appendMessage: AppendMessage =
         typeof message === "string"

package/src/store/clients/thread-tasks.test.ts

@@ -0,0 +1,274 @@
+import { describe, expect, it } from "vitest";
+import type { ThreadMessage, ToolCallMessagePart } from "../../types/message";
+import { createTaskDeriver, getTaskKey } from "./thread-tasks";
+
+const assistantMessage = (
+  id: string,
+  status:
+    | { type: "running" }
+    | { type: "complete"; reason: "stop" }
+    | { type: "incomplete"; reason: "error"; error: unknown },
+  content:
+    | readonly ToolCallMessagePart[]
+    | readonly { type: "text"; text: string }[],
+) =>
+  ({
+    id,
+    role: "assistant",
+    createdAt: new Date(0),
+    content,
+    status,
+    metadata: {
+      unstable_state: {},
+      unstable_annotations: [],
+      unstable_data: [],
+      steps: [],
+      custom: {},
+    },
+  }) as unknown as ThreadMessage;
+
+const toolCall = (
+  id: string,
+  messages?: readonly ThreadMessage[],
+  result?: unknown,
+) =>
+  ({
+    type: "tool-call",
+    toolCallId: id,
+    toolName: "delegate",
+    args: { id },
+    argsText: JSON.stringify({ id }),
+    ...(messages !== undefined ? { messages } : undefined),
+    ...(result !== undefined ? { result } : undefined),
+  }) as ToolCallMessagePart;
+
+describe("createTaskDeriver", () => {
+  it("derives top-level and nested tasks in document order", () => {
+    const nestedTask = toolCall("nested-1", []);
+    const nestedMessage = assistantMessage(
+      "nested-message",
+      { type: "running" },
+      [nestedTask],
+    );
+    const topLevelTask = toolCall("top-level-1", [nestedMessage]);
+    const tasks = createTaskDeriver()([
+      assistantMessage("outer-message", { type: "running" }, [topLevelTask]),
+    ]);
+
+    expect(tasks.map((task) => task.id)).toEqual(["top-level-1", "nested-1"]);
+    expect(tasks[0]).toMatchObject({
+      depth: 0,
+      parentTaskId: null,
+      messageId: "outer-message",
+    });
+    expect(tasks[1]).toMatchObject({
+      depth: 1,
+      parentTaskId: "top-level-1",
+      messageId: "nested-message",
+    });
+  });
+
+  it("uses normalized tool call statuses", () => {
+    const tasks = createTaskDeriver()([
+      assistantMessage("outer-message", { type: "running" }, [
+        toolCall("pending", []),
+        toolCall("complete", [], "done"),
+      ]),
+    ]);
+
+    expect(tasks.map((task) => task.status)).toEqual([
+      { type: "running" },
+      { type: "complete" },
+    ]);
+  });
+
+  it("excludes tool calls without nested messages", () => {
+    const tasks = createTaskDeriver()([
+      assistantMessage("outer-message", { type: "running" }, [
+        toolCall("not-a-task"),
+        toolCall("task", []),
+      ]),
+    ]);
+
+    expect(tasks.map((task) => task.id)).toEqual(["task"]);
+  });
+
+  it("preserves the array identity when an unrelated sibling changes", () => {
+    const task = toolCall("delegate-1", []);
+    const derive = createTaskDeriver();
+    const initial = derive([
+      assistantMessage("outer-message", { type: "running" }, [
+        { type: "text", text: "one" },
+        task,
+      ] as unknown as readonly ToolCallMessagePart[]),
+    ]);
+    const updated = derive([
+      assistantMessage("outer-message", { type: "running" }, [
+        { type: "text", text: "two" },
+        task,
+      ] as unknown as readonly ToolCallMessagePart[]),
+    ]);
+
+    expect(updated).toBe(initial);
+  });
+
+  it("creates a fresh entry and array when a nested status changes", () => {
+    const nestedTask = toolCall("nested-1", []);
+    const derive = createTaskDeriver();
+    const initial = derive([
+      assistantMessage("outer-message", { type: "running" }, [
+        toolCall("top-level-1", [
+          assistantMessage("nested-message", { type: "running" }, [nestedTask]),
+        ]),
+      ]),
+    ]);
+    const updated = derive([
+      assistantMessage("outer-message", { type: "running" }, [
+        toolCall("top-level-1", [
+          assistantMessage(
+            "nested-message",
+            { type: "complete", reason: "stop" },
+            [nestedTask],
+          ),
+        ]),
+      ]),
+    ]);
+
+    expect(updated).not.toBe(initial);
+    expect(updated[1]).not.toBe(initial[1]);
+    expect(updated[1]?.status).toMatchObject({ type: "complete" });
+  });
+
+  it("creates a fresh entry when an incomplete status changes its error", () => {
+    const task = toolCall("failing", []);
+    const derive = createTaskDeriver();
+    const initial = derive([
+      assistantMessage(
+        "outer-message",
+        { type: "incomplete", reason: "error", error: "first" },
+        [task],
+      ),
+    ]);
+    const updated = derive([
+      assistantMessage(
+        "outer-message",
+        { type: "incomplete", reason: "error", error: "second" },
+        [task],
+      ),
+    ]);
+
+    expect(updated).not.toBe(initial);
+    expect(updated[0]).not.toBe(initial[0]);
+    expect(updated[0]?.status).toMatchObject({
+      type: "incomplete",
+      reason: "error",
+      error: "second",
+    });
+  });
+
+  it("rebuilds an entry when an unchanged part moves to another message", () => {
+    const part = toolCall("moving", []);
+    const derive = createTaskDeriver();
+    const initial = derive([
+      assistantMessage("first-message", { type: "running" }, [part]),
+    ]);
+    const moved = derive([
+      assistantMessage("second-message", { type: "running" }, [part]),
+    ]);
+
+    expect(moved[0]).not.toBe(initial[0]);
+    expect(moved[0]?.messageId).toBe("second-message");
+  });
+
+  it("stops descending past the depth cap", () => {
+    let content: readonly ToolCallMessagePart[] = [toolCall("leaf", [])];
+    for (let level = 40; level > 0; level -= 1) {
+      content = [
+        toolCall(`level-${level}`, [
+          assistantMessage(`message-${level}`, { type: "running" }, content),
+        ]),
+      ];
+    }
+    const tasks = createTaskDeriver()([
+      assistantMessage("root", { type: "running" }, content),
+    ]);
+
+    expect(Math.max(...tasks.map((task) => task.depth))).toBe(32);
+  });
+
+  it("keeps the array identity when nested conversations repeat a toolCallId", () => {
+    const nested = (messageId: string) =>
+      assistantMessage(messageId, { type: "complete", reason: "stop" }, [
+        toolCall("call_1", [], "ok"),
+      ]);
+    const messages = [
+      assistantMessage("outer-message", { type: "complete", reason: "stop" }, [
+        toolCall("delegate-a", [nested("nested-a")], "ok"),
+        toolCall("delegate-b", [nested("nested-b")], "ok"),
+      ]),
+    ];
+    const derive = createTaskDeriver();
+    const first = derive(messages);
+    const second = derive(messages);
+
+    expect(first.map((task) => task.id)).toEqual([
+      "delegate-a",
+      "call_1",
+      "delegate-b",
+      "call_1",
+    ]);
+    expect(second).toBe(first);
+  });
+
+  it("keys tasks by document order when nested payloads repeat every id", () => {
+    const replay = () =>
+      assistantMessage("nested", { type: "complete", reason: "stop" }, [
+        toolCall("call_1", [], "ok"),
+      ]);
+    const messages = [
+      assistantMessage("outer-message", { type: "complete", reason: "stop" }, [
+        toolCall("delegate-a", [replay()], "ok"),
+        toolCall("delegate-b", [replay()], "ok"),
+      ]),
+    ];
+    const derive = createTaskDeriver();
+    const first = derive(messages);
+
+    expect(new Set(first.map(getTaskKey)).size).toBe(4);
+    expect(derive(messages)).toBe(first);
+  });
+
+  it("reads a nested message without a status as complete", () => {
+    const unnormalized = {
+      ...assistantMessage("nested", { type: "running" }, [
+        toolCall("call_1", []),
+      ]),
+      status: undefined,
+    } as unknown as ThreadMessage;
+    const [, nestedTask] = createTaskDeriver()([
+      assistantMessage("outer-message", { type: "running" }, [
+        toolCall("delegate", [unnormalized], "ok"),
+      ]),
+    ]);
+
+    expect(nestedTask?.status).toEqual({ type: "complete" });
+  });
+
+  it("preserves unchanged entries when a task is appended", () => {
+    const first = toolCall("first", []);
+    const derive = createTaskDeriver();
+    const initial = derive([
+      assistantMessage("outer-message", { type: "running" }, [first]),
+    ]);
+    const updated = derive([
+      assistantMessage("outer-message", { type: "running" }, [
+        first,
+        toolCall("second", []),
+      ]),
+    ]);
+
+    expect(updated).not.toBe(initial);
+    expect(updated[0]).toBe(initial[0]);
+    expect(updated.map((task) => task.id)).toEqual(["first", "second"]);
+  });
+});