tinker-agent 2.8.0 → 2.10.0

package/src/remote/config.ts

@@ -0,0 +1,95 @@
+import { createHash, timingSafeEqual } from "node:crypto";
+import { readFile, realpath, stat } from "node:fs/promises";
+import path from "node:path";
+import { requireId, requireObject, requireText } from "./protocol";
+
+export type RemoteWorkspaceConfig = {
+  id: string;
+  name: string;
+  path: string;
+  profile?: string;
+};
+export type RemoteServiceConfig = {
+  stateDirectory: string;
+  hostname: string;
+  port: number;
+  tls: { certFile: string; keyFile: string };
+  devices: { id: string; name: string; tokenSha256: string }[];
+  workspaces: RemoteWorkspaceConfig[];
+};
+
+export async function loadRemoteConfig(file: string): Promise<RemoteServiceConfig> {
+  const absolute = path.resolve(file);
+  const raw = requireObject(JSON.parse(await readFile(absolute, "utf8")));
+  if (raw.version !== 1)
+    throw new Error("Remote service configuration version must be 1.");
+  const resolve = (value: unknown, name: string) =>
+    path.resolve(path.dirname(absolute), requireText(value, name, 4096));
+  const tls = requireObject(raw.tls);
+  const port = raw.port ?? 9443;
+  if (typeof port !== "number" || !Number.isInteger(port) || port < 1 || port > 65535)
+    throw new Error("Invalid service port.");
+  if (!Array.isArray(raw.devices) || raw.devices.length === 0)
+    throw new Error("At least one paired device is required.");
+  if (!Array.isArray(raw.workspaces) || raw.workspaces.length === 0)
+    throw new Error("At least one workspace is required.");
+  const devices = raw.devices.map((entry) => {
+    const device = requireObject(entry);
+    const tokenSha256 = requireText(device.tokenSha256, "tokenSha256", 64);
+    if (!/^[0-9a-f]{64}$/.test(tokenSha256))
+      throw new Error("Device tokenSha256 must be a lowercase SHA-256 digest.");
+    return {
+      id: requireId(device.id, "device.id"),
+      name: requireText(device.name, "device.name", 240),
+      tokenSha256,
+    };
+  });
+  const workspaces: RemoteWorkspaceConfig[] = [];
+  for (const entry of raw.workspaces) {
+    const workspace = requireObject(entry);
+    const root = await realpath(resolve(workspace.path, "workspace.path"));
+    if (!(await stat(root)).isDirectory())
+      throw new Error("Workspace must be a directory.");
+    workspaces.push({
+      id: requireId(workspace.id, "workspace.id"),
+      name: requireText(workspace.name, "workspace.name", 240),
+      path: root,
+      ...(workspace.profile === undefined
+        ? {}
+        : { profile: requireText(workspace.profile, "workspace.profile", 240) }),
+    });
+  }
+  if (
+    new Set(devices.map((d) => d.id)).size !== devices.length ||
+    new Set(workspaces.map((w) => w.id)).size !== workspaces.length ||
+    new Set(workspaces.map((w) => w.path)).size !== workspaces.length
+  )
+    throw new Error("Duplicate device/workspace identity.");
+  const hostname = raw.hostname ?? "127.0.0.1";
+  if (hostname !== "127.0.0.1" && hostname !== "::1")
+    throw new Error("Bind the service to loopback; expose only the relay TCP port.");
+  return {
+    stateDirectory: resolve(raw.stateDirectory, "stateDirectory"),
+    hostname,
+    port,
+    tls: {
+      certFile: resolve(tls.certFile, "tls.certFile"),
+      keyFile: resolve(tls.keyFile, "tls.keyFile"),
+    },
+    devices,
+    workspaces,
+  };
+}
+
+export function authenticateDevice(
+  header: string | null,
+  devices: RemoteServiceConfig["devices"],
+): string | undefined {
+  if (!header?.startsWith("Bearer ") || header.length > 256) return undefined;
+  const token = header.slice(7);
+  if (!/^[A-Za-z0-9_-]{43,128}$/.test(token)) return undefined;
+  const digest = createHash("sha256").update(token).digest();
+  return devices.find((device) =>
+    timingSafeEqual(digest, Buffer.from(device.tokenSha256, "hex")),
+  )?.id;
+}

package/src/remote/http-server.ts

