@downcity/agent 1.1.32 → 1.1.43

package/src/session/tools/shell/ShellToolDefinition.ts

@@ -1,509 +0,0 @@
-/**
- * Shell tools（service 化版本）。
- *
- * 设计目标（中文）
- * - shell 子进程生命周期统一由 `shellService` 承担。
- * - tool 只负责 Session/tool 协议适配、参数校验与日志语义。
- * - 复杂桥接和 schema 已拆到旁路模块，当前文件只保留公开 tool 定义。
- */
-
-import { tool } from "ai";
-import type {
-  ShellCloseInput,
-  ShellExecInput,
-  ShellReadInput,
-  ShellStartInput,
-  ShellStatusInput,
-  ShellWaitInput,
-  ShellWriteInput,
-} from "@/plugin/builtins/shell/types/Shell.js";
-import type { JsonObject } from "@/types/common/Json.js";
-import { validateChatSendCommand } from "./ShellToolFormatting.js";
-import {
-  bridgeCommandResponse,
-  clearShellCommandBridge,
-  flattenShellActionResponse,
-  flattenShellExecResponse,
-  formatToolError,
-  invokeShellAction,
-  setShellToolRuntime,
-  trackShellCommandBridge,
-} from "./ShellToolBridge.js";
-import {
-  shellCloseInputSchema,
-  shellExecInputSchema,
-  shellReadInputSchema,
-  shellStartInputSchema,
-  shellStatusInputSchema,
-  shellWaitInputSchema,
-  shellWriteInputSchema,
-} from "./ShellToolSchemas.js";
-
-export { setShellToolRuntime } from "./ShellToolBridge.js";
-
-async function bridgeExecResponseIfNeeded(params: {
-  /**
-   * 原始命令文本。
-   */
-  cmd: string;
-  /**
-   * shell 标识。
-   */
-  shellId: string;
-  /**
-   * 已扁平化的一次性执行结果。
-   */
-  response: JsonObject;
-}): Promise<JsonObject> {
-  trackShellCommandBridge(params.cmd, params.shellId);
-  const withInternalShellId = {
-    ...params.response,
-    shell_id: params.shellId,
-    has_more_output: false,
-  } as JsonObject;
-  const bridged = await bridgeCommandResponse({
-    shellId: params.shellId,
-    response: withInternalShellId,
-  });
-  if ("shell_id" in bridged) delete bridged.shell_id;
-  if ("has_more_output" in bridged) delete bridged.has_more_output;
-  return bridged;
-}
-
-/**
- * `shell_start`：启动 shell 会话。
- */
-export const shell_start = tool({
-  description:
-    "Start a shell session. Returns shell_id plus initial status/output. Long-running commands should usually be checked later with shell_status or shell_wait instead of repeated polling.",
-  inputSchema: shellStartInputSchema,
-  execute: async ({
-    cmd,
-    workdir,
-    shell,
-    login = true,
-    inline_wait_ms = 1200,
-    max_output_tokens,
-    auto_notify_on_exit,
-  }: ShellStartInput) => {
-    const startedAt = Date.now();
-
-    try {
-      console.log(
-        "[shell-tool] shell_start:start",
-        JSON.stringify({
-          cmd,
-          workdir: workdir || "",
-          shell: shell || "",
-          login,
-          inline_wait_ms,
-          max_output_tokens: max_output_tokens ?? null,
-          auto_notify_on_exit: auto_notify_on_exit ?? null,
-        }),
-      );
-
-      const validationError = validateChatSendCommand(cmd);
-      if (validationError) {
-        console.log(
-          "[shell-tool] shell_start:rejected",
-          JSON.stringify({ reason: validationError }),
-        );
-        return {
-          success: false,
-          error: `shell_start rejected: ${validationError}`,
-        };
-      }
-
-      const response = await invokeShellAction({
-        action: "start",
-        payload: {
-          cmd,
-          ...(workdir ? { cwd: workdir } : {}),
-          ...(shell ? { shell } : {}),
-          login,
-          inlineWaitMs: inline_wait_ms,
-          ...(typeof max_output_tokens === "number"
-            ? { maxOutputTokens: max_output_tokens }
-            : {}),
-          ...(typeof auto_notify_on_exit === "boolean"
-            ? { autoNotifyOnExit: auto_notify_on_exit }
-            : {}),
-        },
-      });
-
-      const shellId = response.shell.shellId;
-      trackShellCommandBridge(cmd, shellId);
-      const flatResponse = flattenShellActionResponse({ response, startedAt });
-      const bridgedResponse = await bridgeCommandResponse({
-        shellId,
-        response: flatResponse,
-      });
-      console.log(
-        "[shell-tool] shell_start:done",
-        JSON.stringify({
-          shell_id: shellId,
-          status: bridgedResponse.status,
-          exit_code: bridgedResponse.exit_code ?? null,
-          output_chars: String(bridgedResponse.output || "").length,
-          has_more_output: bridgedResponse.has_more_output === true,
-        }),
-      );
-      return bridgedResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_start:error",
-        JSON.stringify({ error: String(error) }),
-      );
-      return formatToolError("shell_start failed", error);
-    }
-  },
-});
-
-/**
- * `shell_exec`：一次性执行并等待完成。
- */
-export const shell_exec = tool({
-  description:
-    "Execute a short shell command in one-shot mode and wait for completion. Prefer shell_start for long-running or interactive commands.",
-  inputSchema: shellExecInputSchema,
-  execute: async ({
-    cmd,
-    workdir,
-    shell,
-    login = true,
-    timeout_ms = 60000,
-    max_output_tokens,
-  }: ShellExecInput) => {
-    const startedAt = Date.now();
-
-    try {
-      console.log(
-        "[shell-tool] shell_exec:start",
-        JSON.stringify({
-          cmd,
-          workdir: workdir || "",
-          shell: shell || "",
-          login,
-          timeout_ms,
-          max_output_tokens: max_output_tokens ?? null,
-        }),
-      );
-
-      const validationError = validateChatSendCommand(cmd);
-      if (validationError) {
-        console.log(
-          "[shell-tool] shell_exec:rejected",
-          JSON.stringify({ reason: validationError }),
-        );
-        return {
-          success: false,
-          error: `shell_exec rejected: ${validationError}`,
-        };
-      }
-
-      const response = await invokeShellAction({
-        action: "exec",
-        payload: {
-          cmd,
-          ...(workdir ? { cwd: workdir } : {}),
-          ...(shell ? { shell } : {}),
-          login,
-          timeoutMs: timeout_ms,
-          ...(typeof max_output_tokens === "number"
-            ? { maxOutputTokens: max_output_tokens }
-            : {}),
-        },
-      });
-
-      const shellId = response.shell.shellId;
-      const flatResponse = flattenShellExecResponse({ response, startedAt });
-      const bridgedResponse = await bridgeExecResponseIfNeeded({
-        cmd,
-        shellId,
-        response: flatResponse,
-      });
-
-      console.log(
-        "[shell-tool] shell_exec:done",
-        JSON.stringify({
-          status: bridgedResponse.status,
-          exit_code: bridgedResponse.exit_code ?? null,
-          output_chars: String(bridgedResponse.output || "").length,
-        }),
-      );
-      return bridgedResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_exec:error",
-        JSON.stringify({ error: String(error) }),
-      );
-      return formatToolError("shell_exec failed", error);
-    }
-  },
-});
-
-/**
- * `shell_status`：查询 shell 当前状态。
- */
-export const shell_status = tool({
-  description:
-    "Query the current status of a shell session. Prefer this to ask for progress during long-running commands.",
-  inputSchema: shellStatusInputSchema,
-  execute: async ({ shell_id, cmd }: ShellStatusInput) => {
-    const startedAt = Date.now();
-    try {
-      console.log(
-        "[shell-tool] shell_status:start",
-        JSON.stringify({ shell_id: shell_id || "", cmd: cmd || "" }),
-      );
-      const response = await invokeShellAction({
-        action: "status",
-        payload: {
-          ...(shell_id ? { shellId: shell_id } : {}),
-          ...(cmd ? { cmd } : {}),
-          includeCompleted: true,
-        },
-      });
-      const flatResponse = flattenShellActionResponse({ response, startedAt });
-      console.log(
-        "[shell-tool] shell_status:done",
-        JSON.stringify({
-          shell_id: flatResponse.shell_id,
-          status: flatResponse.status,
-          version: flatResponse.version,
-          exit_code: flatResponse.exit_code ?? null,
-        }),
-      );
-      return flatResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_status:error",
-        JSON.stringify({ shell_id: shell_id || "", error: String(error) }),
-      );
-      return formatToolError("shell_status failed", error);
-    }
-  },
-});
-
-/**
- * `shell_read`：读取 shell 输出增量。
- */
-export const shell_read = tool({
-  description:
-    "Read output from a shell session starting at a character cursor. Use this only when you truly need the raw incremental output.",
-  inputSchema: shellReadInputSchema,
-  execute: async ({
-    shell_id,
-    from_cursor,
-    max_output_tokens,
-  }: ShellReadInput) => {
-    const startedAt = Date.now();
-    try {
-      console.log(
-        "[shell-tool] shell_read:start",
-        JSON.stringify({
-          shell_id,
-          from_cursor: from_cursor ?? null,
-          max_output_tokens: max_output_tokens ?? null,
-        }),
-      );
-      const response = await invokeShellAction({
-        action: "read",
-        payload: {
-          shellId: shell_id,
-          ...(typeof from_cursor === "number" ? { fromCursor: from_cursor } : {}),
-          ...(typeof max_output_tokens === "number"
-            ? { maxOutputTokens: max_output_tokens }
-            : {}),
-          includeCompleted: true,
-        },
-      });
-      const flatResponse = flattenShellActionResponse({ response, startedAt });
-      const bridgedResponse = await bridgeCommandResponse({
-        shellId: shell_id,
-        response: flatResponse,
-      });
-      console.log(
-        "[shell-tool] shell_read:done",
-        JSON.stringify({
-          shell_id,
-          status: bridgedResponse.status,
-          exit_code: bridgedResponse.exit_code ?? null,
-          output_chars: String(bridgedResponse.output || "").length,
-          has_more_output: bridgedResponse.has_more_output === true,
-        }),
-      );
-      return bridgedResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_read:error",
-        JSON.stringify({ shell_id, error: String(error) }),
-      );
-      return formatToolError("shell_read failed", error);
-    }
-  },
-});
-
-/**
- * `shell_write`：向 shell stdin 写入内容。
- */
-export const shell_write = tool({
-  description: "Write text to the stdin of an existing shell session.",
-  inputSchema: shellWriteInputSchema,
-  execute: async ({ shell_id, chars }: ShellWriteInput) => {
-    const startedAt = Date.now();
-    try {
-      console.log(
-        "[shell-tool] shell_write:start",
-        JSON.stringify({
-          shell_id,
-          input_chars: String(chars || "").length,
-        }),
-      );
-      const response = await invokeShellAction({
-        action: "write",
-        payload: {
-          shellId: shell_id,
-          chars,
-        },
-      });
-      const flatResponse = flattenShellActionResponse({ response, startedAt });
-      console.log(
-        "[shell-tool] shell_write:done",
-        JSON.stringify({
-          shell_id,
-          status: flatResponse.status,
-          version: flatResponse.version,
-        }),
-      );
-      return flatResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_write:error",
-        JSON.stringify({ shell_id, error: String(error) }),
-      );
-      return formatToolError("shell_write failed", error);
-    }
-  },
-});
-
-/**
- * `shell_wait`：等待 shell 状态或输出变化。
- */
-export const shell_wait = tool({
-  description:
-    "Wait for a shell session to change state or produce more output. Prefer this over manual high-frequency polling loops.",
-  inputSchema: shellWaitInputSchema,
-  execute: async ({
-    shell_id,
-    after_version,
-    from_cursor,
-    timeout_ms = 10000,
-    max_output_tokens,
-  }: ShellWaitInput) => {
-    const startedAt = Date.now();
-    try {
-      console.log(
-        "[shell-tool] shell_wait:start",
-        JSON.stringify({
-          shell_id,
-          after_version: after_version ?? null,
-          from_cursor: from_cursor ?? null,
-          timeout_ms,
-          max_output_tokens: max_output_tokens ?? null,
-        }),
-      );
-      const response = await invokeShellAction({
-        action: "wait",
-        payload: {
-          shellId: shell_id,
-          ...(typeof after_version === "number"
-            ? { afterVersion: after_version }
-            : {}),
-          ...(typeof from_cursor === "number" ? { fromCursor: from_cursor } : {}),
-          timeoutMs: timeout_ms,
-          ...(typeof max_output_tokens === "number"
-            ? { maxOutputTokens: max_output_tokens }
-            : {}),
-        },
-      });
-      const flatResponse = flattenShellActionResponse({ response, startedAt });
-      const bridgedResponse = await bridgeCommandResponse({
-        shellId: shell_id,
-        response: flatResponse,
-      });
-      console.log(
-        "[shell-tool] shell_wait:done",
-        JSON.stringify({
-          shell_id,
-          status: bridgedResponse.status,
-          version: bridgedResponse.version,
-          exit_code: bridgedResponse.exit_code ?? null,
-          output_chars: String(bridgedResponse.output || "").length,
-        }),
-      );
-      return bridgedResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_wait:error",
-        JSON.stringify({ shell_id, error: String(error) }),
-      );
-      return formatToolError("shell_wait failed", error);
-    }
-  },
-});
-
-/**
- * `shell_close`：关闭 shell 会话。
- */
-export const shell_close = tool({
-  description:
-    "Close an existing shell session and release resources. Use force=true to send SIGKILL.",
-  inputSchema: shellCloseInputSchema,
-  execute: async ({ shell_id, force = false }: ShellCloseInput) => {
-    const startedAt = Date.now();
-    try {
-      console.log(
-        "[shell-tool] shell_close:start",
-        JSON.stringify({ shell_id, force }),
-      );
-      clearShellCommandBridge(shell_id);
-      const response = await invokeShellAction({
-        action: "close",
-        payload: {
-          shellId: shell_id,
-          force,
-        },
-      });
-      const flatResponse = flattenShellActionResponse({ response, startedAt });
-      console.log(
-        "[shell-tool] shell_close:done",
-        JSON.stringify({
-          shell_id,
-          status: flatResponse.status,
-          exit_code: flatResponse.exit_code ?? null,
-        }),
-      );
-      return flatResponse;
-    } catch (error) {
-      console.log(
-        "[shell-tool] shell_close:error",
-        JSON.stringify({ shell_id, error: String(error) }),
-      );
-      return formatToolError("shell_close failed", error);
-    }
-  },
-});
-
-/**
- * Shell 工具导出集合。
- */
-export const shellTools = {
-  shell_exec,
-  shell_start,
-  shell_status,
-  shell_read,
-  shell_write,
-  shell_wait,
-  shell_close,
-};

