mirror of
https://github.com/HKUDS/nanobot.git
synced 2026-06-13 14:23:58 +00:00
566 lines
19 KiB
TypeScript
566 lines
19 KiB
TypeScript
import type {
|
|
ConnectionStatus,
|
|
InboundEvent,
|
|
Outbound,
|
|
OutboundCliAppMention,
|
|
OutboundImageGeneration,
|
|
OutboundMcpPresetMention,
|
|
OutboundMedia,
|
|
GoalStateWsPayload,
|
|
WorkspaceScopePayload,
|
|
} from "./types";
|
|
import { createHostWebSocket } from "./runtime";
|
|
|
|
/** WebSocket readyState constants, referenced by value to stay portable
|
|
* across runtimes that don't expose a global ``WebSocket`` (tests, SSR). */
|
|
const WS_OPEN = 1;
|
|
const WS_CLOSING = 2;
|
|
const HOST_SOCKET_URL_PREFIX = "nanobot-host://";
|
|
|
|
function createDefaultSocket(url: string): WebSocket {
|
|
if (url.startsWith(HOST_SOCKET_URL_PREFIX)) {
|
|
return createHostWebSocket(url);
|
|
}
|
|
return new WebSocket(url);
|
|
}
|
|
|
|
/** Inbound WebSocket ``console.log`` / parse-failure ``console.warn``.
|
|
*
|
|
* - **Dev** (non-production bundle): **on by default** — messages appear at default log level.
|
|
* - **Production**: off unless ``localStorage.setItem('nanobot_debug_ws','1')`` (or ``true``).
|
|
* - **Silence anywhere**: ``localStorage.setItem('nanobot_debug_ws','0')`` (or ``false`` / ``off``).
|
|
* Values are read on every frame; no reload needed.
|
|
*/
|
|
function wsInboundDebugEnabled(): boolean {
|
|
if (typeof globalThis === "undefined") return false;
|
|
try {
|
|
if (import.meta.env.MODE === "test") return false;
|
|
const ls = (globalThis as unknown as { localStorage?: Storage }).localStorage;
|
|
const raw = ls?.getItem("nanobot_debug_ws")?.trim().toLowerCase() ?? "";
|
|
if (raw === "0" || raw === "false" || raw === "off" || raw === "no") {
|
|
return false;
|
|
}
|
|
if (raw === "1" || raw === "true" || raw === "on" || raw === "yes") {
|
|
return true;
|
|
}
|
|
return !import.meta.env.PROD;
|
|
} catch {
|
|
return !import.meta.env.PROD;
|
|
}
|
|
}
|
|
|
|
/** Shorten streaming text fields so logging stays usable for huge deltas. */
|
|
function summarizeInboundWsPayload(ev: InboundEvent): unknown {
|
|
const kind = (ev as { event?: string }).event;
|
|
if (kind !== "delta" && kind !== "reasoning_delta") return ev;
|
|
const row = { ...(ev as object) } as Record<string, unknown>;
|
|
const text = typeof row.text === "string" ? row.text : "";
|
|
const max = 240;
|
|
if (text.length > max) {
|
|
row.text = `${text.slice(0, max)}… (${text.length} chars)`;
|
|
}
|
|
return row;
|
|
}
|
|
|
|
type Unsubscribe = () => void;
|
|
type EventHandler = (ev: InboundEvent) => void;
|
|
type StatusHandler = (status: ConnectionStatus) => void;
|
|
type RuntimeModelHandler = (modelName: string | null, modelPreset?: string | null) => void;
|
|
type SessionUpdateScope = "metadata" | "thread" | string;
|
|
type SessionUpdateHandler = (
|
|
chatId: string,
|
|
scope?: SessionUpdateScope,
|
|
workspaceScope?: WorkspaceScopePayload,
|
|
) => void;
|
|
type RunStatusHandler = (chatId: string, startedAt: number | null) => void;
|
|
|
|
/** Structured errors surfaced to the UI.
|
|
*
|
|
* Most entries are transport-level or protocol-level faults. Workspace scope
|
|
* rejections are server application errors promoted here because they affect
|
|
* controls outside the message stream and must be visible immediately.
|
|
*/
|
|
export type StreamError =
|
|
/** Server rejected the inbound frame as too large (WS close code 1009).
|
|
* Typically means the user attached images whose base64 size exceeded
|
|
* ``maxMessageBytes`` on the server. */
|
|
| { kind: "message_too_big" }
|
|
| { kind: "workspace_scope_rejected"; reason?: string; chatId?: string };
|
|
|
|
type ErrorHandler = (error: StreamError) => void;
|
|
|
|
interface PendingNewChat {
|
|
resolve: (chatId: string) => void;
|
|
reject: (err: Error) => void;
|
|
timer: ReturnType<typeof setTimeout>;
|
|
}
|
|
|
|
export interface NanobotClientOptions {
|
|
url: string;
|
|
reconnect?: boolean;
|
|
/** Called when a connection drops so the app can refresh its token. */
|
|
onReauth?: () => Promise<string | null>;
|
|
/** Inject a custom WebSocket factory (used by unit tests). */
|
|
socketFactory?: (url: string) => WebSocket;
|
|
/** Delay-cap for reconnect backoff (ms). */
|
|
maxBackoffMs?: number;
|
|
}
|
|
|
|
/**
|
|
* Singleton WebSocket client that multiplexes chat streams.
|
|
*
|
|
* One socket carries many chat_ids: the server tags every outbound event with
|
|
* ``chat_id``, and this class fans those events out to handlers registered
|
|
* per chat. Reconnects are transparent and re-attach every known chat_id.
|
|
*/
|
|
export class NanobotClient {
|
|
private socket: WebSocket | null = null;
|
|
private statusHandlers = new Set<StatusHandler>();
|
|
private runtimeModelHandlers = new Set<RuntimeModelHandler>();
|
|
private sessionUpdateHandlers = new Set<SessionUpdateHandler>();
|
|
private runStatusHandlers = new Set<RunStatusHandler>();
|
|
private errorHandlers = new Set<ErrorHandler>();
|
|
// chat_id -> handlers listening on it
|
|
private chatHandlers = new Map<string, Set<EventHandler>>();
|
|
/** Inbound frames received while no subscriber is registered (e.g. user switched away). */
|
|
private pendingInboundByChat = new Map<string, InboundEvent[]>();
|
|
private static readonly PENDING_INBOUND_MAX = 2000;
|
|
// chat_ids we've attached to since connect; re-attached after reconnects
|
|
private knownChats = new Set<string>();
|
|
/** Wall-clock run strip: updated from ``goal_status`` even with no ``onChat`` subscriber. */
|
|
private runStartedAtByChatId = new Map<string, number>();
|
|
/** Latest ``goal_state`` snapshot per ``chat_id`` (multi-session isolation). */
|
|
private goalStateByChatId = new Map<string, GoalStateWsPayload>();
|
|
private pendingNewChat: PendingNewChat | null = null;
|
|
// Frames queued while the socket is not yet OPEN
|
|
private sendQueue: Outbound[] = [];
|
|
private reconnectAttempts = 0;
|
|
private reconnectTimer: ReturnType<typeof setTimeout> | null = null;
|
|
private readonly shouldReconnect: boolean;
|
|
private readonly maxBackoffMs: number;
|
|
private socketFactory: (url: string) => WebSocket;
|
|
private currentUrl: string;
|
|
private status_: ConnectionStatus = "idle";
|
|
private readyChatId: string | null = null;
|
|
// Set by ``close()`` so the onclose handler knows the drop was intentional
|
|
// and must not schedule a reconnect or flip status back to "reconnecting".
|
|
private intentionallyClosed = false;
|
|
|
|
constructor(private options: NanobotClientOptions) {
|
|
this.shouldReconnect = options.reconnect ?? true;
|
|
this.maxBackoffMs = options.maxBackoffMs ?? 15_000;
|
|
this.socketFactory = options.socketFactory ?? createDefaultSocket;
|
|
this.currentUrl = options.url;
|
|
}
|
|
|
|
get status(): ConnectionStatus {
|
|
return this.status_;
|
|
}
|
|
|
|
get defaultChatId(): string | null {
|
|
return this.readyChatId;
|
|
}
|
|
|
|
/** Swap the URL (e.g. after fetching a fresh token) then reconnect. */
|
|
updateUrl(url: string, socketFactory?: (url: string) => WebSocket): void {
|
|
this.currentUrl = url;
|
|
if (socketFactory) {
|
|
this.socketFactory = socketFactory;
|
|
}
|
|
}
|
|
|
|
onStatus(handler: StatusHandler): Unsubscribe {
|
|
this.statusHandlers.add(handler);
|
|
handler(this.status_);
|
|
return () => {
|
|
this.statusHandlers.delete(handler);
|
|
};
|
|
}
|
|
|
|
onRuntimeModelUpdate(handler: RuntimeModelHandler): Unsubscribe {
|
|
this.runtimeModelHandlers.add(handler);
|
|
return () => {
|
|
this.runtimeModelHandlers.delete(handler);
|
|
};
|
|
}
|
|
|
|
onSessionUpdate(handler: SessionUpdateHandler): Unsubscribe {
|
|
this.sessionUpdateHandlers.add(handler);
|
|
return () => {
|
|
this.sessionUpdateHandlers.delete(handler);
|
|
};
|
|
}
|
|
|
|
onRunStatus(handler: RunStatusHandler): Unsubscribe {
|
|
this.runStatusHandlers.add(handler);
|
|
for (const [chatId, startedAt] of this.runStartedAtByChatId) {
|
|
handler(chatId, startedAt);
|
|
}
|
|
return () => {
|
|
this.runStatusHandlers.delete(handler);
|
|
};
|
|
}
|
|
|
|
/** Subscribe to transport-level faults (see :type:`StreamError`). */
|
|
onError(handler: ErrorHandler): Unsubscribe {
|
|
this.errorHandlers.add(handler);
|
|
return () => {
|
|
this.errorHandlers.delete(handler);
|
|
};
|
|
}
|
|
|
|
/** Last ``goal_status`` ``started_at`` (unix sec) for *chatId*, if the turn is running. */
|
|
getRunStartedAt(chatId: string): number | null {
|
|
const v = this.runStartedAtByChatId.get(chatId);
|
|
return v === undefined ? null : v;
|
|
}
|
|
|
|
/** Last ``goal_state`` payload for *chatId*, if any frame has arrived this connection. */
|
|
getGoalState(chatId: string): GoalStateWsPayload | undefined {
|
|
return this.goalStateByChatId.get(chatId);
|
|
}
|
|
|
|
private recordGoalStatusForRunStrip(chatId: string, ev: InboundEvent): void {
|
|
if (ev.event === "turn_end") {
|
|
if (this.runStartedAtByChatId.has(chatId)) {
|
|
this.runStartedAtByChatId.delete(chatId);
|
|
this.emitRunStatus(chatId, null);
|
|
}
|
|
return;
|
|
}
|
|
if (ev.event !== "goal_status") return;
|
|
if (ev.status === "running" && typeof ev.started_at === "number") {
|
|
const previous = this.runStartedAtByChatId.get(chatId);
|
|
this.runStartedAtByChatId.set(chatId, ev.started_at);
|
|
if (previous !== ev.started_at) this.emitRunStatus(chatId, ev.started_at);
|
|
} else if (this.runStartedAtByChatId.has(chatId)) {
|
|
this.runStartedAtByChatId.delete(chatId);
|
|
this.emitRunStatus(chatId, null);
|
|
}
|
|
}
|
|
|
|
private recordGoalStateSnapshot(chatId: string, ev: InboundEvent): void {
|
|
if (ev.event === "goal_state") {
|
|
this.goalStateByChatId.set(chatId, ev.goal_state);
|
|
return;
|
|
}
|
|
if (ev.event === "turn_end" && ev.goal_state != null && typeof ev.goal_state === "object") {
|
|
this.goalStateByChatId.set(chatId, ev.goal_state);
|
|
}
|
|
}
|
|
|
|
/** Subscribe to events for a given chat_id. Auto-attaches on the next open. */
|
|
onChat(chatId: string, handler: EventHandler): Unsubscribe {
|
|
let handlers = this.chatHandlers.get(chatId);
|
|
if (!handlers) {
|
|
handlers = new Set();
|
|
this.chatHandlers.set(chatId, handlers);
|
|
}
|
|
handlers.add(handler);
|
|
const pending = this.pendingInboundByChat.get(chatId);
|
|
if (pending !== undefined && pending.length > 0) {
|
|
const flushed = pending.splice(0);
|
|
this.pendingInboundByChat.delete(chatId);
|
|
for (const ev of flushed) {
|
|
handler(ev);
|
|
}
|
|
}
|
|
this.attach(chatId);
|
|
return () => {
|
|
const current = this.chatHandlers.get(chatId);
|
|
if (!current) return;
|
|
current.delete(handler);
|
|
if (current.size === 0) this.chatHandlers.delete(chatId);
|
|
};
|
|
}
|
|
|
|
connect(): void {
|
|
if (this.socket && this.socket.readyState < WS_CLOSING) return;
|
|
this.intentionallyClosed = false;
|
|
this.setStatus("connecting");
|
|
const sock = this.socketFactory(this.currentUrl);
|
|
this.socket = sock;
|
|
sock.onopen = () => this.handleOpen();
|
|
sock.onmessage = (ev) => this.handleMessage(ev);
|
|
sock.onerror = () => this.setStatus("error");
|
|
sock.onclose = (ev) => this.handleClose(ev);
|
|
}
|
|
|
|
close(): void {
|
|
this.intentionallyClosed = true;
|
|
if (this.reconnectTimer) {
|
|
clearTimeout(this.reconnectTimer);
|
|
this.reconnectTimer = null;
|
|
}
|
|
const sock = this.socket;
|
|
this.socket = null;
|
|
try {
|
|
sock?.close();
|
|
} catch {
|
|
// ignore
|
|
}
|
|
this.setStatus("closed");
|
|
}
|
|
|
|
/** Ask the server to provision a new chat_id; resolves with the assigned id. */
|
|
newChat(timeoutMs: number = 5_000, workspaceScope?: WorkspaceScopePayload | null): Promise<string> {
|
|
if (this.pendingNewChat) {
|
|
return Promise.reject(new Error("newChat already in flight"));
|
|
}
|
|
return new Promise<string>((resolve, reject) => {
|
|
const timer = setTimeout(() => {
|
|
this.pendingNewChat = null;
|
|
reject(new Error("newChat timed out"));
|
|
}, timeoutMs);
|
|
this.pendingNewChat = { resolve, reject, timer };
|
|
this.queueSend({
|
|
type: "new_chat",
|
|
...(workspaceScope ? { workspace_scope: workspaceScope } : {}),
|
|
});
|
|
});
|
|
}
|
|
|
|
attach(chatId: string): void {
|
|
this.knownChats.add(chatId);
|
|
if (this.socket?.readyState === WS_OPEN) {
|
|
this.queueSend({ type: "attach", chat_id: chatId });
|
|
}
|
|
}
|
|
|
|
sendMessage(
|
|
chatId: string,
|
|
content: string,
|
|
media?: OutboundMedia[],
|
|
options?: {
|
|
imageGeneration?: OutboundImageGeneration;
|
|
cliApps?: OutboundCliAppMention[];
|
|
mcpPresets?: OutboundMcpPresetMention[];
|
|
workspaceScope?: WorkspaceScopePayload | null;
|
|
},
|
|
): void {
|
|
this.knownChats.add(chatId);
|
|
const frame: Outbound = {
|
|
type: "message",
|
|
chat_id: chatId,
|
|
content,
|
|
...(media && media.length > 0 ? { media } : {}),
|
|
...(options?.imageGeneration ? { image_generation: options.imageGeneration } : {}),
|
|
...(options?.cliApps?.length ? { cli_apps: options.cliApps } : {}),
|
|
...(options?.mcpPresets?.length ? { mcp_presets: options.mcpPresets } : {}),
|
|
...(options?.workspaceScope ? { workspace_scope: options.workspaceScope } : {}),
|
|
webui: true,
|
|
};
|
|
this.queueSend(frame);
|
|
}
|
|
|
|
setWorkspaceScope(chatId: string, workspaceScope: WorkspaceScopePayload): void {
|
|
this.knownChats.add(chatId);
|
|
this.queueSend({
|
|
type: "set_workspace_scope",
|
|
chat_id: chatId,
|
|
workspace_scope: workspaceScope,
|
|
});
|
|
}
|
|
|
|
// -- internals ---------------------------------------------------------
|
|
|
|
private setStatus(status: ConnectionStatus): void {
|
|
if (this.status_ === status) return;
|
|
this.status_ = status;
|
|
for (const handler of this.statusHandlers) handler(status);
|
|
}
|
|
|
|
private handleOpen(): void {
|
|
this.setStatus("open");
|
|
this.reconnectAttempts = 0;
|
|
// Re-attach every known chat_id so deliveries continue routing after a drop.
|
|
for (const chatId of this.knownChats) {
|
|
this.rawSend({ type: "attach", chat_id: chatId });
|
|
}
|
|
// Flush anything queued during reconnect.
|
|
const queued = this.sendQueue.splice(0);
|
|
for (const frame of queued) this.rawSend(frame);
|
|
}
|
|
|
|
private handleMessage(ev: MessageEvent): void {
|
|
let parsed: InboundEvent;
|
|
try {
|
|
parsed = JSON.parse(typeof ev.data === "string" ? ev.data : "") as InboundEvent;
|
|
} catch {
|
|
if (wsInboundDebugEnabled()) {
|
|
const raw = typeof ev.data === "string" ? ev.data : String(ev.data);
|
|
console.warn(
|
|
"[nanobot ws inbound] invalid JSON",
|
|
raw.length > 400 ? `${raw.slice(0, 400)}… (${raw.length} chars)` : raw,
|
|
);
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (wsInboundDebugEnabled()) {
|
|
console.log("[nanobot ws inbound]", summarizeInboundWsPayload(parsed));
|
|
}
|
|
|
|
if (parsed.event === "ready") {
|
|
this.readyChatId = parsed.chat_id;
|
|
this.knownChats.add(parsed.chat_id);
|
|
return;
|
|
}
|
|
|
|
if (parsed.event === "attached") {
|
|
this.knownChats.add(parsed.chat_id);
|
|
if (this.pendingNewChat) {
|
|
clearTimeout(this.pendingNewChat.timer);
|
|
this.pendingNewChat.resolve(parsed.chat_id);
|
|
this.pendingNewChat = null;
|
|
}
|
|
this.dispatch(parsed.chat_id, parsed);
|
|
return;
|
|
}
|
|
|
|
if (parsed.event === "runtime_model_updated") {
|
|
this.emitRuntimeModelUpdate(parsed.model_name || null, parsed.model_preset ?? null);
|
|
return;
|
|
}
|
|
|
|
if (parsed.event === "session_updated") {
|
|
this.emitSessionUpdate(parsed.chat_id, parsed.scope, parsed.workspace_scope);
|
|
return;
|
|
}
|
|
|
|
if (parsed.event === "error" && parsed.detail === "workspace_scope_rejected") {
|
|
this.emitError({
|
|
kind: "workspace_scope_rejected",
|
|
reason: parsed.reason,
|
|
chatId: parsed.chat_id,
|
|
});
|
|
if (this.pendingNewChat) {
|
|
clearTimeout(this.pendingNewChat.timer);
|
|
this.pendingNewChat.reject(new Error(`workspace_scope_rejected:${parsed.reason || ""}`));
|
|
this.pendingNewChat = null;
|
|
}
|
|
}
|
|
|
|
const chatId = (parsed as { chat_id?: string }).chat_id;
|
|
if (chatId) {
|
|
this.recordGoalStatusForRunStrip(chatId, parsed);
|
|
this.recordGoalStateSnapshot(chatId, parsed);
|
|
this.dispatch(chatId, parsed);
|
|
}
|
|
}
|
|
|
|
private emitRuntimeModelUpdate(modelName: string | null, modelPreset?: string | null): void {
|
|
for (const handler of this.runtimeModelHandlers) {
|
|
handler(modelName, modelPreset);
|
|
}
|
|
}
|
|
|
|
private emitSessionUpdate(
|
|
chatId: string,
|
|
scope?: SessionUpdateScope,
|
|
workspaceScope?: WorkspaceScopePayload,
|
|
): void {
|
|
for (const handler of this.sessionUpdateHandlers) {
|
|
handler(chatId, scope, workspaceScope);
|
|
}
|
|
}
|
|
|
|
private emitRunStatus(chatId: string, startedAt: number | null): void {
|
|
for (const handler of this.runStatusHandlers) {
|
|
handler(chatId, startedAt);
|
|
}
|
|
}
|
|
|
|
private dispatch(chatId: string, ev: InboundEvent): void {
|
|
const handlers = this.chatHandlers.get(chatId);
|
|
if (handlers !== undefined && handlers.size > 0) {
|
|
for (const h of handlers) {
|
|
h(ev);
|
|
}
|
|
return;
|
|
}
|
|
let q = this.pendingInboundByChat.get(chatId);
|
|
if (!q) {
|
|
q = [];
|
|
this.pendingInboundByChat.set(chatId, q);
|
|
}
|
|
q.push(ev);
|
|
const over = q.length - NanobotClient.PENDING_INBOUND_MAX;
|
|
if (over > 0) {
|
|
q.splice(0, over);
|
|
}
|
|
}
|
|
|
|
private handleClose(event?: { code?: number }): void {
|
|
this.socket = null;
|
|
if (this.pendingNewChat) {
|
|
clearTimeout(this.pendingNewChat.timer);
|
|
this.pendingNewChat.reject(new Error("socket closed"));
|
|
this.pendingNewChat = null;
|
|
}
|
|
// Surface structured reasons *before* reconnect logic so the UI can
|
|
// display the error even while the client transparently reconnects.
|
|
// Browsers populate ``CloseEvent.code`` with the wire-level close code;
|
|
// 1009 = Message Too Big (server's max frame guard).
|
|
if (event?.code === 1009) {
|
|
this.emitError({ kind: "message_too_big" });
|
|
}
|
|
if (this.intentionallyClosed || !this.shouldReconnect) {
|
|
this.setStatus("closed");
|
|
return;
|
|
}
|
|
this.scheduleReconnect();
|
|
}
|
|
|
|
private emitError(error: StreamError): void {
|
|
// Isolate subscribers so a throwing handler cannot abort the surrounding
|
|
// ``handleClose`` flow (which still owes us a reconnect decision + status
|
|
// update). We deliberately swallow here: error reporting is best-effort
|
|
// and must never be allowed to compound the failure it's reporting.
|
|
for (const handler of this.errorHandlers) {
|
|
try {
|
|
handler(error);
|
|
} catch {
|
|
// best-effort: subscriber fault must not stall transport bookkeeping
|
|
}
|
|
}
|
|
}
|
|
|
|
private scheduleReconnect(): void {
|
|
this.setStatus("reconnecting");
|
|
const attempt = this.reconnectAttempts++;
|
|
// Exponential backoff: 0.5s, 1s, 2s, 4s, capped.
|
|
const delay = Math.min(500 * 2 ** attempt, this.maxBackoffMs);
|
|
this.reconnectTimer = setTimeout(async () => {
|
|
this.reconnectTimer = null;
|
|
if (this.options.onReauth) {
|
|
try {
|
|
const refreshed = await this.options.onReauth();
|
|
if (refreshed) this.currentUrl = refreshed;
|
|
} catch {
|
|
// fall through to retry with current URL
|
|
}
|
|
}
|
|
this.connect();
|
|
}, delay);
|
|
}
|
|
|
|
private queueSend(frame: Outbound): void {
|
|
if (this.socket?.readyState === WS_OPEN) {
|
|
this.rawSend(frame);
|
|
} else {
|
|
this.sendQueue.push(frame);
|
|
}
|
|
}
|
|
|
|
private rawSend(frame: Outbound): void {
|
|
if (!this.socket) return;
|
|
try {
|
|
this.socket.send(JSON.stringify(frame));
|
|
} catch {
|
|
// Send failure will materialize as a close; queue the frame for retry.
|
|
this.sendQueue.push(frame);
|
|
}
|
|
}
|
|
}
|