Главная Обзор Помощь
Регистрация Вход
186-template-175
/
mini-starter
ответвлено от 155-template-138/mini-starter
2
0
Ответвить 0
Файлы
Дерево: 21b7d1a7e6
Ветки Метки
mini-starter
/
docs
/
stories
/
007.004.auth-module-multi-tenant-replication.md

007.004.auth-module-multi-tenant-replication.md 8.3 KB
История Исходник

Story 007.004: 认证模块多租户复制和租户支持

Status

Ready for Review

更新: 已完成多租户认证模块测试合并和优化，所有22个测试用例通过

Story

As a 系统管理员， I want 复制认证模块为多租户版本并修改认证中间件逻辑集成租户上下文管理， so that 认证系统能够支持多租户场景，同时保持单租户版本完全可用。

Acceptance Criteria

  1. 成功复制 @d8d/auth-module 为 @d8d/auth-module-mt
  2. 修改认证中间件逻辑，集成租户上下文管理（中间件名字保持不变）
  3. 在认证逻辑中添加租户支持
  4. 验证多租户认证功能
  5. 保持单租户版本完全可用

Tasks / Subtasks

  • [x] 复制认证模块为多租户版本 (AC: 1)

    • 复制 packages/auth-module 为 packages/auth-module-mt
    • 更新包配置为 @d8d/auth-module-mt
    • 添加多租户模块依赖：@d8d/user-module-mt

  • [x] 更新多租户认证中间件 (AC: 2)

    • 重命名认证中间件文件为多租户版本
    • 修改认证中间件逻辑集成租户上下文管理
    • 保持中间件名字 authMiddleware 不变
    • 从用户信息中提取租户ID并设置租户上下文

  • [x] 更新多租户认证服务 (AC: 3)

    • 重命名认证服务文件为多租户版本
    • 更新认证服务支持租户过滤
    • 更新用户服务依赖为多租户版本
    • 确保所有认证操作支持租户隔离

  • [x] 更新多租户路由配置 (AC: 3)

    • 更新认证路由使用多租户实体和服务
    • 保持API接口与单租户版本一致
    • 更新路由配置支持租户ID提取

  • [x] 实现租户认证隔离测试 (AC: 4)

    • 编写租户认证隔离集成测试
    • 编写跨租户认证安全测试
    • 验证租户认证功能正确性

  • [x] 验证单租户系统完整性 (AC: 5)

    • 运行单租户认证模块回归测试
    • 验证单租户API接口不受影响
    • 确认单租户数据库表结构不变

Dev Notes

技术栈信息

[Source: architecture/tech-stack.md]

  • 运行时: Node.js 20.18.3
  • 框架: Hono 4.8.5 (Web框架和API路由)
  • 数据库: PostgreSQL 17 + TypeORM 0.3.25
  • 认证: JWT 9.0.2 (Bearer Token)

编码标准

[Source: architecture/coding-standards.md]

  • 代码风格: TypeScript严格模式
  • 测试框架: Vitest + hono/testing + shared-test-util
  • 测试位置: packages/auth-module-mt/tests/integration/
  • 测试重点: API集成测试、租户认证隔离验证、认证功能

项目结构

  • 包位置: packages/auth-module-mt/
  • 中间件位置: packages/auth-module-mt/src/middleware/
  • 服务位置: packages/auth-module-mt/src/services/
  • 路由位置: packages/auth-module-mt/src/routes/
  • Schema位置: packages/auth-module-mt/src/schemas/

多租户架构要求

[Source: docs/prd/epic-007-multi-tenant-package-replication.md]

  • 包命名: 使用 -mt 后缀区分多租户版本
  • 表命名: 使用 _mt 后缀避免冲突
  • 租户ID: 所有实体添加 tenantId 字段
  • 数据隔离: 所有查询自动添加租户过滤
  • 依赖关系: 多租户模块间正常依赖

认证模块特性

[Source: packages/auth-module/src/middleware/auth.middleware.ts]

  • 认证中间件: authMiddleware 处理Bearer Token认证
  • 用户验证: 通过UserService验证用户存在性
  • 上下文设置: 设置用户上下文到Hono Context
  • 错误处理: 统一的认证错误响应

多租户认证策略

  • 租户上下文: 从用户信息中提取租户ID
  • 中间件逻辑: 保持中间件名字不变，内部逻辑支持租户
  • 认证隔离: 租户间用户认证完全隔离
  • 用户关联: 用户实体必须包含租户ID字段

测试要求

  • 集成测试: packages/auth-module-mt/tests/integration/**/*.test.ts
  • 测试框架: Vitest + shared-test-util
  • 测试重点: API功能验证、租户认证隔离、跨租户安全、认证流程

