@assistant-ui/core 0.3.17 → 0.3.19

package/src/runtimes/remote-thread-list/title-generation.ts

@@ -0,0 +1,329 @@
+export type ThreadTitleClaim = {
+  readonly title: string;
+  readonly order: number;
+  readonly settled: Promise<boolean>;
+  readonly settle: (renamed: boolean) => void;
+};
+
+type ThreadTitleGeneration = {
+  readonly automatic: boolean;
+  readonly order: number;
+  claim: ThreadTitleClaim | null;
+  beforeGenerationClaims: readonly ThreadTitleClaim[];
+  superseded: boolean;
+  readonly persisted: Promise<string | undefined>;
+  readonly settlePersisted: (title: string | undefined) => void;
+};
+
+export type ThreadTitleState = {
+  generations: Set<ThreadTitleGeneration>;
+  pendingClaim: ThreadTitleClaim | null;
+  inFlightClaims: Set<ThreadTitleClaim>;
+  manualTitle: string | undefined;
+  latestExplicit: ThreadTitleGeneration | null;
+  nextOrder: number;
+};
+
+export type ThreadTitleGenerationRun = {
+  states: Map<string, ThreadTitleState>;
+  threadId: string;
+  automatic: boolean;
+  generate: (
+    onTitle: (title: string | undefined) => Promise<void>,
+  ) => Promise<void>;
+  rename: (title: string) => Promise<void>;
+  applyTitle: (title: string | undefined) => Promise<void>;
+};
+
+function getThreadTitleState(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+): ThreadTitleState {
+  let state = states.get(threadId);
+  if (state === undefined) {
+    state = {
+      generations: new Set(),
+      pendingClaim: null,
+      inFlightClaims: new Set(),
+      manualTitle: undefined,
+      latestExplicit: null,
+      nextOrder: 0,
+    };
+    states.set(threadId, state);
+  }
+  return state;
+}
+
+function pruneThreadTitleState(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+  state: ThreadTitleState,
+): void {
+  if (
+    state.generations.size === 0 &&
+    state.pendingClaim === null &&
+    state.inFlightClaims.size === 0 &&
+    state.manualTitle === undefined &&
+    states.get(threadId) === state
+  ) {
+    states.delete(threadId);
+  }
+}
+
+function isCurrentGeneration(
+  state: ThreadTitleState,
+  generation: ThreadTitleGeneration,
+): boolean {
+  return (
+    !generation.superseded &&
+    (state.latestExplicit?.order ?? 0) <= generation.order
+  );
+}
+
+function isCurrentClaim(
+  state: ThreadTitleState,
+  claim: ThreadTitleClaim,
+): boolean {
+  return (state.latestExplicit?.order ?? 0) < claim.order;
+}
+
+export function startThreadTitleRename(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+  title: string,
+): ThreadTitleClaim {
+  const state = getThreadTitleState(states, threadId);
+  let settle!: (renamed: boolean) => void;
+  const settled = new Promise<boolean>((resolve) => {
+    settle = resolve;
+  });
+  const claim: ThreadTitleClaim = {
+    title,
+    order: ++state.nextOrder,
+    settled,
+    settle,
+  };
+  state.pendingClaim = claim;
+  state.inFlightClaims.add(claim);
+  for (const generation of state.generations) {
+    if (generation.order < claim.order) generation.claim = claim;
+  }
+  return claim;
+}
+
+export function finishThreadTitleRename(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+  claim: ThreadTitleClaim,
+  renamed: boolean,
+): void {
+  claim.settle(renamed);
+  const state = states.get(threadId);
+  if (state === undefined) return;
+  state.inFlightClaims.delete(claim);
+  if (state.pendingClaim === claim) {
+    state.pendingClaim = null;
+    if (renamed) {
+      state.manualTitle = claim.title;
+    }
+  }
+  pruneThreadTitleState(states, threadId, state);
+}
+
+function takeManualTitle(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+  state: ThreadTitleState,
+): string | undefined {
+  const retained = state.manualTitle;
+  if (retained === undefined) return undefined;
+  state.manualTitle = undefined;
+  pruneThreadTitleState(states, threadId, state);
+  return retained;
+}
+
+export function clearThreadTitleState(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+): void {
+  states.delete(threadId);
+}
+
+function startThreadTitleGeneration(
+  states: Map<string, ThreadTitleState>,
+  threadId: string,
+  automatic: boolean,
+): ThreadTitleGeneration | null {
+  const state = getThreadTitleState(states, threadId);
+  if (
+    automatic &&
+    state.pendingClaim === null &&
+    takeManualTitle(states, threadId, state) !== undefined
+  ) {
+    return null;
+  }
+
+  let settlePersisted!: (title: string | undefined) => void;
+  const persisted = new Promise<string | undefined>((resolve) => {
+    settlePersisted = resolve;
+  });
+  const generation: ThreadTitleGeneration = {
+    automatic,
+    order: ++state.nextOrder,
+    claim: automatic ? state.pendingClaim : null,
+    beforeGenerationClaims: automatic ? [] : [...state.inFlightClaims],
+    superseded: false,
+    persisted,
+    settlePersisted,
+  };
+  if (!automatic) {
+    state.pendingClaim = null;
+    state.manualTitle = undefined;
+    state.latestExplicit = generation;
+    for (const active of state.generations) {
+      if (active.automatic) active.superseded = true;
+    }
+  }
+  state.generations.add(generation);
+  return generation;
+}
+
+/**
+ * Runs one title generation under the per-thread rename claims and generation
+ * ordering, so the title that wins locally is also the title left on the
+ * server.
+ *
+ * A generated run persists the title itself, and the adapter exposes no
+ * compare-and-set, so the run that loses reasserts the winner through `rename`
+ * only after `generate` has resolved. Reasserting mid-stream would race the
+ * run's own write and lose the winning title on the server.
+ */
+export async function runThreadTitleGeneration({
+  states,
+  threadId,
+  automatic,
+  generate,
+  rename,
+  applyTitle,
+}: ThreadTitleGenerationRun): Promise<void> {
+  const state = getThreadTitleState(states, threadId);
+  const generation = startThreadTitleGeneration(states, threadId, automatic);
+  if (generation === null) return;
+
+  let persistedTitle: string | undefined;
+  let persistedOrder = generation.order;
+
+  const settleClaim = async (claim: ThreadTitleClaim) => {
+    const renamed = await claim.settled;
+    if (generation.claim !== claim) return undefined;
+    if (!renamed) {
+      generation.claim = null;
+      if (state.pendingClaim === claim) state.pendingClaim = null;
+    }
+    return renamed;
+  };
+
+  const retainManualTitle = () =>
+    automatic && takeManualTitle(states, threadId, state) !== undefined;
+
+  // `generate` resolves only once the run has persisted its title, so a run
+  // that lost the ordering race while it streamed has already overwritten the
+  // winner. It waits for the winning generation to persist its own title and
+  // writes that title back.
+  const repairLostRace = async () => {
+    if (persistedTitle === undefined) return;
+    while (true) {
+      const claim = generation.claim;
+      if (
+        claim !== null &&
+        claim.order > persistedOrder &&
+        isCurrentClaim(state, claim)
+      ) {
+        const renamed = await settleClaim(claim);
+        if (renamed === true) {
+          persistedTitle = claim.title;
+          persistedOrder = claim.order;
+          await rename(claim.title);
+        }
+        continue;
+      }
+      const winner = state.latestExplicit;
+      if (winner === null || winner.order <= persistedOrder) return;
+      const title = await winner.persisted;
+      if (state.latestExplicit !== winner) continue;
+      persistedOrder = winner.order;
+      if (title === undefined || title === persistedTitle) return;
+      persistedTitle = title;
+      await rename(title);
+    }
+  };
+
+  const runGeneration = async () => {
+    // An explicit generation waits for every earlier rename because any of
+    // those server writes may settle last.
+    if (generation.beforeGenerationClaims.length > 0) {
+      await Promise.all(
+        generation.beforeGenerationClaims.map((claim) => claim.settled),
+      );
+    }
+    if (generation.claim !== null) {
+      const renamed = await settleClaim(generation.claim);
+      if (renamed === true) {
+        generation.superseded = true;
+        return;
+      }
+      if (renamed === false && retainManualTitle()) return;
+    }
+    if (!isCurrentGeneration(state, generation)) return;
+
+    let sawTitle = false;
+    let lastTitle: string | undefined;
+    await generate(async (title) => {
+      sawTitle = true;
+      lastTitle = title;
+      if (title !== undefined) persistedTitle = title;
+      const claim = generation.claim;
+      if (claim !== null) {
+        const renamed = await settleClaim(claim);
+        if (renamed !== false) return;
+        if (retainManualTitle()) {
+          generation.superseded = true;
+          return;
+        }
+      }
+      if (isCurrentGeneration(state, generation)) await applyTitle(lastTitle);
+    });
+
+    while (true) {
+      const claim = generation.claim;
+      if (claim === null) return;
+      const renamed = await settleClaim(claim);
+      if (renamed === undefined) continue;
+      if (renamed === false) {
+        if (retainManualTitle()) return;
+        if (sawTitle && isCurrentGeneration(state, generation)) {
+          await applyTitle(lastTitle);
+        }
+        return;
+      }
+      if (!isCurrentClaim(state, claim)) return;
+      await rename(claim.title);
+      persistedTitle = claim.title;
+      persistedOrder = claim.order;
+      if (generation.claim !== claim) continue;
+      if (!isCurrentGeneration(state, generation)) return;
+      await applyTitle(claim.title);
+      generation.superseded = true;
+      return;
+    }
+  };
+
+  try {
+    await runGeneration();
+    await repairLostRace();
+  } finally {
+    generation.settlePersisted(persistedTitle);
+    state.generations.delete(generation);
+    pruneThreadTitleState(states, threadId, state);
+  }
+}

