[REVIEW REQUIRED]feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理 #12

ANGJustinl · 2025-12-18T00:18:33+08:00

ANGJustinl commented

2025-12-18 00:18:33 +08:00

新增完整的 API 状态码文档，并对测试模式进行特殊处理（206 Partial Content）
重组 DTO 结构，引入 app.dto.ts 与 error_response.dto.ts，以实现统一、规范的响应格式
重构登录相关 DTO，优化命名与结构，提升可维护性
实现基于内存的用户服务（users_memory.service.ts），用于开发与测试环境
更新邮件服务，增强验证码生成逻辑，并支持测试模式自动识别
增强登录控制器与服务层的错误处理能力，统一响应行为
优化核心登录服务，强化参数校验并集成邮箱验证流程
新增 @types/express 依赖，提升 TypeScript 类型支持与开发体验
改进 main.ts，优化应用初始化流程与配置管理
在所有服务中统一错误处理机制，采用标准化的错误响应格式
实现测试模式（206）与生产环境邮件发送（200）之间的无缝切换

* 新增完整的 API 状态码文档，并对测试模式进行特殊处理（`206 Partial Content`） * 重组 DTO 结构，引入 `app.dto.ts` 与 `error_response.dto.ts`，以实现统一、规范的响应格式 * 重构登录相关 DTO，优化命名与结构，提升可维护性 * 实现基于内存的用户服务（`users_memory.service.ts`），用于开发与测试环境 * 更新邮件服务，增强验证码生成逻辑，并支持测试模式自动识别 * 增强登录控制器与服务层的错误处理能力，统一响应行为 * 优化核心登录服务，强化参数校验并集成邮箱验证流程 * 新增 `@types/express` 依赖，提升 TypeScript 类型支持与开发体验 * 改进 `main.ts`，优化应用初始化流程与配置管理 * 在所有服务中统一错误处理机制，采用标准化的错误响应格式 * 实现测试模式（`206`）与生产环境邮件发送（`200`）之间的无缝切换

ANGJustinl added 1 commit 2025-12-18 00:18:34 +08:00

feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理 26ea5ac815

* 新增完整的 API 状态码文档，并对测试模式进行特殊处理（`206 Partial Content`）
* 重组 DTO 结构，引入 `app.dto.ts` 与 `error_response.dto.ts`，以实现统一、规范的响应格式
* 重构登录相关 DTO，优化命名与结构，提升可维护性
* 实现基于内存的用户服务（`users_memory.service.ts`），用于开发与测试环境
* 更新邮件服务，增强验证码生成逻辑，并支持测试模式自动识别
* 增强登录控制器与服务层的错误处理能力，统一响应行为
* 优化核心登录服务，强化参数校验并集成邮箱验证流程
* 新增 `@types/express` 依赖，提升 TypeScript 类型支持与开发体验
* 改进 `main.ts`，优化应用初始化流程与配置管理
* 在所有服务中统一错误处理机制，采用标准化的错误响应格式
* 实现测试模式（`206`）与生产环境邮件发送（`200`）之间的无缝切换

ANGJustinl requested review from moyin 2025-12-18 00:18:34 +08:00

ANGJustinl requested review from Owners 2025-12-18 00:18:34 +08:00

ANGJustinl commented

2025-12-18 00:19:24 +08:00

REVIEW REQUIRED]

ANGJustinl changed title from ~~WIP: feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理~~ to WIP: [REVIEW REQUIRED]feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理

2025-12-18 00:19:33 +08:00

moyin approved these changes 2025-12-18 11:33:37 +08:00

Dismissed

moyin requested changes 2025-12-18 12:16:32 +08:00

moyin left a comment

🧪 测试评估报告与修复指南

💡 感谢与提示

非常感谢完善测试部分！在测试过程中，遇到了一些问题，希望能够帮助您解决。

1. 🔍 service文件同步更新：每当修改与增加service文件时，务必同步修改和调整spec文件，确保service文件的方法与函数能通过测试；

2. 📌 工具版本对齐：记得关注关键工具版本，尽可能与原代码版本保持一致；

3. 📝 文档同步完善：在完善业务逻辑或测试逻辑时，可借助AI将新场景补充至docs/systems对应系统模块中，更新模块文档（当前文档仍待完善，欢迎交流调整文档格式与内容，助力未来提供更高质量的文档信息~）