依赖关系

  • 必需依赖: @d8d/user-module-mt
  • 共享依赖: @d8d/shared-crud, @d8d/shared-types, @d8d/shared-utils
  • 测试依赖: @d8d/shared-test-util

共享CRUD包租户隔离支持

[Source: packages/shared-crud/src/routes/generic-crud.routes.ts]

  • 当前状态: ✅ 已完成增强，支持完整的租户隔离功能
  • 配置选项:
    • tenantOptions.enabled: 启用/禁用租户隔离
    • tenantOptions.tenantIdField: 租户ID字段名（默认 'tenantId'）
    • tenantOptions.autoExtractFromContext: 自动从上下文提取租户ID

数据库变更

  • 新表: 认证模块本身不创建新表，依赖用户模块多租户表
  • 索引: 依赖用户模块的租户ID索引
  • 迁移: 使用独立迁移文件，不影响现有表

Testing

测试标准

[Source: architecture/testing-strategy.md]

  • 测试架构: 模块化包测试架构，每个包独立测试
  • 测试类型: 单元测试 + 集成测试，验证模块功能
  • 测试位置: packages/auth-module-mt/tests/integration/
  • 测试框架: Vitest + hono/testing + shared-test-util

认证模块测试要求

  • 认证流程测试: 验证登录、注册、token验证等认证流程
  • 租户隔离测试: 验证不同租户用户的认证隔离
  • 安全测试: 验证跨租户访问的安全性
  • 集成测试: 验证认证模块与其他模块的集成

测试数据工厂

  • 使用 @d8d/shared-test-util 的测试数据库工具
  • 设置测试数据库钩子：setupIntegrationDatabaseHooksWithEntities([UserEntityMt])
  • 创建多租户测试用户数据

Change Log

Date Version Description Author
2025-11-13 1.0 初始故事创建 Bob (Scrum Master)
2025-11-13 1.1 完成认证模块多租户复制和租户支持 James
2025-11-13 1.2 完成测试文件合并和优化，所有22个测试用例通过 James

Dev Agent Record

Agent Model Used

  • James (Full Stack Developer)

Debug Log References

  • 认证模块多租户复制完成
  • 认证中间件租户上下文集成完成
  • 认证服务租户过滤支持完成
  • 路由配置租户ID提取支持完成
  • 租户认证隔离测试实现完成
  • 单租户系统完整性验证通过

Completion Notes List

  • ✅ 成功复制认证模块为多租户版本 @d8d/auth-module-mt
  • ✅ 更新认证中间件支持租户上下文管理，保持中间件名字不变
  • ✅ 更新认证服务支持租户过滤和租户ID验证
  • ✅ 更新JWT payload包含租户ID信息
  • ✅ 更新登录和注册路由支持租户ID提取
  • ✅ 创建租户认证隔离集成测试
  • ✅ 验证单租户认证模块完整性不受影响
  • ✅ 所有单租户认证测试通过（23/23）
  • ✅ 完成多租户认证模块测试合并和优化
  • ✅ 合并租户隔离测试到认证集成测试，删除重复文件
  • ✅ 修复测试数据工厂中的租户ID设置问题
  • ✅ 修复认证中间件和用户信息端点中的schema导入错误
  • ✅ 所有22个多租户认证集成测试通过

File List

  • packages/auth-module-mt/ - 多租户认证模块根目录
  • packages/auth-module-mt/package.json - 包配置
  • packages/auth-module-mt/src/middleware/auth.middleware.ts - 多租户认证中间件
  • packages/auth-module-mt/src/services/auth.service.ts - 多租户认证服务
  • packages/auth-module-mt/src/routes/login.route.ts - 多租户登录路由
  • packages/auth-module-mt/src/routes/register.route.ts - 多租户注册路由
  • packages/auth-module-mt/src/routes/me.route.ts - 多租户用户信息路由
  • packages/auth-module-mt/src/schemas/auth.schema.ts - 多租户认证schema
  • packages/auth-module-mt/tests/integration/auth.integration.test.ts - 统一的多租户认证集成测试（合并后）
  • packages/auth-module-mt/tests/utils/test-data-factory.ts - 测试数据工厂
  • packages/shared-types/src/index.ts - 更新AuthContext和JWTPayload类型
  • packages/shared-utils/src/utils/jwt.util.ts - 更新JWTUtil支持租户ID
  • packages/user-module-mt/src/entities/user.entity.ts - 更新文件模块导入

已删除文件:

  • packages/auth-module-mt/tests/integration/auth-tenant-isolation.test.ts - 租户认证隔离测试（已合并到auth.integration.test.ts）

QA Results

⏳ 质量保证验证待执行