浏览代码

📝 feat(故事007.010): 创建订单模块多租户复制故事

- 基于先前故事经验教训创建订单模块多租户复制故事
- 整合数据库同步冲突预防、租户ID字段管理等最佳实践
- 详细定义订单、订单商品、退款实体的多租户化方案
- 包含完整的测试策略和性能要求

🤖 Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
yourname 1 月之前
父节点
当前提交
265f9cb30a
共有 1 个文件被更改,包括 222 次插入0 次删除
  1. 222 0
      docs/stories/007.010.orders-module-multi-tenant-replication.md

+ 222 - 0
docs/stories/007.010.orders-module-multi-tenant-replication.md

@@ -0,0 +1,222 @@
+# 故事007.010: 订单模块多租户复制
+
+## 状态
+
+Draft
+
+## 故事
+
+**作为** 系统管理员,
+**我想要** 复制订单管理模块并添加多租户支持,
+**以便** 订单可以在租户隔离的环境中管理,同时保持与现有单租户系统的完全兼容性。
+
+## 验收标准
+
+1. **AC 1**: 成功复制 `@d8d/orders-module` 为 `@d8d/orders-module-mt`,包含正确的包配置
+2. **AC 2**: 创建多租户订单实体 `OrderMt`、订单商品实体 `OrderGoodsMt` 和退款实体 `RefundMt`,包含租户ID字段和表名 `orders_mt`、`orders_goods_mt`、`refunds_mt`
+3. **AC 3**: 更新所有订单CRUD操作,自动包含租户过滤并在创建时设置租户ID
+4. **AC 4**: 验证订单数据隔离在不同租户间正常工作,包括关联实体数据隔离
+5. **AC 5**: 保持与现有单租户订单管理模块功能的完全兼容性
+6. **AC 6**: 所有现有单租户API接口保持不变且功能正常
+7. **AC 7**: 实现完整的租户数据隔离API测试,包括跨租户订单访问安全验证
+8. **AC 8**: 确保性能影响小于5%
+9. **AC 9**: 所有多租户模块的回归测试通过
+
+## 任务 / 子任务
+
+- [ ] 复制订单管理模块为多租户版本 (AC: 1)
+  - [ ] 复制 `packages/orders-module` 为 `packages/orders-module-mt`
+  - [ ] 更新包配置为 `@d8d/orders-module-mt`
+  - [ ] 更新依赖:
+    - [ ] 将 `@d8d/user-module` 替换为 `@d8d/user-module-mt`
+    - [ ] 将 `@d8d/auth-module` 替换为 `@d8d/auth-module-mt`
+    - [ ] 将 `@d8d/file-module` 替换为 `@d8d/file-module-mt`
+    - [ ] 将 `@d8d/merchant-module` 替换为 `@d8d/merchant-module-mt`
+    - [ ] 将 `@d8d/supplier-module` 替换为 `@d8d/supplier-module-mt`
+    - [ ] 将 `@d8d/delivery-address-module` 替换为 `@d8d/delivery-address-module-mt`
+    - [ ] 将 `@d8d/goods-module` 替换为 `@d8d/goods-module-mt`
+
+- [ ] 更新多租户订单实体 (AC: 2)
+  - [ ] 创建 `OrderMt` 实体,表名为 `orders_mt`
+  - [ ] 创建 `OrderGoodsMt` 实体,表名为 `orders_goods_mt`
+  - [ ] 创建 `RefundMt` 实体,表名为 `refunds_mt`
+  - [ ] 为所有实体添加 `tenantId` 字段和正确的TypeORM配置
+  - [ ] 保持其他字段与单租户版本一致
+  - [ ] 更新关联关系指向多租户实体
+
+- [ ] 更新多租户订单服务 (AC: 3, 4)
+  - [ ] 使用共享CRUD库的GenericCrudService
+  - [ ] 所有查询操作自动添加租户过滤
+  - [ ] 创建操作自动设置租户ID
+  - [ ] 更新关联查询支持租户隔离
+  - [ ] 确保订单与订单商品、退款等关联实体的租户一致性
+
+- [ ] 更新多租户路由配置 (AC: 3)
+  - [ ] 更新用户订单路由使用多租户实体和服务
+  - [ ] 更新管理员订单路由使用多租户实体和服务
+  - [ ] 更新公开订单路由使用多租户实体和服务
+  - [ ] 保持API接口与单租户版本一致
+  - [ ] 启用租户选项:`tenantOptions: { enabled: true, tenantIdField: 'tenantId' }`
+
+- [ ] 更新Schema定义 (AC: 3)
+  - [ ] 使用多租户订单Schema `OrderSchema`
+  - [ ] 使用多租户订单商品Schema `OrderGoodsSchema`
+  - [ ] 使用多租户退款Schema `RefundSchema`
+  - [ ] 使用多租户用户专用Schema `UserOrderSchema`
+  - [ ] 使用多租户管理员专用Schema `AdminOrderSchema`
+  - [ ] 使用多租户公开订单Schema `PublicOrderSchema`
+  - [ ] 添加租户ID字段定义
+
+- [ ] 实现租户数据隔离API测试 (AC: 7)
+  - [ ] 在 `packages/orders-module-mt/tests/integration/user-orders-routes.integration.test.ts` 中添加租户隔离测试用例
+  - [ ] 在 `packages/orders-module-mt/tests/integration/admin-orders-routes.integration.test.ts` 中添加跨租户订单访问安全验证
+  - [ ] 在 `packages/orders-module-mt/tests/integration/public-orders-routes.integration.test.ts` 中添加租户过滤验证
+  - [ ] 在现有功能测试中验证租户过滤功能正确性
+  - [ ] 验证关联实体(用户、商户、供应商、地址)的租户隔离
+
+- [ ] 验证单租户系统完整性 (AC: 5, 6)
+  - [ ] 运行单租户订单管理模块回归测试
+  - [ ] 验证单租户API接口不受影响
+  - [ ] 确认单租户数据库表结构不变
+
+- [ ] 在创建复制的代码修改完后先运行安装
+  - [ ] 在复制模块后运行 `pnpm install` 安装依赖
+  - [ ] 验证新包已正确添加到工作区
+  - [ ] 确认所有依赖解析正确
+
+- [ ] 执行性能基准测试 (AC: 8)
+  - [ ] 运行多租户订单管理模块性能测试
+  - [ ] 比较单租户与多租户性能差异
+  - [ ] 确保性能影响小于5%
+
+- [ ] 执行回归测试验证 (AC: 9)
+  - [ ] 运行所有多租户模块的回归测试
+  - [ ] 验证权限模块多租户测试 (38个测试)
+  - [ ] 验证文件模块多租户测试 (40个测试)
+  - [ ] 验证区域模块多租户测试 (29个测试)
+  - [ ] 验证用户模块多租户测试 (41个测试)
+  - [ ] 验证配送地址模块多租户测试 (36个测试)
+  - [ ] 验证商户模块多租户测试 (37个测试)
+  - [ ] 验证供应商模块多租户测试 (所有测试)
+  - [ ] 验证租户模块多租户测试 (16个测试)
+  - [ ] 验证广告模块多租户测试 (22个测试)
+  - [ ] 验证商品模块多租户测试 (14个测试)
+  - [ ] 确认所有多租户测试全部通过
+
+## 开发说明
+
+### 先前故事洞察
+基于故事007.009(商品模块多租户复制)和之前故事的经验教训:
+
+**技术挑战和解决方案** [Source: docs/prd/epic-007-multi-tenant-package-replication.md#实施经验总结]
+- **数据库同步冲突**: 在vitest配置中使用 `fileParallelism: false` 避免并行测试导致的数据库表重复创建错误
+- **租户ID字段管理**: 确保所有测试数据包含正确的tenantId字段,避免null value in column "tenant_id" violates not-null constraint错误
+- **目录结构错误**: 清理多租户模块中错误包含的单租户模块目录,确保多租户和单租户模块在同一层级
+- **共享CRUD库租户验证顺序**: 确保租户验证先于数据权限验证,跨租户访问正确返回404状态码
+- **多租户模块依赖**: 系统清理所有多租户包的文件命名,统一使用 `.mt.ts` 后缀
+
+**最佳实践** [Source: docs/prd/epic-007-multi-tenant-package-replication.md#最佳实践]
+- **文件命名规范**: 严格使用 `.mt.ts` 后缀区分多租户文件
+- **测试配置**: 使用 `fileParallelism: false` 避免数据库冲突
+- **类型处理**: 在测试中使用类型断言处理必需参数验证
+- **数据工厂**: 确保所有测试数据包含正确的tenantId字段
+- **依赖管理**: 及时更新多租户模块间的依赖关系
+
+### 数据模型
+**订单实体** [Source: packages/orders-module/src/entities/order.entity.ts]
+- 表名: `orders` → `orders_mt`
+- 主要字段: `orderNo`, `userId`, `amount`, `costAmount`, `freightAmount`, `discountAmount`, `payAmount`, `orderType`, `payType`, `payState`, `state`, `merchantId`, `supplierId`, `addressId`
+- 关联关系: `user`, `merchant`, `supplier`, `deliveryAddress`
+- 需要添加: `tenantId` 字段和复合索引
+
+**订单商品实体** [Source: packages/orders-module/src/entities/order-goods.entity.ts]
+- 表名: `orders_goods` → `orders_goods_mt`
+- 主要字段: `orderId`, `goodsId`, `goodsName`, `goodsType`, `supplierId`, `costPrice`, `price`, `num`, `freightAmount`, `state`
+- 关联关系: `order`, `goods`, `supplier`, `imageFile`
+- 需要添加: `tenantId` 字段和复合索引
+
+**退款实体** [Source: packages/orders-module/src/entities/refund.entity.ts]
+- 表名: `refunds` → `refunds_mt`
+- 主要字段: `orderId`, `orderNo`, `refundNo`, `refundAmount`, `refundType`, `refundState`, `refundReason`
+- 关联关系: `order`
+- 需要添加: `tenantId` 字段和复合索引
+
+### API规范
+**路由结构** [Source: docs/architecture/source-tree.md#订单管理模块]
+- 用户路由: `user-orders-routes.ts`
+- 管理员路由: `admin-orders-routes.ts`
+- 公开路由: `public-orders-routes.ts`
+- 退款管理路由: `admin-refunds-routes.ts`
+
+**API端点** [Source: packages/orders-module/src/routes/]
+- 用户订单路由: 订单列表、详情、创建、更新、删除、支付
+- 管理员订单路由: 完整订单管理功能、订单统计
+- 公开订单路由: 公开订单浏览和状态查询
+- 退款路由: 退款申请、审核、处理
+
+### 文件位置
+**新文件路径** [Source: docs/architecture/source-tree.md#包架构层次]
+- 包根目录: `packages/orders-module-mt/`
+- 实体文件: `packages/orders-module-mt/src/entities/order.mt.entity.ts`
+- 服务文件: `packages/orders-module-mt/src/services/order.mt.service.ts`
+- 路由文件: `packages/orders-module-mt/src/routes/*.mt.ts`
+- Schema文件: `packages/orders-module-mt/src/schemas/*.mt.schema.ts`
+- 测试文件: `packages/orders-module-mt/tests/integration/*.integration.test.ts`
+
+### 技术约束
+**多租户架构** [Source: docs/prd/epic-007-multi-tenant-package-replication.md#架构设计详情]
+- 使用共享CRUD库的GenericCrudService
+- 所有查询操作自动添加租户过滤
+- 创建操作自动设置租户ID
+- 启用租户选项: `tenantOptions: { enabled: true, tenantIdField: 'tenantId' }`
+- 确保关联实体(用户、商户、供应商、商品、地址)的租户一致性
+
+**性能要求** [Source: docs/prd/epic-007-multi-tenant-package-replication.md#成功标准]
+- 性能影响小于5%
+- 租户过滤使用数据库索引
+- 确保查询性能优化,特别是订单列表查询
+
+### 测试
+
+#### 测试标准 [Source: docs/architecture/testing-strategy.md#包测试架构]
+- **测试位置**: `packages/orders-module-mt/tests/integration/`
+- **测试框架**: Vitest + hono/testing + shared-test-util
+- **覆盖率目标**: 集成测试 ≥ 60%
+- **测试类型**: 集成测试验证模块功能
+
+#### 测试要求 [Source: docs/architecture/testing-strategy.md#测试金字塔策略]
+- **集成测试范围**: 多个组件/服务协作
+- **测试目标**: 验证模块间集成和交互
+- **执行频率**: 每次API变更
+
+#### 特定测试要求
+- 租户数据隔离验证
+- 跨租户订单访问安全验证
+- 租户过滤功能正确性
+- 关联实体租户一致性验证
+- 订单与订单商品、退款的租户关联验证
+- 性能基准测试
+
+## 变更日志
+
+| 日期 | 版本 | 描述 | 作者 |
+|------|------|------|------|
+| 2025-11-14 | 1.0 | 初始故事创建 | Bob (Scrum Master) |
+
+## 开发代理记录
+
+### Agent Model Used
+- Claude Code (d8d-model)
+
+### Debug Log References
+- 2025-11-14: 基于先前故事经验教训创建订单模块多租户复制故事
+
+### Completion Notes List
+*此部分将在开发过程中由开发代理填充*
+
+### File List
+*此部分将在开发过程中由开发代理填充*
+
+## QA结果
+
+*此部分将在质量保证审查过程中由QA代理填充*