botmux 2.110.0-canary.1 → 2.110.0

package/dist/adapters/backend/riff-backend.d.ts

@@ -0,0 +1,251 @@
+import type { SessionBackend, SpawnOpts } from './types.js';
+export interface RiffBackendConfig {
+    baseUrl: string;
+    templateId?: string;
+    agent?: string;
+    model?: string;
+    /** Direct JWT token (takes precedence over jwtEnv). */
+    jwt?: string;
+    /** Name of env var containing the JWT token (default: RIFF_JWT). */
+    jwtEnv?: string;
+    sandboxCluster?: string;
+    /**
+     * Repos to clone into the riff sandbox, in the API's native shape
+     * ({ repoName: 'group/repo', repoBranch? }). Takes precedence over
+     * defaultRepo/defaultBranch. Typically derived by the worker from the
+     * session's local workingDir (复用本地仓库+分支) — see
+     * deriveRiffRepoFromWorkingDir.
+     */
+    repos?: RiffRepoRef[];
+    /** Parent task id persisted by the daemon (see worker riff_task_id IPC) —
+     *  restores the follow-up lineage after a daemon restart. */
+    resumeParentTaskId?: string;
+    /** Human-readable notes about the derived repo state (dirty tree, unpushed
+     *  commits). Printed as status lines on task creation so the user knows the
+     *  sandbox may not see their latest local changes. */
+    repoWarnings?: string[];
+    injectStatusLines?: boolean;
+    logLevel?: string;
+    /**
+     * Environment variables injected into the riff sandbox execution environment.
+     * Merged from: botmux session context vars (BOTMUX_SESSION_ID, …) → per-bot
+     * env (bots.json `env`) → explicit config.env (which takes precedence).
+     * The sandbox installs botmux via setupCommands, so BOTMUX_* vars are needed
+     * for the agent to use `botmux send`. Sent as `config.env` to the riff API.
+     */
+    env?: Record<string, string>;
+    /**
+     * System prompt injected into the riff task. Prepended to the userPrompt
+     * (riff API has no separate system-prompt field) so the agent knows it is
+     * running inside a botmux-bridged session. When unset, the built-in
+     * DEFAULT_RIFF_SYSTEM_PROMPT is used as a fallback.
+     */
+    systemPrompt?: string;
+    /**
+     * ADDITIONAL shell commands run in the riff sandbox before the agent starts
+     * working. botmux is ALWAYS installed via MANDATORY_SETUP_COMMANDS (not
+     * user-editable, sent to the riff API as config.setupCommands); these are
+     * extra commands the user wants to run after that (e.g. installing other
+     * dependencies). Sent to the riff API as `config.setupCommands` appended
+     * after the mandatory botmux install commands.
+     */
+    setupCommands?: string[];
+}
+/** Valid riff service base URL: non-empty http(s). Shared by the worker's
+ *  spawn fail-fast and the dashboard PUT endpoint so every config entry point
+ *  (dashboard / /config / setup / hand-edited bots.json) hits the same gate. */
+export declare function isValidRiffBaseUrl(v: unknown): v is string;
+export interface RiffRepoRef {
+    /** Internal repo name, e.g. 'webinfra/agent-monorepo' (code.byted.org). */
+    repoName: string;
+    /** Branch to pin. Omitted → the repo's default branch. (The riff API
+     *  ignores unknown fields like `branch`; `repoBranch` is the real one —
+     *  verified empirically: it normalizes to gitRef/gitRefType/gitCommitId.) */
+    repoBranch?: string;
+}
+/**
+ * Normalize a git origin URL / repo spec to riff's internal repoName.
+ * Accepts `git@code.byted.org:group/repo.git`, `https://code.byted.org/group/repo(.git)`
+ * and bare `group/repo`. Returns null for non-internal hosts (github.com etc.) —
+ * the riff API validates repoName against the internal registry and cannot
+ * clone external repos.
+ */
+export declare function parseRiffRepoName(spec: string): string | null;
+/**
+ * Derive the riff repo ref from a local checkout so a riff task executes
+ * against the same repo + branch the botmux session works in (复用本地仓库).
+ * All git calls are local (no network). Returns null when the workingDir is
+ * not a git repo or its origin is not an internal repo riff can clone.
+ * `warnings` surface states the sandbox cannot see (dirty tree, unpushed
+ * commits, never-pushed branch) — callers inject them as status lines.
+ */
+export declare function deriveRiffRepoFromWorkingDir(workingDir: string, runGit?: (args: string[]) => string | null): {
+    repo: RiffRepoRef;
+    warnings: string[];
+} | null;
+/**
+ * Multi-repo derivation over an EXPLICIT, ordered dir list — the repo-select
+ * card's 多仓库 flow stamps the user's chosen worktree dirs (in selection
+ * order) onto the session, and ONLY that stamp triggers multi-repo here. The
+ * first dir becomes riff's `primary` (sandbox cwd). Never scans children of an
+ * arbitrary non-git workingDir: a home dir / repo-collection dir would attach
+ * random unrelated repos to the task.
+ */
+export declare function deriveRiffReposFromDirs(dirs: string[], deriveOne?: typeof deriveRiffRepoFromWorkingDir): {
+    repos: RiffRepoRef[];
+    warnings: string[];
+} | null;
+/**
+ * Daemon-side orphan cancel: /close on a worker-less riff session must still
+ * cancel the persisted remote task (the sandbox agent otherwise keeps running
+ * with injected Lark credentials after the topic is closed). Bounded + one
+ * retry; failures are logged, never thrown.
+ */
+export declare function cancelRiffTaskById(cfg: {
+    baseUrl: string;
+    jwt?: string;
+    jwtEnv?: string;
+}, taskId: string): Promise<boolean>;
+/** Irreversible short hash of a sandbox URL for log correlation — the unique
+ *  subdomain IS the write capability, so neither URL nor host may be logged. */
+export declare function hashUrlForLog(u: string): string;
+/**
+ * RiffBackend — bridges botmux's SessionBackend interface to riff's HTTP API.
+ *
+ * Lifecycle:
+ *   spawn()       → initializes riff client (no actual task created yet)
+ *   write(text)   → creates a task (first write) or follow-up (subsequent writes)
+ *                   SSE output events flow through onData callback
+ *   kill()        → cancels current task via task-cancel
+ *   onExit        → fires on /close (kill) or unrecoverable error, NOT on task done
+ *
+ * SSE events use standard SSE format: event type in `event:` line, JSON in `data:` lines.
+ * Events: output (text chunks), status (state changes), init (full state + accessUrl),
+ * session_info (sandbox access info), done (task completion), log (verbose logs).
+ */
+export declare class RiffBackend implements SessionBackend {
+    private config;
+    private sessionId;
+    private dataCb;
+    private exitCb;
+    private accessUrlCb;
+    private taskDoneCb;
+    private taskIdCb;
+    private outputBuffer;
+    private currentTaskId;
+    private currentAccessUrl;
+    /** True when currentAccessUrl is the sandbox directAccessUrl (never downgrade it). */
+    private accessUrlIsDirect;
+    private abortController;
+    private killed;
+    /** /close teardown in progress — new writes are rejected and an in-flight
+     *  create/follow-up must cancel its late task instead of streaming it. */
+    private closing;
+    private taskDone;
+    /** Tasks whose done event already fired the turn boundary — a duplicate
+     *  done (observed live) or a stale stream must never re-fire it. Bounded:
+     *  cleared past 64 entries (a session rarely exceeds a few dozen turns). */
+    private completedTaskIds;
+    private reconnectAttempts;
+    private maxReconnectAttempts;
+    /** 预算层级（单调覆盖，见 destroySession 注释）；字段化以便测试注入边界。 */
+    private cancelTimeoutMs;
+    private createTimeoutMs;
+    private destroyDeadlineMs;
+    /** Serializes write() → createTask/followUp. Without this, a second message
+     *  arriving before the first task-execute HTTP returns would see
+     *  currentTaskId === null and create a duplicate task. */
+    private writeChain;
+    constructor(config: RiffBackendConfig, sessionId: string);
+    /** Called when the riff sandbox accessUrl becomes available or changes. */
+    onAccessUrl(cb: (url: string) => void): void;
+    /** Called when the current riff task completes or fails (turn boundary). */
+    onTaskDone(cb: () => void): void;
+    /** Called whenever a new task id becomes current (create/follow-up). The
+     *  worker forwards it to the daemon so the follow-up lineage survives a
+     *  daemon restart (currentTaskId otherwise lives only in this process). */
+    onTaskId(cb: (taskId: string | null) => void): void;
+    /** Resolve JWT dynamically — re-reads env/keychain each call so auto-refresh works. */
+    private getJwt;
+    private resolveJwt;
+    private readJwtFromBytecloudKeychain;
+    spawn(_bin: string, _args: string[], _opts: SpawnOpts): void;
+    write(data: string): void;
+    resize(_cols: number, _rows: number): void;
+    onData(cb: (data: string) => void): void;
+    onExit(cb: (code: number | null, signal: string | null) => void): void;
+    kill(): void;
+    destroySession(): Promise<void>;
+    getChildPid(): number | null;
+    captureCurrentScreen(): string;
+    captureViewport(): string;
+    getPaneSize(): {
+        cols: number;
+        rows: number;
+    } | null;
+    /**
+     * Emit a styled status line into the terminal stream. The worker renders
+     * this through a headless xterm — bare `\n` (no carriage return) makes
+     * lines stair-step to the right, which is the main reason the raw log view
+     * was hard to read. Always emit `\r\n` and reset ANSI styling per line.
+     */
+    private emitLine;
+    /** Normalize newlines for xterm rendering (bare \n → \r\n, keep existing \r\n). */
+    private emitText;
+    private extractAttachments;
+    private basename;
+    private createTask;
+    private followUp;
+    /**
+     * Prepend the configured system prompt to the user prompt.
+     * The riff API has no separate system-prompt field (only userPrompt), so we
+     * fold the system prompt into the prompt text. config.systemPrompt takes
+     * precedence over the built-in DEFAULT_RIFF_SYSTEM_PROMPT. The result is
+     * wrapped in a <system> block so the agent can distinguish it from the user
+     * message. NOTE: setup commands (botmux install) are NOT injected here —
+     * they are sent to the riff API via config.setupCommands for reliability.
+     */
+    private injectSystemPrompt;
+    /**
+     * Build the env object for the riff sandbox. Precedence (highest wins):
+     *   1. config.env (explicit per-bot riff config)
+     *   2. per-bot env from bots.json `env` (merged by the worker into config.env)
+     * Returns a clean Record with empty values dropped.
+     */
+    private buildEnv;
+    private uploadAndCreate;
+    private readFileAsBlob;
+    /**
+     * Post-await adoption gate for a freshly created/followed-up task id.
+     * - closing（/close 竞态窗口）：这个 late task 已经没有会话可服务——立即取消
+     *   （有界+一次重试），绝不 stream/登记，防远端 orphan；
+     * - killed（detach：重启/休眠）：登记 id 让 daemon 持久化血缘，但不 stream
+     *   （任务合法续跑，重启后 follow-up 接上）；
+     * - 正常：登记 + 由调用方启动 stream。
+     */
+    private adoptLateTask;
+    /** Repos come exclusively from config.repos (worker-derived from the session
+     *  workingDir). The old defaultRepo/defaultBranch bot config was removed —
+     *  a stale bots.json value would silently shadow the workingDir derivation
+     *  with no UI left to clear it. */
+    private buildRepos;
+    private cancelTask;
+    private streamTask;
+    private handleSseEvent;
+    /**
+     * Track the best sandbox URL for the "Web 终端" button.
+     * Preference: directAccessUrl (the AIO sandbox terminal, directly openable)
+     * over accessUrl (riff frontend page — hardcoded to the production domain
+     * even on BOE deployments, so its origin is rewritten to the configured
+     * baseUrl). A direct URL is never downgraded back to a frontend URL within
+     * the same task. Returns true when the current URL changed.
+     */
+    private updateAccessUrl;
+    /** Rewrite a riff frontend URL onto the configured baseUrl origin (BOE vs prod). */
+    private rewriteToBaseOrigin;
+    /** One-shot task-detail fetch to pick up directAccessUrl (not present in SSE events). */
+    private fetchDirectAccessUrl;
+    private emitError;
+    private fetchAndEmitOutput;
+}
+//# sourceMappingURL=riff-backend.d.ts.map

