test: add current protocol compatibility gate
This commit is contained in:
@@ -31,7 +31,7 @@
|
||||
| P4 Weave 主流程 | SDK 定义构建与发布校验、实例、顺序/分支/结构化并行汇合、信号/定时等待、版本绑定 | 重启接续、早到/重复信号、并行竞争、内部事件重放、发布版本兼容；端到端通用流程 | 已完成平台功能阶段验收：[原功能及W01–W17逐项核对](reports/phase-4-5.md)、[版本/暂停/全停回归](reports/phase-4-5-races.md)、[提交故障边界](reports/phase-6-fault-boundaries.md)。研发发布、固定版本、顺序/分支/有限并行、信号/时间等待、公共API/SDK及可运行示例均已交付；生产拓扑与发布兼容继续P6/P7 |
|
||||
| P5 Weave 恢复与查询 | 有界查询、暂停继续、取消、人工核查恢复、控制门控与审计 | 轮次与尝试独立预算；暂停/开始/回执/超时竞争；恢复保留预算；未知结果不盲目重复 | 已完成平台功能阶段验收：[原功能核对](reports/phase-4-5.md)。有界查询、独立预算、暂停继续/取消、六类恢复、历史/筛选/事件/来源与SDK场景均已交付；真实竞争、COMMIT断线及进程全停保留原身份、截止和预算。运维、容量与首版发布继续P6/P7 |
|
||||
| P6 生产验证与运维 | 完整监控、凭据轮换、备份恢复、滚动升级、运行手册、可复现负载和故障工具 | 对照生产验收清单执行，报告环境/指标/遗留项；容量、RPO/RTO 按真实拓扑验证 | 进行中；已补[精确故障边界](reports/phase-6-fault-boundaries.md)和[进程观测](reports/phase-6-observability.md)；继续业务积压/阶段延迟、凭据轮换及其余生产门槛 |
|
||||
| P7 首版交付核对 | SDK 兼容与发布准备、完整 API 手册、场景示例、全量回归及交付清单 | 新接入者按文档跑通全部示例；所有首版能力可追溯到实现与测试；报告实际生产边界 | 进行中；已补[通用文件转换示例](reports/phase-7-file-conversion.md)和[SDK独立发布门禁](reports/phase-7-sdk-release.md)，仍需协议兼容矩阵、全量资源充足回归和交付清单 |
|
||||
| P7 首版交付核对 | SDK 兼容与发布准备、完整 API 手册、场景示例、全量回归及交付清单 | 新接入者按文档跑通全部示例；所有首版能力可追溯到实现与测试；报告实际生产边界 | 进行中；已补[通用文件转换示例](reports/phase-7-file-conversion.md)、[SDK独立发布门禁](reports/phase-7-sdk-release.md)和[当前协议兼容矩阵](reports/phase-7-compatibility.md)，仍需带标签的跨版本矩阵、全量资源充足回归和交付清单 |
|
||||
|
||||
SDK、文档与示例随 P1–P5 同步开发，P7 是全量核对，不是最后才开始补文档。
|
||||
|
||||
|
||||
20
docs/reports/phase-7-compatibility.md
Normal file
20
docs/reports/phase-7-compatibility.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# P7 协议兼容矩阵与门禁
|
||||
|
||||
验证日期：2026-09-20。本批把当前服务端、独立 Go SDK 和机器可读 WebSocket schema 的版本边界固定为可执行检查，并明确历史版本组合尚未具备证据。
|
||||
|
||||
## 检查内容
|
||||
|
||||
[`scripts/test-protocol-compatibility.sh`](../../scripts/test-protocol-compatibility.sh) 检查：
|
||||
|
||||
- 服务端和 SDK 的 Worker 子协议均为 `pulse.worker.v1`，连接路径均为 `/v1/worker/connect`；
|
||||
- 服务端和 SDK 的结果事件子协议均为 `orbit.events.v1`，连接路径均为 `/v1/events/connect`；
|
||||
- Worker/事件帧构造和 JSON schema 的 `protocol_version` 均为 `1`，schema `$id` 分别固定为 worker.v1 与 events.v1；
|
||||
- HTTP 接口主版本为 `/v1`，流程定义 schema 版本为 `1`，当前数据库迁移版本为 v28。
|
||||
|
||||
## 实际结果
|
||||
|
||||
```json
|
||||
{"http_api":"/v1","worker_subprotocol":"pulse.worker.v1","event_subprotocol":"orbit.events.v1","worker_frame_version":"1","event_frame_version":"1","workflow_schema_version":1,"status":"current_contracts_match","historical_pairs":"not_verified"}
|
||||
```
|
||||
|
||||
当前同一 checkout 的 SDK 单元/竞态测试、服务端协议测试和真实 MySQL/HTTP/WSS 集成测试覆盖当前组合。仓库尚未有正式 SDK 或服务端标签，因此“旧 SDK + 新服务端”和“新 SDK + 旧服务端”不能标记为通过；发布候选需建立至少一个带标签的旧版本 fixture 后再补两组矩阵回归。
|
||||
@@ -20,7 +20,7 @@
|
||||
{"sdk_module":"git.yuntuo.hk/k2safe/orbit/sdk/go","independent":true,"package_count":27,"forbidden_dependencies":0}
|
||||
``@@BT@
|
||||
|
||||
该轮覆盖 SDK 核心、Worker/事件客户端、流程/任务 API、负载工具和全部可运行示例；新增文件转换示例的单元测试也通过。文档本地链接、shell 语法和 `git diff --check` 同步通过。
|
||||
该轮覆盖 SDK 核心、Worker/事件客户端、流程/任务 API、负载工具和全部可运行示例；新增文件转换示例的单元测试也通过。协议常量、路由和 schema 的当前版本同步检查由 [`make protocol-check`](../sdk/compatibility.md) 通过。文档本地链接、shell 语法和 `git diff --check` 同步通过。
|
||||
|
||||
## 发布边界
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
module：`git.yuntuo.hk/k2safe/orbit/sdk/go`。SDK 使用独立 go.mod，依赖 Go 标准库与 `github.com/coder/websocket v1.8.15`，不引用服务端模型或数据库实现。
|
||||
|
||||
发布候选先执行 [SDK 独立发布门禁](release.md)，确认 `GOWORK=off` 下依赖图、竞态测试、vet 和全包构建均通过；门禁不替代协议兼容矩阵或业务副作用回归。
|
||||
发布候选先执行 [SDK 独立发布门禁](release.md) 和[协议兼容矩阵](compatibility.md)，确认 `GOWORK=off` 下依赖图、竞态测试、vet 和全包构建均通过；门禁不替代业务副作用回归。
|
||||
|
||||
任务相对延迟使用SubmitTaskRequest.DelayMS，由数据库首次受理时间计算，原键重报不重新计时；[完整延迟示例](../examples/delayed-task.md)包含Worker执行和历史核对。非零DelayMS不能与AvailableAt同用，旧服务须先升级。
|
||||
|
||||
|
||||
27
docs/sdk/compatibility.md
Normal file
27
docs/sdk/compatibility.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# SDK 与协议兼容矩阵
|
||||
|
||||
当前发布线是 HTTP `/v1`、Worker WebSocket `pulse.worker.v1`、结果事件 WebSocket `orbit.events.v1`、Worker/事件帧 `protocol_version=1`、流程定义 `schema_version=1`，数据库要求 MySQL 8.4+ 与 Orbit schema v28。协议门禁由 `make protocol-check` 执行，检查服务端常量、SDK 常量、路由和机器可读 schema 是否一致。
|
||||
|
||||
| SDK / 客户端 | 服务端 | 当前证据 | 结论 |
|
||||
| --- | --- | --- | --- |
|
||||
| 当前仓库 SDK | 当前仓库服务端 | `scripts/test-protocol-compatibility.sh`、SDK 单元/竞态测试、HTTP/WSS 集成测试 | 已验证 |
|
||||
| 上一个正式 SDK 标签 | 当前服务端 | 仓库尚未发布正式 SDK 标签 | 未验证，不得宣称兼容 |
|
||||
| 当前 SDK | 上一个正式服务端标签 | 仓库尚未发布正式服务端标签 | 未验证，不得宣称兼容 |
|
||||
| 非 Go HTTP 客户端 | 当前服务端 | `/v1` 接口手册、严格输入和错误码回归 | 按接口手册逐项验证 |
|
||||
|
||||
## 兼容规则
|
||||
|
||||
同一协议线内只允许保持字段语义、状态值和错误码含义不变的兼容扩展。新增响应字段通常由 HTTP JSON 客户端忽略；新增请求必填字段、修改既有字段类型/单位、修改状态终结语义或改变 WebSocket 帧方向，都不属于兼容扩展。Worker 和事件 SDK 的帧解码会拒绝未知字段或错误版本，避免把协议漂移当作业务结果。
|
||||
|
||||
发生不兼容变化时必须新建 HTTP 路径版本、WebSocket 子协议或 schema `$id`，并保留旧线的服务端/SDK 实现与回归，直到发布说明明确移除日期。不能仅增加一个文档版本字符串来掩盖行为变化。流程业务版本（例如定义的 `version`）与传输协议版本分开，业务版本固定在实例上，不改变旧实例的执行语义。
|
||||
|
||||
## 发布前组合
|
||||
|
||||
候选版本至少执行：
|
||||
|
||||
```sh
|
||||
make protocol-check
|
||||
make sdk-check
|
||||
```
|
||||
|
||||
然后在干净 checkout 中用候选 SDK module 标签运行健康、任务、Worker、事件订阅、流程定义/实例/恢复和文件转换示例。当前仓库已验证的是同一 checkout 的服务端与 SDK；旧/新跨版本组合、TLS 终止、外部副作用和生产容量仍需在发布候选及接入方环境单独验证。
|
||||
@@ -25,6 +25,8 @@ sh scripts/test-sdk-isolation.sh
|
||||
|
||||
`package_count` 随示例增加而变化，不能作为兼容性版本号。门禁只证明源码在当前 Go 工具链下保持独立和可构建，不代表已经发布到远端模块代理，也不替代旧 SDK/新服务端和新 SDK/旧服务端的协议兼容矩阵。
|
||||
|
||||
协议版本、WebSocket 子协议、流程 schema 和数据库版本见[兼容矩阵](compatibility.md)。发布候选还必须执行仓库根目录的 `make protocol-check`；它检查当前服务端、SDK 和机器可读 schema 是否仍在同一协议线，不把历史版本组合标记为已验证。
|
||||
|
||||
## 接入方式
|
||||
|
||||
SDK 尚未发布正式标签时，开发项目可以使用本地 replace；发布候选必须使用独立 module 的版本标签和干净 checkout 验证。接入方应固定 SDK 版本，升级前先执行自己的接口和业务幂等回归：
|
||||
|
||||
Reference in New Issue
Block a user