package/src/runtimes/remote-thread-list/title.test.ts

@@ -0,0 +1,62 @@
+import { describe, expect, it } from "vitest";
+import { applyTitleStream } from "./title";
+
+const createTextStream = (text: string) =>
+  new ReadableStream({
+    start(controller) {
+      controller.enqueue({
+        type: "part-start",
+        path: [0],
+        part: { type: "text" },
+      });
+      controller.enqueue({
+        type: "text-delta",
+        path: [0],
+        textDelta: text,
+      });
+      controller.enqueue({ type: "part-finish", path: [0] });
+      controller.close();
+    },
+  }) as never;
+
+describe("applyTitleStream", () => {
+  it("ignores an empty stream", async () => {
+    const titles: (string | undefined)[] = [];
+
+    await applyTitleStream(
+      new ReadableStream({
+        start(controller) {
+          controller.close();
+        },
+      }) as never,
+      async (title) => {
+        titles.push(title);
+      },
+    );
+
+    expect(titles).toEqual([]);
+  });
+
+  it("ignores whitespace-only titles", async () => {
+    const titles: (string | undefined)[] = [];
+
+    await applyTitleStream(createTextStream("   "), async (title) => {
+      titles.push(title);
+    });
+
+    expect(titles).toEqual([]);
+  });
+
+  it("forwards titles containing text unchanged", async () => {
+    const titles: (string | undefined)[] = [];
+
+    await applyTitleStream(
+      createTextStream(" Generated title "),
+      async (title) => {
+        titles.push(title);
+      },
+    );
+
+    expect(titles).toContain(" Generated title ");
+  });
+});

