overspread/dsh-session-backup

dsh-session-backup

DeepSeek Harness plugin: back up every session before deletion, batch-select sessions in the Web GUI, restore a backup in one click

Uncategorizeddeepseek-harnessdsh

dsh-session-backup

中文 | English

在 DeepSeek Harness Web 界面删除会话之前自动备份它,为会话列表加上多选批量删除/批量备份,并支持一键恢复备份 —— 全部以用户插件的形式实现,不改动任何已安装的 harness 文件。从 0.2.0 起,彻底删除本身也由本插件提供(行菜单的删除入口、确认对话框、级联引擎全在插件内),因此升级 harness 不会丢失删除能力:上游 ≥ 0.2.1-alpha.5 没有内核删除,本地 alpha.3 的内核删除行会被本插件遮蔽,两版都只渲染本插件这一行。

你能得到什么

功能在哪里看到
删除时自动备份哪里都看不到 —— 确认 彻底删除… 时它会先静默写入一份备份
多选 + 批量备份/删除侧边栏底部的 多选、每一行的复选框,以及每个会话「…」菜单里的 选择/加入选择
备份管理器 + 一键恢复侧边栏底部的 备份。恢复成功后该备份会被删除(恢复 = 取回);原工作区已不存在的会话会出现在侧栏「未分组」下

批量删除复用同一套自动备份逻辑,所以一批会话里绝不会有哪个没被先复制就删掉。如果备份失败,删除会被拒绝并显示错误 —— 会话的唯一副本绝不会因为备份写不出来而消失。

空白占位行(临时的「新建会话」行)和已归档的行没有复选框:harness 不为它们渲染状态槽位也不渲染自己的操作,因此无法被选中。它们没有需要保留的对话,下一次「新建会话」会领养那个空白行。

备份存放位置

$DSH_HOME/backups/sessions/<sessionId>/<timestamp>-<title>/
├── session.v4.jsonl.zstd        # 会话自身的目录,原样复制
├── …
└── backup.json                  # 清单:sessionId、title、createdAt、sourcePath、size