package/dist/adapters/backend/riff-backend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"riff-backend.d.ts","sourceRoot":"","sources":["../../../src/adapters/backend/riff-backend.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAuD5D,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;IACtB;iEAC6D;IAC7D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;0DAEsD;IACtD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;gFAEgF;AAChF,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM,CAQ1D;AAED,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,CAAC;IACjB;;iFAE6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAU7D;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,MAAM,GAAG,IAAgC,GACpE;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,IAAI,CA2BlD;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EAAE,EACd,SAAS,GAAE,OAAO,4BAA2D,GAC5E;IAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,IAAI,CAYrD;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,EACvD,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,OAAO,CAAC,CAgBlB;AAED;gFACgF;AAChF,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE/C;AAiCD;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAY,YAAW,cAAc;IAChD,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAyC;IACvD,OAAO,CAAC,MAAM,CAAuE;IACrF,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,UAAU,CAA6B;IAC/C,OAAO,CAAC,QAAQ,CAAkD;IAClE,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,sFAAsF;IACtF,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,eAAe,CAAgC;IACvD,OAAO,CAAC,MAAM,CAAS;IACvB;8EAC0E;IAC1E,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAS;IACzB;;gFAE4E;IAC5E,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,oBAAoB,CAAK;IACjC,kDAAkD;IAClD,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,iBAAiB,CAAU;IACnC;;8DAE0D;IAC1D,OAAO,CAAC,UAAU,CAAoC;gBAE1C,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM;IASxD,2EAA2E;IAC3E,WAAW,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAK5C,4EAA4E;IAC5E,UAAU,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI;IAIhC;;+EAE2E;IAC3E,QAAQ,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,GAAG,IAAI;IAKnD,uFAAuF;IACvF,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,4BAA4B;IAkBpC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI;IAK5D,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAyBzB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAI1C,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIxC,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,GAAG,IAAI;IAItE,IAAI,IAAI,IAAI;IAaN,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAyCrC,WAAW,IAAI,MAAM,GAAG,IAAI;IAI5B,oBAAoB,IAAI,MAAM;IAI9B,eAAe,IAAI,MAAM;IAIzB,WAAW,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAMpD;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAgBhB,mFAAmF;IACnF,OAAO,CAAC,QAAQ;IAMhB,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,QAAQ;YAKF,UAAU;YAsDV,QAAQ;IA0BtB;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;YAUF,eAAe;YA6Cf,cAAc;IAM5B;;;;;;;OAOG;YACW,aAAa;IAsB3B;;;uCAGmC;IACnC,OAAO,CAAC,UAAU;YAIJ,UAAU;YAeV,UAAU;IA4ExB,OAAO,CAAC,cAAc;IAsHtB;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAgBvB,oFAAoF;IACpF,OAAO,CAAC,mBAAmB;IAW3B,yFAAyF;YAC3E,oBAAoB;IAsBlC,OAAO,CAAC,SAAS;YAUH,kBAAkB;CA0DjC"}