@assistant-ui/core 0.3.15 → 0.3.17

package/src/model-context/frame/provider.ts

@@ -29,22 +29,26 @@ const serializeModelContext = (
   }),
 });
 
+const getDefaultTargetOrigin = () => window.location.origin;
+
 export class AssistantFrameProvider {
   private static _instance: AssistantFrameProvider | null = null;
 
-  private _providers = new Set<ModelContextProvider>();
-  private _providerUnsubscribes = new Map<
-    ModelContextProvider,
-    Unsubscribe | undefined
-  >();
+  private _providers = new Map<symbol, ModelContextProvider>();
+  private _providerUnsubscribes = new Map<symbol, Unsubscribe | undefined>();
   private _activeToolCalls = new Map<
     string,
-    { abortController: AbortController; event: MessageEvent }
+    {
+      abortController: AbortController;
+      event: MessageEvent;
+      provider: ModelContextProvider | undefined;
+    }
   >();
   private _targetOrigin: string;
   private _strictRegistrations = 0;
+  private _wildcardRegistrations = 0;
 
-  private constructor(targetOrigin: string = "*") {
+  private constructor(targetOrigin: string = getDefaultTargetOrigin()) {
     this._targetOrigin = targetOrigin;
     this.handleMessage = this.handleMessage.bind(this);
     window.addEventListener("message", this.handleMessage);
@@ -63,8 +67,17 @@ export class AssistantFrameProvider {
     return AssistantFrameProvider._instance;
   }
 
-  private reconcileTargetOrigin(targetOrigin: string = "*") {
-    if (targetOrigin === "*" || targetOrigin === this._targetOrigin) return;
+  private reconcileTargetOrigin(
+    targetOrigin: string = getDefaultTargetOrigin(),
+  ) {
+    if (targetOrigin === this._targetOrigin) return;
+
+    if (this._providers.size === 0) {
+      this._targetOrigin = targetOrigin;
+      return;
+    }
+
+    if (targetOrigin === "*") return;
 
     if (this._targetOrigin === "*") {
       this._targetOrigin = targetOrigin;
@@ -106,10 +119,15 @@ export class AssistantFrameProvider {
     message: Extract<FrameMessage, { type: "tool-call" }>,
     event: MessageEvent,
   ) {
-    const tool = this.getModelContext().tools?.[message.toolName];
+    const resolvedTool = this.getTool(message.toolName);
+    const tool = resolvedTool?.tool;
     const abortController = new AbortController();
     this._activeToolCalls.get(message.id)?.abortController.abort();
-    const activeCall = { abortController, event };
+    const activeCall = {
+      abortController,
+      event,
+      provider: resolvedTool?.provider,
+    };
     this._activeToolCalls.set(message.id, activeCall);
 
     let result: any;
@@ -141,7 +159,7 @@ export class AssistantFrameProvider {
     this.sendMessage(event, {
       type: "tool-result",
       id: message.id,
-      ...(error ? { error } : { result }),
+      ...(error !== undefined ? { error } : { result }),
     });
   }
 
@@ -152,6 +170,37 @@ export class AssistantFrameProvider {
     activeCall.abortController.abort();
   }
 
+  private cancelToolCallsForProvider(provider: ModelContextProvider) {
+    const matchingCalls = Array.from(this._activeToolCalls).filter(
+      ([, activeCall]) => activeCall.provider === provider,
+    );
+    for (const [id, activeCall] of matchingCalls) {
+      this._activeToolCalls.delete(id);
+      activeCall.abortController.abort();
+    }
+
+    let sendFailed = false;
+    let sendError: unknown;
+    for (const [id, activeCall] of matchingCalls) {
+      try {
+        this.sendMessage(activeCall.event, {
+          type: "tool-result",
+          id,
+          error: "AssistantFrame tool provider has been removed",
+        });
+      } catch (error) {
+        if (sendFailed) {
+          console.error(error);
+        } else {
+          sendFailed = true;
+          sendError = error;
+        }
+      }
+    }
+
+    if (sendFailed) throw sendError;
+  }
+
   private sendMessage(event: MessageEvent, message: FrameMessage) {
     event.source?.postMessage(
       { channel: FRAME_MESSAGE_CHANNEL, message },
@@ -159,9 +208,26 @@ export class AssistantFrameProvider {
     );
   }
 
+  private getProviders() {
+    return Array.from(new Set(this._providers.values()));
+  }
+
+  private getTool(toolName: string) {
+    let resolved:
+      | { provider: ModelContextProvider; tool: Tool<any, any> }
+      | undefined;
+
+    for (const provider of this.getProviders()) {
+      const tool = provider.getModelContext().tools?.[toolName];
+      if (tool) resolved = { provider, tool };
+    }
+
+    return resolved;
+  }
+
   private getModelContext(): ModelContext {
-    const contexts = Array.from(this._providers).map((p) =>
-      p.getModelContext(),
+    const contexts = this.getProviders().map((provider) =>
+      provider.getModelContext(),
     );
 
     return contexts.reduce(
@@ -191,34 +257,118 @@ export class AssistantFrameProvider {
     }
   }
 
+  private removeProvider(
+    id: symbol,
+    origin: string,
+  ): {
+    unsubscribe: Unsubscribe | undefined;
+    removedProvider: ModelContextProvider | undefined;
+  } {
+    const provider = this._providers.get(id);
+    this._providers.delete(id);
+    const unsubscribe = this._providerUnsubscribes.get(id);
+    this._providerUnsubscribes.delete(id);
+    if (origin === "*") {
+      this._wildcardRegistrations -= 1;
+      if (
+        this._wildcardRegistrations === 0 &&
+        this._strictRegistrations === 0
+      ) {
+        this._targetOrigin = getDefaultTargetOrigin();
+      }
+    } else {
+      this._strictRegistrations -= 1;
+      if (this._strictRegistrations === 0) {
+        this._targetOrigin =
+          this._wildcardRegistrations > 0 ? "*" : getDefaultTargetOrigin();
+      }
+    }
+    const removedProvider =
+      provider && !this.getProviders().includes(provider)
+        ? provider
+        : undefined;
+    return { unsubscribe, removedProvider };
+  }
+
   static addModelContextProvider(
     provider: ModelContextProvider,
     targetOrigin?: string,
   ): Unsubscribe {
-    const origin = targetOrigin ?? "*";
+    const origin = targetOrigin ?? getDefaultTargetOrigin();
     const instance = AssistantFrameProvider.getInstance(origin);
-    instance._providers.add(provider);
-    if (origin !== "*") instance._strictRegistrations += 1;
-
-    const unsubscribe = provider.subscribe?.(() => instance.broadcastUpdate());
-    if (unsubscribe) {
-      instance._providerUnsubscribes.set(provider, unsubscribe);
+    const id = Symbol();
+    instance._providers.set(id, provider);
+    if (origin === "*") {
+      instance._wildcardRegistrations += 1;
+    } else {
+      instance._strictRegistrations += 1;
     }
 
-    instance.broadcastUpdate();
+    try {
+      const unsubscribe = provider.subscribe?.(() =>
+        instance.broadcastUpdate(),
+      );
+      if (unsubscribe) {
+        instance._providerUnsubscribes.set(id, unsubscribe);
+      }
+
+      instance.broadcastUpdate();
+    } catch (error) {
+      const { unsubscribe, removedProvider } = instance.removeProvider(
+        id,
+        origin,
+      );
+      // Rollback failures must not replace the registration error.
+      try {
+        if (removedProvider) {
+          instance.cancelToolCallsForProvider(removedProvider);
+        }
+      } catch (cancelError) {
+        console.error(cancelError);
+      }
+      try {
+        unsubscribe?.();
+      } catch (unsubscribeError) {
+        console.error(unsubscribeError);
+      }
+      try {
+        instance.broadcastUpdate();
+      } catch (broadcastError) {
+        console.error(broadcastError);
+      }
+      throw error;
+    }
 
     let released = false;
     return () => {
       if (released) return;
       released = true;
-      instance._providers.delete(provider);
-      instance._providerUnsubscribes.get(provider)?.();
-      instance._providerUnsubscribes.delete(provider);
-      if (origin !== "*") {
-        instance._strictRegistrations -= 1;
-        if (instance._strictRegistrations === 0) instance._targetOrigin = "*";
+      const { unsubscribe, removedProvider } = instance.removeProvider(
+        id,
+        origin,
+      );
+      let cleanupFailed = false;
+      let cleanupError: unknown;
+      const runCleanup = (cleanup: () => void) => {
+        try {
+          cleanup();
+        } catch (error) {
+          if (cleanupFailed) {
+            console.error(error);
+          } else {
+            cleanupFailed = true;
+            cleanupError = error;
+          }
+        }
+      };
+
+      if (removedProvider) {
+        runCleanup(() => instance.cancelToolCallsForProvider(removedProvider));
       }
-      instance.broadcastUpdate();
+      if (unsubscribe) runCleanup(unsubscribe);
+      runCleanup(() => instance.broadcastUpdate());
+
+      if (cleanupFailed) throw cleanupError;
     };
   }
 
@@ -227,20 +377,40 @@ export class AssistantFrameProvider {
       const instance = AssistantFrameProvider._instance;
       window.removeEventListener("message", instance.handleMessage);
 
-      instance._providerUnsubscribes.forEach((unsubscribe) => unsubscribe?.());
+      let cleanupFailed = false;
+      let cleanupError: unknown;
+      const runCleanup = (cleanup: () => void) => {
+        try {
+          cleanup();
+        } catch (error) {
+          if (cleanupFailed) {
+            console.error(error);
+          } else {
+            cleanupFailed = true;
+            cleanupError = error;
+          }
+        }
+      };
+
+      instance._providerUnsubscribes.forEach((unsubscribe) => {
+        if (unsubscribe) runCleanup(unsubscribe);
+      });
       instance._providerUnsubscribes.clear();
       instance._providers.clear();
       instance._activeToolCalls.forEach(({ abortController, event }, id) => {
-        abortController.abort();
-        instance.sendMessage(event, {
-          type: "tool-result",
-          id,
-          error: "AssistantFrameProvider has been disposed",
+        runCleanup(() => {
+          abortController.abort();
+          instance.sendMessage(event, {
+            type: "tool-result",
+            id,
+            error: "AssistantFrameProvider has been disposed",
+          });
         });
       });
       instance._activeToolCalls.clear();
 
       AssistantFrameProvider._instance = null;
+      if (cleanupFailed) throw cleanupError;
     }
   }
 }

package/src/model-context/interactable-composer-metadata.ts

@@ -33,7 +33,7 @@ type SnapshotCarrierMessage = {
  * `metadata.custom.interactables`, or `undefined` if none. This is the read
  * half of the snapshot channel — integrations use it to surface interactable
  * state to the model (see `unstable_injectInteractableContext` in
- * `@assistant-ui/react-ai-sdk` for the AI SDK implementation).
+ * `@assistant-ui/ai-sdk` for the AI SDK implementation).
  *
  * @deprecated Unstable / Experimental (not actually removed).
  */

package/src/model-context/registry.test.ts

@@ -128,4 +128,48 @@ describe("ModelContextRegistry", () => {
     expect(() => publishUpdate()).toThrow(error);
     expect(laterSubscriber).toHaveBeenCalledTimes(1);
   });
+
+  it("notifies subscribers exactly once when a provider changes", () => {
+    const registry = new ModelContextRegistry();
+    const callbacks = new Set<() => void>();
+    const subscriber = vi.fn();
+
+    registry.addProvider({
+      getModelContext: () => ({ system: "provider instructions" }),
+      subscribe: (callback) => {
+        callbacks.add(callback);
+        return () => callbacks.delete(callback);
+      },
+    });
+    registry.subscribe(subscriber);
+
+    for (const callback of callbacks) {
+      callback();
+    }
+
+    expect(subscriber).toHaveBeenCalledTimes(1);
+  });
+
+  it("removes a provider's context and subscription through the addProvider handle", () => {
+    const registry = new ModelContextRegistry();
+    const unsubscribe = vi.fn();
+
+    const handle = registry.addProvider({
+      getModelContext: () => ({ system: "provider instructions" }),
+      subscribe: () => unsubscribe,
+    });
+    expect(registry.getModelContext().system).toContain(
+      "provider instructions",
+    );
+
+    const subscriber = vi.fn();
+    registry.subscribe(subscriber);
+    handle.remove();
+
+    expect(unsubscribe).toHaveBeenCalledTimes(1);
+    expect(registry.getModelContext().system ?? "").not.toContain(
+      "provider instructions",
+    );
+    expect(subscriber).toHaveBeenCalledTimes(1);
+  });
 });

package/src/model-context/registry.ts

@@ -2,12 +2,12 @@ import type { Tool } from "assistant-stream";
 import {
   type ModelContext,
   type ModelContextProvider,
-  mergeModelContexts,
   type AssistantToolProps,
   type AssistantInstructionsConfig,
 } from "./types";
-import type { Unsubscribe } from "../types/unsubscribe";
 import { notifySubscribers as notifyStateSubscribers } from "../subscribable/subscribable";
+import { CompositeContextProvider } from "../utils/composite-context-provider";
+import type { Unsubscribe } from "../types/unsubscribe";
 import type {
   ModelContextRegistryToolHandle,
   ModelContextRegistryInstructionHandle,
@@ -17,9 +17,14 @@ import type {
 export class ModelContextRegistry implements ModelContextProvider {
   private _tools = new Map<symbol, AssistantToolProps<any, any>>();
   private _instructions = new Map<symbol, string>();
-  private _providers = new Map<symbol, ModelContextProvider>();
+  private _contextProviders = new CompositeContextProvider();
   private _subscribers = new Set<() => void>();
-  private _providerUnsubscribes = new Map<symbol, Unsubscribe | undefined>();
+
+  constructor() {
+    this._contextProviders.subscribe(() => {
+      this.notifySubscribers();
+    });
+  }
 
   getModelContext(): ModelContext {
     const instructions = Array.from(this._instructions.values()).filter(
@@ -35,9 +40,7 @@ export class ModelContextRegistry implements ModelContextProvider {
       tools[toolName] = tool;
     }
 
-    const providerContexts = mergeModelContexts(
-      new Set(this._providers.values()),
-    );
+    const providerContexts = this._contextProviders.getModelContext();
 
     const context: ModelContext = {
       system,
@@ -139,36 +142,11 @@ export class ModelContextRegistry implements ModelContextProvider {
   addProvider(
     provider: ModelContextProvider,
   ): ModelContextRegistryProviderHandle {
-    const id = Symbol();
-
-    this._providers.set(id, provider);
-
-    let unsubscribe: Unsubscribe | undefined;
-    try {
-      unsubscribe = provider.subscribe?.(() => {
-        this.notifySubscribers();
-      });
-    } catch (error) {
-      this._providers.delete(id);
-      try {
-        this.notifySubscribers();
-      } catch (notifyError) {
-        console.error(notifyError);
-      }
-      throw error;
-    }
-    this._providerUnsubscribes.set(id, unsubscribe);
-
-    this.notifySubscribers();
+    const unregister =
+      this._contextProviders.registerModelContextProvider(provider);
 
     return {
-      remove: () => {
-        this._providers.delete(id);
-        const unsubscribe = this._providerUnsubscribes.get(id);
-        unsubscribe?.();
-        this._providerUnsubscribes.delete(id);
-        this.notifySubscribers();
-      },
+      remove: unregister,
     };
   }
 }

package/src/model-context/tool-call-text.test.ts

@@ -0,0 +1,67 @@
+import { describe, expect, it } from "vitest";
+import { resolveToolCallText } from "./tool-call-text";
+
+describe("resolveToolCallText", () => {
+  it("resolves literal text for running and complete tool calls", () => {
+    const text = {
+      running: "Searching...",
+      complete: "Done searching",
+    };
+
+    expect(
+      resolveToolCallText(text, {
+        args: {},
+        status: { type: "running" },
+      }),
+    ).toBe("Searching...");
+    expect(
+      resolveToolCallText(text, {
+        args: {},
+        status: { type: "complete" },
+      }),
+    ).toBe("Done searching");
+  });
+
+  it("passes args and results to text functions", () => {
+    const text = {
+      running: ({ args }: { args: { query: string } }) =>
+        `Searching ${args.query}...`,
+      complete: ({
+        args,
+        result,
+      }: {
+        args: { query: string };
+        result: number | undefined;
+      }) => `Found ${result ?? 0} results for ${args.query}`,
+    };
+
+    expect(
+      resolveToolCallText(text, {
+        args: { query: "docs" },
+        status: { type: "requires-action" },
+      }),
+    ).toBe("Searching docs...");
+    expect(
+      resolveToolCallText(text, {
+        args: { query: "docs" },
+        result: 3,
+        status: { type: "complete" },
+      }),
+    ).toBe("Found 3 results for docs");
+  });
+
+  it("returns null when the active status has no text", () => {
+    expect(
+      resolveToolCallText(
+        { running: "Searching..." },
+        { args: {}, status: { type: "complete" } },
+      ),
+    ).toBeNull();
+    expect(
+      resolveToolCallText(
+        { complete: "Done searching" },
+        { args: {}, status: { type: "running" } },
+      ),
+    ).toBeNull();
+  });
+});

package/src/model-context/tool-call-text.ts

@@ -0,0 +1,67 @@
+type ToolCallRunningText<TArgs extends Record<string, unknown>, TValue> =
+  | TValue
+  | undefined
+  | null
+  | ((options: { args: TArgs }) => TValue | undefined | null);
+
+type ToolCallCompleteText<
+  TArgs extends Record<string, unknown>,
+  TResult,
+  TValue,
+> =
+  | TValue
+  | undefined
+  | null
+  | ((options: {
+      args: TArgs;
+      result: TResult | undefined;
+    }) => TValue | undefined | null);
+
+export type ToolCallText<
+  TArgs extends Record<string, unknown>,
+  TResult,
+  TValue = string,
+> =
+  | {
+      running: ToolCallRunningText<TArgs, TValue>;
+      complete?: ToolCallCompleteText<TArgs, TResult, TValue> | undefined;
+    }
+  | {
+      running?: ToolCallRunningText<TArgs, TValue> | undefined;
+      complete: ToolCallCompleteText<TArgs, TResult, TValue>;
+    };
+
+type ToolCallTextPart<TArgs extends Record<string, unknown>, TResult> = {
+  readonly args: TArgs;
+  readonly result?: TResult | undefined;
+  readonly status?: { readonly type?: string | undefined } | undefined;
+};
+
+export const resolveToolCallText = <
+  TArgs extends Record<string, unknown>,
+  TResult,
+  TValue,
+>(
+  text: ToolCallText<TArgs, TResult, TValue>,
+  part: ToolCallTextPart<TArgs, TResult>,
+): TValue | undefined | null => {
+  const isRunning =
+    part.status?.type === "running" || part.status?.type === "requires-action";
+
+  if (!isRunning) {
+    const value = text.complete;
+    if (typeof value !== "function") return value ?? null;
+    return (
+      value as (options: {
+        args: TArgs;
+        result: TResult | undefined;
+      }) => TValue | undefined | null
+    )({ args: part.args, result: part.result });
+  }
+
+  const value = text.running;
+  if (typeof value !== "function") return value ?? null;
+  return (value as (options: { args: TArgs }) => TValue | undefined | null)({
+    args: part.args,
+  });
+};

package/src/react/AssistantRuntimeProvider.test.tsx

@@ -1,8 +1,8 @@
 // @vitest-environment jsdom
 
 import type { ReactNode } from "react";
-import { useEffect } from "react";
-import { cleanup, render } from "@testing-library/react";
+import { useEffect, useState } from "react";
+import { act, cleanup, render } from "@testing-library/react";
 import { afterEach, describe, expect, it } from "vitest";
 import { resource } from "@assistant-ui/tap";
 import {
@@ -12,8 +12,10 @@ import {
   type AssistantClient,
 } from "@assistant-ui/store";
 import type { ChatModelAdapter } from "../runtime/utils/chat-model-adapter";
+import type { ThreadMessage } from "../types/message";
 import { AssistantRuntimeProvider } from "./AssistantRuntimeProvider";
 import { useLocalRuntime } from "./runtimes/useLocalRuntime";
+import { useExternalStoreRuntime } from "./runtimes/useExternalStoreRuntime";
 
 type AnyClient = Record<string, any>;
 
@@ -21,6 +23,20 @@ const chatModel: ChatModelAdapter = {
   run: async () => ({ content: [] }),
 };
 
+const hoistedConfig = AuiConfig({});
+
+const message = (id: string, role: "user" | "assistant"): ThreadMessage =>
+  ({
+    id,
+    role,
+    content: [{ type: "text", text: `text of ${id}` }],
+    createdAt: new Date(1718000000000),
+    ...(role === "assistant"
+      ? { status: { type: "complete", reason: "stop" } }
+      : { attachments: [] }),
+    metadata: { custom: {} },
+  }) as ThreadMessage;
+
 const makeCounterClient = (log?: string[]) => {
   const useCounterClient = () => {
     useEffect(() => {
@@ -152,4 +168,52 @@ describe("AssistantRuntimeProvider aui composition", () => {
 
     expect(aui.threads.getState().main).toBeDefined();
   });
+
+  const countPublicationsOverThreeRerenders = async (
+    makeMessages: () => ThreadMessage[],
+  ) => {
+    let advance!: () => void;
+    let notifications = 0;
+
+    const Subscriber = () => {
+      const aui = useAui();
+      useEffect(() => aui.subscribe(() => notifications++), [aui]);
+      return null;
+    };
+
+    const App = () => {
+      const [, setTick] = useState(0);
+      advance = () => setTick((tick) => tick + 1);
+      const runtime = useExternalStoreRuntime<ThreadMessage>({
+        messages: makeMessages(),
+        onNew: async () => {},
+      });
+
+      return (
+        <AssistantRuntimeProvider runtime={runtime} config={hoistedConfig}>
+          <Subscriber />
+        </AssistantRuntimeProvider>
+      );
+    };
+
+    render(<App />);
+    notifications = 0;
+
+    await act(async () => advance());
+    await act(async () => advance());
+    await act(async () => advance());
+
+    return notifications;
+  };
+
+  it("publishes once when the external-store runtime owner rerenders", async () => {
+    expect(await countPublicationsOverThreeRerenders(() => [])).toBe(3);
+  });
+
+  it("publishes once per rerender when the thread already has messages", async () => {
+    const messages = [message("m1", "user"), message("m2", "assistant")];
+    expect(await countPublicationsOverThreeRerenders(() => [...messages])).toBe(
+      3,
+    );
+  });
 });