package/src/session/tools/shell/ShellToolFormatting.ts

@@ -1,83 +0,0 @@
-/**
- * Shell 工具辅助函数。
- *
- * 关键点（中文）
- * - shell 会话生命周期已经迁移到 `shellService`。
- * - 这里仅保留当前仍被 tool 与测试复用的最小能力：命令安全校验与 env 注入。
- */
-
-import { stripInvocationAuthEnv } from "@/runtime/server/http/auth/AuthEnv.js";
-import { getSessionRunScope } from "@session/SessionRunScope.js";
-
-function setEnvString(
-  env: NodeJS.ProcessEnv,
-  key: string,
-  value: string | undefined,
-): void {
-  if (typeof value !== "string") return;
-  const trimmed = value.trim();
-  if (!trimmed) return;
-  env[key] = trimmed;
-}
-
-function applyEnvMap(
-  env: NodeJS.ProcessEnv,
-  entries?: Record<string, string>,
-): void {
-  if (!entries) return;
-  for (const [rawKey, rawValue] of Object.entries(entries)) {
-    const key = String(rawKey || "").trim();
-    if (!key) continue;
-    setEnvString(env, key, rawValue);
-  }
-}
-
-/**
- * 对 `city chat send` 命令做前置安全校验。
- *
- * 关键点（中文）
- * - 历史上模型会把长文本直接拼进多行 shell 命令，导致后续行被 zsh 当作独立命令解析。
- * - 这会出现“前面已发送，后面才报错”的副作用。
- * - 默认建议多行正文通过 `--stdin`、`--text-file` 或显式 `--text` 传入。
- */
-export function validateChatSendCommand(cmd: string): string | null {
-  const source = String(cmd ?? "");
-  if (!/\b(?:city|downcity)\s+chat\s+send\b/.test(source)) return null;
-  if (!/[\r\n]/.test(source)) return null;
-  if (/\b(?:city|downcity)\s+chat\s+send\b[\s\S]*\s--stdin(?:\s|$)/.test(source)) {
-    return null;
-  }
-  if (/\b(?:city|downcity)\s+chat\s+send\b[\s\S]*\s--text(?:\s|$)/.test(source)) {
-    return null;
-  }
-  if (/\b(?:city|downcity)\s+chat\s+send\b[\s\S]*\s--text-file(?:\s|$)/.test(source)) {
-    return null;
-  }
-  return [
-    "Unsafe `city chat send` command: real newlines are not allowed.",
-    "If your message is multi-line, use `city chat send --stdin` (with heredoc/pipe), `--text-file`, or explicit `--text`.",
-  ].join(" ");
-}
-
-/**
- * 构建 shell 子进程环境变量。
- *
- * 关键点（中文）
- * - 当前仍用于 shell tool/service 与相关测试。
- * - 优先级：显式注入 > 当前请求上下文变量 > 宿主进程环境。
- * - 默认剥离 Bearer Token，避免通用 shell 隐式走本地 HTTP。
- */
-export function buildShellContextEnv(
-  injected?: Record<string, string>,
-): NodeJS.ProcessEnv {
-  const env: NodeJS.ProcessEnv = { ...process.env };
-  const contextCtx = getSessionRunScope();
-
-  applyEnvMap(env, injected);
-  setEnvString(env, "DC_SESSION_ID", contextCtx?.sessionId);
-  setEnvString(env, "DC_CTX_SERVER_HOST", process.env.DC_SERVER_HOST);
-  setEnvString(env, "DC_CTX_SERVER_PORT", process.env.DC_SERVER_PORT);
-  stripInvocationAuthEnv(env);
-
-  return env;
-}