@@ -0,0 +1,240 @@
+import type { ServerWebSocket } from "bun";
+import { authenticateDevice, type RemoteServiceConfig } from "./config";
+import {
+  RemoteError,
+  parseOperation,
+  requireId,
+  type RemoteCursor,
+  type RemoteFrame,
+} from "./protocol";
+import { RemoteService } from "./service";
+import type { HostedSession } from "../agent/runtime-hosted-session";
+
+type SocketData = {
+  session: HostedSession;
+  cursor?: RemoteCursor;
+  unsubscribe?: () => void;
+  device: string;
+};
+const SOCKET_BUFFER_LIMIT = 2 * 1024 * 1024;
+
+export function startRemoteHttpServer(
+  service: RemoteService,
+  config: RemoteServiceConfig,
+) {
+  const sockets = new Set<ServerWebSocket<SocketData>>();
+  const server = Bun.serve<SocketData>({
+    hostname: config.hostname,
+    port: config.port,
+    tls: {
+      cert: Bun.file(config.tls.certFile),
+      key: Bun.file(config.tls.keyFile),
+    },
+    maxRequestBodySize: 72 * 1024,
+    idleTimeout: 30,
+    async fetch(request, server) {
+      try {
+        // Native clients authenticate in headers. Browser-origin requests are not supported.
+        if (request.headers.has("origin"))
+          throw new RemoteError(
+            403,
+            "ORIGIN_REJECTED",
+            "Browser origins are not enabled.",
+          );
+        const device = authenticateDevice(
+          request.headers.get("authorization"),
+          config.devices,
+        );
+        if (!device)
+          throw new RemoteError(
+            401,
+            "AUTH_REQUIRED",
+            "Pair this device with the Mac before connecting.",
+          );
+        const url = new URL(request.url);
+        const parts = url.pathname.split("/").filter(Boolean);
+        if (parts[0] !== "v1")
+          throw new RemoteError(404, "NOT_FOUND", "Unknown API version or route.");
+        if (request.method === "GET" && url.pathname === "/v1/workspaces") {
+          return json({
+            version: 1,
+            workspaces: service.workspaces.map(({ id, name }) => ({
+              id,
+              name,
+            })),
+          });
+        }
+        if (
+          request.method === "GET" &&
+          parts.length === 4 &&
+          parts[1] === "workspaces" &&
+          parts[3] === "sessions"
+        ) {
+          return json({
+            sessions: await service.listSessions(requireId(parts[2], "workspaceId")),
+          });
+        }
+        if (parts[1] === "operations") {
+          if (request.method === "POST" && parts.length === 2) {
+            if (!request.headers.get("content-type")?.startsWith("application/json"))
+              throw new RemoteError(415, "JSON_REQUIRED", "Send application/json.");
+            const input = parseOperation(await request.json());
+            // Never use request.signal as a runtime cancellation signal.
+            return json(await service.submit(input, device), 202);
+          }
+          if (request.method === "GET" && parts.length === 3)
+            return json(service.store.get(requireId(parts[2], "requestId", true)));
+        }
+        if (request.method === "GET" && parts.length === 4 && parts[1] === "sessions") {
+          const session = service.session(requireId(parts[2], "sessionId", true));
+          await session.open();
+          if (parts[3] === "snapshot") return json(session.hub.snapshot());
+          if (parts[3] === "history") {
+            return json(
+              session.history(
+                optionalInteger(
+                  url.searchParams.get("before"),
+                  1,
+                  Number.MAX_SAFE_INTEGER,
+                ),
+                optionalInteger(url.searchParams.get("limit"), 1, 100),
+              ),
+            );
+          }
+          if (parts[3] === "events") {
+            if (sockets.size >= 64)
+              throw new RemoteError(
+                429,
+                "CONNECTION_LIMIT",
+                "Too many connected clients.",
+              );
+            const epoch = url.searchParams.get("epoch");
+            const sequence = optionalInteger(
+              url.searchParams.get("after"),
+              0,
+              Number.MAX_SAFE_INTEGER,
+            );
+            const cursor =
+              epoch && sequence !== undefined ? { epoch, sequence } : undefined;
+            if (server.upgrade(request, { data: { session, cursor, device } })) return;
+            throw new RemoteError(
+              400,
+              "WEBSOCKET_REQUIRED",
+              "Upgrade this request to WebSocket.",
+            );
+          }
+        }
+        throw new RemoteError(404, "NOT_FOUND", "Unknown API route.");
+      } catch (error) {
+        if (error instanceof RemoteError)
+          return json(
+            { error: { code: error.code, message: error.message } },
+            error.status,
+          );
+        if (error instanceof SyntaxError)
+          return json(
+            {
+              error: {
+                code: "INVALID_JSON",
+                message: "Request body is not valid JSON.",
+              },
+            },
+            400,
+          );
+        return json(
+          {
+            error: {
+              code: "LOCAL_SERVICE_ERROR",
+              message:
+                error instanceof Error ? error.message : "The local operation failed.",
+            },
+          },
+          500,
+        );
+      }
+    },
+    websocket: {
+      maxPayloadLength: 1024,
+      backpressureLimit: SOCKET_BUFFER_LIMIT,
+      closeOnBackpressureLimit: true,
+      idleTimeout: 60,
+      sendPings: true,
+      open(socket) {
+        sockets.add(socket);
+        const send = (frame: RemoteFrame) => {
+          try {
+            if (socket.getBufferedAmount() > SOCKET_BUFFER_LIMIT) {
+              socket.close(1013, "Reconnect to resynchronize");
+              return;
+            }
+            const text = JSON.stringify(frame);
+            if (socket.send(text) === -1)
+              socket.close(1013, "Reconnect to resynchronize");
+          } catch {
+            socket.close(1011, "Reconnect to resynchronize");
+          }
+        };
+        socket.data.unsubscribe = socket.data.session.hub.subscribe(
+          socket.data.cursor,
+          send,
+        );
+      },
+      message(socket) {
+        socket.close(1008, "Submit operations over HTTPS");
+      },
+      close(socket) {
+        sockets.delete(socket);
+        socket.data.unsubscribe?.();
+        // Detach only. The hosted runtime and its AbortController stay alive.
+      },
+    },
+  });
+  return {
+    port: server.port!,
+    async stopTransport() {
+      for (const socket of sockets) {
+        socket.data.unsubscribe?.();
+        socket.terminate();
+      }
+      // Bun 1.3.14 can leave stop's promise pending after a closing TLS socket
+      // is terminated. stop(true) synchronously closes the listener/connections;
+      // bound its completion wait so runtime disposal can always proceed.
+      let timer: ReturnType<typeof setTimeout> | undefined;
+      try {
+        await Promise.race([
+          server.stop(true),
+          new Promise<void>((resolve) => {
+            timer = setTimeout(resolve, 250);
+          }),
+        ]);
+      } finally {
+        if (timer) clearTimeout(timer);
+      }
+    },
+  };
+}
+
+function json(value: unknown, status = 200): Response {
+  return Response.json(value, {
+    status,
+    headers: {
+      "Cache-Control": "no-store",
+      "X-Content-Type-Options": "nosniff",
+    },
+  });
+}
+function optionalInteger(
+  value: string | null,
+  minimum: number,
+  maximum: number,
+): number | undefined {
+  if (value === null) return undefined;
+  if (
+    !/^\d+$/.test(value) ||
+    !Number.isSafeInteger(Number(value)) ||
+    Number(value) < minimum ||
+    Number(value) > maximum
+  )
+    throw new RemoteError(400, "INVALID_CURSOR", "Invalid history or event cursor.");
+  return Number(value);
+}

