Prechádzať zdrojové kódy

📝 docs(infrastructure): update core package documentation

- 完善测试标准,添加测试覆盖率目标及来源引用
- 更新crud-core包文档,细化迁移任务和技术架构信息
- 修正依赖关系,添加依赖版本对齐要求
- 明确CRUD模式迁移具体内容和文件位置
- 更新Change Log记录文档变更历史
yourname 4 týždňov pred
rodič
commit
cfbff36c7f

+ 6 - 2
docs/stories/005.001.infrastructure-core-packages.md

@@ -136,12 +136,16 @@ Draft
 - `@types/*` 相关依赖版本保持一致
 
 ### 测试标准
-- **测试框架**: Vitest
-- **测试位置**: 每个 package 的 `tests/` 目录(遵循现有测试策略)
+- **测试框架**: Vitest [Source: architecture/testing-strategy.md#测试金字塔策略]
+- **测试位置**: 每个 package 的 `tests/` 目录(遵循现有测试策略)[Source: architecture/testing-strategy.md#测试金字塔策略]
   - `tests/unit/` - 单元测试
   - `tests/integration/` - 集成测试
 - **测试要求**: 单元测试覆盖核心功能,集成测试验证包间协作
 - **测试执行**: `pnpm test` 在每个 package 中运行
+- **测试覆盖率目标**: [Source: architecture/testing-strategy.md#测试覆盖率标准]
+  - 单元测试: ≥ 80%
+  - 集成测试: ≥ 60%
+  - 关键模块(认证授权、数据库操作): ≥ 90%
 
 ## Change Log
 | Date | Version | Description | Author |

+ 78 - 16
docs/stories/005.002.crud-infrastructure-package.md

@@ -10,20 +10,25 @@ Draft
 
 ## Acceptance Criteria
 1. crud-core package 创建完成,包含通用的 CRUD 服务、控制器和路由模式
-2. crud-core package 正确依赖基础设施包(shared-types、database-core等)
+2. crud-core package 正确依赖基础设施包(shared-types、user-core等)
 3. server package 重构为使用 crud-core package 替代内部 CRUD 实现
 4. 所有 CRUD 相关的通用模式迁移到 crud-core package
 5. crud-core package 通过单元测试和集成测试
 6. 现有 CRUD 功能通过回归测试验证无影响
 7. 依赖关系层次清晰,无循环依赖
 8. 提供完整的类型定义和 API 文档
+9. 所有新包的依赖版本与 packages/server 保持一致
 
 ## Tasks / Subtasks
 - [ ] 创建 crud-core package (AC: 1)
   - [ ] 创建 package.json 配置
   - [ ] 迁移通用 CRUD 服务模式
-  - [ ] 迁移通用 CRUD 控制器模式
+    - [ ] 迁移 `GenericCrudService` 类
+    - [ ] 迁移 `ConcreteCrudService` 类
+    - [ ] 迁移相关类型定义(UserTrackingOptions、RelationFieldOptions、CrudOptions)
   - [ ] 迁移通用 CRUD 路由模式
+    - [ ] 迁移 `createCrudRoutes` 函数
+    - [ ] 迁移路由配置和验证逻辑
   - [ ] 配置 TypeScript 编译选项
   - [ ] 编写基础测试
 - [ ] 配置依赖关系 (AC: 2)
@@ -37,8 +42,14 @@ Draft
   - [ ] 验证编译通过
 - [ ] 迁移通用 CRUD 模式 (AC: 4)
   - [ ] 迁移基础实体服务
-  - [ ] 迁移通用控制器逻辑
+    - [ ] 迁移 `GenericCrudService` 完整实现
+    - [ ] 迁移 `ConcreteCrudService` 完整实现
   - [ ] 迁移标准路由模式
+    - [ ] 迁移 `createCrudRoutes` 完整实现
+    - [ ] 迁移所有路由处理逻辑
+  - [ ] 迁移配置和类型定义
+    - [ ] 迁移 `CrudOptions` 类型定义
+    - [ ] 迁移用户跟踪和关联字段配置
   - [ ] 迁移错误处理模式
 - [ ] 编写测试 (AC: 5)
   - [ ] 编写 crud-core 单元测试(放在 tests/unit/)
@@ -52,6 +63,10 @@ Draft
   - [ ] 检查 package 依赖关系
   - [ ] 验证无循环依赖
   - [ ] 确认依赖层次正确
+- [ ] 验证依赖版本对齐 (AC: 9)
+  - [ ] 检查所有新包的依赖版本与 packages/server 保持一致
+  - [ ] 验证关键依赖版本(typeorm、hono、zod等)完全一致
+  - [ ] 确保开发依赖版本也保持一致
 - [ ] 完善文档 (AC: 8)
   - [ ] 提供类型定义文档
   - [ ] 编写使用示例
@@ -62,13 +77,19 @@ Draft
 ### 技术架构信息
 - **项目技术栈**: Node.js 20.19.2 + TypeScript + Hono + TypeORM + PostgreSQL
 - **包管理**: pnpm workspace
-- **依赖层次**: shared-types → database-core → crud-core → 业务模块 → server
+- **依赖层次**: shared-types → user-core/auth-core/utils-core → crud-core → 业务模块 → server
 
 ### 现有代码结构参考
-- **当前 CRUD 服务位置**: packages/server/src/services/
-- **当前 CRUD 控制器**: packages/server/src/controllers/
-- **当前 CRUD 路由**: packages/server/src/routes/
-- **需要迁移的通用模式**: 基础实体服务、通用控制器逻辑、标准路由模式
+- **当前 CRUD 服务位置**: packages/server/src/utils/
+  - `generic-crud.service.ts` - 通用CRUD服务基类
+  - `concrete-crud.service.ts` - 具体CRUD服务实现
+  - `generic-crud.routes.ts` - 通用CRUD路由生成器
+- **需要迁移的通用模式**:
+  - 通用CRUD服务基类(GenericCrudService)
+  - 具体CRUD服务实现(ConcreteCrudService)
+  - 通用CRUD路由生成器(createCrudRoutes)
+  - CRUD配置选项和类型定义
+  - 用户跟踪和关联字段处理逻辑
 
 ### Package 配置要求
 ```json
@@ -77,7 +98,7 @@ Draft
   "name": "@d8d/crud-core",
   "dependencies": {
     "@d8d/shared-types": "workspace:*",
-    "@d8d/database-core": "workspace:*",
+    "@d8d/user-core": "workspace:*",
     "typeorm": "^0.3.20",
     "@hono/zod-openapi": "1.0.2",
     "zod": "^4.1.12"
@@ -90,7 +111,7 @@ Draft
   "dependencies": {
     "@d8d/shared-types": "workspace:*",
     "@d8d/crud-core": "workspace:*",
-    "@d8d/database-core": "workspace:*",
+    "@d8d/user-core": "workspace:*",
     "@d8d/auth-core": "workspace:*",
     "@d8d/utils-core": "workspace:*"
   }
@@ -99,26 +120,64 @@ Draft
 
 ### 需要迁移的通用 CRUD 模式
 - **基础服务模式**: 提供通用的 CRUD 操作方法
-- **控制器模式**: 标准化的控制器结构和错误处理
+  - `GenericCrudService` - 通用CRUD服务基类
+  - `ConcreteCrudService` - 具体CRUD服务实现
+  - 用户跟踪功能(UserTrackingOptions)
+  - 关联字段处理(RelationFieldOptions)
 - **路由模式**: 统一的 API 路由定义和验证
-- **DTO 模式**: 通用的数据转换和验证
+  - `createCrudRoutes` - 通用CRUD路由生成器
+  - 标准化的CRUD操作路由(列表、创建、获取、更新、删除)
+  - 只读模式支持
+- **配置模式**: 标准化的CRUD配置
+  - `CrudOptions` - CRUD配置选项类型
+  - 搜索字段配置
+  - 关联关系配置
+  - 中间件配置
 - **查询模式**: 标准化的查询参数处理和分页
+  - 分页查询
+  - 关键词搜索
+  - 复杂筛选条件
+  - 排序支持
 
 ### 集成点注意事项
-- **数据库连接**: 使用 database-core 提供的连接管理
+- **数据库连接**: 使用 user-core 提供的数据库连接管理
 - **类型定义**: 依赖 shared-types 的基础类型
 - **认证**: 后续业务模块可选择性集成 auth-core
 - **错误处理**: 保持现有的错误处理模式
+- **依赖版本对齐**: 所有外部依赖版本必须与 packages/server 保持一致
+- **TypeScript 配置**: tsconfig.json 必须设置 `"composite": true`
+- **Package 输出配置**: package.json 中的 `"main"`、`"types"` 和 `"exports"` 必须指向 `src` 目录(pnpm workspace 直接引用源码)
 
 ### 测试标准
-- **测试框架**: Vitest
-- **测试位置**: crud-core 的 `tests/` 目录(遵循现有测试策略)
+- **测试框架**: Vitest [Source: architecture/testing-strategy.md#测试金字塔策略]
+- **测试位置**: crud-core 的 `tests/` 目录(遵循现有测试策略)[Source: architecture/testing-strategy.md#测试金字塔策略]
   - `tests/unit/` - 单元测试
   - `tests/integration/` - 集成测试
-- **测试类型**: 单元测试 + 集成测试
+- **测试要求**: 单元测试覆盖核心功能,集成测试验证包间协作
+- **测试执行**: `pnpm test` 在每个 package 中运行
+- **测试覆盖率目标**: [Source: architecture/testing-strategy.md#测试覆盖率标准]
+  - 单元测试: ≥ 80%
+  - 集成测试: ≥ 60%
+  - 关键模块(CRUD操作、数据库交互): ≥ 90%
 - **测试重点**: CRUD 操作正确性、类型安全、错误处理
 - **回归测试**: 验证现有 CRUD API 功能无影响
 
+### 关键依赖版本对齐要求
+**必须与 packages/server 完全一致的依赖版本:**
+- `typeorm`: ^0.3.20
+- `hono`: ^4.8.5
+- `zod`: ^4.1.12
+- `@hono/zod-openapi`: 1.0.2
+- `jsonwebtoken`: ^9.0.2
+- `bcrypt`: ^6.0.0
+- `pg`: ^8.16.3
+- `axios`: ^1.12.2
+
+**开发依赖版本对齐:**
+- `typescript`: ^5.8.3
+- `vitest`: ^3.2.4
+- `@types/*` 相关依赖版本保持一致
+
 ### 向后兼容性保证
 - 现有 API 接口保持不变
 - 数据库操作逻辑保持一致
@@ -129,6 +188,9 @@ Draft
 | Date | Version | Description | Author |
 |------|---------|-------------|--------|
 | 2025-11-10 | 1.0 | 初始创建故事文档 | Bob (Scrum Master) |
+| 2025-11-10 | 1.1 | 更新依赖关系,移除 database-core 引用 | Bob (Scrum Master) |
+| 2025-11-10 | 1.2 | 添加依赖版本对齐要求和测试覆盖率目标 | Bob (Scrum Master) |
+| 2025-11-10 | 1.3 | 基于实际代码分析更新需要迁移的CRUD模式 | Bob (Scrum Master) |
 
 ## Dev Agent Record
 *此部分由开发代理在实现过程中填写*