epic-013-type-error-fixes.md 7.5 KB

史诗013 - 类型错误修复与代码类型安全增强

史诗目标

修复残疾人后端模块中的类型错误,并在当前史诗中逐步修复其他模块的类型错误,提高整个项目的TypeScript类型安全性,减少运行时错误风险。

史诗描述

现有系统上下文

当前相关功能:

  • 残疾人管理模块:提供残疾人信息的完整CRUD功能,包含文件模块集成和人才扩展API
  • 企业统计模块:史诗012中新增的企业统计与人才扩展API
  • 订单管理模块:订单相关的业务逻辑和视频管理功能
  • 其他业务模块:channel、company、platform、salary等已移植的allin系统模块

技术栈:

  • 后端:TypeScript、Hono、Zod OpenAPI、TypeORM
  • 数据库:PostgreSQL 17
  • API通信:基于Hono RPC的API客户端模式
  • 测试:Vitest(后端模块使用Vitest)
  • 包管理:pnpm workspace

集成点:

  • 基于史诗7,8,9,10移植的allin系统模块进行修复
  • 保持现有API的向后兼容性
  • 遵循现有的模块结构和类型定义模式
  • 与现有测试框架集成

当前类型错误分析: 通过对残疾人后端模块的类型检查,发现以下主要类型错误:

  1. 路由层类型不匹配aggregated.routes.ts中的bankCards属性类型不兼容,File类型与null类型冲突
  2. 测试代码类型错误:集成测试中的类型断言错误,数组类型与单个实体类型混淆
  3. 响应类型不明确:API响应中的动态属性访问缺乏类型保护
  4. 实体关系类型:TypeORM实体关系中的可选类型定义不准确

增强详情

修复范围: 本次史诗将分阶段修复以下类型的错误:

阶段1:残疾人后端模块核心修复(故事013.001)

  1. 修复aggregated.routes.ts中的类型不匹配问题
  2. 修复集成测试中的类型错误
  3. 优化实体类型定义,提高类型安全性
  4. 确保Zod schema与TypeORM实体类型一致

阶段2:其他模块类型错误修复(后续故事)

  1. 企业统计模块类型错误修复
  2. 订单管理模块类型错误修复
  3. 核心模块类型错误修复
  4. 共享类型定义优化

修复策略:

  1. 精确类型定义:使用准确的TypeScript类型,避免any类型
  2. 类型守卫:添加运行时类型检查,确保类型安全
  3. Zod集成:强化Zod schema的类型推断能力
  4. 测试类型修复:确保测试代码的类型正确性
  5. 渐进式修复:逐个模块修复,确保不影响现有功能

成功标准:

  1. 残疾人后端模块类型检查通过(pnpm typecheck无错误)
  2. 现有功能测试通过,无回归
  3. 类型定义更加精确,减少运行时类型错误风险
  4. 代码可维护性提高,类型提示更加完善
  5. 为其他模块的类型修复建立可复用的模式

故事列表

故事013-01:残疾人后端模块类型错误修复

背景: 残疾人后端模块在类型检查中发现多处类型错误,包括路由层类型不匹配、测试代码类型错误、实体关系类型定义不准确等问题,需要修复以提高代码质量和类型安全性。

任务列表:

  1. 分析aggregated.routes.ts中的类型错误,修复bankCards属性的File类型冲突
  2. 修复tests/integration/person-extension.integration.test.ts中的类型错误:
    • 修复数组类型与单个实体类型的混淆
    • 修复动态属性访问的类型保护
    • 修复实体关系类型定义
  3. 检查并修复其他可能存在的类型错误:
    • 检查any类型的使用,替换为具体类型
    • 优化Zod schema的类型推断
    • 确保TypeORM实体与TypeScript类型一致
  4. 运行类型检查验证修复结果
  5. 运行现有测试确保无回归

验收标准:

  • 残疾人后端模块类型检查通过(pnpm typecheck无错误)
  • 所有集成测试通过,类型错误已修复
  • 现有API功能正常,无回归
  • 类型定义更加精确,减少any类型使用
  • 代码符合项目类型安全标准

故事013-02:server包及其依赖模块类型错误修复

背景: 完成残疾人后端模块类型错误修复后,需要修复server包及其依赖模块中的类型错误,确保整个项目的TypeScript类型检查通过,提高代码质量和类型安全性。

详细故事: 参见故事文件 013.002.story.md

任务列表:

  1. 修复模块导入和导出错误(@d8d/allin-disability-module、@d8d/user-module、@d8d/auth-module、@d8d/file-module等)
  2. 修复类型定义和隐式any错误(permission.middleware.ts、minio.integration.test.ts、redis.util.ts等)
  3. 修复依赖模块中的override修饰符缺失(channel、company、disability、order、platform、salary、system-config等模块)
  4. 修复可能为undefined的错误和类型不匹配(personData可能为undefined、Partial类型不匹配等)
  5. 修复测试中的类型错误(auth.integration.test.ts中的phone属性缺失等)
  6. 验证修复结果,确保类型检查通过且无回归

验收标准:

  • server包类型检查通过(pnpm typecheck无错误)
  • 所有集成测试通过,类型错误已修复
  • 现有API功能正常,无回归
  • 类型定义更加精确,减少any类型使用
  • 代码符合项目类型安全标准

故事013-03:史诗012新增路由连通性集成测试

背景: 史诗012(用人方小程序API补充与数据库扩展)新增了多个企业用户相关API路由,这些路由已在server包中注册。为确保路由注册正确性和系统集成性,需要在server包中创建专门的集成测试文件,验证这些路由的连通性。

详细故事: 参见故事文件 013.003.story.md

任务列表:

  1. 分析史诗012新增的路由:企业用户认证路由 (/api/v1/yongren/auth)、企业统计路由 (/api/v1/yongren/company)、残疾人扩展路由 (/api/v1/yongren/disability-person)、以及订单模块中新增的企业相关路由
  2. 在server包中创建新的集成测试文件 epic012-routes-connectivity.integration.test.ts
  3. 按照现有集成测试模式,编写连通性测试,验证各路由端点可访问
  4. 测试重点:路由注册正确性、路径前缀匹配、中间件集成,不涉及具体业务逻辑测试
  5. 运行新测试确保通过,并验证不影响现有测试

验收标准:

  • 新的集成测试文件创建成功,遵循项目测试标准
  • 所有史诗012新增的路由连通性测试通过
  • 测试仅验证路由注册和连通性,不重复各模块的功能测试
  • 现有测试套件无回归,所有测试继续通过
  • 代码符合项目编码和测试标准

兼容性要求

  • 现有API接口保持不变,只进行类型层面的修复
  • 数据库schema和实体定义保持兼容
  • 前端客户端类型定义无需修改
  • 性能影响最小化,只涉及类型系统

风险缓解

  • 主要风险:类型修复可能引入新的逻辑错误或影响现有功能
  • 缓解措施:充分测试,确保现有测试全部通过;小范围逐步修复
  • 回滚计划:如果修复导致问题,可以回退类型定义更改,恢复为较宽松的类型

完成定义

  • 所有故事完成,验收标准满足
  • 类型检查通过,无TypeScript错误
  • 现有功能测试通过,无回归
  • 代码审查通过,符合类型安全标准
  • 文档更新反映类型定义的改进