package/src/session/tools/shell/ShellToolSchemas.ts

@@ -1,120 +0,0 @@
-/**
- * Shell tool 输入 schema。
- *
- * 关键点（中文）
- * - 所有 schema 统一集中，避免 `Tool.ts` 里同时混杂协议定义与执行逻辑。
- * - 这里保持纯声明，不放任何运行时桥接细节。
- */
-
-import { z } from "zod";
-
-export const shellStartInputSchema = z.object({
-  cmd: z.string().describe("Shell command to execute."),
-  workdir: z
-    .string()
-    .optional()
-    .describe("Optional working directory. Relative path is resolved from project root."),
-  shell: z
-    .string()
-    .optional()
-    .describe("Optional shell executable path. Example: /bin/zsh"),
-  login: z
-    .boolean()
-    .optional()
-    .default(true)
-    .describe("Whether to run shell as login shell (-lc). false uses -c."),
-  inline_wait_ms: z
-    .number()
-    .optional()
-    .default(1200)
-    .describe("How long to inline-wait for initial output before returning."),
-  max_output_tokens: z
-    .number()
-    .optional()
-    .describe("Maximum output tokens returned in a single read chunk."),
-  auto_notify_on_exit: z
-    .boolean()
-    .optional()
-    .describe("Whether the shell service should auto-return to the owning chat agent when the command exits."),
-});
-
-export const shellExecInputSchema = z.object({
-  cmd: z.string().describe("Shell command to execute once and wait until completion."),
-  workdir: z
-    .string()
-    .optional()
-    .describe("Optional working directory. Relative path is resolved from project root."),
-  shell: z
-    .string()
-    .optional()
-    .describe("Optional shell executable path. Example: /bin/zsh"),
-  login: z
-    .boolean()
-    .optional()
-    .default(true)
-    .describe("Whether to run shell as login shell (-lc). false uses -c."),
-  timeout_ms: z
-    .number()
-    .optional()
-    .default(60000)
-    .describe("Total timeout for one-shot execution. Use shell_start for long-running commands."),
-  max_output_tokens: z
-    .number()
-    .optional()
-    .describe("Maximum output tokens returned in the final result."),
-});
-
-export const shellStatusInputSchema = z.object({
-  shell_id: z.string().optional().describe("Existing shell identifier."),
-  cmd: z
-    .string()
-    .optional()
-    .describe("Optional command substring to resolve the latest shell in the current chat."),
-});
-
-export const shellReadInputSchema = z.object({
-  shell_id: z.string().describe("Existing shell identifier."),
-  from_cursor: z
-    .number()
-    .optional()
-    .describe("Character cursor to continue reading from."),
-  max_output_tokens: z
-    .number()
-    .optional()
-    .describe("Maximum output tokens returned in this chunk."),
-});
-
-export const shellWriteInputSchema = z.object({
-  shell_id: z.string().describe("Existing shell identifier."),
-  chars: z.string().describe("Bytes to write to stdin."),
-});
-
-export const shellWaitInputSchema = z.object({
-  shell_id: z.string().describe("Existing shell identifier."),
-  after_version: z
-    .number()
-    .optional()
-    .describe("Only return once the shell version is greater than this value."),
-  from_cursor: z
-    .number()
-    .optional()
-    .describe("Character cursor to continue reading from after the wait."),
-  timeout_ms: z
-    .number()
-    .optional()
-    .default(10000)
-    .describe("Maximum time to wait for state/output changes."),
-  max_output_tokens: z
-    .number()
-    .optional()
-    .describe("Maximum output tokens returned in this chunk."),
-});
-
-export const shellCloseInputSchema = z.object({
-  shell_id: z.string().describe("Existing shell identifier."),
-  force: z
-    .boolean()
-    .optional()
-    .default(false)
-    .describe("Whether to force-kill the shell with SIGKILL."),
-});