目录名是本地时间戳(20261017-184533)加上会话的当前标题,并针对文件系统做了净化(/ \ : * ? " < > | 和控制字符替换为空格,最长 48 个字符,若无可用内容则为 untitled)。同一秒内的两次备份会得到 -1、-2 … 后缀。session.lock 和 .DS_Store 永远不会进入备份;清单文件 backup.json 在恢复时也不会被复制回去。

附件是按内容寻址的,在会话删除后依然存在,所以仅凭会话目录就是一份完整、可恢复的副本。

删除引擎的工作原理(0.2.0 起)

删除不再经过任何内核方法 —— 旧版包装 ctx.remote.session.deleteSession 的 internal/get 拦截器已移除(上游 rc.2 根本没有该方法,包装它会在备份完成后抛 TypeError)。现在的链路全部在本插件内:

  1. 菜单行:注册到官方插槽 sidebar.workspaces.session.menu.item,同时用双注册保证任何内核只出现一行删除 —— id: 'delete' 以 priority: -1 注册一个渲染 null 的遮蔽行(把本地 alpha.3 自带的内核删除行挡掉,与注册先后无关);id: 'session-delete'、order: 460 注册本插件真正的删除行(紧挨「归档会话」之后)。上游 rc.2 没有内核删除行,遮蔽行是惰性的,菜单顺序与 alpha.3 完全一致。
  2. 确认对话框:注入 shell.overlay,空闲态直接打开 danger 确认(文案逐字对齐内核:永久删除日志与缓存、工作区文件不受影响)。
  3. 活动闸门(409 升级):宿主问 workspace/session-activity 瀑布(与内核归档同一组 provider)。有活动时返回 409 workspace/session-active 并携带活动清单 —— 客户端把同一个对话框原地升级为「停止并彻底删除此会话?」+ 活动列表 + 「停止并删除」按钮,与内核的 busy 升级行为逐字节一致。
  4. 停止路径:stopActivity: true 时先发 workspace/session-stop(同时停 agent/jobs/subagent 回合并清掉该会话的全部 schedule 定时行),再 quiesce 裸 agent、detach 已进入的 store 条目(触发 session/disposed 关写句柄 —— rc.2 按 id 拿不到 dispose() capability,这条 detach 路是两版共通的),然后轮询等闸门转空,最后才探写租约。schedule 行删除失败 = 整个删除中止(gateway/internal),因为残留的定时投递会把日志冷恢复复活。
  5. 级联:探到写租约独占 → 删日志目录(alpha.3 走内核 remove(),rc.2 无 remove 则定位目录 + fs.rm + 复检)→ best-effort 清 spill / 投影缓存 / 工作区记账(两版签名不同,各自特征检测)→ ctx.emit('api-session/removed') 让侧栏行消失。附件是共享内容寻址 blob,永不删(spec A5 裁定);工作区目录与用户文件不动。
  6. 备份先行:单个与批量删除都先走 /api/session.backup.create;备份真失败则删除被拒绝并显示错误 —— 会话的唯一副本绝不会因为备份写不出来而消失;只有「无目录可备份」和「profile 没挂 Host 面」才放行。

同 id 会话的并发删除共享第一次的结果(幂等),重复删除返回成功而不再次级联。

备份失败时的语义:

失败情形结果
备份路由返回真实错误(磁盘满、冲突……)删除被拒绝,错误对话框显示原因
会话已无目录可供备份删除照常进行(无东西可复制),控制台提示
活动闸门拒绝(会话正在运行)409 升级到「停止并彻底删除」对话框,等用户二次确认
schedule 定时行清理失败删除中止(gateway/internal),防止日志被定时投递复活

HTTP 路由

五条路由都注册在 Host 连接的 /api 之下,由浏览器按文档相对路径访问(.slice(1)),并返回 JSON:

方法路径请求体响应
GET/api/session.backup.list—{ backups: [...] },最新的在前
POST/api/session.backup.create{ sessionId }{ backup },含 path、title、dirName、bytes、consistent
POST/api/session.backup.delete{ sessionId, stopActivity? }{ deleted };活动闸门拒绝时 409 + details.activity,未知 id 404,schedule 清理失败 500 gateway/internal
POST/api/session.backup.restore{ path }{ restored },含 attached、placement、workspaceId / reason、backupConsumed;若会话已再次存在则返回 409(备份原样保留)
POST/api/session.backup.remove{ path }{ removed };会顺带清理空的会话分组

sessionId 必须匹配普通的 id 模式,且每一条客户端提供的路径都会被校验必须严格位于其根目录之内,因此任何请求都无法触及备份库之外。标题来自 sessionQuery 服务(readTitle),读不到时回退为 untitled。在复制一个正在运行的会话之前,host 会通过 sessions 服务把内存中的日志落盘 —— 与 dsh-session-log-export 使用的是同一道屏障 —— 并在复制后重新校验每个文件的大小,因此仍在追加的日志会被重新复制,而始终无法稳定的副本会在清单中被标记(consistent: false),而不是悄悄交付一个损坏的文件。

readTitle 的返回既可能是裸字符串,也可能是标题提供方的快照记录({ title, source, eventSeq, … }),具体取决于该 profile 拥有哪种查询服务;两种形式都会被解包,所以备份会以侧边栏显示的标题命名,而不是一个笼统的 untitled。

恢复还会把会话放回侧边栏

把目录复制回去只是恢复的一半。删除会话会做两件事 —— 移除目录以及从其 Workspace 记录中丢掉该 id —— 而侧边栏列出的是 Workspace 成员关系,不是原始的目录树。

所以 restore 最后会通过 harness 自己的 API 重新附加该 id:workspace.attachSession(sessionId)。该调用会从持久化层重新读取恢复后会话的头部,并且除非其 cwd 解析到该 Workspace 的路径,否则拒绝附加,因此恢复不会把会话挂到错误的项目上。

恢复成功后会删除该备份(恢复 = 取回,响应里 backupConsumed: true)。只有恢复被拒绝时(会话已存在 → 409)备份才原样保留。删除是 best-effort:清理失败不会让一次已经成功的恢复失败,此时 backupConsumed: false 如实上报。

没有匹配工作区的会话也不会消失:rc.2 的侧栏有原生的「未分组」分组,不属于任何工作区的会话显示在那里(删除一个工作区时也是同样行为 —— 它的会话进入「未分组」)。placement 说明这次恢复的落位:

restored.placement含义
workspace已重新附加;workspaceId 指明是哪个 Workspace,会话回到原分组(若列表已展开则刷新页面)
ungrouped文件已恢复,会话显示在侧栏「未分组」下 —— 没有 Workspace 匹配日志的 cwd(例如原工作区已被删除),或该 profile 没有 workspaceRegistry
unknown罕见:恢复后的日志头部不可读,或 attachSession 拒绝 —— 文件已恢复,reason 说明原因

附加失败绝不会让整个请求失败:数据字节已经恢复。

两个面:index.js 与 client.js

Harness 会用两套不同的模块系统加载本包两次:

面文件消费方
host(Node)index.jsdsh,通过 exports["."] 导入
浏览器client.jsweb host,通过 exports["./client"]

Web host 会把每个 dsh.client.platform: "web" 包的客户端文件拼接成一批经典脚本,从 /plugins/... 提供服务,因此 client.js 必须用 window.__ModuleLoader__.load({ id, factory }) 注册自身。若直接交给它原生 ESM,整批脚本都会以 SyntaxError: Unexpected token 'export' 失败,启动画面会报告 import failed (see console for the import error)。

client.js 由 src/client.mjs 生成 —— 永远不要直接编辑它:

node scripts/build-client.mjs   # 编辑 src/client.mjs 后重新生成 client.js

构建脚本会把每条 ESM import 改写为同一标识符的 require()(react 和 @deepseek-ai/dsh-client-ui-primitives 是种子词),去掉 export 同时记录导出的名称,遇到 Node 内建模块、export default 或任何它无法承载的形式都会立即报错。

安装

从 npm:

dsh plugin --profile <你的 profile> add dsh-session-backup

从 GitHub(固定 tag 或 commit 可获得可复现的安装):

dsh plugin --profile <你的 profile> add github:overspread/dsh-session-backup

从本地检出:

dsh plugin --profile <你的 profile> add /path/to/session-backup
dsh --profile <你的 profile> --dump-config   # 应能看到 "# == dsh-session-backup" 这一层

然后重启 dsh web 服务 —— host 会在内存中缓存每个包解析出的客户端包路径,因此新增、移除或重新指向 exports["./client"] 只有在全新启动时才会生效。

可经受 harness 升级

插件位于你的 profile(~/.dsh/profiles/<name>)中,而不是已安装的 harness 内部,所以升级 dsh 不会移除它。卸载用 dsh plugin --profile <name> remove dsh-session-backup。

发布

发布新版本:

node scripts/build-client.mjs
npm version patch
npm publish                # 需要 npm 登录;tarball 会带上构建出的 client.js
git push --follow-tags

本包没有运行时依赖;打包前请先运行构建,以便 tarball 中的 client.js 与当前的 src/client.mjs 一致。package.json 中的 files 列表会把 node_modules 和 src/ 排除在 tarball 之外。

许可证

MIT © overspread。

这是一个个人的社区插件。它不由 DeepSeek 开发、背书或支持,也不是 DeepSeek Harness 发行版的一部分。它只在你自己的 $DSH_HOME 内读写;像任何会在你机器上运行的第三方插件一样,安装前请审阅源码。