@hyzyn/dsh-tty 0.20.1 → 0.21.0

package/lib/index.d.ts

@@ -67,6 +67,7 @@
  *     子进程），必须 best-effort：失败降级为对顶层 shell 直接 SIGKILL。
  */
 import type { Context } from '@deepseek-ai/cordis';
+import z from '@deepseek-ai/schemastery';
 import { StringDecoder } from 'node:string_decoder';
 import WebSocket from 'ws';
 import xtermHeadless from '@xterm/headless';
@@ -125,6 +126,15 @@ export interface SftpLimits {
     /** 一次批量/拖拽上传的文件数上限。默认 1000。 */
     maxUploadFiles: number;
 }
+/**
+ * 运行时 Config schema——DSH ≥0.1.7 起同时就是本插件的 settings 存储。
+ *
+ * 全部字段都标 `.volatile()`：它们都是「插件配置 → 终端面板」卡片可改项，而
+ * `settings.update(entryId, patch)` 只接受 volatile 路径；loader 对 volatile-only
+ * 变更原地更新引用并发 `loader/volatile-update`，不重挂插件——插件订阅后走
+ * `applyPatch` 热应用（见 @hyzyn/dsh-kit 的 settingsEntryScope）。
+ */
+export declare const Config: z;
 /**
  * 本地 PTY 顶层 shell 的 best-effort 强杀（D48）。
  *
@@ -225,7 +235,7 @@ interface ReqLike {
 interface SocketLike {
     destroy(): void;
 }
-/** 可热更新的运行时配置（settings/updated 动态应用）。 */
+/** 可热更新的运行时配置（loader 的 volatile 更新事件动态应用）。 */
 declare class LiveConfig {
     shell: string;
     term: string;
@@ -497,6 +507,8 @@ export declare class TtyServer {
     private readonly pendingTmux;
     /** 已接线的面板连接（sessions 帧广播用；比 wss.clients 更贴合「面板」语义，单测也可驱动）。 */
     private readonly panels;
+    /** 会话 → 它所属连接的 sid 映射（kill 兜底结案时要从本地表里摘除）。 */
+    private readonly sessionLocals;
     /** WS 闸门（插件禁用时关闭）：拒绝新升级 + 断开存量连接。 */
     private wsGateOpen;
     /** 服务器状态条总开关（配置热生效；关闭时停掉全部采集，重开按订阅恢复）。 */
@@ -637,6 +649,14 @@ export declare class TtyServer {
     private handleStatsFrame;
     /** 会话退出事实 → exit 帧（恰好一次；本地 PTY 与 SSH 共用）。 */
     private watchDone;
+    /**
+     * 会话终局的**唯一出口**：退役 + 清理 + 给所有绑定连接发 exit 帧（恰好一次）。
+     *
+     * `outcome` 正常来自 PTY 句柄的 done；显式 kill 的兜底（KILL_EXIT_FALLBACK_MS）
+     * 也走这里，带 code=null / signal=SIGKILL。exit 广播到所有绑定连接（跨窗口共享），
+     * 各客户端按自己的 sid 收址。
+     */
+    private finishSession;
     /** 输出下行 + 基于 ws.bufferedAmount 的背压（暂停/恢复 PassThrough）。 */
     private attachOutput;
     /** 立即冲刷待发的合并输出（exit/kill 前调用，保证 exit 帧永远在最后一帧 data 之后）。 */

package/lib/index.js

@@ -12,7 +12,7 @@ import WebSocket, { WebSocketServer } from 'ws';
 // found），必须默认导入后取 Terminal；类型用 InstanceType 别名保持同名可用
 import xtermHeadless from '@xterm/headless';
 const HeadlessTerminal = xtermHeadless.Terminal;
-import { definePlugin, dshHome as resolveDshHome } from '@hyzyn/dsh-kit';
+import { definePlugin, dshHome as resolveDshHome, plainConfig, settingsEntryScope, suppressAutoSettingsPage } from '@hyzyn/dsh-kit';
 import { defineTool } from '@deepseek-ai/dsh-tools';
 import { spawnSsh, sshTarget, expandHome, setCredentialResolver } from './ssh.js';
 import { probeSsh } from './probe.js';
@@ -55,30 +55,37 @@ const TUNNEL_SCHEMA = z.object({
     localTargetPort: z.natural().max(65535).default(0),
     enabled: z.boolean().default(true),
 });
-/** 与「插件配置 → 终端面板」卡片表单对齐的 schema。 */
-const TTY_SETTINGS_SCHEMA = z.object({
-    enabled: z.boolean().default(true),
-    announceToAgent: z.boolean().default(true),
-    maxSessions: z.natural().max(16).default(4),
-    shell: z.string().default(''),
-    term: z.string().default('xterm-256color'),
-    colorTerm: z.string().default('truecolor'),
-    cwd: z.string().default(''),
-    reconnectGraceSec: z.natural().max(3600).default(120),
-    sshHosts: z.array(SSH_HOST_SCHEMA).default([]),
-    hostKeys: z.array(HOST_KEY_SCHEMA).default([]),
-    tunnels: z.array(TUNNEL_SCHEMA).default([]),
-    shellIntegration: z.boolean().default(true),
-    sftpStyle: z.union([z.const('dialog'), z.const('dual')]).default('dialog'),
-    persistence: z.union([z.const('off'), z.const('tmux')]).default('off'),
-    endOnPageClose: z.boolean().default(false),
-    statsEnabled: z.boolean().default(true),
+/**
+ * 运行时 Config schema——DSH ≥0.1.7 起同时就是本插件的 settings 存储。
+ *
+ * 全部字段都标 `.volatile()`：它们都是「插件配置 → 终端面板」卡片可改项，而
+ * `settings.update(entryId, patch)` 只接受 volatile 路径；loader 对 volatile-only
+ * 变更原地更新引用并发 `loader/volatile-update`，不重挂插件——插件订阅后走
+ * `applyPatch` 热应用（见 @hyzyn/dsh-kit 的 settingsEntryScope）。
+ */
+export const Config = z.object({
+    enabled: z.boolean().default(true).volatile(),
+    announceToAgent: z.boolean().default(true).volatile(),
+    maxSessions: z.natural().max(16).default(4).volatile(),
+    shell: z.string().default('').volatile(),
+    term: z.string().default('xterm-256color').volatile(),
+    colorTerm: z.string().default('truecolor').volatile(),
+    cwd: z.string().default('').volatile(),
+    reconnectGraceSec: z.natural().max(3600).default(120).volatile(),
+    sshHosts: z.array(SSH_HOST_SCHEMA).default([]).volatile(),
+    hostKeys: z.array(HOST_KEY_SCHEMA).default([]).volatile(),
+    tunnels: z.array(TUNNEL_SCHEMA).default([]).volatile(),
+    shellIntegration: z.boolean().default(true).volatile(),
+    sftpStyle: z.union([z.const('dialog'), z.const('dual')]).default('dialog').volatile(),
+    persistence: z.union([z.const('off'), z.const('tmux')]).default('off').volatile(),
+    endOnPageClose: z.boolean().default(false).volatile(),
+    statsEnabled: z.boolean().default(true).volatile(),
     sftpLimits: z.object({
         maxDownloadMb: z.natural().max(1024 * 1024).default(1024),
         maxUploadMb: z.natural().max(1024 * 1024).default(2048),
         maxUploadFiles: z.natural().max(100000).default(1000),
-    }).default({ maxDownloadMb: 1024, maxUploadMb: 2048, maxUploadFiles: 1000 }),
-    persistSessions: z.array(z.object({ tmuxName: z.string() })).default([]),
+    }).default({ maxDownloadMb: 1024, maxUploadMb: 2048, maxUploadFiles: 1000 }).volatile(),
+    persistSessions: z.array(z.object({ tmuxName: z.string() })).default([]).volatile(),
 });
 /* ------------------------------------------------------------------ *
  * 常量
@@ -90,6 +97,13 @@ const DEFAULT_RECONNECT_GRACE_SEC = 120;
 /** 下行背压阈值（ws.bufferedAmount 字节）。 */
 const BACKPRESSURE_HIGH = 512 * 1024;
 const BACKPRESSURE_LOW = 128 * 1024;
+/**
+ * 显式 kill 后的 exit 帧兜底（毫秒）。PTY 句柄的 `done` 承诺「恰好 resolve 一次」，
+ * 但个别平台/后端上 forceKill 之后它迟迟不兑现（实测 rc.1 的 subprocess-local 在
+ * Linux 上会卡住），而「发过 kill 就必须收到一条 exit 帧」是前端契约（B1/B3 用例
+ * 钉的就是它）。超时即按 SIGKILL 结案；done 真回来时靠 session.exitSent 幂等忽略。
+ */
+const KILL_EXIT_FALLBACK_MS = 2000;
 const SID_RE = /^[A-Za-z0-9_-]{1,64}$/;
 /** 自定义命令标签（0.14.0）的长度上限：单条命令，防误传超长脚本。 */
 const COMMAND_MAX = 2000;
@@ -179,7 +193,7 @@ function sanitizeTermValue(value, fallback) {
     const trimmed = value.trim();
     return TERM_RE.test(trimmed) ? trimmed : fallback;
 }
-/** 可热更新的运行时配置（settings/updated 动态应用）。 */
+/** 可热更新的运行时配置（loader 的 volatile 更新事件动态应用）。 */
 class LiveConfig {
     shell;
     term;
@@ -1147,6 +1161,8 @@ export class TtyServer {
     pendingTmux = new Map();
     /** 已接线的面板连接（sessions 帧广播用；比 wss.clients 更贴合「面板」语义，单测也可驱动）。 */
     panels = new Set();
+    /** 会话 → 它所属连接的 sid 映射（kill 兜底结案时要从本地表里摘除）。 */
+    sessionLocals = new WeakMap();
     /** WS 闸门（插件禁用时关闭）：拒绝新升级 + 断开存量连接。 */
     wsGateOpen = true;
     /** 服务器状态条总开关（配置热生效；关闭时停掉全部采集，重开按订阅恢复）。 */
@@ -1745,6 +1761,11 @@ export class TtyServer {
             /* 已退出 */
         }
         void forceKill(session.handle);
+        // 兜底：handle.done 不兑现时也要按「用户已 kill」结案（见 KILL_EXIT_FALLBACK_MS）。
+        const timer = setTimeout(() => {
+            this.finishSession(session, { exitCode: null, signal: 'SIGKILL' });
+        }, KILL_EXIT_FALLBACK_MS);
+        timer.unref?.();
     }
     /** 每会话一块虚拟屏（xterm-headless）：tty_screen 的数据源；失败降级为 null。
      *  构造参数在 createHeadlessScreen（D57：scrollback 不能是 0），这里只做委托。 */
@@ -2128,34 +2149,42 @@ export class TtyServer {
     }
     /** 会话退出事实 → exit 帧（恰好一次；本地 PTY 与 SSH 共用）。 */
     watchDone(session, local) {
+        this.sessionLocals.set(session, local);
         session.handle.done.then((outcome) => {
-            // kill 主动关闭时会话可能已被移出 local，用 exitSent 保证 exit 帧恰好一次；
-            // 发送走 session.ws 动态取值——attach 换连接后 exit 也能跟着新连接走
-            if (session.exitSent === true)
-                return;
-            session.exitSent = true;
-            session.closed = true;
-            session.statsSubs.clear();
-            this.stopStats(session);
-            local.delete(session.id);
-            this.sessions.remove(session.id);
-            if (session.kind === 'ssh' && session.tmuxName !== null)
-                this.trackPersist(session.tmuxName, false);
-            clearScreenWatchdog(session.screenHeartbeat);
-            try {
-                session.screen?.dispose();
-            }
-            catch {
-                /* 已释放 */
-            }
-            this.flushPendingOutput(session); // exit 前冲掉合并窗口里的尾巴，保序
-            // exit 广播到所有绑定连接（跨窗口共享），各客户端按自己的 sid 收址
-            for (const client of session.clients.values()) {
-                send(client.ws, { t: 'exit', sid: client.sid, code: outcome.exitCode, signal: outcome.signal });
-            }
-            session.clients.clear();
+            this.finishSession(session, outcome);
         }).catch(() => { });
     }
+    /**
+     * 会话终局的**唯一出口**：退役 + 清理 + 给所有绑定连接发 exit 帧（恰好一次）。
+     *
+     * `outcome` 正常来自 PTY 句柄的 done；显式 kill 的兜底（KILL_EXIT_FALLBACK_MS）
+     * 也走这里，带 code=null / signal=SIGKILL。exit 广播到所有绑定连接（跨窗口共享），
+     * 各客户端按自己的 sid 收址。
+     */
+    finishSession(session, outcome) {
+        if (session.exitSent === true)
+            return;
+        session.exitSent = true;
+        session.closed = true;
+        session.statsSubs.clear();
+        this.stopStats(session);
+        this.sessionLocals.get(session)?.delete(session.id);
+        this.sessions.remove(session.id);
+        if (session.kind === 'ssh' && session.tmuxName !== null)
+            this.trackPersist(session.tmuxName, false);
+        clearScreenWatchdog(session.screenHeartbeat);
+        try {
+            session.screen?.dispose();
+        }
+        catch {
+            /* 已释放 */
+        }
+        this.flushPendingOutput(session); // exit 前冲掉合并窗口里的尾巴，保序
+        for (const client of session.clients.values()) {
+            send(client.ws, { t: 'exit', sid: client.sid, code: outcome.exitCode, signal: outcome.signal });
+        }
+        session.clients.clear();
+    }
     /** 输出下行 + 基于 ws.bufferedAmount 的背压（暂停/恢复 PassThrough）。 */
     attachOutput(session) {
         const output = session.handle.output;
@@ -2556,7 +2585,9 @@ const plugin = definePlugin({
     // 声明 inject：tools 服务只有声明式 inject 才能解析（动态 ctx.inject/ctx.get
     // 均拿不到，实测 mcp-client 同款模式），声明后 ctx.get('tools') 才能取到。
     inject: ['tools'],
-    apply(ctx, config) {
+    apply(ctx, rawConfig) {
+        // volatile 字段解析后是 `{ get() }` 引用，先还原成纯数据（见 @hyzyn/dsh-kit 的 plainConfig）。
+        const config = plainConfig((rawConfig ?? {}));
         if (config?.enabled === false)
             return;
         const live = new LiveConfig({
@@ -2648,7 +2679,7 @@ const plugin = definePlugin({
              */
             platform: process.platform,
         });
-        /** 规范化并应用一份配置补丁（settings/updated 事件与 HTTP POST 共用；幂等）。 */
+        /** 规范化并应用一份配置补丁（volatile 更新事件与 HTTP POST 共用；幂等）。 */
         const applyPatch = (section) => {
             live.apply({
                 shell: typeof section.shell === 'string' ? section.shell : undefined,
@@ -2868,8 +2899,8 @@ const plugin = definePlugin({
                         const scope = settingsScope;
                         if (scope !== undefined) {
                             try {
-                                // 官方持久化通道：写入 settings 命名空间（dsh-settings-file），
-                                // 成功后触发 settings/updated → applyPatch 热应用
+                                // 官方持久化通道：settings.update(entryId) 写进本插件 entry 的 profile
+                                // patch（volatile 字段），成功后 loader 发 volatile 更新 → applyPatch 热应用
                                 await scope.update(patch);
                             }
                             catch (error) {
@@ -3334,11 +3365,16 @@ const plugin = definePlugin({
                 };
             }, 'dsh-tty: web routes');
         });
-        // settings 命名空间：注册 + 启动合并持久化值 + settings/updated 热应用
+        // settings：DSH ≥0.1.7 起存储就是本插件 entry 的 Config（导出为 `Config`，可写字段
+        // 标了 volatile）。启动合并一次持久化值，之后由 loader 的 volatile 更新事件热应用。
         ctx.inject(['settings'], (settingsCtx) => {
             settingsCtx.effect(() => {
-                const settings = settingsCtx.settings;
-                const scope = settings.register('tty', TTY_SETTINGS_SCHEMA);
+                const scope = settingsEntryScope(settingsCtx, 'tty');
+                // 服务形态不符（老宿主 / 最小宿主）时不装 scope：卡片仍可看快照，只是不持久化。
+                if (scope === undefined)
+                    return () => { };
+                // 卡片是自定义页（plugins.row.config），别再让 DSH 为本 entry 自动生成一份。
+                const offAutoPage = suppressAutoSettingsPage(settingsCtx, ctx);
                 settingsScope = scope;
                 // 启动合并：字符串字段非空才覆盖；maxSessions/布尔用「非默认值才覆盖」启发式
                 //（schema 默认值会混入 resolved，无法区分「显式保存的 4」与「从未保存」）。
@@ -3383,14 +3419,10 @@ const plugin = definePlugin({
                     startup.tunnels = storedTunnels;
                 if (Object.keys(startup).length > 0)
                     applyPatch(startup);
-                const events = settingsCtx;
-                const off = events.events.on('settings/updated', (ns, next) => {
-                    if (ns !== 'tty' || typeof next !== 'object' || next === null)
-                        return;
-                    applyPatch(next);
-                });
+                const off = scope.onChanged(() => applyPatch(scope.get()));
                 return () => {
                     off();
+                    offAutoPage();
                     settingsScope = undefined;
                 };
             }, 'dsh-tty: settings');
@@ -3851,6 +3883,7 @@ const plugin = definePlugin({
                                                 bookName: { type: 'string', required: true },
                                                 state: { type: 'string', required: true },
                                                 error: { type: 'string' },
+                                                fatal: { type: 'boolean', required: true },
                                                 connections: { type: 'number', required: true },
                                                 totalConnections: { type: 'number', required: true },
                                             },
@@ -3864,7 +3897,10 @@ const plugin = definePlugin({
                                 if (tunnels.length === 0)
                                     return [{ type: 'text', text: '当前没有配置端口转发隧道（插件配置 → 终端面板 卡片可添加）' }];
                                 const text = '端口转发隧道：' + tunnels.map((t) => {
-                                    const tail = t.error !== null && t.error !== undefined ? `（错误: ${t.error}）` : t.lastForwardError !== null && t.lastForwardError !== undefined ? `（最近转发失败: ${t.lastForwardError}）` : `（连接 ${String(t.connections)}）`;
+                                    // fatal 单独措辞（D58）：这类故障不会自愈，不说清就会一直等「正在连」
+                                    const tail = t.error !== null && t.error !== undefined
+                                        ? (t.fatal === true ? `（错误: ${t.error} —— 不会自动重试，需修配置）` : `（错误: ${t.error}）`)
+                                        : t.lastForwardError !== null && t.lastForwardError !== undefined ? `（最近转发失败: ${t.lastForwardError}）` : `（连接 ${String(t.connections)}）`;
                                     return `\n- ${t.name} [${t.direction}] ${t.rule} — ${t.state}${tail}`;
                                 }).join('');
                                 return [{ type: 'text', text }];
@@ -3885,6 +3921,7 @@ const plugin = definePlugin({
                                     rule: t.rule,
                                     state: t.state,
                                     ...(t.error === null || t.error === undefined ? {} : { error: t.error }),
+                                    fatal: t.fatal,
                                     connections: t.connections,
                                     totalConnections: t.totalConnections,
                                 })),