package/src/runtimes/remote-thread-list/title.ts

@@ -1,3 +1,16 @@
+import { AssistantMessageStream } from "assistant-stream";
+
 export const isTitleSourceMessage = (message: {
   status?: { type: string } | undefined;
 }) => message.status?.type !== "running";
+
+export const applyTitleStream = async (
+  stream: Parameters<typeof AssistantMessageStream.fromAssistantStream>[0],
+  onTitle: (title: string | undefined) => Promise<void>,
+) => {
+  const messageStream = AssistantMessageStream.fromAssistantStream(stream);
+  for await (const result of messageStream) {
+    const title = result.parts.filter((part) => part.type === "text")[0]?.text;
+    if (title?.trim()) await onTitle(title);
+  }
+};

package/src/runtimes/remote-thread-list/types.ts

@@ -3,6 +3,7 @@ import type { AssistantRuntime } from "../../runtime/api/assistant-runtime";
 import type { AssistantStream } from "assistant-stream";
 import type { ThreadHistoryAdapter } from "../../adapters/thread-history";
 import type { AttachmentAdapter } from "../../adapters/attachment";
+import type { FeedbackAdapter } from "../../adapters/feedback";
 import type { ModelContextProvider } from "../../model-context/types";
 
 /* oxlint-disable typescript/no-explicit-any -- structural stand-in for ComponentType without depending on react types */
