@vellumai/assistant 0.7.0 → 0.7.2

package/src/daemon/host-file-proxy.ts

@@ -1,10 +1,14 @@
 import { v4 as uuid } from "uuid";
 
+import {
+  assistantEventHub,
+  broadcastMessage,
+} from "../runtime/assistant-event-hub.js";
+import * as pendingInteractions from "../runtime/pending-interactions.js";
 import { readImageBase64 } from "../tools/shared/filesystem/image-read.js";
 import type { ToolExecutionResult } from "../tools/types.js";
 import { AssistantError, ErrorCode } from "../util/errors.js";
 import { getLogger } from "../util/logger.js";
-import type { ServerMessage } from "./message-protocol.js";
 import type { HostFileRequest } from "./message-types/host-file.js";
 
 /** Distributive omit that preserves union variant fields. */
@@ -20,87 +24,120 @@ export type HostFileInput = DistributiveOmit<
 
 const log = getLogger("host-file-proxy");
 
-interface PendingRequest {
-  resolve: (result: ToolExecutionResult) => void;
-  reject: (err: Error) => void;
-  timer: ReturnType<typeof setTimeout>;
-  operation: HostFileInput["operation"];
-  path: string;
-  /** Detach the abort listener from the caller's signal. No-op when no signal was passed. */
-  detachAbort: () => void;
-}
-
 export class HostFileProxy {
-  private pending = new Map<string, PendingRequest>();
-  private sendToClient: (msg: ServerMessage) => void;
-  private onInternalResolve?: (requestId: string) => void;
-  private clientConnected = false;
-
-  constructor(
-    sendToClient: (msg: ServerMessage) => void,
-    onInternalResolve?: (requestId: string) => void,
-  ) {
-    this.sendToClient = sendToClient;
-    this.onInternalResolve = onInternalResolve;
+  private static _instance: HostFileProxy | null = null;
+
+  /**
+   * Lazily-initialized singleton. Availability of an actual desktop
+   * connection is checked at send time via the assistant event hub,
+   * not at construction time.
+   */
+  static get instance(): HostFileProxy {
+    if (!HostFileProxy._instance) {
+      log.info("Creating singleton HostFileProxy");
+      HostFileProxy._instance = new HostFileProxy();
+    }
+    return HostFileProxy._instance;
   }
 
-  updateSender(
-    sendToClient: (msg: ServerMessage) => void,
-    clientConnected: boolean,
-  ): void {
-    this.sendToClient = sendToClient;
-    this.clientConnected = clientConnected;
+  /** Dispose the singleton. Called during graceful shutdown. */
+  static disposeInstance(): void {
+    if (HostFileProxy._instance) {
+      HostFileProxy._instance.dispose();
+      HostFileProxy._instance = null;
+    }
+  }
+
+  /** For tests. */
+  static reset(): void {
+    HostFileProxy._instance = null;
+  }
+
+  /**
+   * Whether a client with `host_file` capability is connected.
+   * Note: host_file covers both file operations and transfers.
+   */
+  isAvailable(): boolean {
+    return (
+      assistantEventHub.getMostRecentClientByCapability("host_file") != null
+    );
   }
 
   request(
     input: HostFileInput,
     conversationId: string,
     signal?: AbortSignal,
+    targetClientId?: string,
   ): Promise<ToolExecutionResult> {
     if (signal?.aborted) {
       return Promise.resolve({ content: "Aborted", isError: true });
     }
 
+    // Resolve targetClientId: explicit → validate; single capable client → auto-resolve.
+    // Callers may embed targetClientId in the input object (tool handlers) or pass it as
+    // the 4th parameter (legacy). Prefer the explicit param; fall back to input field.
+    let resolvedTargetClientId: string | undefined = targetClientId ?? input.targetClientId;
+    if (resolvedTargetClientId != null) {
+      const client = assistantEventHub.getClientById(resolvedTargetClientId);
+      if (!client) {
+        return Promise.resolve({
+          content: `No connected client with id '${resolvedTargetClientId}' supports host_file. Run \`assistant clients list --capability host_file\` to see available clients.`,
+          isError: true,
+        });
+      }
+      if (!client.capabilities.includes("host_file")) {
+        return Promise.resolve({
+          content: `Client '${resolvedTargetClientId}' does not support host_file. Run \`assistant clients list --capability host_file\` to see available clients.`,
+          isError: true,
+        });
+      }
+    } else {
+      const capable = assistantEventHub.listClientsByCapability("host_file");
+      if (capable.length === 1) {
+        resolvedTargetClientId = capable[0].clientId;
+      }
+    }
+
     const requestId = uuid();
 
     return new Promise<ToolExecutionResult>((resolve, reject) => {
-      // File operations should be fast — 30 second timeout.
       const timeoutSec = 30;
 
-      // Declared up-front so onAbort (defined before detachAbort is assigned)
-      // can close over a stable reference once it's wired below.
       let detachAbort: () => void = () => {};
 
       const timer = setTimeout(() => {
-        this.pending.delete(requestId);
-        detachAbort();
-        this.onInternalResolve?.(requestId);
+        pendingInteractions.resolve(requestId);
         log.warn(
           { requestId, operation: input.operation },
           "Host file proxy request timed out",
         );
         resolve({
-          content: "Host file proxy timed out waiting for client response",
+          content: resolvedTargetClientId
+            ? `Host file proxy timed out waiting for response from client '${resolvedTargetClientId}'`
+            : "Host file proxy timed out waiting for client response",
           isError: true,
         });
       }, timeoutSec * 1000);
 
       if (signal) {
         const onAbort = () => {
-          if (this.pending.has(requestId)) {
-            clearTimeout(timer);
-            this.pending.delete(requestId);
-            // Abort fired — nothing to detach, but call the no-op for symmetry
-            // so callers can rely on detachAbort being idempotent.
-            detachAbort();
-            this.onInternalResolve?.(requestId);
+          if (pendingInteractions.get(requestId)) {
+            pendingInteractions.resolve(requestId);
             try {
-              this.sendToClient({
-                type: "host_file_cancel",
-                requestId,
-              } as ServerMessage);
+              broadcastMessage(
+                {
+                  type: "host_file_cancel",
+                  requestId,
+                  conversationId,
+                  ...(resolvedTargetClientId != null
+                    ? { targetClientId: resolvedTargetClientId }
+                    : {}),
+                },
+                conversationId,
+                { targetClientId: resolvedTargetClientId },
+              );
             } catch {
-              // Best-effort cancel notification — connection may already be closed.
+              // Best-effort cancel notification
             }
             resolve({ content: "Aborted", isError: true });
           }
@@ -109,30 +146,35 @@ export class HostFileProxy {
         detachAbort = () => signal.removeEventListener("abort", onAbort);
       }
 
-      this.pending.set(requestId, {
-        resolve,
-        reject,
+      pendingInteractions.register(requestId, {
+        conversationId,
+        kind: "host_file",
+        targetClientId: resolvedTargetClientId,
+        rpcResolve: resolve,
+        rpcReject: reject,
         timer,
-        operation: input.operation,
-        path: input.path,
         detachAbort,
+        metadata: { operation: input.operation, path: input.path },
       });
 
       try {
-        this.sendToClient({
-          ...input,
-          type: "host_file_request",
-          requestId,
+        broadcastMessage(
+          {
+            ...input,
+            type: "host_file_request",
+            requestId,
+            conversationId,
+            // Always include in message body so the receiving client can verify
+            // which endpoint was targeted (even when auto-resolved).
+            ...(resolvedTargetClientId != null
+              ? { targetClientId: resolvedTargetClientId }
+              : {}),
+          },
           conversationId,
-        } as ServerMessage);
+          { targetClientId: resolvedTargetClientId },
+        );
       } catch (err) {
-        // Sender threw synchronously (e.g. client transport error during
-        // event emission). Clean up pending state and timer so we don't
-        // leak an in-flight entry that nothing will ever resolve.
-        clearTimeout(timer);
-        this.pending.delete(requestId);
-        detachAbort();
-        this.onInternalResolve?.(requestId);
+        pendingInteractions.resolve(requestId);
         log.warn(
           { requestId, operation: input.operation, err },
           "Host file proxy send failed",
@@ -142,58 +184,61 @@ export class HostFileProxy {
     });
   }
 
+  /**
+   * Process a client result and resolve the RPC. Called by route handlers.
+   */
   resolve(
     requestId: string,
     response: { content: string; isError: boolean; imageData?: string },
   ): void {
-    const entry = this.pending.get(requestId);
-    if (!entry) {
+    const interaction = pendingInteractions.resolve(requestId);
+    if (!interaction?.rpcResolve) {
       log.warn({ requestId }, "No pending host file request for response");
       return;
     }
-    clearTimeout(entry.timer);
-    entry.detachAbort();
-    this.pending.delete(requestId);
+    const meta = interaction.metadata ?? {};
     if (
-      entry.operation === "read" &&
+      meta.operation === "read" &&
       !response.isError &&
       typeof response.imageData === "string" &&
       response.imageData.length > 0
     ) {
-      entry.resolve(readImageBase64(response.imageData, entry.path));
+      interaction.rpcResolve(
+        readImageBase64(response.imageData, meta.path as string),
+      );
       return;
     }
-    entry.resolve({ content: response.content, isError: response.isError });
-  }
-
-  hasPendingRequest(requestId: string): boolean {
-    return this.pending.has(requestId);
-  }
-
-  isAvailable(): boolean {
-    return this.clientConnected;
+    interaction.rpcResolve({
+      content: response.content,
+      isError: response.isError,
+    });
   }
 
   dispose(): void {
-    for (const [requestId, entry] of this.pending) {
-      clearTimeout(entry.timer);
-      entry.detachAbort();
-      this.onInternalResolve?.(requestId);
+    for (const entry of pendingInteractions.getByKind("host_file")) {
+      pendingInteractions.resolve(entry.requestId);
       try {
-        this.sendToClient({
-          type: "host_file_cancel",
-          requestId,
-        } as ServerMessage);
+        broadcastMessage(
+          {
+            type: "host_file_cancel",
+            requestId: entry.requestId,
+            conversationId: entry.conversationId,
+            ...(entry.targetClientId != null
+              ? { targetClientId: entry.targetClientId }
+              : {}),
+          },
+          entry.conversationId,
+          { targetClientId: entry.targetClientId as string | undefined },
+        );
       } catch {
-        // Best-effort cancel notification — connection may already be closed.
+        // Best-effort cancel notification
       }
-      entry.reject(
+      entry.rpcReject?.(
         new AssistantError(
           "Host file proxy disposed",
           ErrorCode.INTERNAL_ERROR,
         ),
       );
     }
-    this.pending.clear();
   }
 }

package/src/daemon/host-proxy-base.ts

@@ -0,0 +1,294 @@
+/**
+ * Shared lifecycle base for host-proxy classes (HostBashProxy, HostCuProxy,
+ * HostFileProxy, HostTransferProxy, HostBrowserProxy, ...).
+ *
+ * Each host proxy:
+ *  - dispatches a request to the desktop client via the assistant event hub,
+ *  - tracks the request in a pending map keyed by `requestId`,
+ *  - times the request out after a configurable interval,
+ *  - cancels the request when the caller's `AbortSignal` fires,
+ *  - rejects all pending requests on `dispose()`,
+ *  - exposes `isAvailable()` based on the connected client's capabilities.
+ *
+ * Subclasses keep proxy-specific concerns (envelope shape, observation
+ * formatting, per-proxy state like CU's step counter) out of the base.
+ */
+import { v4 as uuid } from "uuid";
+
+import type { HostProxyCapability } from "../channels/types.js";
+import {
+  assistantEventHub,
+  broadcastMessage,
+} from "../runtime/assistant-event-hub.js";
+import type { PendingInteraction } from "../runtime/pending-interactions.js";
+import * as pendingInteractions from "../runtime/pending-interactions.js";
+import { AssistantError, ErrorCode } from "../util/errors.js";
+import { getLogger } from "../util/logger.js";
+import type { ServerMessage } from "./message-protocol.js";
+
+const log = getLogger("host-proxy-base");
+
+/**
+ * `broadcastMessage` is statically typed against the discriminated
+ * `ServerMessage` union. The base class assembles envelopes from
+ * constructor-supplied event names and untyped extra fields, so static
+ * narrowing is impossible — subclasses are responsible for passing event
+ * names that match a real `ServerMessage` variant.
+ */
+function broadcastDynamic(
+  envelope: Record<string, unknown>,
+  targetClientId?: string,
+): void {
+  broadcastMessage(
+    envelope as unknown as ServerMessage,
+    undefined,
+    targetClientId ? { targetClientId } : undefined,
+  );
+}
+
+const DEFAULT_TIMEOUT_MS = 60_000;
+
+/** Reason a pending request was rejected by the base. */
+export type HostProxyRejectionReason = "timeout" | "aborted" | "disposed";
+
+/**
+ * Error thrown by the base when a pending request is rejected via the
+ * lifecycle paths (timeout, abort, dispose). Subclasses inspect `reason`
+ * to map back to their proxy-specific error / observation shape.
+ */
+export class HostProxyRequestError extends AssistantError {
+  constructor(
+    message: string,
+    public readonly reason: HostProxyRejectionReason,
+  ) {
+    super(message, ErrorCode.INTERNAL_ERROR);
+    this.name = "HostProxyRequestError";
+  }
+}
+
+interface PendingEntry<TResultPayload> {
+  resolve: (payload: TResultPayload) => void;
+  reject: (err: Error) => void;
+  timer: ReturnType<typeof setTimeout>;
+  conversationId: string;
+  targetClientId?: string;
+  /** Detach the abort listener from the caller's signal. No-op when no signal was passed. */
+  detachAbort: () => void;
+}
+
+export interface HostProxyBaseOptions {
+  /** Capability advertised by clients that can service this proxy. */
+  capabilityName: HostProxyCapability;
+  /** Outbound message `type` for new requests (e.g. `"host_cu_request"`). */
+  requestEventName: string;
+  /** Outbound message `type` for cancellation (e.g. `"host_cu_cancel"`). */
+  cancelEventName: string;
+  /** Tag used to identify this proxy's requests in `pendingInteractions`. */
+  resultPendingKind: PendingInteraction["kind"];
+  /** Per-request timeout. Defaults to 60s. */
+  timeoutMs?: number;
+  /** Customizable disposed-rejection message (used in test assertions). */
+  disposedMessage?: string;
+}
+
+export abstract class HostProxyBase<TRequest, TResultPayload> {
+  protected pending = new Map<string, PendingEntry<TResultPayload>>();
+
+  protected readonly capabilityName: HostProxyCapability;
+  protected readonly requestEventName: string;
+  protected readonly cancelEventName: string;
+  protected readonly resultPendingKind: PendingInteraction["kind"];
+  protected readonly timeoutMs: number;
+  protected readonly disposedMessage: string;
+
+  constructor(opts: HostProxyBaseOptions) {
+    this.capabilityName = opts.capabilityName;
+    this.requestEventName = opts.requestEventName;
+    this.cancelEventName = opts.cancelEventName;
+    this.resultPendingKind = opts.resultPendingKind;
+    this.timeoutMs = opts.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+    this.disposedMessage = opts.disposedMessage ?? "Host proxy disposed";
+  }
+
+  /**
+   * Whether a client advertising the configured capability is connected.
+   */
+  isAvailable(): boolean {
+    return (
+      assistantEventHub.getMostRecentClientByCapability(this.capabilityName) !=
+      null
+    );
+  }
+
+  /**
+   * Dispatch a request envelope to the connected client and return a
+   * promise that resolves when the client responds (via `resolve()`),
+   * rejects on timeout/abort/dispose, or rejects synchronously if the
+   * broadcast itself fails.
+   *
+   * `extraFields` is shallow-merged into the broadcast envelope so
+   * subclasses can include proxy-specific top-level fields (e.g. CU's
+   * `stepNumber` / `reasoning`) without nesting them inside `input`.
+   *
+   * Named `dispatchRequest` rather than `request` so subclasses are free to
+   * expose their own public `request(...)` with a proxy-specific signature
+   * (e.g. CU passes `stepNumber` and `reasoning` to its callers).
+   */
+  protected dispatchRequest(
+    toolName: string,
+    input: TRequest,
+    conversationId: string,
+    signal?: AbortSignal,
+    extraFields?: Record<string, unknown>,
+    targetClientId?: string,
+  ): Promise<TResultPayload> {
+    const requestId = uuid();
+
+    return new Promise<TResultPayload>((resolve, reject) => {
+      // Declared up-front so onAbort can close over a stable reference once
+      // it's wired below.
+      let detachAbort: () => void = () => {};
+
+      const timer = setTimeout(() => {
+        this.pending.delete(requestId);
+        detachAbort();
+        pendingInteractions.resolve(requestId);
+        log.warn(
+          { requestId, toolName, kind: this.resultPendingKind },
+          "Host proxy request timed out",
+        );
+        reject(new HostProxyRequestError("timeout", "timeout"));
+      }, this.timeoutMs);
+
+      if (signal) {
+        const onAbort = () => {
+          if (this.pending.has(requestId)) {
+            clearTimeout(timer);
+            this.pending.delete(requestId);
+            detachAbort();
+            pendingInteractions.resolve(requestId);
+            try {
+              broadcastDynamic(
+                {
+                  type: this.cancelEventName,
+                  requestId,
+                  conversationId,
+                  targetClientId,
+                },
+                targetClientId,
+              );
+            } catch {
+              // Best-effort cancel notification — connection may already be closed.
+            }
+            reject(new HostProxyRequestError("aborted", "aborted"));
+          }
+        };
+        signal.addEventListener("abort", onAbort, { once: true });
+        detachAbort = () => signal.removeEventListener("abort", onAbort);
+      }
+
+      this.pending.set(requestId, {
+        resolve,
+        reject,
+        timer,
+        conversationId,
+        targetClientId,
+        detachAbort,
+      });
+
+      // Register in the global pendingInteractions store so the result-route
+      // handler (e.g. POST /v1/host-app-control-result) can look up the
+      // request by id and route it back to this proxy. Without this the
+      // route silently drops the response — see host-app-control-routes.ts:
+      // `if (!peeked || peeked.kind !== "host_app_control") return ...`.
+      // (HostCuProxy bypasses dispatchRequest entirely with its own inline
+      //  request method that registers directly, which is why CU works
+      //  without this base-level fix.)
+      pendingInteractions.register(requestId, {
+        conversationId,
+        kind: this.resultPendingKind,
+        ...(targetClientId != null ? { targetClientId } : {}),
+      });
+
+      try {
+        broadcastDynamic(
+          {
+            type: this.requestEventName,
+            requestId,
+            conversationId,
+            toolName,
+            input,
+            targetClientId,
+            ...(extraFields ?? {}),
+          },
+          targetClientId,
+        );
+      } catch (err) {
+        clearTimeout(timer);
+        this.pending.delete(requestId);
+        detachAbort();
+        pendingInteractions.resolve(requestId);
+        log.warn(
+          { requestId, toolName, kind: this.resultPendingKind, err },
+          "Host proxy send failed",
+        );
+        reject(err instanceof Error ? err : new Error(String(err)));
+      }
+    });
+  }
+
+  /**
+   * Resolve a pending request with the client-provided payload. No-op when
+   * no entry is registered for `requestId` (late responses after timeout
+   * or abort fall through to here).
+   */
+  resolve(requestId: string, payload: TResultPayload): void {
+    const entry = this.pending.get(requestId);
+    if (!entry) {
+      log.warn(
+        { requestId, kind: this.resultPendingKind },
+        "No pending host proxy request for response",
+      );
+      return;
+    }
+    clearTimeout(entry.timer);
+    entry.detachAbort();
+    this.pending.delete(requestId);
+    entry.resolve(payload);
+  }
+
+  /**
+   * Whether `requestId` is still registered as pending. Useful to subclasses
+   * that need to reason about the lifecycle in tests.
+   */
+  hasPendingRequest(requestId: string): boolean {
+    return this.pending.has(requestId);
+  }
+
+  /**
+   * Reject every pending request and clear the map. Called during graceful
+   * shutdown or proxy teardown.
+   */
+  dispose(): void {
+    for (const [requestId, entry] of this.pending) {
+      clearTimeout(entry.timer);
+      entry.detachAbort();
+      pendingInteractions.resolve(requestId);
+      try {
+        broadcastDynamic(
+          {
+            type: this.cancelEventName,
+            requestId,
+            conversationId: entry.conversationId,
+            targetClientId: entry.targetClientId,
+          },
+          entry.targetClientId,
+        );
+      } catch {
+        // Best-effort cancel notification — connection may already be closed.
+      }
+      entry.reject(new HostProxyRequestError(this.disposedMessage, "disposed"));
+    }
+    this.pending.clear();
+  }
+}