📊 测试结果概览 - 重新验证确认

✅ 通过的测试

验证服务测试 - 86个测试用例全部通过 ✅
用户服务测试 - 所有数据库操作测试通过 ✅
项目编译 - TypeScript编译无错误 ✅
服务启动 - 应用成功启动，所有模块正常加载 ✅
邮件模板测试 - 12个测试用例通过 ✅

❌ 失败的测试

邮件服务测试 - 10个测试用例失败 ❌ 问题确认
登录核心服务测试 - 14个测试用例失败 ❌ 问题确认

🔍 问题分析

🚨 主要测试失败问题

1. 邮件服务测试问题 ✅ 问题确认存在

问题原因：

测试期望返回 boolean 类型
实际服务返回 EmailSendResult 对象类型

具体错误示例：

// 测试期望 (错误的)
expect(result).toBe(true);

// 实际返回 (正确的)
{
  success: true,
  isTestMode: false,
  error?: string
}

实际测试输出：

Expected: true
Received: {"isTestMode": false, "success": true}

2. 登录核心服务测试问题 ✅ 问题确认存在

问题原因：

LoginCoreService 使用了 @Inject('UsersService') 依赖注入
测试配置中使用了 UsersService 而不是字符串 token

具体错误：

Nest can't resolve dependencies of the LoginCoreService (?, EmailService, VerificationService). 
Please make sure that the argument "UsersService" at index [0] is available in the RootTestModule context.

根本原因：

// LoginCoreService 构造函数
constructor(
  @Inject('UsersService') private readonly usersService: any, // 使用字符串token
  private readonly emailService: EmailService,
  private readonly verificationService: VerificationService,
)

// 测试配置 (错误的)
{
  provide: UsersService,  // 应该是字符串 'UsersService'
  useValue: mockUsersService,
}

🔧 其他代码质量问题

3. 测试日志消息不匹配 ⚠️ 测试维护问题

文件位置： src/core/utils/email/email.service.spec.ts

问题详情：

// 测试期望的日志消息
expect(loggerSpy).toHaveBeenCalledWith('=== 邮件发送（测试模式） ===');

// 实际服务输出的日志消息  
this.logger.warn('=== 邮件发送（测试模式 - 邮件未真实发送） ===');

影响：

测试断言失败
测试与实际实现不同步

🛠️ 修复方案

方案一：修复邮件服务测试（推荐）

需要修改的文件： src/core/utils/email/email.service.spec.ts

修改示例：

// 原来的测试
expect(result).toBe(true);

// 修改为
expect(result.success).toBe(true);
expect(result.isTestMode).toBe(false);

// 错误情况测试
expect(result.success).toBe(false);
expect(result.error).toBe('发送失败');

方案二：修复登录核心服务测试

需要修改的文件： src/core/login_core/login_core.service.spec.ts

问题位置： 第58行的依赖注入配置

修复方法：

// 错误的配置
{
  provide: UsersService,
  useValue: mockUsersService,
}

// 正确的配置
{
  provide: 'UsersService',  // 使用字符串token
  useValue: mockUsersService,
}

方案三：清理未使用的导入和定义

需要修改的文件： src/core/login_core/login_core.service.ts

修复方法：

// 移除未使用的导入
import { Injectable, UnauthorizedException, NotFoundException, BadRequestException, Inject } from '@nestjs/common';
// 移除: ConflictException

import { Users } from '../db/users/users.entity';
import { EmailService } from '../utils/email/email.service';
// 移除: EmailSendResult

// 移除未使用的导入
// import * as crypto from 'crypto';

// 移除未使用的私有方法
// private generateVerificationCode(): string { ... }

方案四：修复测试日志消息

需要修改的文件： src/core/utils/email/email.service.spec.ts

修复方法：

// 更新测试期望的日志消息
expect(loggerSpy).toHaveBeenCalledWith('=== 邮件发送（测试模式 - 邮件未真实发送） ===');

📋 测试修复清单

邮件服务测试修复 (10个测试用例)