package/src/remote/protocol.ts

@@ -0,0 +1,228 @@
+import type {
+  RemoteHistoryPage,
+  RemoteMessage,
+} from "../session/remote-history-reader";
+
+export const REMOTE_PROTOCOL_VERSION = 1;
+export type OperationStatus =
+  | "accepted"
+  | "running"
+  | "waiting_input"
+  | "completed"
+  | "failed"
+  | "cancelled"
+  | "interrupted";
+
+export type RemoteOperationInput = { requestId: string } & (
+  | { kind: "create"; workspaceId: string; title?: string }
+  | { kind: "adopt"; workspaceId: string; sessionId: string }
+  | { kind: "prompt"; sessionId: string; prompt: string }
+  | { kind: "stop"; sessionId: string; targetRequestId: string }
+  | {
+      kind: "answer";
+      sessionId: string;
+      interactionId: string;
+      selectedIndex: number | null;
+    }
+  | {
+      kind: "confirm";
+      sessionId: string;
+      interactionId: string;
+      decision: "allow" | "deny";
+    }
+);
+
+export type OperationReceipt = {
+  requestId: string;
+  sessionId: string;
+  kind: RemoteOperationInput["kind"];
+  status: OperationStatus;
+  createdAt: string;
+  updatedAt: string;
+  turnId?: string;
+  prompt?: string;
+  error?: string;
+};
+
+export type RemoteSessionInfo = {
+  id: string;
+  workspaceId: string;
+  title: string;
+  modelName: string;
+  owner: "service" | "local";
+  status: string;
+  updatedAt: string;
+};
+
+export type RemoteInteraction =
+  | {
+      id: string;
+      kind: "question";
+      question: string;
+      options: readonly { description: string }[];
+    }
+  | { id: string; kind: "confirmation"; command: string; reason: string };
+
+export type RemoteTool = {
+  id: string;
+  name: string;
+  arguments: string;
+  status: "running" | "completed" | "failed" | "cancelled";
+  detail?: string;
+};
+
+export type RemoteActivity = {
+  session: RemoteSessionInfo;
+  status: "idle" | OperationStatus;
+  activeRequestId?: string;
+  activeTurnId?: string;
+  streaming?: { iterationId: string; attempt: number; text: string };
+  tools: RemoteTool[];
+  interaction?: RemoteInteraction;
+  operations: OperationReceipt[];
+  error?: string;
+};
+
+export type RemoteView = RemoteActivity & { history: RemoteHistoryPage };
+export type RemoteChange = { activity: RemoteActivity; messages: RemoteMessage[] };
+export type RemoteCursor = { epoch: string; sequence: number };
+export type RemoteFrame = { version: 1; epoch: string; sequence: number } & (
+  | { type: "snapshot"; view: RemoteView }
+  | { type: "event"; change: RemoteChange }
+);
+
+export class RemoteError extends Error {
+  constructor(
+    readonly status: number,
+    readonly code: string,
+    message: string,
+  ) {
+    super(message);
+    this.name = "RemoteError";
+  }
+}
+
+export function isTerminal(status: OperationStatus): boolean {
+  return ["completed", "failed", "cancelled", "interrupted"].includes(status);
+}
+
+const ID = /^[a-zA-Z0-9][a-zA-Z0-9_-]{0,100}$/;
+const UUID =
+  /^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+export function requireId(value: unknown, name: string, uuid = false): string {
+  if (typeof value !== "string" || !(uuid ? UUID : ID).test(value)) {
+    throw new RemoteError(400, "INVALID_REQUEST", `${name} is invalid.`);
+  }
+  return value;
+}
+
+export function parseOperation(value: unknown): RemoteOperationInput {
+  const object = requireObject(value);
+  const requestId = requireId(object.requestId, "requestId", true);
+  const kind = object.kind;
+  const sessionId = () => requireId(object.sessionId, "sessionId", true);
+  let result: RemoteOperationInput;
+  switch (kind) {
+    case "create":
+      result = {
+        requestId,
+        kind,
+        workspaceId: requireId(object.workspaceId, "workspaceId"),
+        ...(object.title === undefined
+          ? {}
+          : { title: requireText(object.title, "title", 240) }),
+      };
+      break;
+    case "adopt":
+      result = {
+        requestId,
+        kind,
+        workspaceId: requireId(object.workspaceId, "workspaceId"),
+        sessionId: sessionId(),
+      };
+      break;
+    case "prompt":
+      result = {
+        requestId,
+        kind,
+        sessionId: sessionId(),
+        prompt: requireText(object.prompt, "prompt", 64 * 1024),
+      };
+      break;
+    case "stop":
+      result = {
+        requestId,
+        kind,
+        sessionId: sessionId(),
+        targetRequestId: requireId(object.targetRequestId, "targetRequestId", true),
+      };
+      break;
+    case "confirm":
+      if (object.decision !== "allow" && object.decision !== "deny") {
+        throw new RemoteError(
+          400,
+          "INVALID_REQUEST",
+          "decision must be allow or deny.",
+        );
+      }
+      result = {
+        requestId,
+        kind,
+        sessionId: sessionId(),
+        interactionId: requireId(object.interactionId, "interactionId", true),
+        decision: object.decision,
+      };
+      break;
+    case "answer": {
+      const selectedIndex = object.selectedIndex;
+      if (
+        selectedIndex !== null &&
+        (typeof selectedIndex !== "number" ||
+          !Number.isSafeInteger(selectedIndex) ||
+          selectedIndex < 0)
+      ) {
+        throw new RemoteError(
+          400,
+          "INVALID_REQUEST",
+          "selectedIndex must be a nonnegative integer or null.",
+        );
+      }
+      result = {
+        requestId,
+        kind,
+        sessionId: sessionId(),
+        interactionId: requireId(object.interactionId, "interactionId", true),
+        selectedIndex,
+      };
+      break;
+    }
+    default:
+      throw new RemoteError(400, "INVALID_REQUEST", "Unknown operation kind.");
+  }
+  if (Object.keys(object).some((key) => !(key in result))) {
+    throw new RemoteError(400, "INVALID_REQUEST", "Unexpected operation field.");
+  }
+  return result;
+}
+
+export function requireObject(value: unknown): Record<string, unknown> {
+  if (value === null || typeof value !== "object" || Array.isArray(value)) {
+    throw new RemoteError(400, "INVALID_REQUEST", "Expected an object.");
+  }
+  return value as Record<string, unknown>;
+}
+
+export function requireText(value: unknown, name: string, maxBytes: number): string {
+  if (
+    typeof value !== "string" ||
+    !value.trim() ||
+    Buffer.byteLength(value) > maxBytes
+  ) {
+    throw new RemoteError(
+      400,
+      "INVALID_REQUEST",
+      `${name} must contain 1–${maxBytes} bytes.`,
+    );
+  }
+  return value;
+}