@@ -40,6 +41,7 @@ export type RuntimeAdapters = {
   modelContext?: ModelContextProvider | undefined;
   history?: ThreadHistoryAdapter | undefined;
   attachments?: AttachmentAdapter | undefined;
+  feedback?: FeedbackAdapter | undefined;
 };
 
 export type RemoteThreadListAdapter = {
@@ -54,6 +56,14 @@ export type RemoteThreadListAdapter = {
   unarchive(remoteId: string): Promise<void>;
   delete(remoteId: string): Promise<void>;
   initialize(threadId: string): Promise<RemoteThreadInitializeResponse>;
+  /**
+   * Generates a title for the thread and streams it back.
+   *
+   * When the generation persists the title itself, the returned stream must
+   * not complete before that write has landed. Concurrent generations are
+   * ordered by stream completion, and a run whose write outlives its stream
+   * can overwrite a newer title.
+   */
   generateTitle(
     remoteId: string,
     unstable_messages: readonly ThreadMessage[],

package/src/runtimes/tool-invocations/EDGE_CASES.md

@@ -72,9 +72,7 @@ If the tool also had a frontend `execute`, the executor is short-circuited
 via the entry's per-execution skip marker. Single fire.
 
 ### A.6. Previously-resolved tool's `result` is replaced
-Silently ignored — `entry.hasResult` short-circuits both the
-re-`setResponse` path and the downstream result-chunk handler. The host
-sees only the first result.
+Silently ignored. A restored entry with a result remains historical even when a live snapshot reserializes its `argsText` or replaces its result. For active entries, `entry.hasResult` short-circuits both the re-`setResponse` path and the downstream result-chunk handler. The host sees only the first result.
 
 ### A.7. Previously-resolved tool loses its `result` (back to undefined)
 Silently ignored. The entry stays in the resolved phase internally.
@@ -213,9 +211,7 @@ Silently kept as restored. Recursion into `content.messages` still
 happens so any nested live tool calls are processed.
 
 ### C.3. Restored entry observed in a live snapshot, signature changed
-The restored entry is deleted and a new active entry starts via
-`_startActiveEntry`. This is PR #4057's promotion path. `streamCall`
-fires once — its first and only fire for this `toolCallId`.
+A restored entry with a result remains historical regardless of later `argsText` or result changes. An unresolved restored entry is promoted only when a result lands or its `argsText` changes. Complete `argsText` values that parse to equivalent JSON are unchanged. Promotion deletes the restored entry and starts a new active entry via `_startActiveEntry`. `streamCall` fires once, its first and only fire for this `toolCallId`.
 
 ### C.4. `isLoading` transitions `true → false` while messages are stable
 The next `setState` call sees `isLoading === false` and processes

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;
       }