应该成功发送邮件 - 修改返回值断言
应该在发送失败时返回false - 修改错误处理断言
应该在测试模式下输出邮件内容 - 修改测试模式断言
应该成功发送邮箱验证码 - 修改验证码邮件断言
应该成功发送密码重置验证码 - 修改密码重置断言
应该在发送失败时返回false (验证码) - 修改错误断言
应该成功发送欢迎邮件 - 修改欢迎邮件断言
应该在发送失败时返回false (欢迎邮件) - 修改错误断言
应该正确处理网络错误 - 修改网络错误断言
应该正确处理认证错误 - 修改认证错误断言

登录核心服务测试修复 (14个测试用例)

修复依赖注入配置
确保 UsersService 正确 mock
验证所有测试用例的依赖关系
检查测试模块的导入配置

代码质量优化清单

移除 ConflictException 未使用导入
移除 EmailSendResult 未使用导入
移除 crypto 未使用导入
移除 generateVerificationCode 未使用方法
修复测试日志消息匹配问题

🚀 测试执行指南

1. 运行特定测试文件

# 只测试邮件服务
pnpm test src/core/utils/email/email.service.spec.ts

# 只测试登录核心服务  
pnpm test src/core/login_core/login_core.service.spec.ts

# 只测试验证服务
pnpm test src/core/utils/verification/verification.service.spec.ts

2. 运行测试并查看详细输出

# 详细模式
pnpm test --verbose

# 监听模式（开发时使用）
pnpm test --watch

# 生成覆盖率报告
pnpm test --coverage

3. 调试测试

# 运行单个测试用例
pnpm test --testNamePattern="应该成功发送邮件"

# 运行特定描述块的测试
pnpm test --testNamePattern="sendEmail"

📈 环境配置验证结果

✅ 已验证通过的配置

数据库连接 - MySQL连接正常
Redis服务 - 文件Redis服务工作正常
邮件服务 - SMTP配置正确，可以发送邮件
API接口 - 所有路由正常响应
Swagger文档 - API文档生成正常
依赖安装 - 所有npm包安装成功
TypeScript编译 - 代码编译无错误

🔧 需要注意的配置

依赖版本警告 - NestJS版本混用（v10和v11），建议统一版本
测试配置 - 部分测试的mock配置需要完善
测试维护 - 测试断言与实际实现不同步，需要定期更新

