docs: scope private ONLYOFFICE integration

This commit is contained in:
lofyer
2026-10-01 13:59:07 +08:00
parent c9d5e63276
commit 9fa8f3e762
6 changed files with 189 additions and 28 deletions
+25 -3
View File
@@ -5,8 +5,8 @@
| 项目 | 内容 |
| --- | --- |
| 状态 | 设计中 |
| 版本 | 0.5 |
| 日期 | 2026-09-28 |
| 版本 | 0.6 |
| 日期 | 2026-10-01 |
| 关联 PRD | [ShareServer PRD](./prd.md) |
| 共享规则 | [共享网络总体设计](../../../../goodbuddy/docs/architecture/share-network-architecture.md) |
@@ -14,6 +14,7 @@
当前本地联调仅实现设备与发布元数据,使用[技术设计第 4.1 节](./technical-design.md#41-本地共享目录契约已实现)
的独立接口。下文组织身份、Grant、任务和文档归属规则属于目标设计。
Office 私有部署第一阶段的限定状态规则见第 8.2 节,不声称具备 INV-1 的组织隔离或 INV-12 的多类凭据体系。
- 注册相同设备 ID 更新名称、平台及版本,保留首次注册时间;相同内容重试不改变时间。
- 注册不自动发布内容,也不表示设备在线。设备列表目前没有心跳或离线判断。
@@ -384,6 +385,27 @@ Publication/Grant,本人草稿确认也不能绕过当前访问权限。
| Desktop 报告源文件冲突 | 保留 checkpoint 至到期,记录 `source_conflict` |
| 设备或组织权限撤销 | 拒绝新操作并关闭会话,不删除 Desktop 源文件 |
### 8.2 Office 私有部署第一阶段(待实现)
服务端主文档有稳定 ID 和单调递增的持久化 revision;编辑会话关联文档 ID、基准 revision、
编辑轮次及 ONLYOFFICE `document.key`。同一文档同一轮共同编辑复用 key,不按浏览器或每次打开
生成不同 key。活动轮次不接受另一份上传覆盖主文档;另传文件创建新文档。
- status `6` 表示编辑期间的 forcesave:持久化快照后更新已保存 revision,继续当前编辑轮次,
不更换 key,也不据此宣布后续人工修改已保存。
- status `2` 表示本轮编辑结束后的保存:持久化最终内容后结束该轮;等待最终保存时,新打开请求
等待或返回可重试状态,不能先开启一个会被旧回调覆盖的新轮次。下轮从最新 revision 生成新 key。
- 关闭浏览器不等于服务端保存完成;无修改结束按 status `4` 收束,status `3`/`7` 保存错误保留
最近成功版本并报告失败。status `4` 不增版,无内容变化时允许恢复原 key 的连接;需验证断网后
重连场景,不因一次断连即换 key。连接和其他通知不触发文件保存。
- 同文档保存串行处理,重复回调返回原结果;已结束轮次的迟到回调不得覆盖新轮次,迟到的
forcesave 不得覆盖最终保存。无法确定先后或版本冲突时保留原版本并报告待确认,不按到达时间盲目覆盖。
- 已持久化才显示“已保存到服务器”;写盘失败不确认成功,确认丢失后查询或重试同一次保存。
主文档不因会话结束而删除,首期不提供归属转移或组织权限承诺。
协议、幂等依据与文件提交方式由[技术设计第 10.1 节](./technical-design.md#101-私有部署第一阶段待实现)
定义。首期保存结果不涉及 Desktop/SSH 源文件回写。
## 9. 需求追踪
| 需求 | 主要逻辑 |
@@ -401,7 +423,7 @@ Publication/Grant,本人草稿确认也不能绕过当前访问权限。
| `FR-11` | 组织角色边界及各对象状态;展示行为由 UI 设计定义 |
| `FR-12` | 短期权威恢复规则和逻辑完整性;部署结构由技术设计定义 |
| `FR-13` | 注册、Publication、目录与授权不变量,provider 冻结及 `INV-10` |
| `FR-14` | `INV-11`、`INV-12`、DocumentEditSession、Office 保存与保留规则 |
| `FR-14` | `INV-11`、`INV-12`、DocumentEditSession、Office 保存与保留规则;私有部署第一阶段见 8.2 |
| `FR-15` | 2.8 工作空间共享状态、组织与空间成员边界 |
| `FR-16` | 2.8 资料同步与消息连接分离;2.9 交付确认、实时更新与补收 |
| `FR-17` | 2.9 普通消息与处理请求分离;5.1 处理优先级与接手竞争 |