test: isolate and record remote response release acceptance
This commit is contained in:
@@ -1,41 +1,40 @@
|
||||
# 公共响应模板验收
|
||||
# v0.8.0-preview 公共响应模板验收
|
||||
|
||||
版本 `v0.8.0-preview`。本报告记录实现验收与发布验证，旧版本标签保持不变。
|
||||
已发布 `v0.8.0-preview`，固定标签提交为 `7670b222acbad18d1fd19d54bbbac38d9cf5030b`。发布后只在 main 更新验收工具与记录，没有移动标签。
|
||||
|
||||
## 实现范围
|
||||
## 完成范围
|
||||
|
||||
- `.api` 定义具名公共响应体，可跨文件导入、分组引用、接口覆盖；业务类型放入 `${data}`。支持嵌套 JSON、独立 errorBody、固定字段与类型保持的占位符。
|
||||
- 数字/字符串错误码、默认码、按逻辑码映射、消息映射、null/省略行为可配置；OpenAPI 同步结构、类型和真实错误示例。
|
||||
- `@response raw` 成功返回原始业务 JSON，错误继承组级模板。文本、XML及特殊状态的回调通过 Go 编码器实现，不冒充 `.api` 已支持任意媒体类型。
|
||||
- 应用之间的配置独立；创建/快照深复制；空对象模板序列化后保持有效，非法占位符、配置冲突、循环和过深结构拒绝。
|
||||
- 接口策略在全局中间件前设置；提前拒绝、panic、Context 克隆和错误边界使用正确策略。显式 JSON/Text/XML/Bytes/NoContent 绕过包装，已提交响应不追加内容。
|
||||
- 内置路由 404/405 使用应用默认格式。网络层进入应用前的 TLS/HTTP协议错误仍由 transport 处理。
|
||||
- `.api` 具名公共体支持导入、分组引用、单接口覆盖、嵌套 JSON、独立 errorBody、常量与类型保持的占位符。业务返回类型放入 `${data}`。
|
||||
- `int32` / `int64` / `string` 业务码、默认成功/失败码与提示、按逻辑码映射和 null/省略行为可配置；OpenAPI 同步结构、整数位宽和错误示例，旧 integer 写法保持兼容。
|
||||
- `@response raw` 成功返回原始业务 JSON，错误继承组级模板。文本/XML及特殊状态回调使用 Go 编码器，由应用维护对应文档。
|
||||
- 配置在创建与快照时复制，应用间独立；空模板往返序列化有效，非法占位符、冲突、越界和过深模板拒绝。
|
||||
- 接口策略在全局中间件前生效，提前拒绝、panic、Context 克隆与错误边界使用正确格式；已提交响应不追加内容。
|
||||
- 内置 App 的 404/405 使用应用策略；TLS/HTTP解析与连接级过载发生在进入应用之前，仍由 transport 处理。
|
||||
|
||||
## 验证结果
|
||||
## 发布前验证
|
||||
|
||||
1. `GO_OMNI_SCAFFOLD_INTEGRATION=1 go test -race -p=1 -count=1 -timeout=300s ./...`：40 个有测试的包全部通过。
|
||||
2. 首轮 `-p=2` 的原有 S3 fixture 测试遇到 10 秒 deadline；单包复跑通过，随后上述串行全量复跑通过，未修改 S3 实现或放宽断言。
|
||||
3. 专项集成生成临时消费者项目，执行真实生成路由和业务 Service：具名公共体、数字 401、路由覆盖、raw JSON、错误文档，以及重复生成业务文件保护通过。
|
||||
4. App 在 nethttp/native 的真实 TCP 请求中验证配置响应、callback panic 和超时；并发应用配置隔离、克隆、全局中间件提前拒绝及已提交响应保护通过。
|
||||
5. 原有 API 实际 HTTP 回归 54 项通过：starter 两种 transport 各 6 项，contract 两种 transport 各 21 项；见 [回归报告](responsePoliciesAPI.json)。
|
||||
6. `go vet ./...`、`go build ./...`、示例 `.api` validate/inspect、差异空白检查通过。既有用户示例重新生成及 `--check` 通过，28 份原有业务文件保持不变；go.mod 显式升级目标版本并继续使用本地 replace。
|
||||
- 最终代码 `GO_OMNI_SCAFFOLD_INTEGRATION=1 go test -race -p=1 -count=1 -timeout=300s ./...`：40 个有测试的包全部通过，见 [封版测试](responseReleaseTests.txt)。
|
||||
- `go vet ./...`、`go build ./...`、格式/差异检查和 userService `api generate --check` 通过。
|
||||
- 临时生成项目执行真实路由和业务 Service，验证数字 401、raw JSON、路由覆盖、完整 int64 输出、OpenAPI 和重复生成保护；nethttp/native 真实 TCP 检查配置响应、callback panic 和超时。
|
||||
- 本机隔离 MySQL 下，nethttp/native 共 34 项 HTTP/业务/生命周期检查通过；包含事务提交、错误/panic/取消回滚、初始化清理、迁移、日志与优雅退出，见 [本地业务报告](responsePoliciesWorkflowLocal.json)。
|
||||
- 开发阶段额外完成 54 项 API 实际 HTTP 回归与类型专项检查，见 [API 回归](responsePoliciesAPI.json)、[类型专项](responseCodeTypesTests.txt)。这些历史报告分别记录当时的源码哈希。
|
||||
- 开发阶段原有 S3 fixture 曾出现一次 10 秒 deadline，单包及后续全量复跑通过；本次封版全量也通过，未修改 S3 逻辑或放宽断言。
|
||||
|
||||
完整框架记录见 [race 测试](responsePoliciesTests.txt)。本轮仅使用本机临时目录和回环监听，没有连接业务服务器，没有执行远程云存储/数据库验收或压力长测。远程模块下载验收需发布后另行完成。
|
||||
## 远程发布验证
|
||||
|
||||
## 使用入口
|
||||
两个验收分别使用全新的 module cache 安装 `v0.8.0-preview`，实际消费者都无本地 replace，模块校验和一致：
|
||||
|
||||
[公共响应说明](../RESPONSE.md) 与 [可生成的 .api 示例](../examples/contracts/responses.api)。远程使用请安装同版本 CLI 和框架；源码开发可带 `--framework-dir`。
|
||||
`h1:lB4rU4FPsoFr3IedKx/K9xvvsGBO5SO/qdjnjKJ2mvQ=`
|
||||
|
||||
## 后续：类型名与业务字段统一
|
||||
1. [公共响应远程报告](responsePoliciesRemote.json)：实际下载 CLI，解析 int32 示例，生成并运行公共模板消费者；完整 int64 最大值、数字鉴权错误、raw JSON、路由覆盖、业务文件保护、race 检查和固定版本依赖校验全部通过。
|
||||
2. [完整业务远程报告](responsePoliciesWorkflowRemote.json)：远程 CLI 新建 MySQL + local 项目并编译；用户示例在 nethttp/native 共 34 项 HTTP/业务/生命周期检查通过，事务/初始化清理测试同时通过，重生成保留 29 份开发者文件。
|
||||
|
||||
`codeType` 新增 `int32` / `int64`，保留 `string` 与旧 `integer`；int32/int64 使用各自有符号整数范围，默认码和映射都校验。OpenAPI 为 integer + 对应 format。配置 JSON/YAML、生成项目的 int64 数值保留完整精度。
|
||||
首次公共响应远程验收从框架源码目录启动 CLI，触发原有本地开发检测并加入 replace；验收正确拒绝了这种结果。main 的测试工具已改为从独立临时目录启动，随后上述纯远程校验通过。此修复只涉及验收测试的工作目录，不改变已发布 CLI 或框架；复现远程验收请使用 main 的验收脚本和测试。
|
||||
|
||||
本次增量运行根包、response、config、httpx、openapi、CLI/apigen/scaffold 共 8 个包的 race 测试及生成消费者集成，全部通过。覆盖边界/越界、小数拒绝、int64 最大值真实输出、配置精度、平铺/嵌套文档和旧 integer 兼容。vet、全模块 build、示例 validate 与差异检查通过；见 [类型测试记录](responseCodeTypesTests.txt)。上方全量及 HTTP 报告是此前公共响应体验收，此次未重复远程或数据库验收。
|
||||
报告中保留各自实际测试源码哈希，已逐项核对；通过 module version、checksum 和无 Replace 三项确认消费者使用的是固定发布模块。
|
||||
|
||||
## v0.8.0-preview 封版前验证
|
||||
## 资源与使用
|
||||
|
||||
- 最终代码全量 race 通过：40 个有测试的包；包括源码 CLI 的生成消费者、完整 int64 输出和模板配置回归，见 [封版测试记录](responseReleaseTests.txt)。
|
||||
- `go vet ./...`、`go build ./...`、格式检查、差异检查和 userService `api generate --check` 通过。
|
||||
- 本机隔离 MySQL 下，nethttp/native 共 34 项 HTTP、业务和生命周期检查通过；数据库事务提交/错误回滚/panic回滚/取消回滚、初始化清理和迁移通过。
|
||||
- 重生成保留 29 份开发者文件，见 [封版本地业务报告](responsePoliciesWorkflowLocal.json)。临时容器已清理。
|
||||
- 发布后将使用 `verifyResponseRelease.py` 和 `verifyAPIWorkflow.py --version v0.8.0-preview` 验证真实远程 CLI、无本地 replace 的模块、公共模板及完整业务流程。标签不随验收记录变动。
|
||||
只使用本机回环监听、临时目录和受限 MySQL 容器（1 CPU / 768 MiB），结束均清理，没有连接业务服务器。未执行 OSS/R2 云账号实网验收或网络压力长测。
|
||||
|
||||
[发布说明](../RELEASE.md)、[公共响应说明](../RESPONSE.md) 与 [完整 .api 示例](../examples/contracts/responses.api)。CLI 与框架依赖一起固定到 `v0.8.0-preview`；源码开发可使用 `--framework-dir`。
|
||||
|
||||
Reference in New Issue
Block a user