# 🧪 测试评估报告与修复指南 <div style="background: #f8fafc; padding: 16px; border-radius: 8px; border: 1px solid #e2e8f0; margin: 8px 0;"> <div style="display: flex; align-items: center; margin-bottom: 12px;"> <span style="background: #f97316; color: white; padding: 4px 8px; border-radius: 4px; font-size: 14px; font-weight: 1800; margin-right: 8px;">💡 感谢与提示</span> </div> <div style="color: skyblue; margin-bottom: 12px; font-weight: bolder;"> 非常感谢完善测试部分！在测试过程中，遇到了一些问题，希望能够帮助您解决。 </div> <div style="display: flex; flex-direction: column; gap: 8px;"> <div style="display: flex; align-items: flex-start;"> <span style="color: #f97316; font-weight: 600; margin-right: 8px;">1. 🔍</span> <span><strong style="color: #1e293b;">service文件同步更新</strong>：每当修改与增加service文件时，务必同步修改和调整spec文件，确保service文件的方法与函数能通过测试；</span> </div> <div style="display: flex; align-items: flex-start;"> <span style="color: #f97316; font-weight: 600; margin-right: 8px;">2. 📌</span> <span><strong style="color: #1e293b;">工具版本对齐</strong>：记得关注关键工具版本，尽可能与原代码版本保持一致；</span> </div> <div style="display: flex; align-items: flex-start; padding: 8px; background: #fff7ed; border-radius: 6px;"> <span style="color: #ea580c; font-weight: 600; margin-right: 8px;">3. 📝</span> <span><strong style="color: #1e293b;">文档同步完善</strong>：在完善业务逻辑或测试逻辑时，可借助AI将新场景补充至docs/systems对应系统模块中，更新模块文档（当前文档仍待完善，欢迎交流调整文档格式与内容，助力未来提供更高质量的文档信息~）</span> </div> </div> </div> ## 📊 测试结果概览 - 重新验证确认 ### ✅ 通过的测试 - **验证服务测试** - 86个测试用例全部通过 ✅ - **用户服务测试** - 所有数据库操作测试通过 ✅ - **项目编译** - TypeScript编译无错误 ✅ - **服务启动** - 应用成功启动，所有模块正常加载 ✅ - **邮件模板测试** - 12个测试用例通过 ✅ ### ❌ 失败的测试 - **邮件服务测试** - 10个测试用例失败 ❌ **问题确认** - **登录核心服务测试** - 14个测试用例失败 ❌ **问题确认** --- ## 🔍 问题分析 ### 🚨 主要测试失败问题 ### 1. 邮件服务测试问题 ✅ **问题确认存在** **问题原因：** - 测试期望返回 `boolean` 类型 - 实际服务返回 `EmailSendResult` 对象类型 **具体错误示例：** ```typescript // 测试期望 (错误的) expect(result).toBe(true); // 实际返回 (正确的) { success: true, isTestMode: false, error?: string } ``` **实际测试输出：** ``` Expected: true Received: {"isTestMode": false, "success": true} ``` ### 2. 登录核心服务测试问题 ✅ **问题确认存在** **问题原因：** - LoginCoreService 使用了 `@Inject('UsersService')` 依赖注入 - 测试配置中使用了 `UsersService` 而不是字符串 token **具体错误：** ``` Nest can't resolve dependencies of the LoginCoreService (?, EmailService, VerificationService). Please make sure that the argument "UsersService" at index [0] is available in the RootTestModule context. ``` **根本原因：** ```typescript // LoginCoreService 构造函数 constructor( @Inject('UsersService') private readonly usersService: any, // 使用字符串token private readonly emailService: EmailService, private readonly verificationService: VerificationService, ) // 测试配置 (错误的) { provide: UsersService, // 应该是字符串 'UsersService' useValue: mockUsersService, } ``` ### 🔧 其他代码质量问题 #### 3. 测试日志消息不匹配 ⚠️ **测试维护问题** **文件位置：** `src/core/utils/email/email.service.spec.ts` **问题详情：** ```typescript // 测试期望的日志消息 expect(loggerSpy).toHaveBeenCalledWith('=== 邮件发送（测试模式） ==='); // 实际服务输出的日志消息 this.logger.warn('=== 邮件发送（测试模式 - 邮件未真实发送） ==='); ``` **影响：** - 测试断言失败 - 测试与实际实现不同步 --- ## 🛠️ 修复方案 ### 方案一：修复邮件服务测试（推荐） **需要修改的文件：** `src/core/utils/email/email.service.spec.ts` **修改示例：** ```typescript // 原来的测试 expect(result).toBe(true); // 修改为 expect(result.success).toBe(true); expect(result.isTestMode).toBe(false); // 错误情况测试 expect(result.success).toBe(false); expect(result.error).toBe('发送失败'); ``` ### 方案二：修复登录核心服务测试 **需要修改的文件：** `src/core/login_core/login_core.service.spec.ts` **问题位置：** 第58行的依赖注入配置 **修复方法：** ```typescript // 错误的配置 { provide: UsersService, useValue: mockUsersService, } // 正确的配置 { provide: 'UsersService', // 使用字符串token useValue: mockUsersService, } ``` ### 方案三：清理未使用的导入和定义 **需要修改的文件：** `src/core/login_core/login_core.service.ts` **修复方法：** ```typescript // 移除未使用的导入 import { Injectable, UnauthorizedException, NotFoundException, BadRequestException, Inject } from '@nestjs/common'; // 移除: ConflictException import { Users } from '../db/users/users.entity'; import { EmailService } from '../utils/email/email.service'; // 移除: EmailSendResult // 移除未使用的导入 // import * as crypto from 'crypto'; // 移除未使用的私有方法 // private generateVerificationCode(): string { ... } ``` ### 方案四：修复测试日志消息 **需要修改的文件：** `src/core/utils/email/email.service.spec.ts` **修复方法：** ```typescript // 更新测试期望的日志消息 expect(loggerSpy).toHaveBeenCalledWith('=== 邮件发送（测试模式 - 邮件未真实发送） ==='); ``` --- ## 📋 测试修复清单 ### 邮件服务测试修复 (10个测试用例) - [ ] `应该成功发送邮件` - 修改返回值断言 - [ ] `应该在发送失败时返回false` - 修改错误处理断言 - [ ] `应该在测试模式下输出邮件内容` - 修改测试模式断言 - [ ] `应该成功发送邮箱验证码` - 修改验证码邮件断言 - [ ] `应该成功发送密码重置验证码` - 修改密码重置断言 - [ ] `应该在发送失败时返回false` (验证码) - 修改错误断言 - [ ] `应该成功发送欢迎邮件` - 修改欢迎邮件断言 - [ ] `应该在发送失败时返回false` (欢迎邮件) - 修改错误断言 - [ ] `应该正确处理网络错误` - 修改网络错误断言 - [ ] `应该正确处理认证错误` - 修改认证错误断言 ### 登录核心服务测试修复 (14个测试用例) - [ ] 修复依赖注入配置 - [ ] 确保 `UsersService` 正确 mock - [ ] 验证所有测试用例的依赖关系 - [ ] 检查测试模块的导入配置 ### 代码质量优化清单 - [ ] 移除 `ConflictException` 未使用导入 - [ ] 移除 `EmailSendResult` 未使用导入 - [ ] 移除 `crypto` 未使用导入 - [ ] 移除 `generateVerificationCode` 未使用方法 - [ ] 修复测试日志消息匹配问题 --- ## 🚀 测试执行指南 ### 1. 运行特定测试文件 ```bash # 只测试邮件服务 pnpm test src/core/utils/email/email.service.spec.ts # 只测试登录核心服务 pnpm test src/core/login_core/login_core.service.spec.ts # 只测试验证服务 pnpm test src/core/utils/verification/verification.service.spec.ts ``` ### 2. 运行测试并查看详细输出 ```bash # 详细模式 pnpm test --verbose # 监听模式（开发时使用） pnpm test --watch # 生成覆盖率报告 pnpm test --coverage ``` ### 3. 调试测试 ```bash # 运行单个测试用例 pnpm test --testNamePattern="应该成功发送邮件" # 运行特定描述块的测试 pnpm test --testNamePattern="sendEmail" ``` --- ## 📈 环境配置验证结果 ### ✅ 已验证通过的配置 1. **数据库连接** - MySQL连接正常 2. **Redis服务** - 文件Redis服务工作正常 3. **邮件服务** - SMTP配置正确，可以发送邮件 4. **API接口** - 所有路由正常响应 5. **Swagger文档** - API文档生成正常 6. **依赖安装** - 所有npm包安装成功 7. **TypeScript编译** - 代码编译无错误 ### 🔧 需要注意的配置 1. **依赖版本警告** - NestJS版本混用（v10和v11），建议统一版本 2. **测试配置** - 部分测试的mock配置需要完善 3. **测试维护** - 测试断言与实际实现不同步，需要定期更新 ---

