2026-07-23 00:10:53 +08:00
# Agent Note: 共享持久化写入协调器
2026-07-15 23:25:06 -07:00
2026-07-22 03:07:36 -07:00
Status: implemented
2026-07-22 22:29:39 +08:00
[English ](2026-06-18-shared-persistence-write-coordinator.md ) | 中文
2026-07-15 23:25:06 -07:00
## 问题
2026-07-24 13:57:16 +08:00
`dsh-session-persistence-jsonl` 与 `dsh-session-persistence-sqlite` 有意在不同存储介质上证明同一份 `SessionPersistence` 契约,但它们重复实现了写入路径编排:每会话状态、`session/created` 接管、后端特定的前缀读取、write-behind 控制、按 id 串行执行操作、HMR(热模块替换)种子注入与 dispose(资源释放)排空。纯粹的种子前缀碰撞检查与可序列化守卫已迁入 seam 包;剩余的编排仍然对正确性要求很高,且同样的修复被应用了两次。唯一的差异在于存储原语(写字节 vs. INSERT 行)。
2026-07-15 23:25:06 -07:00
## 决策
2026-07-24 00:28:30 +08:00
将一个后端无关的 `PersistenceCoordinator` 提取到 `dsh-session-persistence` 中。协调器统一拥有编排逻辑;每个第一方后端组合一个协调器实例(`new PersistenceCoordinator(ctx, this)` ),实现一个小型 `PersistenceBackend` 钩子接口,并将其有状态的公开方法(`create` /`append` /`load` /`inspect` )委托给协调器。由后端拥有的元数据与修订版本列举会绕过协调器。
2026-07-15 23:25:06 -07:00
2026-07-24 00:28:30 +08:00
组合,而非继承。协调器是后端持有的具体类,不是后端继承的基类。本 Agent Note 的风险——「协调器不得让非常规后端与继承层级作斗争」——由此规避:后端只暴露钩子,无法触及协调器的私有编排状态。第三方后端仍然可以完全不使用协调器、直接实现抽象服务,包括供读模型使用、不修改状态的 `inspect` 契约。
2026-07-23 00:10:53 +08:00
2026-07-24 00:28:30 +08:00
协调器为每个确切的存活 `Session` 持有一个控制器;该控制器统合初始化、待处理事件与共享 flush promise。每个 `session/event` 都会立即启动排空,而 `session/flush` 只观察完全停稳,不会发起常规写入路径。[flush 控制器简化 ](../simplification/2026-07-23-collapse-persistence-flush-state.md )定义该生命周期。
协调器通过 `session/disposed` 退役会话:它等待控制器完成初始化和当前 flush,串行执行最后一次排空,且仅在成功后才移除控制器与其拥有的每 id 状态。失败时保持控制器可被找到,以供后端 teardown(拆除)重试。每个 id 的已结算链尾仅在其仍是当前链尾时才移除自身,因此旧操作完成后不会抹除同一 id 的新操作。后端 teardown 会注销写入路径监听器、flush 每个剩余的控制器、等待所有按 id 串行化的操作,最后关闭后端。
2026-07-15 23:25:06 -07:00
### 钩子接口(`PersistenceBackend<TornMarker>`)
2026-07-23 20:52:40 +08:00
五个必需成员加一个可选的生命周期钩子,构成协调器与存储之间唯一的边界:
2026-07-15 23:25:06 -07:00
2026-07-22 03:07:36 -07:00
- `name` ——后端标签,用于 dispose 失败时的 `AggregateError` 。
2026-07-25 15:11:17 +08:00
- `loadStored(id)` ——按 id 跨所有存储范围读取一个已存储前缀(JSONL 的所有项目目录;SQLite 的 id 全局唯一)。恢复/加载、不修改状态的检查、存活会话接管与创建碰撞探测共用此查找。协调器会断言返回的 id,并在修复或发布状态之前拒绝已存储记录与存活会话的 cwd 不匹配。
2026-07-22 22:29:39 +08:00
- `appendBatch(meta, events, isMaterialized)` ——持久追加一个连续批次,在尚未物化时原子地惰性物化会话(物化写入与首批事件必须一起提交——崩溃不得留下一个已物化但为空的会话;这就是为什么没有单独的 `materialize` 钩子)。
2026-07-22 03:07:36 -07:00
- `commitRepair(meta, tornMarker, closers)` ——使崩溃修复持久化:截断损坏的尾部(当且仅当 `tornMarker !== undefined` )并追加 `closers` 。**不要求原子性**——JSONL 合理地分两步 fsync(先截断再追加),SQLite 在一个事务中完成 DELETE+INSERT。用于 `load` (截断 + 合成 closers)和 live-adoption(仅截断,`closers = []` )。
- `list()` ——列出所有已存储的元数据。
2026-07-24 15:10:55 +08:00
- `close?()` ——可选的生命周期清理(SQLite 关闭 db 句柄;JSONL 省略),在 dispose effect 中于排空至完全停稳之后被 await,因此 close 失败不会掩盖排空错误。
2026-07-15 23:25:06 -07:00
2026-07-22 03:07:36 -07:00
### 不透明的 torn marker
2026-07-15 23:25:06 -07:00
2026-07-23 00:10:53 +08:00
保持 seam 整洁的唯一设计选择:崩溃修复中「损坏尾部在哪里」的 token 对协调器是不透明的。协调器计算合成 closers(它拥有来自 `dsh-session` 的 `interruptedTurnClosers` ),但它只测试 `tornMarker !== undefined` 并将值原样传回 `commitRepair` ——从不检视其内容。每个后端选择自己的 marker 类型:JSONL 携带要截断到的字节偏移,以及从不完整最终帧中解码出的任何完整事件;SQLite 则携带要从其开始删除的 seq。协调器因此既不了解字节长度,也不了解帧恢复状态。
2026-07-15 23:25:06 -07:00
## 测试
2026-07-24 00:28:30 +08:00
共享的 `runPersistenceContract` (公开 API 契约)为每个后端运行,并证明在 `load` 执行恢复之前,`inspect` 会保持被中断的日志与修订版本不变。`runCoordinatorContract` ( `tests/coordinator-contract.ts` )通过内存参考实现、JSONL 与 SQLite 覆盖接管、HMR、碰撞、会话与后端 dispose 排空,以及崩溃尾部修复。协调器专属测试覆盖立即执行的后续批次、存活控制器清理、同 id 链尾竞态、排空失败重试与关闭顺序。各后端自身的测试规格只保留存储机制。每个真实后端都有一个经由协调器的崩溃尾部修复测试,以覆盖不透明 marker 分支,因为契约中的崩溃用例会产生合成 closers,却不会产生 torn marker。
2026-07-15 23:25:06 -07:00
## 曾考虑的替代方案
2026-07-22 03:07:36 -07:00
- **后端继承的基类**——否决,改用组合:后端只暴露钩子,无法触及协调器的私有编排状态,且第三方后端仍可完全不使用协调器、直接实现抽象服务。
2026-07-23 20:52:40 +08:00
- **更宽的钩子面**——每个候选钩子都被折叠掉:没有限定存储范围的实时查找,因为 `loadStored` 加上协调器的 cwd 检查即可维持碰撞边界;没有存储定位器泛型,因为经验证的 JSONL 元数据可还原其路径,而 SQLite 已按 id 绑定;没有单独的 `materialize` 钩子,因为首批事件必须与物化原子提交;没有单独的创建碰撞探测,因为它就是 `loadStored(id) !== undefined` ; `list()` 也不经由协调器透传,因为列举不需要任何编排。
2026-07-15 23:25:06 -07:00
## 后果
2026-07-24 15:10:55 +08:00
协调器增加了一层间接、一个不透明的 torn marker 和脱离会话生命周期的退役任务,但将此前每个后端重复的、对正确性要求很高的编排逻辑集中到一处。会话 dispose 仍是仅观察事件,因此会话所有者不会等待持久化退役;协调器会收容失败、在存活控制器中保留待处理事件,并以后端 teardown 为完全停稳边界。其钩子面保持窄小:标识校验、接管、碰撞检查与不修改状态的检查共用 `loadStored` ;物化保持在 `appendBatch` 内原子完成;列举绕过协调器。读模型使用 `inspect` 而非 `load` ,因此观察已持久化但仍开放的轮次时,不会因提交中断 closers 而与新的存活所有者产生竞态。新后端只需实现存储原语,而无需复制立即写入生命周期。