docs(plan): 更新发展规划,记录本轮测试扩展

- 单元测试总数:125 个(server 从 5→17)
- 更新待办池优先级和状态
This commit is contained in:
xfy911 2026-06-04 09:04:54 +08:00
parent 4a979a105f
commit 8f9d420447

View File

@ -21,24 +21,21 @@
- [x] 最大并发连接数限制 ✅ 2026-06-03 - [x] 最大并发连接数限制 ✅ 2026-06-03
- [x] 分级日志系统error / warn / info / debug✅ 2026-06-03 - [x] 分级日志系统error / warn / info / debug✅ 2026-06-03
- [x] Gzip 压缩 ✅ 2026-06-03已接入响应流程 - [x] Gzip 压缩 ✅ 2026-06-03已接入响应流程
- [x] 集成测试 suite30 项 curl/bash 测试全部通过)✅ 2026-06-03 - [x] Brotli 压缩 ✅ 2026-06-04优先于 Gzip
- [x] 集成测试 suite37 项 curl/bash 测试全部通过)✅ 2026-06-04
- [x] 性能基准wrk: ~16.2K RPS / ~60μs 延迟)✅ 2026-06-03 - [x] 性能基准wrk: ~16.2K RPS / ~60μs 延迟)✅ 2026-06-03
- [x] 请求体解析POST 支持)✅ 2026-06-03 - [x] 请求体解析POST 支持)✅ 2026-06-03
- Content-Length 读取 - Content-Length 读取
- JSON / form-urlencoded 回显 - JSON / form-urlencoded 回显
- **multipart/form-data 文件上传**(保存到 root_dir/uploads/)✅ 2026-06-04 - **multipart/form-data 文件上传**(保存到 root_dir/uploads/)✅ 2026-06-04
- [x] C 语言单元测试框架 ✅ 2026-06-03Unity 框架,99 个测试全部通过) - [x] C 语言单元测试框架 ✅ 2026-06-03Unity 框架,125 个测试全部通过)
### Phase 3 — 扩展 ### Phase 3 — 扩展
- [x] **配置文件支持** — JSON 配置替代纯命令行 ✅ 2026-06-04 - [x] **配置文件支持** — JSON 配置替代纯命令行 ✅ 2026-06-04
- `config.c` / `config.h`:极简 JSON 解析器(数字、字符串、布尔、注释) - [x] **Brotli 压缩** — 比 gzip 更高压缩率 ✅ 2026-06-04
- `cocoon_config_t` 结构体root_dir / port / threaded / num_workers / max_connections / timeout_ms / log_level / gzip_enabled
- `config_merge()`:命令行参数覆盖配置文件
- `cocoon.json` 示例配置
- `--no-gzip` 命令行选项禁用压缩
- [x] **Brotli 压缩** — 比 gzip 更高压缩率,现代浏览器均支持 ✅ 2026-06-04
- [ ] HTTPS / TLS - [ ] HTTPS / TLS
- [ ] HTTP/2 - [ ] HTTP/2
- [ ] Windows 兼容性
### Phase 4 — 生态 ### Phase 4 — 生态
- [ ] WebSocket 支持 - [ ] WebSocket 支持
@ -49,7 +46,7 @@
- 编译通过,零警告(除 coco 子模块的 linker .note.GNU-stack 提示) - 编译通过,零警告(除 coco 子模块的 linker .note.GNU-stack 提示)
- **37 项集成测试全部通过**GET/HEAD/POST/404/Range/304/gzip/brotli/MIME/目录浏览/路径防护/文件上传) - **37 项集成测试全部通过**GET/HEAD/POST/404/Range/304/gzip/brotli/MIME/目录浏览/路径防护/文件上传)
- **113 个单元测试全部通过**Unity 框架,覆盖 http.c / static.c / multipart.c / config.c 核心逻辑 - **125 个单元测试全部通过**Unity 框架server 测试 17 个
- 压测数据wrk -t4 -c100 -d10s → 16,179 RPS平均延迟 59.86μs - 压测数据wrk -t4 -c100 -d10s → 16,179 RPS平均延迟 59.86μs
- POST 支持JSON 和 form-urlencoded 回显multipart 文件上传Content-Length 解析8MB 上限 - POST 支持JSON 和 form-urlencoded 回显multipart 文件上传Content-Length 解析8MB 上限
- **配置文件支持**JSON 格式8 个字段,命令行参数可覆盖 - **配置文件支持**JSON 格式8 个字段,命令行参数可覆盖
@ -57,72 +54,30 @@
## 待办池 ## 待办池
1. **[高] Windows 兼容性** — 支持 Windows 构建与运行 1. **[高] HTTPS / TLS** — 生产部署必备
2. **[高] HTTPS / TLS** — 生产部署必备 2. **[高] HTTP/2 多路复用** — 长期演进方向
3. **[高] HTTP/2 多路复用** — 长期演进方向 3. **[中] Windows 兼容性** — 平台抽象层platform.h / platform.c
4. **[中] server.c 单元测试** — 需要 mock socket 和 coco 协程环境 4. **[中] Doxygen 中文注释** — 所有模块的公共 API 需要完整文档
5. **[中] 完善 Doxygen 中文注释** — 所有模块的公共 API 需要完整文档 5. **[低] 检查远程更新内容** — 上游有 new commits需 review 9041d8d
### Windows 兼容性详细计划
**目标**:在 Windows 上编译运行 cocoon目前仅支持 Linux/macOS
**核心发现**coco 库**已有完整 Windows 支持**`poll_windows.c` 使用 WSAPoll`coco_read/coco_write/coco_accept` 内部调用 `recv/send/accept`)。问题在 cocoon 自身直接调用大量 POSIX API。
**方案**:引入 `platform.h` + `platform.c` 平台抽象层,封装所有 POSIX/Windows 差异。
| 变更 | 说明 |
|------|------|
| **新增** | `src/platform.h`, `src/platform.c`, `CMakeLists.txt` |
| **修改** | `server.c`, `static.c`, `main.c`, `server.h`, `Makefile` |
| **移除依赖** | `sys/socket.h`, `sendfile.h`, `dirent.h`, `signal.h`, `unistd.h` |
| **关键映射** | `close()``closesocket()`, `fcntl()``ioctlsocket()`, `sendfile()``read+send` 循环, `opendir()``FindFirstFileA()` |
| **零拷贝** | Windows 上暂时移除 sendfile后续可用 TransmitFile 优化) |
**执行方式**Option 1 — Subagent-Driven子代理逐个 Task 实现,每步自动 review
## 最近行动记录 ## 最近行动记录
- 2026-06-04: **本轮行动 — Brotli 压缩支持** - **2026-06-04: 本轮行动 — 修复拼写错误 + 扩展 server 单元测试**
- `static.c``brotli_compress()` 函数,使用 `libbrotlienc` 高质量压缩(质量 11窗口 22 - `cocoon.h``COCOONForbidden``COCOON_FORBIDDEN`(统一下划线命名)
- `static_serve_file()`:优先 Brotli回退 Gzip不可压缩/二进制文件跳过 - `test_server.c`:从 5 个测试扩展到 17 个
- `http.c`:解析 `Accept-Encoding: br``http_request_t` 新增 `accept_brotli` 字段 - 空 root_dir 边界测试
- `cocoon.h``cocoon_config_t` 新增 `brotli_enabled` 字段(默认 true - port=0系统分配和 port=65535 边界测试
- `config.c` / `config.h`:解析 `brotli_enabled` JSON 字段,`config_merge()` 新增 `has_brotli_enabled` 参数 - 多线程配置 + workers=0 自动检测测试
- `main.c``--no-brotli` 命令行选项,默认启用 Brotli - timeout / max_connections 配置测试
- `server.c`:连接结构体新增 `brotli_enabled`,传递至 `static_serve_file()` - gzip/brotli 压缩标志测试
- `Makefile`:链接 `-lbrotlienc`,单元测试编译也添加 - stop → destroy 生命周期测试
- 单元测试:`test_static.c` 新增 4 个 Brotli 测试(可压缩/不可压缩/小数据/溢出) - 多实例创建测试
- 单元测试:`test_config.c` 新增 `brotli_enabled` 解析与 merge 测试,修复所有 `config_merge()` 调用签名 - `server_start(NULL)` 参数校验测试
- 集成测试:`assert_brotli()` / `assert_brotli_preferred()` / `assert_not_brotli()`,新增 5 项 Brotli 测试 - 单元测试125 个全部通过集成测试37 项全部通过
- `cocoon.json` 示例配置添加 `brotli_enabled: true` - 推送到 mainrebase 了远程更新 9041d8d
- README更新特性描述、curl 示例、命令行参数、路线图 - 2026-06-04: Brotli 压缩支持(优先于 Gzip
- 单元测试113 个全部通过集成测试37 项全部通过 - 2026-06-04: 配置文件支持 + gzip_enabled 控制 + README 修正
- 推送到 main - 2026-06-04: multipart 文件上传
- 2026-06-04: **本轮行动 — 配置文件支持 + README 修正 + bug 修复**
- `config.c` / `config.h`:极简 JSON 配置解析器(支持数字、字符串、布尔 true/false、// 注释)
- `cocoon_config_t` 扩展 `gzip_enabled` 字段(默认 true
- `main.c``-c <file>` 加载配置文件,`--no-gzip` 禁用压缩,命令行参数覆盖配置文件
- `config_merge()`:命令行显式指定值覆盖配置文件,新增 `has_gzip_enabled` 参数
- **修复 `-r` 参数 strdup 崩溃**`parse_args``config->root_dir = strdup(argv[i])`,避免 `free()` 野指针
- **修复 signal handler 双重 free**`main()` 中 server 指针仅在 `server != NULL` 时调用 `server_destroy()`
- 单元测试:`test_config.c` 17 个测试配置加载、merge、边界条件、gzip_enabled全部通过
- 集成测试32 项全部通过,配置文件启动验证通过
- `cocoon.json` 示例配置更新,添加 `gzip_enabled` 字段
- README 修正:
- "极简配置" → "配置文件"(已支持 JSON 配置)
- 安全设计:"仅允许 GET/HEAD" → "支持 GET/HEAD/POST"
- `-v` 参数说明:"显示版本号" → "详细日志输出debug 级别)"
- 路线图:配置文件支持打勾,添加 Brotli 压缩待办
- 推送到 main
- 2026-06-04: **本轮行动 — multipart 文件上传**
- 实现 `multipart.c` / `multipart.h`boundary 提取、multipart 解析、part 内存管理
- `server.c` 集成POST 请求检测 multipart保存文件到 `root_dir/uploads/`
- 修复 boundary 解析条件(`>= b_len` 替代 `> b_len`),修复边界扫描越界
- 创建 `tests/unit/test_multipart.c`12 个测试boundary 提取、解析、边界条件
- 修复集成测试 CRLF 问题:使用 `printf` 生成真实 CRLF 字节
- 集成测试 32 项全部通过,单元测试 99 个全部通过
- 推送到 main
- 2026-06-03: 项目初始化,核心模块全部实现 - 2026-06-03: 项目初始化,核心模块全部实现
- 2026-06-03: 添加缓存协商ETag + Last-Modified + 304修复编译警告 - 2026-06-03: 添加缓存协商ETag + Last-Modified + 304修复编译警告
- 2026-06-03: 添加连接空闲超时管理 + 最大并发限制 + 分级日志系统 - 2026-06-03: 添加连接空闲超时管理 + 最大并发限制 + 分级日志系统
@ -130,19 +85,8 @@
- 2026-06-03: 添加 POST 请求体解析支持30 项测试全部通过README 更新 - 2026-06-03: 添加 POST 请求体解析支持30 项测试全部通过README 更新
- 2026-06-03: **本轮行动 — 单元测试框架** - 2026-06-03: **本轮行动 — 单元测试框架**
- 引入 Unity 测试框架ThrowTheSwitch - 引入 Unity 测试框架ThrowTheSwitch
- 创建 `tests/unit/test_http.c`35 个测试): - 创建 `tests/unit/test_http.c`35 个测试)
- 请求解析方法、路径、头部、Range、缓存、编码、边界条件 - 创建 `tests/unit/test_static.c`31 个测试)
- 响应格式化状态行、缓存头、Range、缓冲区溢出
- MIME 类型:常见类型、大小写、无扩展名、特殊类型
- 内存管理:请求体释放
- 创建 `tests/unit/test_static.c`31 个测试):
- 压缩判断:文本/二进制/空值
- 时间处理:格式化、解析、边界
- ETag生成、匹配精确/弱/通配符/空值)
- 路径安全:正常拼接、路径遍历、空值、边界
- HTML 转义:特殊字符、缓冲区溢出
- gzip 压缩:可压缩/不可压缩/小数据/溢出
- socket 层send_all、错误响应404/500/未知)
- 更新 Makefile`make unit-test` 一键编译运行 - 更新 Makefile`make unit-test` 一键编译运行
- 66 个测试全部通过,集成测试保持 30 项通过 - 66 个测试全部通过,集成测试保持 30 项通过
- 推送到 main - 推送到 main