moyin commented

2025-12-18 12:20:08 +08:00

@ANGJustinl

👀 1

ANGJustinl added 1 commit 2025-12-18 13:30:23 +08:00

test(email, verification, login): 更新测试中的断言内容, 修复测试error. 6dece752ef

- Replace boolean assertions with structured result object checks in email service tests
- Update email service tests to verify success flag and isTestMode property
- Add error message assertions for failed email sending scenarios
- Change logger spy from 'log' to 'warn' for test mode email output
- Update test message to clarify emails are not actually sent in test mode
- Add code and createdAt properties to verification code stats mock data
- Fix TTL mock value from -1 to -2 to correctly represent non-existent keys
- Replace Inject decorator with direct UsersService type injection in LoginCoreService
- Ensure verification service tests properly mock TTL values during code verification
- Improve test coverage by validating complete response structures instead of simple booleans

ANGJustinl changed title from ~~WIP: [REVIEW REQUIRED]feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理~~ to [REVIEW REQUIRED]feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理

2025-12-18 13:30:50 +08:00

ANGJustinl requested review from moyin 2025-12-18 13:31:05 +08:00

ANGJustinl requested review from Owners 2025-12-18 13:31:10 +08:00

moyin added 1 commit 2025-12-18 14:21:03 +08:00

Merge branch 'main' of https://gitea.xinghangee.icu/datawhale/whale-town-end into ANGJustinl-main d4a7b36129

moyin merged commit d322db242d into main

2025-12-18 14:21:24 +08:00

moyin referenced this issue from a commit

2025-12-18 14:21:26 +08:00

Merge pull request '[REVIEW REQUIRED]feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理' (#12) from ANGJustinl/whale-town-end:main into main

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: datawhale/whale-town-end#12

Allow edits from maintainers