forked from datawhale/whale-town-end
Compare commits
107 Commits
d4a7b36129
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| b142e7de76 | |||
| ece4e6f5a2 | |||
|
|
931ccc4440 | ||
|
|
72bd69655e | ||
|
|
71bc317c57 | ||
|
|
c31cbe559d | ||
|
|
6924416bbd | ||
|
|
0f37130832 | ||
|
|
c2a1c6862d | ||
|
|
569a69c00e | ||
|
|
dd5cc48b49 | ||
|
|
bb796a2469 | ||
| 4fa4bd1a70 | |||
|
|
2bcbaeb030 | ||
|
|
dd91264d0c | ||
|
|
003091494f | ||
|
|
b01ea38a17 | ||
|
|
a30ef52c5a | ||
|
|
d1fc396db7 | ||
|
|
7fd6740090 | ||
|
|
4bda65d593 | ||
| 179f0f66eb | |||
| 1b380e4bb9 | |||
| 9483d6ab20 | |||
|
|
8f9a6e7f9d | ||
| 07d9c736fa | |||
| 5e1afc2875 | |||
|
|
3733717d1f | ||
|
|
470b0b8dbf | ||
|
|
4165a4c03a | ||
|
|
2b87eac495 | ||
| c2ecb3c1a7 | |||
|
|
6ad8d80449 | ||
| fcb81f80d9 | |||
| 065d3f2fc6 | |||
|
|
f335b72f6d | ||
|
|
3bf1b6f474 | ||
|
|
38f9f81b6c | ||
|
|
4818279fac | ||
|
|
270e7e5bd2 | ||
|
|
e282c9dd16 | ||
|
|
d8b7143f60 | ||
|
|
6002f53cbc | ||
| 9cb172d645 | |||
|
|
70c020a97c | ||
| 67ade48ad7 | |||
|
|
29b8b05a2a | ||
| bbf3476d75 | |||
|
|
faf93a30e1 | ||
|
|
2d10131838 | ||
|
|
5140bd1a54 | ||
|
|
3dd5f23d79 | ||
|
|
daaf5c3f22 | ||
|
|
55cfda0532 | ||
| dd856b9ba6 | |||
|
|
07601b6d79 | ||
|
|
7429de3cf4 | ||
|
|
0192934c66 | ||
|
|
64370c3206 | ||
|
|
a78df48101 | ||
|
|
0005dc773c | ||
|
|
946d328be6 | ||
|
|
841a58886e | ||
|
|
91565f716d | ||
| 417b01323e | |||
| b3de6dec5f | |||
|
|
d683f0d5da | ||
|
|
aae77866ac | ||
|
|
8a19bb7daa | ||
| a8e29c6a46 | |||
|
|
9f606abbb2 | ||
|
|
7385c63ffd | ||
| 8d5a44d985 | |||
|
|
d59e9531e2 | ||
| 28a39935b7 | |||
|
|
68debdcb40 | ||
|
|
9ad98f74d9 | ||
|
|
f6fa1ca1e3 | ||
| 578cba39a7 | |||
|
|
404ef5d3e0 | ||
| e537e782a9 | |||
|
|
cb25703892 | ||
| 64230db651 | |||
|
|
612755de63 | ||
|
|
e6d8c28806 | ||
|
|
47a738067a | ||
|
|
85d488a508 | ||
|
|
032c97a1fc | ||
| 0313b78852 | |||
|
|
d80d2c5cb8 | ||
| 2fb46967c7 | |||
|
|
9b35a1c500 | ||
|
|
43c9cbc863 | ||
|
|
a4a3a60db7 | ||
|
|
8166c95af4 | ||
|
|
ec2e346ded | ||
|
|
dd4fb6edd3 | ||
| 17c16588aa | |||
| 8fc2b53c00 | |||
| 4e2f46223e | |||
| f079a80b66 | |||
| bc16187fe0 | |||
|
|
b99b77e08b | ||
| 7afd9a52fa | |||
|
|
7924cfb201 | ||
| d322db242d | |||
|
|
11387f7046 |
133
.env.example
133
.env.example
@@ -1,30 +1,64 @@
|
||||
# 环境配置模板
|
||||
# 复制此文件为 .env 并根据需要修改配置
|
||||
|
||||
# 数据库配置
|
||||
# DB_HOST=localhost
|
||||
# ===========================================
|
||||
# 测试模式配置(开发/测试环境推荐)
|
||||
# ===========================================
|
||||
# 使用以下配置可以在没有数据库和邮件服务器的情况下进行测试
|
||||
# 1. 复制此文件为 .env
|
||||
# 2. 保持数据库和邮件配置为注释状态
|
||||
# 3. 运行 npm run dev 启动服务
|
||||
# 4. 运行测试脚本:./test-api.ps1 (Windows) 或 ./test-api.sh (Linux/macOS)
|
||||
|
||||
# 应用配置
|
||||
NODE_ENV=development
|
||||
PORT=3000
|
||||
LOG_LEVEL=debug
|
||||
|
||||
# ===========================================
|
||||
# 管理员后台配置(开发环境推荐配置)
|
||||
# ===========================================
|
||||
# 管理员Token签名密钥(至少16字符,生产环境务必使用强随机值)
|
||||
ADMIN_TOKEN_SECRET=dev_admin_token_secret_change_me_32chars
|
||||
# 管理员Token有效期(秒),默认8小时
|
||||
ADMIN_TOKEN_TTL_SECONDS=28800
|
||||
|
||||
# 启动引导创建管理员账号(仅当 enabled=true 时生效)
|
||||
ADMIN_BOOTSTRAP_ENABLED=false
|
||||
# ADMIN_USERNAME=admin
|
||||
# ADMIN_PASSWORD=Admin123456
|
||||
# ADMIN_NICKNAME=管理员
|
||||
|
||||
# JWT 配置
|
||||
JWT_SECRET=test_jwt_secret_key_for_development_only_32chars
|
||||
JWT_EXPIRES_IN=7d
|
||||
|
||||
# Redis 配置(测试模式:使用文件存储)
|
||||
USE_FILE_REDIS=true
|
||||
REDIS_HOST=localhost
|
||||
REDIS_PORT=6379
|
||||
REDIS_PASSWORD=
|
||||
REDIS_DB=0
|
||||
|
||||
# ===========================================
|
||||
# 生产环境配置(取消注释并填入真实数据)
|
||||
# ===========================================
|
||||
|
||||
# 数据库配置(生产环境取消注释)
|
||||
# DB_HOST=your_mysql_host
|
||||
# DB_PORT=3306
|
||||
# DB_USERNAME=your_db_username
|
||||
# DB_PASSWORD=your_db_password
|
||||
# DB_NAME=your_db_name
|
||||
|
||||
# 应用配置
|
||||
NODE_ENV=production
|
||||
PORT=3000
|
||||
LOG_LEVEL=info
|
||||
# Redis 配置(生产环境取消注释并设置 USE_FILE_REDIS=false)
|
||||
# USE_FILE_REDIS=false
|
||||
# REDIS_HOST=your_redis_host
|
||||
# REDIS_PORT=6379
|
||||
# REDIS_PASSWORD=your_redis_password
|
||||
# REDIS_DB=0
|
||||
|
||||
# JWT 配置(如果有的话)
|
||||
JWT_SECRET=your_jwt_secret_key_here_at_least_32_characters
|
||||
JWT_EXPIRES_IN=7d
|
||||
|
||||
# Redis 配置(用于验证码存储)
|
||||
# 生产环境使用真实Redis服务
|
||||
USE_FILE_REDIS=false
|
||||
REDIS_HOST=your_redis_host
|
||||
REDIS_PORT=6379
|
||||
REDIS_PASSWORD=your_redis_password
|
||||
REDIS_DB=0
|
||||
|
||||
# 邮件服务配置
|
||||
# 邮件服务配置(生产环境取消注释)
|
||||
# EMAIL_HOST=smtp.gmail.com
|
||||
# EMAIL_PORT=587
|
||||
# EMAIL_SECURE=false
|
||||
@@ -32,5 +66,62 @@ REDIS_DB=0
|
||||
# EMAIL_PASS=your_app_password
|
||||
# EMAIL_FROM="Whale Town Game" <noreply@whaletown.com>
|
||||
|
||||
# 其他配置
|
||||
# 根据项目需要添加其他环境变量
|
||||
# 生产环境设置(生产环境取消注释)
|
||||
# NODE_ENV=production
|
||||
# LOG_LEVEL=info
|
||||
|
||||
# ===========================================
|
||||
# Zulip 集成配置
|
||||
# ===========================================
|
||||
|
||||
# Zulip 服务器配置
|
||||
ZULIP_SERVER_URL=https://zulip.xinghangee.icu/
|
||||
ZULIP_BOT_EMAIL=cbot-bot@zulip.xinghangee.icu
|
||||
ZULIP_BOT_API_KEY=your_bot_api_key
|
||||
|
||||
# Zulip API Key加密密钥(生产环境必须配置,至少32字符)
|
||||
# ZULIP_API_KEY_ENCRYPTION_KEY=your_32_character_encryption_key_here
|
||||
|
||||
# Zulip 错误处理配置
|
||||
ZULIP_DEGRADED_MODE_ENABLED=false
|
||||
ZULIP_AUTO_RECONNECT_ENABLED=true
|
||||
ZULIP_MAX_RECONNECT_ATTEMPTS=5
|
||||
ZULIP_RECONNECT_BASE_DELAY=5000
|
||||
ZULIP_API_TIMEOUT=30000
|
||||
ZULIP_MAX_RETRIES=3
|
||||
|
||||
# Zulip 连接限制配置
|
||||
ZULIP_MAX_CONNECTIONS=100
|
||||
ZULIP_SESSION_TIMEOUT=30
|
||||
ZULIP_CLEANUP_INTERVAL=5
|
||||
|
||||
# Zulip 消息配置
|
||||
ZULIP_MESSAGE_RATE_LIMIT=10
|
||||
ZULIP_MESSAGE_MAX_LENGTH=10000
|
||||
ZULIP_CONTENT_FILTER_ENABLED=true
|
||||
# ZULIP_SENSITIVE_WORDS_PATH=config/zulip/sensitive-words.txt
|
||||
|
||||
# Zulip 允许的Stream列表(逗号分隔,空表示允许所有)
|
||||
# ZULIP_ALLOWED_STREAMS=General,Novice Village,Tavern
|
||||
|
||||
# WebSocket配置
|
||||
# WEBSOCKET_PORT=3000
|
||||
# WEBSOCKET_NAMESPACE=/game
|
||||
# WEBSOCKET_PING_INTERVAL=25000
|
||||
# WEBSOCKET_PING_TIMEOUT=5000
|
||||
|
||||
# ===========================================
|
||||
# 监控配置
|
||||
# ===========================================
|
||||
|
||||
# 健康检查间隔(毫秒)
|
||||
MONITORING_HEALTH_CHECK_INTERVAL=60000
|
||||
|
||||
# 错误率阈值(0-1)
|
||||
MONITORING_ERROR_RATE_THRESHOLD=0.1
|
||||
|
||||
# API响应时间阈值(毫秒)
|
||||
MONITORING_RESPONSE_TIME_THRESHOLD=5000
|
||||
|
||||
# 内存使用阈值(0-1)
|
||||
MONITORING_MEMORY_THRESHOLD=0.9
|
||||
@@ -16,6 +16,16 @@ PORT=3000
|
||||
JWT_SECRET=your_jwt_secret_key_here_at_least_32_characters
|
||||
JWT_EXPIRES_IN=7d
|
||||
|
||||
# 管理员后台配置(生产环境必须配置)
|
||||
ADMIN_TOKEN_SECRET=please_use_a_strong_random_secret_at_least_32_chars
|
||||
ADMIN_TOKEN_TTL_SECONDS=28800
|
||||
|
||||
# 启动引导创建管理员账号(建议仅首次部署临时开启,创建后关闭)
|
||||
ADMIN_BOOTSTRAP_ENABLED=false
|
||||
# ADMIN_USERNAME=admin
|
||||
# ADMIN_PASSWORD=please_set_a_strong_password
|
||||
# ADMIN_NICKNAME=管理员
|
||||
|
||||
# Redis 配置(用于验证码存储)
|
||||
# 生产环境使用真实Redis服务
|
||||
USE_FILE_REDIS=false
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -44,3 +44,5 @@ coverage/
|
||||
|
||||
# Redis数据文件(本地开发用)
|
||||
redis-data/
|
||||
|
||||
.kiro/
|
||||
227
AI代码检查规范_简洁版.md
Normal file
227
AI代码检查规范_简洁版.md
Normal file
@@ -0,0 +1,227 @@
|
||||
# AI代码检查规范(简洁版)
|
||||
|
||||
## 执行原则
|
||||
- **分步执行**:每次只执行一个步骤,完成后等待用户确认
|
||||
- **用户信息收集**:开始前必须收集用户当前日期和名称
|
||||
- **修改验证**:每次修改后必须重新检查该步骤
|
||||
|
||||
## 检查步骤
|
||||
|
||||
### 步骤1:命名规范检查
|
||||
- **文件/文件夹**:snake_case(下划线分隔),严禁kebab-case
|
||||
- **变量/函数**:camelCase
|
||||
- **类/接口**:PascalCase
|
||||
- **常量**:SCREAMING_SNAKE_CASE
|
||||
- **路由**:kebab-case
|
||||
- **文件夹优化**:删除单文件文件夹,扁平化结构
|
||||
- **Core层命名**:业务支撑模块用_core后缀,通用工具模块不用
|
||||
|
||||
#### 文件夹结构检查要求
|
||||
**必须使用listDirectory工具详细检查每个文件夹的内容:**
|
||||
1. 使用`listDirectory(path, depth=2)`获取完整文件夹结构
|
||||
2. 统计每个文件夹内的文件数量
|
||||
3. 识别只有1个文件的文件夹(单文件文件夹)
|
||||
4. 将单文件文件夹中的文件移动到上级目录
|
||||
5. 更新所有相关的import路径引用
|
||||
|
||||
**检查标准:**
|
||||
- 不超过3个文件的文件夹:必须扁平化处理
|
||||
- 4个以上文件:通常保持独立文件夹
|
||||
- 完整功能模块:即使文件较少也可以保持独立(需特殊说明)
|
||||
- **测试文件位置**:测试文件必须与对应源文件放在同一目录,不允许单独的tests文件夹
|
||||
|
||||
**测试文件位置规范(重要):**
|
||||
- ✅ 正确:`src/business/admin/admin.service.ts` 和 `src/business/admin/admin.service.spec.ts` 同目录
|
||||
- ❌ 错误:`src/business/admin/tests/admin.service.spec.ts` 单独tests文件夹
|
||||
- **强制要求**:所有tests/、test/等测试专用文件夹必须扁平化,测试文件移动到源文件同目录
|
||||
- **扁平化处理**:包括tests/、test/、spec/、__tests__/等所有测试文件夹都必须扁平化
|
||||
|
||||
**常见错误:**
|
||||
- 只看文件夹名称,不检查内容
|
||||
- 凭印象判断,不使用工具获取准确数据
|
||||
- 遗漏3个文件以下文件夹的识别
|
||||
- **忽略测试文件夹**:认为tests文件夹是"标准结构"而不进行扁平化检查
|
||||
|
||||
### 步骤2:注释规范检查
|
||||
- **文件头注释**:功能描述、职责分离、修改记录、@author、@version、@since、@lastModified
|
||||
- **类注释**:职责、主要方法、使用场景
|
||||
- **方法注释**:业务逻辑步骤、@param、@returns、@throws、@example
|
||||
- **修改记录**:使用用户提供的日期和名称,格式"日期: 类型 - 内容 (修改者: 名称)"
|
||||
- **@author处理规范**:
|
||||
- **保留原则**:人名必须保留,不得随意修改
|
||||
- **AI标识替换**:只有AI标识(kiro、ChatGPT、Claude、AI等)才可替换为用户名称
|
||||
- **判断示例**:`@author kiro` → 可替换,`@author 张三` → 必须保留
|
||||
- **版本号递增**:规范优化/Bug修复→修订版本+1,功能变更→次版本+1,重构→主版本+1
|
||||
- **时间更新**:只有真正修改了文件内容时才更新@lastModified字段,仅检查不修改内容时不更新日期
|
||||
|
||||
### 步骤3:代码质量检查
|
||||
- **清理未使用**:导入、变量、方法
|
||||
- **常量定义**:使用SCREAMING_SNAKE_CASE
|
||||
- **方法长度**:建议不超过50行
|
||||
- **代码重复**:识别并消除重复代码
|
||||
- **魔法数字**:提取为常量定义
|
||||
- **工具函数**:抽象重复逻辑为可复用函数
|
||||
|
||||
### 步骤4:架构分层检查
|
||||
- **检查范围**:仅检查当前执行检查的文件夹,不考虑其他同层功能模块
|
||||
- **Core层**:专注技术实现,不含业务逻辑
|
||||
- **Core层命名规则**:
|
||||
- **业务支撑模块**:为特定业务功能提供技术支撑,使用`_core`后缀(如:`location_broadcast_core`)
|
||||
- **通用工具模块**:提供可复用的数据访问或技术服务,不使用后缀(如:`user_profiles`、`redis_cache`)
|
||||
- **判断方法**:检查模块是否专门为某个业务服务,如果是则使用`_core`后缀,如果是通用服务则不使用
|
||||
- **Business层**:专注业务逻辑,不含技术实现细节
|
||||
- **依赖关系**:Core层不能导入Business层,Business层通过依赖注入使用Core层
|
||||
- **职责分离**:确保各层职责清晰,边界明确
|
||||
|
||||
### 步骤5:测试覆盖检查
|
||||
- **测试文件存在性**:每个Service必须有.spec.ts文件
|
||||
- **Service定义**:只有以下类型需要测试文件
|
||||
- ✅ **Service类**:文件名包含`.service.ts`的业务逻辑类
|
||||
- ✅ **Controller类**:文件名包含`.controller.ts`的控制器类
|
||||
- ✅ **Gateway类**:文件名包含`.gateway.ts`的WebSocket网关类
|
||||
- ❌ **Middleware类**:中间件不需要测试文件
|
||||
- ❌ **Guard类**:守卫不需要测试文件
|
||||
- ❌ **DTO类**:数据传输对象不需要测试文件
|
||||
- ❌ **Interface文件**:接口定义不需要测试文件
|
||||
- ❌ **Utils工具类**:工具函数不需要测试文件
|
||||
- **方法覆盖**:所有公共方法必须有测试
|
||||
- **场景覆盖**:正常、异常、边界情况
|
||||
- **测试质量**:真实有效的测试用例,不是空壳
|
||||
- **集成测试**:复杂Service需要.integration.spec.ts
|
||||
- **测试执行**:必须执行测试命令验证通过
|
||||
|
||||
### 步骤6:功能文档生成
|
||||
- **README结构**:模块概述、对外接口、内部依赖、核心特性、潜在风险
|
||||
- **接口描述**:每个公共方法一句话功能说明
|
||||
- **依赖分析**:列出所有项目内部依赖及用途
|
||||
- **特性识别**:技术特性、功能特性、质量特性
|
||||
- **风险评估**:技术风险、业务风险、运维风险、安全风险
|
||||
|
||||
## 关键规则
|
||||
|
||||
### 命名规范
|
||||
```typescript
|
||||
// 文件命名
|
||||
✅ user_service.ts, create_user_dto.ts
|
||||
❌ user-service.ts, UserService.ts
|
||||
|
||||
// 变量命名
|
||||
✅ const userName = 'test';
|
||||
❌ const UserName = 'test';
|
||||
|
||||
// 常量命名
|
||||
✅ const MAX_RETRY_COUNT = 3;
|
||||
❌ const maxRetryCount = 3;
|
||||
```
|
||||
|
||||
### 注释规范
|
||||
```typescript
|
||||
/**
|
||||
* 文件功能描述
|
||||
*
|
||||
* 功能描述:
|
||||
* - 功能点1
|
||||
* - 功能点2
|
||||
*
|
||||
* 最近修改:
|
||||
* - [用户日期]: 修改类型 - 修改内容 (修改者: [用户名称])
|
||||
*
|
||||
* @author [处理后的作者名称]
|
||||
* @version x.x.x
|
||||
* @since [创建日期]
|
||||
* @lastModified [用户日期]
|
||||
*/
|
||||
```
|
||||
|
||||
**@author字段处理规则:**
|
||||
- **保留人名**:如果@author是人名,必须保留不变
|
||||
- **替换AI标识**:只有AI标识(kiro、ChatGPT、Claude、AI等)才可替换
|
||||
- **示例**:
|
||||
- `@author kiro` → 可替换为 `@author [用户名称]`
|
||||
- `@author 张三` → 必须保留为 `@author 张三`
|
||||
|
||||
### 架构分层
|
||||
```typescript
|
||||
// Core层 - 业务支撑模块(使用_core后缀)
|
||||
@Injectable()
|
||||
export class LocationBroadcastCoreService {
|
||||
async broadcastPosition(data: PositionData): Promise<void> {
|
||||
// 为位置广播业务提供技术支撑
|
||||
}
|
||||
}
|
||||
|
||||
// Core层 - 通用工具模块(不使用后缀)
|
||||
@Injectable()
|
||||
export class UserProfilesService {
|
||||
async findByUserId(userId: bigint): Promise<UserProfile> {
|
||||
// 通用的用户档案数据访问服务
|
||||
}
|
||||
}
|
||||
|
||||
// Business层 - 业务逻辑
|
||||
@Injectable()
|
||||
export class LocationBroadcastService {
|
||||
constructor(
|
||||
private readonly locationBroadcastCore: LocationBroadcastCoreService,
|
||||
private readonly userProfiles: UserProfilesService
|
||||
) {}
|
||||
|
||||
async updateUserLocation(userId: string, position: Position): Promise<void> {
|
||||
// 业务逻辑:验证、调用Core层、返回结果
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Core层命名判断标准:**
|
||||
- **业务支撑模块**:专门为某个业务功能提供技术支撑 → 使用`_core`后缀
|
||||
- **通用工具模块**:提供可复用的数据访问或基础服务 → 不使用后缀
|
||||
|
||||
### 测试覆盖
|
||||
```typescript
|
||||
describe('UserService', () => {
|
||||
describe('createUser', () => {
|
||||
it('should create user successfully', () => {}); // 正常情况
|
||||
it('should throw error when email exists', () => {}); // 异常情况
|
||||
it('should handle empty name', () => {}); // 边界情况
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
## 执行模板
|
||||
|
||||
每步完成后使用此模板报告:
|
||||
|
||||
```
|
||||
## 步骤X:[步骤名称]检查报告
|
||||
|
||||
### 🔍 检查结果
|
||||
[发现的问题列表]
|
||||
|
||||
### 🛠️ 修正方案
|
||||
[具体修正建议]
|
||||
|
||||
### ✅ 完成状态
|
||||
- 检查项1 ✓/✗
|
||||
- 检查项2 ✓/✗
|
||||
|
||||
**请确认修正方案,确认后进行下一步骤**
|
||||
```
|
||||
|
||||
## 修改验证流程
|
||||
|
||||
修改后必须:
|
||||
1. 重新执行该步骤检查
|
||||
2. 提供验证报告
|
||||
3. 确认问题是否解决
|
||||
4. 等待用户确认
|
||||
|
||||
## 强制要求
|
||||
|
||||
- **用户信息**:开始前必须收集用户日期和名称
|
||||
- **分步执行**:严禁一次执行多步骤
|
||||
- **等待确认**:每步完成后必须等待用户确认
|
||||
- **修改验证**:修改后必须重新检查验证
|
||||
- **测试执行**:步骤5必须执行实际测试命令
|
||||
- **日期使用**:所有日期字段使用用户提供的真实日期
|
||||
- **作者字段保护**:@author字段中的人名不得修改,只有AI标识才可替换
|
||||
- **修改记录强制**:每次修改文件必须添加修改记录和更新@lastModified
|
||||
216
DEPLOYMENT.md
216
DEPLOYMENT.md
@@ -1,216 +0,0 @@
|
||||
# 部署指南
|
||||
|
||||
本文档详细说明如何部署 Pixel Game Server 到生产环境。
|
||||
|
||||
## 前置要求
|
||||
|
||||
- Node.js 18+
|
||||
- pnpm 包管理器
|
||||
- MySQL 8.0+
|
||||
- PM2 进程管理器(推荐)
|
||||
- Nginx(可选,用于反向代理)
|
||||
|
||||
## 部署步骤
|
||||
|
||||
### 1. 服务器环境准备
|
||||
|
||||
```bash
|
||||
# 安装 Node.js (使用 NodeSource 仓库)
|
||||
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
|
||||
sudo apt-get install -y nodejs
|
||||
|
||||
# 安装 pnpm
|
||||
curl -fsSL https://get.pnpm.io/install.sh | sh
|
||||
source ~/.bashrc
|
||||
|
||||
# 安装 PM2
|
||||
npm install -g pm2
|
||||
|
||||
# 安装 MySQL
|
||||
sudo apt update
|
||||
sudo apt install mysql-server
|
||||
sudo mysql_secure_installation
|
||||
```
|
||||
|
||||
### 2. 克隆项目
|
||||
|
||||
```bash
|
||||
# 创建项目目录
|
||||
sudo mkdir -p /var/www
|
||||
cd /var/www
|
||||
|
||||
# 克隆项目(替换为你的实际仓库地址)
|
||||
git clone https://gitea.xinghangee.icu/datawhale/whale-town-end.git
|
||||
cd whale-town-end
|
||||
```
|
||||
|
||||
### 3. 配置环境
|
||||
|
||||
```bash
|
||||
# 复制环境配置文件
|
||||
cp .env.production.example .env.production
|
||||
|
||||
# 编辑环境配置(填入实际的数据库信息)
|
||||
nano .env.production
|
||||
|
||||
# 复制部署脚本
|
||||
cp deploy.sh.example deploy.sh
|
||||
chmod +x deploy.sh
|
||||
|
||||
# 编辑部署脚本(修改路径配置)
|
||||
nano deploy.sh
|
||||
|
||||
# 复制 webhook 处理器
|
||||
cp webhook-handler.js.example webhook-handler.js
|
||||
|
||||
# 编辑 webhook 处理器(修改密钥和路径)
|
||||
nano webhook-handler.js
|
||||
```
|
||||
|
||||
### 4. 数据库设置
|
||||
|
||||
```bash
|
||||
# 登录 MySQL
|
||||
sudo mysql -u root -p
|
||||
|
||||
# 创建数据库和用户
|
||||
CREATE DATABASE pixel_game_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
||||
CREATE USER 'pixel_game'@'localhost' IDENTIFIED BY 'your_secure_password';
|
||||
GRANT ALL PRIVILEGES ON pixel_game_db.* TO 'pixel_game'@'localhost';
|
||||
FLUSH PRIVILEGES;
|
||||
EXIT;
|
||||
```
|
||||
|
||||
### 5. 安装依赖和构建
|
||||
|
||||
```bash
|
||||
# 安装依赖
|
||||
pnpm install --frozen-lockfile
|
||||
|
||||
# 构建项目
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
### 6. 启动服务
|
||||
|
||||
```bash
|
||||
# 使用 PM2 启动应用
|
||||
pm2 start ecosystem.config.js --env production
|
||||
|
||||
# 保存 PM2 配置
|
||||
pm2 save
|
||||
|
||||
# 设置开机自启
|
||||
pm2 startup
|
||||
# 按照提示执行显示的命令
|
||||
```
|
||||
|
||||
### 7. 配置 Nginx(可选)
|
||||
|
||||
创建 Nginx 配置文件:
|
||||
|
||||
```bash
|
||||
sudo nano /etc/nginx/sites-available/whale-town-end
|
||||
```
|
||||
|
||||
添加以下内容:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name your-domain.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:3000;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection 'upgrade';
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_cache_bypass $http_upgrade;
|
||||
}
|
||||
|
||||
location /webhook {
|
||||
proxy_pass http://localhost:9000;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
启用站点:
|
||||
|
||||
```bash
|
||||
sudo ln -s /etc/nginx/sites-available/whale-town-end /etc/nginx/sites-enabled/
|
||||
sudo nginx -t
|
||||
sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
## Gitea Webhook 配置
|
||||
|
||||
1. 在 Gitea 仓库中进入 **Settings** → **Webhooks**
|
||||
2. 点击 **Add Webhook** → **Gitea**
|
||||
3. 配置:
|
||||
- **Target URL**: `http://your-server.com:9000/webhook` 或 `http://your-domain.com/webhook`
|
||||
- **HTTP Method**: `POST`
|
||||
- **POST Content Type**: `application/json`
|
||||
- **Secret**: 与 `webhook-handler.js` 中的 `SECRET` 一致
|
||||
- **Trigger On**: 选择 `Push events`
|
||||
- **Branch filter**: `main`
|
||||
|
||||
## 验证部署
|
||||
|
||||
```bash
|
||||
# 检查服务状态
|
||||
pm2 status
|
||||
|
||||
# 查看日志
|
||||
pm2 logs whale-town-end
|
||||
pm2 logs webhook-handler
|
||||
|
||||
# 测试 API
|
||||
curl http://localhost:3000/
|
||||
curl http://localhost:3000/api-docs
|
||||
```
|
||||
|
||||
## 常用命令
|
||||
|
||||
```bash
|
||||
# 重启服务
|
||||
pm2 restart whale-town-end
|
||||
|
||||
# 查看日志
|
||||
pm2 logs whale-town-end --lines 100
|
||||
|
||||
# 手动部署
|
||||
bash deploy.sh
|
||||
|
||||
# 更新代码(不重启)
|
||||
git pull origin main
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 reload whale-town-end
|
||||
```
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 服务无法启动
|
||||
- 检查环境变量配置
|
||||
- 检查数据库连接
|
||||
- 查看 PM2 日志
|
||||
|
||||
### Webhook 不工作
|
||||
- 检查防火墙设置
|
||||
- 验证 webhook URL 可访问性
|
||||
- 检查 Gitea webhook 日志
|
||||
- 验证签名密钥是否一致
|
||||
|
||||
### 数据库连接失败
|
||||
- 检查 MySQL 服务状态
|
||||
- 验证数据库用户权限
|
||||
- 检查网络连接
|
||||
31
Dockerfile
31
Dockerfile
@@ -1,31 +0,0 @@
|
||||
# 使用官方 Node.js 镜像
|
||||
FROM node:lts-alpine
|
||||
|
||||
# 设置工作目录
|
||||
WORKDIR /app
|
||||
|
||||
# 设置构建参数
|
||||
ARG NPM_REGISTRY=https://registry.npmmirror.com
|
||||
|
||||
# 设置 npm 和 pnpm 镜像源
|
||||
RUN npm config set registry ${NPM_REGISTRY} && \
|
||||
npm install -g pnpm && \
|
||||
pnpm config set registry ${NPM_REGISTRY}
|
||||
|
||||
# 复制 package.json
|
||||
COPY package.json pnpm-workspace.yaml ./
|
||||
|
||||
# 安装依赖
|
||||
RUN pnpm install
|
||||
|
||||
# 复制源代码
|
||||
COPY . .
|
||||
|
||||
# 构建应用
|
||||
RUN pnpm run build
|
||||
|
||||
# 暴露端口
|
||||
EXPOSE 3000
|
||||
|
||||
# 启动应用
|
||||
CMD ["pnpm", "run", "start:prod"]
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Whale Town Team
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
757
README.md
757
README.md
@@ -1,341 +1,470 @@
|
||||
# Pixel Game Server
|
||||
# 🐋 Whale Town - 像素游戏后端服务
|
||||
|
||||
一个基于 NestJS 的 2D 像素风游戏后端服务
|
||||
> 一个基于 NestJS 的现代化 2D 像素风游戏后端服务,采用业务功能模块化架构,支持用户认证、管理员后台、安全防护等完整功能。
|
||||
|
||||
[](https://nodejs.org/)
|
||||
[](https://nestjs.com/)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](./LICENSE)
|
||||
|
||||
## 🎯 项目简介
|
||||
|
||||
Whale Town 是一个功能完整的像素游戏后端服务,采用业务功能模块化架构设计:
|
||||
|
||||
- 🔐 **用户认证模块** - 完整的登录、注册、密码管理、邮箱验证系统
|
||||
- 👥 **用户管理模块** - 用户状态管理、批量操作、状态统计功能
|
||||
- 🛡️ **管理员模块** - 管理员认证、用户管理、密码重置、日志查看
|
||||
- 🔒 **安全模块** - 频率限制、维护模式、超时控制、内容类型检查
|
||||
- 📧 **智能邮件服务** - 支持测试模式和生产模式自动切换
|
||||
- 🗄️ **灵活存储方案** - Redis文件存储 + 内存数据库,支持无依赖测试
|
||||
- 📚 **完整API文档** - Swagger UI + OpenAPI规范,17个接口完整覆盖
|
||||
- 🧪 **全面测试覆盖** - 140个单元测试用例全部通过
|
||||
|
||||
---
|
||||
|
||||
## 🚨 开发者必读警告
|
||||
## 🚀 快速开始
|
||||
|
||||
**⚠️ 在开始任何开发工作之前,请务必阅读:[AI 辅助开发规范指南](./docs/AI辅助开发规范指南.md)**
|
||||
### 📋 环境要求
|
||||
|
||||
**📢 重要提醒:**
|
||||
- 🚫 **未阅读 AI 辅助指南的代码将无法通过审查**
|
||||
- 🤖 **学会使用 AI 助手可以让你的开发效率提升 300%**
|
||||
- 📝 **AI 可以帮你自动生成符合规范的代码和注释**
|
||||
- 🔍 **AI 可以实时检查你的代码质量**
|
||||
- **Node.js** >= 18.0.0 (推荐 24.7.0)
|
||||
- **pnpm** >= 8.0.0 (推荐 10.25.0)
|
||||
|
||||
**👉 [立即阅读 AI 辅助开发指南](./docs/AI辅助开发规范指南.md)**
|
||||
|
||||
---
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **NestJS** `^10.4.20` - 渐进式 Node.js 框架
|
||||
- **TypeScript** `^5.9.3` - 类型安全
|
||||
- **Socket.IO** - WebSocket 实时通信支持
|
||||
- **RxJS** `^7.8.2` - 响应式编程库
|
||||
- **Pino** `^10.1.0` - 高性能日志库
|
||||
- **Jest** `^29.7.0` - 测试框架
|
||||
|
||||
### 核心依赖
|
||||
|
||||
**生产环境:**
|
||||
- `@nestjs/common` `^10.4.20` - NestJS 核心功能
|
||||
- `@nestjs/core` `^10.4.20` - NestJS 核心模块
|
||||
- `@nestjs/config` `^4.0.2` - 配置管理
|
||||
- `@nestjs/platform-express` `^10.4.20` - Express 平台适配器
|
||||
- `@nestjs/websockets` `^10.4.20` - WebSocket 支持
|
||||
- `@nestjs/platform-socket.io` `^10.4.20` - Socket.IO 适配器
|
||||
- `nestjs-pino` `^4.5.0` - Pino 日志集成
|
||||
- `pino` `^10.1.0` - 高性能日志库
|
||||
- `reflect-metadata` `^0.1.14` - 装饰器元数据支持
|
||||
- `rxjs` `^7.8.2` - 响应式编程
|
||||
|
||||
**开发环境:**
|
||||
- `@nestjs/cli` `^10.4.9` - NestJS 命令行工具
|
||||
- `@nestjs/schematics` `^10.2.3` - NestJS 代码生成器
|
||||
- `@nestjs/testing` `^10.4.20` - 测试工具
|
||||
- `@types/jest` `^29.5.14` - Jest 类型定义
|
||||
- `@types/node` `^20.19.26` - Node.js 类型定义
|
||||
- `jest` `^29.7.0` - 测试框架
|
||||
- `ts-jest` `^29.2.5` - TypeScript Jest 支持
|
||||
- `ts-node` `^10.9.2` - TypeScript 运行时
|
||||
- `typescript` `^5.9.3` - TypeScript 编译器
|
||||
- `pino-pretty` `^13.1.3` - Pino 美化输出
|
||||
|
||||
## 🚨 重要:开发前必读
|
||||
|
||||
### ⚠️ 所有开发者必须先阅读 AI 辅助开发指南
|
||||
|
||||
**在开始任何开发工作之前,请务必阅读:[AI 辅助开发规范指南](./docs/AI辅助开发规范指南.md)**
|
||||
|
||||
这个指南将教你如何:
|
||||
- 🤖 使用 AI 助手遵循项目规范
|
||||
- 📝 自动生成规范的代码和注释
|
||||
- 🔍 实时检查代码质量
|
||||
- 🚀 显著提高开发效率和代码质量
|
||||
|
||||
**不阅读此指南直接开发,代码审查将无法通过!**
|
||||
|
||||
---
|
||||
|
||||
## 开发规范
|
||||
|
||||
### 命名规范
|
||||
|
||||
项目采用统一的命名规范,确保代码风格一致:
|
||||
|
||||
- **文件/文件夹**:下划线分隔(如 `order_controller.ts`)
|
||||
- **变量/函数**:小驼峰命名(如 `userName`、`async queryUserInfo()`)
|
||||
- **类/构造函数**:大驼峰命名(如 `UserModel`、`OrderService`)
|
||||
- **常量**:全大写 + 下划线(如 `PORT`、`DB_HOST`)
|
||||
- **接口路由**:全小写 + 短横线(如 `/user/get-info`、`/order/create-order`)
|
||||
|
||||
详细规范请查看:[命名规范文档](./docs/naming_convention.md)
|
||||
|
||||
### Git 提交规范
|
||||
|
||||
项目采用约定式提交规范,提交信息格式:`<类型>:<简短描述>`
|
||||
|
||||
**常用提交类型:**
|
||||
|
||||
- `feat` - 新增功能
|
||||
- `fix` - 修复 Bug
|
||||
- `docs` - 文档更新
|
||||
- `style` - 代码格式调整
|
||||
- `refactor` - 代码重构
|
||||
- `perf` - 性能优化
|
||||
- `test` - 测试相关
|
||||
- `chore` - 构建/工具变动
|
||||
|
||||
**后端特定类型:**
|
||||
|
||||
- `api` - API 接口
|
||||
- `db` - 数据库
|
||||
- `websocket` - WebSocket
|
||||
- `auth` - 认证授权
|
||||
- `dto` - 数据传输对象
|
||||
- `service` - 服务层
|
||||
|
||||
**核心原则:**
|
||||
|
||||
- ⭐ 一次提交只做一件事
|
||||
- 使用中文冒号 `:`
|
||||
- 简短明确(不超过 50 字符)
|
||||
- 能拆分就拆分,保持提交历史清晰
|
||||
|
||||
**示例:**
|
||||
### 🛠️ 安装与运行
|
||||
|
||||
```bash
|
||||
git commit -m "feat:实现玩家注册和登录功能"
|
||||
git commit -m "fix:修复房间加入时的并发问题"
|
||||
git commit -m "api:添加玩家信息查询接口"
|
||||
```
|
||||
# 1. 克隆项目
|
||||
git clone <repository-url>
|
||||
cd whale-town-end
|
||||
|
||||
详细规范请查看:[Git 提交规范文档](./docs/git_commit_guide.md)
|
||||
|
||||
### 后端开发规范
|
||||
|
||||
项目要求严格的代码质量和可维护性标准:
|
||||
|
||||
**核心要求:**
|
||||
|
||||
- **完整注释**:每个模块、类、方法都必须有详细注释
|
||||
- **全面业务逻辑**:考虑所有可能情况,包括异常和边界条件
|
||||
- **关键日志记录**:重要操作必须记录日志,便于问题排查
|
||||
- **防御性编程**:对所有输入进行验证,实现健壮的错误处理
|
||||
|
||||
**注释要求:**
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 玩家服务类
|
||||
*
|
||||
* 职责:处理玩家相关的业务逻辑
|
||||
* 主要方法:createPlayer(), updatePlayerInfo(), getPlayerById()
|
||||
* 使用场景:玩家注册登录流程、个人陈列室数据管理
|
||||
*/
|
||||
@Injectable()
|
||||
export class PlayerService {
|
||||
/**
|
||||
* 创建新玩家
|
||||
* @param email 玩家邮箱地址
|
||||
* @param nickname 玩家昵称
|
||||
* @returns Promise<Player> 创建成功的玩家对象
|
||||
* @throws BadRequestException 当邮箱格式错误时
|
||||
*/
|
||||
async createPlayer(email: string, nickname: string): Promise<Player> {
|
||||
// 详细的业务逻辑实现...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
详细规范请查看:[后端开发规范指南](./docs/backend_development_guide.md)
|
||||
|
||||
## 📚 开发文档
|
||||
|
||||
### 🔥 必读文档
|
||||
- **[AI 辅助开发规范指南](./docs/AI辅助开发规范指南.md)** - 🚨 **所有开发者必读!** 教你如何使用 AI 遵循项目规范
|
||||
|
||||
### 📋 规范文档
|
||||
- [后端开发规范](./docs/backend_development_guide.md) - 注释标准、业务逻辑设计和日志记录要求
|
||||
- [Git 提交规范](./docs/git_commit_guide.md) - Git 提交信息格式和最佳实践
|
||||
- [命名规范](./docs/naming_convention.md) - 项目命名规范和最佳实践
|
||||
- [NestJS 使用指南](./docs/nestjs_guide.md) - 详细的 NestJS 开发指南,包含实战案例
|
||||
|
||||
### 📖 API 文档
|
||||
- **[API 文档总览](./docs/api/README.md)** - API 文档使用指南和快速开始
|
||||
- **[Swagger UI](http://localhost:3000/api-docs)** - 交互式 API 文档(需启动服务器)
|
||||
- [详细接口文档](./docs/api/api-documentation.md) - 完整的 API 接口说明
|
||||
- [OpenAPI 规范](./docs/api/openapi.yaml) - 标准化的 API 描述文件
|
||||
- [Postman 集合](./docs/api/postman-collection.json) - 可导入的 API 测试集合
|
||||
|
||||
### 💡 使用建议
|
||||
1. **开发前**:先读 AI 辅助指南,了解如何用 AI 帮助遵循规范
|
||||
2. **开发中**:参考具体规范文档,使用 AI 实时检查代码质量
|
||||
3. **API 开发**:使用 Swagger UI 进行接口测试,参考 API 文档进行开发
|
||||
4. **提交前**:用 AI 检查代码和提交信息是否符合规范
|
||||
|
||||
## 前置要求
|
||||
|
||||
- **Node.js** >= 18.0.0 默认:24.7.0
|
||||
- **pnpm** >= 8.0.0(推荐)默认:10.25.0
|
||||
|
||||
如果还没有安装 pnpm,请先安装:
|
||||
|
||||
```bash
|
||||
npm install -g pnpm
|
||||
```
|
||||
|
||||
检查版本:
|
||||
|
||||
```bash
|
||||
node --version
|
||||
pnpm --version
|
||||
```
|
||||
|
||||
## 安装依赖
|
||||
|
||||
```bash
|
||||
# 2. 安装依赖
|
||||
pnpm install
|
||||
|
||||
# 3. 配置环境(测试模式,无需数据库和邮件服务器)
|
||||
cp .env.example .env
|
||||
|
||||
# 4. 启动开发服务器
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
## 开发
|
||||
🎉 **服务启动成功!** 访问 http://localhost:3000
|
||||
|
||||
启动开发服务器(支持热重载):
|
||||
### 🧑💻 前端管理界面
|
||||
|
||||
项目包含一个功能完整的前端管理界面,位于 `client/` 目录:
|
||||
|
||||
**🎛️ 核心功能:**
|
||||
- 管理员身份认证(独立Token系统)
|
||||
- 用户列表管理与搜索
|
||||
- 用户密码重置功能
|
||||
- 运行时日志查看与下载
|
||||
- 响应式界面设计
|
||||
|
||||
**🚀 快速启动:**
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
服务器将运行在 `http://localhost:3000`
|
||||
|
||||
## 测试
|
||||
|
||||
运行测试:
|
||||
|
||||
```bash
|
||||
pnpm test
|
||||
```
|
||||
|
||||
运行测试并监听文件变化:
|
||||
|
||||
```bash
|
||||
pnpm test:watch
|
||||
```
|
||||
|
||||
运行测试并生成覆盖率报告:
|
||||
|
||||
```bash
|
||||
pnpm test:cov
|
||||
```
|
||||
|
||||
## 构建
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## 生产环境运行
|
||||
|
||||
```bash
|
||||
pnpm start:prod
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
src/
|
||||
├── api/ # API 接口层(控制器、网关)
|
||||
├── business/ # 业务逻辑层
|
||||
├── core/ # 核心功能模块
|
||||
│ ├── db/ # 数据库相关
|
||||
│ └── utils/ # 工具函数
|
||||
│ └── logger/ # 日志系统
|
||||
├── main.ts # 应用入口
|
||||
├── app.module.ts # 根模块
|
||||
├── app.controller.ts # 根控制器
|
||||
└── app.service.ts # 根服务
|
||||
test/
|
||||
├── api/ # API 测试
|
||||
└── service/ # 服务测试
|
||||
docs/ # 项目文档
|
||||
├── api/ # API 接口文档
|
||||
│ ├── README.md # API 文档使用指南
|
||||
│ ├── api-documentation.md # 详细接口文档
|
||||
│ ├── openapi.yaml # OpenAPI 规范文件
|
||||
│ └── postman-collection.json # Postman 测试集合
|
||||
├── systems/ # 系统设计文档
|
||||
│ ├── logger/ # 日志系统文档
|
||||
│ └── user-auth/ # 用户认证系统文档
|
||||
├── backend_development_guide.md # 后端开发规范
|
||||
├── git_commit_guide.md # Git 提交规范
|
||||
├── naming_convention.md # 命名规范
|
||||
├── nestjs_guide.md # NestJS 使用指南
|
||||
└── AI辅助开发规范指南.md # AI 辅助开发指南
|
||||
```
|
||||
|
||||
## 核心功能
|
||||
|
||||
### 🔐 用户认证系统
|
||||
|
||||
完整的用户认证解决方案,支持多种登录方式和安全特性:
|
||||
|
||||
- 用户名/邮箱/手机号登录
|
||||
- GitHub OAuth 第三方登录
|
||||
- 密码重置和修改功能
|
||||
- bcrypt 密码加密
|
||||
- 基于角色的权限控制
|
||||
|
||||
**详细文档**: [用户认证系统文档](./docs/systems/user-auth/README.md)
|
||||
|
||||
### 📖 API 文档系统
|
||||
|
||||
集成了完整的 API 文档解决方案,提供多种格式的接口文档:
|
||||
|
||||
- **Swagger UI** - 交互式 API 文档界面
|
||||
- **OpenAPI 规范** - 标准化的 API 描述文件
|
||||
- **Postman 集合** - 可导入的 API 测试集合
|
||||
- **详细文档** - 包含示例和最佳实践的完整说明
|
||||
|
||||
**快速访问**:
|
||||
```bash
|
||||
# 启动服务器
|
||||
# 1. 启动后端服务
|
||||
pnpm run dev
|
||||
|
||||
# 访问 Swagger UI 文档
|
||||
# 浏览器打开: http://localhost:3000/api-docs
|
||||
# 2. 启动前端管理界面
|
||||
cd client
|
||||
pnpm install
|
||||
pnpm run dev
|
||||
|
||||
# 3. 访问管理后台
|
||||
# 地址: http://localhost:5173
|
||||
# 默认账号: admin / Admin123456
|
||||
```
|
||||
|
||||
**详细文档**: [API 文档说明](./docs/api/README.md)
|
||||
### 🧪 快速测试
|
||||
|
||||
### 📊 日志系统
|
||||
```bash
|
||||
# 运行综合测试(推荐)
|
||||
.\test-comprehensive.ps1
|
||||
|
||||
基于 Pino 的高性能日志系统,提供结构化日志记录:
|
||||
# 跳过限流测试(更快)
|
||||
.\test-comprehensive.ps1 -SkipThrottleTest
|
||||
|
||||
- 高性能日志记录
|
||||
- 自动敏感信息过滤
|
||||
- 多级别日志控制
|
||||
- 请求上下文绑定
|
||||
# 测试远程服务器
|
||||
.\test-comprehensive.ps1 -BaseUrl "https://your-server.com"
|
||||
```
|
||||
|
||||
**详细文档**: [日志系统文档](./docs/systems/logger/README.md)
|
||||
**测试内容:**
|
||||
- ✅ 应用状态检查
|
||||
- ✅ 邮箱验证码发送与验证
|
||||
- ✅ 用户注册与登录
|
||||
- ✅ 验证码登录功能
|
||||
- ✅ 密码重置流程
|
||||
- ✅ 邮箱冲突检测
|
||||
- ✅ 验证码冷却时间清除
|
||||
- ✅ 限流保护机制
|
||||
- ✅ Redis文件存储功能
|
||||
- ✅ 邮件测试模式
|
||||
|
||||
**💡 提示:使用 [AI 辅助开发指南](./docs/AI辅助开发规范指南.md) 可以让 AI 帮你自动生成符合规范的代码!**
|
||||
---
|
||||
|
||||
## 下一步
|
||||
## 🎓 新开发者指南
|
||||
|
||||
- 在 `src/api/` 目录下创建游戏相关的控制器和网关
|
||||
- 在 `src/model/` 目录下定义游戏数据模型
|
||||
- 在 `src/service/` 目录下实现游戏业务逻辑
|
||||
- 使用 NestJS CLI 快速生成模块:`nest g module game`
|
||||
- 添加 WebSocket 网关实现实时游戏逻辑
|
||||
### 第一步:了解项目规范 📚
|
||||
|
||||
**⚠️ 重要:在开始开发前,请务必阅读以下文档**
|
||||
|
||||
1. **[AI辅助开发规范指南](./docs/AI辅助开发规范指南.md)** 🤖
|
||||
- 学会使用AI助手提升开发效率300%
|
||||
- 自动生成符合规范的代码和注释
|
||||
- 实时检查代码质量
|
||||
|
||||
2. **[后端开发规范](./docs/backend_development_guide.md)** 📝
|
||||
- 代码注释标准
|
||||
- 业务逻辑设计原则
|
||||
- 日志记录要求
|
||||
|
||||
3. **[Git提交规范](./docs/git_commit_guide.md)** 🔄
|
||||
- 提交信息格式
|
||||
- 分支管理策略
|
||||
|
||||
### 第二步:熟悉项目架构 🏗️
|
||||
|
||||
**📁 项目文件结构总览**
|
||||
|
||||
```
|
||||
whale-town-end/ # 🐋 项目根目录
|
||||
├── 📂 src/ # 源代码目录
|
||||
│ ├── 📂 business/ # 🎯 业务功能模块(按功能组织)
|
||||
│ │ ├── 📂 auth/ # 🔐 用户认证模块
|
||||
│ │ ├── 📂 user-mgmt/ # 👥 用户管理模块
|
||||
│ │ ├── 📂 admin/ # 🛡️ 管理员模块
|
||||
│ │ ├── 📂 security/ # 🔒 安全防护模块
|
||||
│ │ ├── 📂 zulip/ # 💬 Zulip集成模块
|
||||
│ │ └── 📂 shared/ # 🔗 共享业务组件
|
||||
│ ├── 📂 core/ # ⚙️ 核心技术服务
|
||||
│ │ ├── 📂 db/ # 🗄️ 数据库层(MySQL/内存双模式)
|
||||
│ │ ├── 📂 redis/ # 🔴 Redis缓存(真实Redis/文件存储)
|
||||
│ │ ├── 📂 login_core/ # 🔑 登录核心服务
|
||||
│ │ ├── 📂 admin_core/ # 👑 管理员核心服务
|
||||
│ │ ├── 📂 zulip/ # 💬 Zulip核心服务
|
||||
│ │ └── 📂 utils/ # 🛠️ 工具服务(邮件、验证码、日志)
|
||||
│ ├── 📄 app.module.ts # 🏠 应用主模块
|
||||
│ └── 📄 main.ts # 🚀 应用入口点
|
||||
├── 📂 client/ # 🎨 前端管理界面
|
||||
│ ├── 📂 src/ # 前端源码
|
||||
│ ├── 📂 dist/ # 前端构建产物
|
||||
│ ├── 📄 package.json # 前端依赖配置
|
||||
│ └── 📄 vite.config.ts # Vite构建配置
|
||||
├── 📂 docs/ # 📚 项目文档中心
|
||||
│ ├── 📂 api/ # 🔌 API接口文档
|
||||
│ ├── 📂 development/ # 💻 开发指南
|
||||
│ ├── 📂 deployment/ # 🚀 部署文档
|
||||
│ ├── 📄 ARCHITECTURE.md # 🏗️ 架构设计文档
|
||||
│ └── 📄 README.md # 📖 文档导航中心
|
||||
├── 📂 test/ # 🧪 测试文件目录
|
||||
├── 📂 config/ # ⚙️ 配置文件目录
|
||||
├── 📂 logs/ # 📝 日志文件存储
|
||||
├── 📂 redis-data/ # 💾 Redis文件存储数据
|
||||
├── 📂 dist/ # 📦 后端构建产物
|
||||
├── 📄 .env # 🔧 环境变量配置
|
||||
├── 📄 package.json # 📋 项目依赖配置
|
||||
├── 📄 docker-compose.yml # 🐳 Docker编排配置
|
||||
├── 📄 Dockerfile # 🐳 Docker镜像配置
|
||||
└── 📄 README.md # 📖 项目主文档(当前文件)
|
||||
```
|
||||
|
||||
**架构特点:**
|
||||
- 🏗️ **业务功能模块化** - 按业务功能而非技术组件组织代码
|
||||
- 🔄 **双模式支持** - 开发测试模式 + 生产部署模式
|
||||
- 📦 **清晰分层** - 业务层 → 核心层 → 数据层
|
||||
- 🧪 **测试友好** - 完整的单元测试和集成测试覆盖
|
||||
|
||||
### 第三步:体验核心功能 🎮
|
||||
|
||||
1. **API文档系统** 📖
|
||||
```bash
|
||||
# 启动服务后访问
|
||||
http://localhost:3000/api-docs
|
||||
```
|
||||
|
||||
2. **用户认证系统** 🔐
|
||||
- 邮箱验证码注册
|
||||
- 多方式登录(用户名/邮箱/手机号)
|
||||
- 密码重置功能
|
||||
|
||||
3. **实时通信** 🌐
|
||||
- WebSocket支持
|
||||
- Socket.IO集成
|
||||
|
||||
### 第四步:开始贡献 🤝
|
||||
|
||||
1. **Fork项目** 到你的Gitea账户
|
||||
2. **创建功能分支**:`git checkout -b feature/your-feature`
|
||||
3. **遵循规范开发**(使用AI助手帮助)
|
||||
4. **提交代码**:`git commit -m "feat:添加新功能"`
|
||||
5. **创建Pull Request**
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 技术栈
|
||||
|
||||
### 🚀 核心框架
|
||||
- **NestJS** `^11.1.9` - 企业级Node.js框架,提供依赖注入、模块化等特性
|
||||
- **TypeScript** `^5.9.3` - 类型安全的JavaScript超集
|
||||
- **Express** `^10.4.20` - 基于Express的HTTP服务器
|
||||
- **RxJS** `^7.8.2` - 响应式编程库,处理异步数据流
|
||||
|
||||
### 🌐 实时通信
|
||||
- **Socket.IO** `^10.4.20` - WebSocket实时双向通信
|
||||
- **@nestjs/websockets** - NestJS WebSocket网关支持
|
||||
- **@nestjs/platform-socket.io** - Socket.IO平台适配器
|
||||
|
||||
### 🗄️ 数据存储
|
||||
- **TypeORM** `^0.3.28` - 强大的ORM框架,支持多种数据库
|
||||
- **MySQL2** `^3.16.0` - 高性能MySQL驱动
|
||||
- **IORedis** `^5.8.2` - Redis客户端,支持集群和哨兵模式
|
||||
- **文件存储** - 自研Redis文件存储适配器,支持无Redis开发
|
||||
|
||||
### 🔐 安全认证
|
||||
- **bcrypt** `^6.0.0` - 密码加密哈希算法
|
||||
- **class-validator** `^0.14.3` - 数据验证装饰器
|
||||
- **class-transformer** `^0.5.1` - 对象转换和序列化
|
||||
|
||||
### 📧 通信服务
|
||||
- **Nodemailer** `^6.10.1` - 邮件发送服务
|
||||
- **Axios** `^1.13.2` - HTTP客户端,支持第三方API调用
|
||||
|
||||
### 📚 API文档
|
||||
- **Swagger UI** `^5.0.1` - 交互式API文档界面
|
||||
- **@nestjs/swagger** `^11.2.3` - NestJS Swagger集成
|
||||
|
||||
### 🧑💻 管理员后台(前端)
|
||||
- **Vite** - 前端构建工具(本项目 admin dashboard 使用)
|
||||
- **React** - 前端 UI 框架
|
||||
- **React Router** - 前端路由
|
||||
- **Ant Design** - 企业级 UI 组件库
|
||||
|
||||
### 📊 日志监控
|
||||
- **Pino** `^10.1.0` - 高性能结构化日志库
|
||||
- **nestjs-pino** `^4.5.0` - NestJS Pino集成
|
||||
- **pino-pretty** `^13.1.3` - Pino日志美化输出
|
||||
|
||||
### 🧪 测试框架
|
||||
- **Jest** `^29.7.0` - JavaScript测试框架
|
||||
- **Supertest** `^7.1.4` - HTTP断言测试
|
||||
- **@nestjs/testing** `^10.4.20` - NestJS测试工具
|
||||
|
||||
### ⚙️ 开发工具
|
||||
- **@nestjs/cli** `^10.4.9` - NestJS命令行工具
|
||||
- **ts-jest** `^29.2.5` - TypeScript Jest支持
|
||||
- **ts-node** `^10.9.2` - TypeScript运行时
|
||||
- **pnpm** - 快速、节省磁盘空间的包管理器
|
||||
|
||||
### 🔄 任务调度
|
||||
- **@nestjs/schedule** `^4.1.2` - 定时任务和计划任务支持
|
||||
|
||||
### 📦 构建部署
|
||||
- **Docker** - 容器化部署
|
||||
- **PM2** - 生产环境进程管理
|
||||
- **Nginx** - 反向代理和负载均衡
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ 核心功能
|
||||
|
||||
### 🔐 用户认证模块 (business/auth/)
|
||||
- **多方式登录** - 用户名/邮箱/手机号
|
||||
- **邮箱验证** - 完整的验证码流程
|
||||
- **密码安全** - bcrypt加密 + 强度验证
|
||||
- **第三方登录** - GitHub OAuth支持
|
||||
- **密码管理** - 忘记密码、重置密码、修改密码
|
||||
|
||||
### 👥 用户管理模块 (business/user-mgmt/)
|
||||
- **用户状态管理** - 6种状态控制(active、inactive、locked、banned、deleted、pending)
|
||||
- **批量操作** - 批量修改用户状态
|
||||
- **状态统计** - 各状态用户数量统计
|
||||
- **状态变更日志** - 完整的审计日志
|
||||
|
||||
### 🛡️ 管理员模块 (business/admin/)
|
||||
- **独立认证** - 专用Token系统,与用户系统隔离
|
||||
- **用户管理** - 用户列表、搜索、密码重置
|
||||
- **日志监控** - 实时日志查看、历史日志下载
|
||||
- **权限控制** - 管理员角色验证(role=9)
|
||||
|
||||
### 🔒 安全模块 (business/security/)
|
||||
- **频率限制** - 基于IP的请求频率控制
|
||||
- **维护模式** - 系统维护期间的访问控制
|
||||
- **内容类型验证** - HTTP请求内容类型检查
|
||||
- **超时控制** - 可配置的请求超时机制
|
||||
|
||||
### 📧 智能邮件服务
|
||||
- **测试模式** - 控制台输出,无需SMTP服务器
|
||||
- **生产模式** - 支持主流邮件服务商
|
||||
- **模板系统** - 验证码、欢迎邮件等模板
|
||||
- **自动切换** - 根据配置自动选择模式
|
||||
|
||||
### 🗄️ 灵活存储方案
|
||||
- **Redis文件存储** - 开发测试无需Redis服务器
|
||||
- **内存数据库** - 无需MySQL即可运行
|
||||
- **生产就绪** - 支持MySQL + Redis部署
|
||||
- **自动切换** - 根据配置自动选择存储方式
|
||||
|
||||
### 📚 完整API文档
|
||||
- **Swagger UI** - 交互式API文档
|
||||
- **OpenAPI规范** - 标准化接口描述
|
||||
- **Postman集合** - 可导入的测试集合
|
||||
- **实时更新** - 代码变更自动同步文档
|
||||
|
||||
### 🧪 全面测试覆盖
|
||||
- **单元测试** - 140个测试用例全部通过
|
||||
- **API测试** - 跨平台测试脚本
|
||||
- **集成测试** - 完整业务流程验证
|
||||
- **测试模式** - 无依赖快速测试
|
||||
|
||||
---
|
||||
|
||||
## 📊 开发与测试
|
||||
|
||||
### 🔧 开发命令
|
||||
|
||||
```bash
|
||||
# 开发服务器(热重载)
|
||||
pnpm run dev
|
||||
|
||||
# 构建项目
|
||||
pnpm run build
|
||||
|
||||
# 生产环境运行
|
||||
pnpm run start:prod
|
||||
|
||||
# 代码检查
|
||||
pnpm run lint
|
||||
|
||||
# 格式化代码
|
||||
pnpm run format
|
||||
```
|
||||
|
||||
### 🧪 测试命令
|
||||
|
||||
```bash
|
||||
# 运行所有单元测试
|
||||
pnpm test
|
||||
|
||||
# 监听模式运行测试
|
||||
pnpm run test:watch
|
||||
|
||||
# 生成测试覆盖率报告
|
||||
pnpm run test:cov
|
||||
|
||||
# API功能测试(综合测试脚本)
|
||||
.\test-comprehensive.ps1
|
||||
```
|
||||
|
||||
### 📈 测试覆盖率
|
||||
|
||||
- **单元测试**: 140个测试用例 ✅
|
||||
- **功能测试**: 用户认证、用户管理、管理员后台、安全防护 ✅
|
||||
- **集成测试**: 完整业务流程 ✅
|
||||
|
||||
---
|
||||
|
||||
## 🌍 部署配置
|
||||
|
||||
### 测试环境(默认)
|
||||
```bash
|
||||
# 无需数据库和邮件服务器
|
||||
USE_FILE_REDIS=true
|
||||
NODE_ENV=development
|
||||
# 数据库和邮件配置保持注释状态
|
||||
```
|
||||
|
||||
### 生产环境
|
||||
```bash
|
||||
# 启用真实服务
|
||||
USE_FILE_REDIS=false
|
||||
NODE_ENV=production
|
||||
|
||||
# 配置数据库
|
||||
DB_HOST=your_mysql_host
|
||||
DB_USERNAME=your_username
|
||||
DB_PASSWORD=your_password
|
||||
|
||||
# 配置Redis
|
||||
REDIS_HOST=your_redis_host
|
||||
REDIS_PASSWORD=your_password
|
||||
|
||||
# 配置邮件服务
|
||||
EMAIL_HOST=smtp.gmail.com
|
||||
EMAIL_USER=your_email@gmail.com
|
||||
EMAIL_PASS=your_app_password
|
||||
```
|
||||
|
||||
详细部署指南:[DEPLOYMENT.md](./DEPLOYMENT.md)
|
||||
|
||||
---
|
||||
|
||||
## 📚 文档中心
|
||||
|
||||
### 🎯 新手必读
|
||||
1. **[AI辅助开发指南](./docs/AI辅助开发规范指南.md)** - 提升开发效率300%
|
||||
2. **[后端开发规范](./docs/backend_development_guide.md)** - 代码质量标准
|
||||
3. **[Git提交规范](./docs/git_commit_guide.md)** - 版本控制最佳实践
|
||||
|
||||
### 📖 API文档
|
||||
- **[Swagger UI](http://localhost:3000/api-docs)** - 交互式API文档
|
||||
- **[API文档总览](./docs/api/README.md)** - 使用指南
|
||||
- **[OpenAPI规范](./docs/api/openapi.yaml)** - 标准化描述
|
||||
- **[Postman集合](./docs/api/postman-collection.json)** - 测试集合
|
||||
|
||||
### 🏗️ 系统设计
|
||||
- **[架构文档](./docs/ARCHITECTURE.md)** - 系统架构设计
|
||||
- **[部署指南](./docs/deployment/DEPLOYMENT.md)** - 生产环境部署
|
||||
|
||||
### 🧪 测试指南
|
||||
- **[测试指南](./docs/development/TESTING.md)** - 完整测试说明
|
||||
- **[单元测试](./src/**/*.spec.ts)** - 测试用例参考
|
||||
|
||||
---
|
||||
|
||||
## 🤝 贡献者
|
||||
|
||||
感谢所有为项目做出贡献的开发者!
|
||||
|
||||
### 🏆 核心团队
|
||||
- **[moyin](https://gitea.xinghangee.icu/moyin)** - 核心开发者
|
||||
- **[jianuo](https://gitea.xinghangee.icu/jianuo)** - 核心开发者
|
||||
- **[angjustinl](https://gitea.xinghangee.icu/ANGJustinl)** - 核心开发者
|
||||
|
||||
查看完整贡献者名单:[docs/CONTRIBUTORS.md](./docs/CONTRIBUTORS.md)
|
||||
|
||||
### 🌟 如何贡献
|
||||
|
||||
我们欢迎所有形式的贡献:
|
||||
|
||||
1. **<EFBFBD> Bug修复** - 发现并修复问题
|
||||
2. **✨ 新功能** - 添加有价值的功能
|
||||
3. **<EFBFBD> 文档改馈进** - 完善项目文档
|
||||
4. **🧪 测试用例** - 提高代码覆盖率
|
||||
5. **💡 建议反馈** - 提出改进建议
|
||||
|
||||
**贡献流程:**
|
||||
1. Fork项目 → 2. 创建分支 → 3. 开发功能 → 4. 提交PR
|
||||
|
||||
---
|
||||
|
||||
## 📞 联系我们
|
||||
|
||||
- **项目地址**: [Gitea Repository](https://gitea.xinghangee.icu/datawhale/whale-town-end)
|
||||
- **问题反馈**: [Issues](https://gitea.xinghangee.icu/datawhale/whale-town-end/issues)
|
||||
- **功能建议**: [Discussions](https://gitea.xinghangee.icu/datawhale/whale-town-end/discussions)
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目采用 [MIT License](./LICENSE) 开源协议。
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🐋 Whale Town - 让像素世界更精彩!**
|
||||
|
||||
Made with ❤️ by the Whale Town Team
|
||||
|
||||
[⭐ Star](https://gitea.xinghangee.icu/datawhale/whale-town-end) | [🍴 Fork](https://gitea.xinghangee.icu/datawhale/whale-town-end/fork) | [📖 Docs](./docs/) | [🐛 Issues](https://gitea.xinghangee.icu/datawhale/whale-town-end/issues)
|
||||
|
||||
</div>
|
||||
@@ -1,112 +0,0 @@
|
||||
# 验证码问题调试脚本
|
||||
# 作者: moyin
|
||||
# 日期: 2025-12-17
|
||||
|
||||
$baseUrl = "http://localhost:3000"
|
||||
$testEmail = "debug@example.com"
|
||||
|
||||
Write-Host "=== 验证码问题调试脚本 ===" -ForegroundColor Green
|
||||
|
||||
# 步骤1: 发送验证码
|
||||
Write-Host "`n1. 发送验证码..." -ForegroundColor Yellow
|
||||
$sendBody = @{
|
||||
email = $testEmail
|
||||
} | ConvertTo-Json
|
||||
|
||||
try {
|
||||
$sendResponse = Invoke-RestMethod -Uri "$baseUrl/auth/send-email-verification" -Method POST -Body $sendBody -ContentType "application/json"
|
||||
Write-Host "发送响应: $($sendResponse | ConvertTo-Json -Depth 3)" -ForegroundColor Cyan
|
||||
|
||||
if ($sendResponse.success) {
|
||||
Write-Host "✅ 验证码发送成功" -ForegroundColor Green
|
||||
|
||||
# 步骤2: 立即查看验证码调试信息
|
||||
Write-Host "`n2. 查看验证码调试信息..." -ForegroundColor Yellow
|
||||
$debugResponse = Invoke-RestMethod -Uri "$baseUrl/auth/debug-verification-code" -Method POST -Body $sendBody -ContentType "application/json"
|
||||
Write-Host "调试信息: $($debugResponse | ConvertTo-Json -Depth 5)" -ForegroundColor Cyan
|
||||
|
||||
# 步骤3: 故意输入错误验证码
|
||||
Write-Host "`n3. 测试错误验证码..." -ForegroundColor Yellow
|
||||
$wrongVerifyBody = @{
|
||||
email = $testEmail
|
||||
verification_code = "000000"
|
||||
} | ConvertTo-Json
|
||||
|
||||
try {
|
||||
$wrongResponse = Invoke-RestMethod -Uri "$baseUrl/auth/verify-email" -Method POST -Body $wrongVerifyBody -ContentType "application/json"
|
||||
Write-Host "错误验证响应: $($wrongResponse | ConvertTo-Json -Depth 3)" -ForegroundColor Red
|
||||
} catch {
|
||||
Write-Host "错误验证失败(预期): $($_.Exception.Message)" -ForegroundColor Yellow
|
||||
if ($_.Exception.Response) {
|
||||
$errorResponse = $_.Exception.Response.GetResponseStream()
|
||||
$reader = New-Object System.IO.StreamReader($errorResponse)
|
||||
$errorBody = $reader.ReadToEnd()
|
||||
Write-Host "错误详情: $errorBody" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
|
||||
# 步骤4: 再次查看调试信息
|
||||
Write-Host "`n4. 错误验证后的调试信息..." -ForegroundColor Yellow
|
||||
$debugResponse2 = Invoke-RestMethod -Uri "$baseUrl/auth/debug-verification-code" -Method POST -Body $sendBody -ContentType "application/json"
|
||||
Write-Host "调试信息: $($debugResponse2 | ConvertTo-Json -Depth 5)" -ForegroundColor Cyan
|
||||
|
||||
# 步骤5: 再次尝试错误验证码
|
||||
Write-Host "`n5. 再次测试错误验证码..." -ForegroundColor Yellow
|
||||
try {
|
||||
$wrongResponse2 = Invoke-RestMethod -Uri "$baseUrl/auth/verify-email" -Method POST -Body $wrongVerifyBody -ContentType "application/json"
|
||||
Write-Host "第二次错误验证响应: $($wrongResponse2 | ConvertTo-Json -Depth 3)" -ForegroundColor Red
|
||||
} catch {
|
||||
Write-Host "第二次错误验证失败: $($_.Exception.Message)" -ForegroundColor Yellow
|
||||
if ($_.Exception.Response) {
|
||||
$errorResponse = $_.Exception.Response.GetResponseStream()
|
||||
$reader = New-Object System.IO.StreamReader($errorResponse)
|
||||
$errorBody = $reader.ReadToEnd()
|
||||
Write-Host "错误详情: $errorBody" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
|
||||
# 步骤6: 最终调试信息
|
||||
Write-Host "`n6. 最终调试信息..." -ForegroundColor Yellow
|
||||
$debugResponse3 = Invoke-RestMethod -Uri "$baseUrl/auth/debug-verification-code" -Method POST -Body $sendBody -ContentType "application/json"
|
||||
Write-Host "最终调试信息: $($debugResponse3 | ConvertTo-Json -Depth 5)" -ForegroundColor Cyan
|
||||
|
||||
# 步骤7: 使用正确验证码(如果有的话)
|
||||
if ($sendResponse.data.verification_code) {
|
||||
Write-Host "`n7. 使用正确验证码..." -ForegroundColor Yellow
|
||||
$correctVerifyBody = @{
|
||||
email = $testEmail
|
||||
verification_code = $sendResponse.data.verification_code
|
||||
} | ConvertTo-Json
|
||||
|
||||
try {
|
||||
$correctResponse = Invoke-RestMethod -Uri "$baseUrl/auth/verify-email" -Method POST -Body $correctVerifyBody -ContentType "application/json"
|
||||
Write-Host "正确验证响应: $($correctResponse | ConvertTo-Json -Depth 3)" -ForegroundColor Green
|
||||
} catch {
|
||||
Write-Host "正确验证也失败了: $($_.Exception.Message)" -ForegroundColor Red
|
||||
if ($_.Exception.Response) {
|
||||
$errorResponse = $_.Exception.Response.GetResponseStream()
|
||||
$reader = New-Object System.IO.StreamReader($errorResponse)
|
||||
$errorBody = $reader.ReadToEnd()
|
||||
Write-Host "错误详情: $errorBody" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} else {
|
||||
Write-Host "❌ 验证码发送失败: $($sendResponse.message)" -ForegroundColor Red
|
||||
}
|
||||
} catch {
|
||||
Write-Host "❌ 请求失败: $($_.Exception.Message)" -ForegroundColor Red
|
||||
if ($_.Exception.Response) {
|
||||
$errorResponse = $_.Exception.Response.GetResponseStream()
|
||||
$reader = New-Object System.IO.StreamReader($errorResponse)
|
||||
$errorBody = $reader.ReadToEnd()
|
||||
Write-Host "错误详情: $errorBody" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
|
||||
Write-Host "`n=== 调试完成 ===" -ForegroundColor Green
|
||||
Write-Host "请查看上述输出,重点关注:" -ForegroundColor Yellow
|
||||
Write-Host "1. TTL值的变化" -ForegroundColor White
|
||||
Write-Host "2. attempts字段的变化" -ForegroundColor White
|
||||
Write-Host "3. 验证码是否被意外删除" -ForegroundColor White
|
||||
4
client/.env.example
Normal file
4
client/.env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# 前端后台配置
|
||||
# 复制为 .env.local
|
||||
|
||||
VITE_API_BASE_URL=http://localhost:3000
|
||||
222
client/README.md
Normal file
222
client/README.md
Normal file
@@ -0,0 +1,222 @@
|
||||
# 🎛️ Whale Town 管理员前端界面
|
||||
|
||||
基于 React + Vite + Ant Design 构建的现代化管理员后台界面。
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 📋 环境要求
|
||||
- Node.js >= 18.0.0
|
||||
- pnpm >= 8.0.0
|
||||
|
||||
### 🛠️ 安装与运行
|
||||
|
||||
```bash
|
||||
# 1. 确保后端服务已启动
|
||||
cd ..
|
||||
pnpm run dev
|
||||
|
||||
# 2. 安装前端依赖
|
||||
cd client
|
||||
pnpm install
|
||||
|
||||
# 3. 启动开发服务器
|
||||
pnpm run dev
|
||||
|
||||
# 4. 访问管理界面
|
||||
# 浏览器打开: http://localhost:5173
|
||||
```
|
||||
|
||||
### 🔑 默认登录信息
|
||||
- **用户名**: admin
|
||||
- **密码**: Admin123456
|
||||
|
||||
## 🎯 核心功能
|
||||
|
||||
### 🔐 管理员认证
|
||||
- 独立的Token认证系统
|
||||
- 安全的登录验证
|
||||
- 自动Token刷新
|
||||
|
||||
### 👥 用户管理
|
||||
- 用户列表查看和搜索
|
||||
- 用户状态管理
|
||||
- 用户密码重置
|
||||
- 分页和排序功能
|
||||
|
||||
### 📊 系统监控
|
||||
- 实时日志查看
|
||||
- 日志文件下载
|
||||
- 系统状态监控
|
||||
|
||||
### 🎨 界面特性
|
||||
- 响应式设计,支持移动端
|
||||
- 现代化UI组件
|
||||
- 暗色/亮色主题切换
|
||||
- 国际化支持
|
||||
|
||||
## 🏗️ 技术栈
|
||||
|
||||
### 🚀 核心框架
|
||||
- **React** `^18.0.0` - 前端UI框架
|
||||
- **Vite** `^5.0.0` - 现代化构建工具
|
||||
- **TypeScript** `^5.0.0` - 类型安全的JavaScript
|
||||
|
||||
### 🎨 UI组件
|
||||
- **Ant Design** `^5.0.0` - 企业级UI组件库
|
||||
- **Ant Design Icons** - 图标库
|
||||
- **CSS Modules** - 样式模块化
|
||||
|
||||
### 🔧 开发工具
|
||||
- **ESLint** - 代码质量检查
|
||||
- **Prettier** - 代码格式化
|
||||
- **Husky** - Git钩子管理
|
||||
|
||||
### 🌐 HTTP客户端
|
||||
- **Axios** - HTTP请求库
|
||||
- **React Query** - 数据获取和缓存
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
client/
|
||||
├── src/
|
||||
│ ├── components/ # 通用组件
|
||||
│ ├── pages/ # 页面组件
|
||||
│ ├── services/ # API服务
|
||||
│ ├── utils/ # 工具函数
|
||||
│ ├── types/ # TypeScript类型定义
|
||||
│ ├── styles/ # 全局样式
|
||||
│ ├── App.tsx # 应用主组件
|
||||
│ └── main.tsx # 应用入口
|
||||
├── public/ # 静态资源
|
||||
├── index.html # HTML模板
|
||||
├── vite.config.ts # Vite配置
|
||||
├── tsconfig.json # TypeScript配置
|
||||
└── package.json # 项目配置
|
||||
```
|
||||
|
||||
## 🔧 开发命令
|
||||
|
||||
```bash
|
||||
# 启动开发服务器
|
||||
pnpm run dev
|
||||
|
||||
# 构建生产版本
|
||||
pnpm run build
|
||||
|
||||
# 预览生产构建
|
||||
pnpm run preview
|
||||
|
||||
# 代码检查
|
||||
pnpm run lint
|
||||
|
||||
# 代码格式化
|
||||
pnpm run format
|
||||
|
||||
# 类型检查
|
||||
pnpm run type-check
|
||||
```
|
||||
|
||||
## 🌍 环境配置
|
||||
|
||||
### 开发环境 (.env.local)
|
||||
```bash
|
||||
VITE_API_BASE_URL=http://localhost:3000
|
||||
VITE_APP_TITLE=Whale Town 管理后台
|
||||
```
|
||||
|
||||
### 生产环境 (.env.production)
|
||||
```bash
|
||||
VITE_API_BASE_URL=https://your-api-domain.com
|
||||
VITE_APP_TITLE=Whale Town 管理后台
|
||||
```
|
||||
|
||||
## 🔗 API集成
|
||||
|
||||
### 认证接口
|
||||
- `POST /admin/auth/login` - 管理员登录
|
||||
- 自动Token管理和刷新
|
||||
|
||||
### 用户管理接口
|
||||
- `GET /admin/users` - 获取用户列表
|
||||
- `GET /admin/users/:id` - 获取用户详情
|
||||
- `POST /admin/users/:id/reset-password` - 重置用户密码
|
||||
- `PUT /admin/users/:id/status` - 修改用户状态
|
||||
|
||||
### 系统接口
|
||||
- `GET /admin/logs/runtime` - 获取运行日志
|
||||
- `GET /admin/logs/archive` - 下载日志归档
|
||||
|
||||
## 🎨 界面预览
|
||||
|
||||
### 登录页面
|
||||
- 简洁的登录表单
|
||||
- 输入验证和错误提示
|
||||
- 记住登录状态
|
||||
|
||||
### 用户管理页面
|
||||
- 用户列表表格
|
||||
- 搜索和筛选功能
|
||||
- 用户状态管理
|
||||
- 密码重置操作
|
||||
|
||||
### 日志管理页面
|
||||
- 实时日志显示
|
||||
- 日志级别筛选
|
||||
- 日志文件下载
|
||||
|
||||
## 🚀 部署指南
|
||||
|
||||
### 构建生产版本
|
||||
```bash
|
||||
# 构建
|
||||
pnpm run build
|
||||
|
||||
# 构建产物在 dist/ 目录
|
||||
```
|
||||
|
||||
### 部署到Nginx
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name your-domain.com;
|
||||
|
||||
location / {
|
||||
root /path/to/client/dist;
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
location /api {
|
||||
proxy_pass http://localhost:3000;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🤝 开发规范
|
||||
|
||||
### 代码风格
|
||||
- 使用TypeScript进行类型检查
|
||||
- 遵循ESLint和Prettier规范
|
||||
- 组件使用函数式组件和Hooks
|
||||
|
||||
### 文件命名
|
||||
- 组件文件使用PascalCase:`UserList.tsx`
|
||||
- 工具文件使用camelCase:`apiClient.ts`
|
||||
- 样式文件使用kebab-case:`user-list.module.css`
|
||||
|
||||
### 提交规范
|
||||
- 遵循项目Git提交规范
|
||||
- 提交前自动运行代码检查
|
||||
|
||||
## 📞 技术支持
|
||||
|
||||
如有问题,请查看:
|
||||
1. [后端API文档](../docs/api/README.md)
|
||||
2. [项目架构文档](../docs/ARCHITECTURE.md)
|
||||
3. [开发规范指南](../docs/development/)
|
||||
|
||||
---
|
||||
|
||||
**🎛️ 现代化管理界面,让后台管理更高效!**
|
||||
12
client/index.html
Normal file
12
client/index.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<!doctype html>
|
||||
<html lang="zh-CN">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Whale Town Admin</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
<script type="module" src="/src/main.tsx"></script>
|
||||
</body>
|
||||
</html>
|
||||
24
client/package.json
Normal file
24
client/package.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "whale-town-admin",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
"build": "tsc -b && vite build",
|
||||
"preview": "vite preview"
|
||||
},
|
||||
"dependencies": {
|
||||
"antd": "^5.27.3",
|
||||
"react": "^18.3.1",
|
||||
"react-dom": "^18.3.1",
|
||||
"react-router-dom": "^6.30.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/react": "^18.3.24",
|
||||
"@types/react-dom": "^18.3.7",
|
||||
"@vitejs/plugin-react": "^5.0.2",
|
||||
"typescript": "^5.9.3",
|
||||
"vite": "^7.1.3"
|
||||
}
|
||||
}
|
||||
61
client/src/app/AdminLayout.tsx
Normal file
61
client/src/app/AdminLayout.tsx
Normal file
@@ -0,0 +1,61 @@
|
||||
import { Layout, Menu, Typography } from 'antd';
|
||||
import { Outlet, useLocation, useNavigate } from 'react-router-dom';
|
||||
import { clearAuth } from '../lib/adminAuth';
|
||||
|
||||
const { Header, Content, Sider } = Layout;
|
||||
|
||||
export function AdminLayout() {
|
||||
const navigate = useNavigate();
|
||||
const location = useLocation();
|
||||
|
||||
const selectedKey = location.pathname.startsWith('/logs')
|
||||
? 'logs'
|
||||
: location.pathname.startsWith('/users')
|
||||
? 'users'
|
||||
: 'users';
|
||||
|
||||
return (
|
||||
<Layout style={{ minHeight: '100vh' }}>
|
||||
<Sider width={220}>
|
||||
<div style={{ padding: 16 }}>
|
||||
<Typography.Title level={5} style={{ color: 'white', margin: 0 }}>
|
||||
Whale Town Admin
|
||||
</Typography.Title>
|
||||
</div>
|
||||
<Menu
|
||||
theme="dark"
|
||||
mode="inline"
|
||||
selectedKeys={[selectedKey]}
|
||||
items={[
|
||||
{
|
||||
key: 'users',
|
||||
label: '用户管理',
|
||||
onClick: () => navigate('/users'),
|
||||
},
|
||||
{
|
||||
key: 'logs',
|
||||
label: '运行日志',
|
||||
onClick: () => navigate('/logs'),
|
||||
},
|
||||
{
|
||||
key: 'logout',
|
||||
label: '退出登录',
|
||||
onClick: () => {
|
||||
clearAuth();
|
||||
navigate('/login');
|
||||
},
|
||||
},
|
||||
]}
|
||||
/>
|
||||
</Sider>
|
||||
<Layout>
|
||||
<Header style={{ background: 'white', display: 'flex', alignItems: 'center' }}>
|
||||
<Typography.Text>后台管理</Typography.Text>
|
||||
</Header>
|
||||
<Content style={{ padding: 16 }}>
|
||||
<Outlet />
|
||||
</Content>
|
||||
</Layout>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
28
client/src/app/App.tsx
Normal file
28
client/src/app/App.tsx
Normal file
@@ -0,0 +1,28 @@
|
||||
import { ConfigProvider } from 'antd';
|
||||
import { BrowserRouter, Navigate, Route, Routes } from 'react-router-dom';
|
||||
import { AdminLayout } from './AdminLayout';
|
||||
import { LoginPage } from '../pages/LoginPage';
|
||||
import { UsersPage } from '../pages/UsersPage';
|
||||
import { LogsPage } from '../pages/LogsPage';
|
||||
import { isAuthed } from '../lib/adminAuth';
|
||||
|
||||
export function App() {
|
||||
return (
|
||||
<ConfigProvider>
|
||||
<BrowserRouter>
|
||||
<Routes>
|
||||
<Route path="/login" element={<LoginPage />} />
|
||||
<Route
|
||||
path="/"
|
||||
element={isAuthed() ? <AdminLayout /> : <Navigate to="/login" replace />}
|
||||
>
|
||||
<Route index element={<Navigate to="/users" replace />} />
|
||||
<Route path="users" element={<UsersPage />} />
|
||||
<Route path="logs" element={<LogsPage />} />
|
||||
</Route>
|
||||
<Route path="*" element={<Navigate to={isAuthed() ? '/users' : '/login'} replace />} />
|
||||
</Routes>
|
||||
</BrowserRouter>
|
||||
</ConfigProvider>
|
||||
);
|
||||
}
|
||||
17
client/src/lib/adminAuth.ts
Normal file
17
client/src/lib/adminAuth.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
const TOKEN_KEY = 'whale_town_admin_token';
|
||||
|
||||
export function getToken(): string | null {
|
||||
return localStorage.getItem(TOKEN_KEY);
|
||||
}
|
||||
|
||||
export function setToken(token: string): void {
|
||||
localStorage.setItem(TOKEN_KEY, token);
|
||||
}
|
||||
|
||||
export function clearAuth(): void {
|
||||
localStorage.removeItem(TOKEN_KEY);
|
||||
}
|
||||
|
||||
export function isAuthed(): boolean {
|
||||
return Boolean(getToken());
|
||||
}
|
||||
130
client/src/lib/api.ts
Normal file
130
client/src/lib/api.ts
Normal file
@@ -0,0 +1,130 @@
|
||||
import { getToken, clearAuth } from './adminAuth';
|
||||
|
||||
const API_BASE_URL = import.meta.env.VITE_API_BASE_URL || 'http://localhost:3000';
|
||||
|
||||
export class ApiError extends Error {
|
||||
status: number;
|
||||
|
||||
constructor(message: string, status: number) {
|
||||
super(message);
|
||||
this.status = status;
|
||||
}
|
||||
}
|
||||
|
||||
function parseFilenameFromContentDisposition(contentDisposition: string | null): string | null {
|
||||
if (!contentDisposition) return null;
|
||||
|
||||
// Prefer RFC 5987 filename*=UTF-8''...
|
||||
const filenameStarMatch = contentDisposition.match(/filename\*=(?:UTF-8''|utf-8'')([^;]+)/);
|
||||
if (filenameStarMatch?.[1]) {
|
||||
try {
|
||||
return decodeURIComponent(filenameStarMatch[1].trim().replace(/^"|"$/g, ''));
|
||||
} catch {
|
||||
return filenameStarMatch[1].trim().replace(/^"|"$/g, '');
|
||||
}
|
||||
}
|
||||
|
||||
const filenameMatch = contentDisposition.match(/filename=([^;]+)/);
|
||||
if (filenameMatch?.[1]) {
|
||||
return filenameMatch[1].trim().replace(/^"|"$/g, '');
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
async function request<T>(path: string, init?: RequestInit): Promise<T> {
|
||||
const token = getToken();
|
||||
|
||||
const headers: Record<string, string> = {
|
||||
'Content-Type': 'application/json',
|
||||
};
|
||||
|
||||
if (token) {
|
||||
headers['Authorization'] = `Bearer ${token}`;
|
||||
}
|
||||
|
||||
const res = await fetch(`${API_BASE_URL}${path}`, {
|
||||
...init,
|
||||
headers: {
|
||||
...headers,
|
||||
...(init?.headers || {}),
|
||||
},
|
||||
credentials: 'include',
|
||||
});
|
||||
|
||||
if (res.status === 401) {
|
||||
clearAuth();
|
||||
}
|
||||
|
||||
const data = (await res.json().catch(() => ({}))) as any;
|
||||
|
||||
if (!res.ok) {
|
||||
throw new ApiError(data?.message || `请求失败: ${res.status}`, res.status);
|
||||
}
|
||||
|
||||
return data as T;
|
||||
}
|
||||
|
||||
async function requestDownload(path: string, init?: RequestInit): Promise<{ blob: Blob; filename: string }>
|
||||
{
|
||||
const token = getToken();
|
||||
|
||||
const headers: Record<string, string> = {
|
||||
...(init?.headers as any),
|
||||
};
|
||||
|
||||
// Do NOT force Content-Type for downloads (GET binary)
|
||||
if (token) {
|
||||
headers['Authorization'] = `Bearer ${token}`;
|
||||
}
|
||||
|
||||
const res = await fetch(`${API_BASE_URL}${path}`, {
|
||||
...init,
|
||||
headers,
|
||||
credentials: 'include',
|
||||
});
|
||||
|
||||
if (res.status === 401) {
|
||||
clearAuth();
|
||||
}
|
||||
|
||||
if (!res.ok) {
|
||||
const text = await res.text().catch(() => '');
|
||||
// Try to extract message from JSON-ish body
|
||||
let message = `请求失败: ${res.status}`;
|
||||
try {
|
||||
const maybeJson = JSON.parse(text || '{}');
|
||||
message = maybeJson?.message || message;
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
throw new ApiError(message, res.status);
|
||||
}
|
||||
|
||||
const filename =
|
||||
parseFilenameFromContentDisposition(res.headers.get('content-disposition')) || 'logs.tar.gz';
|
||||
const blob = await res.blob();
|
||||
return { blob, filename };
|
||||
}
|
||||
|
||||
export const api = {
|
||||
adminLogin: (identifier: string, password: string) =>
|
||||
request<any>('/admin/auth/login', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({ identifier, password }),
|
||||
}),
|
||||
|
||||
listUsers: (limit = 100, offset = 0) =>
|
||||
request<any>(`/admin/users?limit=${encodeURIComponent(limit)}&offset=${encodeURIComponent(offset)}`),
|
||||
|
||||
resetUserPassword: (userId: string, newPassword: string) =>
|
||||
request<any>(`/admin/users/${encodeURIComponent(userId)}/reset-password`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({ new_password: newPassword }),
|
||||
}),
|
||||
|
||||
getRuntimeLogs: (lines = 200) =>
|
||||
request<any>(`/admin/logs/runtime?lines=${encodeURIComponent(lines)}`),
|
||||
|
||||
downloadLogsArchive: () => requestDownload('/admin/logs/archive'),
|
||||
};
|
||||
9
client/src/main.tsx
Normal file
9
client/src/main.tsx
Normal file
@@ -0,0 +1,9 @@
|
||||
import React from 'react';
|
||||
import ReactDOM from 'react-dom/client';
|
||||
import { App } from './app/App';
|
||||
|
||||
ReactDOM.createRoot(document.getElementById('root')!).render(
|
||||
<React.StrictMode>
|
||||
<App />
|
||||
</React.StrictMode>,
|
||||
);
|
||||
50
client/src/pages/LoginPage.tsx
Normal file
50
client/src/pages/LoginPage.tsx
Normal file
@@ -0,0 +1,50 @@
|
||||
import { Button, Card, Form, Input, Typography, message } from 'antd';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { api } from '../lib/api';
|
||||
import { setToken } from '../lib/adminAuth';
|
||||
|
||||
type LoginValues = {
|
||||
identifier: string;
|
||||
password: string;
|
||||
};
|
||||
|
||||
export function LoginPage() {
|
||||
const navigate = useNavigate();
|
||||
const [form] = Form.useForm<LoginValues>();
|
||||
|
||||
const onFinish = async (values: LoginValues) => {
|
||||
try {
|
||||
const res = await api.adminLogin(values.identifier, values.password);
|
||||
if (!res?.success || !res?.data?.access_token) {
|
||||
throw new Error(res?.message || '登录失败');
|
||||
}
|
||||
|
||||
setToken(res.data.access_token);
|
||||
message.success('登录成功');
|
||||
navigate('/users');
|
||||
} catch (e: any) {
|
||||
message.error(e?.message || '登录失败');
|
||||
}
|
||||
};
|
||||
|
||||
return (
|
||||
<div style={{ minHeight: '100vh', display: 'flex', justifyContent: 'center', alignItems: 'center' }}>
|
||||
<Card style={{ width: 420 }}>
|
||||
<Typography.Title level={4} style={{ marginTop: 0 }}>
|
||||
管理员登录
|
||||
</Typography.Title>
|
||||
<Form form={form} layout="vertical" onFinish={onFinish}>
|
||||
<Form.Item name="identifier" label="用户名/邮箱/手机号" rules={[{ required: true }]}>
|
||||
<Input placeholder="admin" autoComplete="username" />
|
||||
</Form.Item>
|
||||
<Form.Item name="password" label="密码" rules={[{ required: true }]}>
|
||||
<Input.Password placeholder="请输入密码" autoComplete="current-password" />
|
||||
</Form.Item>
|
||||
<Button type="primary" htmlType="submit" block>
|
||||
登录
|
||||
</Button>
|
||||
</Form>
|
||||
</Card>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
106
client/src/pages/LogsPage.tsx
Normal file
106
client/src/pages/LogsPage.tsx
Normal file
@@ -0,0 +1,106 @@
|
||||
import { useEffect, useMemo, useState } from 'react';
|
||||
import { Alert, Button, Card, InputNumber, Space, Typography } from 'antd';
|
||||
import { api, ApiError } from '../lib/api';
|
||||
|
||||
export function LogsPage() {
|
||||
const [lines, setLines] = useState<number>(200);
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [downloadLoading, setDownloadLoading] = useState(false);
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const [file, setFile] = useState<string>('');
|
||||
const [updatedAt, setUpdatedAt] = useState<string>('');
|
||||
const [logLines, setLogLines] = useState<string[]>([]);
|
||||
|
||||
const logText = useMemo(() => logLines.join('\n'), [logLines]);
|
||||
|
||||
const load = async () => {
|
||||
setLoading(true);
|
||||
setError(null);
|
||||
try {
|
||||
const res = await api.getRuntimeLogs(lines);
|
||||
if (!res?.success) {
|
||||
setError(res?.message || '运行日志获取失败');
|
||||
return;
|
||||
}
|
||||
setFile(res?.data?.file || '');
|
||||
setUpdatedAt(res?.data?.updated_at || '');
|
||||
setLogLines(Array.isArray(res?.data?.lines) ? res.data.lines : []);
|
||||
} catch (e) {
|
||||
if (e instanceof ApiError) {
|
||||
setError(e.message);
|
||||
} else {
|
||||
setError(e instanceof Error ? e.message : '运行日志获取失败');
|
||||
}
|
||||
} finally {
|
||||
setLoading(false);
|
||||
}
|
||||
};
|
||||
|
||||
useEffect(() => {
|
||||
void load();
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, []);
|
||||
|
||||
const downloadArchive = async () => {
|
||||
setDownloadLoading(true);
|
||||
setError(null);
|
||||
try {
|
||||
const { blob, filename } = await api.downloadLogsArchive();
|
||||
const url = URL.createObjectURL(blob);
|
||||
try {
|
||||
const a = document.createElement('a');
|
||||
a.href = url;
|
||||
a.download = filename || 'logs.tar.gz';
|
||||
document.body.appendChild(a);
|
||||
a.click();
|
||||
document.body.removeChild(a);
|
||||
} finally {
|
||||
URL.revokeObjectURL(url);
|
||||
}
|
||||
} catch (e) {
|
||||
if (e instanceof ApiError) {
|
||||
setError(e.message);
|
||||
} else {
|
||||
setError(e instanceof Error ? e.message : '日志下载失败');
|
||||
}
|
||||
} finally {
|
||||
setDownloadLoading(false);
|
||||
}
|
||||
};
|
||||
|
||||
return (
|
||||
<Space direction="vertical" style={{ width: '100%' }} size="middle">
|
||||
{error ? <Alert type="error" message={error} /> : null}
|
||||
|
||||
<Card
|
||||
title="运行日志"
|
||||
extra={
|
||||
<Space>
|
||||
<span>行数</span>
|
||||
<InputNumber
|
||||
min={1}
|
||||
max={2000}
|
||||
value={lines}
|
||||
onChange={(v) => setLines(typeof v === 'number' ? v : 200)}
|
||||
/>
|
||||
<Button onClick={() => void load()} loading={loading}>
|
||||
刷新
|
||||
</Button>
|
||||
<Button onClick={() => void downloadArchive()} loading={downloadLoading}>
|
||||
下载日志压缩包
|
||||
</Button>
|
||||
</Space>
|
||||
}
|
||||
>
|
||||
<Space direction="vertical" style={{ width: '100%' }} size="small">
|
||||
<Typography.Text type="secondary">
|
||||
{file ? `文件:${file}` : '文件:-'}
|
||||
{updatedAt ? ` 更新时间:${updatedAt}` : ''}
|
||||
</Typography.Text>
|
||||
|
||||
<pre style={{ margin: 0, whiteSpace: 'pre-wrap', wordBreak: 'break-word' }}>{logText || '暂无日志'}</pre>
|
||||
</Space>
|
||||
</Card>
|
||||
</Space>
|
||||
);
|
||||
}
|
||||
161
client/src/pages/UsersPage.tsx
Normal file
161
client/src/pages/UsersPage.tsx
Normal file
@@ -0,0 +1,161 @@
|
||||
import { Button, Card, Form, Input, Modal, Space, Table, Typography, message } from 'antd';
|
||||
import { useEffect, useMemo, useState } from 'react';
|
||||
import { api } from '../lib/api';
|
||||
|
||||
type UserRow = {
|
||||
id: string;
|
||||
username: string;
|
||||
nickname: string;
|
||||
email?: string;
|
||||
email_verified: boolean;
|
||||
phone?: string;
|
||||
role: number;
|
||||
created_at: string;
|
||||
};
|
||||
|
||||
type ResetValues = {
|
||||
newPassword: string;
|
||||
};
|
||||
|
||||
export function UsersPage() {
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [rows, setRows] = useState<UserRow[]>([]);
|
||||
const [resetOpen, setResetOpen] = useState(false);
|
||||
const [resetUserId, setResetUserId] = useState<string | null>(null);
|
||||
const [resetForm] = Form.useForm<ResetValues>();
|
||||
|
||||
const columns = useMemo(
|
||||
() => [
|
||||
{ title: 'ID', dataIndex: 'id', key: 'id', width: 90 },
|
||||
{ title: '用户名', dataIndex: 'username', key: 'username' },
|
||||
{ title: '昵称', dataIndex: 'nickname', key: 'nickname' },
|
||||
{ title: '邮箱', dataIndex: 'email', key: 'email' },
|
||||
{
|
||||
title: '邮箱验证',
|
||||
dataIndex: 'email_verified',
|
||||
key: 'email_verified',
|
||||
render: (v: boolean) => (v ? '已验证' : '未验证'),
|
||||
width: 100,
|
||||
},
|
||||
{ title: '手机号', dataIndex: 'phone', key: 'phone' },
|
||||
{ title: '角色', dataIndex: 'role', key: 'role', width: 80 },
|
||||
{ title: '创建时间', dataIndex: 'created_at', key: 'created_at', width: 180 },
|
||||
{
|
||||
title: '操作',
|
||||
key: 'actions',
|
||||
width: 160,
|
||||
render: (_: any, row: UserRow) => (
|
||||
<Space>
|
||||
<Button
|
||||
size="small"
|
||||
onClick={() => {
|
||||
setResetUserId(row.id);
|
||||
resetForm.resetFields();
|
||||
setResetOpen(true);
|
||||
}}
|
||||
>
|
||||
重置密码
|
||||
</Button>
|
||||
</Space>
|
||||
),
|
||||
},
|
||||
],
|
||||
[resetForm],
|
||||
);
|
||||
|
||||
const load = async () => {
|
||||
setLoading(true);
|
||||
try {
|
||||
const res = await api.listUsers(200, 0);
|
||||
const users = res?.data?.users || [];
|
||||
setRows(
|
||||
users.map((u: any) => ({
|
||||
id: u.id,
|
||||
username: u.username,
|
||||
nickname: u.nickname,
|
||||
email: u.email || undefined,
|
||||
email_verified: Boolean(u.email_verified),
|
||||
phone: u.phone || undefined,
|
||||
role: u.role,
|
||||
created_at: u.created_at,
|
||||
})),
|
||||
);
|
||||
} catch (e: any) {
|
||||
message.error(e?.message || '加载失败');
|
||||
} finally {
|
||||
setLoading(false);
|
||||
}
|
||||
};
|
||||
|
||||
useEffect(() => {
|
||||
void load();
|
||||
}, []);
|
||||
|
||||
const onResetOk = async () => {
|
||||
try {
|
||||
const values = await resetForm.validateFields();
|
||||
if (!resetUserId) return;
|
||||
|
||||
await api.resetUserPassword(resetUserId, values.newPassword);
|
||||
message.success('密码已重置');
|
||||
setResetOpen(false);
|
||||
} catch (e: any) {
|
||||
if (e?.errorFields) return;
|
||||
message.error(e?.message || '重置失败');
|
||||
}
|
||||
};
|
||||
|
||||
return (
|
||||
<Card>
|
||||
<Space direction="vertical" style={{ width: '100%' }} size={12}>
|
||||
<Space style={{ justifyContent: 'space-between', width: '100%' }}>
|
||||
<Typography.Title level={4} style={{ margin: 0 }}>
|
||||
用户管理
|
||||
</Typography.Title>
|
||||
<Button onClick={load} loading={loading}>
|
||||
刷新
|
||||
</Button>
|
||||
</Space>
|
||||
|
||||
<Table
|
||||
rowKey="id"
|
||||
loading={loading}
|
||||
columns={columns as any}
|
||||
dataSource={rows}
|
||||
pagination={false}
|
||||
/>
|
||||
</Space>
|
||||
|
||||
<Modal
|
||||
title={`重置密码${resetUserId ? `(用户ID: ${resetUserId})` : ''}`}
|
||||
open={resetOpen}
|
||||
onOk={onResetOk}
|
||||
onCancel={() => setResetOpen(false)}
|
||||
okText="确认"
|
||||
cancelText="取消"
|
||||
>
|
||||
<Form form={resetForm} layout="vertical">
|
||||
<Form.Item
|
||||
label="新密码"
|
||||
name="newPassword"
|
||||
rules={[
|
||||
{ required: true, message: '请输入新密码' },
|
||||
{ min: 8, message: '至少8位' },
|
||||
{
|
||||
validator: (_, v) => {
|
||||
const hasLetter = /[a-zA-Z]/.test(v || '');
|
||||
const hasNumber = /\d/.test(v || '');
|
||||
if (!v) return Promise.resolve();
|
||||
if (!hasLetter || !hasNumber) return Promise.reject(new Error('必须包含字母和数字'));
|
||||
return Promise.resolve();
|
||||
},
|
||||
},
|
||||
]}
|
||||
>
|
||||
<Input.Password placeholder="例如 NewPass1234" />
|
||||
</Form.Item>
|
||||
</Form>
|
||||
</Modal>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
19
client/tsconfig.json
Normal file
19
client/tsconfig.json
Normal file
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"useDefineForClassFields": true,
|
||||
"lib": ["ES2022", "DOM", "DOM.Iterable"],
|
||||
"module": "ESNext",
|
||||
"skipLibCheck": true,
|
||||
|
||||
"moduleResolution": "Bundler",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"noEmit": true,
|
||||
"jsx": "react-jsx",
|
||||
|
||||
"strict": true,
|
||||
"types": ["vite/client"]
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
9
client/vite.config.ts
Normal file
9
client/vite.config.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import { defineConfig } from 'vite';
|
||||
import react from '@vitejs/plugin-react';
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [react()],
|
||||
server: {
|
||||
port: 5173,
|
||||
},
|
||||
});
|
||||
149
config/zulip/README.md
Normal file
149
config/zulip/README.md
Normal file
@@ -0,0 +1,149 @@
|
||||
# Zulip配置目录
|
||||
|
||||
本目录包含Zulip集成系统的配置文件。
|
||||
|
||||
## 文件说明
|
||||
|
||||
### map-config.json
|
||||
|
||||
地图映射配置文件,定义游戏地图到Zulip Stream/Topic的映射关系。
|
||||
|
||||
#### 配置结构
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"lastModified": "2025-12-25T00:00:00.000Z",
|
||||
"description": "配置描述",
|
||||
"maps": [
|
||||
{
|
||||
"mapId": "地图唯一标识",
|
||||
"mapName": "地图显示名称",
|
||||
"zulipStream": "对应的Zulip Stream名称",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "交互对象唯一标识",
|
||||
"objectName": "交互对象显示名称",
|
||||
"zulipTopic": "对应的Zulip Topic名称",
|
||||
"position": { "x": 100, "y": 150 }
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### 字段说明
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| version | string | 否 | 配置版本号 |
|
||||
| lastModified | string | 否 | 最后修改时间(ISO 8601格式) |
|
||||
| description | string | 否 | 配置描述 |
|
||||
| maps | array | 是 | 地图配置数组 |
|
||||
|
||||
##### 地图配置 (MapConfig)
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| mapId | string | 是 | 地图唯一标识,如 "novice_village" |
|
||||
| mapName | string | 是 | 地图显示名称,如 "新手村" |
|
||||
| zulipStream | string | 是 | 对应的Zulip Stream名称 |
|
||||
| interactionObjects | array | 是 | 交互对象配置数组 |
|
||||
|
||||
##### 交互对象配置 (InteractionObject)
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| objectId | string | 是 | 交互对象唯一标识 |
|
||||
| objectName | string | 是 | 交互对象显示名称 |
|
||||
| zulipTopic | string | 是 | 对应的Zulip Topic名称 |
|
||||
| position | object | 是 | 对象在地图中的位置 |
|
||||
| position.x | number | 是 | X坐标 |
|
||||
| position.y | number | 是 | Y坐标 |
|
||||
|
||||
## 配置示例
|
||||
|
||||
### 新手村配置
|
||||
|
||||
```json
|
||||
{
|
||||
"mapId": "novice_village",
|
||||
"mapName": "新手村",
|
||||
"zulipStream": "Novice Village",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "notice_board",
|
||||
"objectName": "公告板",
|
||||
"zulipTopic": "Notice Board",
|
||||
"position": { "x": 100, "y": 150 }
|
||||
},
|
||||
{
|
||||
"objectId": "village_well",
|
||||
"objectName": "村井",
|
||||
"zulipTopic": "Village Well",
|
||||
"position": { "x": 200, "y": 200 }
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 酒馆配置
|
||||
|
||||
```json
|
||||
{
|
||||
"mapId": "tavern",
|
||||
"mapName": "酒馆",
|
||||
"zulipStream": "Tavern",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "bar_counter",
|
||||
"objectName": "吧台",
|
||||
"zulipTopic": "Bar Counter",
|
||||
"position": { "x": 150, "y": 100 }
|
||||
},
|
||||
{
|
||||
"objectId": "fireplace",
|
||||
"objectName": "壁炉",
|
||||
"zulipTopic": "Fireplace Chat",
|
||||
"position": { "x": 300, "y": 200 }
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## 热重载
|
||||
|
||||
配置文件支持热重载,修改后无需重启服务即可生效。
|
||||
|
||||
### 启用配置监听
|
||||
|
||||
在代码中调用:
|
||||
|
||||
```typescript
|
||||
configManagerService.enableConfigWatcher();
|
||||
```
|
||||
|
||||
### 手动重载配置
|
||||
|
||||
```typescript
|
||||
await configManagerService.reloadConfig();
|
||||
```
|
||||
|
||||
## 验证配置
|
||||
|
||||
系统启动时会自动验证配置文件的有效性。验证规则包括:
|
||||
|
||||
1. mapId必须是非空字符串
|
||||
2. mapName必须是非空字符串
|
||||
3. zulipStream必须是非空字符串
|
||||
4. interactionObjects必须是数组
|
||||
5. 每个交互对象必须有有效的objectId、objectName、zulipTopic和position
|
||||
6. position.x和position.y必须是有效数字
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **Stream名称**: Zulip Stream名称区分大小写,请确保与Zulip服务器上的Stream名称完全匹配
|
||||
2. **Topic名称**: Topic名称同样区分大小写
|
||||
3. **位置坐标**: 位置坐标用于空间过滤,确保与游戏客户端的坐标系统一致
|
||||
4. **唯一性**: mapId和objectId在各自范围内必须唯一
|
||||
205
config/zulip/map-config.json
Normal file
205
config/zulip/map-config.json
Normal file
@@ -0,0 +1,205 @@
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"lastModified": "2025-12-25T20:00:00.000Z",
|
||||
"description": "基于设计图的 Zulip 映射配置",
|
||||
"maps": [
|
||||
{
|
||||
"mapId": "whale_port",
|
||||
"mapName": "鲸之港",
|
||||
"zulipStream": "Whale Port",
|
||||
"description": "中心城区,交通枢纽与主要聚会点",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "whale_statue",
|
||||
"objectName": "鲸鱼雕像",
|
||||
"zulipTopic": "Announcements",
|
||||
"position": { "x": 600, "y": 400 }
|
||||
},
|
||||
{
|
||||
"objectId": "clock_tower",
|
||||
"objectName": "大本钟",
|
||||
"zulipTopic": "General Chat",
|
||||
"position": { "x": 550, "y": 350 }
|
||||
},
|
||||
{
|
||||
"objectId": "city_metro",
|
||||
"objectName": "地铁入口",
|
||||
"zulipTopic": "Transportation",
|
||||
"position": { "x": 600, "y": 550 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "offer_city",
|
||||
"mapName": "Offer 城",
|
||||
"zulipStream": "Offer City",
|
||||
"description": "职业发展、面试与商务区",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "skyscrapers",
|
||||
"objectName": "摩天大楼",
|
||||
"zulipTopic": "Career Talk",
|
||||
"position": { "x": 350, "y": 650 }
|
||||
},
|
||||
{
|
||||
"objectId": "business_center",
|
||||
"objectName": "商务中心",
|
||||
"zulipTopic": "Interview Prep",
|
||||
"position": { "x": 300, "y": 700 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "model_factory",
|
||||
"mapName": "模型工厂",
|
||||
"zulipStream": "Model Factory",
|
||||
"description": "AI模型训练、代码构建与工业区",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "assembly_line",
|
||||
"objectName": "流水线",
|
||||
"zulipTopic": "Code Review",
|
||||
"position": { "x": 400, "y": 200 }
|
||||
},
|
||||
{
|
||||
"objectId": "gear_tower",
|
||||
"objectName": "齿轮塔",
|
||||
"zulipTopic": "DevOps & CI/CD",
|
||||
"position": { "x": 450, "y": 180 }
|
||||
},
|
||||
{
|
||||
"objectId": "cable_car_station",
|
||||
"objectName": "缆车站",
|
||||
"zulipTopic": "Deployments",
|
||||
"position": { "x": 350, "y": 220 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "kernel_island",
|
||||
"mapName": "内核岛",
|
||||
"zulipStream": "Kernel Island",
|
||||
"description": "核心技术研究、底层原理与算法",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "crystal_core",
|
||||
"objectName": "能量水晶",
|
||||
"zulipTopic": "Core Algorithms",
|
||||
"position": { "x": 600, "y": 150 }
|
||||
},
|
||||
{
|
||||
"objectId": "floating_rocks",
|
||||
"objectName": "浮空石",
|
||||
"zulipTopic": "System Architecture",
|
||||
"position": { "x": 650, "y": 180 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "pumpkin_valley",
|
||||
"mapName": "南瓜谷",
|
||||
"zulipStream": "Pumpkin Valley",
|
||||
"description": "新手成长、基础资源与学习社区",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "pumpkin_patch",
|
||||
"objectName": "南瓜田",
|
||||
"zulipTopic": "Tutorials",
|
||||
"position": { "x": 150, "y": 400 }
|
||||
},
|
||||
{
|
||||
"objectId": "farm_house",
|
||||
"objectName": "农舍",
|
||||
"zulipTopic": "Study Group",
|
||||
"position": { "x": 200, "y": 450 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "moyu_beach",
|
||||
"mapName": "摸鱼海滩",
|
||||
"zulipStream": "Moyu Beach",
|
||||
"description": "休闲娱乐、水贴与非技术话题",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "beach_umbrella",
|
||||
"objectName": "遮阳伞",
|
||||
"zulipTopic": "Random Chat",
|
||||
"position": { "x": 850, "y": 200 }
|
||||
},
|
||||
{
|
||||
"objectId": "lighthouse",
|
||||
"objectName": "灯塔",
|
||||
"zulipTopic": "Music & Movies",
|
||||
"position": { "x": 800, "y": 100 }
|
||||
},
|
||||
{
|
||||
"objectId": "fishing_dock",
|
||||
"objectName": "栈桥",
|
||||
"zulipTopic": "Gaming",
|
||||
"position": { "x": 750, "y": 250 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "ladder_peak",
|
||||
"mapName": "天梯峰",
|
||||
"zulipStream": "Ladder Peak",
|
||||
"description": "挑战、竞赛与排行榜",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "summit_flag",
|
||||
"objectName": "峰顶旗帜",
|
||||
"zulipTopic": "Leaderboard",
|
||||
"position": { "x": 150, "y": 100 }
|
||||
},
|
||||
{
|
||||
"objectId": "snowy_path",
|
||||
"objectName": "雪径",
|
||||
"zulipTopic": "Challenges",
|
||||
"position": { "x": 200, "y": 150 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "galaxy_bay",
|
||||
"mapName": "星河湾",
|
||||
"zulipStream": "Galaxy Bay",
|
||||
"description": "创意、设计与灵感",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "starfish",
|
||||
"objectName": "巨型海星",
|
||||
"zulipTopic": "UI/UX Design",
|
||||
"position": { "x": 100, "y": 700 }
|
||||
},
|
||||
{
|
||||
"objectId": "palm_tree",
|
||||
"objectName": "椰子树",
|
||||
"zulipTopic": "Art & Assets",
|
||||
"position": { "x": 150, "y": 650 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "data_ruins",
|
||||
"mapName": "数据遗迹",
|
||||
"zulipStream": "Data Ruins",
|
||||
"description": "数据库、归档与历史记录",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "ruined_gate",
|
||||
"objectName": "遗迹之门",
|
||||
"zulipTopic": "Database Schema",
|
||||
"position": { "x": 900, "y": 700 }
|
||||
},
|
||||
{
|
||||
"objectId": "ancient_monolith",
|
||||
"objectName": "石碑",
|
||||
"zulipTopic": "Archives",
|
||||
"position": { "x": 950, "y": 650 }
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# 部署脚本模板 - 用于 Gitea Webhook 自动部署
|
||||
# 复制此文件为 deploy.sh 并根据服务器环境修改配置
|
||||
set -e
|
||||
|
||||
echo "开始部署 Pixel Game Server..."
|
||||
|
||||
# 项目路径(根据你的服务器实际路径修改)
|
||||
PROJECT_PATH="/var/www/pixel-game-server"
|
||||
BACKUP_PATH="/var/backups/pixel-game-server"
|
||||
|
||||
# 创建备份
|
||||
echo "创建备份..."
|
||||
mkdir -p $BACKUP_PATH
|
||||
cp -r $PROJECT_PATH $BACKUP_PATH/backup-$(date +%Y%m%d-%H%M%S)
|
||||
|
||||
# 进入项目目录
|
||||
cd $PROJECT_PATH
|
||||
|
||||
# 拉取最新代码
|
||||
echo "拉取最新代码..."
|
||||
git pull origin main
|
||||
|
||||
# 安装/更新依赖
|
||||
echo "安装依赖..."
|
||||
pnpm install --frozen-lockfile
|
||||
|
||||
# 构建项目
|
||||
echo "构建项目..."
|
||||
pnpm run build
|
||||
|
||||
# 重启服务
|
||||
echo "重启服务..."
|
||||
if command -v pm2 &> /dev/null; then
|
||||
# 使用 PM2
|
||||
pm2 restart pixel-game-server || pm2 start dist/main.js --name pixel-game-server
|
||||
elif command -v docker-compose &> /dev/null; then
|
||||
# 使用 Docker Compose
|
||||
docker-compose down
|
||||
docker-compose up -d --build
|
||||
else
|
||||
# 使用 systemd
|
||||
sudo systemctl restart pixel-game-server
|
||||
fi
|
||||
|
||||
echo "部署完成!"
|
||||
|
||||
# 清理旧备份(保留最近5个)
|
||||
find $BACKUP_PATH -maxdepth 1 -type d -name "backup-*" | sort -r | tail -n +6 | xargs rm -rf
|
||||
|
||||
echo "服务状态检查..."
|
||||
sleep 5
|
||||
curl -f http://localhost:3000/health || echo "警告:服务健康检查失败"
|
||||
@@ -1,36 +0,0 @@
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
app:
|
||||
build: .
|
||||
ports:
|
||||
- "3000:3000"
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
- DB_HOST=mysql
|
||||
- DB_PORT=3306
|
||||
- DB_USERNAME=pixel_game
|
||||
- DB_PASSWORD=your_password
|
||||
- DB_NAME=pixel_game_db
|
||||
depends_on:
|
||||
- mysql
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ./logs:/app/logs
|
||||
|
||||
mysql:
|
||||
image: mysql:8.0
|
||||
environment:
|
||||
- MYSQL_ROOT_PASSWORD=root_password
|
||||
- MYSQL_DATABASE=pixel_game_db
|
||||
- MYSQL_USER=pixel_game
|
||||
- MYSQL_PASSWORD=your_password
|
||||
ports:
|
||||
- "3306:3306"
|
||||
volumes:
|
||||
- mysql_data:/var/lib/mysql
|
||||
- ./init.sql:/docker-entrypoint-initdb.d/init.sql
|
||||
restart: unless-stopped
|
||||
|
||||
volumes:
|
||||
mysql_data:
|
||||
@@ -1,257 +0,0 @@
|
||||
# API 状态码说明
|
||||
|
||||
## 📊 概述
|
||||
|
||||
本文档说明了项目中使用的 HTTP 状态码,特别是针对邮件发送功能的特殊状态码处理。
|
||||
|
||||
## 🔢 标准状态码
|
||||
|
||||
| 状态码 | 含义 | 使用场景 |
|
||||
|--------|------|----------|
|
||||
| 200 | OK | 请求成功 |
|
||||
| 201 | Created | 资源创建成功(如用户注册) |
|
||||
| 400 | Bad Request | 请求参数错误 |
|
||||
| 401 | Unauthorized | 未授权(如密码错误) |
|
||||
| 403 | Forbidden | 权限不足 |
|
||||
| 404 | Not Found | 资源不存在 |
|
||||
| 409 | Conflict | 资源冲突(如用户名已存在) |
|
||||
| 429 | Too Many Requests | 请求频率过高 |
|
||||
| 500 | Internal Server Error | 服务器内部错误 |
|
||||
|
||||
## 🎯 特殊状态码
|
||||
|
||||
### 206 Partial Content - 测试模式
|
||||
|
||||
**使用场景:** 邮件发送功能在测试模式下使用
|
||||
|
||||
**含义:** 请求部分成功,但未完全达到预期效果
|
||||
|
||||
**具体应用:**
|
||||
- 验证码已生成,但邮件未真实发送
|
||||
- 功能正常工作,但处于测试/开发模式
|
||||
- 用户可以获得验证码进行测试,但需要知道这不是真实发送
|
||||
|
||||
**响应示例:**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"data": {
|
||||
"verification_code": "123456",
|
||||
"is_test_mode": true
|
||||
},
|
||||
"message": "⚠️ 测试模式:验证码已生成但未真实发送。请在控制台查看验证码,或配置邮件服务以启用真实发送。",
|
||||
"error_code": "TEST_MODE_ONLY"
|
||||
}
|
||||
```
|
||||
|
||||
## 📧 邮件发送接口状态码
|
||||
|
||||
### 发送邮箱验证码 - POST /auth/send-email-verification
|
||||
|
||||
| 状态码 | 场景 | 响应 |
|
||||
|--------|------|------|
|
||||
| 200 | 邮件真实发送成功 | `{ "success": true, "message": "验证码已发送,请查收邮件" }` |
|
||||
| 206 | 测试模式 | `{ "success": false, "error_code": "TEST_MODE_ONLY", "data": { "verification_code": "123456", "is_test_mode": true } }` |
|
||||
| 400 | 参数错误 | `{ "success": false, "message": "邮箱格式错误" }` |
|
||||
| 429 | 发送频率过高 | `{ "success": false, "message": "发送频率过高,请稍后重试" }` |
|
||||
|
||||
### 发送密码重置验证码 - POST /auth/forgot-password
|
||||
|
||||
| 状态码 | 场景 | 响应 |
|
||||
|--------|------|------|
|
||||
| 200 | 邮件真实发送成功 | `{ "success": true, "message": "验证码已发送,请查收" }` |
|
||||
| 206 | 测试模式 | `{ "success": false, "error_code": "TEST_MODE_ONLY", "data": { "verification_code": "123456", "is_test_mode": true } }` |
|
||||
| 400 | 参数错误 | `{ "success": false, "message": "邮箱格式错误" }` |
|
||||
| 404 | 用户不存在 | `{ "success": false, "message": "用户不存在" }` |
|
||||
|
||||
### 重新发送邮箱验证码 - POST /auth/resend-email-verification
|
||||
|
||||
| 状态码 | 场景 | 响应 |
|
||||
|--------|------|------|
|
||||
| 200 | 邮件真实发送成功 | `{ "success": true, "message": "验证码已重新发送,请查收邮件" }` |
|
||||
| 206 | 测试模式 | `{ "success": false, "error_code": "TEST_MODE_ONLY", "data": { "verification_code": "123456", "is_test_mode": true } }` |
|
||||
| 400 | 邮箱已验证或用户不存在 | `{ "success": false, "message": "邮箱已验证,无需重复验证" }` |
|
||||
| 429 | 发送频率过高 | `{ "success": false, "message": "发送频率过高,请稍后重试" }` |
|
||||
|
||||
## 🔄 模式切换
|
||||
|
||||
### 测试模式 → 真实发送模式
|
||||
|
||||
**配置前(测试模式):**
|
||||
```bash
|
||||
curl -X POST http://localhost:3000/auth/send-email-verification \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"email": "test@example.com"}'
|
||||
|
||||
# 响应:206 Partial Content
|
||||
{
|
||||
"success": false,
|
||||
"data": {
|
||||
"verification_code": "123456",
|
||||
"is_test_mode": true
|
||||
},
|
||||
"message": "⚠️ 测试模式:验证码已生成但未真实发送...",
|
||||
"error_code": "TEST_MODE_ONLY"
|
||||
}
|
||||
```
|
||||
|
||||
**配置后(真实发送模式):**
|
||||
```bash
|
||||
# 同样的请求
|
||||
curl -X POST http://localhost:3000/auth/send-email-verification \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"email": "test@example.com"}'
|
||||
|
||||
# 响应:200 OK
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"is_test_mode": false
|
||||
},
|
||||
"message": "验证码已发送,请查收邮件"
|
||||
}
|
||||
```
|
||||
|
||||
## 💡 前端处理建议
|
||||
|
||||
### JavaScript 示例
|
||||
|
||||
```javascript
|
||||
async function sendEmailVerification(email) {
|
||||
try {
|
||||
const response = await fetch('/auth/send-email-verification', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({ email }),
|
||||
});
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
if (response.status === 200) {
|
||||
// 真实发送成功
|
||||
showSuccess('验证码已发送,请查收邮件');
|
||||
} else if (response.status === 206) {
|
||||
// 测试模式
|
||||
showWarning(`测试模式:验证码是 ${data.data.verification_code}`);
|
||||
showInfo('请配置邮件服务以启用真实发送');
|
||||
} else {
|
||||
// 其他错误
|
||||
showError(data.message);
|
||||
}
|
||||
} catch (error) {
|
||||
showError('网络错误,请稍后重试');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### React 示例
|
||||
|
||||
```jsx
|
||||
const handleSendVerification = async (email) => {
|
||||
try {
|
||||
const response = await fetch('/auth/send-email-verification', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ email }),
|
||||
});
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
switch (response.status) {
|
||||
case 200:
|
||||
setMessage({ type: 'success', text: '验证码已发送,请查收邮件' });
|
||||
break;
|
||||
case 206:
|
||||
setMessage({
|
||||
type: 'warning',
|
||||
text: `测试模式:验证码是 ${data.data.verification_code}`
|
||||
});
|
||||
setShowConfigTip(true);
|
||||
break;
|
||||
case 400:
|
||||
setMessage({ type: 'error', text: data.message });
|
||||
break;
|
||||
case 429:
|
||||
setMessage({ type: 'error', text: '发送频率过高,请稍后重试' });
|
||||
break;
|
||||
default:
|
||||
setMessage({ type: 'error', text: '发送失败,请稍后重试' });
|
||||
}
|
||||
} catch (error) {
|
||||
setMessage({ type: 'error', text: '网络错误,请稍后重试' });
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## 🎨 UI 展示建议
|
||||
|
||||
### 测试模式提示
|
||||
|
||||
```html
|
||||
<!-- 成功状态 (200) -->
|
||||
<div class="alert alert-success">
|
||||
✅ 验证码已发送,请查收邮件
|
||||
</div>
|
||||
|
||||
<!-- 测试模式 (206) -->
|
||||
<div class="alert alert-warning">
|
||||
⚠️ 测试模式:验证码是 123456
|
||||
<br>
|
||||
<small>请配置邮件服务以启用真实发送</small>
|
||||
</div>
|
||||
|
||||
<!-- 错误状态 (400+) -->
|
||||
<div class="alert alert-danger">
|
||||
❌ 发送失败:邮箱格式错误
|
||||
</div>
|
||||
```
|
||||
|
||||
## 📝 开发建议
|
||||
|
||||
### 1. 状态码检查
|
||||
|
||||
```javascript
|
||||
// 推荐:明确检查状态码
|
||||
if (response.status === 206) {
|
||||
// 处理测试模式
|
||||
} else if (response.status === 200) {
|
||||
// 处理真实发送
|
||||
}
|
||||
|
||||
// 不推荐:只检查 success 字段
|
||||
if (data.success) {
|
||||
// 可能遗漏测试模式的情况
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 错误处理
|
||||
|
||||
```javascript
|
||||
// 推荐:根据 error_code 进行精确处理
|
||||
switch (data.error_code) {
|
||||
case 'TEST_MODE_ONLY':
|
||||
handleTestMode(data);
|
||||
break;
|
||||
case 'SEND_CODE_FAILED':
|
||||
handleSendFailure(data);
|
||||
break;
|
||||
default:
|
||||
handleGenericError(data);
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 用户体验
|
||||
|
||||
- **测试模式**:清晰提示用户当前处于测试模式
|
||||
- **配置引导**:提供配置邮件服务的链接或说明
|
||||
- **验证码显示**:在测试模式下直接显示验证码
|
||||
- **状态区分**:用不同的颜色和图标区分不同状态
|
||||
|
||||
## 🔗 相关文档
|
||||
|
||||
- [邮件服务配置指南](./EMAIL_CONFIGURATION.md)
|
||||
- [快速启动指南](./QUICK_START.md)
|
||||
- [API 文档](./api/README.md)
|
||||
773
docs/ARCHITECTURE.md
Normal file
773
docs/ARCHITECTURE.md
Normal file
@@ -0,0 +1,773 @@
|
||||
# 🏗️ Whale Town 项目架构设计
|
||||
|
||||
> 基于业务功能模块化的现代化后端架构,支持双模式运行,开发测试零依赖,生产部署高性能。
|
||||
|
||||
## 📋 目录
|
||||
|
||||
- [🎯 架构概述](#-架构概述)
|
||||
- [📁 目录结构详解](#-目录结构详解)
|
||||
- [🏗️ 分层架构设计](#️-分层架构设计)
|
||||
- [🔄 双模式架构](#-双模式架构)
|
||||
- [📦 模块依赖关系](#-模块依赖关系)
|
||||
- [🚀 扩展指南](#-扩展指南)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 架构概述
|
||||
|
||||
Whale Town 采用**业务功能模块化架构**,将代码按业务功能而非技术组件组织,确保高内聚、低耦合的设计原则。
|
||||
|
||||
### 🌟 核心设计理念
|
||||
|
||||
- **业务驱动** - 按业务功能组织代码,而非技术分层
|
||||
- **双模式支持** - 开发测试零依赖,生产部署高性能
|
||||
- **清晰分层** - 业务层 → 核心层 → 数据层,职责明确
|
||||
- **模块化设计** - 每个模块独立完整,可单独测试和部署
|
||||
- **配置驱动** - 通过环境变量控制运行模式和行为
|
||||
|
||||
### 🛠️ 技术栈
|
||||
|
||||
#### 后端技术栈
|
||||
- **框架**: NestJS 11.x (基于Express)
|
||||
- **语言**: TypeScript 5.x
|
||||
- **数据库**: MySQL + TypeORM (生产) / 内存数据库 (开发)
|
||||
- **缓存**: Redis + IORedis (生产) / 文件存储 (开发)
|
||||
- **认证**: JWT + bcrypt
|
||||
- **验证**: class-validator + class-transformer
|
||||
- **文档**: Swagger/OpenAPI
|
||||
- **测试**: Jest + Supertest
|
||||
- **日志**: Pino + nestjs-pino
|
||||
- **WebSocket**: Socket.IO
|
||||
- **邮件**: Nodemailer
|
||||
- **集成**: Zulip API
|
||||
|
||||
#### 前端技术栈
|
||||
- **框架**: React 18.x
|
||||
- **构建工具**: Vite 7.x
|
||||
- **UI库**: Ant Design 5.x
|
||||
- **路由**: React Router DOM 6.x
|
||||
- **语言**: TypeScript 5.x
|
||||
|
||||
### 📊 整体架构图
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 🌐 API接口层 │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ 🔗 REST API │ │ 🔌 WebSocket │ │ 📄 Swagger UI │ │
|
||||
│ │ (HTTP接口) │ │ (实时通信) │ │ (API文档) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
⬇️
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 🎯 业务功能模块层 │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ 🔐 用户认证 │ │ 👥 用户管理 │ │ 🛡️ 管理员 │ │
|
||||
│ │ (auth) │ │ (user_mgmt) │ │ (admin) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ 💬 Zulip集成 │ │ 🔗 共享组件 │ │ │ │
|
||||
│ │ (zulip) │ │ (shared) │ │ │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
⬇️
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ ⚙️ 核心技术服务层 │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ 🔑 登录核心 │ │ 👑 管理员核心 │ │ 💬 Zulip核心 │ │
|
||||
│ │ (auth_core) │ │ (admin_core) │ │ (zulip) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ 🛡️ 安全核心 │ │ 🛠️ 工具服务 │ │ 📧 邮件服务 │ │
|
||||
│ │ (security_core)│ │ (utils) │ │ (email) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
⬇️
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 🗄️ 数据存储层 │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ 🗃️ 数据库 │ │ 🔴 Redis缓存 │ │ 📁 文件存储 │ │
|
||||
│ │ (MySQL/内存) │ │ (Redis/文件) │ │ (logs/data) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 目录结构详解
|
||||
|
||||
### 🎯 业务功能模块 (`src/business/`)
|
||||
|
||||
> **设计原则**: 按业务功能组织,每个模块包含完整的业务逻辑
|
||||
|
||||
```
|
||||
src/business/
|
||||
├── 📂 auth/ # 🔐 用户认证模块
|
||||
│ ├── 📄 auth.module.ts # 模块定义
|
||||
│ ├── 📂 controllers/ # 控制器
|
||||
│ │ └── 📄 login.controller.ts # 登录接口控制器
|
||||
│ ├── 📂 services/ # 业务服务
|
||||
│ │ ├── 📄 login.service.ts # 登录业务逻辑
|
||||
│ │ └── 📄 login.service.spec.ts # 登录服务测试
|
||||
│ ├── 📂 dto/ # 数据传输对象
|
||||
│ │ ├── 📄 login.dto.ts # 登录请求DTO
|
||||
│ │ └── 📄 login_response.dto.ts # 登录响应DTO
|
||||
│ └── 📂 guards/ # 权限守卫(预留)
|
||||
│
|
||||
├── 📂 user-mgmt/ # 👥 用户管理模块
|
||||
│ ├── 📄 user-mgmt.module.ts # 模块定义
|
||||
│ ├── 📂 controllers/ # 控制器
|
||||
│ │ └── 📄 user-status.controller.ts # 用户状态管理接口
|
||||
│ ├── 📂 services/ # 业务服务
|
||||
│ │ └── 📄 user-management.service.ts # 用户管理逻辑
|
||||
│ ├── 📂 dto/ # 数据传输对象
|
||||
│ │ ├── 📄 user-status.dto.ts # 用户状态DTO
|
||||
│ │ └── 📄 user-status-response.dto.ts # 状态响应DTO
|
||||
│ ├── 📂 enums/ # 枚举定义
|
||||
│ │ └── 📄 user-status.enum.ts # 用户状态枚举
|
||||
│ └── 📂 tests/ # 测试文件(预留)
|
||||
│
|
||||
├── 📂 admin/ # 🛡️ 管理员模块
|
||||
│ ├── 📄 admin.controller.ts # 管理员接口
|
||||
│ ├── 📄 admin.service.ts # 管理员业务逻辑
|
||||
│ ├── 📄 admin.module.ts # 模块定义
|
||||
│ ├── 📄 admin.service.spec.ts # 管理员服务测试
|
||||
│ ├── 📂 dto/ # 数据传输对象
|
||||
│ └── 📂 guards/ # 权限守卫
|
||||
│
|
||||
├── 📂 zulip/ # 💬 Zulip集成模块
|
||||
│ ├── 📄 zulip.service.ts # Zulip业务服务
|
||||
│ ├── 📄 zulip_websocket.gateway.ts # WebSocket网关
|
||||
│ ├── 📄 zulip.module.ts # 模块定义
|
||||
│ ├── 📂 interfaces/ # 接口定义
|
||||
│ └── 📂 services/ # 子服务
|
||||
│ ├── 📄 message_filter.service.ts # 消息过滤
|
||||
│ └── 📄 session_cleanup.service.ts # 会话清理
|
||||
│
|
||||
└── 📂 shared/ # 🔗 共享业务组件
|
||||
├── 📂 dto/ # 共享数据传输对象
|
||||
└── 📄 index.ts # 导出文件
|
||||
```
|
||||
|
||||
### ⚙️ 核心技术服务 (`src/core/`)
|
||||
|
||||
> **设计原则**: 提供技术基础设施,支持业务模块运行
|
||||
|
||||
```
|
||||
src/core/
|
||||
├── 📂 db/ # 🗄️ 数据库层
|
||||
│ └── 📂 users/ # 用户数据服务
|
||||
│ ├── 📄 users.service.ts # MySQL数据库实现
|
||||
│ ├── 📄 users_memory.service.ts # 内存数据库实现
|
||||
│ ├── 📄 users.dto.ts # 用户数据传输对象
|
||||
│ ├── 📄 users.entity.ts # 用户实体定义
|
||||
│ ├── 📄 users.module.ts # 用户数据模块
|
||||
│ └── 📄 users.service.spec.ts # 用户服务测试
|
||||
│
|
||||
├── 📂 redis/ # 🔴 Redis缓存层
|
||||
│ ├── 📄 redis.module.ts # Redis模块
|
||||
│ ├── 📄 real_redis.service.ts # Redis真实实现
|
||||
│ ├── 📄 file_redis.service.ts # 文件存储实现
|
||||
│ └── 📄 redis.interface.ts # Redis服务接口
|
||||
│
|
||||
├── 📂 login_core/ # 🔑 登录核心服务
|
||||
│ ├── 📄 login_core.service.ts # 登录核心逻辑
|
||||
│ ├── 📄 login_core.module.ts # 模块定义
|
||||
│ └── 📄 login_core.service.spec.ts # 登录核心测试
|
||||
│
|
||||
├── 📂 admin_core/ # 👑 管理员核心服务
|
||||
│ ├── 📄 admin_core.service.ts # 管理员核心逻辑
|
||||
│ ├── 📄 admin_core.module.ts # 模块定义
|
||||
│ └── 📄 admin_core.service.spec.ts # 管理员核心测试
|
||||
│
|
||||
├── 📂 zulip_core/ # 💬 Zulip核心服务
|
||||
│ ├── 📄 zulip_core.module.ts # Zulip核心模块
|
||||
│ ├── 📂 config/ # 配置文件
|
||||
│ ├── 📂 interfaces/ # 接口定义
|
||||
│ ├── 📂 services/ # 核心服务
|
||||
│ ├── 📂 types/ # 类型定义
|
||||
│ └── 📄 index.ts # 导出文件
|
||||
│
|
||||
├── 📂 security_core/ # 🛡️ 安全核心模块
|
||||
│ ├── 📄 security_core.module.ts # 安全模块定义
|
||||
│ ├── 📂 guards/ # 安全守卫
|
||||
│ │ └── 📄 throttle.guard.ts # 频率限制守卫
|
||||
│ ├── 📂 interceptors/ # 拦截器
|
||||
│ │ └── 📄 timeout.interceptor.ts # 超时拦截器
|
||||
│ ├── 📂 middleware/ # 中间件
|
||||
│ │ ├── 📄 maintenance.middleware.ts # 维护模式中间件
|
||||
│ │ └── 📄 content_type.middleware.ts # 内容类型中间件
|
||||
│ └── 📂 decorators/ # 装饰器
|
||||
│ ├── 📄 throttle.decorator.ts # 频率限制装饰器
|
||||
│ └── 📄 timeout.decorator.ts # 超时装饰器
|
||||
│
|
||||
└── 📂 utils/ # 🛠️ 工具服务
|
||||
├── 📂 email/ # 📧 邮件服务
|
||||
│ ├── 📄 email.service.ts # 邮件发送服务
|
||||
│ ├── 📄 email.module.ts # 邮件模块
|
||||
│ └── 📄 email.service.spec.ts # 邮件服务测试
|
||||
├── 📂 verification/ # 🔢 验证码服务
|
||||
│ ├── 📄 verification.service.ts # 验证码生成验证
|
||||
│ ├── 📄 verification.module.ts # 验证码模块
|
||||
│ └── 📄 verification.service.spec.ts # 验证码服务测试
|
||||
└── 📂 logger/ # 📝 日志服务
|
||||
├── 📄 logger.service.ts # 日志记录服务
|
||||
├── 📄 logger.module.ts # 日志模块
|
||||
├── 📄 logger.config.ts # 日志配置
|
||||
└── 📄 log_management.service.ts # 日志管理服务
|
||||
```
|
||||
|
||||
### 🎨 前端管理界面 (`client/`)
|
||||
|
||||
> **设计原则**: 独立的前端项目,提供管理员后台功能,基于React + Vite + Ant Design
|
||||
|
||||
```
|
||||
client/
|
||||
├── 📂 src/ # 前端源码
|
||||
│ ├── 📂 app/ # 应用组件
|
||||
│ │ ├── 📄 App.tsx # 应用主组件
|
||||
│ │ └── 📄 AdminLayout.tsx # 管理员布局组件
|
||||
│ ├── 📂 pages/ # 页面组件
|
||||
│ │ ├── 📄 LoginPage.tsx # 登录页面
|
||||
│ │ ├── 📄 UsersPage.tsx # 用户管理页面
|
||||
│ │ └── 📄 LogsPage.tsx # 日志管理页面
|
||||
│ ├── 📂 lib/ # 工具库
|
||||
│ │ ├── 📄 api.ts # API客户端
|
||||
│ │ └── 📄 adminAuth.ts # 管理员认证服务
|
||||
│ └── 📄 main.tsx # 应用入口
|
||||
├── 📂 dist/ # 构建产物
|
||||
├── 📄 package.json # 前端依赖
|
||||
├── 📄 vite.config.ts # Vite配置
|
||||
└── 📄 tsconfig.json # TypeScript配置
|
||||
```
|
||||
|
||||
### 📚 文档中心 (`docs/`)
|
||||
|
||||
> **设计原则**: 完整的项目文档,支持开发者快速上手
|
||||
|
||||
```
|
||||
docs/
|
||||
├── 📄 README.md # 📖 文档导航中心
|
||||
├── 📄 ARCHITECTURE.md # 🏗️ 架构设计文档
|
||||
├── 📄 CONTRIBUTORS.md # 🤝 贡献者指南
|
||||
│
|
||||
├── 📂 api/ # 🔌 API接口文档
|
||||
│ ├── 📄 README.md # API文档使用指南
|
||||
│ └── 📄 api-documentation.md # 完整API接口文档
|
||||
│
|
||||
├── 📂 development/ # 💻 开发指南
|
||||
│ ├── 📄 backend_development_guide.md # 后端开发规范
|
||||
│ ├── 📄 git_commit_guide.md # Git提交规范
|
||||
│ ├── 📄 AI辅助开发规范指南.md # AI辅助开发指南
|
||||
│ └── 📄 TESTING.md # 测试指南
|
||||
│
|
||||
└── 📂 deployment/ # 🚀 部署文档
|
||||
└── 📄 DEPLOYMENT.md # 生产环境部署指南
|
||||
```
|
||||
|
||||
### 🧪 测试文件 (`test/`)
|
||||
|
||||
> **设计原则**: 完整的测试覆盖,确保代码质量
|
||||
|
||||
```
|
||||
test/
|
||||
├── 📂 unit/ # 单元测试
|
||||
├── 📂 integration/ # 集成测试
|
||||
├── 📂 e2e/ # 端到端测试
|
||||
└── 📂 fixtures/ # 测试数据
|
||||
```
|
||||
|
||||
### ⚙️ 配置文件
|
||||
|
||||
> **设计原则**: 清晰的配置管理,支持多环境部署
|
||||
|
||||
```
|
||||
项目根目录/
|
||||
├── 📄 .env # 🔧 环境变量配置
|
||||
├── 📄 .env.example # 🔧 环境变量示例
|
||||
├── 📄 .env.production.example # 🔧 生产环境示例
|
||||
├── 📄 package.json # 📋 后端项目依赖配置
|
||||
├── 📄 pnpm-workspace.yaml # 📦 pnpm工作空间配置
|
||||
├── 📄 tsconfig.json # 📘 TypeScript配置
|
||||
├── 📄 jest.config.js # 🧪 Jest测试配置
|
||||
├── 📄 nest-cli.json # 🏠 NestJS CLI配置
|
||||
└── 📄 ecosystem.config.js # 🚀 PM2进程管理配置
|
||||
|
||||
client/
|
||||
├── 📄 package.json # 📋 前端项目依赖配置
|
||||
├── 📄 vite.config.ts # ⚡ Vite构建配置
|
||||
└── 📄 tsconfig.json # 📘 前端TypeScript配置
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ 分层架构设计
|
||||
|
||||
### 📊 架构分层说明
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 🌐 表现层 (Presentation) │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Controllers │ │ WebSocket │ │ Swagger UI │ │
|
||||
│ │ (HTTP接口) │ │ Gateways │ │ (API文档) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
⬇️
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 🎯 业务层 (Business) │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Auth Module │ │ UserMgmt │ │ Admin Module │ │
|
||||
│ │ (用户认证) │ │ Module │ │ (管理员) │ │
|
||||
│ │ │ │ (用户管理) │ │ │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Security Module │ │ Zulip Module │ │ Shared Module │ │
|
||||
│ │ (安全防护) │ │ (Zulip集成) │ │ (共享组件) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
⬇️
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ ⚙️ 服务层 (Service) │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Login Core │ │ Admin Core │ │ Zulip Core │ │
|
||||
│ │ (登录核心) │ │ (管理员核心) │ │ (Zulip核心) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Email Service │ │ Verification │ │ Logger Service │ │
|
||||
│ │ (邮件服务) │ │ Service │ │ (日志服务) │ │
|
||||
│ │ │ │ (验证码服务) │ │ │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
⬇️
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 🗄️ 数据层 (Data) │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Users Service │ │ Redis Service │ │ File Storage │ │
|
||||
│ │ (用户数据) │ │ (缓存服务) │ │ (文件存储) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ MySQL/Memory │ │ Redis/File │ │ Logs/Data │ │
|
||||
│ │ (数据库) │ │ (缓存实现) │ │ (日志数据) │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 🔄 数据流向
|
||||
|
||||
#### 用户登录流程示例
|
||||
|
||||
```
|
||||
1. 📱 用户请求 → LoginController.login()
|
||||
2. 🔍 参数验证 → class-validator装饰器
|
||||
3. 🎯 业务逻辑 → LoginService.login()
|
||||
4. ⚙️ 核心服务 → LoginCoreService.validateUser()
|
||||
5. 📧 发送验证码 → VerificationService.generate()
|
||||
6. 💾 存储数据 → UsersService.findByEmail() + RedisService.set()
|
||||
7. 📝 记录日志 → LoggerService.log()
|
||||
8. ✅ 返回响应 → 用户收到登录结果
|
||||
```
|
||||
|
||||
#### 管理员操作流程示例
|
||||
|
||||
```
|
||||
1. 🛡️ 管理员请求 → AdminController.resetUserPassword()
|
||||
2. 🔐 权限验证 → AdminGuard.canActivate()
|
||||
3. 🎯 业务逻辑 → AdminService.resetPassword()
|
||||
4. ⚙️ 核心服务 → AdminCoreService.resetUserPassword()
|
||||
5. 🔑 密码加密 → bcrypt.hash()
|
||||
6. 💾 更新数据 → UsersService.update()
|
||||
7. 📧 通知用户 → EmailService.sendPasswordReset()
|
||||
8. 📝 审计日志 → LoggerService.audit()
|
||||
9. ✅ 返回响应 → 管理员收到操作结果
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 双模式架构
|
||||
|
||||
### 🎯 设计目标
|
||||
|
||||
- **开发测试**: 零依赖快速启动,无需安装MySQL、Redis等外部服务
|
||||
- **生产部署**: 高性能、高可用,支持集群和负载均衡
|
||||
|
||||
### 📊 模式对比
|
||||
|
||||
| 功能模块 | 🧪 开发测试模式 | 🚀 生产部署模式 |
|
||||
|----------|----------------|----------------|
|
||||
| **数据库** | 内存存储 (UsersMemoryService) | MySQL (UsersService + TypeORM) |
|
||||
| **缓存** | 文件存储 (FileRedisService) | Redis (RealRedisService + IORedis) |
|
||||
| **邮件** | 控制台输出 (测试模式) | SMTP服务器 (生产模式) |
|
||||
| **日志** | 控制台 + 文件 | 结构化日志 + 日志轮转 |
|
||||
| **配置** | `.env` 默认配置 | 环境变量 + 配置中心 |
|
||||
|
||||
### ⚙️ 模式切换配置
|
||||
|
||||
#### 开发测试模式 (.env)
|
||||
```bash
|
||||
# 数据存储模式
|
||||
USE_FILE_REDIS=true # 使用文件存储代替Redis
|
||||
NODE_ENV=development # 开发环境
|
||||
|
||||
# 数据库配置(注释掉,使用内存数据库)
|
||||
# DB_HOST=localhost
|
||||
# DB_USERNAME=root
|
||||
# DB_PASSWORD=password
|
||||
|
||||
# 邮件配置(注释掉,使用测试模式)
|
||||
# EMAIL_HOST=smtp.gmail.com
|
||||
# EMAIL_USER=your_email@gmail.com
|
||||
# EMAIL_PASS=your_password
|
||||
```
|
||||
|
||||
#### 生产部署模式 (.env.production)
|
||||
```bash
|
||||
# 数据存储模式
|
||||
USE_FILE_REDIS=false # 使用真实Redis
|
||||
NODE_ENV=production # 生产环境
|
||||
|
||||
# 数据库配置
|
||||
DB_HOST=your_mysql_host
|
||||
DB_PORT=3306
|
||||
DB_USERNAME=your_username
|
||||
DB_PASSWORD=your_password
|
||||
DB_DATABASE=whale_town
|
||||
|
||||
# Redis配置
|
||||
REDIS_HOST=your_redis_host
|
||||
REDIS_PORT=6379
|
||||
REDIS_PASSWORD=your_redis_password
|
||||
|
||||
# 邮件配置
|
||||
EMAIL_HOST=smtp.gmail.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_USER=your_email@gmail.com
|
||||
EMAIL_PASS=your_app_password
|
||||
```
|
||||
|
||||
### 🔧 实现机制
|
||||
|
||||
#### 依赖注入切换
|
||||
```typescript
|
||||
// redis.module.ts
|
||||
@Module({
|
||||
providers: [
|
||||
{
|
||||
provide: 'IRedisService',
|
||||
useFactory: (configService: ConfigService) => {
|
||||
const useFileRedis = configService.get<boolean>('USE_FILE_REDIS');
|
||||
return useFileRedis
|
||||
? new FileRedisService()
|
||||
: new RealRedisService(configService);
|
||||
},
|
||||
inject: [ConfigService],
|
||||
},
|
||||
],
|
||||
})
|
||||
export class RedisModule {}
|
||||
```
|
||||
|
||||
#### 配置驱动服务选择
|
||||
```typescript
|
||||
// users.module.ts
|
||||
@Module({
|
||||
providers: [
|
||||
{
|
||||
provide: 'IUsersService',
|
||||
useFactory: (configService: ConfigService) => {
|
||||
const dbHost = configService.get<string>('DB_HOST');
|
||||
return dbHost
|
||||
? new UsersService()
|
||||
: new UsersMemoryService();
|
||||
},
|
||||
inject: [ConfigService],
|
||||
},
|
||||
],
|
||||
})
|
||||
export class UsersModule {}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📦 模块依赖关系
|
||||
|
||||
### 🏗️ 模块依赖图
|
||||
|
||||
```
|
||||
AppModule (应用主模块)
|
||||
├── 📊 ConfigModule (全局配置)
|
||||
├── 📝 LoggerModule (日志系统)
|
||||
├── 🔴 RedisModule (缓存服务)
|
||||
│ ├── RealRedisService (真实Redis)
|
||||
│ └── FileRedisService (文件存储)
|
||||
├── 🗄️ UsersModule (用户数据)
|
||||
│ ├── UsersService (MySQL数据库)
|
||||
│ └── UsersMemoryService (内存数据库)
|
||||
├── 📧 EmailModule (邮件服务)
|
||||
├── 🔢 VerificationModule (验证码服务)
|
||||
├── 🔑 LoginCoreModule (登录核心)
|
||||
├── 👑 AdminCoreModule (管理员核心)
|
||||
├── 💬 ZulipCoreModule (Zulip核心)
|
||||
├── 🔒 SecurityCoreModule (安全核心)
|
||||
│
|
||||
├── 🎯 业务功能模块
|
||||
│ ├── 🔐 AuthModule (用户认证)
|
||||
│ │ └── 依赖: LoginCoreModule, EmailModule, VerificationModule, SecurityCoreModule
|
||||
│ ├── 👥 UserMgmtModule (用户管理)
|
||||
│ │ └── 依赖: UsersModule, LoggerModule, SecurityCoreModule
|
||||
│ ├── 🛡️ AdminModule (管理员)
|
||||
│ │ └── 依赖: AdminCoreModule, UsersModule, SecurityCoreModule
|
||||
│ ├── 💬 ZulipModule (Zulip集成)
|
||||
│ │ └── 依赖: ZulipCoreModule, RedisModule
|
||||
│ └── 🔗 SharedModule (共享组件)
|
||||
```
|
||||
|
||||
### 🔄 模块交互流程
|
||||
|
||||
#### 用户认证流程
|
||||
```
|
||||
AuthController → LoginService → LoginCoreService
|
||||
↓
|
||||
EmailService ← VerificationService ← RedisService
|
||||
↓
|
||||
UsersService
|
||||
```
|
||||
|
||||
#### 管理员操作流程
|
||||
```
|
||||
AdminController → AdminService → AdminCoreService
|
||||
↓
|
||||
LoggerService ← UsersService ← RedisService
|
||||
```
|
||||
|
||||
#### 安全防护流程
|
||||
```
|
||||
SecurityGuard → RedisService (频率限制)
|
||||
→ LoggerService (审计日志)
|
||||
→ ConfigService (维护模式)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 扩展指南
|
||||
|
||||
### 📝 添加新的业务模块
|
||||
|
||||
#### 1. 创建业务模块结构
|
||||
```bash
|
||||
# 创建模块目录
|
||||
mkdir -p src/business/game/{dto,enums,guards,interfaces}
|
||||
|
||||
# 生成NestJS模块文件
|
||||
nest g module business/game
|
||||
nest g controller business/game
|
||||
nest g service business/game
|
||||
```
|
||||
|
||||
#### 2. 实现业务逻辑
|
||||
```typescript
|
||||
// src/business/game/game.module.ts
|
||||
@Module({
|
||||
imports: [
|
||||
GameCoreModule, # 依赖核心服务
|
||||
UsersModule, # 依赖用户数据
|
||||
RedisModule, # 依赖缓存服务
|
||||
],
|
||||
controllers: [GameController],
|
||||
providers: [GameService],
|
||||
exports: [GameService],
|
||||
})
|
||||
export class GameModule {}
|
||||
```
|
||||
|
||||
#### 3. 创建对应的核心服务
|
||||
```bash
|
||||
# 创建核心服务
|
||||
mkdir -p src/core/game_core
|
||||
nest g module core/game_core
|
||||
nest g service core/game_core
|
||||
```
|
||||
|
||||
#### 4. 更新主模块
|
||||
```typescript
|
||||
// src/app.module.ts
|
||||
@Module({
|
||||
imports: [
|
||||
// ... 其他模块
|
||||
GameModule, # 添加新的业务模块
|
||||
],
|
||||
})
|
||||
export class AppModule {}
|
||||
```
|
||||
|
||||
### 🛠️ 添加新的工具服务
|
||||
|
||||
#### 1. 创建工具服务
|
||||
```bash
|
||||
mkdir -p src/core/utils/notification
|
||||
nest g module core/utils/notification
|
||||
nest g service core/utils/notification
|
||||
```
|
||||
|
||||
#### 2. 定义服务接口
|
||||
```typescript
|
||||
// src/core/utils/notification/notification.interface.ts
|
||||
export interface INotificationService {
|
||||
sendPush(userId: string, message: string): Promise<void>;
|
||||
sendSMS(phone: string, message: string): Promise<void>;
|
||||
}
|
||||
```
|
||||
|
||||
#### 3. 实现服务
|
||||
```typescript
|
||||
// src/core/utils/notification/notification.service.ts
|
||||
@Injectable()
|
||||
export class NotificationService implements INotificationService {
|
||||
async sendPush(userId: string, message: string): Promise<void> {
|
||||
// 实现推送通知逻辑
|
||||
}
|
||||
|
||||
async sendSMS(phone: string, message: string): Promise<void> {
|
||||
// 实现短信发送逻辑
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 4. 配置依赖注入
|
||||
```typescript
|
||||
// src/core/utils/notification/notification.module.ts
|
||||
@Module({
|
||||
providers: [
|
||||
{
|
||||
provide: 'INotificationService',
|
||||
useClass: NotificationService,
|
||||
},
|
||||
],
|
||||
exports: ['INotificationService'],
|
||||
})
|
||||
export class NotificationModule {}
|
||||
```
|
||||
|
||||
### 🔌 添加新的API接口
|
||||
|
||||
#### 1. 定义DTO
|
||||
```typescript
|
||||
// src/business/game/dto/create-game.dto.ts
|
||||
export class CreateGameDto {
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
name: string;
|
||||
|
||||
@IsString()
|
||||
@IsOptional()
|
||||
description?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### 2. 实现Controller
|
||||
```typescript
|
||||
// src/business/game/game.controller.ts
|
||||
@Controller('game')
|
||||
@ApiTags('游戏管理')
|
||||
export class GameController {
|
||||
constructor(private readonly gameService: GameService) {}
|
||||
|
||||
@Post()
|
||||
@ApiOperation({ summary: '创建游戏' })
|
||||
async createGame(@Body() createGameDto: CreateGameDto) {
|
||||
return this.gameService.create(createGameDto);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 3. 实现Service
|
||||
```typescript
|
||||
// src/business/game/game.service.ts
|
||||
@Injectable()
|
||||
export class GameService {
|
||||
constructor(
|
||||
@Inject('IGameCoreService')
|
||||
private readonly gameCoreService: IGameCoreService,
|
||||
) {}
|
||||
|
||||
async create(createGameDto: CreateGameDto) {
|
||||
return this.gameCoreService.createGame(createGameDto);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 4. 添加测试用例
|
||||
```typescript
|
||||
// src/business/game/game.service.spec.ts
|
||||
describe('GameService', () => {
|
||||
let service: GameService;
|
||||
let gameCoreService: jest.Mocked<IGameCoreService>;
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
providers: [
|
||||
GameService,
|
||||
{
|
||||
provide: 'IGameCoreService',
|
||||
useValue: {
|
||||
createGame: jest.fn(),
|
||||
},
|
||||
},
|
||||
],
|
||||
}).compile();
|
||||
|
||||
service = module.get<GameService>(GameService);
|
||||
gameCoreService = module.get('IGameCoreService');
|
||||
});
|
||||
|
||||
it('should create game', async () => {
|
||||
const createGameDto = { name: 'Test Game' };
|
||||
const expectedResult = { id: 1, ...createGameDto };
|
||||
|
||||
gameCoreService.createGame.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await service.create(createGameDto);
|
||||
|
||||
expect(result).toEqual(expectedResult);
|
||||
expect(gameCoreService.createGame).toHaveBeenCalledWith(createGameDto);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
### 📊 性能优化建议
|
||||
|
||||
#### 1. 缓存策略
|
||||
- **Redis缓存**: 用户会话、验证码、频繁查询数据
|
||||
- **内存缓存**: 配置信息、静态数据
|
||||
- **CDN缓存**: 静态资源文件
|
||||
|
||||
#### 2. 数据库优化
|
||||
- **连接池**: 复用数据库连接,减少连接开销
|
||||
- **索引优化**: 为查询字段建立合适的索引
|
||||
- **查询优化**: 避免N+1查询,使用JOIN优化关联查询
|
||||
|
||||
#### 3. 日志优化
|
||||
- **异步日志**: 使用Pino的异步写入功能
|
||||
- **日志分级**: 生产环境只记录ERROR和WARN级别
|
||||
- **日志轮转**: 自动清理过期日志文件
|
||||
|
||||
### 🔒 安全加固建议
|
||||
|
||||
#### 1. 数据验证
|
||||
- **输入验证**: 使用class-validator进行严格验证
|
||||
- **类型检查**: TypeScript静态类型检查
|
||||
- **SQL注入防护**: TypeORM参数化查询
|
||||
|
||||
#### 2. 认证授权
|
||||
- **密码安全**: bcrypt加密,强密码策略
|
||||
- **会话管理**: JWT + Redis会话存储
|
||||
- **权限控制**: 基于角色的访问控制(RBAC)
|
||||
|
||||
#### 3. 通信安全
|
||||
- **HTTPS**: 生产环境强制HTTPS
|
||||
- **CORS**: 严格的跨域请求控制
|
||||
- **Rate Limiting**: API请求频率限制
|
||||
|
||||
---
|
||||
|
||||
**🏗️ 通过清晰的架构设计,Whale Town 实现了高内聚、低耦合的模块化架构,支持快速开发和灵活部署!**
|
||||
148
docs/CONTRIBUTORS.md
Normal file
148
docs/CONTRIBUTORS.md
Normal file
@@ -0,0 +1,148 @@
|
||||
# 贡献者名单
|
||||
|
||||
感谢所有为 Whale Town 项目做出贡献的开发者们!🎉
|
||||
|
||||
## 核心贡献者
|
||||
|
||||
### 🏆 主要维护者
|
||||
|
||||
**moyin** - 主要维护者
|
||||
- Gitea: [@moyin](https://gitea.xinghangee.icu/moyin)
|
||||
- Email: xinghang_a@proton.me
|
||||
- 提交数: **112 commits**
|
||||
- 主要贡献:
|
||||
- 🚀 项目架构设计与初始化
|
||||
- 🔐 完整用户认证系统实现
|
||||
- 📧 邮箱验证系统设计与开发
|
||||
- 🗄️ Redis缓存服务(文件存储+真实Redis双模式)
|
||||
- 📝 完整的API文档系统(Swagger UI + OpenAPI)
|
||||
- 🧪 测试框架搭建与507个测试用例编写
|
||||
- 📊 高性能日志系统集成(Pino)
|
||||
- 🔧 项目配置优化与部署方案
|
||||
- 🐛 验证码TTL重置关键问题修复
|
||||
- 📚 完整的项目文档体系建设
|
||||
- 🏗️ **Zulip模块架构重构** - 业务功能模块化架构设计与实现
|
||||
- 📖 **架构文档重写** - 详细的架构设计文档和开发者指南
|
||||
- 🔄 **验证码冷却时间优化** - 自动清除机制设计与实现
|
||||
- 📋 **文档清理优化** - 项目文档结构化整理和维护体系建立
|
||||
|
||||
### 🌟 核心开发者
|
||||
|
||||
**angjustinl** - 核心开发者
|
||||
- Gitea: [@ANGJustinl](https://gitea.xinghangee.icu/ANGJustinl)
|
||||
- GitHub: [@ANGJustinl](https://github.com/ANGJustinl)
|
||||
- Email: 96008766+ANGJustinl@users.noreply.github.com
|
||||
- 提交数: **7 commits**
|
||||
- 主要贡献:
|
||||
- 🔄 邮箱验证流程重构与优化
|
||||
- 💾 基于内存的用户服务实现
|
||||
- 🛠️ API响应处理改进
|
||||
- 🧪 测试用例完善与错误修复
|
||||
- 📚 系统架构优化
|
||||
- 💬 **Zulip集成系统** - 完整的Zulip实时通信系统开发
|
||||
- 🔧 **E2E测试修复** - Zulip集成的端到端测试优化
|
||||
- 🎯 **验证码登录测试** - 验证码登录功能测试用例编写
|
||||
|
||||
**jianuo** - 核心开发者
|
||||
- Gitea: [@jianuo](https://gitea.xinghangee.icu/jianuo)
|
||||
- Email: 32106500027@e.gzhu.edu.cn
|
||||
- 提交数: **11 commits**
|
||||
- 主要贡献:
|
||||
- 🎛️ **管理员后台系统** - 完整的前后端管理界面开发
|
||||
- 📊 **日志管理功能** - 运行时日志查看与下载系统
|
||||
- 🔐 **管理员认证系统** - 独立Token认证与权限控制
|
||||
- 🧪 **单元测试完善** - 管理员功能测试用例编写
|
||||
- ⚙️ **TypeScript配置优化** - Node16模块解析配置
|
||||
- 🐳 **Docker部署优化** - 容器化部署问题修复
|
||||
- 📖 **技术栈文档更新** - 项目技术栈说明完善
|
||||
- 🔧 **项目配置优化** - 构建和开发环境配置改进
|
||||
|
||||
## 贡献统计
|
||||
|
||||
| 贡献者 | 提交数 | 主要领域 | 贡献占比 |
|
||||
|--------|--------|----------|----------|
|
||||
| moyin | 112 | 架构设计、核心功能、文档、测试、Zulip重构 | 86% |
|
||||
| jianuo | 11 | 管理员后台、日志系统、部署优化、配置管理 | 8% |
|
||||
| angjustinl | 7 | Zulip集成、功能优化、测试、重构 | 5% |
|
||||
|
||||
## 🌟 最新重要贡献
|
||||
|
||||
### 🏗️ Zulip模块架构重构 (2025年12月31日)
|
||||
**主要贡献者**: moyin, angjustinl
|
||||
|
||||
这是项目历史上最重要的架构重构之一:
|
||||
|
||||
- **架构重构**: 实现业务功能模块化架构,将Zulip模块按照业务层和核心层进行清晰分离
|
||||
- **代码迁移**: 36个文件的重构和迁移,涉及2773行代码的新增和125行的删除
|
||||
- **依赖注入**: 通过接口抽象实现业务层与核心层的完全解耦
|
||||
- **测试完善**: 所有507个测试用例通过,确保重构的安全性
|
||||
|
||||
### 📚 项目文档体系优化 (2025年12月31日)
|
||||
**主要贡献者**: moyin
|
||||
|
||||
- **架构文档重写**: `docs/ARCHITECTURE.md` 从简单架构图扩展为800+行的完整架构设计文档
|
||||
- **README优化**: 采用总分结构设计,详细的文件结构总览
|
||||
- **文档清理**: 新增 `docs/DOCUMENT_CLEANUP.md` 记录文档维护过程
|
||||
- **开发者体验**: 建立完整的文档导航体系,提升开发者上手体验
|
||||
|
||||
### 💬 Zulip集成系统 (2025年12月25日)
|
||||
**主要贡献者**: angjustinl
|
||||
|
||||
- **完整集成**: 实现与Zulip的完整集成,支持实时通信功能
|
||||
- **WebSocket支持**: 建立稳定的WebSocket连接和消息处理机制
|
||||
- **测试覆盖**: 完善的E2E测试确保集成功能的稳定性
|
||||
|
||||
## 项目里程碑
|
||||
|
||||
### 2025年12月
|
||||
- **12月17日**: 项目初始化,完成基础架构搭建
|
||||
- **12月17日**: 实现完整的用户认证系统
|
||||
- **12月17日**: 完成API文档系统集成
|
||||
- **12月17日**: 实现邮箱验证系统
|
||||
- **12月17日**: 修复验证码TTL重置关键问题
|
||||
- **12月18日**: angjustinl重构邮箱验证流程,引入内存用户服务
|
||||
- **12月18日**: jianuo修复Docker部署问题
|
||||
- **12月18日**: 完成测试用例修复和优化
|
||||
- **12月19日**: jianuo开发管理员后台系统
|
||||
- **12月20日**: jianuo完善日志管理功能
|
||||
- **12月21日**: jianuo添加管理员后台单元测试
|
||||
- **12月22日**: 管理员后台功能合并到主分支
|
||||
- **12月25日**: angjustinl开发完整的Zulip集成系统
|
||||
- **12月25日**: 实现验证码冷却时间自动清除机制
|
||||
- **12月25日**: 完成邮箱冲突检测优化v1.1.1
|
||||
- **12月25日**: 升级项目版本到v1.1.0
|
||||
- **12月31日**: **重大架构重构** - 完成Zulip模块业务功能模块化架构重构
|
||||
- **12月31日**: **文档体系优化** - 项目文档结构化整理和架构文档重写
|
||||
- **12月31日**: **测试覆盖完善** - 所有507个测试用例通过,测试覆盖率达到新高
|
||||
|
||||
## 如何成为贡献者
|
||||
|
||||
我们欢迎所有形式的贡献!无论是:
|
||||
|
||||
- 🐛 **Bug修复** - 发现并修复问题
|
||||
- ✨ **新功能** - 添加有价值的功能
|
||||
- 📚 **文档改进** - 完善项目文档
|
||||
- 🧪 **测试用例** - 提高代码覆盖率
|
||||
- 🎨 **代码优化** - 改进代码质量
|
||||
- 💡 **建议反馈** - 提出改进建议
|
||||
|
||||
### 贡献流程
|
||||
|
||||
1. Fork 项目到你的Gitea账户
|
||||
2. 创建功能分支:`git checkout -b feature/your-feature`
|
||||
3. 提交你的更改:`git commit -m "feat:添加新功能"`
|
||||
4. 推送到分支:`git push origin feature/your-feature`
|
||||
5. 创建Pull Request
|
||||
|
||||
### 贡献规范
|
||||
|
||||
请在贡献前阅读:
|
||||
- [AI辅助开发规范指南](./docs/AI辅助开发规范指南.md)
|
||||
- [后端开发规范](./docs/backend_development_guide.md)
|
||||
- [Git提交规范](./docs/git_commit_guide.md)
|
||||
|
||||
---
|
||||
|
||||
**再次感谢所有贡献者的辛勤付出!** 🙏
|
||||
|
||||
*如果你的名字没有出现在列表中,请联系我们或提交PR更新此文件。*
|
||||
202
docs/README.md
202
docs/README.md
@@ -1,139 +1,107 @@
|
||||
# 项目文档
|
||||
# 📚 Pixel Game Server 文档中心
|
||||
|
||||
本目录包含了像素游戏服务器的完整文档。
|
||||
欢迎来到 Whale Town 项目文档中心!这里包含了项目的完整文档,帮助你快速了解和使用项目。
|
||||
|
||||
## 文档结构
|
||||
## 📖 **文档导航**
|
||||
|
||||
### 📁 api/
|
||||
API接口相关文档,包含:
|
||||
- **api-documentation.md** - 详细的API接口文档
|
||||
- **openapi.yaml** - OpenAPI 3.0规范文件
|
||||
- **postman-collection.json** - Postman测试集合
|
||||
- **README.md** - API文档使用说明
|
||||
### 🚀 **快速开始**
|
||||
- [项目概述](../README.md) - 项目介绍和快速开始指南
|
||||
- [架构设计](ARCHITECTURE.md) - 系统架构和设计理念
|
||||
|
||||
### 📁 systems/
|
||||
系统设计文档,包含:
|
||||
- **logger/** - 日志系统文档
|
||||
- **user-auth/** - 用户认证系统文档
|
||||
### 🔌 **API文档**
|
||||
- [API接口文档](api/api-documentation.md) - 完整的API接口说明(17个接口)
|
||||
- [API状态码](API_STATUS_CODES.md) - HTTP状态码和错误代码说明
|
||||
- [OpenAPI规范](api/openapi.yaml) - 机器可读的API规范文件
|
||||
- [API使用指南](api/README.md) - API文档使用说明
|
||||
|
||||
### 📄 其他文档
|
||||
- **AI辅助开发规范指南.md** - AI开发规范
|
||||
- **backend_development_guide.md** - 后端开发指南
|
||||
- **git_commit_guide.md** - Git提交规范
|
||||
- **naming_convention.md** - 命名规范
|
||||
- **nestjs_guide.md** - NestJS开发指南
|
||||
- **日志系统详细说明.md** - 日志系统说明
|
||||
### 💻 **开发指南**
|
||||
- [后端开发指南](development/backend_development_guide.md) - 后端开发规范和最佳实践
|
||||
- [NestJS指南](development/nestjs_guide.md) - NestJS框架使用指南
|
||||
- [命名规范](development/naming_convention.md) - 代码命名规范
|
||||
- [Git提交规范](development/git_commit_guide.md) - Git提交消息规范
|
||||
- [AI辅助开发规范](development/AI辅助开发规范指南.md) - AI辅助开发最佳实践
|
||||
- [测试指南](development/TESTING.md) - 测试策略和规范
|
||||
|
||||
## 如何使用
|
||||
### 🚀 **部署运维**
|
||||
- [部署指南](deployment/DEPLOYMENT.md) - 生产环境部署说明
|
||||
|
||||
### 1. 启动服务器并查看Swagger文档
|
||||
### 📋 **项目管理**
|
||||
- [贡献指南](CONTRIBUTORS.md) - 如何参与项目贡献
|
||||
- [文档清理说明](DOCUMENT_CLEANUP.md) - 文档维护和优化记录
|
||||
|
||||
```bash
|
||||
# 启动开发服务器
|
||||
pnpm run dev
|
||||
## 🏗️ **文档结构说明**
|
||||
|
||||
# 访问Swagger UI
|
||||
# 浏览器打开: http://localhost:3000/api-docs
|
||||
```
|
||||
docs/
|
||||
├── README.md # 📚 文档中心首页
|
||||
├── ARCHITECTURE.md # 🏗️ 架构文档
|
||||
├── API_STATUS_CODES.md # 📋 API状态码
|
||||
├── CONTRIBUTORS.md # 🤝 贡献指南
|
||||
├── DOCUMENT_CLEANUP.md # 📝 文档清理说明
|
||||
│
|
||||
├── api/ # 🔌 API文档
|
||||
│ ├── api-documentation.md # API接口文档
|
||||
│ ├── openapi.yaml # OpenAPI规范
|
||||
│ ├── postman-collection.json # Postman测试集合
|
||||
│ └── README.md # API文档说明
|
||||
│
|
||||
├── development/ # 💻 开发指南
|
||||
│ ├── backend_development_guide.md
|
||||
│ ├── nestjs_guide.md
|
||||
│ ├── naming_convention.md
|
||||
│ ├── git_commit_guide.md
|
||||
│ ├── AI辅助开发规范指南.md
|
||||
│ └── TESTING.md
|
||||
│
|
||||
└── deployment/ # 🚀 部署文档
|
||||
└── DEPLOYMENT.md
|
||||
```
|
||||
|
||||
### 2. 使用Postman测试API
|
||||
## 🎯 **文档特色**
|
||||
|
||||
1. 打开Postman
|
||||
2. 点击 Import 按钮
|
||||
3. 选择 `docs/postman-collection.json` 文件
|
||||
4. 导入后即可看到所有API接口
|
||||
5. 修改环境变量 `baseUrl` 为你的服务器地址(默认:http://localhost:3000)
|
||||
### ✨ **业务功能模块化**
|
||||
文档结构与代码架构保持一致,按业务功能组织:
|
||||
- **用户认证模块** - 登录、注册、密码管理
|
||||
- **用户管理模块** - 状态管理、批量操作
|
||||
- **管理员模块** - 后台管理、权限控制
|
||||
- **安全模块** - 频率限制、维护模式
|
||||
|
||||
### 3. 使用OpenAPI规范
|
||||
### 📊 **完整API覆盖**
|
||||
- **17个API接口** - 涵盖所有业务功能
|
||||
- **交互式文档** - Swagger UI实时测试
|
||||
- **标准化规范** - OpenAPI 3.0标准
|
||||
- **测试集合** - Postman一键导入
|
||||
|
||||
#### 在Swagger Editor中查看
|
||||
1. 访问 [Swagger Editor](https://editor.swagger.io/)
|
||||
2. 将 `docs/openapi.yaml` 的内容复制粘贴到编辑器中
|
||||
3. 即可查看可视化的API文档
|
||||
### 🔧 **开发者友好**
|
||||
- **规范指导** - 命名、提交、开发规范
|
||||
- **AI辅助** - 提升开发效率的AI使用指南
|
||||
- **测试覆盖** - 140个测试用例全覆盖
|
||||
- **部署就绪** - 生产环境部署指南
|
||||
|
||||
#### 生成客户端SDK
|
||||
```bash
|
||||
# 使用swagger-codegen生成JavaScript客户端
|
||||
swagger-codegen generate -i docs/openapi.yaml -l javascript -o ./client-sdk
|
||||
## 📝 **文档维护原则**
|
||||
|
||||
# 使用openapi-generator生成TypeScript客户端
|
||||
openapi-generator generate -i docs/openapi.yaml -g typescript-axios -o ./client-sdk
|
||||
```
|
||||
### ✅ **保留的文档类型**
|
||||
- **长期有用**:对整个项目生命周期都有价值的文档
|
||||
- **参考价值**:开发、部署、维护时需要查阅的文档
|
||||
- **规范指南**:团队协作和代码质量保证的规范
|
||||
|
||||
## API接口概览
|
||||
### ❌ **不保留的文档类型**
|
||||
- **阶段性文档**:只在特定开发阶段有用的文档
|
||||
- **临时记录**:会议记录、临时决策等
|
||||
- **过时信息**:已经不适用的旧版本文档
|
||||
|
||||
| 接口 | 方法 | 路径 | 描述 |
|
||||
|------|------|------|------|
|
||||
| 用户登录 | POST | /auth/login | 支持用户名、邮箱或手机号登录 |
|
||||
| 用户注册 | POST | /auth/register | 创建新用户账户 |
|
||||
| GitHub OAuth | POST | /auth/github | 使用GitHub账户登录或注册 |
|
||||
| 发送验证码 | POST | /auth/forgot-password | 发送密码重置验证码 |
|
||||
| 重置密码 | POST | /auth/reset-password | 使用验证码重置密码 |
|
||||
| 修改密码 | PUT | /auth/change-password | 修改用户密码 |
|
||||
### 🔄 **文档更新策略**
|
||||
- **及时更新**:功能变更时同步更新相关文档
|
||||
- **版本控制**:重要变更记录版本历史
|
||||
- **定期审查**:定期检查文档的准确性和有效性
|
||||
|
||||
## 快速测试
|
||||
## 🤝 **如何贡献文档**
|
||||
|
||||
### 使用cURL测试登录接口
|
||||
1. **发现问题**:发现文档错误或缺失时,请提交Issue
|
||||
2. **改进文档**:按照项目规范提交Pull Request
|
||||
3. **新增文档**:新功能开发时同步编写相关文档
|
||||
4. **审查文档**:参与文档审查,确保质量和准确性
|
||||
|
||||
```bash
|
||||
# 测试用户登录
|
||||
curl -X POST http://localhost:3000/auth/login \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"identifier": "testuser",
|
||||
"password": "password123"
|
||||
}'
|
||||
---
|
||||
|
||||
# 测试用户注册
|
||||
curl -X POST http://localhost:3000/auth/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "newuser",
|
||||
"password": "password123",
|
||||
"nickname": "新用户",
|
||||
"email": "newuser@example.com"
|
||||
}'
|
||||
```
|
||||
|
||||
### 使用JavaScript测试
|
||||
|
||||
```javascript
|
||||
// 用户登录
|
||||
const response = await fetch('http://localhost:3000/auth/login', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({
|
||||
identifier: 'testuser',
|
||||
password: 'password123'
|
||||
})
|
||||
});
|
||||
|
||||
const data = await response.json();
|
||||
console.log(data);
|
||||
```
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **开发环境**: 当前配置适用于开发环境,生产环境需要使用HTTPS
|
||||
2. **认证**: 实际应用中应实现JWT认证机制
|
||||
3. **限流**: 建议对认证接口实施限流策略
|
||||
4. **验证码**: 示例中返回验证码仅用于演示,生产环境不应返回
|
||||
5. **错误处理**: 建议实现统一的错误处理机制
|
||||
|
||||
## 更新文档
|
||||
|
||||
当API接口发生变化时,请同步更新以下文件:
|
||||
1. 更新DTO类的Swagger装饰器
|
||||
2. 更新 `api-documentation.md`
|
||||
3. 更新 `openapi.yaml`
|
||||
4. 更新 `postman-collection.json`
|
||||
5. 重新生成Swagger文档
|
||||
|
||||
## 相关链接
|
||||
|
||||
- [NestJS Swagger文档](https://docs.nestjs.com/openapi/introduction)
|
||||
- [OpenAPI规范](https://swagger.io/specification/)
|
||||
- [Postman文档](https://learning.postman.com/docs/getting-started/introduction/)
|
||||
- [Swagger Editor](https://editor.swagger.io/)
|
||||
📧 **联系我们**:如有文档相关问题,请通过项目Issue或邮件联系维护团队。
|
||||
@@ -1,29 +1,30 @@
|
||||
# API接口文档
|
||||
|
||||
本目录包含了像素游戏服务器用户认证API的完整文档。
|
||||
本目录包含了 Whale Town 像素游戏服务器的完整API文档,采用业务功能模块化设计,提供17个接口覆盖所有核心功能。
|
||||
|
||||
## 📋 文档文件说明
|
||||
|
||||
### 1. api-documentation.md
|
||||
详细的API接口文档,包含:
|
||||
- **17个API接口** - 用户认证、用户管理、管理员功能、安全防护
|
||||
- 接口概述和通用响应格式
|
||||
- 每个接口的详细说明、参数、响应示例
|
||||
- 错误代码说明
|
||||
- 数据验证规则
|
||||
- 错误代码说明和状态码映射
|
||||
- 数据验证规则和业务逻辑
|
||||
- 使用示例(JavaScript/TypeScript 和 cURL)
|
||||
|
||||
### 2. openapi.yaml
|
||||
OpenAPI 3.0规范文件,可以用于:
|
||||
- 导入到Swagger Editor查看和编辑
|
||||
- 生成客户端SDK
|
||||
- 集成到API网关
|
||||
- 自动化测试
|
||||
- 生成客户端SDK(支持多种语言)
|
||||
- 集成到API网关和测试工具
|
||||
- 自动化测试和文档生成
|
||||
|
||||
### 3. postman-collection.json
|
||||
Postman集合文件,包含:
|
||||
- 所有API接口的请求示例
|
||||
- 预设的请求参数
|
||||
- 响应示例
|
||||
- 所有17个API接口的请求示例
|
||||
- 预设的请求参数和环境变量
|
||||
- 完整的响应示例和测试脚本
|
||||
- 可直接导入Postman进行测试
|
||||
|
||||
## 🚀 快速开始
|
||||
@@ -34,7 +35,7 @@ Postman集合文件,包含:
|
||||
# 启动开发服务器
|
||||
pnpm run dev
|
||||
|
||||
# 访问Swagger UI
|
||||
# 访问Swagger UI(推荐)
|
||||
# 浏览器打开: http://localhost:3000/api-docs
|
||||
```
|
||||
|
||||
@@ -64,78 +65,144 @@ openapi-generator generate -i docs/api/openapi.yaml -g typescript-axios -o ./cli
|
||||
|
||||
## 📊 API接口概览
|
||||
|
||||
### 🔐 用户认证模块 (9个接口)
|
||||
| 接口 | 方法 | 路径 | 描述 |
|
||||
|------|------|------|------|
|
||||
| 用户登录 | POST | /auth/login | 支持用户名、邮箱或手机号登录 |
|
||||
| 用户注册 | POST | /auth/register | 创建新用户账户 |
|
||||
| GitHub OAuth | POST | /auth/github | 使用GitHub账户登录或注册 |
|
||||
| 发送验证码 | POST | /auth/forgot-password | 发送密码重置验证码 |
|
||||
| 发送重置验证码 | POST | /auth/forgot-password | 发送密码重置验证码 |
|
||||
| 重置密码 | POST | /auth/reset-password | 使用验证码重置密码 |
|
||||
| 修改密码 | PUT | /auth/change-password | 修改用户密码 |
|
||||
| 发送邮箱验证码 | POST | /auth/send-email-verification | 发送邮箱验证码 |
|
||||
| 验证邮箱 | POST | /auth/verify-email | 验证邮箱验证码 |
|
||||
| 重发邮箱验证码 | POST | /auth/resend-email-verification | 重新发送邮箱验证码 |
|
||||
|
||||
### 👥 用户管理模块 (3个接口)
|
||||
| 接口 | 方法 | 路径 | 描述 |
|
||||
|------|------|------|------|
|
||||
| 修改用户状态 | PUT | /admin/users/:id/status | 修改指定用户状态 |
|
||||
| 批量修改状态 | POST | /admin/users/batch-status | 批量修改用户状态 |
|
||||
| 用户状态统计 | GET | /admin/users/status-stats | 获取各状态用户统计 |
|
||||
|
||||
### 🛡️ 管理员模块 (4个接口)
|
||||
| 接口 | 方法 | 路径 | 描述 |
|
||||
|------|------|------|------|
|
||||
| 管理员登录 | POST | /admin/auth/login | 管理员身份认证 |
|
||||
| 获取用户列表 | GET | /admin/users | 分页获取用户列表 |
|
||||
| 获取用户详情 | GET | /admin/users/:id | 获取指定用户信息 |
|
||||
| 重置用户密码 | POST | /admin/users/:id/reset-password | 管理员重置用户密码 |
|
||||
|
||||
### 📊 系统状态 (1个接口)
|
||||
| 接口 | 方法 | 路径 | 描述 |
|
||||
|------|------|------|------|
|
||||
| 应用状态 | GET | / | 获取应用运行状态和系统信息 |
|
||||
|
||||
## 🧪 快速测试
|
||||
|
||||
### 使用cURL测试登录接口
|
||||
### 使用cURL测试核心接口
|
||||
|
||||
```bash
|
||||
# 测试用户登录
|
||||
# 1. 测试应用状态
|
||||
curl -X GET http://localhost:3000/
|
||||
|
||||
# 2. 测试用户注册
|
||||
curl -X POST http://localhost:3000/auth/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "testuser",
|
||||
"password": "Test123456",
|
||||
"nickname": "测试用户",
|
||||
"email": "test@example.com"
|
||||
}'
|
||||
|
||||
# 3. 测试用户登录
|
||||
curl -X POST http://localhost:3000/auth/login \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"identifier": "testuser",
|
||||
"password": "password123"
|
||||
"password": "Test123456"
|
||||
}'
|
||||
|
||||
# 测试用户注册
|
||||
curl -X POST http://localhost:3000/auth/register \
|
||||
# 4. 测试管理员登录
|
||||
curl -X POST http://localhost:3000/admin/auth/login \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "newuser",
|
||||
"password": "password123",
|
||||
"nickname": "新用户",
|
||||
"email": "newuser@example.com"
|
||||
"username": "admin",
|
||||
"password": "Admin123456"
|
||||
}'
|
||||
```
|
||||
|
||||
### 使用JavaScript测试
|
||||
|
||||
```javascript
|
||||
// 用户注册
|
||||
const registerResponse = await fetch('http://localhost:3000/auth/register', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({
|
||||
username: 'testuser',
|
||||
password: 'Test123456',
|
||||
nickname: '测试用户',
|
||||
email: 'test@example.com'
|
||||
})
|
||||
});
|
||||
|
||||
// 用户登录
|
||||
const response = await fetch('http://localhost:3000/auth/login', {
|
||||
const loginResponse = await fetch('http://localhost:3000/auth/login', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({
|
||||
identifier: 'testuser',
|
||||
password: 'password123'
|
||||
password: 'Test123456'
|
||||
})
|
||||
});
|
||||
|
||||
const data = await response.json();
|
||||
console.log(data);
|
||||
const loginData = await loginResponse.json();
|
||||
console.log('登录结果:', loginData);
|
||||
```
|
||||
|
||||
### 使用自动化测试脚本
|
||||
|
||||
```bash
|
||||
# Windows PowerShell
|
||||
.\test-api.ps1
|
||||
|
||||
# Linux/macOS Bash
|
||||
./test-api.sh
|
||||
|
||||
# 自定义测试参数
|
||||
.\test-api.ps1 -BaseUrl "http://localhost:3000" -TestEmail "custom@example.com"
|
||||
```
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
1. **开发环境**: 当前配置适用于开发环境,生产环境需要使用HTTPS
|
||||
2. **认证**: 实际应用中应实现JWT认证机制
|
||||
3. **限流**: 建议对认证接口实施限流策略
|
||||
4. **验证码**: 示例中返回验证码仅用于演示,生产环境不应返回
|
||||
5. **错误处理**: 建议实现统一的错误处理机制
|
||||
2. **认证机制**: 项目使用JWT认证,管理员使用独立的Token系统
|
||||
3. **频率限制**: 已实现API频率限制,登录接口2次/分钟,管理员操作10次/分钟
|
||||
4. **用户状态**: 支持6种用户状态管理(active、inactive、locked、banned、deleted、pending)
|
||||
5. **测试模式**: 邮件服务支持测试模式,验证码会在控制台输出
|
||||
6. **存储模式**: 支持Redis文件存储和内存数据库,便于无依赖测试
|
||||
7. **安全防护**: 实现了维护模式、内容类型检查、超时控制等安全机制
|
||||
|
||||
## 🔄 更新文档
|
||||
|
||||
当API接口发生变化时,请同步更新以下文件:
|
||||
1. 更新DTO类的Swagger装饰器
|
||||
2. 更新 `api-documentation.md`
|
||||
3. 更新 `openapi.yaml`
|
||||
4. 更新 `postman-collection.json`
|
||||
5. 重新生成Swagger文档
|
||||
1. 更新Controller和DTO类的Swagger装饰器
|
||||
2. 更新 `api-documentation.md` 接口文档
|
||||
3. 更新 `openapi.yaml` 规范文件
|
||||
4. 更新 `postman-collection.json` 测试集合
|
||||
5. 重新生成Swagger文档并验证
|
||||
|
||||
## 🔗 相关链接
|
||||
|
||||
- [NestJS Swagger文档](https://docs.nestjs.com/openapi/introduction)
|
||||
- [OpenAPI规范](https://swagger.io/specification/)
|
||||
- [Postman文档](https://learning.postman.com/docs/getting-started/introduction/)
|
||||
- [Swagger Editor](https://editor.swagger.io/)
|
||||
- [Swagger Editor](https://editor.swagger.io/)
|
||||
- [项目架构文档](../ARCHITECTURE.md)
|
||||
- [开发规范指南](../development/)
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,856 +0,0 @@
|
||||
# 后端开发规范指南
|
||||
|
||||
## 一、文档概述
|
||||
|
||||
### 1.1 文档目的
|
||||
|
||||
本文档定义了 Datawhale Town 后端开发的编码规范、注释标准、业务逻辑设计原则和日志记录要求,确保代码质量、可维护性和系统稳定性。
|
||||
|
||||
### 1.2 适用范围
|
||||
|
||||
- 所有后端开发人员
|
||||
- 代码审查人员
|
||||
- 系统维护人员
|
||||
|
||||
---
|
||||
|
||||
## 二、注释规范
|
||||
|
||||
### 2.1 模块注释
|
||||
|
||||
每个功能模块文件必须包含模块级注释,说明模块用途、主要功能和依赖关系。
|
||||
|
||||
**格式要求:**
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 玩家管理模块
|
||||
*
|
||||
* 功能描述:
|
||||
* - 处理玩家注册、登录、信息更新等核心功能
|
||||
* - 管理玩家角色皮肤和个人资料
|
||||
* - 提供玩家数据的 CRUD 操作
|
||||
*
|
||||
* 依赖模块:
|
||||
* - AuthService: 身份验证服务
|
||||
* - DatabaseService: 数据库操作服务
|
||||
* - LoggerService: 日志记录服务
|
||||
*
|
||||
* @author 开发者姓名
|
||||
* @version 1.0.0
|
||||
* @since 2025-12-13
|
||||
*/
|
||||
```
|
||||
|
||||
### 2.2 类注释
|
||||
|
||||
每个类必须包含类级注释,说明类的职责、主要方法和使用场景。
|
||||
|
||||
**格式要求:**
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 玩家服务类
|
||||
*
|
||||
* 职责:
|
||||
* - 处理玩家相关的业务逻辑
|
||||
* - 管理玩家状态和数据
|
||||
* - 提供玩家操作的统一接口
|
||||
*
|
||||
* 主要方法:
|
||||
* - createPlayer(): 创建新玩家
|
||||
* - updatePlayerInfo(): 更新玩家信息
|
||||
* - getPlayerById(): 根据ID获取玩家信息
|
||||
*
|
||||
* 使用场景:
|
||||
* - 玩家注册登录流程
|
||||
* - 个人陈列室数据管理
|
||||
* - 广场玩家状态同步
|
||||
*/
|
||||
@Injectable()
|
||||
export class PlayerService {
|
||||
// 类实现
|
||||
}
|
||||
```
|
||||
|
||||
### 2.3 方法注释
|
||||
|
||||
每个方法必须包含详细的方法注释,说明功能、参数、返回值、异常和业务逻辑。
|
||||
|
||||
**格式要求:**
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 创建新玩家
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据邮箱创建新的玩家账户,包含基础信息初始化和默认配置设置
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证邮箱格式和白名单
|
||||
* 2. 检查邮箱是否已存在
|
||||
* 3. 生成唯一玩家ID
|
||||
* 4. 初始化默认角色皮肤和个人信息
|
||||
* 5. 创建对应的个人陈列室
|
||||
* 6. 记录创建日志
|
||||
*
|
||||
* @param email 玩家邮箱地址,必须符合邮箱格式且在白名单中
|
||||
* @param nickname 玩家昵称,长度3-20字符,不能包含特殊字符
|
||||
* @param avatarSkin 角色皮肤ID,必须是1-8之间的有效值
|
||||
* @returns Promise<Player> 创建成功的玩家对象
|
||||
*
|
||||
* @throws BadRequestException 当邮箱格式错误或不在白名单中
|
||||
* @throws ConflictException 当邮箱已存在时
|
||||
* @throws InternalServerErrorException 当数据库操作失败时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const player = await playerService.createPlayer(
|
||||
* 'user@datawhale.club',
|
||||
* '数据鲸鱼',
|
||||
* '1'
|
||||
* );
|
||||
* ```
|
||||
*/
|
||||
async createPlayer(
|
||||
email: string,
|
||||
nickname: string,
|
||||
avatarSkin: string
|
||||
): Promise<Player> {
|
||||
// 方法实现
|
||||
}
|
||||
```
|
||||
|
||||
### 2.4 复杂业务逻辑注释
|
||||
|
||||
对于复杂的业务逻辑,必须添加行内注释说明每个步骤的目的和处理逻辑。
|
||||
|
||||
**示例:**
|
||||
|
||||
```typescript
|
||||
async joinRoom(roomId: string, playerId: string): Promise<Room> {
|
||||
// 1. 参数验证 - 确保房间ID和玩家ID格式正确
|
||||
if (!roomId || !playerId) {
|
||||
this.logger.warn(`房间加入失败:参数无效`, { roomId, playerId });
|
||||
throw new BadRequestException('房间ID和玩家ID不能为空');
|
||||
}
|
||||
|
||||
// 2. 获取房间信息 - 检查房间是否存在
|
||||
const room = await this.roomRepository.findById(roomId);
|
||||
if (!room) {
|
||||
this.logger.warn(`房间加入失败:房间不存在`, { roomId, playerId });
|
||||
throw new NotFoundException('房间不存在');
|
||||
}
|
||||
|
||||
// 3. 检查房间状态 - 只有等待中的房间才能加入
|
||||
if (room.status !== RoomStatus.WAITING) {
|
||||
this.logger.warn(`房间加入失败:房间状态不允许加入`, {
|
||||
roomId,
|
||||
playerId,
|
||||
currentStatus: room.status
|
||||
});
|
||||
throw new BadRequestException('游戏已开始,无法加入房间');
|
||||
}
|
||||
|
||||
// 4. 检查房间容量 - 防止超过最大人数限制
|
||||
if (room.players.length >= room.maxPlayers) {
|
||||
this.logger.warn(`房间加入失败:房间已满`, {
|
||||
roomId,
|
||||
playerId,
|
||||
currentPlayers: room.players.length,
|
||||
maxPlayers: room.maxPlayers
|
||||
});
|
||||
throw new BadRequestException('房间已满');
|
||||
}
|
||||
|
||||
// 5. 检查玩家是否已在房间中 - 防止重复加入
|
||||
if (room.players.includes(playerId)) {
|
||||
this.logger.info(`玩家已在房间中,跳过加入操作`, { roomId, playerId });
|
||||
return room;
|
||||
}
|
||||
|
||||
// 6. 执行加入操作 - 更新房间玩家列表
|
||||
try {
|
||||
room.players.push(playerId);
|
||||
const updatedRoom = await this.roomRepository.save(room);
|
||||
|
||||
// 7. 记录成功日志
|
||||
this.logger.info(`玩家成功加入房间`, {
|
||||
roomId,
|
||||
playerId,
|
||||
currentPlayers: updatedRoom.players.length,
|
||||
maxPlayers: updatedRoom.maxPlayers
|
||||
});
|
||||
|
||||
return updatedRoom;
|
||||
} catch (error) {
|
||||
// 8. 异常处理 - 记录错误并抛出
|
||||
this.logger.error(`房间加入操作数据库错误`, {
|
||||
roomId,
|
||||
playerId,
|
||||
error: error.message,
|
||||
stack: error.stack
|
||||
});
|
||||
throw new InternalServerErrorException('房间加入失败,请稍后重试');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 三、业务逻辑设计原则
|
||||
|
||||
### 3.1 全面性原则
|
||||
|
||||
每个业务方法必须考虑所有可能的情况,包括正常流程、异常情况和边界条件。
|
||||
|
||||
**必须考虑的情况:**
|
||||
|
||||
| 类别 | 具体情况 | 处理方式 |
|
||||
|------|---------|---------|
|
||||
| **输入验证** | 参数为空、格式错误、超出范围 | 参数校验 + 异常抛出 |
|
||||
| **权限检查** | 未登录、权限不足、令牌过期 | 身份验证 + 权限验证 |
|
||||
| **资源状态** | 资源不存在、状态不正确、已被占用 | 状态检查 + 业务规则验证 |
|
||||
| **并发控制** | 同时操作、数据竞争、锁冲突 | 事务处理 + 乐观锁/悲观锁 |
|
||||
| **系统异常** | 数据库连接失败、网络超时、内存不足 | 异常捕获 + 降级处理 |
|
||||
| **业务规则** | 违反业务约束、超出限制、状态冲突 | 业务规则验证 + 友好提示 |
|
||||
|
||||
### 3.2 防御性编程
|
||||
|
||||
采用防御性编程思想,对所有外部输入和依赖进行验证和保护。
|
||||
|
||||
**实现要求:**
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 更新玩家信息 - 防御性编程示例
|
||||
*/
|
||||
async updatePlayerInfo(
|
||||
playerId: string,
|
||||
updateData: UpdatePlayerDto
|
||||
): Promise<Player> {
|
||||
// 1. 输入参数防御性检查
|
||||
if (!playerId) {
|
||||
this.logger.warn('更新玩家信息失败:玩家ID为空');
|
||||
throw new BadRequestException('玩家ID不能为空');
|
||||
}
|
||||
|
||||
if (!updateData || Object.keys(updateData).length === 0) {
|
||||
this.logger.warn('更新玩家信息失败:更新数据为空', { playerId });
|
||||
throw new BadRequestException('更新数据不能为空');
|
||||
}
|
||||
|
||||
// 2. 数据格式验证
|
||||
if (updateData.nickname) {
|
||||
if (updateData.nickname.length < 3 || updateData.nickname.length > 20) {
|
||||
this.logger.warn('更新玩家信息失败:昵称长度不符合要求', {
|
||||
playerId,
|
||||
nicknameLength: updateData.nickname.length
|
||||
});
|
||||
throw new BadRequestException('昵称长度必须在3-20字符之间');
|
||||
}
|
||||
}
|
||||
|
||||
if (updateData.avatarSkin) {
|
||||
const validSkins = ['1', '2', '3', '4', '5', '6', '7', '8'];
|
||||
if (!validSkins.includes(updateData.avatarSkin)) {
|
||||
this.logger.warn('更新玩家信息失败:角色皮肤ID无效', {
|
||||
playerId,
|
||||
avatarSkin: updateData.avatarSkin
|
||||
});
|
||||
throw new BadRequestException('角色皮肤ID必须在1-8之间');
|
||||
}
|
||||
}
|
||||
|
||||
// 3. 玩家存在性检查
|
||||
const existingPlayer = await this.playerRepository.findById(playerId);
|
||||
if (!existingPlayer) {
|
||||
this.logger.warn('更新玩家信息失败:玩家不存在', { playerId });
|
||||
throw new NotFoundException('玩家不存在');
|
||||
}
|
||||
|
||||
// 4. 昵称唯一性检查(如果更新昵称)
|
||||
if (updateData.nickname && updateData.nickname !== existingPlayer.nickname) {
|
||||
const nicknameExists = await this.playerRepository.findByNickname(updateData.nickname);
|
||||
if (nicknameExists) {
|
||||
this.logger.warn('更新玩家信息失败:昵称已存在', {
|
||||
playerId,
|
||||
nickname: updateData.nickname
|
||||
});
|
||||
throw new ConflictException('昵称已被使用');
|
||||
}
|
||||
}
|
||||
|
||||
// 5. 执行更新操作(使用事务保证数据一致性)
|
||||
try {
|
||||
const updatedPlayer = await this.playerRepository.update(playerId, updateData);
|
||||
|
||||
this.logger.info('玩家信息更新成功', {
|
||||
playerId,
|
||||
updatedFields: Object.keys(updateData),
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
return updatedPlayer;
|
||||
} catch (error) {
|
||||
this.logger.error('更新玩家信息数据库操作失败', {
|
||||
playerId,
|
||||
updateData,
|
||||
error: error.message,
|
||||
stack: error.stack
|
||||
});
|
||||
throw new InternalServerErrorException('更新失败,请稍后重试');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3.3 异常处理策略
|
||||
|
||||
建立统一的异常处理策略,确保所有异常都能被正确捕获和处理。
|
||||
|
||||
**异常分类和处理:**
|
||||
|
||||
| 异常类型 | HTTP状态码 | 处理策略 | 日志级别 |
|
||||
|---------|-----------|---------|---------|
|
||||
| **BadRequestException** | 400 | 参数验证失败,返回具体错误信息 | WARN |
|
||||
| **UnauthorizedException** | 401 | 身份验证失败,要求重新登录 | WARN |
|
||||
| **ForbiddenException** | 403 | 权限不足,拒绝访问 | WARN |
|
||||
| **NotFoundException** | 404 | 资源不存在,返回友好提示 | WARN |
|
||||
| **ConflictException** | 409 | 资源冲突,如重复创建 | WARN |
|
||||
| **InternalServerErrorException** | 500 | 系统内部错误,记录详细日志 | ERROR |
|
||||
|
||||
---
|
||||
|
||||
## 四、日志系统使用指南
|
||||
|
||||
### 4.1 日志服务简介
|
||||
|
||||
项目使用统一的 `AppLoggerService` 提供日志记录功能,集成了 Pino 高性能日志库,支持自动敏感信息过滤和请求上下文绑定。
|
||||
|
||||
### 4.2 在服务中使用日志
|
||||
|
||||
**依赖注入:**
|
||||
|
||||
```typescript
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { AppLoggerService } from '../core/utils/logger/logger.service';
|
||||
|
||||
@Injectable()
|
||||
export class UserService {
|
||||
constructor(
|
||||
private readonly logger: AppLoggerService
|
||||
) {}
|
||||
}
|
||||
```
|
||||
|
||||
### 4.3 日志级别和使用场景
|
||||
|
||||
| 级别 | 使用场景 | 示例 |
|
||||
|------|---------|------|
|
||||
| **ERROR** | 系统错误、异常情况、数据库连接失败 | 数据库连接超时、第三方服务调用失败 |
|
||||
| **WARN** | 业务警告、参数错误、权限不足 | 用户输入无效参数、尝试访问不存在的资源 |
|
||||
| **INFO** | 重要业务操作、状态变更、关键流程 | 用户登录成功、房间创建、玩家加入广场 |
|
||||
| **DEBUG** | 调试信息、详细执行流程 | 方法调用参数、中间计算结果 |
|
||||
| **FATAL** | 致命错误、系统不可用 | 数据库完全不可用、关键服务宕机 |
|
||||
| **TRACE** | 极细粒度调试信息 | 循环内的变量状态、算法执行步骤 |
|
||||
|
||||
### 4.4 标准日志格式
|
||||
|
||||
**推荐的日志上下文格式:**
|
||||
|
||||
```typescript
|
||||
// 成功操作日志
|
||||
this.logger.info('操作描述', {
|
||||
operation: '操作类型',
|
||||
userId: '用户ID',
|
||||
resourceId: '资源ID',
|
||||
params: '关键参数',
|
||||
result: '操作结果',
|
||||
duration: '执行时间(ms)',
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// 警告日志
|
||||
this.logger.warn('警告描述', {
|
||||
operation: '操作类型',
|
||||
userId: '用户ID',
|
||||
reason: '警告原因',
|
||||
params: '相关参数',
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// 错误日志
|
||||
this.logger.error('错误描述', {
|
||||
operation: '操作类型',
|
||||
userId: '用户ID',
|
||||
error: error.message,
|
||||
params: '相关参数',
|
||||
timestamp: new Date().toISOString()
|
||||
}, error.stack);
|
||||
```
|
||||
|
||||
### 4.5 请求上下文绑定
|
||||
|
||||
**在 Controller 中使用:**
|
||||
|
||||
```typescript
|
||||
@Controller('users')
|
||||
export class UserController {
|
||||
constructor(private readonly logger: AppLoggerService) {}
|
||||
|
||||
@Get(':id')
|
||||
async getUser(@Param('id') id: string, @Req() req: Request) {
|
||||
// 绑定请求上下文
|
||||
const requestLogger = this.logger.bindRequest(req, 'UserController');
|
||||
|
||||
requestLogger.info('开始获取用户信息', { userId: id });
|
||||
|
||||
try {
|
||||
const user = await this.userService.findById(id);
|
||||
requestLogger.info('用户信息获取成功', { userId: id });
|
||||
return user;
|
||||
} catch (error) {
|
||||
requestLogger.error('用户信息获取失败', error.stack, {
|
||||
userId: id,
|
||||
reason: error.message
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4.6 业务方法日志记录最佳实践
|
||||
|
||||
**完整的业务方法日志记录示例:**
|
||||
|
||||
```typescript
|
||||
async createPlayer(email: string, nickname: string): Promise<Player> {
|
||||
const startTime = Date.now();
|
||||
|
||||
this.logger.info('开始创建玩家', {
|
||||
operation: 'createPlayer',
|
||||
email,
|
||||
nickname,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
try {
|
||||
// 1. 参数验证
|
||||
if (!email || !nickname) {
|
||||
this.logger.warn('创建玩家失败:参数无效', {
|
||||
operation: 'createPlayer',
|
||||
email,
|
||||
nickname,
|
||||
reason: 'invalid_parameters'
|
||||
});
|
||||
throw new BadRequestException('邮箱和昵称不能为空');
|
||||
}
|
||||
|
||||
// 2. 邮箱格式验证
|
||||
if (!this.isValidEmail(email)) {
|
||||
this.logger.warn('创建玩家失败:邮箱格式无效', {
|
||||
operation: 'createPlayer',
|
||||
email,
|
||||
nickname
|
||||
});
|
||||
throw new BadRequestException('邮箱格式不正确');
|
||||
}
|
||||
|
||||
// 3. 检查邮箱是否已存在
|
||||
const existingPlayer = await this.playerRepository.findByEmail(email);
|
||||
if (existingPlayer) {
|
||||
this.logger.warn('创建玩家失败:邮箱已存在', {
|
||||
operation: 'createPlayer',
|
||||
email,
|
||||
nickname,
|
||||
existingPlayerId: existingPlayer.id
|
||||
});
|
||||
throw new ConflictException('邮箱已被使用');
|
||||
}
|
||||
|
||||
// 4. 创建玩家
|
||||
const player = await this.playerRepository.create({
|
||||
email,
|
||||
nickname,
|
||||
avatarSkin: '1', // 默认皮肤
|
||||
createTime: new Date()
|
||||
});
|
||||
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
this.logger.info('玩家创建成功', {
|
||||
operation: 'createPlayer',
|
||||
playerId: player.id,
|
||||
email,
|
||||
nickname,
|
||||
duration,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
return player;
|
||||
|
||||
} catch (error) {
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
if (error instanceof BadRequestException ||
|
||||
error instanceof ConflictException) {
|
||||
// 业务异常,重新抛出
|
||||
throw error;
|
||||
}
|
||||
|
||||
// 系统异常,记录详细日志
|
||||
this.logger.error('创建玩家系统异常', {
|
||||
operation: 'createPlayer',
|
||||
email,
|
||||
nickname,
|
||||
error: error.message,
|
||||
duration,
|
||||
timestamp: new Date().toISOString()
|
||||
}, error.stack);
|
||||
|
||||
throw new InternalServerErrorException('创建玩家失败,请稍后重试');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4.7 必须记录日志的操作
|
||||
|
||||
| 操作类型 | 日志级别 | 记录内容 |
|
||||
|---------|---------|---------|
|
||||
| **用户认证** | INFO/WARN | 登录成功/失败、令牌生成/验证 |
|
||||
| **数据变更** | INFO | 创建、更新、删除操作 |
|
||||
| **权限检查** | WARN | 权限验证失败、非法访问尝试 |
|
||||
| **系统异常** | ERROR | 异常堆栈、错误上下文、影响范围 |
|
||||
| **性能监控** | INFO | 慢查询、高并发操作、资源使用 |
|
||||
| **安全事件** | WARN/ERROR | 恶意请求、频繁操作、异常行为 |
|
||||
|
||||
### 4.8 敏感信息保护
|
||||
|
||||
日志系统会自动过滤以下敏感字段:
|
||||
- `password` - 密码
|
||||
- `token` - 令牌
|
||||
- `secret` - 密钥
|
||||
- `authorization` - 授权信息
|
||||
- `cardNo` - 卡号
|
||||
|
||||
**注意:** 包含这些关键词的字段会被自动替换为 `[REDACTED]`
|
||||
|
||||
---
|
||||
|
||||
## 五、代码审查检查清单
|
||||
|
||||
### 5.1 注释检查
|
||||
|
||||
- [ ] 模块文件包含完整的模块级注释
|
||||
- [ ] 每个类都有详细的类级注释
|
||||
- [ ] 每个公共方法都有完整的方法注释
|
||||
- [ ] 复杂业务逻辑有行内注释说明
|
||||
- [ ] 注释内容准确,与代码实现一致
|
||||
|
||||
### 5.2 业务逻辑检查
|
||||
|
||||
- [ ] 考虑了所有可能的输入情况
|
||||
- [ ] 包含完整的参数验证
|
||||
- [ ] 处理了所有可能的异常情况
|
||||
- [ ] 实现了适当的权限检查
|
||||
- [ ] 考虑了并发和竞态条件
|
||||
|
||||
### 5.3 日志记录检查
|
||||
|
||||
- [ ] 关键业务操作都有日志记录
|
||||
- [ ] 日志级别使用正确
|
||||
- [ ] 日志格式符合规范
|
||||
- [ ] 包含足够的上下文信息
|
||||
- [ ] 敏感信息已脱敏处理
|
||||
|
||||
### 5.4 异常处理检查
|
||||
|
||||
- [ ] 所有异常都被正确捕获
|
||||
- [ ] 异常类型选择合适
|
||||
- [ ] 异常信息对用户友好
|
||||
- [ ] 系统异常有详细的错误日志
|
||||
- [ ] 不会泄露敏感的系统信息
|
||||
|
||||
---
|
||||
|
||||
## 六、最佳实践示例
|
||||
|
||||
### 6.1 完整的服务类示例
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 广场管理服务
|
||||
*
|
||||
* 功能描述:
|
||||
* - 管理中央广场的玩家状态和位置同步
|
||||
* - 处理玩家进入和离开广场的逻辑
|
||||
* - 维护广场在线玩家列表(最多50人)
|
||||
*
|
||||
* 依赖模块:
|
||||
* - PlayerService: 玩家信息服务
|
||||
* - WebSocketGateway: WebSocket通信网关
|
||||
* - RedisService: 缓存服务
|
||||
* - LoggerService: 日志记录服务
|
||||
*
|
||||
* @author 开发团队
|
||||
* @version 1.0.0
|
||||
* @since 2025-12-13
|
||||
*/
|
||||
@Injectable()
|
||||
export class PlazaService {
|
||||
private readonly logger = new Logger(PlazaService.name);
|
||||
private readonly MAX_PLAYERS = 50;
|
||||
|
||||
constructor(
|
||||
private readonly playerService: PlayerService,
|
||||
private readonly redisService: RedisService,
|
||||
private readonly webSocketGateway: WebSocketGateway
|
||||
) {}
|
||||
|
||||
/**
|
||||
* 玩家进入广场
|
||||
*
|
||||
* 功能描述:
|
||||
* 处理玩家进入中央广场的逻辑,包括人数限制检查、位置分配和状态同步
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证玩家身份和权限
|
||||
* 2. 检查广场当前人数是否超限
|
||||
* 3. 为玩家分配初始位置
|
||||
* 4. 更新Redis中的在线玩家列表
|
||||
* 5. 向其他玩家广播新玩家进入消息
|
||||
* 6. 向新玩家发送当前广场状态
|
||||
*
|
||||
* @param playerId 玩家ID,必须是有效的已注册玩家
|
||||
* @param socketId WebSocket连接ID,用于消息推送
|
||||
* @returns Promise<PlazaPlayerInfo> 玩家在广场的信息
|
||||
*
|
||||
* @throws UnauthorizedException 当玩家身份验证失败时
|
||||
* @throws BadRequestException 当广场人数已满时
|
||||
* @throws InternalServerErrorException 当系统操作失败时
|
||||
*/
|
||||
async enterPlaza(playerId: string, socketId: string): Promise<PlazaPlayerInfo> {
|
||||
const startTime = Date.now();
|
||||
|
||||
this.logger.info('玩家尝试进入广场', {
|
||||
operation: 'enterPlaza',
|
||||
playerId,
|
||||
socketId,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
try {
|
||||
// 1. 验证玩家身份
|
||||
const player = await this.playerService.getPlayerById(playerId);
|
||||
if (!player) {
|
||||
this.logger.warn('进入广场失败:玩家不存在', {
|
||||
operation: 'enterPlaza',
|
||||
playerId,
|
||||
socketId
|
||||
});
|
||||
throw new UnauthorizedException('玩家身份验证失败');
|
||||
}
|
||||
|
||||
// 2. 检查广场人数限制
|
||||
const currentPlayers = await this.redisService.scard('plaza:online_players');
|
||||
if (currentPlayers >= this.MAX_PLAYERS) {
|
||||
this.logger.warn('进入广场失败:人数已满', {
|
||||
operation: 'enterPlaza',
|
||||
playerId,
|
||||
currentPlayers,
|
||||
maxPlayers: this.MAX_PLAYERS
|
||||
});
|
||||
throw new BadRequestException('广场人数已满,请稍后再试');
|
||||
}
|
||||
|
||||
// 3. 检查玩家是否已在广场中
|
||||
const isAlreadyInPlaza = await this.redisService.sismember('plaza:online_players', playerId);
|
||||
if (isAlreadyInPlaza) {
|
||||
this.logger.info('玩家已在广场中,更新连接信息', {
|
||||
operation: 'enterPlaza',
|
||||
playerId,
|
||||
socketId
|
||||
});
|
||||
|
||||
// 更新Socket连接映射
|
||||
await this.redisService.hset('plaza:player_sockets', playerId, socketId);
|
||||
|
||||
// 获取当前位置信息
|
||||
const existingInfo = await this.redisService.hget('plaza:player_positions', playerId);
|
||||
return JSON.parse(existingInfo);
|
||||
}
|
||||
|
||||
// 4. 为玩家分配初始位置(广场中心附近随机位置)
|
||||
const initialPosition = this.generateInitialPosition();
|
||||
|
||||
const playerInfo: PlazaPlayerInfo = {
|
||||
playerId: player.id,
|
||||
nickname: player.nickname,
|
||||
avatarSkin: player.avatarSkin,
|
||||
position: initialPosition,
|
||||
lastUpdate: new Date(),
|
||||
socketId
|
||||
};
|
||||
|
||||
// 5. 更新Redis中的玩家状态
|
||||
await Promise.all([
|
||||
this.redisService.sadd('plaza:online_players', playerId),
|
||||
this.redisService.hset('plaza:player_positions', playerId, JSON.stringify(playerInfo)),
|
||||
this.redisService.hset('plaza:player_sockets', playerId, socketId),
|
||||
this.redisService.expire('plaza:player_positions', 3600), // 1小时过期
|
||||
this.redisService.expire('plaza:player_sockets', 3600)
|
||||
]);
|
||||
|
||||
// 6. 向其他玩家广播新玩家进入消息
|
||||
this.webSocketGateway.broadcastToPlaza('player_entered', {
|
||||
playerId: player.id,
|
||||
nickname: player.nickname,
|
||||
avatarSkin: player.avatarSkin,
|
||||
position: initialPosition
|
||||
}, socketId); // 排除新进入的玩家
|
||||
|
||||
// 7. 向新玩家发送当前广场状态
|
||||
const allPlayers = await this.getAllPlazaPlayers();
|
||||
this.webSocketGateway.sendToPlayer(socketId, 'plaza_state', {
|
||||
players: allPlayers.filter(p => p.playerId !== playerId),
|
||||
totalPlayers: allPlayers.length
|
||||
});
|
||||
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
this.logger.info('玩家成功进入广场', {
|
||||
operation: 'enterPlaza',
|
||||
playerId,
|
||||
socketId,
|
||||
position: initialPosition,
|
||||
totalPlayers: currentPlayers + 1,
|
||||
duration,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
return playerInfo;
|
||||
|
||||
} catch (error) {
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
if (error instanceof UnauthorizedException ||
|
||||
error instanceof BadRequestException) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
this.logger.error('玩家进入广场系统异常', {
|
||||
operation: 'enterPlaza',
|
||||
playerId,
|
||||
socketId,
|
||||
error: error.message,
|
||||
stack: error.stack,
|
||||
duration,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
throw new InternalServerErrorException('进入广场失败,请稍后重试');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成初始位置
|
||||
*
|
||||
* 功能描述:
|
||||
* 在广场中心附近生成随机的初始位置,避免玩家重叠
|
||||
*
|
||||
* @returns Position 包含x、y坐标的位置对象
|
||||
* @private
|
||||
*/
|
||||
private generateInitialPosition(): Position {
|
||||
// 广场中心坐标 (400, 300),在半径100像素范围内随机分配
|
||||
const centerX = 400;
|
||||
const centerY = 300;
|
||||
const radius = 100;
|
||||
|
||||
const angle = Math.random() * 2 * Math.PI;
|
||||
const distance = Math.random() * radius;
|
||||
|
||||
const x = Math.round(centerX + distance * Math.cos(angle));
|
||||
const y = Math.round(centerY + distance * Math.sin(angle));
|
||||
|
||||
return { x, y };
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取所有广场玩家信息
|
||||
*
|
||||
* @returns Promise<PlazaPlayerInfo[]> 广场中所有玩家的信息列表
|
||||
* @private
|
||||
*/
|
||||
private async getAllPlazaPlayers(): Promise<PlazaPlayerInfo[]> {
|
||||
try {
|
||||
const playerIds = await this.redisService.smembers('plaza:online_players');
|
||||
const playerInfos = await Promise.all(
|
||||
playerIds.map(async (playerId) => {
|
||||
const info = await this.redisService.hget('plaza:player_positions', playerId);
|
||||
return info ? JSON.parse(info) : null;
|
||||
})
|
||||
);
|
||||
|
||||
return playerInfos.filter(info => info !== null);
|
||||
} catch (error) {
|
||||
this.logger.error('获取广场玩家列表失败', {
|
||||
operation: 'getAllPlazaPlayers',
|
||||
error: error.message
|
||||
});
|
||||
return [];
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、工具和配置
|
||||
|
||||
### 7.1 推荐的开发工具
|
||||
|
||||
| 工具 | 用途 | 配置说明 |
|
||||
|------|------|---------|
|
||||
| **ESLint** | 代码规范检查 | 配置注释规范检查规则 |
|
||||
| **Prettier** | 代码格式化 | 统一代码格式 |
|
||||
| **TSDoc** | 文档生成 | 从注释生成API文档 |
|
||||
| **SonarQube** | 代码质量分析 | 检查代码覆盖率和复杂度 |
|
||||
|
||||
### 7.2 日志配置示例
|
||||
|
||||
```typescript
|
||||
// logger.config.ts
|
||||
export const loggerConfig = {
|
||||
level: process.env.LOG_LEVEL || 'info',
|
||||
format: winston.format.combine(
|
||||
winston.format.timestamp(),
|
||||
winston.format.errors({ stack: true }),
|
||||
winston.format.json()
|
||||
),
|
||||
transports: [
|
||||
new winston.transports.Console(),
|
||||
new winston.transports.File({
|
||||
filename: 'logs/error.log',
|
||||
level: 'error'
|
||||
}),
|
||||
new winston.transports.File({
|
||||
filename: 'logs/combined.log'
|
||||
})
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 八、总结
|
||||
|
||||
本规范文档定义了后端开发的核心要求:
|
||||
|
||||
1. **完整的注释体系**:模块、类、方法三级注释,确保代码可读性
|
||||
2. **全面的业务逻辑**:考虑所有可能情况,实现防御性编程
|
||||
3. **规范的日志记录**:关键操作必须记录,便于问题排查和系统监控
|
||||
4. **统一的异常处理**:分类处理不同类型异常,提供友好的用户体验
|
||||
|
||||
遵循本规范将显著提高代码质量、系统稳定性和团队协作效率。所有开发人员必须严格按照本规范进行开发,代码审查时将重点检查这些方面的实现。
|
||||
418
docs/deployment/DEPLOYMENT.md
Normal file
418
docs/deployment/DEPLOYMENT.md
Normal file
@@ -0,0 +1,418 @@
|
||||
# 🚀 Whale Town 部署指南
|
||||
|
||||
本文档详细说明如何部署 Whale Town 像素游戏后端服务到生产环境。
|
||||
|
||||
## 📋 前置要求
|
||||
|
||||
### 基础环境
|
||||
- **Node.js** 18+ (推荐 20.x LTS)
|
||||
- **pnpm** 包管理器
|
||||
- **MySQL** 8.0+
|
||||
- **Redis** 6.0+ (可选,支持文件存储模式)
|
||||
- **PM2** 进程管理器(推荐)
|
||||
- **Nginx** 反向代理(推荐)
|
||||
|
||||
### 新增要求 (管理员后台)
|
||||
- **Web服务器** (Nginx/Apache) - 用于前端管理界面
|
||||
- **SSL证书** (推荐) - 保护管理后台安全
|
||||
|
||||
## 部署步骤
|
||||
|
||||
### 1. 服务器环境准备
|
||||
|
||||
```bash
|
||||
# 安装 Node.js (使用 NodeSource 仓库)
|
||||
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
|
||||
sudo apt-get install -y nodejs
|
||||
|
||||
# 安装 pnpm
|
||||
curl -fsSL https://get.pnpm.io/install.sh | sh
|
||||
source ~/.bashrc
|
||||
|
||||
# 安装 PM2
|
||||
npm install -g pm2
|
||||
|
||||
# 安装 MySQL
|
||||
sudo apt update
|
||||
sudo apt install mysql-server
|
||||
sudo mysql_secure_installation
|
||||
```
|
||||
|
||||
### 2. 克隆项目
|
||||
|
||||
```bash
|
||||
# 创建项目目录
|
||||
sudo mkdir -p /var/www
|
||||
cd /var/www
|
||||
|
||||
# 克隆项目(替换为你的实际仓库地址)
|
||||
git clone https://gitea.xinghangee.icu/datawhale/whale-town-end.git
|
||||
cd whale-town-end
|
||||
```
|
||||
|
||||
### 3. 配置环境
|
||||
|
||||
```bash
|
||||
# 复制环境配置文件
|
||||
cp .env.production.example .env.production
|
||||
|
||||
# 编辑环境配置(填入实际的数据库信息)
|
||||
nano .env.production
|
||||
|
||||
# 复制部署脚本
|
||||
cp deploy.sh.example deploy.sh
|
||||
chmod +x deploy.sh
|
||||
|
||||
# 编辑部署脚本(修改路径配置)
|
||||
nano deploy.sh
|
||||
|
||||
# 复制 webhook 处理器
|
||||
cp webhook-handler.js.example webhook-handler.js
|
||||
|
||||
# 编辑 webhook 处理器(修改密钥和路径)
|
||||
nano webhook-handler.js
|
||||
```
|
||||
|
||||
### 4. 数据库设置
|
||||
|
||||
```bash
|
||||
# 登录 MySQL
|
||||
sudo mysql -u root -p
|
||||
|
||||
# 创建数据库和用户
|
||||
CREATE DATABASE pixel_game_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
||||
CREATE USER 'pixel_game'@'localhost' IDENTIFIED BY 'your_secure_password';
|
||||
GRANT ALL PRIVILEGES ON pixel_game_db.* TO 'pixel_game'@'localhost';
|
||||
FLUSH PRIVILEGES;
|
||||
EXIT;
|
||||
```
|
||||
|
||||
### 5. 安装依赖和构建
|
||||
|
||||
```bash
|
||||
# 安装后端依赖
|
||||
pnpm install --frozen-lockfile
|
||||
|
||||
# 安装前端依赖 (新增)
|
||||
cd client
|
||||
pnpm install --frozen-lockfile
|
||||
cd ..
|
||||
|
||||
# 构建后端
|
||||
pnpm run build
|
||||
|
||||
# 构建前端管理界面 (新增)
|
||||
cd client
|
||||
pnpm run build
|
||||
cd ..
|
||||
```
|
||||
|
||||
### 6. 启动服务
|
||||
|
||||
```bash
|
||||
# 使用 PM2 启动应用
|
||||
pm2 start ecosystem.config.js --env production
|
||||
|
||||
# 保存 PM2 配置
|
||||
pm2 save
|
||||
|
||||
# 设置开机自启
|
||||
pm2 startup
|
||||
# 按照提示执行显示的命令
|
||||
```
|
||||
|
||||
### 7. 配置 Nginx
|
||||
|
||||
#### 方案一: 分离部署 (推荐)
|
||||
|
||||
创建后端API配置:
|
||||
```bash
|
||||
sudo nano /etc/nginx/sites-available/whale-town-api
|
||||
```
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name api.whaletown.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:3000;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection 'upgrade';
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_cache_bypass $http_upgrade;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
创建前端管理界面配置:
|
||||
```bash
|
||||
sudo nano /etc/nginx/sites-available/whale-town-admin
|
||||
```
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name admin.whaletown.com;
|
||||
root /var/www/whale-town-end/client/dist;
|
||||
index index.html;
|
||||
|
||||
# SPA路由支持
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
# API代理
|
||||
location /api/ {
|
||||
proxy_pass http://api.whaletown.com/;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
}
|
||||
|
||||
# 静态资源缓存
|
||||
location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg)$ {
|
||||
expires 1y;
|
||||
add_header Cache-Control "public, immutable";
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 方案二: 单域名部署
|
||||
|
||||
创建统一配置:
|
||||
```bash
|
||||
sudo nano /etc/nginx/sites-available/whale-town-unified
|
||||
```
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name whaletown.com;
|
||||
|
||||
# API接口
|
||||
location /api/ {
|
||||
proxy_pass http://localhost:3000/;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
}
|
||||
|
||||
# 管理后台
|
||||
location /admin/ {
|
||||
alias /var/www/whale-town-end/client/dist/;
|
||||
try_files $uri $uri/ /admin/index.html;
|
||||
}
|
||||
|
||||
# 主站点 (可选)
|
||||
location / {
|
||||
proxy_pass http://localhost:3000;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
启用配置:
|
||||
```bash
|
||||
# 启用站点
|
||||
sudo ln -s /etc/nginx/sites-available/whale-town-* /etc/nginx/sites-enabled/
|
||||
|
||||
# 测试配置
|
||||
sudo nginx -t
|
||||
|
||||
# 重载配置
|
||||
sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
## 🔒 SSL证书配置 (推荐)
|
||||
|
||||
### 使用 Let's Encrypt
|
||||
```bash
|
||||
# 安装 Certbot
|
||||
sudo apt install certbot python3-certbot-nginx
|
||||
|
||||
# 为API域名申请证书
|
||||
sudo certbot --nginx -d api.whaletown.com
|
||||
|
||||
# 为管理后台申请证书
|
||||
sudo certbot --nginx -d admin.whaletown.com
|
||||
|
||||
# 设置自动续期
|
||||
sudo crontab -e
|
||||
# 添加: 0 12 * * * /usr/bin/certbot renew --quiet
|
||||
```
|
||||
|
||||
## 🎛️ 管理员后台配置
|
||||
|
||||
### 环境变量配置
|
||||
在 `.env.production` 中添加:
|
||||
```bash
|
||||
# 管理员Token配置 (必须)
|
||||
ADMIN_TOKEN_SECRET=your_super_strong_random_secret_at_least_32_chars
|
||||
ADMIN_TOKEN_TTL_SECONDS=28800
|
||||
|
||||
# 首次部署启用管理员引导
|
||||
ADMIN_BOOTSTRAP_ENABLED=true
|
||||
ADMIN_USERNAME=admin
|
||||
ADMIN_PASSWORD=YourStrongPassword123!
|
||||
ADMIN_NICKNAME=系统管理员
|
||||
|
||||
# CORS配置 (如果前后端分离)
|
||||
CORS_ORIGIN=https://admin.whaletown.com
|
||||
```
|
||||
|
||||
### 访问管理后台
|
||||
- **地址**: https://admin.whaletown.com
|
||||
- **默认账号**: admin / YourStrongPassword123!
|
||||
|
||||
**⚠️ 重要**: 首次登录后立即修改密码并关闭引导功能 (`ADMIN_BOOTSTRAP_ENABLED=false`)
|
||||
|
||||
## 📡 Gitea Webhook 配置
|
||||
1. 在 Gitea 仓库中进入 **Settings** → **Webhooks**
|
||||
3. 配置:
|
||||
- **Target URL**: `http://your-server.com:9000/webhook` 或 `http://your-domain.com/webhook`
|
||||
- **HTTP Method**: `POST`
|
||||
- **POST Content Type**: `application/json`
|
||||
- **Secret**: 与 `webhook-handler.js` 中的 `SECRET` 一致
|
||||
- **Trigger On**: 选择 `Push events`
|
||||
- **Branch filter**: `main`
|
||||
|
||||
## ✅ 验证部署
|
||||
|
||||
### 基础服务检查
|
||||
```bash
|
||||
# 检查PM2服务状态
|
||||
pm2 status
|
||||
|
||||
# 检查后端API
|
||||
curl http://localhost:3000/
|
||||
curl http://localhost:3000/api-docs
|
||||
|
||||
# 检查前端管理界面
|
||||
curl -I https://admin.whaletown.com
|
||||
```
|
||||
|
||||
### 管理员后台测试
|
||||
```bash
|
||||
# 测试管理员登录API
|
||||
curl -X POST https://api.whaletown.com/admin/auth/login \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"identifier":"admin","password":"YourStrongPassword123!"}'
|
||||
|
||||
# 访问管理界面
|
||||
# 浏览器打开: https://admin.whaletown.com
|
||||
```
|
||||
|
||||
### 功能验证清单
|
||||
- [ ] 后端API服务正常响应
|
||||
- [ ] API文档可访问
|
||||
- [ ] 前端管理界面加载正常
|
||||
- [ ] 管理员登录功能正常
|
||||
- [ ] 用户管理功能正常
|
||||
- [ ] 日志查看功能正常
|
||||
- [ ] SSL证书配置正确
|
||||
|
||||
## 🔧 常用命令
|
||||
|
||||
### 服务管理
|
||||
```bash
|
||||
# 重启后端服务
|
||||
pm2 restart whale-town-end
|
||||
|
||||
# 重启前端服务 (如果使用PM2托管)
|
||||
pm2 restart whale-town-admin
|
||||
|
||||
# 查看服务日志
|
||||
pm2 logs whale-town-end --lines 100
|
||||
pm2 logs whale-town-admin --lines 100
|
||||
|
||||
# 手动部署
|
||||
bash deploy.sh
|
||||
```
|
||||
|
||||
### 更新部署
|
||||
```bash
|
||||
# 更新后端
|
||||
git pull origin main
|
||||
pnpm install
|
||||
pnpm run build
|
||||
pm2 reload whale-town-end
|
||||
|
||||
# 更新前端管理界面
|
||||
cd client
|
||||
git pull origin main
|
||||
pnpm install
|
||||
pnpm run build
|
||||
sudo systemctl reload nginx
|
||||
cd ..
|
||||
```
|
||||
|
||||
### 日志管理
|
||||
```bash
|
||||
# 查看应用日志
|
||||
tail -f logs/app.log
|
||||
|
||||
# 查看管理员操作日志
|
||||
tail -f logs/admin.log
|
||||
|
||||
# 查看Nginx日志
|
||||
sudo tail -f /var/log/nginx/access.log
|
||||
sudo tail -f /var/log/nginx/error.log
|
||||
```
|
||||
|
||||
## 🚨 故障排除
|
||||
|
||||
### 后端服务问题
|
||||
**服务无法启动**
|
||||
- 检查环境变量配置 (`cat .env.production`)
|
||||
- 检查数据库连接 (`mysql -u pixel_game -p`)
|
||||
- 查看PM2日志 (`pm2 logs whale-town-end`)
|
||||
- 检查端口占用 (`netstat -tlnp | grep 3000`)
|
||||
|
||||
**管理员登录失败**
|
||||
- 验证 `ADMIN_TOKEN_SECRET` 配置
|
||||
- 检查管理员账号是否创建
|
||||
- 查看后端错误日志
|
||||
- 确认密码复杂度要求
|
||||
|
||||
### 前端管理界面问题
|
||||
**界面无法访问**
|
||||
- 检查前端构建是否成功 (`ls -la client/dist/`)
|
||||
- 验证Nginx配置 (`sudo nginx -t`)
|
||||
- 检查域名解析
|
||||
- 查看Nginx错误日志
|
||||
|
||||
**API请求失败**
|
||||
- 检查CORS配置
|
||||
- 验证API代理设置
|
||||
- 确认后端服务状态
|
||||
- 检查防火墙规则
|
||||
|
||||
### 数据库连接问题
|
||||
**连接失败**
|
||||
- 检查MySQL服务状态 (`sudo systemctl status mysql`)
|
||||
- 验证数据库用户权限
|
||||
- 检查网络连接
|
||||
- 确认数据库配置
|
||||
|
||||
### SSL证书问题
|
||||
**证书验证失败**
|
||||
- 检查证书有效期 (`sudo certbot certificates`)
|
||||
- 验证域名解析
|
||||
- 重新申请证书 (`sudo certbot --nginx -d your-domain.com`)
|
||||
|
||||
### 性能问题
|
||||
**响应缓慢**
|
||||
- 检查系统资源使用 (`htop`, `df -h`)
|
||||
- 优化数据库查询
|
||||
- 配置Redis缓存
|
||||
- 启用Nginx压缩
|
||||
|
||||
### 日志文件过大
|
||||
**磁盘空间不足**
|
||||
- 配置日志轮转 (`sudo nano /etc/logrotate.d/whale-town`)
|
||||
- 清理旧日志文件
|
||||
- 监控磁盘使用情况
|
||||
2101
docs/development/AI代码检查规范.md
Normal file
2101
docs/development/AI代码检查规范.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -37,6 +37,35 @@
|
||||
| [后端开发规范](./backend_development_guide.md) | 注释、日志、业务逻辑 | 注释完整性、日志规范 |
|
||||
| [NestJS 使用指南](./nestjs_guide.md) | 框架最佳实践 | 架构设计、代码组织 |
|
||||
|
||||
**📝 重要:修改记录注释规范**
|
||||
|
||||
当对现有文件进行修改时,必须在文件头注释中添加修改记录,格式如下:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 文件功能描述
|
||||
*
|
||||
* 最近修改:
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
*
|
||||
* @author 原作者
|
||||
* @version x.x.x (修改后递增版本号)
|
||||
* @since 创建日期
|
||||
* @lastModified 最后修改日期
|
||||
*/
|
||||
```
|
||||
|
||||
**📏 重要限制:修改记录只保留最近5次修改,超出时删除最旧记录,保持注释简洁。**
|
||||
|
||||
**修改类型包括:**
|
||||
- `代码规范优化` - 命名规范、注释规范、代码清理等
|
||||
- `功能新增` - 添加新的功能或方法
|
||||
- `功能修改` - 修改现有功能的实现
|
||||
- `Bug修复` - 修复代码缺陷
|
||||
- `性能优化` - 提升代码性能
|
||||
- `重构` - 代码结构调整但功能不变
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI 辅助开发工作流程
|
||||
@@ -89,6 +118,7 @@
|
||||
- 模块级注释(功能描述、依赖模块、作者、版本)
|
||||
- 类级注释(职责、主要方法、使用场景)
|
||||
- 方法级注释(功能描述、业务逻辑、参数、返回值、异常、示例)
|
||||
- 修改记录注释(如果是修改现有文件,添加修改记录和更新版本号)
|
||||
|
||||
2. 按照命名规范:
|
||||
- 类名使用大驼峰
|
||||
@@ -229,6 +259,7 @@
|
||||
□ 模块级注释(功能描述、依赖模块、作者、版本)
|
||||
□ 类级注释(职责、主要方法、使用场景)
|
||||
□ 方法级注释(功能描述、业务逻辑、参数、返回值、异常、示例)
|
||||
□ 修改记录注释(如果是修改现有文件,必须添加修改记录和更新版本号,只保留最近5次修改)
|
||||
□ 文件命名使用下划线分隔
|
||||
□ 类名使用大驼峰命名
|
||||
□ 方法名使用小驼峰命名
|
||||
@@ -312,7 +343,50 @@ AI 会生成包含完整注释和异常处理的代码。
|
||||
请按照 Git 提交规范生成提交信息。
|
||||
```
|
||||
|
||||
### 案例2:代码审查场景
|
||||
### 案例3:修改现有文件规范
|
||||
|
||||
#### 修改现有代码时的注释更新
|
||||
|
||||
```
|
||||
我需要修改现有的 login_core.service.ts 文件,进行以下优化:
|
||||
- 清理未使用的导入 (EmailSendResult, crypto)
|
||||
- 修复常量命名 (saltRounds -> SALT_ROUNDS)
|
||||
- 删除未使用的私有方法 (generateVerificationCode)
|
||||
|
||||
请帮我:
|
||||
1. 在文件头注释中添加修改记录
|
||||
2. 更新版本号 (1.0.0 -> 1.0.1)
|
||||
3. 添加 @lastModified 标记
|
||||
4. 确保修改记录格式符合规范
|
||||
5. 只保留最近5次修改记录,保持注释简洁
|
||||
|
||||
修改记录格式要求:
|
||||
- 日期格式:YYYY-MM-DD
|
||||
- 修改类型:代码规范优化
|
||||
- 描述要具体明确
|
||||
- 最多保留5条记录
|
||||
```
|
||||
|
||||
#### AI 生成的修改记录示例
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 登录核心服务
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 代码规范优化 - 清理未使用的导入(EmailSendResult, crypto)
|
||||
* - 2025-01-07: 代码规范优化 - 修复常量命名(saltRounds -> SALT_ROUNDS)
|
||||
* - 2025-01-07: 代码规范优化 - 删除未使用的私有方法(generateVerificationCode)
|
||||
* - 2025-01-07: 代码质量提升 - 确保完全符合项目命名规范和注释规范
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2025-12-17
|
||||
* @lastModified 2025-01-07
|
||||
*/
|
||||
```
|
||||
|
||||
### 案例4:代码审查场景
|
||||
|
||||
#### 现有代码检查
|
||||
|
||||
@@ -380,6 +454,14 @@ AI 会生成包含完整注释和异常处理的代码。
|
||||
- 日志记录
|
||||
- 规范命名
|
||||
|
||||
## 代码修改模板
|
||||
修改现有文件时,请:
|
||||
- 在文件头注释添加修改记录
|
||||
- 更新版本号(递增小版本号)
|
||||
- 添加 @lastModified 标记
|
||||
- 修改记录格式:YYYY-MM-DD: 修改类型 - 具体描述
|
||||
- 只保留最近5次修改记录,保持注释简洁
|
||||
|
||||
## 代码检查模板
|
||||
请检查代码规范符合性:
|
||||
[保存检查清单]
|
||||
@@ -397,6 +479,7 @@ AI 会生成包含完整注释和异常处理的代码。
|
||||
3. 异常处理模板
|
||||
4. 日志记录模板
|
||||
5. 参数验证模板
|
||||
6. 文件修改记录注释模板
|
||||
|
||||
每个模板都要包含完整的注释和最佳实践。
|
||||
```
|
||||
276
docs/development/TESTING.md
Normal file
276
docs/development/TESTING.md
Normal file
@@ -0,0 +1,276 @@
|
||||
# 测试指南
|
||||
|
||||
本项目支持**无数据库和无邮件服务器**的测试模式,让你可以快速验证所有功能!
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 1. 环境配置
|
||||
|
||||
```bash
|
||||
# 复制环境配置文件
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
默认配置已经设置为测试模式,无需修改即可使用。
|
||||
|
||||
### 2. 启动服务
|
||||
|
||||
```bash
|
||||
# 安装依赖
|
||||
npm install
|
||||
|
||||
# 启动开发服务器
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### 3. 运行测试
|
||||
|
||||
**Windows (PowerShell):**
|
||||
```powershell
|
||||
.\test-api.ps1
|
||||
```
|
||||
|
||||
**Linux/macOS:**
|
||||
```bash
|
||||
./test-api.sh
|
||||
```
|
||||
|
||||
**自定义参数:**
|
||||
```bash
|
||||
# Windows
|
||||
.\test-api.ps1 -BaseUrl "http://localhost:3000" -TestEmail "custom@example.com"
|
||||
|
||||
# Linux/macOS
|
||||
./test-api.sh "http://localhost:3000" "custom@example.com"
|
||||
```
|
||||
|
||||
## 🧪 测试功能
|
||||
|
||||
### API功能测试
|
||||
测试脚本会验证以下核心功能:
|
||||
|
||||
**用户认证模块:**
|
||||
- ✅ **邮箱验证码发送** - 生成6位数验证码,测试模式输出到控制台
|
||||
- ✅ **邮箱验证码验证** - 验证码校验和自动清理
|
||||
- ✅ **用户注册** - 完整的用户注册流程,包含邮箱验证
|
||||
- ✅ **用户登录** - 支持用户名/邮箱/手机号多种方式登录
|
||||
|
||||
**系统状态测试:**
|
||||
- ✅ **应用状态检查** - 验证服务器运行状态和系统信息
|
||||
- ✅ **Redis文件存储** - 验证验证码存储和读取功能
|
||||
- ✅ **内存数据库** - 验证用户数据存储功能
|
||||
|
||||
### 单元测试覆盖
|
||||
|
||||
**核心服务测试(7个测试套件,140个测试用例):**
|
||||
|
||||
1. **LoginCoreService** - 登录核心服务(15个测试)
|
||||
- 用户登录成功/失败场景
|
||||
- 用户注册功能测试
|
||||
- GitHub OAuth登录测试
|
||||
- 密码重置和修改功能
|
||||
- 用户状态验证(active、inactive、locked等)
|
||||
|
||||
2. **AdminService** - 管理员服务测试
|
||||
- 管理员登录认证
|
||||
- 用户列表管理
|
||||
- 用户密码重置
|
||||
- 日志管理功能
|
||||
|
||||
3. **VerificationService** - 验证码服务测试
|
||||
- 验证码生成和验证
|
||||
- 频率限制机制
|
||||
- Redis存储操作
|
||||
- 错误处理和边界条件
|
||||
|
||||
4. **EmailService** - 邮件服务测试
|
||||
- 邮件发送功能(测试模式和生产模式)
|
||||
- 验证码邮件模板
|
||||
- 连接验证和错误处理
|
||||
- SMTP配置测试
|
||||
|
||||
5. **UsersService** - 用户数据服务测试
|
||||
- 用户CRUD操作
|
||||
- 用户查询功能
|
||||
- 数据验证和约束
|
||||
|
||||
6. **AdminCoreService** - 管理员核心服务测试
|
||||
- 管理员认证逻辑
|
||||
- 权限验证
|
||||
- 管理员引导创建
|
||||
|
||||
7. **LoggerService** - 日志服务测试
|
||||
- 日志记录功能
|
||||
- 敏感信息过滤
|
||||
- 日志级别控制
|
||||
|
||||
### E2E端到端测试
|
||||
|
||||
**登录功能完整流程测试:**
|
||||
- 用户注册 → 邮箱验证 → 登录验证
|
||||
- GitHub OAuth登录流程
|
||||
- 密码重置完整流程
|
||||
- 错误处理和边界条件测试
|
||||
|
||||
## 🔧 测试模式特性
|
||||
|
||||
- 🗄️ **Redis 文件存储** - 使用 `redis-data/redis.json` 存储验证码
|
||||
- 📧 **邮件测试模式** - 邮件内容输出到控制台,无需真实SMTP
|
||||
- 💾 **内存用户存储** - 无需数据库,用户数据存储在内存中
|
||||
- 🔄 **自动切换** - 根据配置自动选择存储模式
|
||||
|
||||
## 📊 单元测试
|
||||
|
||||
### 运行测试命令
|
||||
|
||||
```bash
|
||||
# 运行所有单元测试
|
||||
npm test
|
||||
|
||||
# 监听模式(开发时使用)
|
||||
npm run test:watch
|
||||
|
||||
# 生成覆盖率报告
|
||||
npm run test:cov
|
||||
|
||||
# 运行特定测试文件
|
||||
npm test -- src/core/login_core/login_core.service.spec.ts
|
||||
```
|
||||
|
||||
### 测试覆盖情况
|
||||
|
||||
**测试统计:**
|
||||
- 测试套件:7个
|
||||
- 测试用例:140个
|
||||
- 覆盖率:100%通过
|
||||
|
||||
**测试文件列表:**
|
||||
```
|
||||
src/core/login_core/login_core.service.spec.ts # 登录核心服务
|
||||
src/business/admin/admin.service.spec.ts # 管理员服务
|
||||
src/core/utils/verification/verification.service.spec.ts # 验证码服务
|
||||
src/core/utils/email/email.service.spec.ts # 邮件服务
|
||||
src/core/db/users/users.service.spec.ts # 用户数据服务
|
||||
src/core/admin_core/admin_core.service.spec.ts # 管理员核心服务
|
||||
src/core/utils/logger/logger.service.spec.ts # 日志服务
|
||||
test/business/login.e2e-spec.ts # E2E端到端测试
|
||||
```
|
||||
|
||||
### 测试场景覆盖
|
||||
|
||||
**正常流程测试:**
|
||||
- 用户注册、登录、密码管理
|
||||
- 邮箱验证码发送和验证
|
||||
- 管理员认证和用户管理
|
||||
- 系统状态和日志功能
|
||||
|
||||
**异常情况测试:**
|
||||
- 无效输入和参数验证
|
||||
- 网络连接失败处理
|
||||
- 权限验证和访问控制
|
||||
- 频率限制和安全防护
|
||||
|
||||
**边界条件测试:**
|
||||
- 密码强度验证
|
||||
- 验证码过期处理
|
||||
- 用户状态变更
|
||||
- 数据库连接异常
|
||||
|
||||
## 🌐 生产环境配置
|
||||
|
||||
要切换到生产环境,编辑 `.env` 文件:
|
||||
|
||||
```bash
|
||||
# 启用数据库(取消注释并填入真实数据)
|
||||
DB_HOST=your_mysql_host
|
||||
DB_PORT=3306
|
||||
DB_USERNAME=your_db_username
|
||||
DB_PASSWORD=your_db_password
|
||||
DB_NAME=your_db_name
|
||||
|
||||
# 启用真实Redis(取消注释并设置)
|
||||
USE_FILE_REDIS=false
|
||||
REDIS_HOST=your_redis_host
|
||||
REDIS_PORT=6379
|
||||
REDIS_PASSWORD=your_redis_password
|
||||
|
||||
# 启用邮件服务(取消注释并填入真实数据)
|
||||
EMAIL_HOST=smtp.gmail.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_USER=your_email@gmail.com
|
||||
EMAIL_PASS=your_app_password
|
||||
EMAIL_FROM="Whale Town Game" <noreply@whaletown.com>
|
||||
|
||||
# 生产环境设置
|
||||
NODE_ENV=production
|
||||
LOG_LEVEL=info
|
||||
```
|
||||
|
||||
## 🔍 故障排除
|
||||
|
||||
### 服务启动失败
|
||||
- **端口占用**:检查端口3000是否被占用,使用 `netstat -ano | findstr :3000` 查看
|
||||
- **Node.js版本**:确认Node.js版本 >= 18.0.0,使用 `node --version` 检查
|
||||
- **依赖问题**:运行 `npm install` 或 `pnpm install` 重新安装依赖
|
||||
- **权限问题**:确保有足够的文件读写权限
|
||||
|
||||
### 测试脚本执行失败
|
||||
- **服务器状态**:确认服务器正在运行,访问 http://localhost:3000 检查
|
||||
- **网络连接**:检查防火墙设置,确保端口3000可访问
|
||||
- **脚本权限**:在Linux/macOS上确保脚本有执行权限:`chmod +x test-api.sh`
|
||||
- **PowerShell策略**:Windows上可能需要设置执行策略:`Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
|
||||
|
||||
### 单元测试失败
|
||||
- **依赖冲突**:清理node_modules并重新安装:`rm -rf node_modules && npm install`
|
||||
- **TypeScript错误**:运行 `npm run build` 检查编译错误
|
||||
- **环境变量**:确保测试环境变量配置正确
|
||||
- **数据库连接**:测试模式下应该使用内存数据库,检查配置
|
||||
|
||||
### Redis文件存储问题
|
||||
- **目录权限**:检查 `redis-data` 目录的读写权限
|
||||
- **配置设置**:确认 `USE_FILE_REDIS=true` 设置正确
|
||||
- **文件锁定**:确保redis.json文件没有被其他进程锁定
|
||||
- **磁盘空间**:检查磁盘空间是否充足
|
||||
|
||||
### 邮件测试模式问题
|
||||
- **配置检查**:确认邮件配置为注释状态(测试模式)
|
||||
- **控制台输出**:检查服务器控制台是否有邮件内容输出
|
||||
- **日志级别**:确保日志级别设置为info或debug以查看详细输出
|
||||
|
||||
### 常见错误解决
|
||||
|
||||
**EADDRINUSE错误:**
|
||||
```bash
|
||||
# 查找占用端口的进程
|
||||
netstat -ano | findstr :3000
|
||||
# 结束进程(Windows)
|
||||
taskkill /PID <进程ID> /F
|
||||
```
|
||||
|
||||
**权限错误:**
|
||||
```bash
|
||||
# Linux/macOS设置权限
|
||||
chmod +x test-api.sh
|
||||
chmod 755 redis-data/
|
||||
```
|
||||
|
||||
**模块未找到错误:**
|
||||
```bash
|
||||
# 清理并重新安装
|
||||
rm -rf node_modules package-lock.json
|
||||
npm install
|
||||
```
|
||||
|
||||
## 📝 测试数据
|
||||
|
||||
测试完成后,你可以查看:
|
||||
|
||||
- `redis-data/redis.json` - 验证码存储数据
|
||||
- 服务器控制台 - 邮件内容输出
|
||||
- 测试脚本输出 - API响应结果
|
||||
|
||||
## 🎯 下一步
|
||||
|
||||
- 查看 [API 文档](http://localhost:3000/api-docs) 了解更多接口
|
||||
- 阅读 [开发规范](./docs/backend_development_guide.md) 开始开发
|
||||
- 使用 [AI 辅助指南](./docs/AI辅助开发规范指南.md) 提高开发效率
|
||||
BIN
docs/development/ab164782cdc17e22f9bdf443c7e1e96c.png
Normal file
BIN
docs/development/ab164782cdc17e22f9bdf443c7e1e96c.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 484 KiB |
505
docs/development/backend_development_guide.md
Normal file
505
docs/development/backend_development_guide.md
Normal file
@@ -0,0 +1,505 @@
|
||||
# 后端开发规范指南
|
||||
|
||||
本文档定义了后端开发的核心规范,包括注释规范、日志规范、业务逻辑规范等,确保代码质量和团队协作效率。
|
||||
|
||||
## 📋 目录
|
||||
|
||||
- [注释规范](#注释规范)
|
||||
- [日志规范](#日志规范)
|
||||
- [业务逻辑规范](#业务逻辑规范)
|
||||
- [异常处理规范](#异常处理规范)
|
||||
- [代码质量规范](#代码质量规范)
|
||||
- [最佳实践](#最佳实践)
|
||||
|
||||
---
|
||||
|
||||
## 📝 注释规范
|
||||
|
||||
### 文件头注释
|
||||
|
||||
每个 TypeScript 文件都必须包含完整的文件头注释:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 文件功能描述
|
||||
*
|
||||
* 功能描述:
|
||||
* - 主要功能点1
|
||||
* - 主要功能点2
|
||||
* - 主要功能点3
|
||||
*
|
||||
* 职责分离:
|
||||
* - 职责描述1
|
||||
* - 职责描述2
|
||||
*
|
||||
* 最近修改:
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
*
|
||||
* @author 作者名
|
||||
* @version x.x.x
|
||||
* @since 创建日期
|
||||
* @lastModified 最后修改日期
|
||||
*/
|
||||
```
|
||||
|
||||
### 类注释
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 类功能描述
|
||||
*
|
||||
* 职责:
|
||||
* - 主要职责1
|
||||
* - 主要职责2
|
||||
*
|
||||
* 主要方法:
|
||||
* - method1() - 方法1功能
|
||||
* - method2() - 方法2功能
|
||||
*
|
||||
* 使用场景:
|
||||
* - 场景描述
|
||||
*/
|
||||
@Injectable()
|
||||
export class ExampleService {
|
||||
// 类实现
|
||||
}
|
||||
```
|
||||
|
||||
### 方法注释(三级注释标准)
|
||||
|
||||
**必须包含以下三个级别的注释:**
|
||||
|
||||
#### 1. 功能描述级别
|
||||
```typescript
|
||||
/**
|
||||
* 用户登录验证
|
||||
*/
|
||||
```
|
||||
|
||||
#### 2. 业务逻辑级别
|
||||
```typescript
|
||||
/**
|
||||
* 用户登录验证
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户名或邮箱格式
|
||||
* 2. 查找用户记录
|
||||
* 3. 验证密码哈希值
|
||||
* 4. 检查用户状态是否允许登录
|
||||
* 5. 记录登录日志
|
||||
* 6. 返回认证结果
|
||||
*/
|
||||
```
|
||||
|
||||
#### 3. 技术实现级别
|
||||
```typescript
|
||||
/**
|
||||
* 用户登录验证
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户名或邮箱格式
|
||||
* 2. 查找用户记录
|
||||
* 3. 验证密码哈希值
|
||||
* 4. 检查用户状态是否允许登录
|
||||
* 5. 记录登录日志
|
||||
* 6. 返回认证结果
|
||||
*
|
||||
* @param loginRequest 登录请求数据
|
||||
* @returns 认证结果,包含用户信息和认证状态
|
||||
* @throws UnauthorizedException 用户名或密码错误时
|
||||
* @throws ForbiddenException 用户状态不允许登录时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await loginService.validateUser({
|
||||
* identifier: 'user@example.com',
|
||||
* password: 'password123'
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
async validateUser(loginRequest: LoginRequest): Promise<AuthResult> {
|
||||
// 实现代码
|
||||
}
|
||||
```
|
||||
|
||||
### 修改记录规范
|
||||
|
||||
#### 修改类型定义
|
||||
|
||||
- **代码规范优化** - 命名规范、注释规范、代码清理等
|
||||
- **功能新增** - 添加新的功能或方法
|
||||
- **功能修改** - 修改现有功能的实现
|
||||
- **Bug修复** - 修复代码缺陷
|
||||
- **性能优化** - 提升代码性能
|
||||
- **重构** - 代码结构调整但功能不变
|
||||
|
||||
#### 修改记录格式
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 代码规范优化 - 清理未使用的导入(EmailSendResult, crypto)
|
||||
* - 2025-01-07: 代码规范优化 - 修复常量命名(saltRounds -> SALT_ROUNDS)
|
||||
* - 2025-01-07: 功能新增 - 添加用户验证码登录功能
|
||||
* - 2025-01-06: Bug修复 - 修复邮箱验证逻辑错误
|
||||
*
|
||||
* @version 1.0.1 (修改后需要递增版本号)
|
||||
* @lastModified 2025-01-07
|
||||
*/
|
||||
```
|
||||
|
||||
#### 修改记录长度限制
|
||||
|
||||
**重要:为保持文件头注释简洁,修改记录只保留最近的5次修改。**
|
||||
|
||||
- ✅ **保留最新5条记录** - 便于快速了解最近变更
|
||||
- ✅ **超出时删除最旧记录** - 保持注释简洁
|
||||
- ✅ **重要修改可标注** - 重大版本更新可特别标注
|
||||
|
||||
```typescript
|
||||
// ✅ 正确示例:保持最新5条记录
|
||||
/**
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 功能新增 - 添加用户头像上传功能
|
||||
* - 2025-01-06: Bug修复 - 修复邮箱验证逻辑错误
|
||||
* - 2025-01-05: 代码规范优化 - 统一异常处理格式
|
||||
* - 2025-01-04: 功能修改 - 优化用户状态管理逻辑
|
||||
* - 2025-01-03: 性能优化 - 优化数据库查询性能
|
||||
*
|
||||
* @version 1.3.0
|
||||
*/
|
||||
|
||||
// ❌ 错误示例:记录过多,注释冗长
|
||||
/**
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 功能新增 - 添加用户头像上传功能
|
||||
* - 2025-01-06: Bug修复 - 修复邮箱验证逻辑错误
|
||||
* - 2025-01-05: 代码规范优化 - 统一异常处理格式
|
||||
* - 2025-01-04: 功能修改 - 优化用户状态管理逻辑
|
||||
* - 2025-01-03: 性能优化 - 优化数据库查询性能
|
||||
* - 2025-01-02: 重构 - 重构用户认证逻辑
|
||||
* - 2025-01-01: 功能新增 - 添加用户权限管理
|
||||
* - 2024-12-31: Bug修复 - 修复登录超时问题
|
||||
* // ... 更多记录导致注释过长
|
||||
*/
|
||||
```
|
||||
|
||||
#### 版本号递增规则
|
||||
|
||||
- **代码规范优化、Bug修复** → 修订版本 +1 (1.0.0 → 1.0.1)
|
||||
- **功能新增、功能修改** → 次版本 +1 (1.0.1 → 1.1.0)
|
||||
- **重构、架构变更** → 主版本 +1 (1.1.0 → 2.0.0)
|
||||
|
||||
---
|
||||
|
||||
## 📊 日志规范
|
||||
|
||||
### 日志级别使用
|
||||
|
||||
```typescript
|
||||
// ERROR - 系统错误,需要立即处理
|
||||
this.logger.error('用户登录失败', { userId, error: error.message });
|
||||
|
||||
// WARN - 警告信息,需要关注但不影响系统运行
|
||||
this.logger.warn('用户多次登录失败', { userId, attemptCount });
|
||||
|
||||
// INFO - 重要的业务操作记录
|
||||
this.logger.info('用户登录成功', { userId, loginTime: new Date() });
|
||||
|
||||
// DEBUG - 调试信息,仅在开发环境使用
|
||||
this.logger.debug('验证用户密码', { userId, hashedPassword: '***' });
|
||||
```
|
||||
|
||||
### 日志格式规范
|
||||
|
||||
```typescript
|
||||
// ✅ 正确格式
|
||||
this.logger.info('操作描述', {
|
||||
userId: 'user123',
|
||||
action: 'login',
|
||||
timestamp: new Date(),
|
||||
metadata: { ip: '192.168.1.1' }
|
||||
});
|
||||
|
||||
// ❌ 错误格式
|
||||
this.logger.info('用户登录');
|
||||
this.logger.info(`用户${userId}登录成功`);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ 业务逻辑规范
|
||||
|
||||
### 防御性编程
|
||||
|
||||
```typescript
|
||||
async getUserById(userId: string): Promise<User> {
|
||||
// 1. 参数验证
|
||||
if (!userId) {
|
||||
throw new BadRequestException('用户ID不能为空');
|
||||
}
|
||||
|
||||
// 2. 业务逻辑验证
|
||||
const user = await this.usersService.findOne(userId);
|
||||
if (!user) {
|
||||
throw new NotFoundException('用户不存在');
|
||||
}
|
||||
|
||||
// 3. 状态检查
|
||||
if (user.status === UserStatus.DELETED) {
|
||||
throw new ForbiddenException('用户已被删除');
|
||||
}
|
||||
|
||||
// 4. 返回结果
|
||||
return user;
|
||||
}
|
||||
```
|
||||
|
||||
### 业务逻辑分层
|
||||
|
||||
```typescript
|
||||
// Controller 层 - 只处理HTTP请求和响应
|
||||
@Controller('users')
|
||||
export class UsersController {
|
||||
@Get(':id')
|
||||
async getUser(@Param('id') id: string) {
|
||||
return this.usersService.getUserById(id);
|
||||
}
|
||||
}
|
||||
|
||||
// Service 层 - 处理业务逻辑
|
||||
@Injectable()
|
||||
export class UsersService {
|
||||
async getUserById(id: string): Promise<User> {
|
||||
// 业务逻辑实现
|
||||
return this.usersCoreService.findUserById(id);
|
||||
}
|
||||
}
|
||||
|
||||
// Core 层 - 核心业务实现
|
||||
@Injectable()
|
||||
export class UsersCoreService {
|
||||
async findUserById(id: string): Promise<User> {
|
||||
// 核心逻辑实现
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ 异常处理规范
|
||||
|
||||
### 异常类型使用
|
||||
|
||||
```typescript
|
||||
// 400 - 客户端请求错误
|
||||
throw new BadRequestException('参数格式错误');
|
||||
|
||||
// 401 - 未授权
|
||||
throw new UnauthorizedException('用户名或密码错误');
|
||||
|
||||
// 403 - 禁止访问
|
||||
throw new ForbiddenException('用户状态不允许此操作');
|
||||
|
||||
// 404 - 资源不存在
|
||||
throw new NotFoundException('用户不存在');
|
||||
|
||||
// 409 - 资源冲突
|
||||
throw new ConflictException('用户名已存在');
|
||||
|
||||
// 500 - 服务器内部错误
|
||||
throw new InternalServerErrorException('系统内部错误');
|
||||
```
|
||||
|
||||
### 异常处理模式
|
||||
|
||||
```typescript
|
||||
async createUser(userData: CreateUserDto): Promise<User> {
|
||||
try {
|
||||
// 1. 参数验证
|
||||
this.validateUserData(userData);
|
||||
|
||||
// 2. 业务逻辑检查
|
||||
await this.checkUserExists(userData.email);
|
||||
|
||||
// 3. 执行创建操作
|
||||
const user = await this.usersRepository.create(userData);
|
||||
|
||||
// 4. 记录成功日志
|
||||
this.logger.info('用户创建成功', { userId: user.id });
|
||||
|
||||
return user;
|
||||
} catch (error) {
|
||||
// 5. 记录错误日志
|
||||
this.logger.error('用户创建失败', {
|
||||
userData: { ...userData, password: '***' },
|
||||
error: error.message
|
||||
});
|
||||
|
||||
// 6. 重新抛出业务异常
|
||||
if (error instanceof BadRequestException) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
// 7. 转换为系统异常
|
||||
throw new InternalServerErrorException('用户创建失败');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 代码质量规范
|
||||
|
||||
### 代码检查清单
|
||||
|
||||
在提交代码前,请确保:
|
||||
|
||||
- [ ] **注释完整性**
|
||||
- [ ] 文件头注释包含功能描述、修改记录、作者信息
|
||||
- [ ] 类注释包含职责、主要方法、使用场景
|
||||
- [ ] 方法注释包含三级注释(功能、业务逻辑、技术实现)
|
||||
- [ ] 修改现有文件时添加了修改记录和更新版本号
|
||||
- [ ] 修改记录只保留最近5次,保持注释简洁
|
||||
|
||||
- [ ] **业务逻辑完整性**
|
||||
- [ ] 所有参数都进行了验证
|
||||
- [ ] 所有异常情况都进行了处理
|
||||
- [ ] 关键操作都记录了日志
|
||||
- [ ] 业务逻辑考虑了所有边界情况
|
||||
|
||||
- [ ] **代码质量**
|
||||
- [ ] 没有未使用的导入和变量
|
||||
- [ ] 常量使用了正确的命名规范
|
||||
- [ ] 方法长度合理(建议不超过50行)
|
||||
- [ ] 单一职责原则,每个方法只做一件事
|
||||
|
||||
- [ ] **安全性**
|
||||
- [ ] 敏感信息不在日志中暴露
|
||||
- [ ] 用户输入都进行了验证和清理
|
||||
- [ ] 权限检查在适当的位置进行
|
||||
|
||||
---
|
||||
|
||||
## 💡 最佳实践
|
||||
|
||||
### 1. 注释驱动开发
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 用户注册功能
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证邮箱格式和唯一性
|
||||
* 2. 验证密码强度
|
||||
* 3. 生成邮箱验证码
|
||||
* 4. 创建用户记录
|
||||
* 5. 发送验证邮件
|
||||
* 6. 返回注册结果
|
||||
*
|
||||
* @param registerData 注册数据
|
||||
* @returns 注册结果
|
||||
*/
|
||||
async registerUser(registerData: RegisterDto): Promise<RegisterResult> {
|
||||
// 先写注释,再写实现
|
||||
// 这样确保逻辑清晰,不遗漏步骤
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 错误优先处理
|
||||
|
||||
```typescript
|
||||
async processPayment(paymentData: PaymentDto): Promise<PaymentResult> {
|
||||
// 1. 先处理所有可能的错误情况
|
||||
if (!paymentData.amount || paymentData.amount <= 0) {
|
||||
throw new BadRequestException('支付金额必须大于0');
|
||||
}
|
||||
|
||||
if (!paymentData.userId) {
|
||||
throw new BadRequestException('用户ID不能为空');
|
||||
}
|
||||
|
||||
const user = await this.usersService.findOne(paymentData.userId);
|
||||
if (!user) {
|
||||
throw new NotFoundException('用户不存在');
|
||||
}
|
||||
|
||||
// 2. 再处理正常的业务逻辑
|
||||
return this.executePayment(paymentData);
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 日志驱动调试
|
||||
|
||||
```typescript
|
||||
async complexBusinessLogic(data: ComplexData): Promise<Result> {
|
||||
this.logger.debug('开始执行复杂业务逻辑', { data });
|
||||
|
||||
try {
|
||||
// 步骤1
|
||||
const step1Result = await this.step1(data);
|
||||
this.logger.debug('步骤1完成', { step1Result });
|
||||
|
||||
// 步骤2
|
||||
const step2Result = await this.step2(step1Result);
|
||||
this.logger.debug('步骤2完成', { step2Result });
|
||||
|
||||
// 步骤3
|
||||
const finalResult = await this.step3(step2Result);
|
||||
this.logger.info('复杂业务逻辑执行成功', { finalResult });
|
||||
|
||||
return finalResult;
|
||||
} catch (error) {
|
||||
this.logger.error('复杂业务逻辑执行失败', { data, error: error.message });
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 版本管理最佳实践
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 用户服务
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 功能新增 - 添加用户头像上传功能 (v1.2.0)
|
||||
* - 2025-01-06: Bug修复 - 修复邮箱验证逻辑错误 (v1.1.1)
|
||||
* - 2025-01-05: 代码规范优化 - 统一异常处理格式 (v1.1.0)
|
||||
* - 2025-01-04: 功能新增 - 添加用户状态管理 (v1.1.0)
|
||||
* - 2025-01-03: 重构 - 重构用户认证逻辑 (v2.0.0)
|
||||
*
|
||||
* @version 1.2.0
|
||||
* @lastModified 2025-01-07
|
||||
*/
|
||||
```
|
||||
|
||||
**修改记录管理原则:**
|
||||
- ✅ **保持简洁** - 只保留最近5次修改
|
||||
- ✅ **定期清理** - 超出5条时删除最旧记录
|
||||
- ✅ **重要标注** - 重大版本更新可特别标注版本号
|
||||
- ✅ **描述清晰** - 每条记录都要说明具体改动内容
|
||||
|
||||
---
|
||||
|
||||
## 🎯 总结
|
||||
|
||||
遵循后端开发规范能够:
|
||||
|
||||
1. **提高代码质量** - 通过完整的注释和规范的实现
|
||||
2. **提升团队效率** - 统一的规范减少沟通成本
|
||||
3. **降低维护成本** - 清晰的文档和日志便于问题定位
|
||||
4. **增强系统稳定性** - 完善的异常处理和防御性编程
|
||||
5. **促进知识传承** - 详细的修改记录和版本管理
|
||||
|
||||
**记住:好的代码不仅要能运行,更要能被理解、维护和扩展。**
|
||||
|
||||
---
|
||||
|
||||
## 📚 相关文档
|
||||
|
||||
- [命名规范](./naming_convention.md) - 代码命名规范
|
||||
- [NestJS 使用指南](./nestjs_guide.md) - 框架最佳实践
|
||||
- [Git 提交规范](./git_commit_guide.md) - 版本控制规范
|
||||
- [AI 辅助开发规范](./AI辅助开发规范指南.md) - AI 辅助开发指南
|
||||
@@ -1,3 +1,7 @@
|
||||
|
||||
|
||||

|
||||
|
||||
# Git 提交规范
|
||||
|
||||
本文档定义了项目的 Git 提交信息格式规范,以保持提交历史的清晰和一致性。
|
||||
@@ -10,6 +10,7 @@
|
||||
- [常量命名](#常量命名)
|
||||
- [接口路由命名](#接口路由命名)
|
||||
- [TypeScript 特定规范](#typescript-特定规范)
|
||||
- [注释命名规范](#注释命名规范)
|
||||
- [命名示例](#命名示例)
|
||||
|
||||
## 文件和文件夹命名
|
||||
@@ -331,6 +332,111 @@ class Repository<type, key> { }
|
||||
@IsString({ message: 'name_must_be_string' })
|
||||
```
|
||||
|
||||
## 注释命名规范
|
||||
|
||||
### 注释标签命名
|
||||
|
||||
**规则:使用标准JSDoc标签**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
@param userId 用户ID
|
||||
@returns 用户信息
|
||||
@throws NotFoundException 用户不存在时
|
||||
@author moyin
|
||||
@version 1.0.0
|
||||
@since 2025-01-07
|
||||
@lastModified 2025-01-07
|
||||
|
||||
❌ 错误示例:
|
||||
@参数 userId 用户ID
|
||||
@返回 用户信息
|
||||
@异常 NotFoundException 用户不存在时
|
||||
@作者 moyin
|
||||
```
|
||||
|
||||
### 修改记录命名
|
||||
|
||||
**规则:使用标准化的修改类型**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
- 2025-01-07: 代码规范优化 - 清理未使用的导入
|
||||
- 2025-01-07: 功能新增 - 添加用户验证功能
|
||||
- 2025-01-07: Bug修复 - 修复登录验证逻辑
|
||||
- 2025-01-07: 性能优化 - 优化数据库查询
|
||||
- 2025-01-07: 重构 - 重构用户服务架构
|
||||
|
||||
❌ 错误示例:
|
||||
- 2025-01-07: 修改 - 改了一些代码
|
||||
- 2025-01-07: 更新 - 更新了功能
|
||||
- 2025-01-07: 优化 - 优化了性能
|
||||
- 2025-01-07: 调整 - 调整了结构
|
||||
```
|
||||
|
||||
**📏 长度限制:修改记录只保留最近5次修改,保持文件头注释简洁。**
|
||||
|
||||
### 注释内容命名
|
||||
|
||||
**规则:使用清晰描述性的中文**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
/** 用户唯一标识符 */
|
||||
userId: string;
|
||||
|
||||
/** 用户邮箱地址,用于登录和通知 */
|
||||
email: string;
|
||||
|
||||
/** 用户状态:active-激活, inactive-未激活, banned-已封禁 */
|
||||
status: UserStatus;
|
||||
|
||||
/**
|
||||
* 验证用户登录凭据
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户名或邮箱格式
|
||||
* 2. 查找用户记录
|
||||
* 3. 验证密码哈希值
|
||||
* 4. 检查用户状态
|
||||
*/
|
||||
|
||||
❌ 错误示例:
|
||||
/** id */
|
||||
userId: string;
|
||||
|
||||
/** 邮箱 */
|
||||
email: string;
|
||||
|
||||
/** 状态 */
|
||||
status: UserStatus;
|
||||
|
||||
/**
|
||||
* 登录
|
||||
*/
|
||||
```
|
||||
|
||||
### 版本号命名规范
|
||||
|
||||
**规则:使用语义化版本号**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
@version 1.0.0 // 主版本.次版本.修订版本
|
||||
@version 1.2.3 // 功能更新
|
||||
@version 2.0.0 // 重大更新
|
||||
|
||||
修改时版本递增规则:
|
||||
- 代码规范优化、Bug修复 → 修订版本 +1 (1.0.0 → 1.0.1)
|
||||
- 功能新增、功能修改 → 次版本 +1 (1.0.1 → 1.1.0)
|
||||
- 重构、架构变更 → 主版本 +1 (1.1.0 → 2.0.0)
|
||||
|
||||
❌ 错误示例:
|
||||
@version v1 // 缺少详细版本号
|
||||
@version 1 // 格式不规范
|
||||
@version latest // 不明确的版本标识
|
||||
```
|
||||
|
||||
## 命名示例
|
||||
|
||||
### 完整的模块示例
|
||||
@@ -483,6 +589,11 @@ export class CreatePlayerDto {
|
||||
- [ ] 函数名清晰表达其功能
|
||||
- [ ] 布尔变量使用 is/has/can 前缀
|
||||
- [ ] 避免使用无意义的缩写
|
||||
- [ ] 注释使用标准JSDoc标签
|
||||
- [ ] 修改记录使用标准化修改类型
|
||||
- [ ] 版本号遵循语义化版本规范
|
||||
- [ ] 修改现有文件时添加了修改记录和更新版本号
|
||||
- [ ] 修改记录只保留最近5次,保持注释简洁
|
||||
|
||||
## 工具配置
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
- [WebSocket 实时通信](#websocket-实时通信)
|
||||
- [数据验证](#数据验证)
|
||||
- [异常处理](#异常处理)
|
||||
- [注释规范](#注释规范)
|
||||
|
||||
## 核心概念
|
||||
|
||||
@@ -453,6 +454,142 @@ export class RoomController {
|
||||
7. **日志记录**:使用内置 Logger 或集成第三方日志库
|
||||
8. **测试**:编写单元测试和 E2E 测试
|
||||
|
||||
## 注释规范
|
||||
|
||||
### 文件头注释
|
||||
|
||||
每个 TypeScript 文件都应该包含完整的文件头注释:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 文件功能描述
|
||||
*
|
||||
* 功能描述:
|
||||
* - 主要功能点1
|
||||
* - 主要功能点2
|
||||
* - 主要功能点3
|
||||
*
|
||||
* 职责分离:
|
||||
* - 职责描述1
|
||||
* - 职责描述2
|
||||
*
|
||||
* 最近修改:
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
*
|
||||
* @author 作者名
|
||||
* @version x.x.x
|
||||
* @since 创建日期
|
||||
* @lastModified 最后修改日期
|
||||
*/
|
||||
```
|
||||
|
||||
### 类注释
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 类功能描述
|
||||
*
|
||||
* 职责:
|
||||
* - 主要职责1
|
||||
* - 主要职责2
|
||||
*
|
||||
* 主要方法:
|
||||
* - method1() - 方法1功能
|
||||
* - method2() - 方法2功能
|
||||
*
|
||||
* 使用场景:
|
||||
* - 场景描述
|
||||
*/
|
||||
@Injectable()
|
||||
export class ExampleService {
|
||||
// 类实现
|
||||
}
|
||||
```
|
||||
|
||||
### 方法注释
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 方法功能描述
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 步骤1描述
|
||||
* 2. 步骤2描述
|
||||
* 3. 步骤3描述
|
||||
*
|
||||
* @param param1 参数1描述
|
||||
* @param param2 参数2描述
|
||||
* @returns 返回值描述
|
||||
* @throws ExceptionType 异常情况描述
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await service.methodName(param1, param2);
|
||||
* ```
|
||||
*/
|
||||
async methodName(param1: string, param2: number): Promise<ResultType> {
|
||||
// 方法实现
|
||||
}
|
||||
```
|
||||
|
||||
### 接口注释
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 接口功能描述
|
||||
*/
|
||||
export interface ExampleInterface {
|
||||
/** 字段1描述 */
|
||||
field1: string;
|
||||
|
||||
/** 字段2描述 */
|
||||
field2: number;
|
||||
|
||||
/** 可选字段描述 */
|
||||
optionalField?: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
### 修改记录规范
|
||||
|
||||
当修改现有文件时,必须在文件头注释中添加修改记录:
|
||||
|
||||
#### 修改类型定义
|
||||
|
||||
- **代码规范优化** - 命名规范、注释规范、代码清理等
|
||||
- **功能新增** - 添加新的功能或方法
|
||||
- **功能修改** - 修改现有功能的实现
|
||||
- **Bug修复** - 修复代码缺陷
|
||||
- **性能优化** - 提升代码性能
|
||||
- **重构** - 代码结构调整但功能不变
|
||||
|
||||
#### 修改记录格式
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 代码规范优化 - 清理未使用的导入(EmailSendResult, crypto)
|
||||
* - 2025-01-07: 代码规范优化 - 修复常量命名(saltRounds -> SALT_ROUNDS)
|
||||
* - 2025-01-07: 功能新增 - 添加用户验证码登录功能
|
||||
* - 2025-01-06: Bug修复 - 修复邮箱验证逻辑错误
|
||||
*
|
||||
* @version 1.0.1 (修改后需要递增版本号)
|
||||
* @lastModified 2025-01-07
|
||||
*/
|
||||
```
|
||||
|
||||
**📏 修改记录长度限制:只保留最近5次修改,超出时删除最旧记录,保持注释简洁。**
|
||||
|
||||
### 注释最佳实践
|
||||
|
||||
1. **保持更新**:修改代码时同步更新注释
|
||||
2. **描述意图**:注释应该说明"为什么"而不只是"做什么"
|
||||
3. **业务逻辑**:复杂的业务逻辑必须有详细的步骤说明
|
||||
4. **异常处理**:明确说明可能抛出的异常和处理方式
|
||||
5. **示例代码**:复杂方法提供使用示例
|
||||
6. **版本管理**:修改文件时必须更新修改记录和版本号
|
||||
|
||||
## 更多资源
|
||||
|
||||
- [NestJS 官方文档](https://docs.nestjs.com/)
|
||||
@@ -1,265 +0,0 @@
|
||||
# 邮箱验证系统
|
||||
|
||||
## 概述
|
||||
|
||||
邮箱验证系统提供完整的邮箱验证功能,包括验证码生成、发送、验证和管理。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 📧 邮箱验证码发送
|
||||
- 🔐 验证码安全验证
|
||||
- ⏰ 验证码过期管理
|
||||
- 🚫 防刷机制(频率限制)
|
||||
- 📊 验证统计和监控
|
||||
|
||||
## 系统架构
|
||||
|
||||
```
|
||||
邮箱验证系统
|
||||
├── 验证码服务 (VerificationService)
|
||||
│ ├── 验证码生成
|
||||
│ ├── 验证码验证
|
||||
│ └── 防刷机制
|
||||
├── 邮件服务 (EmailService)
|
||||
│ ├── 验证码邮件发送
|
||||
│ ├── 欢迎邮件发送
|
||||
│ └── 邮件模板管理
|
||||
└── Redis缓存
|
||||
├── 验证码存储
|
||||
├── 冷却时间管理
|
||||
└── 发送频率限制
|
||||
```
|
||||
|
||||
## 核心组件
|
||||
|
||||
### 1. 验证码服务 (VerificationService)
|
||||
|
||||
负责验证码的生成、验证和管理:
|
||||
|
||||
- **验证码生成**:6位数字验证码
|
||||
- **验证码验证**:支持多次尝试限制
|
||||
- **过期管理**:5分钟有效期
|
||||
- **防刷机制**:60秒冷却时间,每小时最多5次
|
||||
|
||||
### 2. 邮件服务 (EmailService)
|
||||
|
||||
负责邮件的发送和模板管理:
|
||||
|
||||
- **验证码邮件**:发送验证码到用户邮箱
|
||||
- **欢迎邮件**:用户注册成功后发送
|
||||
- **模板支持**:支持HTML邮件模板
|
||||
|
||||
### 3. Redis缓存
|
||||
|
||||
负责数据的临时存储:
|
||||
|
||||
- **验证码存储**:`verification_code:${type}:${identifier}`
|
||||
- **冷却时间**:`verification_cooldown:${type}:${identifier}`
|
||||
- **发送频率**:`verification_hourly:${type}:${identifier}:${date}:${hour}`
|
||||
|
||||
## 使用流程
|
||||
|
||||
### 注册流程中的邮箱验证
|
||||
|
||||
1. **发送验证码**
|
||||
```typescript
|
||||
POST /auth/send-email-verification
|
||||
{
|
||||
"email": "user@example.com"
|
||||
}
|
||||
```
|
||||
|
||||
2. **用户注册**
|
||||
```typescript
|
||||
POST /auth/register
|
||||
{
|
||||
"username": "testuser",
|
||||
"password": "password123",
|
||||
"nickname": "测试用户",
|
||||
"email": "user@example.com",
|
||||
"email_verification_code": "123456"
|
||||
}
|
||||
```
|
||||
|
||||
### 独立邮箱验证
|
||||
|
||||
1. **验证邮箱**
|
||||
```typescript
|
||||
POST /auth/verify-email
|
||||
{
|
||||
"email": "user@example.com",
|
||||
"verification_code": "123456"
|
||||
}
|
||||
```
|
||||
|
||||
## 配置说明
|
||||
|
||||
### 环境变量
|
||||
|
||||
```bash
|
||||
# 邮件服务配置
|
||||
SMTP_HOST=smtp.example.com
|
||||
SMTP_PORT=587
|
||||
SMTP_USER=your-email@example.com
|
||||
SMTP_PASS=your-password
|
||||
SMTP_FROM=noreply@example.com
|
||||
|
||||
# Redis配置
|
||||
REDIS_HOST=localhost
|
||||
REDIS_PORT=6379
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
|
||||
### 验证码配置
|
||||
|
||||
```typescript
|
||||
// 验证码长度
|
||||
CODE_LENGTH = 6
|
||||
|
||||
// 验证码过期时间(秒)
|
||||
CODE_EXPIRE_TIME = 300 // 5分钟
|
||||
|
||||
// 最大验证尝试次数
|
||||
MAX_ATTEMPTS = 3
|
||||
|
||||
// 发送冷却时间(秒)
|
||||
RATE_LIMIT_TIME = 60 // 1分钟
|
||||
|
||||
// 每小时最大发送次数
|
||||
MAX_SENDS_PER_HOUR = 5
|
||||
```
|
||||
|
||||
## API接口
|
||||
|
||||
### 发送邮箱验证码
|
||||
|
||||
- **接口**:`POST /auth/send-email-verification`
|
||||
- **描述**:向指定邮箱发送验证码
|
||||
- **参数**:
|
||||
```typescript
|
||||
{
|
||||
email: string; // 邮箱地址
|
||||
}
|
||||
```
|
||||
|
||||
### 验证邮箱验证码
|
||||
|
||||
- **接口**:`POST /auth/verify-email`
|
||||
- **描述**:使用验证码验证邮箱
|
||||
- **参数**:
|
||||
```typescript
|
||||
{
|
||||
email: string; // 邮箱地址
|
||||
verification_code: string; // 6位数字验证码
|
||||
}
|
||||
```
|
||||
|
||||
### 重新发送验证码
|
||||
|
||||
- **接口**:`POST /auth/resend-email-verification`
|
||||
- **描述**:重新向指定邮箱发送验证码
|
||||
- **参数**:
|
||||
```typescript
|
||||
{
|
||||
email: string; // 邮箱地址
|
||||
}
|
||||
```
|
||||
|
||||
## 错误处理
|
||||
|
||||
### 常见错误码
|
||||
|
||||
- `VERIFICATION_CODE_NOT_FOUND`:验证码不存在或已过期
|
||||
- `VERIFICATION_CODE_INVALID`:验证码错误
|
||||
- `TOO_MANY_ATTEMPTS`:验证尝试次数过多
|
||||
- `RATE_LIMIT_EXCEEDED`:发送频率过高
|
||||
- `EMAIL_SEND_FAILED`:邮件发送失败
|
||||
|
||||
### 错误响应格式
|
||||
|
||||
```typescript
|
||||
{
|
||||
success: false,
|
||||
message: "错误描述",
|
||||
error_code: "ERROR_CODE"
|
||||
}
|
||||
```
|
||||
|
||||
## 监控和日志
|
||||
|
||||
### 关键指标
|
||||
|
||||
- 验证码发送成功率
|
||||
- 验证码验证成功率
|
||||
- 邮件发送延迟
|
||||
- Redis连接状态
|
||||
|
||||
### 日志记录
|
||||
|
||||
- 验证码生成和验证日志
|
||||
- 邮件发送状态日志
|
||||
- 错误和异常日志
|
||||
- 性能监控日志
|
||||
|
||||
## 安全考虑
|
||||
|
||||
### 防刷机制
|
||||
|
||||
1. **发送频率限制**:每个邮箱60秒内只能发送一次
|
||||
2. **每小时限制**:每个邮箱每小时最多发送5次
|
||||
3. **验证尝试限制**:每个验证码最多尝试3次
|
||||
|
||||
### 数据安全
|
||||
|
||||
1. **验证码加密存储**:Redis中的验证码经过加密
|
||||
2. **过期自动清理**:验证码5分钟后自动过期
|
||||
3. **日志脱敏**:日志中不记录完整验证码
|
||||
|
||||
## 部署指南
|
||||
|
||||
详细的部署说明请参考:[deployment-guide.md](./deployment-guide.md)
|
||||
|
||||
## 测试
|
||||
|
||||
### 单元测试
|
||||
|
||||
```bash
|
||||
# 运行验证服务测试
|
||||
npm test -- verification.service.spec.ts
|
||||
|
||||
# 运行邮件服务测试
|
||||
npm test -- email.service.spec.ts
|
||||
```
|
||||
|
||||
### 集成测试
|
||||
|
||||
```bash
|
||||
# 运行邮箱验证集成测试
|
||||
npm run test:e2e -- email-verification
|
||||
```
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 常见问题
|
||||
|
||||
1. **验证码收不到**
|
||||
- 检查SMTP配置
|
||||
- 检查邮箱是否在垃圾邮件中
|
||||
- 检查网络连接
|
||||
|
||||
2. **验证码验证失败**
|
||||
- 检查验证码是否过期
|
||||
- 检查验证码输入是否正确
|
||||
- 检查Redis连接状态
|
||||
|
||||
3. **发送频率限制**
|
||||
- 等待冷却时间结束
|
||||
- 检查是否达到每小时限制
|
||||
|
||||
## 更新日志
|
||||
|
||||
- **v1.0.0** (2025-12-17)
|
||||
- 初始版本发布
|
||||
- 支持基本的邮箱验证功能
|
||||
- 集成Redis缓存
|
||||
- 添加防刷机制
|
||||
@@ -1,316 +0,0 @@
|
||||
# 邮箱验证功能部署指南
|
||||
|
||||
## 概述
|
||||
|
||||
本指南详细说明如何部署和配置邮箱验证功能,包括Redis缓存、邮件服务配置等。
|
||||
|
||||
## 1. 安装依赖
|
||||
|
||||
```bash
|
||||
# 安装新增的依赖包
|
||||
pnpm install ioredis nodemailer
|
||||
|
||||
# 安装类型定义
|
||||
pnpm install -D @types/nodemailer
|
||||
```
|
||||
|
||||
## 2. Redis 服务配置
|
||||
|
||||
### 2.1 安装 Redis
|
||||
|
||||
#### Ubuntu/Debian
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install redis-server
|
||||
sudo systemctl start redis-server
|
||||
sudo systemctl enable redis-server
|
||||
```
|
||||
|
||||
#### CentOS/RHEL
|
||||
```bash
|
||||
sudo yum install redis
|
||||
sudo systemctl start redis
|
||||
sudo systemctl enable redis
|
||||
```
|
||||
|
||||
#### Docker 方式
|
||||
```bash
|
||||
docker run -d --name redis -p 6379:6379 redis:7-alpine
|
||||
```
|
||||
|
||||
### 2.2 Redis 配置验证
|
||||
|
||||
```bash
|
||||
# 测试 Redis 连接
|
||||
redis-cli ping
|
||||
# 应该返回 PONG
|
||||
```
|
||||
|
||||
## 3. 邮件服务配置
|
||||
|
||||
### 3.1 Gmail 配置示例
|
||||
|
||||
1. **启用两步验证**:
|
||||
- 登录 Google 账户
|
||||
- 进入"安全性"设置
|
||||
- 启用"两步验证"
|
||||
|
||||
2. **生成应用专用密码**:
|
||||
- 在"安全性"设置中找到"应用专用密码"
|
||||
- 生成新的应用密码
|
||||
- 记录生成的16位密码
|
||||
|
||||
3. **环境变量配置**:
|
||||
```env
|
||||
EMAIL_HOST=smtp.gmail.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_SECURE=false
|
||||
EMAIL_USER=your-email@gmail.com
|
||||
EMAIL_PASS=your-16-digit-app-password
|
||||
EMAIL_FROM="Whale Town Game" <noreply@gmail.com>
|
||||
```
|
||||
|
||||
### 3.2 其他邮件服务商配置
|
||||
|
||||
#### 163邮箱
|
||||
```env
|
||||
EMAIL_HOST=smtp.163.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_SECURE=false
|
||||
EMAIL_USER=your-email@163.com
|
||||
EMAIL_PASS=your-authorization-code
|
||||
```
|
||||
|
||||
#### QQ邮箱
|
||||
```env
|
||||
EMAIL_HOST=smtp.qq.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_SECURE=false
|
||||
EMAIL_USER=your-email@qq.com
|
||||
EMAIL_PASS=your-authorization-code
|
||||
```
|
||||
|
||||
#### 阿里云邮件推送
|
||||
```env
|
||||
EMAIL_HOST=smtpdm.aliyun.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_SECURE=false
|
||||
EMAIL_USER=your-smtp-username
|
||||
EMAIL_PASS=your-smtp-password
|
||||
```
|
||||
|
||||
## 4. 环境变量配置
|
||||
|
||||
### 4.1 创建环境配置文件
|
||||
|
||||
```bash
|
||||
# 复制环境变量模板
|
||||
cp .env.production.example .env
|
||||
|
||||
# 编辑环境变量
|
||||
nano .env
|
||||
```
|
||||
|
||||
### 4.2 完整的环境变量配置
|
||||
|
||||
```env
|
||||
# 数据库配置
|
||||
DB_HOST=localhost
|
||||
DB_PORT=3306
|
||||
DB_USERNAME=pixel_game
|
||||
DB_PASSWORD=your_db_password
|
||||
DB_NAME=pixel_game_db
|
||||
|
||||
# 应用配置
|
||||
NODE_ENV=production
|
||||
PORT=3000
|
||||
|
||||
# JWT 配置
|
||||
JWT_SECRET=your_jwt_secret_key_here_at_least_32_characters
|
||||
JWT_EXPIRES_IN=7d
|
||||
|
||||
# Redis 配置
|
||||
REDIS_HOST=localhost
|
||||
REDIS_PORT=6379
|
||||
REDIS_PASSWORD=
|
||||
REDIS_DB=0
|
||||
|
||||
# 邮件服务配置
|
||||
EMAIL_HOST=smtp.gmail.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_SECURE=false
|
||||
EMAIL_USER=your-email@gmail.com
|
||||
EMAIL_PASS=your-app-password
|
||||
EMAIL_FROM="Whale Town Game" <noreply@whaletown.com>
|
||||
```
|
||||
|
||||
## 5. 数据库迁移
|
||||
|
||||
由于添加了新的字段,需要更新数据库结构:
|
||||
|
||||
```sql
|
||||
-- 添加邮箱验证状态字段
|
||||
ALTER TABLE users ADD COLUMN email_verified BOOLEAN NOT NULL DEFAULT FALSE COMMENT '邮箱是否已验证';
|
||||
|
||||
-- 为已有用户设置默认值
|
||||
UPDATE users SET email_verified = FALSE WHERE email_verified IS NULL;
|
||||
|
||||
-- 如果是OAuth用户且有邮箱,可以设为已验证
|
||||
UPDATE users SET email_verified = TRUE WHERE github_id IS NOT NULL AND email IS NOT NULL;
|
||||
```
|
||||
|
||||
## 6. 启动和测试
|
||||
|
||||
### 6.1 启动应用
|
||||
|
||||
```bash
|
||||
# 安装依赖
|
||||
pnpm install
|
||||
|
||||
# 构建应用
|
||||
pnpm run build
|
||||
|
||||
# 启动应用
|
||||
pnpm run start:prod
|
||||
```
|
||||
|
||||
### 6.2 功能测试
|
||||
|
||||
#### 测试邮箱验证码发送
|
||||
```bash
|
||||
curl -X POST http://localhost:3000/auth/send-email-verification \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"email":"test@example.com"}'
|
||||
```
|
||||
|
||||
#### 测试邮箱验证
|
||||
```bash
|
||||
curl -X POST http://localhost:3000/auth/verify-email \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"email":"test@example.com","verification_code":"123456"}'
|
||||
```
|
||||
|
||||
#### 测试密码重置
|
||||
```bash
|
||||
curl -X POST http://localhost:3000/auth/forgot-password \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"identifier":"test@example.com"}'
|
||||
```
|
||||
|
||||
## 7. 监控和日志
|
||||
|
||||
### 7.1 查看应用日志
|
||||
|
||||
```bash
|
||||
# PM2 日志
|
||||
pm2 logs pixel-game-server
|
||||
|
||||
# 或者查看文件日志
|
||||
tail -f logs/dev.log
|
||||
```
|
||||
|
||||
### 7.2 Redis 监控
|
||||
|
||||
```bash
|
||||
# 查看 Redis 信息
|
||||
redis-cli info
|
||||
|
||||
# 监控 Redis 命令
|
||||
redis-cli monitor
|
||||
|
||||
# 查看验证码相关的键
|
||||
redis-cli keys "verification_*"
|
||||
```
|
||||
|
||||
### 7.3 邮件发送监控
|
||||
|
||||
应用会记录邮件发送的日志,包括:
|
||||
- 发送成功/失败状态
|
||||
- 收件人信息
|
||||
- 发送时间
|
||||
- 错误信息(如果有)
|
||||
|
||||
## 8. 故障排除
|
||||
|
||||
### 8.1 Redis 连接问题
|
||||
|
||||
**问题**:Redis连接失败
|
||||
```
|
||||
Redis连接错误: Error: connect ECONNREFUSED 127.0.0.1:6379
|
||||
```
|
||||
|
||||
**解决方案**:
|
||||
1. 检查Redis服务状态:`sudo systemctl status redis`
|
||||
2. 启动Redis服务:`sudo systemctl start redis`
|
||||
3. 检查防火墙设置
|
||||
4. 验证Redis配置文件
|
||||
|
||||
### 8.2 邮件发送问题
|
||||
|
||||
**问题**:邮件发送失败
|
||||
```
|
||||
邮件发送失败: Error: Invalid login: 535-5.7.8 Username and Password not accepted
|
||||
```
|
||||
|
||||
**解决方案**:
|
||||
1. 检查邮箱用户名和密码
|
||||
2. 确认已启用应用专用密码(Gmail)
|
||||
3. 检查邮件服务商的SMTP设置
|
||||
4. 验证网络连接
|
||||
|
||||
### 8.3 验证码问题
|
||||
|
||||
**问题**:验证码验证失败
|
||||
|
||||
**解决方案**:
|
||||
1. 检查Redis中是否存在验证码:`redis-cli get verification_code:email_verification:test@example.com`
|
||||
2. 检查验证码是否过期
|
||||
3. 验证验证码格式(6位数字)
|
||||
4. 检查应用日志
|
||||
|
||||
## 9. 安全建议
|
||||
|
||||
### 9.1 邮件服务安全
|
||||
|
||||
1. **使用应用专用密码**:不要使用主密码
|
||||
2. **启用TLS/SSL**:确保邮件传输加密
|
||||
3. **限制发送频率**:防止邮件轰炸
|
||||
4. **监控发送量**:避免被标记为垃圾邮件
|
||||
|
||||
### 9.2 Redis 安全
|
||||
|
||||
1. **设置密码**:`requirepass your_redis_password`
|
||||
2. **绑定IP**:`bind 127.0.0.1`
|
||||
3. **禁用危险命令**:`rename-command FLUSHDB ""`
|
||||
4. **定期备份**:设置Redis数据备份
|
||||
|
||||
### 9.3 验证码安全
|
||||
|
||||
1. **设置过期时间**:默认5分钟
|
||||
2. **限制尝试次数**:最多3次
|
||||
3. **防刷机制**:60秒冷却时间
|
||||
4. **记录日志**:监控异常行为
|
||||
|
||||
## 10. 性能优化
|
||||
|
||||
### 10.1 Redis 优化
|
||||
|
||||
```redis
|
||||
# Redis 配置优化
|
||||
maxmemory 256mb
|
||||
maxmemory-policy allkeys-lru
|
||||
save 900 1
|
||||
save 300 10
|
||||
save 60 10000
|
||||
```
|
||||
|
||||
### 10.2 邮件发送优化
|
||||
|
||||
1. **连接池**:复用SMTP连接
|
||||
2. **异步发送**:不阻塞主流程
|
||||
3. **队列机制**:处理大量邮件
|
||||
4. **失败重试**:自动重试机制
|
||||
|
||||
---
|
||||
|
||||
*部署完成后,建议进行完整的功能测试,确保所有邮箱验证功能正常工作。*
|
||||
@@ -1,80 +0,0 @@
|
||||
# 日志系统
|
||||
|
||||
## 概述
|
||||
|
||||
项目集成了完整的日志系统,基于 Pino 高性能日志库,提供结构化日志记录、自动敏感信息过滤和多级别日志控制。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 🚀 高性能日志记录
|
||||
- 🔒 自动敏感信息过滤
|
||||
- 🎯 多级别日志控制
|
||||
- 🔍 请求上下文绑定
|
||||
- 📊 结构化日志输出
|
||||
|
||||
## 使用示例
|
||||
|
||||
### 基础用法
|
||||
|
||||
```typescript
|
||||
import { AppLoggerService } from './core/utils/logger/logger.service';
|
||||
|
||||
@Injectable()
|
||||
export class UserService {
|
||||
constructor(private readonly logger: AppLoggerService) {}
|
||||
|
||||
async createUser(userData: CreateUserDto) {
|
||||
this.logger.info('开始创建用户', {
|
||||
operation: 'createUser',
|
||||
email: userData.email,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
try {
|
||||
const user = await this.userRepository.save(userData);
|
||||
|
||||
this.logger.info('用户创建成功', {
|
||||
operation: 'createUser',
|
||||
userId: user.id,
|
||||
email: userData.email
|
||||
});
|
||||
|
||||
return user;
|
||||
} catch (error) {
|
||||
this.logger.error('用户创建失败', {
|
||||
operation: 'createUser',
|
||||
email: userData.email,
|
||||
error: error.message
|
||||
}, error.stack);
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 日志级别
|
||||
|
||||
- `error`: 错误信息
|
||||
- `warn`: 警告信息
|
||||
- `info`: 一般信息
|
||||
- `debug`: 调试信息
|
||||
|
||||
## 配置
|
||||
|
||||
日志配置位于 `src/core/utils/logger/logger.config.ts`,支持:
|
||||
|
||||
- 日志级别设置
|
||||
- 输出格式配置
|
||||
- 敏感信息过滤规则
|
||||
- 文件输出配置
|
||||
|
||||
## 敏感信息过滤
|
||||
|
||||
系统自动过滤以下敏感信息:
|
||||
- 密码字段
|
||||
- 令牌信息
|
||||
- 个人身份信息
|
||||
- 支付相关信息
|
||||
|
||||
详细使用方法请参考:[后端开发规范指南 - 日志系统使用指南](../../backend_development_guide.md#四日志系统使用指南)
|
||||
@@ -1,363 +0,0 @@
|
||||
# 日志系统详细说明
|
||||
|
||||
## 📋 概述
|
||||
|
||||
本项目的日志系统基于 Pino 高性能日志库构建,提供完整的日志记录、管理和分析功能。
|
||||
|
||||
---
|
||||
|
||||
## 🗂️ 日志文件结构
|
||||
|
||||
### 开发环境 (`NODE_ENV=development`)
|
||||
|
||||
```
|
||||
logs/
|
||||
└── dev.log # 开发环境综合日志(所有级别)
|
||||
```
|
||||
|
||||
**输出方式:**
|
||||
- 🖥️ **控制台**:彩色美化输出,便于开发调试
|
||||
- 📁 **文件**:保存到 `logs/dev.log`,便于问题追踪
|
||||
|
||||
### 生产环境 (`NODE_ENV=production`)
|
||||
|
||||
```
|
||||
logs/
|
||||
├── app.log # 应用综合日志(info及以上级别)
|
||||
├── error.log # 错误日志(error和fatal级别)
|
||||
├── access.log # HTTP访问日志(请求响应记录)
|
||||
├── app.log.gz # 压缩的历史日志文件
|
||||
├── error.log.gz # 压缩的历史错误日志
|
||||
└── access.log.gz # 压缩的历史访问日志
|
||||
```
|
||||
|
||||
**输出方式:**
|
||||
- 📁 **文件**:分类保存到不同的日志文件
|
||||
- 🖥️ **控制台**:仅输出 warn 及以上级别(用于容器日志收集)
|
||||
|
||||
---
|
||||
|
||||
## 📊 日志级别和用途
|
||||
|
||||
| 级别 | 数值 | 用途 | 保存位置 | 示例场景 |
|
||||
|------|------|------|----------|----------|
|
||||
| **TRACE** | 10 | 极细粒度调试 | dev.log | 循环内变量状态 |
|
||||
| **DEBUG** | 20 | 开发调试信息 | dev.log | 方法调用参数 |
|
||||
| **INFO** | 30 | 重要业务操作 | app.log, dev.log | 用户登录成功 |
|
||||
| **WARN** | 40 | 警告信息 | app.log, dev.log, 控制台 | 参数验证失败 |
|
||||
| **ERROR** | 50 | 错误信息 | error.log, app.log, 控制台 | 数据库连接失败 |
|
||||
| **FATAL** | 60 | 致命错误 | error.log, app.log, 控制台 | 系统不可用 |
|
||||
|
||||
---
|
||||
|
||||
## 🔄 日志轮转和管理
|
||||
|
||||
### 自动轮转策略
|
||||
|
||||
| 文件类型 | 轮转频率 | 文件大小限制 | 保留时间 | 压缩策略 |
|
||||
|----------|----------|--------------|----------|----------|
|
||||
| **app.log** | 每日 | 10MB | 7天 | 7天后压缩 |
|
||||
| **error.log** | 每日 | 10MB | 30天 | 7天后压缩 |
|
||||
| **access.log** | 每日 | 50MB | 14天 | 7天后压缩 |
|
||||
| **dev.log** | 手动 | 无限制 | 无限制 | 不压缩 |
|
||||
|
||||
### 定时任务
|
||||
|
||||
| 任务 | 执行时间 | 功能 |
|
||||
|------|----------|------|
|
||||
| **日志清理** | 每天 02:00 | 删除过期日志文件 |
|
||||
| **日志压缩** | 每周日 03:00 | 压缩7天前的日志文件 |
|
||||
| **健康监控** | 每小时 | 监控日志系统状态 |
|
||||
| **统计报告** | 每天 09:00 | 输出日志统计信息 |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 如何使用日志系统
|
||||
|
||||
### 基本使用
|
||||
|
||||
```typescript
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { AppLoggerService } from '../core/utils/logger/logger.service';
|
||||
|
||||
@Injectable()
|
||||
export class UserService {
|
||||
constructor(private readonly logger: AppLoggerService) {}
|
||||
|
||||
async createUser(userData: CreateUserDto) {
|
||||
// 记录操作开始
|
||||
this.logger.info('开始创建用户', {
|
||||
operation: 'createUser',
|
||||
email: userData.email,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
try {
|
||||
const user = await this.userRepository.save(userData);
|
||||
|
||||
// 记录成功操作
|
||||
this.logger.info('用户创建成功', {
|
||||
operation: 'createUser',
|
||||
userId: user.id,
|
||||
email: userData.email,
|
||||
duration: Date.now() - startTime
|
||||
});
|
||||
|
||||
return user;
|
||||
} catch (error) {
|
||||
// 记录错误
|
||||
this.logger.error('用户创建失败', {
|
||||
operation: 'createUser',
|
||||
email: userData.email,
|
||||
error: error.message
|
||||
}, error.stack);
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 请求上下文绑定
|
||||
|
||||
```typescript
|
||||
@Controller('users')
|
||||
export class UserController {
|
||||
constructor(private readonly logger: AppLoggerService) {}
|
||||
|
||||
@Get(':id')
|
||||
async getUser(@Param('id') id: string, @Req() req: Request) {
|
||||
// 绑定请求上下文
|
||||
const requestLogger = this.logger.bindRequest(req, 'UserController');
|
||||
|
||||
requestLogger.info('开始获取用户信息', { userId: id });
|
||||
|
||||
try {
|
||||
const user = await this.userService.findById(id);
|
||||
requestLogger.info('用户信息获取成功', { userId: id });
|
||||
return user;
|
||||
} catch (error) {
|
||||
requestLogger.error('用户信息获取失败', error.stack, {
|
||||
userId: id,
|
||||
reason: error.message
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 日志格式详解
|
||||
|
||||
### 开发环境日志格式
|
||||
|
||||
```
|
||||
🕐 2024-12-13 14:30:25 📝 INFO pixel-game-server [UserService] 用户创建成功
|
||||
operation: "createUser"
|
||||
userId: "user_123"
|
||||
email: "user@example.com"
|
||||
duration: 45
|
||||
```
|
||||
|
||||
### 生产环境日志格式 (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"level": 30,
|
||||
"time": 1702456225000,
|
||||
"pid": 12345,
|
||||
"hostname": "server-01",
|
||||
"app": "pixel-game-server",
|
||||
"version": "1.0.0",
|
||||
"msg": "用户创建成功",
|
||||
"operation": "createUser",
|
||||
"userId": "user_123",
|
||||
"email": "user@example.com",
|
||||
"duration": 45,
|
||||
"reqId": "req_1702456225_abc123"
|
||||
}
|
||||
```
|
||||
|
||||
### HTTP 请求日志格式
|
||||
|
||||
```json
|
||||
{
|
||||
"level": 30,
|
||||
"time": 1702456225000,
|
||||
"req": {
|
||||
"id": "req_1702456225_abc123",
|
||||
"method": "POST",
|
||||
"url": "/api/users",
|
||||
"headers": {
|
||||
"host": "localhost:3000",
|
||||
"user-agent": "Mozilla/5.0...",
|
||||
"content-type": "application/json"
|
||||
},
|
||||
"ip": "127.0.0.1"
|
||||
},
|
||||
"res": {
|
||||
"statusCode": 201,
|
||||
"responseTime": 45
|
||||
},
|
||||
"msg": "POST /api/users completed in 45ms"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 问题排查指南
|
||||
|
||||
### 1. 如何查找特定用户的操作日志?
|
||||
|
||||
```bash
|
||||
# 在日志文件中搜索特定用户ID
|
||||
grep "userId.*user_123" logs/app.log
|
||||
|
||||
# 搜索特定操作
|
||||
grep "operation.*createUser" logs/app.log
|
||||
|
||||
# 搜索特定时间段的日志
|
||||
grep "2024-12-13 14:" logs/app.log
|
||||
```
|
||||
|
||||
### 2. 如何查找错误日志?
|
||||
|
||||
```bash
|
||||
# 查看所有错误日志
|
||||
cat logs/error.log
|
||||
|
||||
# 查看最近的错误
|
||||
tail -f logs/error.log
|
||||
|
||||
# 搜索特定错误
|
||||
grep "数据库连接失败" logs/error.log
|
||||
```
|
||||
|
||||
### 3. 如何分析性能问题?
|
||||
|
||||
```bash
|
||||
# 查找响应时间超过1000ms的请求
|
||||
grep "responseTime.*[0-9][0-9][0-9][0-9]" logs/access.log
|
||||
|
||||
# 查找特定接口的性能数据
|
||||
grep "POST /api/users" logs/access.log | grep responseTime
|
||||
```
|
||||
|
||||
### 4. 如何监控系统健康状态?
|
||||
|
||||
```bash
|
||||
# 查看日志统计信息
|
||||
grep "日志系统健康状态报告" logs/app.log
|
||||
|
||||
# 查看日志清理记录
|
||||
grep "日志清理任务完成" logs/app.log
|
||||
|
||||
# 查看压缩记录
|
||||
grep "日志压缩任务完成" logs/app.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📈 日志分析和监控
|
||||
|
||||
### 日志统计信息
|
||||
|
||||
系统会自动收集以下统计信息:
|
||||
|
||||
- **文件数量**:当前日志文件总数
|
||||
- **总大小**:所有日志文件占用的磁盘空间
|
||||
- **错误日志数量**:错误级别日志文件数量
|
||||
- **最旧/最新文件**:日志文件的时间范围
|
||||
- **平均文件大小**:单个日志文件的平均大小
|
||||
|
||||
### 健康监控告警
|
||||
|
||||
系统会在以下情况发出警告:
|
||||
|
||||
- 📊 **磁盘空间告警**:日志文件总大小超过阈值
|
||||
- ⚠️ **错误日志告警**:错误日志数量异常增长
|
||||
- 🔧 **清理失败告警**:日志清理任务执行失败
|
||||
- 💾 **压缩失败告警**:日志压缩任务执行失败
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
### 环境变量配置
|
||||
|
||||
```bash
|
||||
# 应用名称
|
||||
APP_NAME=pixel-game-server
|
||||
|
||||
# 环境标识
|
||||
NODE_ENV=development
|
||||
|
||||
# 日志级别
|
||||
LOG_LEVEL=debug
|
||||
|
||||
# 日志目录
|
||||
LOG_DIR=./logs
|
||||
|
||||
# 日志保留天数
|
||||
LOG_MAX_FILES=7d
|
||||
|
||||
# 单个日志文件最大大小
|
||||
LOG_MAX_SIZE=10m
|
||||
```
|
||||
|
||||
### 高级配置选项
|
||||
|
||||
如需自定义日志配置,可以修改 `src/core/utils/logger/logger.config.ts`:
|
||||
|
||||
```typescript
|
||||
// 自定义日志轮转策略
|
||||
{
|
||||
target: 'pino-roll',
|
||||
options: {
|
||||
file: path.join(logDir, 'app.log'),
|
||||
frequency: 'daily', // 轮转频率:daily, hourly, weekly
|
||||
size: '10m', // 文件大小限制
|
||||
limit: {
|
||||
count: 7, // 保留文件数量
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚨 注意事项
|
||||
|
||||
### 安全考虑
|
||||
|
||||
1. **敏感信息过滤**:系统自动过滤密码、token等敏感字段
|
||||
2. **访问控制**:确保日志文件只有授权用户可以访问
|
||||
3. **传输加密**:生产环境建议使用加密传输日志
|
||||
|
||||
### 性能考虑
|
||||
|
||||
1. **异步写入**:Pino 使用异步写入,不会阻塞主线程
|
||||
2. **日志级别**:生产环境建议使用 info 及以上级别
|
||||
3. **文件轮转**:及时清理和压缩日志文件,避免占用过多磁盘空间
|
||||
|
||||
### 运维建议
|
||||
|
||||
1. **监控磁盘空间**:定期检查日志目录的磁盘使用情况
|
||||
2. **备份重要日志**:对于重要的错误日志,建议定期备份
|
||||
3. **日志分析**:可以集成 ELK Stack 等日志分析工具
|
||||
4. **告警设置**:配置日志监控告警,及时发现系统问题
|
||||
|
||||
---
|
||||
|
||||
## 🔗 相关文档
|
||||
|
||||
- [后端开发规范 - 日志系统使用指南](./backend_development_guide.md#四日志系统使用指南)
|
||||
- [AI 辅助开发规范指南](./AI辅助开发规范指南.md)
|
||||
- [Pino 官方文档](https://getpino.io/)
|
||||
- [NestJS Pino 集成文档](https://github.com/iamolegga/nestjs-pino)
|
||||
|
||||
---
|
||||
|
||||
**💡 提示:使用 [AI 辅助开发指南](./AI辅助开发规范指南.md) 可以让 AI 帮你自动生成符合规范的日志代码!**
|
||||
@@ -1,334 +0,0 @@
|
||||
# 用户认证系统
|
||||
|
||||
## 概述
|
||||
|
||||
用户认证系统提供完整的用户注册、登录、密码管理功能,支持传统用户名密码登录和第三方OAuth登录。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 🔐 多种登录方式:用户名/邮箱/手机号登录
|
||||
- 📝 用户注册和信息管理
|
||||
- 🐙 GitHub OAuth 第三方登录
|
||||
- 🔄 密码重置和修改
|
||||
- 🛡️ bcrypt 密码加密
|
||||
- 🎯 基于角色的权限控制
|
||||
|
||||
## 架构设计
|
||||
|
||||
### 分层结构
|
||||
|
||||
```
|
||||
src/
|
||||
├── business/login/ # 业务逻辑层
|
||||
│ ├── login.controller.ts # HTTP 控制器
|
||||
│ ├── login.service.ts # 业务服务
|
||||
│ ├── login.dto.ts # 数据传输对象
|
||||
│ ├── login.service.spec.ts # 业务服务测试
|
||||
│ └── login.module.ts # 业务模块
|
||||
├── core/
|
||||
│ ├── login_core/ # 核心功能层
|
||||
│ │ ├── login_core.service.ts # 核心认证逻辑
|
||||
│ │ ├── login_core.service.spec.ts # 核心服务测试
|
||||
│ │ └── login_core.module.ts # 核心模块
|
||||
│ └── db/users/ # 数据访问层
|
||||
│ ├── users.entity.ts # 用户实体
|
||||
│ ├── users.service.ts # 用户数据服务
|
||||
│ └── users.dto.ts # 用户 DTO
|
||||
```
|
||||
|
||||
### 职责分离
|
||||
|
||||
#### 1. 业务逻辑层 (Business Layer)
|
||||
- **位置**: `src/business/login/`
|
||||
- **职责**:
|
||||
- 处理HTTP请求和响应
|
||||
- 数据格式化和验证
|
||||
- 业务流程控制
|
||||
- 错误处理和日志记录
|
||||
|
||||
#### 2. 核心功能层 (Core Layer)
|
||||
- **位置**: `src/core/login_core/`
|
||||
- **职责**:
|
||||
- 认证核心算法实现
|
||||
- 密码加密和验证
|
||||
- 用户查找和匹配
|
||||
- 令牌生成和验证
|
||||
|
||||
#### 3. 数据访问层 (Data Access Layer)
|
||||
- **位置**: `src/core/db/users/`
|
||||
- **职责**:
|
||||
- 数据库操作封装
|
||||
- 实体关系映射
|
||||
- 数据完整性保证
|
||||
- 查询优化
|
||||
|
||||
## API 接口
|
||||
|
||||
### 用户注册
|
||||
|
||||
```bash
|
||||
POST /auth/register
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"username": "testuser",
|
||||
"password": "password123",
|
||||
"nickname": "测试用户",
|
||||
"email": "test@example.com",
|
||||
"phone": "+8613800138000"
|
||||
}
|
||||
```
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"user": {
|
||||
"id": "1",
|
||||
"username": "testuser",
|
||||
"nickname": "测试用户",
|
||||
"email": "test@example.com",
|
||||
"phone": "+8613800138000",
|
||||
"avatar_url": null,
|
||||
"role": 1,
|
||||
"created_at": "2025-12-17T10:00:00.000Z"
|
||||
},
|
||||
"access_token": "eyJ1c2VySWQiOiIxIiwidXNlcm5hbWUiOiJ0ZXN0dXNlciJ9...",
|
||||
"is_new_user": true,
|
||||
"message": "注册成功"
|
||||
},
|
||||
"message": "注册成功"
|
||||
}
|
||||
```
|
||||
|
||||
### 用户登录
|
||||
|
||||
```bash
|
||||
POST /auth/login
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"identifier": "testuser", # 支持用户名/邮箱/手机号
|
||||
"password": "password123"
|
||||
}
|
||||
```
|
||||
|
||||
### GitHub OAuth登录
|
||||
|
||||
```bash
|
||||
POST /auth/github
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"github_id": "12345678",
|
||||
"username": "githubuser",
|
||||
"nickname": "GitHub用户",
|
||||
"email": "github@example.com",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/12345678"
|
||||
}
|
||||
```
|
||||
|
||||
### 密码重置
|
||||
|
||||
```bash
|
||||
# 1. 发送验证码
|
||||
POST /auth/forgot-password
|
||||
{
|
||||
"identifier": "test@example.com"
|
||||
}
|
||||
|
||||
# 2. 重置密码
|
||||
POST /auth/reset-password
|
||||
{
|
||||
"identifier": "test@example.com",
|
||||
"verification_code": "123456",
|
||||
"new_password": "newpassword123"
|
||||
}
|
||||
```
|
||||
|
||||
### 修改密码
|
||||
|
||||
```bash
|
||||
PUT /auth/change-password
|
||||
{
|
||||
"user_id": "1",
|
||||
"old_password": "password123",
|
||||
"new_password": "newpassword123"
|
||||
}
|
||||
```
|
||||
|
||||
## 数据模型
|
||||
|
||||
### 用户实体 (Users Entity)
|
||||
|
||||
```typescript
|
||||
{
|
||||
id: bigint, // 主键ID
|
||||
username: string, // 用户名(唯一)
|
||||
email?: string, // 邮箱(唯一,可选)
|
||||
phone?: string, // 手机号(唯一,可选)
|
||||
password_hash?: string, // 密码哈希(OAuth用户为空)
|
||||
nickname: string, // 显示昵称
|
||||
github_id?: string, // GitHub ID(唯一,可选)
|
||||
avatar_url?: string, // 头像URL
|
||||
role: number, // 用户角色(1-普通,9-管理员)
|
||||
created_at: Date, // 创建时间
|
||||
updated_at: Date // 更新时间
|
||||
}
|
||||
```
|
||||
|
||||
### 数据库设计特点
|
||||
|
||||
1. **唯一性约束**: username, email, phone, github_id
|
||||
2. **索引优化**: 主键、唯一索引、角色索引
|
||||
3. **字符集支持**: utf8mb4,支持emoji
|
||||
4. **数据类型**: BIGINT主键,VARCHAR字段,DATETIME时间戳
|
||||
|
||||
## 安全机制
|
||||
|
||||
### 1. 密码安全
|
||||
- **加密算法**: bcrypt (saltRounds=12)
|
||||
- **强度验证**: 最少8位,包含字母和数字
|
||||
- **存储安全**: 只存储哈希值,不存储明文
|
||||
|
||||
### 2. 数据验证
|
||||
- **输入验证**: class-validator装饰器
|
||||
- **SQL注入防护**: TypeORM参数化查询
|
||||
- **XSS防护**: 数据转义和验证
|
||||
|
||||
### 3. 访问控制
|
||||
- **令牌机制**: 基于用户信息的访问令牌
|
||||
- **角色权限**: 基于角色的访问控制(RBAC)
|
||||
- **会话管理**: 令牌生成和验证
|
||||
|
||||
### 4. 错误处理
|
||||
- **统一异常**: NestJS异常过滤器
|
||||
- **日志记录**: 操作日志和错误日志
|
||||
- **信息脱敏**: 敏感信息自动脱敏
|
||||
|
||||
## 测试覆盖
|
||||
|
||||
### 单元测试
|
||||
- 核心服务测试:`src/core/login_core/login_core.service.spec.ts`
|
||||
- 业务服务测试:`src/business/login/login.service.spec.ts`
|
||||
|
||||
### 集成测试
|
||||
- 端到端测试:`test/business/login.e2e-spec.ts`
|
||||
|
||||
### 测试用例
|
||||
- 用户注册和登录流程
|
||||
- GitHub OAuth认证
|
||||
- 密码重置和修改
|
||||
- 数据验证和错误处理
|
||||
- 安全性测试
|
||||
|
||||
## 使用示例
|
||||
|
||||
### JavaScript/TypeScript
|
||||
|
||||
```javascript
|
||||
// 用户注册
|
||||
const registerResponse = await fetch('/auth/register', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({
|
||||
username: 'testuser',
|
||||
password: 'password123',
|
||||
nickname: '测试用户',
|
||||
email: 'test@example.com'
|
||||
})
|
||||
});
|
||||
|
||||
const registerData = await registerResponse.json();
|
||||
console.log(registerData);
|
||||
|
||||
// 用户登录
|
||||
const loginResponse = await fetch('/auth/login', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({
|
||||
identifier: 'testuser',
|
||||
password: 'password123'
|
||||
})
|
||||
});
|
||||
|
||||
const loginData = await loginResponse.json();
|
||||
console.log(loginData);
|
||||
```
|
||||
|
||||
### curl 命令
|
||||
|
||||
```bash
|
||||
# 用户注册
|
||||
curl -X POST http://localhost:3000/auth/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "testuser",
|
||||
"password": "password123",
|
||||
"nickname": "测试用户",
|
||||
"email": "test@example.com"
|
||||
}'
|
||||
|
||||
# 用户登录
|
||||
curl -X POST http://localhost:3000/auth/login \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"identifier": "testuser",
|
||||
"password": "password123"
|
||||
}'
|
||||
```
|
||||
|
||||
## 错误处理
|
||||
|
||||
### 常见错误代码
|
||||
|
||||
- `LOGIN_FAILED`: 登录失败
|
||||
- `REGISTER_FAILED`: 注册失败
|
||||
- `GITHUB_OAUTH_FAILED`: GitHub登录失败
|
||||
- `SEND_CODE_FAILED`: 发送验证码失败
|
||||
- `RESET_PASSWORD_FAILED`: 密码重置失败
|
||||
- `CHANGE_PASSWORD_FAILED`: 密码修改失败
|
||||
|
||||
### 错误响应格式
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"message": "错误描述",
|
||||
"error_code": "ERROR_CODE"
|
||||
}
|
||||
```
|
||||
|
||||
## 扩展功能
|
||||
|
||||
### 计划中的功能
|
||||
|
||||
1. **JWT令牌管理**
|
||||
- 访问令牌和刷新令牌
|
||||
- 令牌黑名单机制
|
||||
- 自动刷新功能
|
||||
|
||||
2. **多因子认证**
|
||||
- 短信验证码
|
||||
- 邮箱验证码
|
||||
- TOTP应用支持
|
||||
|
||||
3. **社交登录扩展**
|
||||
- 微信登录
|
||||
- QQ登录
|
||||
- 微博登录
|
||||
|
||||
4. **安全增强**
|
||||
- 登录失败次数限制
|
||||
- IP白名单/黑名单
|
||||
- 设备指纹识别
|
||||
|
||||
5. **用户管理**
|
||||
- 用户状态管理(激活/禁用)
|
||||
- 用户角色权限细化
|
||||
- 用户行为日志记录
|
||||
386
docs/systems/zulip/README.md
Normal file
386
docs/systems/zulip/README.md
Normal file
@@ -0,0 +1,386 @@
|
||||
# Zulip 集成系统文档
|
||||
|
||||
## 概述
|
||||
|
||||
Zulip 集成系统是一个为 2D 社交 MMO 游戏设计的跨平台聊天解决方案。该系统实现了游戏内外的无缝互通,让不玩游戏的 Zulip 社群成员也能与游戏内玩家实时交流。
|
||||
|
||||
### 核心设计理念
|
||||
|
||||
系统采用 **统一网关 (Unified Gateway)** 架构,利用 Zulip 的 Stream-Topic 线程模型与游戏世界的空间概念进行映射:
|
||||
|
||||
| 游戏概念 | Zulip 概念 | 示例 |
|
||||
|---------|-----------|------|
|
||||
| Game World / Map | Stream | #Novice_Village |
|
||||
| Interactive Object / Event | Topic | Notice Board, Tavern Gossip |
|
||||
| Whisper / Party | Private Message | 私聊消息 |
|
||||
|
||||
### 架构优势
|
||||
|
||||
1. **客户端极度简化**: Godot 客户端无需处理 HTTP 请求、Long Polling 或复杂 JSON 解析
|
||||
2. **安全性**: Zulip API Key 永不下发到客户端,位置欺诈完全消除
|
||||
3. **协议统一**: 单一 WebSocket 协议,网络层代码减半
|
||||
|
||||
## 系统架构
|
||||
|
||||
```
|
||||
┌─────────────────┐ WebSocket ┌─────────────────────────────────────┐
|
||||
│ Godot Client │◄──────────────────►│ NestJS 中间件服务器 │
|
||||
│ (Game Client) │ Game Protocol │ ┌─────────────────────────────────┐│
|
||||
└─────────────────┘ │ │ WebSocket Gateway ││
|
||||
│ │ ├─ Session Manager ││
|
||||
│ │ ├─ Message Filter ││
|
||||
│ │ └─ Zulip Client Pool ││
|
||||
│ └─────────────────────────────────┘│
|
||||
└──────────────┬──────────────────────┘
|
||||
│ REST API / Long Polling
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ Zulip Server │
|
||||
│ ├─ REST API │
|
||||
│ └─ Event Queue │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## 核心组件
|
||||
|
||||
### 1. WebSocket Gateway (`zulip-websocket.gateway.ts`)
|
||||
|
||||
统一网关,处理所有 Godot 客户端连接,实现游戏协议到 Zulip 协议的转换。
|
||||
|
||||
**主要功能:**
|
||||
- 连接认证和会话管理
|
||||
- 消息路由和协议转换
|
||||
- 权限控制和上下文注入
|
||||
|
||||
**支持的消息类型:**
|
||||
- `login`: 玩家登录
|
||||
- `chat`: 发送聊天消息
|
||||
- `position_update`: 位置更新
|
||||
- `logout`: 玩家登出
|
||||
|
||||
### 2. Session Manager (`session-manager.service.ts`)
|
||||
|
||||
会话管理器,维护 Socket_ID 与 Zulip_Queue_ID 的绑定关系。
|
||||
|
||||
**主要功能:**
|
||||
- 会话创建/销毁
|
||||
- 玩家位置跟踪
|
||||
- 上下文注入(根据位置确定 Stream/Topic)
|
||||
- 空间过滤(获取指定地图的所有 Socket)
|
||||
|
||||
### 3. Zulip Client Pool (`zulip-client-pool.service.ts`)
|
||||
|
||||
Zulip 客户端池,为每个用户维护专用的 Zulip 客户端实例。
|
||||
|
||||
**主要功能:**
|
||||
- API Key 管理
|
||||
- 事件队列注册
|
||||
- 消息发送/接收
|
||||
- 客户端生命周期管理
|
||||
|
||||
### 4. Message Filter (`message-filter.service.ts`)
|
||||
|
||||
消息过滤器,实施内容审核和频率控制。
|
||||
|
||||
**主要功能:**
|
||||
- 敏感词过滤
|
||||
- 频率限制(默认 10 条/分钟)
|
||||
- 消息长度限制(默认 1000 字符)
|
||||
- 重复内容检测
|
||||
- 权限验证
|
||||
|
||||
### 5. Config Manager (`config-manager.service.ts`)
|
||||
|
||||
配置管理器,管理地图映射配置和系统参数。
|
||||
|
||||
**主要功能:**
|
||||
- 地图到 Stream 的映射
|
||||
- 交互对象到 Topic 的映射
|
||||
- 配置热重载
|
||||
- 配置验证
|
||||
|
||||
### 6. Stream Initializer Service (`stream-initializer.service.ts`)
|
||||
|
||||
Stream 初始化服务,在系统启动时自动检查并创建缺失的 Zulip Streams。
|
||||
|
||||
**主要功能:**
|
||||
- 启动时自动检查所有地图对应的 Streams
|
||||
- 自动创建缺失的 Streams
|
||||
- 使用 Bot API Key 或管理员账号创建 Streams
|
||||
- 记录初始化结果和错误
|
||||
|
||||
**权限说明:**
|
||||
- Bot 账号可能缺少创建 Stream 的权限
|
||||
- 建议使用管理员账号手动创建 Streams
|
||||
- 或在 Zulip 服务器中为 Bot 授予相应权限
|
||||
|
||||
### 7. Monitoring Service (`monitoring.service.ts`)
|
||||
|
||||
监控服务,提供系统健康检查和指标收集。
|
||||
|
||||
**主要功能:**
|
||||
- 连接指标监控
|
||||
- 消息指标监控
|
||||
- 系统健康检查
|
||||
- 告警通知
|
||||
|
||||
## 消息协议
|
||||
|
||||
### 客户端发送格式
|
||||
|
||||
#### 登录消息
|
||||
```json
|
||||
{
|
||||
"type": "login",
|
||||
"token": "user_game_token"
|
||||
}
|
||||
```
|
||||
|
||||
#### 聊天消息
|
||||
```json
|
||||
{
|
||||
"t": "chat",
|
||||
"content": "Hello",
|
||||
"scope": "local"
|
||||
}
|
||||
```
|
||||
|
||||
#### 位置更新
|
||||
```json
|
||||
{
|
||||
"t": "position",
|
||||
"x": 100,
|
||||
"y": 200,
|
||||
"mapId": "novice_village"
|
||||
}
|
||||
```
|
||||
|
||||
### 客户端接收格式
|
||||
|
||||
#### 聊天渲染消息
|
||||
```json
|
||||
{
|
||||
"t": "chat_render",
|
||||
"from": "User_B",
|
||||
"txt": "Hi",
|
||||
"bubble": true
|
||||
}
|
||||
```
|
||||
|
||||
#### 登录确认
|
||||
```json
|
||||
{
|
||||
"t": "login_success",
|
||||
"sessionId": "session_123",
|
||||
"currentMap": "novice_village"
|
||||
}
|
||||
```
|
||||
|
||||
#### 错误消息
|
||||
```json
|
||||
{
|
||||
"t": "error",
|
||||
"code": "RATE_LIMIT",
|
||||
"message": "消息发送过于频繁,请稍后再试"
|
||||
}
|
||||
```
|
||||
|
||||
## 配置说明
|
||||
|
||||
### 环境变量配置
|
||||
|
||||
```bash
|
||||
# Zulip 服务器配置
|
||||
ZULIP_SERVER_URL=https://your-zulip-server.com
|
||||
ZULIP_BOT_EMAIL=bot@your-zulip-server.com
|
||||
ZULIP_BOT_API_KEY=your-bot-api-key
|
||||
|
||||
# WebSocket 配置
|
||||
WEBSOCKET_PORT=3001
|
||||
WEBSOCKET_NAMESPACE=/game
|
||||
|
||||
# 消息配置
|
||||
MESSAGE_RATE_LIMIT=10 # 消息频率限制(条/分钟)
|
||||
MESSAGE_MAX_LENGTH=1000 # 消息最大长度
|
||||
|
||||
# 会话配置
|
||||
SESSION_TIMEOUT=30 # 会话超时时间(分钟)
|
||||
CLEANUP_INTERVAL=5 # 清理间隔(分钟)
|
||||
```
|
||||
|
||||
### Stream 初始化
|
||||
|
||||
系统在启动时会自动检查并尝试创建缺失的 Zulip Streams。
|
||||
|
||||
**注意事项:**
|
||||
|
||||
- Bot 账号可能缺少创建 Stream 的权限
|
||||
- 建议使用管理员账号预先创建所有 Streams
|
||||
- 或在 Zulip 服务器中为 Bot 授予 "Create streams" 权限
|
||||
|
||||
**手动创建 Streams:**
|
||||
|
||||
```bash
|
||||
# 使用测试脚本创建所有地图区域的 Streams
|
||||
node test-stream-initialization.js
|
||||
```
|
||||
|
||||
详细配置说明请参考 [配置管理指南](./configuration.md)。
|
||||
|
||||
### 地图映射配置
|
||||
|
||||
配置文件位置: `config/zulip/map-config.json`
|
||||
|
||||
系统支持 9 个地图区域,每个区域对应一个 Zulip Stream:
|
||||
|
||||
1. **鲸之港 (Whale Port)** - 中心城区,默认出生点
|
||||
2. **南瓜谷 (Pumpkin Valley)** - 新手学习区
|
||||
3. **Offer 城 (Offer City)** - 职业发展区
|
||||
4. **模型工厂 (Model Factory)** - AI/代码构建区
|
||||
5. **内核岛 (Kernel Island)** - 核心技术研究区
|
||||
6. **摸鱼海滩 (Moyu Beach)** - 休闲娱乐区
|
||||
7. **天梯峰 (Ladder Peak)** - 挑战竞赛区
|
||||
8. **星河湾 (Galaxy Bay)** - 创意设计区
|
||||
9. **数据遗迹 (Data Ruins)** - 数据库归档区
|
||||
|
||||
配置示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"description": "基于像素大地图的 Zulip 映射配置",
|
||||
"maps": [
|
||||
{
|
||||
"mapId": "whale_port",
|
||||
"mapName": "鲸之港",
|
||||
"zulipStream": "Whale Port",
|
||||
"description": "中心城区,交通枢纽与主要聚会点",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "whale_statue",
|
||||
"objectName": "鲸鱼雕像",
|
||||
"zulipTopic": "Announcements",
|
||||
"position": { "x": 600, "y": 400 }
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## 数据流程
|
||||
|
||||
### 发送消息流程 (游戏 → Zulip)
|
||||
|
||||
1. 玩家在游戏中输入消息
|
||||
2. Godot 客户端通过 WebSocket 发送 `chat` 消息
|
||||
3. WebSocket Gateway 接收消息
|
||||
4. Session Manager 获取玩家当前位置
|
||||
5. 上下文注入:根据位置确定目标 Stream/Topic
|
||||
6. Message Filter 进行内容过滤和频率检查
|
||||
7. Zulip Client Pool 使用用户的 API Key 发送消息到 Zulip
|
||||
8. 返回发送确认给客户端
|
||||
|
||||
### 接收消息流程 (Zulip → 游戏)
|
||||
|
||||
1. Zulip 服务器推送消息事件到 Event Queue
|
||||
2. Zulip Event Processor 接收并处理事件
|
||||
3. Session Manager 进行空间过滤,确定目标玩家
|
||||
4. 消息转换为游戏协议格式
|
||||
5. WebSocket Gateway 推送 `chat_render` 消息给目标客户端
|
||||
6. Godot 客户端显示聊天气泡
|
||||
|
||||
## 错误处理
|
||||
|
||||
### 错误码说明
|
||||
|
||||
| 错误码 | 说明 | 处理建议 |
|
||||
|-------|------|---------|
|
||||
| `AUTH_FAILED` | 认证失败 | 检查 Token 有效性 |
|
||||
| `RATE_LIMIT` | 频率限制 | 等待后重试 |
|
||||
| `CONTENT_FILTERED` | 内容被过滤 | 修改消息内容 |
|
||||
| `PERMISSION_DENIED` | 权限不足 | 检查用户权限 |
|
||||
| `ZULIP_ERROR` | Zulip 服务错误 | 系统自动重试 |
|
||||
| `SESSION_EXPIRED` | 会话过期 | 重新登录 |
|
||||
|
||||
### 降级策略
|
||||
|
||||
当 Zulip 服务不可用时,系统会自动切换到本地聊天模式:
|
||||
- 消息仅在游戏内传播
|
||||
- 不同步到 Zulip
|
||||
- 服务恢复后自动切换回正常模式
|
||||
|
||||
## 安全机制
|
||||
|
||||
### API Key 安全
|
||||
|
||||
- API Key 加密存储在数据库中
|
||||
- 永不下发到客户端
|
||||
- 支持强制刷新机制
|
||||
|
||||
### 消息安全
|
||||
|
||||
- 敏感词过滤
|
||||
- 频率限制防刷屏
|
||||
- 位置验证防欺诈
|
||||
- 消息长度限制
|
||||
|
||||
### 连接安全
|
||||
|
||||
- Token 验证
|
||||
- 会话超时自动断开
|
||||
- 异常连接检测和拒绝
|
||||
|
||||
## 监控指标
|
||||
|
||||
### 连接指标
|
||||
- `zulip.connections.active`: 活跃连接数
|
||||
- `zulip.connections.total`: 总连接数
|
||||
- `zulip.connections.errors`: 连接错误数
|
||||
|
||||
### 消息指标
|
||||
- `zulip.messages.sent`: 发送消息数
|
||||
- `zulip.messages.received`: 接收消息数
|
||||
- `zulip.messages.filtered`: 被过滤消息数
|
||||
- `zulip.messages.latency`: 消息延迟
|
||||
|
||||
### 系统指标
|
||||
- `zulip.sessions.active`: 活跃会话数
|
||||
- `zulip.zulip_clients.active`: 活跃 Zulip 客户端数
|
||||
- `zulip.event_queues.active`: 活跃事件队列数
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [zulip-js 库使用指南](./zulip-js.md)
|
||||
- [API 接口文档](./api.md)
|
||||
- [WebSocket 协议详解](./websocket-protocol.md)
|
||||
- [配置管理指南](./configuration.md)
|
||||
|
||||
## 更新日志
|
||||
|
||||
### v1.1.0 (2026-01-06)
|
||||
- **修复 JWT Token 验证和 API Key 管理**
|
||||
- 修复 `LoginService.generateTokenPair()` 的 JWT 签名冲突问题
|
||||
- `ZulipService` 现在复用 `LoginService.verifyToken()` 进行 Token 验证
|
||||
- 修复消息发送时使用错误的硬编码 API Key 问题
|
||||
- 现在正确从 Redis 读取用户注册时存储的真实 API Key
|
||||
- 添加 `AuthModule` 到 `ZulipModule` 的依赖注入
|
||||
- 消息发送功能现已完全正常工作 ✅
|
||||
|
||||
### v1.0.1 (2025-12-25)
|
||||
- 更新地图配置为 9 区域系统
|
||||
- 添加 Stream Initializer Service 自动初始化服务
|
||||
- 更新默认出生点为鲸之港 (Whale Port)
|
||||
- 添加地图区域描述字段
|
||||
- 修复上下文注入使用 ConfigManager
|
||||
- 改进错误处理和日志记录
|
||||
|
||||
### v1.0.0 (2025-12-25)
|
||||
- 初始版本发布
|
||||
- 实现 WebSocket Gateway 统一网关
|
||||
- 实现 Session Manager 会话管理
|
||||
- 实现 Zulip Client Pool 客户端池
|
||||
- 实现 Message Filter 消息过滤
|
||||
- 实现 Config Manager 配置管理
|
||||
- 实现 Monitoring Service 监控服务
|
||||
- 完成集成测试覆盖
|
||||
254
docs/systems/zulip/ZULIP_INTEGRATION_SUMMARY.md
Normal file
254
docs/systems/zulip/ZULIP_INTEGRATION_SUMMARY.md
Normal file
@@ -0,0 +1,254 @@
|
||||
# Zulip集成系统测试总结
|
||||
|
||||
## 测试日期
|
||||
2025-12-25
|
||||
|
||||
## 测试环境
|
||||
|
||||
### Zulip服务器配置
|
||||
|
||||
- **服务器URL**: <https://zulip.xinghangee.icu/>
|
||||
- **Bot邮箱**: <cbot-bot@zulip.xinghangee.icu>
|
||||
- **Bot API Key**: 3k61GqxVkc...x3F3STksF (已配置在.env)
|
||||
|
||||
### 测试用户配置
|
||||
|
||||
- **用户API Key**: W2KhXaQxJ...0c9nPXaalh5
|
||||
- **Zulip用户邮箱**: <user8@zulip.xinghangee.icu>
|
||||
- **用户全名**: ANGJustinl
|
||||
- **用户ID**: 8
|
||||
- **权限**: 管理员
|
||||
|
||||
## 测试结果
|
||||
|
||||
### ✅ 1. API Key验证测试
|
||||
|
||||
**测试脚本**: `test-api-key-validation.js`
|
||||
|
||||
**结果**: 通过
|
||||
|
||||
- API Key验证成功
|
||||
- 用户信息获取正常
|
||||
- 用户邮箱: <user8@zulip.xinghangee.icu>
|
||||
- 用户全名: ANGJustinl
|
||||
|
||||
### ✅ 2. Stream管理测试
|
||||
|
||||
**测试脚本**: `test-list-subscriptions.js`, `test-subscribe-stream.js`
|
||||
|
||||
**结果**: 通过
|
||||
|
||||
- 成功列出用户订阅的Streams (Zulip, general, 沙箱)
|
||||
- 成功创建"Novice Village" Stream
|
||||
- 成功订阅新创建的Stream
|
||||
- 测试消息发送成功 (Message ID: 17, 19)
|
||||
|
||||
### ✅ 3. Zulip客户端创建测试
|
||||
|
||||
**测试方法**: 服务器日志验证
|
||||
|
||||
**结果**: 通过
|
||||
|
||||
- Zulip客户端创建成功
|
||||
- 事件队列注册成功 (Queue ID: 9b7c31ed-29a5-4419-b482-2fe549e26cc4)
|
||||
- 客户端生命周期管理正常
|
||||
- 客户端销毁和清理正常
|
||||
|
||||
### ✅ 4. 端到端集成测试
|
||||
|
||||
**测试脚本**: `test-user-api-key.js`
|
||||
|
||||
**结果**: 通过
|
||||
|
||||
- WebSocket连接成功
|
||||
- 登录流程正常
|
||||
- 会话ID生成正常
|
||||
- 用户ID: user_W2KhXaQx
|
||||
- 用户名: Player_W2KhX
|
||||
- 当前地图: whale_port (更新后)
|
||||
- 消息发送成功
|
||||
- Message ID: 20-25, 51-52
|
||||
- 所有消息成功发送到Zulip服务器
|
||||
- 支持多地图消息路由 (Whale Port, Pumpkin Valley)
|
||||
- 目标Topic: General
|
||||
|
||||
### ✅ 5. 单元测试和集成测试
|
||||
|
||||
**测试套件**: `src/business/zulip/zulip-integration.e2e.spec.ts`
|
||||
|
||||
**结果**: 22/22 通过
|
||||
|
||||
- WebSocket连接和会话管理 ✓
|
||||
- Zulip客户端生命周期管理 ✓
|
||||
- 消息路由和权限验证 ✓
|
||||
- 消息格式转换完整性 ✓
|
||||
- 消息接收和分发 ✓
|
||||
- 会话状态一致性 ✓
|
||||
- 内容安全和频率控制 ✓
|
||||
- API Key安全存储 ✓
|
||||
- 错误处理和服务降级 ✓
|
||||
- 操作确认和日志记录 ✓
|
||||
- 系统监控和告警 ✓
|
||||
- 配置验证 ✓
|
||||
|
||||
### ✅ 6. Stream初始化测试
|
||||
|
||||
**测试脚本**: `test-stream-initialization.js`
|
||||
|
||||
**结果**: 部分通过
|
||||
|
||||
- Stream 初始化服务正常启动
|
||||
- 成功检测缺失的 Streams
|
||||
- Bot 账号权限不足,无法自动创建 Streams
|
||||
- 使用管理员账号手动创建 Streams 成功
|
||||
- 所有 9 个地图区域的 Streams 已创建
|
||||
|
||||
### ✅ 7. 多地图消息路由测试
|
||||
|
||||
**测试脚本**: `test-user-api-key.js` (更新版)
|
||||
|
||||
**结果**: 通过
|
||||
|
||||
- 成功在 Whale Port 发送消息 (Message ID: 51)
|
||||
- 成功切换到 Pumpkin Valley
|
||||
- 成功在 Pumpkin Valley 发送消息 (Message ID: 52)
|
||||
- 上下文注入正确使用 ConfigManager
|
||||
- 消息路由到正确的 Stream
|
||||
|
||||
## 关键发现
|
||||
|
||||
### 1. API Key和用户邮箱映射
|
||||
|
||||
- 用户API Key对应的Zulip邮箱是 `user8@zulip.xinghangee.icu`
|
||||
- 不是 `cbot-bot@zulip.xinghangee.icu`
|
||||
- 已在代码中修正 (`src/business/zulip/zulip.service.ts`)
|
||||
|
||||
### 2. Stream创建和权限
|
||||
|
||||
- Bot 账号 (cbot-bot) 缺少创建 Stream 的权限
|
||||
- 需要使用管理员账号手动创建 Streams
|
||||
- 或在 Zulip 服务器中为 Bot 授予 Stream 创建权限
|
||||
- 已使用管理员账号成功创建所有 9 个地图区域的 Streams
|
||||
|
||||
### 3. 地图配置更新
|
||||
|
||||
- 系统从 2 个地图区域扩展到 9 个地图区域
|
||||
- 默认出生点从 `novice_village` 更改为 `whale_port`
|
||||
- 添加了地图区域描述字段 (`description`)
|
||||
- 配置版本从 1.0.0 升级到 2.0.0
|
||||
|
||||
### 4. 消息路由改进
|
||||
|
||||
- 修复了 SessionManager 使用硬编码 Stream 映射的问题
|
||||
- 现在使用 ConfigManager 动态获取 Stream 映射
|
||||
- 支持多地图消息路由,消息自动发送到玩家当前地图对应的 Stream
|
||||
- 已验证 Whale Port 和 Pumpkin Valley 的消息路由正常
|
||||
|
||||
### 5. 消息发送验证
|
||||
|
||||
- 所有消息都成功发送到Zulip服务器
|
||||
- 返回真实的Message ID (20-25, 51-52)
|
||||
- 可以在Zulip网页界面查看消息
|
||||
- 支持跨地图消息发送
|
||||
|
||||
## 系统状态
|
||||
|
||||
### ✅ 核心功能
|
||||
|
||||
- [x] WebSocket连接管理
|
||||
- [x] 用户登录和会话管理
|
||||
- [x] Zulip客户端创建和管理
|
||||
- [x] 事件队列注册和管理
|
||||
- [x] 消息发送到Zulip
|
||||
- [x] 消息格式转换
|
||||
- [x] 多地图消息路由
|
||||
- [x] Stream 自动初始化检查
|
||||
- [x] 错误处理和降级
|
||||
- [x] 日志记录和监控
|
||||
|
||||
### ✅ 配置管理
|
||||
|
||||
- [x] 环境变量配置
|
||||
- [x] 9 区域地图映射配置
|
||||
- [x] API Key安全存储
|
||||
- [x] 配置验证
|
||||
- [x] 动态 Stream 映射
|
||||
|
||||
### ✅ 测试覆盖
|
||||
|
||||
- [x] 单元测试 (22个测试用例)
|
||||
- [x] 集成测试 (端到端流程)
|
||||
- [x] 真实Zulip服务器测试
|
||||
- [x] 多地图消息路由测试
|
||||
- [x] Stream 初始化测试
|
||||
- [x] 错误场景测试
|
||||
|
||||
# !!!stream-initializer.service.ts - 404行处仍有todo需要完成, 现在没前端我搞不清楚咋做:(
|
||||
|
||||
## 下一步建议
|
||||
|
||||
### 1. Stream 权限配置
|
||||
|
||||
- [ ] 在 Zulip 服务器中为 Bot 账号授予创建 Stream 的权限
|
||||
- [ ] 或使用管理员账号预先创建所有 Streams
|
||||
- [ ] 验证所有 9 个地图区域的 Streams 已创建
|
||||
|
||||
### 2. 生产环境准备
|
||||
|
||||
- [ ] 配置生产环境的Zulip服务器
|
||||
- [ ] 设置API Key加密密钥 (ZULIP_API_KEY_ENCRYPTION_KEY)
|
||||
- [ ] 配置邮件服务用于通知
|
||||
- [ ] 设置监控和告警
|
||||
- [ ] 配置所有地图区域的 Streams
|
||||
|
||||
### 3. 功能增强
|
||||
|
||||
- [ ] 实现从Zulip接收消息的事件轮询
|
||||
- [ ] 实现双向消息同步
|
||||
- [ ] 实现用户权限管理
|
||||
- [ ] 添加地图切换动画和提示
|
||||
- [ ] 实现跨地图私聊功能
|
||||
|
||||
### 4. 性能优化
|
||||
|
||||
- [ ] 优化客户端池管理
|
||||
- [ ] 实现消息批量发送
|
||||
- [ ] 添加消息缓存机制
|
||||
- [ ] 优化事件队列轮询频率
|
||||
- [ ] 实现 Stream 订阅缓存
|
||||
|
||||
### 5. 文档完善
|
||||
|
||||
- [x] 系统架构文档
|
||||
- [x] API文档
|
||||
- [x] WebSocket协议文档
|
||||
- [x] 配置文档 (已更新 9 区域配置)
|
||||
- [x] Stream 初始化文档
|
||||
- [ ] 部署文档
|
||||
- [ ] 运维手册
|
||||
|
||||
## 结论
|
||||
|
||||
Zulip集成系统已成功完成开发和测试,所有核心功能正常工作。系统已通过:
|
||||
|
||||
- 22个单元测试和集成测试
|
||||
- 真实Zulip服务器的端到端测试
|
||||
- 多地图消息路由验证
|
||||
- Stream 初始化服务测试
|
||||
- 消息发送和接收验证
|
||||
|
||||
**最新更新 (v2.0.0):**
|
||||
|
||||
- 地图配置从 2 个区域扩展到 9 个区域
|
||||
- 实现 Stream 自动初始化检查服务
|
||||
- 修复上下文注入使用动态配置
|
||||
- 改进错误处理和日志记录
|
||||
- 更新默认出生点为鲸之港
|
||||
|
||||
系统已准备好进入下一阶段的开发和部署。建议优先配置 Stream 创建权限或手动创建所有地图区域的 Streams。
|
||||
|
||||
---
|
||||
|
||||
**测试人员**: ANGJustinl
|
||||
**审核状态**: 待确认
|
||||
**文档版本**: 1.0.0
|
||||
285
docs/systems/zulip/api.md
Normal file
285
docs/systems/zulip/api.md
Normal file
@@ -0,0 +1,285 @@
|
||||
# Zulip 集成系统 API 文档
|
||||
|
||||
## WebSocket 连接
|
||||
|
||||
### 连接地址
|
||||
|
||||
```
|
||||
wss://localhost:3000/game
|
||||
```
|
||||
|
||||
### 连接参数
|
||||
|
||||
连接时无需额外参数,认证通过 `login` 消息完成。
|
||||
|
||||
## 消息类型
|
||||
|
||||
### 1. 登录 (login)
|
||||
|
||||
**请求:**
|
||||
```json
|
||||
{
|
||||
"type": "login",
|
||||
"token": "user_game_token"
|
||||
}
|
||||
```
|
||||
|
||||
**成功响应:**
|
||||
```json
|
||||
{
|
||||
"t": "login_success",
|
||||
"sessionId": "session_abc123",
|
||||
"currentMap": "novice_village",
|
||||
"username": "player_name"
|
||||
}
|
||||
```
|
||||
|
||||
**失败响应:**
|
||||
```json
|
||||
{
|
||||
"t": "error",
|
||||
"code": "AUTH_FAILED",
|
||||
"message": "Token 验证失败"
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 发送聊天消息 (chat)
|
||||
|
||||
**请求:**
|
||||
```json
|
||||
{
|
||||
"t": "chat",
|
||||
"content": "Hello, world!",
|
||||
"scope": "local"
|
||||
}
|
||||
```
|
||||
|
||||
**参数说明:**
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| t | string | 是 | 固定值 "chat" |
|
||||
| content | string | 是 | 消息内容,最大 1000 字符 |
|
||||
| scope | string | 是 | 消息范围: "local" 或具体 topic 名称 |
|
||||
|
||||
**成功响应:**
|
||||
```json
|
||||
{
|
||||
"t": "chat_sent",
|
||||
"messageId": "msg_123",
|
||||
"timestamp": 1703500800000
|
||||
}
|
||||
```
|
||||
|
||||
**失败响应:**
|
||||
```json
|
||||
{
|
||||
"t": "error",
|
||||
"code": "RATE_LIMIT",
|
||||
"message": "消息发送过于频繁,请稍后再试"
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 接收聊天消息 (chat_render)
|
||||
|
||||
**服务器推送:**
|
||||
```json
|
||||
{
|
||||
"t": "chat_render",
|
||||
"from": "other_player",
|
||||
"txt": "Hi there!",
|
||||
"bubble": true,
|
||||
"timestamp": 1703500800000
|
||||
}
|
||||
```
|
||||
|
||||
**参数说明:**
|
||||
| 参数 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| t | string | 固定值 "chat_render" |
|
||||
| from | string | 发送者名称 |
|
||||
| txt | string | 消息内容 |
|
||||
| bubble | boolean | 是否显示气泡 |
|
||||
| timestamp | number | 消息时间戳 |
|
||||
|
||||
### 4. 位置更新 (position_update)
|
||||
|
||||
**请求:**
|
||||
```json
|
||||
{
|
||||
"t": "position",
|
||||
"x": 150,
|
||||
"y": 200,
|
||||
"mapId": "novice_village"
|
||||
}
|
||||
```
|
||||
|
||||
**参数说明:**
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| t | string | 是 | 固定值 "position" |
|
||||
| x | number | 是 | X 坐标 |
|
||||
| y | number | 是 | Y 坐标 |
|
||||
| mapId | string | 是 | 地图 ID |
|
||||
|
||||
**响应:**
|
||||
```json
|
||||
{
|
||||
"t": "position_updated",
|
||||
"stream": "Novice Village",
|
||||
"topic": "General"
|
||||
}
|
||||
```
|
||||
|
||||
### 5. 登出 (logout)
|
||||
|
||||
**请求:**
|
||||
```json
|
||||
{
|
||||
"type": "logout"
|
||||
}
|
||||
```
|
||||
|
||||
**响应:**
|
||||
```json
|
||||
{
|
||||
"t": "logout_success"
|
||||
}
|
||||
```
|
||||
|
||||
## 错误码
|
||||
|
||||
| 错误码 | HTTP 等效 | 说明 | 处理建议 |
|
||||
|-------|----------|------|---------|
|
||||
| `AUTH_FAILED` | 401 | 认证失败,Token 无效或过期 | 重新获取 Token 并登录 |
|
||||
| `RATE_LIMIT` | 429 | 消息发送频率超限 | 等待 60 秒后重试 |
|
||||
| `CONTENT_FILTERED` | 400 | 消息内容被过滤 | 修改消息内容后重试 |
|
||||
| `CONTENT_TOO_LONG` | 400 | 消息内容超长 | 缩短消息长度 |
|
||||
| `PERMISSION_DENIED` | 403 | 权限不足 | 检查用户权配置 |
|
||||
| `SESSION_EXPIRED` | 401 | 会话已过期 | 重新登录 |
|
||||
| `SESSION_NOT_FOUND` | 404 | 会话不存在 | 重新登录 |
|
||||
| `ZULIP_ERROR` | 502 | Zulip 服务错误 | 系统自动重试,无需处理 |
|
||||
| `INTERNAL_ERROR` | 500 | 内部服务器错误 | 联系管理员 |
|
||||
|
||||
## 频率限制
|
||||
|
||||
### 消息发送限制
|
||||
|
||||
- 默认限制: 10 条/分钟
|
||||
- 超限后返回 `RATE_LIMIT` 错误
|
||||
- 限制窗口: 滑动窗口,60 秒
|
||||
|
||||
### 连接限制
|
||||
|
||||
- 单用户最大连接数: 3
|
||||
- 超限后新连接被拒绝
|
||||
|
||||
## 消息过滤规则
|
||||
|
||||
### 内容过滤
|
||||
|
||||
1. **敏感词过滤**: 包含敏感词的消息将被拒绝
|
||||
2. **长度限制**: 消息最大 1000 字符
|
||||
3. **重复检测**: 连续发送相同内容将被拒绝
|
||||
|
||||
### 权限验证
|
||||
|
||||
1. **位置验证**: 只能向当前所在地图对应的 Stream 发送消息
|
||||
2. **Stream 权限**: 只能访问配置中允许的 Stream
|
||||
|
||||
## 示例代码
|
||||
|
||||
### JavaScript/TypeScript
|
||||
|
||||
```typescript
|
||||
// 连接 WebSocket
|
||||
const socket = new WebSocket('ws://localhost:3000/game');
|
||||
|
||||
// 连接成功
|
||||
socket.onopen = () => {
|
||||
// 发送登录消息
|
||||
socket.send(JSON.stringify({
|
||||
type: 'login',
|
||||
token: 'your_game_token'
|
||||
}));
|
||||
};
|
||||
|
||||
// 接收消息
|
||||
socket.onmessage = (event) => {
|
||||
const data = JSON.parse(event.data);
|
||||
|
||||
switch (data.t) {
|
||||
case 'login_success':
|
||||
console.log('登录成功:', data.sessionId);
|
||||
break;
|
||||
case 'chat_render':
|
||||
console.log(`${data.from}: ${data.txt}`);
|
||||
break;
|
||||
case 'error':
|
||||
console.error(`错误 [${data.code}]: ${data.message}`);
|
||||
break;
|
||||
}
|
||||
};
|
||||
|
||||
// 发送聊天消息
|
||||
function sendChat(content: string) {
|
||||
socket.send(JSON.stringify({
|
||||
t: 'chat',
|
||||
content: content,
|
||||
scope: 'local'
|
||||
}));
|
||||
}
|
||||
|
||||
// 更新位置
|
||||
function updatePosition(x: number, y: number, mapId: string) {
|
||||
socket.send(JSON.stringify({
|
||||
t: 'position',
|
||||
x: x,
|
||||
y: y,
|
||||
mapId: mapId
|
||||
}));
|
||||
}
|
||||
```
|
||||
|
||||
## 健康检查接口
|
||||
|
||||
### GET /health
|
||||
|
||||
检查系统健康状态。
|
||||
|
||||
**响应:**
|
||||
```json
|
||||
{
|
||||
"status": "healthy",
|
||||
"components": {
|
||||
"websocket": "healthy",
|
||||
"zulip": "healthy",
|
||||
"redis": "healthy"
|
||||
},
|
||||
"metrics": {
|
||||
"activeConnections": 42,
|
||||
"activeSessions": 40,
|
||||
"messagesSentLastMinute": 156
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### GET /metrics
|
||||
|
||||
获取系统指标(Prometheus 格式)。
|
||||
|
||||
**响应:**
|
||||
```
|
||||
# HELP zulip_connections_active Active WebSocket connections
|
||||
# TYPE zulip_connections_active gauge
|
||||
zulip_connections_active 42
|
||||
|
||||
# HELP zulip_messages_sent_total Total messages sent
|
||||
# TYPE zulip_messages_sent_total counter
|
||||
zulip_messages_sent_total 15678
|
||||
|
||||
# HELP zulip_message_latency_seconds Message processing latency
|
||||
# TYPE zulip_message_latency_seconds histogram
|
||||
zulip_message_latency_seconds_bucket{le="0.1"} 14500
|
||||
zulip_message_latency_seconds_bucket{le="0.5"} 15600
|
||||
zulip_message_latency_seconds_bucket{le="1"} 15678
|
||||
```
|
||||
516
docs/systems/zulip/configuration.md
Normal file
516
docs/systems/zulip/configuration.md
Normal file
@@ -0,0 +1,516 @@
|
||||
# 配置管理指南
|
||||
|
||||
## 概述
|
||||
|
||||
Zulip 集成系统支持多种配置方式,包括环境变量、配置文件和运行时配置。本文档详细说明各配置项的用途和设置方法。
|
||||
|
||||
## 环境变量配置
|
||||
|
||||
### Zulip 服务器配置
|
||||
|
||||
```bash
|
||||
# Zulip 服务器 URL
|
||||
ZULIP_SERVER_URL=https://zulip.xinghangee.icu/
|
||||
|
||||
# Zulip Bot 邮箱
|
||||
ZULIP_BOT_EMAIL=cbot-bot@zulip.xinghangee.icu
|
||||
|
||||
# Zulip Bot API Key
|
||||
ZULIP_BOT_API_KEY=your-bot-api-key
|
||||
|
||||
# Zulip Realm (可选,默认从 URL 推断)
|
||||
ZULIP_REALM=your-realm
|
||||
```
|
||||
|
||||
### WebSocket 配置
|
||||
|
||||
```bash
|
||||
# WebSocket 端口
|
||||
WEBSOCKET_PORT=3000
|
||||
|
||||
# WebSocket 命名空间
|
||||
WEBSOCKET_NAMESPACE=/game
|
||||
|
||||
# 最大连接数
|
||||
WEBSOCKET_MAX_CONNECTIONS=100
|
||||
|
||||
# 连接超时时间 (毫秒)
|
||||
WEBSOCKET_TIMEOUT=60000
|
||||
```
|
||||
|
||||
### 消息配置
|
||||
|
||||
```bash
|
||||
# 消息频率限制 (条/分钟)
|
||||
MESSAGE_RATE_LIMIT=10
|
||||
|
||||
# 消息最大长度 (字符)
|
||||
MESSAGE_MAX_LENGTH=1000
|
||||
|
||||
# 是否启用内容过滤
|
||||
ENABLE_CONTENT_FILTER=true
|
||||
|
||||
# 是否启用重复检测
|
||||
ENABLE_DUPLICATE_DETECTION=true
|
||||
```
|
||||
|
||||
### 会话配置
|
||||
|
||||
```bash
|
||||
# 会话超时时间 (分钟)
|
||||
SESSION_TIMEOUT=30
|
||||
|
||||
# 会话清理间隔 (分钟)
|
||||
SESSION_CLEANUP_INTERVAL=5
|
||||
|
||||
# 最大会话数
|
||||
MAX_SESSIONS=5000
|
||||
```
|
||||
|
||||
### Redis 配置
|
||||
|
||||
```bash
|
||||
# Redis 主机
|
||||
REDIS_HOST=localhost
|
||||
|
||||
# Redis 端口
|
||||
REDIS_PORT=6379
|
||||
|
||||
# Redis 密码 (可选)
|
||||
REDIS_PASSWORD=
|
||||
|
||||
# Redis 数据库索引
|
||||
REDIS_DB=0
|
||||
|
||||
# Redis 键前缀
|
||||
REDIS_KEY_PREFIX=zulip:
|
||||
```
|
||||
|
||||
### 日志配置
|
||||
|
||||
```bash
|
||||
# 日志级别 (debug, info, warn, error)
|
||||
LOG_LEVEL=info
|
||||
|
||||
# 是否启用结构化日志
|
||||
LOG_STRUCTURED=true
|
||||
|
||||
# 日志文件路径 (可选)
|
||||
LOG_FILE_PATH=logs/zulip.log
|
||||
```
|
||||
|
||||
## 配置文件
|
||||
|
||||
### 地图映射配置
|
||||
|
||||
文件位置: `config/zulip/map-config.json`
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"lastModified": "2025-12-25T20:00:00.000Z",
|
||||
"description": "基于像素大地图的 Zulip 映射配置",
|
||||
"maps": [
|
||||
{
|
||||
"mapId": "whale_port",
|
||||
"mapName": "鲸之港",
|
||||
"zulipStream": "Whale Port",
|
||||
"description": "中心城区,交通枢纽与主要聚会点",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "whale_statue",
|
||||
"objectName": "鲸鱼雕像",
|
||||
"zulipTopic": "Announcements",
|
||||
"position": { "x": 600, "y": 400 }
|
||||
},
|
||||
{
|
||||
"objectId": "clock_tower",
|
||||
"objectName": "大本钟",
|
||||
"zulipTopic": "General Chat",
|
||||
"position": { "x": 550, "y": 350 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "pumpkin_valley",
|
||||
"mapName": "南瓜谷",
|
||||
"zulipStream": "Pumpkin Valley",
|
||||
"description": "新手成长、基础资源与学习社区",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "pumpkin_patch",
|
||||
"objectName": "南瓜田",
|
||||
"zulipTopic": "Tutorials",
|
||||
"position": { "x": 150, "y": 400 }
|
||||
},
|
||||
{
|
||||
"objectId": "farm_house",
|
||||
"objectName": "农舍",
|
||||
"zulipTopic": "Study Group",
|
||||
"position": { "x": 200, "y": 450 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "offer_city",
|
||||
"mapName": "Offer 城",
|
||||
"zulipStream": "Offer City",
|
||||
"description": "职业发展、面试与商务区",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "skyscrapers",
|
||||
"objectName": "摩天大楼",
|
||||
"zulipTopic": "Career Talk",
|
||||
"position": { "x": 350, "y": 650 }
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"mapId": "model_factory",
|
||||
"mapName": "模型工厂",
|
||||
"zulipStream": "Model Factory",
|
||||
"description": "AI模型训练、代码构建与工业区",
|
||||
"interactionObjects": [
|
||||
{
|
||||
"objectId": "assembly_line",
|
||||
"objectName": "流水线",
|
||||
"zulipTopic": "Code Review",
|
||||
"position": { "x": 400, "y": 200 }
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
系统现在支持 9 个地图区域:
|
||||
|
||||
1. **鲸之港 (Whale Port)** - 中心城区,交通枢纽与主要聚会点
|
||||
2. **南瓜谷 (Pumpkin Valley)** - 新手成长、基础资源与学习社区
|
||||
3. **Offer 城 (Offer City)** - 职业发展、面试与商务区
|
||||
4. **模型工厂 (Model Factory)** - AI模型训练、代码构建与工业区
|
||||
5. **内核岛 (Kernel Island)** - 核心技术研究、底层原理与算法
|
||||
6. **摸鱼海滩 (Moyu Beach)** - 休闲娱乐、水贴与非技术话题
|
||||
7. **天梯峰 (Ladder Peak)** - 挑战、竞赛与排行榜
|
||||
8. **星河湾 (Galaxy Bay)** - 创意、设计与灵感
|
||||
9. **数据遗迹 (Data Ruins)** - 数据库、归档与历史记录
|
||||
|
||||
### 配置字段说明
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| version | string | 是 | 配置版本号 |
|
||||
| lastModified | string | 否 | 最后修改时间 (ISO 8601) |
|
||||
| description | string | 否 | 配置文件描述 |
|
||||
| maps | array | 是 | 地图配置数组 |
|
||||
| maps[].mapId | string | 是 | 地图唯一标识 |
|
||||
| maps[].mapName | string | 是 | 地图显示名称 |
|
||||
| maps[].zulipStream | string | 是 | 对应的 Zulip Stream |
|
||||
| maps[].description | string | 否 | 地图区域描述 |
|
||||
| maps[].defaultTopic | string | 否 | 默认 Topic,默认 "General" |
|
||||
| maps[].interactionObjects | array | 否 | 交互对象配置 |
|
||||
| interactionObjects[].objectId | string | 是 | 对象唯一标识 |
|
||||
| interactionObjects[].objectName | string | 是 | 对象显示名称 |
|
||||
| interactionObjects[].zulipTopic | string | 是 | 对应的 Zulip Topic |
|
||||
| interactionObjects[].position | object | 是 | 对象位置坐标 |
|
||||
| interactionObjects[].radius | number | 否 | 交互半径,默认 50 |
|
||||
|
||||
### 敏感词配置
|
||||
|
||||
文件位置: `config/zulip/sensitive-words.json`
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"words": [
|
||||
"敏感词1",
|
||||
"敏感词2"
|
||||
],
|
||||
"patterns": [
|
||||
"正则表达式1",
|
||||
"正则表达式2"
|
||||
],
|
||||
"replacements": {
|
||||
"原词": "替换词"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 允许的 Stream 配置
|
||||
|
||||
文件位置: `config/zulip/allowed-streams.json`
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"streams": [
|
||||
"Novice Village",
|
||||
"Market Square",
|
||||
"Guild Hall",
|
||||
"Arena"
|
||||
],
|
||||
"privateStreams": [
|
||||
"Admin",
|
||||
"Moderators"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## 运行时配置
|
||||
|
||||
### 通过 API 更新配置
|
||||
|
||||
```typescript
|
||||
// 更新消息频率限制
|
||||
await configManager.updateConfig('messageRateLimit', 20);
|
||||
|
||||
// 更新会话超时时间
|
||||
await configManager.updateConfig('sessionTimeout', 60);
|
||||
|
||||
// 重新加载地图配置
|
||||
await configManager.reloadMapConfig();
|
||||
```
|
||||
|
||||
### 配置热重载
|
||||
|
||||
系统支持配置热重载,无需重启服务:
|
||||
|
||||
```bash
|
||||
# 发送 SIGHUP 信号触发配置重载
|
||||
kill -HUP <pid>
|
||||
```
|
||||
|
||||
或通过 API:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3000/admin/config/reload \
|
||||
-H "Authorization: Bearer <admin_token>"
|
||||
```
|
||||
|
||||
## 配置验证
|
||||
|
||||
### 启动时验证
|
||||
|
||||
系统在启动时会验证所有配置的有效性:
|
||||
|
||||
```typescript
|
||||
// 配置验证示例
|
||||
const configValidator = new ConfigValidator();
|
||||
|
||||
// 验证环境变量
|
||||
configValidator.validateEnv({
|
||||
ZULIP_SERVER_URL: { required: true, type: 'url' },
|
||||
ZULIP_BOT_EMAIL: { required: true, type: 'email' },
|
||||
ZULIP_BOT_API_KEY: { required: true, type: 'string' },
|
||||
MESSAGE_RATE_LIMIT: { required: false, type: 'number', default: 10 },
|
||||
});
|
||||
|
||||
// 验证地图配置
|
||||
configValidator.validateMapConfig(mapConfig);
|
||||
```
|
||||
|
||||
### 验证错误处理
|
||||
|
||||
配置验证失败时,系统会:
|
||||
|
||||
1. 记录详细的错误日志
|
||||
2. 输出错误信息到控制台
|
||||
3. 阻止服务启动(严重错误)或使用默认值(非严重错误)
|
||||
|
||||
```
|
||||
[ERROR] 配置验证失败:
|
||||
- ZULIP_SERVER_URL: 必填项未设置
|
||||
- MESSAGE_RATE_LIMIT: 值必须大于 0
|
||||
- map-config.json: maps[0].zulipStream 不能为空
|
||||
```
|
||||
|
||||
## Stream 初始化
|
||||
|
||||
### 自动初始化服务
|
||||
|
||||
系统在启动时会自动检查所有地图配置中定义的 Zulip Streams 是否存在。如果发现缺失的 Streams,会尝试自动创建。
|
||||
|
||||
**服务配置:**
|
||||
|
||||
```typescript
|
||||
// Stream 初始化服务会在系统启动 5 秒后自动运行
|
||||
// 位置: src/core/zulip_core/services/stream_initializer.service.ts
|
||||
|
||||
@Injectable()
|
||||
export class StreamInitializerService implements OnModuleInit {
|
||||
async onModuleInit() {
|
||||
// 延迟 5 秒启动,确保其他服务已就绪
|
||||
setTimeout(() => {
|
||||
this.initializeStreams();
|
||||
}, 5000);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 权限要求
|
||||
|
||||
创建 Zulip Streams 需要特定权限:
|
||||
|
||||
- **Bot 账号**: 默认情况下可能缺少创建 Stream 的权限
|
||||
- **管理员账号**: 拥有完整的 Stream 创建权限
|
||||
|
||||
**解决方案:**
|
||||
|
||||
1. **方案一**: 在 Zulip 服务器中为 Bot 账号授予创建 Stream 的权限
|
||||
- 登录 Zulip 管理后台
|
||||
- 找到 Bot 账号设置
|
||||
- 授予 "Create streams" 权限
|
||||
|
||||
2. **方案二**: 使用管理员账号手动创建 Streams
|
||||
- 使用提供的测试脚本 `test-stream-initialization.js`
|
||||
- 配置管理员 API Key
|
||||
- 运行脚本自动创建所有 Streams
|
||||
|
||||
3. **方案三**: 在 Zulip 网页界面手动创建
|
||||
- 登录 Zulip 网页界面
|
||||
- 创建对应的 Streams (参考 `config/zulip/map-config.json`)
|
||||
|
||||
### 手动创建 Streams
|
||||
|
||||
使用测试脚本创建所有地图区域的 Streams:
|
||||
|
||||
```bash
|
||||
# 编辑 test-stream-initialization.js,配置管理员 API Key
|
||||
# 然后运行脚本
|
||||
node test-stream-initialization.js
|
||||
```
|
||||
|
||||
脚本会自动创建以下 Streams:
|
||||
|
||||
- Whale Port (鲸之港)
|
||||
- Pumpkin Valley (南瓜谷)
|
||||
- Offer City (Offer 城)
|
||||
- Model Factory (模型工厂)
|
||||
- Kernel Island (内核岛)
|
||||
- Moyu Beach (摸鱼海滩)
|
||||
- Ladder Peak (天梯峰)
|
||||
- Galaxy Bay (星河湾)
|
||||
- Data Ruins (数据遗迹)
|
||||
|
||||
### 初始化日志
|
||||
|
||||
系统会记录 Stream 初始化的详细日志:
|
||||
|
||||
```
|
||||
[INFO] 开始初始化 Zulip Streams...
|
||||
[INFO] 检查 Stream: Whale Port
|
||||
[INFO] Stream 已存在: Whale Port
|
||||
[WARN] Stream 不存在,尝试创建: Pumpkin Valley
|
||||
[INFO] Stream 创建成功: Pumpkin Valley
|
||||
[ERROR] Stream 创建失败: Offer City - Insufficient permission
|
||||
```
|
||||
|
||||
## 配置最佳实践
|
||||
|
||||
### 1. 使用环境变量管理敏感信息
|
||||
|
||||
```bash
|
||||
# 不要在代码中硬编码敏感信息
|
||||
# 使用环境变量或密钥管理服务
|
||||
|
||||
# 开发环境
|
||||
export ZULIP_BOT_API_KEY=dev-api-key
|
||||
|
||||
# 生产环境 (使用密钥管理服务)
|
||||
export ZULIP_BOT_API_KEY=$(aws secretsmanager get-secret-value --secret-id zulip-api-key --query SecretString --output text)
|
||||
```
|
||||
|
||||
### 2. 分环境配置
|
||||
|
||||
```
|
||||
config/
|
||||
├── zulip/
|
||||
│ ├── map-config.json # 默认配置
|
||||
│ ├── map-config.dev.json # 开发环境
|
||||
│ ├── map-config.staging.json # 预发布环境
|
||||
│ └── map-config.prod.json # 生产环境
|
||||
```
|
||||
|
||||
```typescript
|
||||
// 根据环境加载配置
|
||||
const env = process.env.NODE_ENV || 'development';
|
||||
const configPath = `config/zulip/map-config.${env}.json`;
|
||||
```
|
||||
|
||||
### 3. 配置版本控制
|
||||
|
||||
- 将配置文件纳入版本控制
|
||||
- 使用 `.env.example` 提供配置模板
|
||||
- 敏感配置使用 `.gitignore` 排除
|
||||
|
||||
### 4. 配置文档化
|
||||
|
||||
为每个配置项提供清晰的文档说明:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 消息频率限制配置
|
||||
*
|
||||
* @description 限制用户每分钟可发送的消息数量
|
||||
* @default 10
|
||||
* @range 1-100
|
||||
* @env MESSAGE_RATE_LIMIT
|
||||
*/
|
||||
messageRateLimit: number;
|
||||
```
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 常见配置问题
|
||||
|
||||
#### 1. Zulip 连接失败
|
||||
|
||||
```
|
||||
错误: ZULIP_CONNECTION_FAILED
|
||||
原因: 无法连接到 Zulip 服务器
|
||||
```
|
||||
|
||||
检查项:
|
||||
- `ZULIP_SERVER_URL` 是否正确
|
||||
- 网络是否可达
|
||||
- API Key 是否有效
|
||||
|
||||
#### 2. 地图配置加载失败
|
||||
|
||||
```
|
||||
错误: MAP_CONFIG_LOAD_FAILED
|
||||
原因: 地图配置文件格式错误
|
||||
```
|
||||
|
||||
检查项:
|
||||
- JSON 格式是否正确
|
||||
- 必填字段是否完整
|
||||
- 字段类型是否正确
|
||||
|
||||
#### 3. Redis 连接失败
|
||||
|
||||
```
|
||||
错误: REDIS_CONNECTION_FAILED
|
||||
原因: 无法连接到 Redis 服务器
|
||||
```
|
||||
|
||||
检查项:
|
||||
- `REDIS_HOST` 和 `REDIS_PORT` 是否正确
|
||||
- Redis 服务是否运行
|
||||
- 密码是否正确
|
||||
|
||||
### 配置诊断命令
|
||||
|
||||
```bash
|
||||
# 检查配置有效性
|
||||
npm run config:validate
|
||||
|
||||
# 显示当前配置
|
||||
npm run config:show
|
||||
|
||||
# 测试 Zulip 连接
|
||||
npm run config:test-zulip
|
||||
|
||||
# 测试 Redis 连接
|
||||
npm run config:test-redis
|
||||
```
|
||||
216
docs/systems/zulip/guide.md
Normal file
216
docs/systems/zulip/guide.md
Normal file
@@ -0,0 +1,216 @@
|
||||
游戏属性: 2d社交属性, 无战斗的社群mmo游戏
|
||||
核心目的(游戏内外无缝互通): 不玩这个游戏但是在zulip的社群成员, 也可以跨平台和游戏内的成员聊天
|
||||
|
||||
核心设计理念:
|
||||
Stream (流) -> Topic (话题) 线程模型,天然契合 MMO 中的 Zone (区域) -> Context (情境) 逻辑
|
||||
我们需要解决的核心问题是:如何将2D 空间位置(Game State)映射到Zulip 的信息组织形式(Message State),同时利用 Zulip 的 API Key 机制完成无缝认证
|
||||
|
||||
---
|
||||
1. 核心逻辑架构 (The Core Logic)
|
||||
在设计 API 之前,我们需要定义 mappings(映射关系):
|
||||
- Game World / Map ←→ Zulip Stream (e.g., #Novice_Village)
|
||||
- Interactive Object / Event ←→ Zulip Topic (e.g., Notice Board, Tavern Gossip)
|
||||
- Whisper / Party ←→ Zulip Private Message
|
||||
|
||||
---
|
||||
架构图示:
|
||||
Client (Game) $$\xrightarrow{\text{Game Token}}$$ Game Middleware API $$\xrightarrow{\text{Zulip API Key}}$$ Zulip Server
|
||||
$$Client (Godot) \xleftrightarrow{\text{WebSocket}} Node.js Server \xleftrightarrow{\text{REST/Long-Poll}} Zulip Server$$
|
||||
设计理由:不建议让客户端直接直连 Zulip。我们需要一层中间件(Middleware)来控制权限、注入游戏数据(如玩家坐标、当前的动作状态),并防止用户在该 API Key 下进行非游戏允许的 Zulip 操作(如随意创建 Stream)。
|
||||
|
||||
---
|
||||
2. 设计思路一: "统一网关"(Unified Gateway)
|
||||
2.1 详细数据流设计 (Data Flow)
|
||||
我们需要在 Node.js 中维护一个 Session Manager。
|
||||
A. 登录与握手 (Initialization)
|
||||
1. Godot: 发送登录包 {"type": "login", "token": "user_game_token"}。
|
||||
2. Node.js:
|
||||
- 验证游戏 Token。
|
||||
- 查找该用户的 Zulip API Key(通常存储在数据库中,或者首次登录时让用户提供)。
|
||||
- 关键步骤: Node.js 服务器为该特定用户实例化一个 Zulip Client,并向 Zulip 申请注册一个 Event Queue。
|
||||
- 将 Socket_ID 与 Zulip_Queue_ID 绑定。
|
||||
B. 发送消息 (Upstream: Godot -> Node -> Zulip)
|
||||
1. Godot: 玩家输入 "Hello",Godot 通过 WebSocket 发送简化的包:
|
||||
2. JSON
|
||||
{
|
||||
"t": "chat",
|
||||
"content": "Hello",
|
||||
"scope": "local" // 或者 "topic_name"
|
||||
}
|
||||
1. Node.js:
|
||||
- 收到包,解析出这是聊天请求。
|
||||
- 上下文注入: Node 知道玩家当前在 Map_101 (对应 Zulip Stream #Tavern)。
|
||||
- API 调用: Node 使用该用户的 Zulip Client,调用 Zulip API 发送消息到 #Tavern。
|
||||
- 优势: 这里可以做风控(比如禁止发脏话、频率限制),Godot 端根本无法绕过。
|
||||
C. 接收消息 (Downstream: Zulip -> Node -> Godot)
|
||||
1. Node.js:
|
||||
- 服务器内部有一个循环(或者异步监听器),轮询 Zulip 的事件队列。
|
||||
- 收到 Zulip 的 message 事件:User_B 在 #Tavern 说了 "Hi"。
|
||||
- 空间过滤: Node 检查当前连接的所有 WebSocket,找出所有位于 Map_101 的玩家。
|
||||
- 广播: 将消息打包成游戏协议,通过 WebSocket 推送给这些玩家:
|
||||
2. JSON
|
||||
{
|
||||
"t": "chat_render",
|
||||
"from": "User_B",
|
||||
"txt": "Hi",
|
||||
"bubble": true
|
||||
}
|
||||
1. Godot: 收到包,直接调用 show_bubble()。
|
||||
|
||||
---
|
||||
2.3 这个方案的权衡分析 (Trade-off Analysis)
|
||||
这种改变带来的本质变化:
|
||||
优势 (The Wins)
|
||||
1. 客户端极度简化 (Thin Client):
|
||||
- Godot 里不需要写 HTTP Request,不需要处理 Long Polling 的异常断连,不需要解析复杂的 JSON 结构。
|
||||
- Godot 只需要处理 on_websocket_packet_received。
|
||||
2. 安全性 (Security):
|
||||
- Zulip API Key 永不下发: 用户的 Zulip 凭证永远只保存在服务器端。如果客户端直接拿 Key,黑客可以通过解包 Godot 拿到 Key 然后去 Zulip 乱发消息。
|
||||
- 位置欺诈完全消除: 因为 Stream 的选择权在 Node 手里,玩家无法做到“人在新手村,却往高等级区域频道发消息”。
|
||||
3. 协议统一:
|
||||
- 不再需要处理 HTTP (Zulip) 和 WebSocket (Game) 两种并发逻辑。网络层代码减少一半。
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 3. JWT Token 验证和 API Key 管理 (v1.1.0 更新)
|
||||
|
||||
### 3.1 用户注册和 API Key 生成流程
|
||||
|
||||
当用户注册游戏账号时,系统会自动创建对应的 Zulip 账号并获取 API Key:
|
||||
|
||||
```
|
||||
用户注册 (POST /auth/register)
|
||||
↓
|
||||
1. 创建游戏账号 (LoginService.register)
|
||||
↓
|
||||
2. 初始化 Zulip 管理员客户端
|
||||
↓
|
||||
3. 创建 Zulip 账号 (ZulipAccountService.createZulipAccount)
|
||||
- 使用相同的邮箱和密码
|
||||
- 调用 Zulip API: POST /api/v1/users
|
||||
↓
|
||||
4. 获取 API Key (ZulipAccountService.generateApiKeyForUser)
|
||||
- 使用 fetch_api_key 端点(固定的、基于密码的 Key)
|
||||
- 注意:不使用 regenerate_api_key(会生成新 Key)
|
||||
↓
|
||||
5. 加密存储 API Key (ApiKeySecurityService.storeApiKey)
|
||||
- 使用 AES-256-GCM 加密
|
||||
- 存储到 Redis: zulip:api_key:{userId}
|
||||
↓
|
||||
6. 创建账号关联记录 (ZulipAccountsRepository)
|
||||
- 存储 gameUserId ↔ zulipUserId 映射
|
||||
↓
|
||||
7. 生成 JWT Token (LoginService.generateTokenPair)
|
||||
- 包含用户信息:sub, username, email, role
|
||||
- 返回 access_token 和 refresh_token
|
||||
```
|
||||
|
||||
### 3.2 JWT Token 验证流程
|
||||
|
||||
当用户通过 WebSocket 登录游戏时,系统会验证 JWT Token 并获取 API Key:
|
||||
|
||||
```
|
||||
WebSocket 登录 (login 消息)
|
||||
↓
|
||||
1. ZulipService.validateGameToken(token)
|
||||
↓
|
||||
2. 调用 LoginService.verifyToken(token, 'access')
|
||||
- 验证签名、过期时间、载荷
|
||||
- 提取用户信息:userId, username, email
|
||||
↓
|
||||
3. 从 Redis 获取 API Key (ApiKeySecurityService.getApiKey)
|
||||
- 解密存储的 API Key
|
||||
- 更新访问计数和时间
|
||||
↓
|
||||
4. 创建 Zulip 客户端 (ZulipClientPoolService.createUserClient)
|
||||
- 使用真实的用户 API Key
|
||||
- 注册事件队列
|
||||
↓
|
||||
5. 创建游戏会话 (SessionManagerService.createSession)
|
||||
- 绑定 socketId ↔ zulipQueueId
|
||||
- 记录用户位置信息
|
||||
↓
|
||||
6. 返回登录成功
|
||||
```
|
||||
|
||||
### 3.3 消息发送流程(使用正确的 API Key)
|
||||
|
||||
```
|
||||
发送聊天消息 (chat 消息)
|
||||
↓
|
||||
1. ZulipService.sendChatMessage()
|
||||
↓
|
||||
2. 获取会话信息 (SessionManagerService.getSession)
|
||||
- 获取 userId 和当前位置
|
||||
↓
|
||||
3. 上下文注入 (SessionManagerService.injectContext)
|
||||
- 根据位置确定目标 Stream/Topic
|
||||
↓
|
||||
4. 消息验证 (MessageFilterService.validateMessage)
|
||||
- 内容过滤、频率限制
|
||||
↓
|
||||
5. 发送到 Zulip (ZulipClientPoolService.sendMessage)
|
||||
- 使用用户的真实 API Key
|
||||
- 调用 Zulip API: POST /api/v1/messages
|
||||
↓
|
||||
6. 返回发送结果
|
||||
```
|
||||
|
||||
### 3.4 关键修复说明
|
||||
|
||||
**问题 1: JWT Token 签名冲突**
|
||||
- **原因**: payload 中包含 `iss` 和 `aud`,但 `jwtService.signAsync()` 也通过 options 传递这些值
|
||||
- **修复**: 从 payload 中移除 `iss` 和 `aud`,只通过 options 传递
|
||||
- **文件**: `src/business/auth/services/login.service.ts`
|
||||
|
||||
**问题 2: 使用硬编码的旧 API Key**
|
||||
- **原因**: `ZulipService.validateGameToken()` 使用硬编码的测试 API Key
|
||||
- **修复**: 从 Redis 读取用户注册时存储的真实 API Key
|
||||
- **文件**: `src/business/zulip/zulip.service.ts`
|
||||
|
||||
**问题 3: 重复实现 JWT 验证逻辑**
|
||||
- **原因**: `ZulipService` 自己实现了 JWT 解析
|
||||
- **修复**: 复用 `LoginService.verifyToken()` 方法
|
||||
- **文件**: `src/business/zulip/zulip.service.ts`, `src/business/zulip/zulip.module.ts`
|
||||
|
||||
### 3.5 API Key 安全机制
|
||||
|
||||
**加密存储**:
|
||||
- 使用 AES-256-GCM 算法加密
|
||||
- 加密密钥从环境变量 `ZULIP_API_KEY_ENCRYPTION_KEY` 读取
|
||||
- 存储格式:`{encryptedKey, iv, authTag, createdAt, updatedAt, accessCount}`
|
||||
|
||||
**访问控制**:
|
||||
- 频率限制:每分钟最多 60 次访问
|
||||
- 访问日志:记录每次访问的时间和次数
|
||||
- 安全事件:记录所有关键操作(存储、访问、更新、删除)
|
||||
|
||||
**环境变量配置**:
|
||||
```bash
|
||||
# 生成 64 字符的十六进制密钥(32 字节 = 256 位)
|
||||
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
|
||||
|
||||
# 在 .env 文件中配置
|
||||
ZULIP_API_KEY_ENCRYPTION_KEY=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
|
||||
```
|
||||
|
||||
### 3.6 测试验证
|
||||
|
||||
使用测试脚本验证功能:
|
||||
|
||||
```bash
|
||||
# 测试注册用户的 Zulip 集成
|
||||
node docs/systems/zulip/quick_tests/test-registered-user.js
|
||||
|
||||
# 验证 API Key 一致性
|
||||
node docs/systems/zulip/quick_tests/verify-api-key.js
|
||||
```
|
||||
|
||||
**预期结果**:
|
||||
- ✅ WebSocket 连接成功
|
||||
- ✅ JWT Token 验证通过
|
||||
- ✅ 从 Redis 获取正确的 API Key
|
||||
- ✅ 消息成功发送到 Zulip
|
||||
|
||||
---
|
||||
260
docs/systems/zulip/quick_tests/test-get-messages.js
Normal file
260
docs/systems/zulip/quick_tests/test-get-messages.js
Normal file
@@ -0,0 +1,260 @@
|
||||
/**
|
||||
* 测试通过 WebSocket 接收 Zulip 消息
|
||||
*
|
||||
* 设计理念:
|
||||
* - Zulip API Key 永不下发到客户端
|
||||
* - 所有 Zulip 交互通过游戏服务器的 WebSocket 进行
|
||||
* - 客户端只接收 chat_render 消息,不直接调用 Zulip API
|
||||
*
|
||||
* 功能:
|
||||
* 1. 登录游戏服务器获取 JWT Token
|
||||
* 2. 通过 WebSocket 连接游戏服务器
|
||||
* 3. 在当前地图 (Whale Port) 接收消息
|
||||
* 4. 切换到 Pumpkin Valley 接收消息
|
||||
* 5. 统计接收到的消息数量
|
||||
*
|
||||
* 使用方法:
|
||||
* node docs/systems/zulip/quick_tests/test-get-messages.js
|
||||
*/
|
||||
|
||||
const axios = require('axios');
|
||||
const io = require('socket.io-client');
|
||||
|
||||
// 配置
|
||||
const GAME_SERVER = 'http://localhost:3000';
|
||||
const TEST_USER = {
|
||||
username: 'angtest123',
|
||||
password: 'angtest123',
|
||||
email: 'angjustinl@163.com'
|
||||
};
|
||||
|
||||
// 测试配置
|
||||
const TEST_CONFIG = {
|
||||
whalePortWaitTime: 10000, // 在 Whale Port 等待 10 秒
|
||||
pumpkinValleyWaitTime: 10000, // 在 Pumpkin Valley 等待 10 秒
|
||||
totalTimeout: 30000 // 总超时时间 30 秒
|
||||
};
|
||||
|
||||
/**
|
||||
* 登录游戏服务器获取用户信息
|
||||
*/
|
||||
async function loginToGameServer() {
|
||||
console.log('📝 步骤 1: 登录游戏服务器');
|
||||
console.log(` 用户名: ${TEST_USER.username}`);
|
||||
|
||||
try {
|
||||
const response = await axios.post(`${GAME_SERVER}/auth/login`, {
|
||||
identifier: TEST_USER.username,
|
||||
password: TEST_USER.password
|
||||
});
|
||||
|
||||
if (response.data.success) {
|
||||
console.log('✅ 登录成功');
|
||||
console.log(` 用户ID: ${response.data.data.user.id}`);
|
||||
console.log(` 邮箱: ${response.data.data.user.email}`);
|
||||
return {
|
||||
userId: response.data.data.user.id,
|
||||
username: response.data.data.user.username,
|
||||
email: response.data.data.user.email,
|
||||
token: response.data.data.access_token
|
||||
};
|
||||
} else {
|
||||
throw new Error(response.data.message || '登录失败');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('❌ 登录失败:', error.response?.data?.message || error.message);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* 通过 WebSocket 接收消息
|
||||
*/
|
||||
async function receiveMessagesViaWebSocket(userInfo) {
|
||||
console.log('\n📡 步骤 2: 通过 WebSocket 连接并接收消息');
|
||||
console.log(` 连接到: ${GAME_SERVER}/game`);
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
const socket = io(`${GAME_SERVER}/game`, {
|
||||
transports: ['websocket'],
|
||||
timeout: 20000
|
||||
});
|
||||
|
||||
const receivedMessages = {
|
||||
whalePort: [],
|
||||
pumpkinValley: []
|
||||
};
|
||||
|
||||
let currentMap = 'whale_port';
|
||||
let testPhase = 0; // 0: 连接中, 1: Whale Port, 2: Pumpkin Valley, 3: 完成
|
||||
|
||||
// 连接成功
|
||||
socket.on('connect', () => {
|
||||
console.log('✅ WebSocket 连接成功');
|
||||
|
||||
// 发送登录消息
|
||||
const loginMessage = {
|
||||
type: 'login',
|
||||
token: userInfo.token
|
||||
};
|
||||
|
||||
console.log('📤 发送登录消息...');
|
||||
socket.emit('login', loginMessage);
|
||||
});
|
||||
|
||||
// 登录成功
|
||||
socket.on('login_success', (data) => {
|
||||
console.log('✅ 登录成功');
|
||||
console.log(` 会话ID: ${data.sessionId}`);
|
||||
console.log(` 用户ID: ${data.userId}`);
|
||||
console.log(` 当前地图: ${data.currentMap}`);
|
||||
|
||||
testPhase = 1;
|
||||
currentMap = data.currentMap || 'whale_port';
|
||||
|
||||
console.log(`\n📬 步骤 3: 在 Whale Port 接收消息 (等待 ${TEST_CONFIG.whalePortWaitTime / 1000} 秒)`);
|
||||
console.log(' 💡 提示: 请在 Zulip 的 "Whale Port" Stream 发送测试消息');
|
||||
|
||||
// 在 Whale Port 等待一段时间
|
||||
setTimeout(() => {
|
||||
console.log(`\n📊 Whale Port 接收到 ${receivedMessages.whalePort.length} 条消息`);
|
||||
|
||||
// 切换到 Pumpkin Valley
|
||||
console.log(`\n📤 步骤 4: 切换到 Pumpkin Valley`);
|
||||
const positionUpdate = {
|
||||
t: 'position',
|
||||
x: 150,
|
||||
y: 400,
|
||||
mapId: 'pumpkin_valley'
|
||||
};
|
||||
socket.emit('position_update', positionUpdate);
|
||||
|
||||
testPhase = 2;
|
||||
currentMap = 'pumpkin_valley';
|
||||
|
||||
console.log(`\n📬 步骤 5: 在 Pumpkin Valley 接收消息 (等待 ${TEST_CONFIG.pumpkinValleyWaitTime / 1000} 秒)`);
|
||||
console.log(' 💡 提示: 请在 Zulip 的 "Pumpkin Valley" Stream 发送测试消息');
|
||||
|
||||
// 在 Pumpkin Valley 等待一段时间
|
||||
setTimeout(() => {
|
||||
console.log(`\n📊 Pumpkin Valley 接收到 ${receivedMessages.pumpkinValley.length} 条消息`);
|
||||
|
||||
testPhase = 3;
|
||||
console.log('\n📊 测试完成,断开连接...');
|
||||
socket.disconnect();
|
||||
}, TEST_CONFIG.pumpkinValleyWaitTime);
|
||||
}, TEST_CONFIG.whalePortWaitTime);
|
||||
});
|
||||
|
||||
// 接收到消息 (chat_render)
|
||||
socket.on('chat_render', (data) => {
|
||||
const timestamp = new Date().toLocaleTimeString('zh-CN');
|
||||
|
||||
console.log(`\n📨 [${timestamp}] 收到消息:`);
|
||||
console.log(` ├─ 发送者: ${data.from}`);
|
||||
console.log(` ├─ 内容: ${data.txt}`);
|
||||
console.log(` ├─ Stream: ${data.stream || '未知'}`);
|
||||
console.log(` ├─ Topic: ${data.topic || '未知'}`);
|
||||
console.log(` └─ 当前地图: ${currentMap}`);
|
||||
|
||||
// 记录消息
|
||||
const message = {
|
||||
from: data.from,
|
||||
content: data.txt,
|
||||
stream: data.stream,
|
||||
topic: data.topic,
|
||||
timestamp: new Date(),
|
||||
map: currentMap
|
||||
};
|
||||
|
||||
if (testPhase === 1) {
|
||||
receivedMessages.whalePort.push(message);
|
||||
} else if (testPhase === 2) {
|
||||
receivedMessages.pumpkinValley.push(message);
|
||||
}
|
||||
});
|
||||
|
||||
// 错误处理
|
||||
socket.on('error', (error) => {
|
||||
console.error('❌ 收到错误:', JSON.stringify(error, null, 2));
|
||||
});
|
||||
|
||||
// 连接断开
|
||||
socket.on('disconnect', () => {
|
||||
console.log('\n🔌 WebSocket 连接已关闭');
|
||||
resolve(receivedMessages);
|
||||
});
|
||||
|
||||
// 连接错误
|
||||
socket.on('connect_error', (error) => {
|
||||
console.error('❌ 连接错误:', error.message);
|
||||
reject(error);
|
||||
});
|
||||
|
||||
// 总超时保护
|
||||
setTimeout(() => {
|
||||
if (socket.connected) {
|
||||
console.log('\n⏰ 测试超时,关闭连接');
|
||||
socket.disconnect();
|
||||
}
|
||||
}, TEST_CONFIG.totalTimeout);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 主测试流程
|
||||
*/
|
||||
async function runTest() {
|
||||
console.log('🚀 开始测试通过 WebSocket 接收 Zulip 消息');
|
||||
console.log('='.repeat(60));
|
||||
console.log('📋 设计理念: Zulip API Key 永不下发到客户端');
|
||||
console.log('📋 所有消息通过游戏服务器的 WebSocket (chat_render) 接收');
|
||||
console.log('='.repeat(60));
|
||||
|
||||
try {
|
||||
// 步骤1: 登录游戏服务器
|
||||
const userInfo = await loginToGameServer();
|
||||
|
||||
// 步骤2-5: 通过 WebSocket 接收消息
|
||||
const receivedMessages = await receiveMessagesViaWebSocket(userInfo);
|
||||
|
||||
// 步骤6: 统计信息
|
||||
console.log('\n' + '='.repeat(60));
|
||||
console.log('📊 测试结果汇总');
|
||||
console.log('='.repeat(60));
|
||||
console.log(`✅ Whale Port: ${receivedMessages.whalePort.length} 条消息`);
|
||||
console.log(`✅ Pumpkin Valley: ${receivedMessages.pumpkinValley.length} 条消息`);
|
||||
console.log(`📝 总计: ${receivedMessages.whalePort.length + receivedMessages.pumpkinValley.length} 条消息`);
|
||||
|
||||
// 显示详细消息列表
|
||||
if (receivedMessages.whalePort.length > 0) {
|
||||
console.log('\n📬 Whale Port 消息列表:');
|
||||
receivedMessages.whalePort.forEach((msg, index) => {
|
||||
console.log(` ${index + 1}. [${msg.timestamp.toLocaleTimeString()}] ${msg.from}: ${msg.content.substring(0, 50)}${msg.content.length > 50 ? '...' : ''}`);
|
||||
});
|
||||
}
|
||||
|
||||
if (receivedMessages.pumpkinValley.length > 0) {
|
||||
console.log('\n📬 Pumpkin Valley 消息列表:');
|
||||
receivedMessages.pumpkinValley.forEach((msg, index) => {
|
||||
console.log(` ${index + 1}. [${msg.timestamp.toLocaleTimeString()}] ${msg.from}: ${msg.content.substring(0, 50)}${msg.content.length > 50 ? '...' : ''}`);
|
||||
});
|
||||
}
|
||||
|
||||
console.log('='.repeat(60));
|
||||
|
||||
console.log('\n🎉 测试完成!');
|
||||
console.log('💡 提示: 客户端通过 WebSocket 接收消息,无需直接访问 Zulip API');
|
||||
console.log('💡 提示: 访问 https://zulip.xinghangee.icu 查看完整消息历史');
|
||||
|
||||
process.exit(0);
|
||||
} catch (error) {
|
||||
console.error('\n❌ 测试失败:', error.message);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
// 运行测试
|
||||
runTest();
|
||||
174
docs/systems/zulip/quick_tests/test-list-subscriptions.js
Normal file
174
docs/systems/zulip/quick_tests/test-list-subscriptions.js
Normal file
@@ -0,0 +1,174 @@
|
||||
const zulip = require('zulip-js');
|
||||
const axios = require('axios');
|
||||
|
||||
// 配置
|
||||
const GAME_SERVER = 'http://localhost:3000';
|
||||
const TEST_USER = {
|
||||
username: 'angtest123',
|
||||
password: 'angtest123',
|
||||
email: 'angjustinl@163.com'
|
||||
};
|
||||
|
||||
/**
|
||||
* 登录游戏服务器获取用户信息
|
||||
*/
|
||||
async function loginToGameServer() {
|
||||
console.log('📝 步骤 1: 登录游戏服务器');
|
||||
console.log(` 用户名: ${TEST_USER.username}`);
|
||||
|
||||
try {
|
||||
const response = await axios.post(`${GAME_SERVER}/auth/login`, {
|
||||
identifier: TEST_USER.username,
|
||||
password: TEST_USER.password
|
||||
});
|
||||
|
||||
if (response.data.success) {
|
||||
console.log('✅ 登录成功');
|
||||
console.log(` 用户ID: ${response.data.data.user.id}`);
|
||||
console.log(` 邮箱: ${response.data.data.user.email}`);
|
||||
return {
|
||||
userId: response.data.data.user.id,
|
||||
username: response.data.data.user.username,
|
||||
email: response.data.data.user.email,
|
||||
token: response.data.data.access_token
|
||||
};
|
||||
} else {
|
||||
throw new Error(response.data.message || '登录失败');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('❌ 登录失败:', error.response?.data?.message || error.message);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 使用密码获取 Zulip API Key
|
||||
*/
|
||||
async function getZulipApiKey(email, password) {
|
||||
console.log('\n📝 步骤 2: 获取 Zulip API Key');
|
||||
console.log(` 邮箱: ${email}`);
|
||||
|
||||
try {
|
||||
// Zulip API 使用 Basic Auth 和 form data
|
||||
const response = await axios.post(
|
||||
'https://zulip.xinghangee.icu/api/v1/fetch_api_key',
|
||||
`username=${encodeURIComponent(email)}&password=${encodeURIComponent(password)}`,
|
||||
{
|
||||
headers: {
|
||||
'Content-Type': 'application/x-www-form-urlencoded'
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
if (response.data.result === 'success') {
|
||||
console.log('✅ 成功获取 API Key');
|
||||
console.log(` API Key: ${response.data.api_key.substring(0, 10)}...`);
|
||||
console.log(` 用户ID: ${response.data.user_id}`);
|
||||
return {
|
||||
apiKey: response.data.api_key,
|
||||
email: response.data.email,
|
||||
userId: response.data.user_id
|
||||
};
|
||||
} else {
|
||||
throw new Error(response.data.msg || '获取 API Key 失败');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('❌ 获取 API Key 失败:', error.response?.data?.msg || error.message);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
async function listSubscriptions() {
|
||||
console.log('🚀 开始测试用户订阅的 Streams');
|
||||
console.log('='.repeat(60));
|
||||
|
||||
try {
|
||||
// 步骤1: 登录游戏服务器
|
||||
const userInfo = await loginToGameServer();
|
||||
|
||||
// 步骤2: 获取 Zulip API Key
|
||||
const zulipAuth = await getZulipApiKey(userInfo.email, TEST_USER.password);
|
||||
|
||||
console.log('\n📝 步骤 3: 检查用户订阅的 Streams');
|
||||
|
||||
const config = {
|
||||
username: zulipAuth.email,
|
||||
apiKey: zulipAuth.apiKey,
|
||||
realm: 'https://zulip.xinghangee.icu/'
|
||||
};
|
||||
|
||||
const client = await zulip(config);
|
||||
|
||||
// 获取用户信息
|
||||
console.log('\n👤 获取用户信息...');
|
||||
const profile = await client.users.me.getProfile();
|
||||
console.log('用户:', profile.full_name, `(${profile.email})`);
|
||||
console.log('是否管理员:', profile.is_admin);
|
||||
|
||||
// 获取用户订阅的 Streams
|
||||
console.log('\n📋 获取用户订阅的 Streams...');
|
||||
const subscriptions = await client.streams.subscriptions.retrieve();
|
||||
|
||||
if (subscriptions.result === 'success') {
|
||||
console.log(`\n✅ 找到 ${subscriptions.subscriptions.length} 个订阅的 Streams:`);
|
||||
subscriptions.subscriptions.forEach(sub => {
|
||||
console.log(` - ${sub.name} (ID: ${sub.stream_id})`);
|
||||
});
|
||||
|
||||
// 检查是否有 "Novice Village"
|
||||
const noviceVillage = subscriptions.subscriptions.find(s => s.name === 'Pumpkin Valley');
|
||||
if (noviceVillage) {
|
||||
console.log('\n✅ "Pumpkin Valley" Stream 已存在!');
|
||||
|
||||
// 测试发送消息
|
||||
console.log('\n📤 测试发送消息...');
|
||||
const result = await client.messages.send({
|
||||
type: 'stream',
|
||||
to: 'Pumpkin Valley',
|
||||
subject: 'General',
|
||||
content: '测试消息:系统集成测试成功 🎮'
|
||||
});
|
||||
|
||||
if (result.result === 'success') {
|
||||
console.log('✅ 消息发送成功! Message ID:', result.id);
|
||||
} else {
|
||||
console.log('❌ 消息发送失败:', result.msg);
|
||||
}
|
||||
} else {
|
||||
console.log('\n⚠️ "Pumpkin Valley" Stream 不存在');
|
||||
console.log('💡 请在 Zulip 网页界面手动创建该 Stream,或使用管理员账号创建');
|
||||
|
||||
// 尝试发送到第一个可用的 Stream
|
||||
if (subscriptions.subscriptions.length > 0) {
|
||||
const firstStream = subscriptions.subscriptions[0];
|
||||
console.log(`\n📤 尝试发送消息到 "${firstStream.name}"...`);
|
||||
const result = await client.messages.send({
|
||||
type: 'stream',
|
||||
to: firstStream.name,
|
||||
subject: 'Test',
|
||||
content: '测试消息:验证系统可以发送消息 🎮'
|
||||
});
|
||||
|
||||
if (result.result === 'success') {
|
||||
console.log('✅ 消息发送成功! Message ID:', result.id);
|
||||
console.log(`💡 系统工作正常,只需创建 "Novice Village" Stream 即可`);
|
||||
} else {
|
||||
console.log('❌ 消息发送失败:', result.msg);
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
console.log('❌ 获取订阅失败:', subscriptions.msg);
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
console.error('\n❌ 操作失败:', error.message);
|
||||
if (error.response) {
|
||||
console.error('响应数据:', error.response.data);
|
||||
}
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
// 运行测试
|
||||
listSubscriptions();
|
||||
232
docs/systems/zulip/quick_tests/test-registered-user.js
Normal file
232
docs/systems/zulip/quick_tests/test-registered-user.js
Normal file
@@ -0,0 +1,232 @@
|
||||
/**
|
||||
* 测试新注册用户的Zulip账号功能
|
||||
*
|
||||
* 功能:
|
||||
* 1. 验证新注册用户可以通过游戏服务器登录
|
||||
* 2. 验证Zulip账号已正确创建和关联
|
||||
* 3. 验证用户可以通过WebSocket发送消息到Zulip
|
||||
* 4. 验证用户可以接收来自Zulip的消息
|
||||
*
|
||||
* 使用方法:
|
||||
* node docs/systems/zulip/quick_tests/test-registered-user.js
|
||||
*/
|
||||
|
||||
const io = require('socket.io-client');
|
||||
const axios = require('axios');
|
||||
|
||||
// 配置
|
||||
const GAME_SERVER = 'http://localhost:3000';
|
||||
const TEST_USER = {
|
||||
username: 'angtest123',
|
||||
password: 'angtest123',
|
||||
email: 'angjustinl@163.com'
|
||||
};
|
||||
|
||||
/**
|
||||
* 步骤1: 登录游戏服务器获取token
|
||||
*/
|
||||
async function loginToGameServer() {
|
||||
console.log('📝 步骤 1: 登录游戏服务器');
|
||||
console.log(` 用户名: ${TEST_USER.username}`);
|
||||
|
||||
try {
|
||||
const response = await axios.post(`${GAME_SERVER}/auth/login`, {
|
||||
identifier: TEST_USER.username,
|
||||
password: TEST_USER.password
|
||||
});
|
||||
|
||||
if (response.data.success) {
|
||||
console.log('✅ 登录成功');
|
||||
console.log(` 用户ID: ${response.data.data.user.id}`);
|
||||
console.log(` 昵称: ${response.data.data.user.nickname}`);
|
||||
console.log(` 邮箱: ${response.data.data.user.email}`);
|
||||
console.log(` Token: ${response.data.data.access_token.substring(0, 20)}...`);
|
||||
return {
|
||||
userId: response.data.data.user.id,
|
||||
username: response.data.data.user.username,
|
||||
token: response.data.data.access_token
|
||||
};
|
||||
} else {
|
||||
throw new Error(response.data.message || '登录失败');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('❌ 登录失败:', error.response?.data?.message || error.message);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 步骤2: 通过WebSocket连接并测试Zulip集成
|
||||
*/
|
||||
async function testZulipIntegration(userInfo) {
|
||||
console.log('\n📡 步骤 2: 测试 Zulip 集成');
|
||||
console.log(` 连接到: ${GAME_SERVER}/game`);
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
const socket = io(`${GAME_SERVER}/game`, {
|
||||
transports: ['websocket'],
|
||||
timeout: 20000
|
||||
});
|
||||
|
||||
let testStep = 0;
|
||||
let testResults = {
|
||||
connected: false,
|
||||
loggedIn: false,
|
||||
messageSent: false,
|
||||
messageReceived: false
|
||||
};
|
||||
|
||||
// 连接成功
|
||||
socket.on('connect', () => {
|
||||
console.log('✅ WebSocket 连接成功');
|
||||
testResults.connected = true;
|
||||
testStep = 1;
|
||||
|
||||
// 发送登录消息
|
||||
const loginMessage = {
|
||||
type: 'login',
|
||||
token: userInfo.token
|
||||
};
|
||||
|
||||
console.log('📤 发送登录消息...');
|
||||
socket.emit('login', loginMessage);
|
||||
});
|
||||
|
||||
// 登录成功
|
||||
socket.on('login_success', (data) => {
|
||||
console.log('✅ 登录成功');
|
||||
console.log(` 会话ID: ${data.sessionId}`);
|
||||
console.log(` 用户ID: ${data.userId}`);
|
||||
console.log(` 用户名: ${data.username}`);
|
||||
console.log(` 当前地图: ${data.currentMap}`);
|
||||
testResults.loggedIn = true;
|
||||
testStep = 2;
|
||||
|
||||
// 等待Zulip客户端初始化
|
||||
console.log('\n⏳ 等待 3 秒让 Zulip 客户端初始化...');
|
||||
setTimeout(() => {
|
||||
const chatMessage = {
|
||||
t: 'chat',
|
||||
content: `🎮 【注册用户测试】来自 ${userInfo.username} 的消息!\n` +
|
||||
`时间: ${new Date().toLocaleString()}\n` +
|
||||
`这是通过新注册账号发送的测试消息。`,
|
||||
scope: 'local'
|
||||
};
|
||||
|
||||
console.log('📤 发送测试消息到 Zulip...');
|
||||
console.log(` 内容: ${chatMessage.content.split('\n')[0]}`);
|
||||
socket.emit('chat', chatMessage);
|
||||
}, 3000);
|
||||
});
|
||||
|
||||
// 消息发送成功
|
||||
socket.on('chat_sent', (data) => {
|
||||
console.log('✅ 消息发送成功');
|
||||
console.log(` 消息ID: ${data.id || '未知'}`);
|
||||
testResults.messageSent = true;
|
||||
testStep = 3;
|
||||
|
||||
// 等待一段时间接收消息
|
||||
setTimeout(() => {
|
||||
console.log('\n📊 测试完成,断开连接...');
|
||||
socket.disconnect();
|
||||
}, 5000);
|
||||
});
|
||||
|
||||
// 接收到消息
|
||||
socket.on('chat_render', (data) => {
|
||||
console.log('📨 收到来自 Zulip 的消息:');
|
||||
console.log(` 发送者: ${data.from}`);
|
||||
console.log(` 内容: ${data.txt}`);
|
||||
console.log(` Stream: ${data.stream || '未知'}`);
|
||||
console.log(` Topic: ${data.topic || '未知'}`);
|
||||
testResults.messageReceived = true;
|
||||
});
|
||||
|
||||
// 错误处理
|
||||
socket.on('error', (error) => {
|
||||
console.error('❌ 收到错误:', JSON.stringify(error, null, 2));
|
||||
});
|
||||
|
||||
// 连接断开
|
||||
socket.on('disconnect', () => {
|
||||
console.log('\n🔌 WebSocket 连接已关闭');
|
||||
resolve(testResults);
|
||||
});
|
||||
|
||||
// 连接错误
|
||||
socket.on('connect_error', (error) => {
|
||||
console.error('❌ 连接错误:', error.message);
|
||||
reject(error);
|
||||
});
|
||||
|
||||
// 超时保护
|
||||
setTimeout(() => {
|
||||
if (socket.connected) {
|
||||
socket.disconnect();
|
||||
}
|
||||
}, 15000);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 打印测试结果
|
||||
*/
|
||||
function printTestResults(results) {
|
||||
console.log('\n' + '='.repeat(60));
|
||||
console.log('📊 测试结果汇总');
|
||||
console.log('='.repeat(60));
|
||||
|
||||
const checks = [
|
||||
{ name: 'WebSocket 连接', passed: results.connected },
|
||||
{ name: '游戏服务器登录', passed: results.loggedIn },
|
||||
{ name: '发送消息到 Zulip', passed: results.messageSent },
|
||||
{ name: '接收 Zulip 消息', passed: results.messageReceived }
|
||||
];
|
||||
|
||||
checks.forEach(check => {
|
||||
const icon = check.passed ? '✅' : '❌';
|
||||
console.log(`${icon} ${check.name}: ${check.passed ? '通过' : '失败'}`);
|
||||
});
|
||||
|
||||
const passedCount = checks.filter(c => c.passed).length;
|
||||
const totalCount = checks.length;
|
||||
|
||||
console.log('='.repeat(60));
|
||||
console.log(`总计: ${passedCount}/${totalCount} 项测试通过`);
|
||||
|
||||
if (passedCount === totalCount) {
|
||||
console.log('\n🎉 所有测试通过!Zulip账号创建和集成功能正常!');
|
||||
console.log('💡 提示: 请访问 https://zulip.xinghangee.icu/ 查看发送的消息');
|
||||
} else {
|
||||
console.log('\n⚠️ 部分测试失败,请检查日志');
|
||||
}
|
||||
console.log('='.repeat(60));
|
||||
}
|
||||
|
||||
/**
|
||||
* 主测试流程
|
||||
*/
|
||||
async function runTest() {
|
||||
console.log('🚀 开始测试新注册用户的 Zulip 集成功能');
|
||||
console.log('='.repeat(60));
|
||||
|
||||
try {
|
||||
// 步骤1: 登录
|
||||
const userInfo = await loginToGameServer();
|
||||
|
||||
// 步骤2: 测试Zulip集成
|
||||
const results = await testZulipIntegration(userInfo);
|
||||
|
||||
// 打印结果
|
||||
printTestResults(results);
|
||||
|
||||
process.exit(results.connected && results.loggedIn && results.messageSent ? 0 : 1);
|
||||
} catch (error) {
|
||||
console.error('\n❌ 测试失败:', error.message);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
// 运行测试
|
||||
runTest();
|
||||
183
docs/systems/zulip/quick_tests/test-user-api-key.js
Normal file
183
docs/systems/zulip/quick_tests/test-user-api-key.js
Normal file
@@ -0,0 +1,183 @@
|
||||
const io = require('socket.io-client');
|
||||
const axios = require('axios');
|
||||
|
||||
// 配置
|
||||
const GAME_SERVER = 'http://localhost:3000';
|
||||
const TEST_USER = {
|
||||
username: 'angtest123',
|
||||
password: 'angtest123',
|
||||
email: 'angjustinl@163.com'
|
||||
};
|
||||
|
||||
/**
|
||||
* 登录游戏服务器获取token
|
||||
*/
|
||||
async function loginToGameServer() {
|
||||
console.log('📝 步骤 1: 登录游戏服务器');
|
||||
console.log(` 用户名: ${TEST_USER.username}`);
|
||||
|
||||
try {
|
||||
const response = await axios.post(`${GAME_SERVER}/auth/login`, {
|
||||
identifier: TEST_USER.username,
|
||||
password: TEST_USER.password
|
||||
});
|
||||
|
||||
if (response.data.success) {
|
||||
console.log('✅ 登录成功');
|
||||
console.log(` 用户ID: ${response.data.data.user.id}`);
|
||||
console.log(` 昵称: ${response.data.data.user.nickname}`);
|
||||
console.log(` 邮箱: ${response.data.data.user.email}`);
|
||||
console.log(` Token: ${response.data.data.access_token.substring(0, 20)}...`);
|
||||
return {
|
||||
userId: response.data.data.user.id,
|
||||
username: response.data.data.user.username,
|
||||
token: response.data.data.access_token
|
||||
};
|
||||
} else {
|
||||
throw new Error(response.data.message || '登录失败');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('❌ 登录失败:', error.response?.data?.message || error.message);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
// 使用用户 API Key 测试 Zulip 集成
|
||||
async function testWithUserApiKey() {
|
||||
console.log('🚀 开始测试用户 API Key 的 Zulip 集成');
|
||||
console.log('='.repeat(60));
|
||||
|
||||
try {
|
||||
// 登录获取 token
|
||||
const userInfo = await loginToGameServer();
|
||||
|
||||
console.log('\n📡 步骤 2: 连接 WebSocket 并测试 Zulip 集成');
|
||||
console.log(` 连接到: ${GAME_SERVER}/game`);
|
||||
|
||||
const socket = io(`${GAME_SERVER}/game`, {
|
||||
transports: ['websocket'],
|
||||
timeout: 20000
|
||||
});
|
||||
|
||||
let testStep = 0;
|
||||
|
||||
socket.on('connect', () => {
|
||||
console.log('✅ WebSocket 连接成功');
|
||||
testStep = 1;
|
||||
|
||||
// 使用真实的 JWT token
|
||||
const loginMessage = {
|
||||
type: 'login',
|
||||
token: userInfo.token
|
||||
};
|
||||
|
||||
console.log('📤 步骤 3: 发送登录消息(使用 JWT Token)');
|
||||
socket.emit('login', loginMessage);
|
||||
});
|
||||
|
||||
socket.on('login_success', (data) => {
|
||||
console.log('✅ 步骤 3 完成: 登录成功');
|
||||
console.log(' 会话ID:', data.sessionId);
|
||||
console.log(' 用户ID:', data.userId);
|
||||
console.log(' 用户名:', data.username);
|
||||
console.log(' 当前地图:', data.currentMap);
|
||||
testStep = 2;
|
||||
|
||||
// 等待 Zulip 客户端初始化
|
||||
console.log('\n⏳ 等待 3 秒让 Zulip 客户端初始化...');
|
||||
setTimeout(() => {
|
||||
const chatMessage = {
|
||||
t: 'chat',
|
||||
content: `🎮 【用户API Key测试】来自 ${userInfo.username} 的消息!\n` +
|
||||
`时间: ${new Date().toLocaleString()}\n` +
|
||||
`使用真实 API Key 发送此消息。`,
|
||||
scope: 'local'
|
||||
};
|
||||
|
||||
console.log('📤 步骤 4: 发送消息到 Zulip(使用真实 API Key)');
|
||||
console.log(' 目标 Stream: Whale Port');
|
||||
socket.emit('chat', chatMessage);
|
||||
}, 3000);
|
||||
});
|
||||
|
||||
socket.on('chat_sent', (data) => {
|
||||
console.log('✅ 步骤 4 完成: 消息发送成功');
|
||||
console.log(' 响应:', JSON.stringify(data, null, 2));
|
||||
|
||||
// 只在第一次收到 chat_sent 时发送第二条消息
|
||||
if (testStep === 2) {
|
||||
testStep = 3;
|
||||
|
||||
setTimeout(() => {
|
||||
// 先切换到 Pumpkin Valley 地图
|
||||
console.log('\n📤 步骤 5: 切换到 Pumpkin Valley 地图');
|
||||
const positionUpdate = {
|
||||
t: 'position',
|
||||
x: 150,
|
||||
y: 400,
|
||||
mapId: 'pumpkin_valley'
|
||||
};
|
||||
socket.emit('position_update', positionUpdate);
|
||||
|
||||
// 等待位置更新后发送消息
|
||||
setTimeout(() => {
|
||||
const chatMessage2 = {
|
||||
t: 'chat',
|
||||
content: '🎃 在南瓜谷发送的测试消息!',
|
||||
scope: 'local'
|
||||
};
|
||||
|
||||
console.log('📤 步骤 6: 在 Pumpkin Valley 发送消息');
|
||||
socket.emit('chat', chatMessage2);
|
||||
}, 1000);
|
||||
}, 2000);
|
||||
}
|
||||
});
|
||||
|
||||
socket.on('chat_render', (data) => {
|
||||
console.log('\n📨 收到来自 Zulip 的消息:');
|
||||
console.log(' 发送者:', data.from);
|
||||
console.log(' 内容:', data.txt);
|
||||
console.log(' Stream:', data.stream || '未知');
|
||||
console.log(' Topic:', data.topic || '未知');
|
||||
});
|
||||
|
||||
socket.on('error', (error) => {
|
||||
console.log('❌ 收到错误:', JSON.stringify(error, null, 2));
|
||||
});
|
||||
|
||||
socket.on('disconnect', () => {
|
||||
console.log('\n🔌 WebSocket 连接已关闭');
|
||||
console.log('\n' + '='.repeat(60));
|
||||
console.log('📊 测试结果汇总');
|
||||
console.log('='.repeat(60));
|
||||
console.log(' 完成步骤:', testStep, '/ 3');
|
||||
if (testStep >= 3) {
|
||||
console.log(' ✅ 核心功能正常!');
|
||||
console.log(' 💡 请检查 Zulip 中的 "Whale Port" 和 "Pumpkin Valley" Streams 查看消息');
|
||||
} else {
|
||||
console.log(' ⚠️ 部分测试未完成');
|
||||
}
|
||||
console.log('='.repeat(60));
|
||||
process.exit(testStep >= 3 ? 0 : 1);
|
||||
});
|
||||
|
||||
socket.on('connect_error', (error) => {
|
||||
console.error('❌ 连接错误:', error.message);
|
||||
process.exit(1);
|
||||
});
|
||||
|
||||
// 20秒后自动关闭(给足够时间完成测试)
|
||||
setTimeout(() => {
|
||||
console.log('\n⏰ 测试时间到,关闭连接');
|
||||
socket.disconnect();
|
||||
}, 20000);
|
||||
|
||||
} catch (error) {
|
||||
console.error('\n❌ 测试失败:', error.message);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
// 运行测试
|
||||
testWithUserApiKey();
|
||||
431
docs/systems/zulip/websocket-protocol.md
Normal file
431
docs/systems/zulip/websocket-protocol.md
Normal file
@@ -0,0 +1,431 @@
|
||||
# WebSocket 协议详解
|
||||
|
||||
## 协议概述
|
||||
|
||||
Zulip 集成系统使用 WebSocket 协议实现游戏客户端与服务器之间的实时双向通信。所有消息采用 JSON 格式编码。
|
||||
|
||||
## 连接生命周期
|
||||
|
||||
### 1. 建立连接
|
||||
|
||||
```
|
||||
Client Server
|
||||
| |
|
||||
|-------- WebSocket Connect --------->|
|
||||
| |
|
||||
|<------- Connection Accepted --------|
|
||||
| |
|
||||
```
|
||||
|
||||
### 2. 认证握手
|
||||
|
||||
```
|
||||
Client Server
|
||||
| |
|
||||
|-------- login message ------------->|
|
||||
| |
|
||||
| [验证 Token] |
|
||||
| [创建 Zulip Client] |
|
||||
| [注册 Event Queue] |
|
||||
| [创建 Session] |
|
||||
| |
|
||||
|<------- login_success --------------|
|
||||
| |
|
||||
```
|
||||
|
||||
### 3. 消息交换
|
||||
|
||||
```
|
||||
Client Server Zulip
|
||||
| | |
|
||||
|-------- chat message -------------->| |
|
||||
| |-------- POST /messages ---------->|
|
||||
| |<------- 200 OK -------------------|
|
||||
|<------- chat_sent ------------------| |
|
||||
| | |
|
||||
| |<------- Event Queue Message ------|
|
||||
|<------- chat_render ----------------| |
|
||||
| | |
|
||||
```
|
||||
|
||||
### 4. 断开连接
|
||||
|
||||
```
|
||||
Client Server
|
||||
| |
|
||||
|-------- logout message ------------>|
|
||||
| |
|
||||
| [清理 Session] |
|
||||
| [注销 Event Queue] |
|
||||
| [销毁 Zulip Client] |
|
||||
| |
|
||||
|<------- logout_success -------------|
|
||||
| |
|
||||
|-------- WebSocket Close ----------->|
|
||||
| |
|
||||
```
|
||||
|
||||
## 消息格式规范
|
||||
|
||||
### 消息结构
|
||||
|
||||
所有消息都是 JSON 对象,包含以下基本字段:
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| `type` 或 `t` | string | 消息类型标识 |
|
||||
| 其他字段 | any | 根据消息类型不同而变化 |
|
||||
|
||||
### 消息类型标识
|
||||
|
||||
- 客户端发送的消息使用 `type` 或 `t` 字段
|
||||
- 服务器响应的消息统一使用 `t` 字段
|
||||
|
||||
## 客户端消息
|
||||
|
||||
### LOGIN - 登录认证
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "login",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| type | string | 是 | 固定值 "login" |
|
||||
| token | string | 是 | 游戏认证 Token |
|
||||
|
||||
### CHAT - 发送聊天消息
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "chat",
|
||||
"content": "Hello, everyone!",
|
||||
"scope": "local"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| t | string | 是 | 固定值 "chat" |
|
||||
| content | string | 是 | 消息内容 (1-1000 字符) |
|
||||
| scope | string | 是 | 消息范围 |
|
||||
|
||||
**scope 取值:**
|
||||
- `"local"`: 当前地图的默认 Topic
|
||||
- `"topic_name"`: 指定的 Topic 名称
|
||||
|
||||
### POSITION - 位置更新
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "position",
|
||||
"x": 150.5,
|
||||
"y": 200.3,
|
||||
"mapId": "novice_village"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| t | string | 是 | 固定值 "position" |
|
||||
| x | number | 是 | X 坐标 |
|
||||
| y | number | 是 | Y 坐标 |
|
||||
| mapId | string | 是 | 地图 ID |
|
||||
|
||||
### LOGOUT - 登出
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "logout"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----|------|-----|------|
|
||||
| type | string | 是 | 固定值 "logout" |
|
||||
|
||||
## 服务器消息
|
||||
|
||||
### LOGIN_SUCCESS - 登录成功
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "login_success",
|
||||
"sessionId": "sess_abc123def456",
|
||||
"currentMap": "novice_village",
|
||||
"username": "player_name",
|
||||
"stream": "Novice Village"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| t | string | 固定值 "login_success" |
|
||||
| sessionId | string | 会话 ID |
|
||||
| currentMap | string | 当前地图 ID |
|
||||
| username | string | 用户名 |
|
||||
| stream | string | 当前 Zulip Stream |
|
||||
|
||||
### CHAT_SENT - 消息发送确认
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "chat_sent",
|
||||
"messageId": "msg_789xyz",
|
||||
"timestamp": 1703500800000
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| t | string | 固定值 "chat_sent" |
|
||||
| messageId | string | Zulip 消息 ID |
|
||||
| timestamp | number | 发送时间戳 (毫秒) |
|
||||
|
||||
### CHAT_RENDER - 接收聊天消息
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "chat_render",
|
||||
"from": "other_player",
|
||||
"txt": "Hi there!",
|
||||
"bubble": true,
|
||||
"timestamp": 1703500800000,
|
||||
"stream": "Novice Village",
|
||||
"topic": "General"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| t | string | 固定值 "chat_render" |
|
||||
| from | string | 发送者名称 |
|
||||
| txt | string | 消息内容 |
|
||||
| bubble | boolean | 是否显示气泡 |
|
||||
| timestamp | number | 消息时间戳 |
|
||||
| stream | string | 来源 Stream |
|
||||
| topic | string | 来源 Topic |
|
||||
|
||||
### POSITION_UPDATED - 位置更新确认
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "position_updated",
|
||||
"stream": "Novice Village",
|
||||
"topic": "General"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| t | string | 固定值 "position_updated" |
|
||||
| stream | string | 新的 Zulip Stream |
|
||||
| topic | string | 新的 Zulip Topic |
|
||||
|
||||
### LOGOUT_SUCCESS - 登出成功
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "logout_success"
|
||||
}
|
||||
```
|
||||
|
||||
### ERROR - 错误消息
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "error",
|
||||
"code": "RATE_LIMIT",
|
||||
"message": "消息发送过于频繁,请稍后再试",
|
||||
"details": {
|
||||
"retryAfter": 60
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|-----|------|------|
|
||||
| t | string | 固定值 "error" |
|
||||
| code | string | 错误码 |
|
||||
| message | string | 错误描述 |
|
||||
| details | object | 可选,额外错误信息 |
|
||||
|
||||
## 心跳机制
|
||||
|
||||
### 客户端心跳
|
||||
|
||||
客户端应每 30 秒发送一次心跳消息:
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "ping"
|
||||
}
|
||||
```
|
||||
|
||||
### 服务器响应
|
||||
|
||||
```json
|
||||
{
|
||||
"t": "pong",
|
||||
"timestamp": 1703500800000
|
||||
}
|
||||
```
|
||||
|
||||
### 超时处理
|
||||
|
||||
- 服务器在 60 秒内未收到任何消息将断开连接
|
||||
- 客户端应在连接断开后自动重连
|
||||
|
||||
## 重连策略
|
||||
|
||||
### 指数退避算法
|
||||
|
||||
```
|
||||
重试间隔 = min(baseDelay * 2^attempt, maxDelay)
|
||||
|
||||
baseDelay = 1000ms
|
||||
maxDelay = 30000ms
|
||||
```
|
||||
|
||||
### 重连流程
|
||||
|
||||
1. 检测到连接断开
|
||||
2. 等待重试间隔
|
||||
3. 尝试重新连接
|
||||
4. 连接成功后重新发送 login 消息
|
||||
5. 恢复会话状态
|
||||
|
||||
### 示例代码
|
||||
|
||||
```typescript
|
||||
class ReconnectingWebSocket {
|
||||
private baseDelay = 1000;
|
||||
private maxDelay = 30000;
|
||||
private attempt = 0;
|
||||
|
||||
private getDelay(): number {
|
||||
const delay = Math.min(
|
||||
this.baseDelay * Math.pow(2, this.attempt),
|
||||
this.maxDelay
|
||||
);
|
||||
this.attempt++;
|
||||
return delay;
|
||||
}
|
||||
|
||||
private resetDelay(): void {
|
||||
this.attempt = 0;
|
||||
}
|
||||
|
||||
async reconnect(): Promise<void> {
|
||||
const delay = this.getDelay();
|
||||
console.log(`等待 ${delay}ms 后重连...`);
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, delay));
|
||||
|
||||
try {
|
||||
await this.connect();
|
||||
this.resetDelay();
|
||||
} catch (error) {
|
||||
await this.reconnect();
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 消息序列化
|
||||
|
||||
### 发送消息
|
||||
|
||||
```typescript
|
||||
function sendMessage(socket: WebSocket, message: object): void {
|
||||
const json = JSON.stringify(message);
|
||||
socket.send(json);
|
||||
}
|
||||
```
|
||||
|
||||
### 接收消息
|
||||
|
||||
```typescript
|
||||
socket.onmessage = (event: MessageEvent) => {
|
||||
try {
|
||||
const message = JSON.parse(event.data);
|
||||
handleMessage(message);
|
||||
} catch (error) {
|
||||
console.error('消息解析失败:', error);
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## 并发处理
|
||||
|
||||
### 消息顺序
|
||||
|
||||
- 同一客户端的消息按发送顺序处理
|
||||
- 不同客户端的消息可能并发处理
|
||||
- 服务器响应顺序可能与请求顺序不同
|
||||
|
||||
### 消息确认
|
||||
|
||||
对于需要确认的操作(如发送聊天消息),客户端应:
|
||||
|
||||
1. 生成唯一的请求 ID
|
||||
2. 等待对应的响应
|
||||
3. 设置超时处理
|
||||
|
||||
```typescript
|
||||
async function sendChatWithConfirmation(
|
||||
socket: WebSocket,
|
||||
content: string,
|
||||
timeout: number = 5000
|
||||
): Promise<void> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const timer = setTimeout(() => {
|
||||
reject(new Error('发送超时'));
|
||||
}, timeout);
|
||||
|
||||
const handler = (event: MessageEvent) => {
|
||||
const message = JSON.parse(event.data);
|
||||
if (message.t === 'chat_sent') {
|
||||
clearTimeout(timer);
|
||||
socket.removeEventListener('message', handler);
|
||||
resolve();
|
||||
} else if (message.t === 'error') {
|
||||
clearTimeout(timer);
|
||||
socket.removeEventListener('message', handler);
|
||||
reject(new Error(message.message));
|
||||
}
|
||||
};
|
||||
|
||||
socket.addEventListener('message', handler);
|
||||
|
||||
socket.send(JSON.stringify({
|
||||
t: 'chat',
|
||||
content: content,
|
||||
scope: 'local'
|
||||
}));
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
## 安全考虑
|
||||
|
||||
### Token 安全
|
||||
|
||||
- Token 仅在 login 消息中传输一次
|
||||
- 服务器验证后不再需要 Token
|
||||
- Token 应有合理的过期时间
|
||||
|
||||
### 消息验证
|
||||
|
||||
- 服务器验证所有消息格式
|
||||
- 拒绝格式错误的消息
|
||||
- 记录异常消息日志
|
||||
|
||||
### 防重放攻击
|
||||
|
||||
- 使用时间戳验证消息新鲜度
|
||||
- 拒绝过期的消息
|
||||
- 检测重复的消息 ID
|
||||
175
docs/systems/zulip/zulip-js.md
Normal file
175
docs/systems/zulip/zulip-js.md
Normal file
@@ -0,0 +1,175 @@
|
||||
# zulip-js 
|
||||
|
||||
Javascript library to access the Zulip API
|
||||
|
||||
# Usage
|
||||
|
||||
## Initialization
|
||||
|
||||
### With API Key
|
||||
|
||||
```js
|
||||
const zulipInit = require('zulip-js');
|
||||
const config = {
|
||||
username: process.env.ZULIP_USERNAME,
|
||||
apiKey: process.env.ZULIP_API_KEY,
|
||||
realm: process.env.ZULIP_REALM,
|
||||
};
|
||||
|
||||
(async () => {
|
||||
const zulip = await zulipInit(config);
|
||||
// The zulip object now initialized with config
|
||||
console.log(await zulip.streams.subscriptions.retrieve());
|
||||
})();
|
||||
```
|
||||
|
||||
### With Username & Password
|
||||
|
||||
You will need to first retrieve the API key by calling `await zulipInit(config)`.
|
||||
|
||||
```js
|
||||
const zulipInit = require('zulip-js');
|
||||
const config = {
|
||||
username: process.env.ZULIP_USERNAME,
|
||||
password: process.env.ZULIP_PASSWORD,
|
||||
realm: process.env.ZULIP_REALM,
|
||||
};
|
||||
|
||||
(async () => {
|
||||
// Fetch API Key
|
||||
const zulip = await zulipInit(config);
|
||||
// The zulip object now contains the API Key
|
||||
console.log(await zulip.streams.subscriptions.retrieve());
|
||||
})();
|
||||
```
|
||||
|
||||
### With zuliprc
|
||||
|
||||
Create a file called `zuliprc` (in the same directory as your code) which looks like:
|
||||
|
||||
```
|
||||
[api]
|
||||
email=cordelia@zulip.com
|
||||
key=wlueAg7cQXqKpUgIaPP3dmF4vibZXal7
|
||||
site=http://localhost:9991
|
||||
```
|
||||
|
||||
Please remember to add this file to your `.gitignore`! Calling `await zulipInit({ zuliprc: 'zuliprc' })` will read this file.
|
||||
|
||||
```js
|
||||
const zulipInit = require('zulip-js');
|
||||
const path = require('path');
|
||||
const zuliprc = path.resolve(__dirname, 'zuliprc');
|
||||
(async () => {
|
||||
const zulip = await zulipInit({ zuliprc });
|
||||
// The zulip object now contains the config from the zuliprc file
|
||||
console.log(await zulip.streams.subscriptions.retrieve());
|
||||
})();
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
Please see some examples in [the examples directory](https://github.com/zulip/zulip-js/tree/main/examples).
|
||||
|
||||
Also, to easily test an API endpoint while developing, you can run:
|
||||
|
||||
```
|
||||
$ npm run build
|
||||
$ npm run call <method> <endpoint> [optional: json_params] [optional: path to zuliprc file]
|
||||
$ # For example:
|
||||
$ npm run call GET /users/me
|
||||
$ npm run call GET /users/me '' ~/path/to/my/zuliprc
|
||||
```
|
||||
|
||||
## Supported endpoints
|
||||
|
||||
We support the following endpoints and are striving to have complete coverage of the API. If you want to use some endpoint we do not support presently, you can directly call it as follows:
|
||||
|
||||
```js
|
||||
const params = {
|
||||
to: 'bot testing',
|
||||
type: 'stream',
|
||||
subject: 'Testing zulip-js',
|
||||
content: 'Something is horribly wrong....',
|
||||
};
|
||||
|
||||
await zulip.callEndpoint('/messages', 'POST', params);
|
||||
```
|
||||
|
||||
| Function to call | API Endpoint | Documentation |
|
||||
| --- | --- | --- |
|
||||
| `zulip.accounts.retrieve()` | POST `/fetch_api_key` | returns a promise that you can use to retrieve your `API key`. |
|
||||
| `zulip.emojis.retrieve()` | GET `/realm/emoji` | retrieves the list of realm specific emojis. |
|
||||
| `zulip.events.retrieve()` | GET `/events` | retrieves events from a queue. You can pass it a params object with the id of the queue you are interested in, the last event id that you have received and wish to acknowledge. You can also specify whether the server should not block on this request until there is a new event (the default is to block). |
|
||||
| `zulip.messages.send()` | POST `/messages` | returns a promise that can be used to send a message. |
|
||||
| `zulip.messages.retrieve()` | GET `/messages` | returns a promise that can be used to retrieve messages from a stream. You need to specify the id of the message to be used as an anchor. Use `1000000000` to retrieve the most recent message, or [`zulip.users.me.pointer.retrieve()`](#fetching-a-pointer-for-a-user) to get the id of the last message the user read. |
|
||||
| `zulip.messages.render()` | POST `/messages/render` | returns a promise that can be used to get rendered HTML for a message text. |
|
||||
| `zulip.messages.update()` | PATCH `/messages/<msg_id>` | updates the content or topic of the message with the given `msg_id`. |
|
||||
| `zulip.messages.flags.add()` | POST `/messages/flags` | add a flag to a list of messages. Its params are `flag` which is one of `[read, starred, mentioned, wildcard_mentioned, has_alert_word, historical]` and `messages` which is a list of messageIDs. |
|
||||
| `zulip.messages.flags.remove()` | POST `/messages/flags` | remove a flag from a list of messages. Its params are `flag` which is one of `[read, starred, mentioned, wildcard_mentioned, has_alert_word, historical]` and `messages` which is a list of messageIDs. |
|
||||
| `zulip.messages.getById()` | GET `/messages/<msg_id>` | returns a message by its id. |
|
||||
| `zulip.messages.getHistoryById()` | GET `/messages/<msg_id>/history` | return the history of a message |
|
||||
| `zulip.messages.deleteReactionById()` | DELETE `/messages/<msg_id>/reactions` | deletes reactions on a message by message id |
|
||||
| `zulip.messages.deleteById()` | DELETE `/messages/<msg_id>` | delete the message with the provided message id if the user has permission to do so. |
|
||||
| `zulip.queues.register()` | POST `/register` | registers a new queue. You can pass it a params object with the types of events you are interested in and whether you want to receive raw text or html (using markdown). |
|
||||
| `zulip.queues.deregister()` | DELETE `/events` | deletes a previously registered queue. |
|
||||
| `zulip.reactions.add()` | POST `/reactions` | add a reaction to a message. Accepts a params object with `message_id`, `emoji_name`, `emoji_code` and `reaction_type` (default is `unicode_emoji`). |
|
||||
| `zulip.reactions.remove()` | DELETE `/reactions` | remove a reaction from a message. Accepts a params object with `message_id` and `emoji_code` and `reaction_type` (default is `unicode_emoji`). |
|
||||
| `zulip.streams.retrieve()` | GET `/streams` | returns a promise that can be used to retrieve all streams. |
|
||||
| `zulip.streams.getStreamId()` | GET `/get_stream_id` | returns a promise that can be used to retrieve a stream's id. |
|
||||
| `zulip.streams.subscriptions.retrieve()` | GET `/users/me/subscriptions` | returns a promise that can be used to retrieve the user's subscriptions. |
|
||||
| `zulip.streams.deleteById()` | DELETE `/streams/<stream_id>` | delete the stream with the provided stream id if the user has permission to do so. |
|
||||
| `zulip.streams.topics.retrieve()` | GET `/users/me/<stream_id>/topics` | retrieves all the topics in a specific stream. |
|
||||
| `zulip.typing.send()` | POST `/typing` | can be used to send a typing notification. The parameters required are `to` (either a username or a list of usernames) and `op` (either `start` or `stop`). |
|
||||
| `zulip.users.retrieve()` | GET `/users` | retrieves all users for this realm. |
|
||||
| `zulip.users.me.pointer.retrieve()` | GET `/users/me/pointer` | retrieves a pointer for a user. The pointer is the id of the last message the user read. This can then be used as an anchor message id for subsequent API calls. |
|
||||
| `zulip.users.me.getProfile()` | GET `/users/me` | retrieves the profile of the user/bot. |
|
||||
| `zulip.users.me.subscriptions()` | POST `/users/me/subscriptions` | subscribes a user to a stream/streams. |
|
||||
| `zulip.users.create()` | POST `/users` | create a new user. |
|
||||
| `zulip.users.me.alertWords.retrieve()` | GET `/users/me/alert_words` | get array of a user's alert words. |
|
||||
| `zulip.users.me.subscriptions.remove()` | DELETE `/users/me/subscriptions` | remove subscriptions. |
|
||||
| `zulip.users.me.pointer.update()` | POST `users/me/pointer` | updates the pointer for the user, for moving the home view. Accepts a message id. This has the side effect of marking some messages as read. Will not return success if the message id is invalid. Will always succeed if the id is less than the current value of the pointer (the id of the last message read). |
|
||||
| `zulip.server.settings()` | GET `/server_settings` | returns a dictionary of server settings. |
|
||||
| `zulip.filters.retrieve()` | GET `realm/filters` | return a list of filters in a realm |
|
||||
|
||||
# Testing
|
||||
|
||||
Use `npm test` to run the tests.
|
||||
|
||||
## Writing Tests
|
||||
|
||||
Currently, we have a simple testing framework which stubs our network requests and also allows us to test the input passed to it. This is what a sample test for an API endpoint looks like:
|
||||
|
||||
```js
|
||||
const chai = require('chai');
|
||||
const users = require('../../lib/resources/users'); // File to test.
|
||||
const common = require('../common'); // Common functions for tests.
|
||||
|
||||
chai.should();
|
||||
|
||||
describe('Users', () => {
|
||||
it('should fetch users', async () => {
|
||||
const params = {
|
||||
subject: 'test',
|
||||
content: 'sample test',
|
||||
};
|
||||
const validator = (url, options) => {
|
||||
// Function to test the network request parameters.
|
||||
url.should.equal(`${common.config.apiURL}/users`);
|
||||
Object.keys(options.body.data).length.should.equal(4);
|
||||
options.body.data.subject.should.equal(params.subject);
|
||||
options.body.data.content.should.equal(params.content);
|
||||
};
|
||||
const output = {
|
||||
// The data returned by the API in JSON format.
|
||||
already_subscribed: {},
|
||||
result: 'success',
|
||||
};
|
||||
common.stubNetwork(validator, output); // Stub the network modules.
|
||||
const data = await users(common.config).retrieve(params);
|
||||
data.should.have.property('result', 'success'); // Function call.
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
Each pull request should contain relevant tests as well as example usage.
|
||||
@@ -1,7 +1,7 @@
|
||||
module.exports = {
|
||||
moduleFileExtensions: ['js', 'json', 'ts'],
|
||||
rootDir: 'src',
|
||||
testRegex: '.*\\.spec\\.ts$',
|
||||
roots: ['<rootDir>/src', '<rootDir>/test'],
|
||||
testRegex: '.*\\.(spec|e2e-spec|integration-spec|perf-spec)\\.ts$',
|
||||
transform: {
|
||||
'^.+\\.(t|j)s$': 'ts-jest',
|
||||
},
|
||||
@@ -11,6 +11,6 @@ module.exports = {
|
||||
coverageDirectory: '../coverage',
|
||||
testEnvironment: 'node',
|
||||
moduleNameMapper: {
|
||||
'^src/(.*)$': '<rootDir>/$1',
|
||||
'^src/(.*)$': '<rootDir>/src/$1',
|
||||
},
|
||||
};
|
||||
@@ -3,6 +3,12 @@
|
||||
"collection": "@nestjs/schematics",
|
||||
"sourceRoot": "src",
|
||||
"compilerOptions": {
|
||||
"deleteOutDir": true
|
||||
"deleteOutDir": true,
|
||||
"assets": [
|
||||
{
|
||||
"include": "../config/**/*",
|
||||
"outDir": "./dist"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
26
package.json
26
package.json
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "pixel-game-server",
|
||||
"version": "1.0.0",
|
||||
"description": "A 2D pixel art game server built with NestJS",
|
||||
"version": "1.2.0",
|
||||
"description": "A 2D pixel art game server built with NestJS - 完整的游戏服务器,包含用户认证、位置广播、聊天系统、管理员后台等功能模块",
|
||||
"main": "dist/main.js",
|
||||
"scripts": {
|
||||
"dev": "nest start --watch",
|
||||
@@ -10,7 +10,10 @@
|
||||
"start:prod": "node dist/main.js",
|
||||
"test": "jest",
|
||||
"test:watch": "jest --watch",
|
||||
"test:cov": "jest --coverage"
|
||||
"test:cov": "jest --coverage",
|
||||
"test:e2e": "cross-env RUN_E2E_TESTS=true jest --testPathPattern=e2e.spec.ts",
|
||||
"test:unit": "jest --testPathPattern=spec.ts --testPathIgnorePatterns=e2e.spec.ts",
|
||||
"test:all": "cross-env RUN_E2E_TESTS=true jest"
|
||||
},
|
||||
"keywords": [
|
||||
"game",
|
||||
@@ -25,38 +28,53 @@
|
||||
"@nestjs/common": "^11.1.9",
|
||||
"@nestjs/config": "^4.0.2",
|
||||
"@nestjs/core": "^11.1.9",
|
||||
"@nestjs/jwt": "^11.0.2",
|
||||
"@nestjs/platform-express": "^10.4.20",
|
||||
"@nestjs/platform-socket.io": "^10.4.20",
|
||||
"@nestjs/schedule": "^4.1.2",
|
||||
"@nestjs/swagger": "^11.2.3",
|
||||
"@nestjs/throttler": "^6.5.0",
|
||||
"@nestjs/typeorm": "^11.0.0",
|
||||
"@nestjs/websockets": "^10.4.20",
|
||||
"@types/archiver": "^7.0.0",
|
||||
"@types/bcrypt": "^6.0.0",
|
||||
"archiver": "^7.0.1",
|
||||
"axios": "^1.13.2",
|
||||
"bcrypt": "^6.0.0",
|
||||
"class-transformer": "^0.5.1",
|
||||
"class-validator": "^0.14.3",
|
||||
"ioredis": "^5.8.2",
|
||||
"jsonwebtoken": "^9.0.3",
|
||||
"mysql2": "^3.16.0",
|
||||
"nestjs-pino": "^4.5.0",
|
||||
"nodemailer": "^6.10.1",
|
||||
"pino": "^10.1.0",
|
||||
"reflect-metadata": "^0.1.14",
|
||||
"rxjs": "^7.8.2",
|
||||
"socket.io": "^4.8.3",
|
||||
"swagger-ui-express": "^5.0.1",
|
||||
"typeorm": "^0.3.28"
|
||||
"typeorm": "^0.3.28",
|
||||
"uuid": "^13.0.0",
|
||||
"ws": "^8.18.3",
|
||||
"zulip-js": "^2.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@faker-js/faker": "^10.2.0",
|
||||
"@nestjs/cli": "^10.4.9",
|
||||
"@nestjs/schematics": "^10.2.3",
|
||||
"@nestjs/testing": "^10.4.20",
|
||||
"@types/express": "^5.0.6",
|
||||
"@types/jest": "^29.5.14",
|
||||
"@types/jsonwebtoken": "^9.0.10",
|
||||
"@types/node": "^20.19.27",
|
||||
"@types/nodemailer": "^6.4.14",
|
||||
"@types/supertest": "^6.0.3",
|
||||
"cross-env": "^10.1.0",
|
||||
"fast-check": "^4.5.2",
|
||||
"jest": "^29.7.0",
|
||||
"pino-pretty": "^13.1.3",
|
||||
"socket.io-client": "^4.8.3",
|
||||
"sqlite3": "^5.1.7",
|
||||
"supertest": "^7.1.4",
|
||||
"ts-jest": "^29.2.5",
|
||||
"ts-node": "^10.9.2",
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
packages:
|
||||
- 'client'
|
||||
|
||||
ignoredBuiltDependencies:
|
||||
- '@nestjs/core'
|
||||
- '@scarf/scarf'
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
import { Controller, Get } from '@nestjs/common';
|
||||
import { ApiTags, ApiOperation, ApiResponse } from '@nestjs/swagger';
|
||||
import { AppService } from './app.service';
|
||||
import { AppStatusResponseDto } from './dto/app.dto';
|
||||
import { ErrorResponseDto } from './dto/error_response.dto';
|
||||
import { AppStatusResponseDto, ErrorResponseDto } from './business/shared';
|
||||
|
||||
/**
|
||||
* 应用根控制器
|
||||
|
||||
@@ -1,13 +1,21 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
import { APP_INTERCEPTOR } from '@nestjs/core';
|
||||
import { AppController } from './app.controller';
|
||||
import { AppService } from './app.service';
|
||||
import { LoggerModule } from './core/utils/logger/logger.module';
|
||||
import { UsersModule } from './core/db/users/users.module';
|
||||
import { LoginCoreModule } from './core/login_core/login_core.module';
|
||||
import { LoginModule } from './business/login/login.module';
|
||||
import { AuthModule } from './business/auth/auth.module';
|
||||
import { ZulipModule } from './business/zulip/zulip.module';
|
||||
import { RedisModule } from './core/redis/redis.module';
|
||||
import { AdminModule } from './business/admin/admin.module';
|
||||
import { UserMgmtModule } from './business/user_mgmt/user_mgmt.module';
|
||||
import { SecurityCoreModule } from './core/security_core/security_core.module';
|
||||
import { LocationBroadcastModule } from './business/location_broadcast/location_broadcast.module';
|
||||
import { MaintenanceMiddleware } from './core/security_core/maintenance.middleware';
|
||||
import { ContentTypeMiddleware } from './core/security_core/content_type.middleware';
|
||||
|
||||
/**
|
||||
* 检查数据库配置是否完整 by angjustinl 2025-12-17
|
||||
@@ -60,9 +68,34 @@ function isDatabaseConfigured(): boolean {
|
||||
// 根据数据库配置选择用户模块模式
|
||||
isDatabaseConfigured() ? UsersModule.forDatabase() : UsersModule.forMemory(),
|
||||
LoginCoreModule,
|
||||
LoginModule,
|
||||
AuthModule,
|
||||
ZulipModule,
|
||||
UserMgmtModule,
|
||||
AdminModule,
|
||||
SecurityCoreModule,
|
||||
LocationBroadcastModule,
|
||||
],
|
||||
controllers: [AppController],
|
||||
providers: [AppService],
|
||||
providers: [
|
||||
AppService,
|
||||
// 注意:全局拦截器现在由SecurityModule提供
|
||||
],
|
||||
})
|
||||
export class AppModule {}
|
||||
export class AppModule implements NestModule {
|
||||
/**
|
||||
* 配置中间件
|
||||
*
|
||||
* @param consumer 中间件消费者
|
||||
*/
|
||||
configure(consumer: MiddlewareConsumer) {
|
||||
// 1. 维护模式中间件 - 最高优先级
|
||||
consumer
|
||||
.apply(MaintenanceMiddleware)
|
||||
.forRoutes('*');
|
||||
|
||||
// 2. 内容类型检查中间件
|
||||
consumer
|
||||
.apply(ContentTypeMiddleware)
|
||||
.forRoutes('*');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { AppStatusResponseDto } from './dto/app.dto';
|
||||
import { AppStatusResponseDto } from './business/shared';
|
||||
|
||||
/**
|
||||
* 应用服务类
|
||||
@@ -31,12 +31,12 @@ export class AppService {
|
||||
|
||||
return {
|
||||
service: 'Pixel Game Server',
|
||||
version: '1.0.0',
|
||||
version: '1.1.1',
|
||||
status: 'running',
|
||||
timestamp: new Date().toISOString(),
|
||||
uptime: Math.floor((Date.now() - this.startTime) / 1000),
|
||||
environment: this.configService.get<string>('NODE_ENV', 'development'),
|
||||
storage_mode: isDatabaseConfigured ? 'database' : 'memory'
|
||||
storageMode: isDatabaseConfigured ? 'database' : 'memory'
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
237
src/business/admin/admin.controller.spec.ts
Normal file
237
src/business/admin/admin.controller.spec.ts
Normal file
@@ -0,0 +1,237 @@
|
||||
/**
|
||||
* AdminController 单元测试
|
||||
*
|
||||
* 功能描述:
|
||||
* - 测试管理员控制器的所有HTTP端点
|
||||
* - 验证请求参数处理和响应格式
|
||||
* - 测试权限验证和异常处理
|
||||
*
|
||||
* 职责分离:
|
||||
* - HTTP层测试,不涉及业务逻辑实现
|
||||
* - Mock业务服务,专注控制器逻辑
|
||||
* - 验证请求响应的正确性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-07: 代码规范优化 - 创建AdminController测试文件,补充测试覆盖
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-07
|
||||
* @lastModified 2026-01-07
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { Response } from 'express';
|
||||
import { AdminController } from './admin.controller';
|
||||
import { AdminService } from './admin.service';
|
||||
import { AdminGuard } from './admin.guard';
|
||||
|
||||
describe('AdminController', () => {
|
||||
let controller: AdminController;
|
||||
let adminService: jest.Mocked<AdminService>;
|
||||
|
||||
const mockAdminService = {
|
||||
login: jest.fn(),
|
||||
listUsers: jest.fn(),
|
||||
getUser: jest.fn(),
|
||||
resetPassword: jest.fn(),
|
||||
getRuntimeLogs: jest.fn(),
|
||||
getLogDirAbsolutePath: jest.fn(),
|
||||
};
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
controllers: [AdminController],
|
||||
providers: [
|
||||
{
|
||||
provide: AdminService,
|
||||
useValue: mockAdminService,
|
||||
},
|
||||
],
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
controller = module.get<AdminController>(AdminController);
|
||||
adminService = module.get(AdminService);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('login', () => {
|
||||
it('should login admin successfully', async () => {
|
||||
const loginDto = { identifier: 'admin', password: 'Admin123456' };
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
data: { admin: { id: '1', username: 'admin', role: 9 }, access_token: 'token' },
|
||||
message: '管理员登录成功'
|
||||
};
|
||||
|
||||
adminService.login.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.login(loginDto);
|
||||
|
||||
expect(adminService.login).toHaveBeenCalledWith('admin', 'Admin123456');
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
|
||||
it('should handle login failure', async () => {
|
||||
const loginDto = { identifier: 'admin', password: 'wrong' };
|
||||
const expectedResult = {
|
||||
success: false,
|
||||
message: '密码错误',
|
||||
error_code: 'ADMIN_LOGIN_FAILED'
|
||||
};
|
||||
|
||||
adminService.login.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.login(loginDto);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('ADMIN_LOGIN_FAILED');
|
||||
});
|
||||
});
|
||||
|
||||
describe('listUsers', () => {
|
||||
it('should list users with default pagination', async () => {
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
data: {
|
||||
users: [{ id: '1', username: 'user1' }],
|
||||
limit: 100,
|
||||
offset: 0
|
||||
},
|
||||
message: '用户列表获取成功'
|
||||
};
|
||||
|
||||
adminService.listUsers.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.listUsers();
|
||||
|
||||
expect(adminService.listUsers).toHaveBeenCalledWith(100, 0);
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
|
||||
it('should list users with custom pagination', async () => {
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
data: {
|
||||
users: [],
|
||||
limit: 50,
|
||||
offset: 10
|
||||
},
|
||||
message: '用户列表获取成功'
|
||||
};
|
||||
|
||||
adminService.listUsers.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.listUsers('50', '10');
|
||||
|
||||
expect(adminService.listUsers).toHaveBeenCalledWith(50, 10);
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUser', () => {
|
||||
it('should get user by id', async () => {
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
data: { user: { id: '123', username: 'testuser' } },
|
||||
message: '用户信息获取成功'
|
||||
};
|
||||
|
||||
adminService.getUser.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.getUser('123');
|
||||
|
||||
expect(adminService.getUser).toHaveBeenCalledWith(BigInt(123));
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
});
|
||||
|
||||
describe('resetPassword', () => {
|
||||
it('should reset user password', async () => {
|
||||
const resetDto = { newPassword: 'NewPass1234' };
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
message: '密码重置成功'
|
||||
};
|
||||
|
||||
adminService.resetPassword.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.resetPassword('123', resetDto);
|
||||
|
||||
expect(adminService.resetPassword).toHaveBeenCalledWith(BigInt(123), 'NewPass1234');
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getRuntimeLogs', () => {
|
||||
it('should get runtime logs with default lines', async () => {
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
data: {
|
||||
file: 'app.log',
|
||||
updated_at: '2026-01-07T00:00:00.000Z',
|
||||
lines: ['log line 1', 'log line 2']
|
||||
},
|
||||
message: '运行日志获取成功'
|
||||
};
|
||||
|
||||
adminService.getRuntimeLogs.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.getRuntimeLogs();
|
||||
|
||||
expect(adminService.getRuntimeLogs).toHaveBeenCalledWith(undefined);
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
|
||||
it('should get runtime logs with custom lines', async () => {
|
||||
const expectedResult = {
|
||||
success: true,
|
||||
data: {
|
||||
file: 'app.log',
|
||||
updated_at: '2026-01-07T00:00:00.000Z',
|
||||
lines: ['log line 1']
|
||||
},
|
||||
message: '运行日志获取成功'
|
||||
};
|
||||
|
||||
adminService.getRuntimeLogs.mockResolvedValue(expectedResult);
|
||||
|
||||
const result = await controller.getRuntimeLogs('100');
|
||||
|
||||
expect(adminService.getRuntimeLogs).toHaveBeenCalledWith(100);
|
||||
expect(result).toEqual(expectedResult);
|
||||
});
|
||||
});
|
||||
|
||||
describe('downloadLogsArchive', () => {
|
||||
let mockResponse: Partial<Response>;
|
||||
|
||||
beforeEach(() => {
|
||||
mockResponse = {
|
||||
setHeader: jest.fn(),
|
||||
status: jest.fn().mockReturnThis(),
|
||||
json: jest.fn(),
|
||||
end: jest.fn(),
|
||||
headersSent: false,
|
||||
};
|
||||
});
|
||||
|
||||
it('should handle missing log directory', async () => {
|
||||
adminService.getLogDirAbsolutePath.mockReturnValue('/nonexistent/logs');
|
||||
|
||||
await controller.downloadLogsArchive(mockResponse as Response);
|
||||
|
||||
expect(mockResponse.status).toHaveBeenCalledWith(404);
|
||||
expect(mockResponse.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
message: '日志目录不存在'
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
361
src/business/admin/admin.controller.ts
Normal file
361
src/business/admin/admin.controller.ts
Normal file
@@ -0,0 +1,361 @@
|
||||
/**
|
||||
* 管理员控制器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供管理员登录认证接口
|
||||
* - 提供用户管理相关接口(查询、重置密码)
|
||||
* - 提供系统日志查询和下载功能
|
||||
*
|
||||
* 职责分离:
|
||||
* - HTTP请求处理和参数验证
|
||||
* - 业务逻辑委托给AdminService处理
|
||||
* - 权限控制通过AdminGuard实现
|
||||
*
|
||||
* API端点:
|
||||
* - POST /admin/auth/login 管理员登录
|
||||
* - GET /admin/users 用户列表(需要管理员Token)
|
||||
* - GET /admin/users/:id 用户详情(需要管理员Token)
|
||||
* - POST /admin/users/:id/reset-password 重置指定用户密码(需要管理员Token)
|
||||
* - GET /admin/logs/runtime 获取运行日志尾部(需要管理员Token)
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
* - 2026-01-08: 注释规范优化 - 补充方法注释,添加@param、@returns、@throws和@example (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.2
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Body, Controller, Get, HttpCode, HttpStatus, Param, Post, Query, UseGuards, ValidationPipe, UsePipes, Res, Logger } from '@nestjs/common';
|
||||
import { ApiBearerAuth, ApiBody, ApiOperation, ApiParam, ApiProduces, ApiQuery, ApiResponse, ApiTags } from '@nestjs/swagger';
|
||||
import { AdminGuard } from './admin.guard';
|
||||
import { AdminService } from './admin.service';
|
||||
import { AdminLoginDto, AdminResetPasswordDto } from './admin_login.dto';
|
||||
import {
|
||||
AdminLoginResponseDto,
|
||||
AdminUsersResponseDto,
|
||||
AdminCommonResponseDto,
|
||||
AdminUserResponseDto,
|
||||
AdminRuntimeLogsResponseDto
|
||||
} from './admin_response.dto';
|
||||
import { Throttle, ThrottlePresets } from '../../core/security_core/throttle.decorator';
|
||||
import { getCurrentTimestamp } from './admin_utils';
|
||||
import type { Response } from 'express';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { spawn } from 'child_process';
|
||||
import { pipeline } from 'stream';
|
||||
|
||||
@ApiTags('admin')
|
||||
@Controller('admin')
|
||||
export class AdminController {
|
||||
private readonly logger = new Logger(AdminController.name);
|
||||
|
||||
constructor(private readonly adminService: AdminService) {}
|
||||
|
||||
/**
|
||||
* 管理员登录
|
||||
*
|
||||
* 功能描述:
|
||||
* 验证管理员身份并生成JWT Token,仅允许role=9的账户登录后台
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证登录标识符和密码
|
||||
* 2. 检查用户角色是否为管理员(role=9)
|
||||
* 3. 生成JWT Token
|
||||
* 4. 返回登录结果和Token
|
||||
*
|
||||
* @param dto 登录请求数据
|
||||
* @returns 登录结果,包含Token和管理员信息
|
||||
*
|
||||
* @throws UnauthorizedException 当登录失败时
|
||||
* @throws ForbiddenException 当权限不足或账户被禁用时
|
||||
* @throws TooManyRequestsException 当登录尝试过于频繁时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminController.login({
|
||||
* identifier: 'admin',
|
||||
* password: 'Admin123456'
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
@ApiOperation({ summary: '管理员登录', description: '仅允许 role=9 的账户登录后台' })
|
||||
@ApiBody({ type: AdminLoginDto })
|
||||
@ApiResponse({ status: 200, description: '登录成功', type: AdminLoginResponseDto })
|
||||
@ApiResponse({ status: 401, description: '登录失败' })
|
||||
@ApiResponse({ status: 403, description: '权限不足或账户被禁用' })
|
||||
@ApiResponse({ status: 429, description: '登录尝试过于频繁' })
|
||||
@Throttle(ThrottlePresets.LOGIN)
|
||||
@Post('auth/login')
|
||||
@HttpCode(HttpStatus.OK)
|
||||
@UsePipes(new ValidationPipe({ transform: true }))
|
||||
async login(@Body() dto: AdminLoginDto) {
|
||||
return await this.adminService.login(dto.identifier, dto.password);
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
*
|
||||
* 功能描述:
|
||||
* 分页获取系统中的用户列表,支持限制数量和偏移量参数
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 解析查询参数(limit和offset)
|
||||
* 2. 调用用户服务获取用户列表
|
||||
* 3. 格式化用户数据
|
||||
* 4. 返回分页结果
|
||||
*
|
||||
* @param limit 返回数量,默认100,可选参数
|
||||
* @param offset 偏移量,默认0,可选参数
|
||||
* @returns 用户列表和分页信息
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 获取前20个用户
|
||||
* const result = await adminController.listUsers('20', '0');
|
||||
* ```
|
||||
*/
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
@ApiOperation({ summary: '获取用户列表', description: '后台用户管理:分页获取用户列表' })
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认100)' })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)' })
|
||||
@ApiResponse({ status: 200, description: '获取成功', type: AdminUsersResponseDto })
|
||||
@UseGuards(AdminGuard)
|
||||
@Get('users')
|
||||
async listUsers(
|
||||
@Query('limit') limit?: string,
|
||||
@Query('offset') offset?: string,
|
||||
) {
|
||||
const parsedLimit = limit ? Number(limit) : 100;
|
||||
const parsedOffset = offset ? Number(offset) : 0;
|
||||
return await this.adminService.listUsers(parsedLimit, parsedOffset);
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取用户详情
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据用户ID获取指定用户的详细信息
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户ID格式
|
||||
* 2. 查询用户详细信息
|
||||
* 3. 格式化用户数据
|
||||
* 4. 返回用户详情
|
||||
*
|
||||
* @param id 用户ID字符串
|
||||
* @returns 用户详细信息
|
||||
*
|
||||
* @throws NotFoundException 当用户不存在时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminController.getUser('123');
|
||||
* ```
|
||||
*/
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
@ApiOperation({ summary: '获取用户详情' })
|
||||
@ApiParam({ name: 'id', description: '用户ID' })
|
||||
@ApiResponse({ status: 200, description: '获取成功', type: AdminUserResponseDto })
|
||||
@UseGuards(AdminGuard)
|
||||
@Get('users/:id')
|
||||
async getUser(@Param('id') id: string) {
|
||||
return await this.adminService.getUser(BigInt(id));
|
||||
}
|
||||
|
||||
/**
|
||||
* 重置用户密码
|
||||
*
|
||||
* 功能描述:
|
||||
* 管理员直接为指定用户设置新密码,新密码需满足密码强度规则
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户ID和新密码格式
|
||||
* 2. 检查用户是否存在
|
||||
* 3. 验证密码强度规则
|
||||
* 4. 更新用户密码
|
||||
* 5. 记录操作日志
|
||||
*
|
||||
* @param id 用户ID字符串
|
||||
* @param dto 密码重置请求数据
|
||||
* @returns 重置结果
|
||||
*
|
||||
* @throws NotFoundException 当用户不存在时
|
||||
* @throws BadRequestException 当密码不符合强度规则时
|
||||
* @throws TooManyRequestsException 当操作过于频繁时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminController.resetPassword('123', {
|
||||
* newPassword: 'NewPass1234'
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
@ApiOperation({ summary: '重置用户密码', description: '管理员直接为用户设置新密码(需满足密码强度规则)' })
|
||||
@ApiParam({ name: 'id', description: '用户ID' })
|
||||
@ApiBody({ type: AdminResetPasswordDto })
|
||||
@ApiResponse({ status: 200, description: '重置成功', type: AdminCommonResponseDto })
|
||||
@ApiResponse({ status: 429, description: '操作过于频繁' })
|
||||
@UseGuards(AdminGuard)
|
||||
@Throttle(ThrottlePresets.ADMIN_OPERATION)
|
||||
@Post('users/:id/reset-password')
|
||||
@HttpCode(HttpStatus.OK)
|
||||
@UsePipes(new ValidationPipe({ transform: true }))
|
||||
async resetPassword(@Param('id') id: string, @Body() dto: AdminResetPasswordDto) {
|
||||
return await this.adminService.resetPassword(BigInt(id), dto.newPassword);
|
||||
}
|
||||
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
@ApiOperation({ summary: '获取运行日志尾部', description: '从 logs/ 目录读取最近的日志行(默认200行)' })
|
||||
@ApiQuery({ name: 'lines', required: false, description: '返回行数(默认200,最大2000)' })
|
||||
@ApiResponse({ status: 200, description: '获取成功', type: AdminRuntimeLogsResponseDto })
|
||||
@UseGuards(AdminGuard)
|
||||
@Get('logs/runtime')
|
||||
async getRuntimeLogs(@Query('lines') lines?: string) {
|
||||
const parsedLines = lines ? Number(lines) : undefined;
|
||||
return await this.adminService.getRuntimeLogs(parsedLines);
|
||||
}
|
||||
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
@ApiOperation({ summary: '下载全部运行日志', description: '将 logs/ 目录打包为 tar.gz 并下载(需要管理员Token)' })
|
||||
@ApiProduces('application/gzip')
|
||||
@ApiResponse({ status: 200, description: '打包下载成功(tar.gz 二进制流)' })
|
||||
@UseGuards(AdminGuard)
|
||||
@Get('logs/archive')
|
||||
async downloadLogsArchive(@Res() res: Response) {
|
||||
const logDir = this.adminService.getLogDirAbsolutePath();
|
||||
|
||||
// 验证日志目录
|
||||
const dirValidation = this.validateLogDirectory(logDir, res);
|
||||
if (!dirValidation.isValid) {
|
||||
return;
|
||||
}
|
||||
|
||||
// 设置响应头
|
||||
this.setArchiveResponseHeaders(res);
|
||||
|
||||
// 创建并处理tar进程
|
||||
await this.createAndHandleTarProcess(logDir, res);
|
||||
}
|
||||
|
||||
/**
|
||||
* 验证日志目录是否存在且可用
|
||||
*
|
||||
* @param logDir 日志目录路径
|
||||
* @param res 响应对象
|
||||
* @returns 验证结果
|
||||
*/
|
||||
private validateLogDirectory(logDir: string, res: Response): { isValid: boolean } {
|
||||
if (!fs.existsSync(logDir)) {
|
||||
res.status(404).json({ success: false, message: '日志目录不存在' });
|
||||
return { isValid: false };
|
||||
}
|
||||
|
||||
const stats = fs.statSync(logDir);
|
||||
if (!stats.isDirectory()) {
|
||||
res.status(404).json({ success: false, message: '日志目录不可用' });
|
||||
return { isValid: false };
|
||||
}
|
||||
|
||||
return { isValid: true };
|
||||
}
|
||||
|
||||
/**
|
||||
* 设置文件下载的响应头
|
||||
*
|
||||
* @param res 响应对象
|
||||
*/
|
||||
private setArchiveResponseHeaders(res: Response): void {
|
||||
const ts = getCurrentTimestamp().replace(/[:.]/g, '-');
|
||||
const filename = `logs-${ts}.tar.gz`;
|
||||
|
||||
res.setHeader('Content-Type', 'application/gzip');
|
||||
res.setHeader('Content-Disposition', `attachment; filename="${filename}"`);
|
||||
res.setHeader('Cache-Control', 'no-store');
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建并处理tar进程
|
||||
*
|
||||
* @param logDir 日志目录路径
|
||||
* @param res 响应对象
|
||||
*/
|
||||
private async createAndHandleTarProcess(logDir: string, res: Response): Promise<void> {
|
||||
const parentDir = path.dirname(logDir);
|
||||
const baseName = path.basename(logDir);
|
||||
|
||||
const tar = spawn('tar', ['-czf', '-', '-C', parentDir, baseName], {
|
||||
stdio: ['ignore', 'pipe', 'pipe'],
|
||||
});
|
||||
|
||||
// 处理tar进程的stderr输出
|
||||
tar.stderr.on('data', (chunk: Buffer) => {
|
||||
const msg = chunk.toString('utf8').trim();
|
||||
if (msg) {
|
||||
this.logger.warn(`tar stderr: ${msg}`);
|
||||
}
|
||||
});
|
||||
|
||||
// 处理tar进程错误
|
||||
tar.on('error', (err: any) => {
|
||||
this.handleTarProcessError(err, res);
|
||||
});
|
||||
|
||||
// 处理数据流和进程退出
|
||||
await this.handleTarStreams(tar, res);
|
||||
}
|
||||
|
||||
/**
|
||||
* 处理tar进程错误
|
||||
*
|
||||
* @param err 错误对象
|
||||
* @param res 响应对象
|
||||
*/
|
||||
private handleTarProcessError(err: any, res: Response): void {
|
||||
this.logger.error('打包日志失败(tar 进程启动失败)', err?.stack || String(err));
|
||||
if (!res.headersSent) {
|
||||
const msg = err?.code === 'ENOENT' ? '服务器缺少 tar 命令,无法打包日志' : '日志打包失败';
|
||||
res.status(500).json({ success: false, message: msg });
|
||||
} else {
|
||||
res.end();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 处理tar进程的数据流和退出
|
||||
*
|
||||
* @param tar tar进程
|
||||
* @param res 响应对象
|
||||
*/
|
||||
private async handleTarStreams(tar: any, res: Response): Promise<void> {
|
||||
const pipelinePromise = new Promise<void>((resolve, reject) => {
|
||||
pipeline(tar.stdout, res, (err) => (err ? reject(err) : resolve()));
|
||||
});
|
||||
|
||||
const exitPromise = new Promise<void>((resolve, reject) => {
|
||||
tar.on('close', (code) => {
|
||||
if (code === 0) {
|
||||
resolve();
|
||||
} else {
|
||||
reject(new Error(`tar exited with code ${code ?? 'unknown'}`));
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
try {
|
||||
await pipelinePromise;
|
||||
await exitPromise;
|
||||
} catch (err) {
|
||||
this.logger.error('打包日志失败(tar 执行或输出失败)', err instanceof Error ? err.stack : String(err));
|
||||
if (!res.headersSent) {
|
||||
res.status(500).json({ success: false, message: '日志打包失败' });
|
||||
} else {
|
||||
res.end();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
103
src/business/admin/admin.guard.spec.ts
Normal file
103
src/business/admin/admin.guard.spec.ts
Normal file
@@ -0,0 +1,103 @@
|
||||
/**
|
||||
* AdminGuard 单元测试
|
||||
*
|
||||
* 功能描述:
|
||||
* - 测试管理员鉴权守卫的权限验证逻辑
|
||||
* - 验证Token解析和验证的正确性
|
||||
* - 测试各种异常情况的处理
|
||||
*
|
||||
* 职责分离:
|
||||
* - 权限验证测试,专注守卫逻辑
|
||||
* - Mock核心服务,测试守卫行为
|
||||
* - 验证请求拦截和放行的正确性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 添加文件头注释,完善测试文档说明 (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { ExecutionContext, UnauthorizedException } from '@nestjs/common';
|
||||
import { AdminCoreService, AdminAuthPayload } from '../../core/admin_core/admin_core.service';
|
||||
import { AdminGuard } from './admin.guard';
|
||||
|
||||
describe('AdminGuard', () => {
|
||||
const payload: AdminAuthPayload = {
|
||||
adminId: '1',
|
||||
username: 'admin',
|
||||
role: 9,
|
||||
iat: 1,
|
||||
exp: 2,
|
||||
};
|
||||
|
||||
const adminCoreServiceMock: Pick<AdminCoreService, 'verifyToken'> = {
|
||||
verifyToken: jest.fn(),
|
||||
};
|
||||
|
||||
const makeContext = (authorization?: any) => {
|
||||
const req: any = { headers: {} };
|
||||
if (authorization !== undefined) {
|
||||
req.headers['authorization'] = authorization;
|
||||
}
|
||||
|
||||
const ctx: Partial<ExecutionContext> = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => req,
|
||||
getResponse: () => ({} as any),
|
||||
getNext: () => ({} as any),
|
||||
}),
|
||||
};
|
||||
|
||||
return { ctx: ctx as ExecutionContext, req };
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
it('should allow access with valid admin token', () => {
|
||||
(adminCoreServiceMock.verifyToken as jest.Mock).mockReturnValue(payload);
|
||||
|
||||
const guard = new AdminGuard(adminCoreServiceMock as AdminCoreService);
|
||||
const { ctx, req } = makeContext('Bearer valid');
|
||||
|
||||
expect(guard.canActivate(ctx)).toBe(true);
|
||||
expect(adminCoreServiceMock.verifyToken).toHaveBeenCalledWith('valid');
|
||||
expect(req.admin).toEqual(payload);
|
||||
});
|
||||
|
||||
it('should deny access without token', () => {
|
||||
const guard = new AdminGuard(adminCoreServiceMock as AdminCoreService);
|
||||
const { ctx } = makeContext(undefined);
|
||||
|
||||
expect(() => guard.canActivate(ctx)).toThrow(UnauthorizedException);
|
||||
});
|
||||
|
||||
it('should deny access with invalid Authorization format', () => {
|
||||
const guard = new AdminGuard(adminCoreServiceMock as AdminCoreService);
|
||||
const { ctx } = makeContext('InvalidFormat');
|
||||
|
||||
expect(() => guard.canActivate(ctx)).toThrow(UnauthorizedException);
|
||||
});
|
||||
|
||||
it('should deny access when verifyToken throws (invalid/expired)', () => {
|
||||
(adminCoreServiceMock.verifyToken as jest.Mock).mockImplementation(() => {
|
||||
throw new UnauthorizedException('Token已过期');
|
||||
});
|
||||
|
||||
const guard = new AdminGuard(adminCoreServiceMock as AdminCoreService);
|
||||
const { ctx } = makeContext('Bearer bad');
|
||||
|
||||
expect(() => guard.canActivate(ctx)).toThrow(UnauthorizedException);
|
||||
});
|
||||
|
||||
it('should deny access when Authorization header is an array', () => {
|
||||
const guard = new AdminGuard(adminCoreServiceMock as AdminCoreService);
|
||||
const { ctx } = makeContext(['Bearer token']);
|
||||
|
||||
expect(() => guard.canActivate(ctx)).toThrow(UnauthorizedException);
|
||||
});
|
||||
});
|
||||
97
src/business/admin/admin.guard.ts
Normal file
97
src/business/admin/admin.guard.ts
Normal file
@@ -0,0 +1,97 @@
|
||||
/**
|
||||
* 管理员鉴权守卫
|
||||
*
|
||||
* 功能描述:
|
||||
* - 保护后台管理接口的访问权限
|
||||
* - 验证Authorization Bearer Token
|
||||
* - 确保只有role=9的管理员可以访问
|
||||
*
|
||||
* 职责分离:
|
||||
* - HTTP请求权限验证
|
||||
* - Token解析和验证
|
||||
* - 管理员身份确认
|
||||
*
|
||||
* 主要方法:
|
||||
* - canActivate() - 权限验证核心逻辑
|
||||
*
|
||||
* 使用场景:
|
||||
* - 后台管理API的权限保护
|
||||
* - 管理员身份验证
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 为接口添加注释,完善文档说明 (修改者: moyin)
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
* - 2026-01-08: 注释规范优化 - 补充方法注释,添加@param、@returns、@throws和@example (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.3
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { CanActivate, ExecutionContext, Injectable, UnauthorizedException } from '@nestjs/common';
|
||||
import { Request } from 'express';
|
||||
import { AdminCoreService, AdminAuthPayload } from '../../core/admin_core/admin_core.service';
|
||||
|
||||
/**
|
||||
* 管理员请求接口
|
||||
*
|
||||
* 功能描述:
|
||||
* 扩展Express Request接口,添加管理员认证信息
|
||||
*
|
||||
* 使用场景:
|
||||
* - AdminGuard验证通过后,将管理员信息附加到请求对象
|
||||
* - 控制器方法中获取当前管理员信息
|
||||
*/
|
||||
export interface AdminRequest extends Request {
|
||||
admin?: AdminAuthPayload;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class AdminGuard implements CanActivate {
|
||||
constructor(private readonly adminCoreService: AdminCoreService) {}
|
||||
|
||||
/**
|
||||
* 权限验证核心逻辑
|
||||
*
|
||||
* 功能描述:
|
||||
* 验证HTTP请求的Authorization头,确保只有管理员可以访问
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 提取Authorization头
|
||||
* 2. 验证Bearer Token格式
|
||||
* 3. 调用核心服务验证Token
|
||||
* 4. 将管理员信息附加到请求对象
|
||||
*
|
||||
* @param context 执行上下文,包含HTTP请求信息
|
||||
* @returns 是否允许访问,true表示允许
|
||||
*
|
||||
* @throws UnauthorizedException 当缺少Authorization头或格式错误时
|
||||
* @throws UnauthorizedException 当Token无效或过期时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 在控制器方法上使用
|
||||
* @UseGuards(AdminGuard)
|
||||
* @Get('users')
|
||||
* async getUsers() { ... }
|
||||
* ```
|
||||
*/
|
||||
canActivate(context: ExecutionContext): boolean {
|
||||
const req = context.switchToHttp().getRequest<AdminRequest>();
|
||||
const auth = req.headers['authorization'];
|
||||
|
||||
if (!auth || Array.isArray(auth)) {
|
||||
throw new UnauthorizedException('缺少Authorization头');
|
||||
}
|
||||
|
||||
const [scheme, token] = auth.split(' ');
|
||||
if (scheme !== 'Bearer' || !token) {
|
||||
throw new UnauthorizedException('Authorization格式错误');
|
||||
}
|
||||
|
||||
const payload = this.adminCoreService.verifyToken(token);
|
||||
req.admin = payload;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
80
src/business/admin/admin.module.ts
Normal file
80
src/business/admin/admin.module.ts
Normal file
@@ -0,0 +1,80 @@
|
||||
/**
|
||||
* 管理员业务模块
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供后台管理的HTTP API(管理员登录、用户管理、密码重置等)
|
||||
* - 集成管理员核心服务和日志管理服务
|
||||
* - 导出管理员服务供其他模块使用
|
||||
*
|
||||
* 职责分离:
|
||||
* - 模块依赖管理和服务注册
|
||||
* - HTTP层与业务流程编排
|
||||
* - 核心鉴权与密码策略由AdminCoreService提供
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正import路径,创建缺失的控制器和服务文件 (修改者: moyin)
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.2
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Module } from '@nestjs/common';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
import { AdminCoreModule } from '../../core/admin_core/admin_core.module';
|
||||
import { LoggerModule } from '../../core/utils/logger/logger.module';
|
||||
import { UsersModule } from '../../core/db/users/users.module';
|
||||
import { UserProfilesModule } from '../../core/db/user_profiles/user_profiles.module';
|
||||
import { ZulipAccountsModule } from '../../core/db/zulip_accounts/zulip_accounts.module';
|
||||
import { AdminController } from './admin.controller';
|
||||
import { AdminService } from './admin.service';
|
||||
import { AdminDatabaseController } from './admin_database.controller';
|
||||
import { AdminOperationLogController } from './admin_operation_log.controller';
|
||||
import { DatabaseManagementService } from './database_management.service';
|
||||
import { AdminOperationLogService } from './admin_operation_log.service';
|
||||
import { AdminOperationLog } from './admin_operation_log.entity';
|
||||
import { AdminDatabaseExceptionFilter } from './admin_database_exception.filter';
|
||||
import { AdminOperationLogInterceptor } from './admin_operation_log.interceptor';
|
||||
|
||||
/**
|
||||
* 检查数据库配置是否完整
|
||||
*
|
||||
* @returns 是否配置了数据库
|
||||
*/
|
||||
function isDatabaseConfigured(): boolean {
|
||||
const requiredEnvVars = ['DB_HOST', 'DB_PORT', 'DB_USERNAME', 'DB_PASSWORD', 'DB_NAME'];
|
||||
return requiredEnvVars.every(varName => process.env[varName]);
|
||||
}
|
||||
|
||||
@Module({
|
||||
imports: [
|
||||
AdminCoreModule,
|
||||
LoggerModule,
|
||||
UsersModule,
|
||||
// 根据数据库配置选择UserProfiles模块模式
|
||||
isDatabaseConfigured() ? UserProfilesModule.forDatabase() : UserProfilesModule.forMemory(),
|
||||
ZulipAccountsModule,
|
||||
// 注册AdminOperationLog实体
|
||||
TypeOrmModule.forFeature([AdminOperationLog])
|
||||
],
|
||||
controllers: [
|
||||
AdminController,
|
||||
AdminDatabaseController,
|
||||
AdminOperationLogController
|
||||
],
|
||||
providers: [
|
||||
AdminService,
|
||||
DatabaseManagementService,
|
||||
AdminOperationLogService,
|
||||
AdminDatabaseExceptionFilter,
|
||||
AdminOperationLogInterceptor
|
||||
],
|
||||
exports: [
|
||||
AdminService,
|
||||
DatabaseManagementService,
|
||||
AdminOperationLogService
|
||||
], // 导出服务供其他模块使用
|
||||
})
|
||||
export class AdminModule {}
|
||||
290
src/business/admin/admin.service.spec.ts
Normal file
290
src/business/admin/admin.service.spec.ts
Normal file
@@ -0,0 +1,290 @@
|
||||
/**
|
||||
* AdminService 单元测试
|
||||
*
|
||||
* 功能描述:
|
||||
* - 测试管理员业务服务的所有方法
|
||||
* - 验证业务逻辑的正确性
|
||||
* - 测试异常处理和边界情况
|
||||
*
|
||||
* 职责分离:
|
||||
* - 业务逻辑测试,不涉及HTTP层
|
||||
* - Mock核心服务,专注业务服务逻辑
|
||||
* - 验证数据处理和格式化的正确性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 添加文件头注释,完善测试文档说明 (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { NotFoundException, BadRequestException } from '@nestjs/common';
|
||||
import { AdminService } from './admin.service';
|
||||
import { AdminCoreService } from '../../core/admin_core/admin_core.service';
|
||||
import { LogManagementService } from '../../core/utils/logger/log_management.service';
|
||||
import { Users } from '../../core/db/users/users.entity';
|
||||
import { UserStatus } from '../user_mgmt/user_status.enum';
|
||||
|
||||
describe('AdminService', () => {
|
||||
let service: AdminService;
|
||||
|
||||
const adminCoreServiceMock: Pick<AdminCoreService, 'login' | 'resetUserPassword'> = {
|
||||
login: jest.fn(),
|
||||
resetUserPassword: jest.fn(),
|
||||
};
|
||||
|
||||
const usersServiceMock = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
update: jest.fn(),
|
||||
};
|
||||
|
||||
const logManagementServiceMock: Pick<LogManagementService, 'getRuntimeLogTail' | 'getLogDirAbsolutePath'> = {
|
||||
getRuntimeLogTail: jest.fn(),
|
||||
getLogDirAbsolutePath: jest.fn(),
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
jest.resetAllMocks();
|
||||
service = new AdminService(
|
||||
adminCoreServiceMock as unknown as AdminCoreService,
|
||||
usersServiceMock as any,
|
||||
logManagementServiceMock as unknown as LogManagementService,
|
||||
);
|
||||
});
|
||||
|
||||
it('should login admin successfully', async () => {
|
||||
(adminCoreServiceMock.login as jest.Mock).mockResolvedValue({
|
||||
admin: { id: '1', username: 'admin', nickname: '管理员', role: 9 },
|
||||
access_token: 'token',
|
||||
expires_at: 123,
|
||||
});
|
||||
|
||||
const res = await service.login('admin', 'Admin123456');
|
||||
|
||||
expect(adminCoreServiceMock.login).toHaveBeenCalledWith({ identifier: 'admin', password: 'Admin123456' });
|
||||
expect(res.success).toBe(true);
|
||||
expect(res.data?.admin?.role).toBe(9);
|
||||
expect(res.message).toBe('管理员登录成功');
|
||||
});
|
||||
|
||||
it('should handle login failure', async () => {
|
||||
(adminCoreServiceMock.login as jest.Mock).mockRejectedValue(new Error('密码错误'));
|
||||
|
||||
const res = await service.login('admin', 'bad');
|
||||
|
||||
expect(res.success).toBe(false);
|
||||
expect(res.error_code).toBe('ADMIN_LOGIN_FAILED');
|
||||
expect(res.message).toBe('密码错误');
|
||||
});
|
||||
|
||||
it('should handle non-Error login failure', async () => {
|
||||
(adminCoreServiceMock.login as jest.Mock).mockRejectedValue('boom');
|
||||
|
||||
const res = await service.login('admin', 'bad');
|
||||
|
||||
expect(res.success).toBe(false);
|
||||
expect(res.error_code).toBe('ADMIN_LOGIN_FAILED');
|
||||
expect(res.message).toBe('管理员登录失败');
|
||||
});
|
||||
|
||||
it('should list users with pagination', async () => {
|
||||
const user = {
|
||||
id: BigInt(1),
|
||||
username: 'u1',
|
||||
nickname: 'U1',
|
||||
email: 'u1@test.com',
|
||||
email_verified: true,
|
||||
phone: null,
|
||||
avatar_url: null,
|
||||
role: 1,
|
||||
created_at: new Date('2025-01-01T00:00:00Z'),
|
||||
updated_at: new Date('2025-01-02T00:00:00Z'),
|
||||
} as unknown as Users;
|
||||
|
||||
usersServiceMock.findAll.mockResolvedValue([user]);
|
||||
|
||||
const res = await service.listUsers(100, 0);
|
||||
|
||||
expect(usersServiceMock.findAll).toHaveBeenCalledWith(100, 0);
|
||||
expect(res.success).toBe(true);
|
||||
expect(res.data?.users).toHaveLength(1);
|
||||
expect(res.data?.users[0]).toMatchObject({
|
||||
id: '1',
|
||||
username: 'u1',
|
||||
nickname: 'U1',
|
||||
role: 1,
|
||||
});
|
||||
});
|
||||
|
||||
it('should get user by id', async () => {
|
||||
const user = {
|
||||
id: BigInt(3),
|
||||
username: 'u3',
|
||||
nickname: 'U3',
|
||||
email: null,
|
||||
email_verified: false,
|
||||
phone: '123',
|
||||
avatar_url: null,
|
||||
role: 1,
|
||||
created_at: new Date('2025-01-01T00:00:00Z'),
|
||||
updated_at: new Date('2025-01-02T00:00:00Z'),
|
||||
} as unknown as Users;
|
||||
|
||||
usersServiceMock.findOne.mockResolvedValue(user);
|
||||
|
||||
const res = await service.getUser(BigInt(3));
|
||||
|
||||
expect(usersServiceMock.findOne).toHaveBeenCalledWith(BigInt(3));
|
||||
expect(res.success).toBe(true);
|
||||
expect(res.data?.user).toMatchObject({ id: '3', username: 'u3', nickname: 'U3' });
|
||||
});
|
||||
|
||||
it('should reset user password', async () => {
|
||||
usersServiceMock.findOne.mockResolvedValue({ id: BigInt(2) } as unknown as Users);
|
||||
(adminCoreServiceMock.resetUserPassword as jest.Mock).mockResolvedValue(undefined);
|
||||
|
||||
const res = await service.resetPassword(BigInt(2), 'NewPass1234');
|
||||
|
||||
expect(usersServiceMock.findOne).toHaveBeenCalledWith(BigInt(2));
|
||||
expect(adminCoreServiceMock.resetUserPassword).toHaveBeenCalledWith(BigInt(2), 'NewPass1234');
|
||||
expect(res).toEqual({ success: true, message: '密码重置成功' });
|
||||
});
|
||||
|
||||
it('should throw NotFoundException when resetting password for missing user', async () => {
|
||||
usersServiceMock.findOne.mockRejectedValue(new Error('not found'));
|
||||
|
||||
await expect(service.resetPassword(BigInt(999), 'NewPass1234')).rejects.toBeInstanceOf(NotFoundException);
|
||||
});
|
||||
|
||||
it('should get runtime logs', async () => {
|
||||
(logManagementServiceMock.getRuntimeLogTail as jest.Mock).mockResolvedValue({
|
||||
file: 'dev.log',
|
||||
updated_at: '2025-01-01T00:00:00.000Z',
|
||||
lines: ['a', 'b'],
|
||||
});
|
||||
|
||||
const res = await service.getRuntimeLogs(2);
|
||||
|
||||
expect(logManagementServiceMock.getRuntimeLogTail).toHaveBeenCalledWith({ lines: 2 });
|
||||
expect(res.success).toBe(true);
|
||||
expect(res.data?.file).toBe('dev.log');
|
||||
expect(res.data?.lines).toEqual(['a', 'b']);
|
||||
});
|
||||
|
||||
it('should expose log dir absolute path', () => {
|
||||
(logManagementServiceMock.getLogDirAbsolutePath as jest.Mock).mockReturnValue('/abs/logs');
|
||||
|
||||
expect(service.getLogDirAbsolutePath()).toBe('/abs/logs');
|
||||
expect(logManagementServiceMock.getLogDirAbsolutePath).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
// 测试新增的用户状态管理方法
|
||||
describe('updateUserStatus', () => {
|
||||
const mockUser = {
|
||||
id: BigInt(1),
|
||||
username: 'testuser',
|
||||
status: UserStatus.ACTIVE
|
||||
} as unknown as Users;
|
||||
|
||||
it('should update user status successfully', async () => {
|
||||
usersServiceMock.findOne.mockResolvedValue(mockUser);
|
||||
usersServiceMock.update.mockResolvedValue({ ...mockUser, status: UserStatus.INACTIVE });
|
||||
|
||||
const result = await service.updateUserStatus(BigInt(1), { status: UserStatus.INACTIVE, reason: 'test' });
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.message).toBe('用户状态修改成功');
|
||||
});
|
||||
|
||||
it('should throw NotFoundException when user not found', async () => {
|
||||
usersServiceMock.findOne.mockResolvedValue(null);
|
||||
|
||||
await expect(service.updateUserStatus(BigInt(999), { status: UserStatus.INACTIVE, reason: 'test' }))
|
||||
.rejects.toThrow(NotFoundException);
|
||||
});
|
||||
|
||||
it('should return error when status unchanged', async () => {
|
||||
usersServiceMock.findOne.mockResolvedValue({ ...mockUser, status: UserStatus.INACTIVE });
|
||||
|
||||
await expect(service.updateUserStatus(BigInt(1), { status: UserStatus.INACTIVE, reason: 'test' }))
|
||||
.rejects.toThrow(BadRequestException);
|
||||
});
|
||||
});
|
||||
|
||||
describe('batchUpdateUserStatus', () => {
|
||||
it('should batch update user status successfully', async () => {
|
||||
const mockUsers = [
|
||||
{ id: BigInt(1), username: 'user1', status: UserStatus.ACTIVE },
|
||||
{ id: BigInt(2), username: 'user2', status: UserStatus.ACTIVE }
|
||||
] as unknown as Users[];
|
||||
|
||||
usersServiceMock.findOne
|
||||
.mockResolvedValueOnce(mockUsers[0])
|
||||
.mockResolvedValueOnce(mockUsers[1]);
|
||||
|
||||
usersServiceMock.update
|
||||
.mockResolvedValueOnce({ ...mockUsers[0], status: UserStatus.INACTIVE })
|
||||
.mockResolvedValueOnce({ ...mockUsers[1], status: UserStatus.INACTIVE });
|
||||
|
||||
const result = await service.batchUpdateUserStatus({
|
||||
userIds: ['1', '2'],
|
||||
status: UserStatus.INACTIVE,
|
||||
reason: 'batch test'
|
||||
});
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data?.result.success_count).toBe(2);
|
||||
expect(result.data?.result.failed_count).toBe(0);
|
||||
});
|
||||
|
||||
it('should handle mixed success and failure', async () => {
|
||||
usersServiceMock.findOne
|
||||
.mockResolvedValueOnce({ id: BigInt(1), status: UserStatus.ACTIVE })
|
||||
.mockResolvedValueOnce(null); // User not found
|
||||
|
||||
usersServiceMock.update.mockResolvedValueOnce({ id: BigInt(1), status: UserStatus.INACTIVE });
|
||||
|
||||
const result = await service.batchUpdateUserStatus({
|
||||
userIds: ['1', '999'],
|
||||
status: UserStatus.INACTIVE,
|
||||
reason: 'mixed test'
|
||||
});
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data?.result.success_count).toBe(1);
|
||||
expect(result.data?.result.failed_count).toBe(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUserStatusStats', () => {
|
||||
it('should return user status statistics', async () => {
|
||||
const mockUsers = [
|
||||
{ status: UserStatus.ACTIVE },
|
||||
{ status: UserStatus.ACTIVE },
|
||||
{ status: UserStatus.INACTIVE },
|
||||
{ status: null } // Should default to active
|
||||
] as unknown as Users[];
|
||||
|
||||
usersServiceMock.findAll.mockResolvedValue(mockUsers);
|
||||
|
||||
const result = await service.getUserStatusStats();
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data?.stats.active).toBe(3); // 2 active + 1 null (defaults to active)
|
||||
expect(result.data?.stats.inactive).toBe(1);
|
||||
expect(result.data?.stats.total).toBe(4);
|
||||
});
|
||||
|
||||
it('should handle error when getting stats', async () => {
|
||||
usersServiceMock.findAll.mockRejectedValue(new Error('Database error'));
|
||||
|
||||
const result = await service.getUserStatusStats();
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('USER_STATUS_STATS_FAILED');
|
||||
});
|
||||
});
|
||||
});
|
||||
592
src/business/admin/admin.service.ts
Normal file
592
src/business/admin/admin.service.ts
Normal file
@@ -0,0 +1,592 @@
|
||||
/**
|
||||
* 管理员业务服务
|
||||
*
|
||||
* 功能描述:
|
||||
* - 管理员登录认证业务逻辑
|
||||
* - 用户管理业务功能(查询、密码重置、状态管理)
|
||||
* - 系统日志管理功能
|
||||
*
|
||||
* 职责分离:
|
||||
* - 业务逻辑编排和数据格式化
|
||||
* - 调用核心服务完成具体操作
|
||||
* - 异常处理和日志记录
|
||||
*
|
||||
* 主要方法:
|
||||
* - login() - 管理员登录认证
|
||||
* - listUsers() - 用户列表查询
|
||||
* - getUser() - 单个用户查询
|
||||
* - resetPassword() - 重置用户密码
|
||||
* - updateUserStatus() - 修改用户状态
|
||||
* - batchUpdateUserStatus() - 批量修改用户状态
|
||||
* - getUserStatusStats() - 获取用户状态统计
|
||||
* - getRuntimeLogs() - 获取运行日志
|
||||
*
|
||||
* 使用场景:
|
||||
* - 后台管理系统的业务逻辑处理
|
||||
* - 管理员权限相关的业务操作
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
* - 2026-01-08: 注释规范优化 - 补充方法注释,添加@param、@returns、@throws和@example (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.2
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Inject, Injectable, Logger, NotFoundException, BadRequestException } from '@nestjs/common';
|
||||
import { AdminCoreService } from '../../core/admin_core/admin_core.service';
|
||||
import { Users } from '../../core/db/users/users.entity';
|
||||
import { UsersService } from '../../core/db/users/users.service';
|
||||
import { UsersMemoryService } from '../../core/db/users/users_memory.service';
|
||||
import { LogManagementService } from '../../core/utils/logger/log_management.service';
|
||||
import { UserStatus, getUserStatusDescription } from '../user_mgmt/user_status.enum';
|
||||
import { UserStatusDto, BatchUserStatusDto } from '../user_mgmt/user_status.dto';
|
||||
import { getCurrentTimestamp } from './admin_utils';
|
||||
import { USER_QUERY_LIMITS } from './admin_constants';
|
||||
import {
|
||||
UserStatusResponseDto,
|
||||
BatchUserStatusResponseDto,
|
||||
UserStatusStatsResponseDto,
|
||||
UserStatusInfoDto,
|
||||
BatchOperationResultDto
|
||||
} from '../user_mgmt/user_status_response.dto';
|
||||
|
||||
export interface AdminApiResponse<T = any> {
|
||||
success: boolean;
|
||||
data?: T;
|
||||
message: string;
|
||||
error_code?: string;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class AdminService {
|
||||
private readonly logger = new Logger(AdminService.name);
|
||||
|
||||
constructor(
|
||||
private readonly adminCoreService: AdminCoreService,
|
||||
@Inject('UsersService') private readonly usersService: UsersService | UsersMemoryService,
|
||||
private readonly logManagementService: LogManagementService,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* 记录操作日志
|
||||
*
|
||||
* @param level 日志级别
|
||||
* @param message 日志消息
|
||||
* @param context 日志上下文
|
||||
*/
|
||||
private logOperation(level: 'log' | 'warn' | 'error', message: string, context: Record<string, any>): void {
|
||||
this.logger[level](message, {
|
||||
...context,
|
||||
timestamp: getCurrentTimestamp()
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取日志目录绝对路径
|
||||
*
|
||||
* @returns 日志目录的绝对路径
|
||||
*/
|
||||
getLogDirAbsolutePath(): string {
|
||||
return this.logManagementService.getLogDirAbsolutePath();
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员登录
|
||||
*
|
||||
* 功能描述:
|
||||
* 验证管理员身份并生成JWT Token
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 调用核心服务验证登录信息
|
||||
* 2. 生成JWT Token
|
||||
* 3. 返回登录结果
|
||||
*
|
||||
* @param identifier 登录标识符(用户名/邮箱/手机号)
|
||||
* @param password 密码
|
||||
* @returns 登录结果,包含Token和管理员信息
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminService.login('admin', 'password123');
|
||||
* ```
|
||||
*/
|
||||
async login(identifier: string, password: string): Promise<AdminApiResponse> {
|
||||
try {
|
||||
const result = await this.adminCoreService.login({ identifier, password });
|
||||
return { success: true, data: result, message: '管理员登录成功' };
|
||||
} catch (error) {
|
||||
this.logger.error(`管理员登录失败: ${identifier}`, error instanceof Error ? error.stack : String(error));
|
||||
return {
|
||||
success: false,
|
||||
message: error instanceof Error ? error.message : '管理员登录失败',
|
||||
error_code: 'ADMIN_LOGIN_FAILED',
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
*
|
||||
* 功能描述:
|
||||
* 分页获取系统中的用户列表
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 调用用户服务获取用户数据
|
||||
* 2. 格式化用户信息
|
||||
* 3. 返回分页结果
|
||||
*
|
||||
* @param limit 返回数量限制
|
||||
* @param offset 偏移量
|
||||
* @returns 用户列表和分页信息
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminService.listUsers(20, 0);
|
||||
* ```
|
||||
*/
|
||||
async listUsers(limit: number, offset: number): Promise<AdminApiResponse<{ users: any[]; limit: number; offset: number }>> {
|
||||
const users = await this.usersService.findAll(limit, offset);
|
||||
return {
|
||||
success: true,
|
||||
data: {
|
||||
users: users.map((u: Users) => this.formatUser(u)),
|
||||
limit,
|
||||
offset,
|
||||
},
|
||||
message: '用户列表获取成功',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取用户详情
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据用户ID获取指定用户的详细信息
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 查询用户信息
|
||||
* 2. 格式化用户数据
|
||||
* 3. 返回用户详情
|
||||
*
|
||||
* @param id 用户ID
|
||||
* @returns 用户详细信息
|
||||
*
|
||||
* @throws NotFoundException 当用户不存在时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminService.getUser(BigInt(123));
|
||||
* ```
|
||||
*/
|
||||
async getUser(id: bigint): Promise<AdminApiResponse<{ user: any }>> {
|
||||
const user = await this.usersService.findOne(id);
|
||||
return {
|
||||
success: true,
|
||||
data: { user: this.formatUser(user) },
|
||||
message: '用户信息获取成功',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 重置用户密码
|
||||
*
|
||||
* 功能描述:
|
||||
* 管理员直接为指定用户设置新密码
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户是否存在
|
||||
* 2. 调用核心服务重置密码
|
||||
* 3. 记录操作日志
|
||||
* 4. 返回重置结果
|
||||
*
|
||||
* @param id 用户ID
|
||||
* @param newPassword 新密码
|
||||
* @returns 重置结果
|
||||
*
|
||||
* @throws NotFoundException 当用户不存在时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminService.resetPassword(BigInt(123), 'NewPass1234');
|
||||
* ```
|
||||
*/
|
||||
async resetPassword(id: bigint, newPassword: string): Promise<AdminApiResponse> {
|
||||
// 确认用户存在
|
||||
const user = await this.usersService.findOne(id).catch((): null => null);
|
||||
if (!user) {
|
||||
throw new NotFoundException('用户不存在');
|
||||
}
|
||||
|
||||
await this.adminCoreService.resetUserPassword(id, newPassword);
|
||||
|
||||
this.logger.log(`管理员重置密码成功: userId=${id.toString()}`);
|
||||
|
||||
return { success: true, message: '密码重置成功' };
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取运行日志
|
||||
*
|
||||
* 功能描述:
|
||||
* 获取系统运行日志的尾部内容
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 调用日志管理服务获取日志
|
||||
* 2. 返回日志内容和元信息
|
||||
*
|
||||
* @param lines 返回的日志行数,可选参数
|
||||
* @returns 日志内容和元信息
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await adminService.getRuntimeLogs(200);
|
||||
* ```
|
||||
*/
|
||||
async getRuntimeLogs(lines?: number): Promise<AdminApiResponse<{ file: string; updated_at: string; lines: string[] }>> {
|
||||
const result = await this.logManagementService.getRuntimeLogTail({ lines });
|
||||
return {
|
||||
success: true,
|
||||
data: result,
|
||||
message: '运行日志获取成功',
|
||||
};
|
||||
}
|
||||
|
||||
private formatUser(user: Users) {
|
||||
return {
|
||||
id: user.id.toString(),
|
||||
username: user.username,
|
||||
nickname: user.nickname,
|
||||
email: user.email,
|
||||
email_verified: user.email_verified,
|
||||
phone: user.phone,
|
||||
avatar_url: user.avatar_url,
|
||||
role: user.role,
|
||||
status: user.status || UserStatus.ACTIVE, // 兼容旧数据
|
||||
created_at: user.created_at,
|
||||
updated_at: user.updated_at,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 格式化用户状态信息
|
||||
*
|
||||
* @param user 用户实体
|
||||
* @returns 格式化的用户状态信息
|
||||
*/
|
||||
private formatUserStatus(user: Users): UserStatusInfoDto {
|
||||
return {
|
||||
id: user.id.toString(),
|
||||
username: user.username,
|
||||
nickname: user.nickname,
|
||||
status: user.status || UserStatus.ACTIVE,
|
||||
status_description: getUserStatusDescription(user.status || UserStatus.ACTIVE),
|
||||
updated_at: user.updated_at
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 修改用户状态
|
||||
*
|
||||
* 功能描述:
|
||||
* 管理员修改指定用户的账户状态,支持激活、锁定、禁用等操作
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户是否存在
|
||||
* 2. 检查状态变更的合法性
|
||||
* 3. 更新用户状态
|
||||
* 4. 记录状态变更日志
|
||||
*
|
||||
* @param userId 用户ID
|
||||
* @param userStatusDto 状态修改数据
|
||||
* @returns 修改结果
|
||||
*
|
||||
* @throws NotFoundException 当用户不存在时
|
||||
* @throws BadRequestException 当状态变更不合法时
|
||||
*/
|
||||
async updateUserStatus(userId: bigint, userStatusDto: UserStatusDto): Promise<UserStatusResponseDto> {
|
||||
try {
|
||||
this.logOperation('log', '开始修改用户状态', {
|
||||
operation: 'update_user_status',
|
||||
userId: userId.toString(),
|
||||
newStatus: userStatusDto.status,
|
||||
reason: userStatusDto.reason
|
||||
});
|
||||
|
||||
// 1. 验证用户是否存在
|
||||
const user = await this.usersService.findOne(userId);
|
||||
if (!user) {
|
||||
this.logOperation('warn', '修改用户状态失败:用户不存在', {
|
||||
operation: 'update_user_status',
|
||||
userId: userId.toString()
|
||||
});
|
||||
throw new NotFoundException('用户不存在');
|
||||
}
|
||||
|
||||
// 2. 检查状态变更的合法性
|
||||
if (user.status === userStatusDto.status) {
|
||||
this.logOperation('warn', '修改用户状态失败:状态未发生变化', {
|
||||
operation: 'update_user_status',
|
||||
userId: userId.toString(),
|
||||
currentStatus: user.status,
|
||||
newStatus: userStatusDto.status
|
||||
});
|
||||
throw new BadRequestException('用户状态未发生变化');
|
||||
}
|
||||
|
||||
// 3. 更新用户状态
|
||||
const updatedUser = await this.usersService.update(userId, {
|
||||
status: userStatusDto.status
|
||||
});
|
||||
|
||||
// 4. 记录状态变更日志
|
||||
this.logOperation('log', '用户状态修改成功', {
|
||||
operation: 'update_user_status',
|
||||
userId: userId.toString(),
|
||||
oldStatus: user.status,
|
||||
newStatus: userStatusDto.status,
|
||||
reason: userStatusDto.reason
|
||||
});
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: {
|
||||
user: this.formatUserStatus(updatedUser),
|
||||
reason: userStatusDto.reason
|
||||
},
|
||||
message: '用户状态修改成功'
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
this.logOperation('error', '修改用户状态失败', {
|
||||
operation: 'update_user_status',
|
||||
userId: userId.toString(),
|
||||
error: error instanceof Error ? error.message : String(error)
|
||||
});
|
||||
|
||||
if (error instanceof NotFoundException || error instanceof BadRequestException) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
return {
|
||||
success: false,
|
||||
message: '用户状态修改失败',
|
||||
error_code: 'USER_STATUS_UPDATE_FAILED'
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 处理单个用户状态修改
|
||||
*
|
||||
* @param userIdStr 用户ID字符串
|
||||
* @param newStatus 新状态
|
||||
* @returns 处理结果
|
||||
*/
|
||||
private async processSingleUserStatus(
|
||||
userIdStr: string,
|
||||
newStatus: UserStatus
|
||||
): Promise<{ success: true; user: UserStatusInfoDto } | { success: false; error: string }> {
|
||||
try {
|
||||
const userId = BigInt(userIdStr);
|
||||
|
||||
// 验证用户是否存在
|
||||
const user = await this.usersService.findOne(userId);
|
||||
if (!user) {
|
||||
return { success: false, error: '用户不存在' };
|
||||
}
|
||||
|
||||
// 检查状态是否需要变更
|
||||
if (user.status === newStatus) {
|
||||
return { success: false, error: '用户状态未发生变化' };
|
||||
}
|
||||
|
||||
// 更新用户状态
|
||||
const updatedUser = await this.usersService.update(userId, { status: newStatus });
|
||||
return { success: true, user: this.formatUserStatus(updatedUser) };
|
||||
|
||||
} catch (error) {
|
||||
return {
|
||||
success: false,
|
||||
error: error instanceof Error ? error.message : '未知错误'
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 批量修改用户状态
|
||||
*
|
||||
* 功能描述:
|
||||
* 管理员批量修改多个用户的账户状态
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户ID列表
|
||||
* 2. 逐个处理用户状态修改
|
||||
* 3. 收集成功和失败的结果
|
||||
* 4. 返回批量操作结果
|
||||
*
|
||||
* @param batchUserStatusDto 批量状态修改数据
|
||||
* @returns 批量修改结果
|
||||
*/
|
||||
async batchUpdateUserStatus(batchUserStatusDto: BatchUserStatusDto): Promise<BatchUserStatusResponseDto> {
|
||||
try {
|
||||
this.logOperation('log', '开始批量修改用户状态', {
|
||||
operation: 'batch_update_user_status',
|
||||
userCount: batchUserStatusDto.userIds.length,
|
||||
newStatus: batchUserStatusDto.status,
|
||||
reason: batchUserStatusDto.reason
|
||||
});
|
||||
|
||||
const successUsers: UserStatusInfoDto[] = [];
|
||||
const failedUsers: Array<{ user_id: string; error: string }> = [];
|
||||
|
||||
// 逐个处理用户状态修改
|
||||
for (const userIdStr of batchUserStatusDto.userIds) {
|
||||
const result = await this.processSingleUserStatus(userIdStr, batchUserStatusDto.status);
|
||||
|
||||
if (result.success) {
|
||||
successUsers.push(result.user);
|
||||
} else {
|
||||
failedUsers.push({ user_id: userIdStr, error: (result as { success: false; error: string }).error });
|
||||
}
|
||||
}
|
||||
|
||||
// 构建批量操作结果
|
||||
const operationResult: BatchOperationResultDto = {
|
||||
success_users: successUsers,
|
||||
failed_users: failedUsers,
|
||||
success_count: successUsers.length,
|
||||
failed_count: failedUsers.length,
|
||||
total_count: batchUserStatusDto.userIds.length
|
||||
};
|
||||
|
||||
this.logOperation('log', '批量修改用户状态完成', {
|
||||
operation: 'batch_update_user_status',
|
||||
successCount: operationResult.success_count,
|
||||
failedCount: operationResult.failed_count,
|
||||
totalCount: operationResult.total_count
|
||||
});
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: {
|
||||
result: operationResult,
|
||||
reason: batchUserStatusDto.reason
|
||||
},
|
||||
message: `批量用户状态修改完成,成功:${operationResult.success_count},失败:${operationResult.failed_count}`
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
this.logOperation('error', '批量修改用户状态失败', {
|
||||
operation: 'batch_update_user_status',
|
||||
error: error instanceof Error ? error.message : String(error)
|
||||
});
|
||||
|
||||
return {
|
||||
success: false,
|
||||
message: '批量用户状态修改失败',
|
||||
error_code: 'BATCH_USER_STATUS_UPDATE_FAILED'
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 计算用户状态统计
|
||||
*
|
||||
* @param users 用户列表
|
||||
* @returns 状态统计结果
|
||||
*/
|
||||
private calculateUserStatusStats(users: Users[]) {
|
||||
const stats = {
|
||||
active: 0,
|
||||
inactive: 0,
|
||||
locked: 0,
|
||||
banned: 0,
|
||||
deleted: 0,
|
||||
pending: 0,
|
||||
total: users.length
|
||||
};
|
||||
|
||||
users.forEach((user: Users) => {
|
||||
const status = user.status || UserStatus.ACTIVE;
|
||||
switch (status) {
|
||||
case UserStatus.ACTIVE:
|
||||
stats.active++;
|
||||
break;
|
||||
case UserStatus.INACTIVE:
|
||||
stats.inactive++;
|
||||
break;
|
||||
case UserStatus.LOCKED:
|
||||
stats.locked++;
|
||||
break;
|
||||
case UserStatus.BANNED:
|
||||
stats.banned++;
|
||||
break;
|
||||
case UserStatus.DELETED:
|
||||
stats.deleted++;
|
||||
break;
|
||||
case UserStatus.PENDING:
|
||||
stats.pending++;
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
return stats;
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取用户状态统计
|
||||
*
|
||||
* 功能描述:
|
||||
* 获取各种用户状态的数量统计信息
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 查询所有用户
|
||||
* 2. 按状态分组统计
|
||||
* 3. 计算各状态数量
|
||||
* 4. 返回统计结果
|
||||
*
|
||||
* @returns 状态统计信息
|
||||
*/
|
||||
async getUserStatusStats(): Promise<UserStatusStatsResponseDto> {
|
||||
try {
|
||||
this.logOperation('log', '开始获取用户状态统计', {
|
||||
operation: 'get_user_status_stats'
|
||||
});
|
||||
|
||||
// 查询所有用户(这里可以优化为直接查询统计信息)
|
||||
const allUsers = await this.usersService.findAll(USER_QUERY_LIMITS.MAX_USERS_FOR_STATS, 0);
|
||||
|
||||
// 计算各状态数量
|
||||
const stats = this.calculateUserStatusStats(allUsers);
|
||||
|
||||
this.logOperation('log', '用户状态统计获取成功', {
|
||||
operation: 'get_user_status_stats',
|
||||
stats
|
||||
});
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: {
|
||||
stats,
|
||||
timestamp: getCurrentTimestamp()
|
||||
},
|
||||
message: '用户状态统计获取成功'
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
this.logOperation('error', '获取用户状态统计失败', {
|
||||
operation: 'get_user_status_stats',
|
||||
error: error instanceof Error ? error.message : String(error)
|
||||
});
|
||||
|
||||
return {
|
||||
success: false,
|
||||
message: '用户状态统计获取失败',
|
||||
error_code: 'USER_STATUS_STATS_FAILED'
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
185
src/business/admin/admin_constants.ts
Normal file
185
src/business/admin/admin_constants.ts
Normal file
@@ -0,0 +1,185 @@
|
||||
/**
|
||||
* 管理员模块常量定义
|
||||
*
|
||||
* 功能描述:
|
||||
* - 定义管理员模块使用的所有常量
|
||||
* - 统一管理配置参数和限制值
|
||||
* - 避免魔法数字的使用
|
||||
* - 提供类型安全的常量访问
|
||||
*
|
||||
* 职责分离:
|
||||
* - 常量集中管理
|
||||
* - 配置参数定义
|
||||
* - 限制值设定
|
||||
* - 敏感字段标识
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 代码质量优化 - 添加日志查询限制和请求ID配置常量,补充用户查询限制常量 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员模块常量定义文件 (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.2.0
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
/**
|
||||
* 分页限制常量
|
||||
*/
|
||||
export const PAGINATION_LIMITS = {
|
||||
/** 默认每页数量 */
|
||||
DEFAULT_LIMIT: 20,
|
||||
/** 默认偏移量 */
|
||||
DEFAULT_OFFSET: 0,
|
||||
/** 用户列表最大每页数量 */
|
||||
USER_LIST_MAX_LIMIT: 100,
|
||||
/** 搜索结果最大每页数量 */
|
||||
SEARCH_MAX_LIMIT: 50,
|
||||
/** 日志列表最大每页数量 */
|
||||
LOG_LIST_MAX_LIMIT: 200,
|
||||
/** 批量操作最大数量 */
|
||||
BATCH_OPERATION_MAX_SIZE: 100
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 请求ID前缀常量
|
||||
*/
|
||||
export const REQUEST_ID_PREFIXES = {
|
||||
/** 通用请求 */
|
||||
GENERAL: 'req',
|
||||
/** 错误请求 */
|
||||
ERROR: 'err',
|
||||
/** 管理员操作 */
|
||||
ADMIN_OPERATION: 'admin',
|
||||
/** 数据库操作 */
|
||||
DATABASE_OPERATION: 'db',
|
||||
/** 健康检查 */
|
||||
HEALTH_CHECK: 'health',
|
||||
/** 日志操作 */
|
||||
LOG_OPERATION: 'log'
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 敏感字段列表
|
||||
*/
|
||||
export const SENSITIVE_FIELDS = [
|
||||
'password',
|
||||
'password_hash',
|
||||
'newPassword',
|
||||
'oldPassword',
|
||||
'token',
|
||||
'api_key',
|
||||
'secret',
|
||||
'private_key',
|
||||
'zulipApiKeyEncrypted'
|
||||
] as const;
|
||||
|
||||
/**
|
||||
* 日志保留策略常量
|
||||
*/
|
||||
export const LOG_RETENTION = {
|
||||
/** 默认保留天数 */
|
||||
DEFAULT_DAYS: 90,
|
||||
/** 最少保留天数 */
|
||||
MIN_DAYS: 7,
|
||||
/** 最多保留天数 */
|
||||
MAX_DAYS: 365,
|
||||
/** 敏感操作日志保留天数 */
|
||||
SENSITIVE_OPERATION_DAYS: 180
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 操作类型常量
|
||||
*/
|
||||
export const OPERATION_TYPES = {
|
||||
CREATE: 'CREATE',
|
||||
UPDATE: 'UPDATE',
|
||||
DELETE: 'DELETE',
|
||||
QUERY: 'QUERY',
|
||||
BATCH: 'BATCH'
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 目标类型常量
|
||||
*/
|
||||
export const TARGET_TYPES = {
|
||||
USERS: 'users',
|
||||
USER_PROFILES: 'user_profiles',
|
||||
ZULIP_ACCOUNTS: 'zulip_accounts',
|
||||
ADMIN_LOGS: 'admin_logs'
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 操作结果常量
|
||||
*/
|
||||
export const OPERATION_RESULTS = {
|
||||
SUCCESS: 'SUCCESS',
|
||||
FAILED: 'FAILED'
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 错误码常量
|
||||
*/
|
||||
export const ERROR_CODES = {
|
||||
BAD_REQUEST: 'BAD_REQUEST',
|
||||
UNAUTHORIZED: 'UNAUTHORIZED',
|
||||
FORBIDDEN: 'FORBIDDEN',
|
||||
NOT_FOUND: 'NOT_FOUND',
|
||||
CONFLICT: 'CONFLICT',
|
||||
UNPROCESSABLE_ENTITY: 'UNPROCESSABLE_ENTITY',
|
||||
TOO_MANY_REQUESTS: 'TOO_MANY_REQUESTS',
|
||||
INTERNAL_SERVER_ERROR: 'INTERNAL_SERVER_ERROR',
|
||||
BAD_GATEWAY: 'BAD_GATEWAY',
|
||||
SERVICE_UNAVAILABLE: 'SERVICE_UNAVAILABLE',
|
||||
GATEWAY_TIMEOUT: 'GATEWAY_TIMEOUT',
|
||||
UNKNOWN_ERROR: 'UNKNOWN_ERROR'
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* HTTP状态码常量
|
||||
*/
|
||||
export const HTTP_STATUS = {
|
||||
OK: 200,
|
||||
CREATED: 201,
|
||||
BAD_REQUEST: 400,
|
||||
UNAUTHORIZED: 401,
|
||||
FORBIDDEN: 403,
|
||||
NOT_FOUND: 404,
|
||||
CONFLICT: 409,
|
||||
UNPROCESSABLE_ENTITY: 422,
|
||||
TOO_MANY_REQUESTS: 429,
|
||||
INTERNAL_SERVER_ERROR: 500,
|
||||
BAD_GATEWAY: 502,
|
||||
SERVICE_UNAVAILABLE: 503,
|
||||
GATEWAY_TIMEOUT: 504
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 缓存键前缀常量
|
||||
*/
|
||||
export const CACHE_KEYS = {
|
||||
USER_LIST: 'admin:users:list',
|
||||
USER_PROFILE_LIST: 'admin:profiles:list',
|
||||
ZULIP_ACCOUNT_LIST: 'admin:zulip:list',
|
||||
STATISTICS: 'admin:stats'
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 日志查询限制常量
|
||||
*/
|
||||
export const LOG_QUERY_LIMITS = {
|
||||
/** 默认日志查询每页数量 */
|
||||
DEFAULT_LOG_QUERY_LIMIT: 50,
|
||||
/** 敏感操作日志默认查询数量 */
|
||||
SENSITIVE_LOG_DEFAULT_LIMIT: 50
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* 用户查询限制常量
|
||||
*/
|
||||
export const USER_QUERY_LIMITS = {
|
||||
/** 用户状态统计查询的最大用户数 */
|
||||
MAX_USERS_FOR_STATS: 10000,
|
||||
/** 管理员操作历史默认查询数量 */
|
||||
ADMIN_HISTORY_DEFAULT_LIMIT: 20
|
||||
} as const;
|
||||
400
src/business/admin/admin_database.controller.ts
Normal file
400
src/business/admin/admin_database.controller.ts
Normal file
@@ -0,0 +1,400 @@
|
||||
/**
|
||||
* 管理员数据库管理控制器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供管理员专用的数据库管理HTTP接口
|
||||
* - 集成用户、用户档案、Zulip账号关联的CRUD操作
|
||||
* - 实现统一的权限控制和参数验证
|
||||
* - 支持分页查询和搜索功能
|
||||
*
|
||||
* 职责分离:
|
||||
* - HTTP请求处理:接收和验证HTTP请求参数
|
||||
* - 权限控制:通过AdminGuard确保只有管理员可以访问
|
||||
* - 业务委托:将业务逻辑委托给DatabaseManagementService处理
|
||||
* - 响应格式化:返回统一格式的HTTP响应
|
||||
*
|
||||
* API端点分组:
|
||||
* - /admin/database/users/* 用户管理相关接口
|
||||
* - /admin/database/user-profiles/* 用户档案管理相关接口
|
||||
* - /admin/database/zulip-accounts/* Zulip账号关联管理相关接口
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 代码质量优化 - 清理未使用的导入 (修改者: moyin)
|
||||
* - 2026-01-08: 文件夹扁平化 - 从controllers/子文件夹移动到上级目录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员数据库管理控制器 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.1.0
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import {
|
||||
Controller,
|
||||
Get,
|
||||
Post,
|
||||
Put,
|
||||
Delete,
|
||||
Param,
|
||||
Query,
|
||||
Body,
|
||||
UseGuards,
|
||||
UseFilters,
|
||||
UseInterceptors,
|
||||
ParseIntPipe,
|
||||
DefaultValuePipe
|
||||
} from '@nestjs/common';
|
||||
import {
|
||||
ApiTags,
|
||||
ApiBearerAuth,
|
||||
ApiOperation,
|
||||
ApiParam,
|
||||
ApiQuery,
|
||||
ApiResponse,
|
||||
ApiBody
|
||||
} from '@nestjs/swagger';
|
||||
import { AdminGuard } from './admin.guard';
|
||||
import { AdminDatabaseExceptionFilter } from './admin_database_exception.filter';
|
||||
import { AdminOperationLogInterceptor } from './admin_operation_log.interceptor';
|
||||
import { LogAdminOperation } from './log_admin_operation.decorator';
|
||||
import { DatabaseManagementService, AdminApiResponse, AdminListResponse } from './database_management.service';
|
||||
import {
|
||||
AdminCreateUserDto,
|
||||
AdminUpdateUserDto,
|
||||
AdminBatchUpdateStatusDto,
|
||||
AdminDatabaseResponseDto,
|
||||
AdminHealthCheckResponseDto
|
||||
} from './admin_database.dto';
|
||||
import { PAGINATION_LIMITS, REQUEST_ID_PREFIXES } from './admin_constants';
|
||||
import { safeLimitValue, createSuccessResponse, getCurrentTimestamp } from './admin_utils';
|
||||
|
||||
@ApiTags('admin-database')
|
||||
@Controller('admin/database')
|
||||
@UseGuards(AdminGuard)
|
||||
@UseFilters(AdminDatabaseExceptionFilter)
|
||||
@UseInterceptors(AdminOperationLogInterceptor)
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
export class AdminDatabaseController {
|
||||
constructor(
|
||||
private readonly databaseManagementService: DatabaseManagementService
|
||||
) {}
|
||||
|
||||
// ==================== 用户管理接口 ====================
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取用户列表',
|
||||
description: '分页获取用户列表,支持管理员查看所有用户信息'
|
||||
})
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认20,最大100)', example: 20 })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)', example: 0 })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@ApiResponse({ status: 401, description: '未授权访问' })
|
||||
@ApiResponse({ status: 403, description: '权限不足' })
|
||||
@LogAdminOperation({
|
||||
operationType: 'QUERY',
|
||||
targetType: 'users',
|
||||
description: '获取用户列表',
|
||||
isSensitive: false
|
||||
})
|
||||
@Get('users')
|
||||
async getUserList(
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number,
|
||||
@Query('offset', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_OFFSET), ParseIntPipe) offset: number
|
||||
): Promise<AdminListResponse> {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.USER_LIST_MAX_LIMIT);
|
||||
return await this.databaseManagementService.getUserList(safeLimit, offset);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取用户详情',
|
||||
description: '根据用户ID获取详细的用户信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '用户ID', example: '1' })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@ApiResponse({ status: 404, description: '用户不存在' })
|
||||
@Get('users/:id')
|
||||
async getUserById(@Param('id') id: string): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.getUserById(BigInt(id));
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '搜索用户',
|
||||
description: '根据关键词搜索用户,支持用户名、邮箱、昵称模糊匹配'
|
||||
})
|
||||
@ApiQuery({ name: 'keyword', description: '搜索关键词', example: 'admin' })
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认20,最大50)', example: 20 })
|
||||
@ApiResponse({ status: 200, description: '搜索成功' })
|
||||
@Get('users/search')
|
||||
async searchUsers(
|
||||
@Query('keyword') keyword: string,
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number
|
||||
): Promise<AdminListResponse> {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.SEARCH_MAX_LIMIT);
|
||||
return await this.databaseManagementService.searchUsers(keyword, safeLimit);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '创建用户',
|
||||
description: '创建新用户,需要提供用户名和昵称等基本信息'
|
||||
})
|
||||
@ApiBody({ type: AdminCreateUserDto, description: '用户创建数据' })
|
||||
@ApiResponse({ status: 201, description: '创建成功', type: AdminDatabaseResponseDto })
|
||||
@ApiResponse({ status: 400, description: '请求参数错误' })
|
||||
@ApiResponse({ status: 409, description: '用户名或邮箱已存在' })
|
||||
@LogAdminOperation({
|
||||
operationType: 'CREATE',
|
||||
targetType: 'users',
|
||||
description: '创建用户',
|
||||
isSensitive: true
|
||||
})
|
||||
@Post('users')
|
||||
async createUser(@Body() createUserDto: AdminCreateUserDto): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.createUser(createUserDto);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '更新用户',
|
||||
description: '根据用户ID更新用户信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '用户ID', example: '1' })
|
||||
@ApiBody({ type: AdminUpdateUserDto, description: '用户更新数据' })
|
||||
@ApiResponse({ status: 200, description: '更新成功', type: AdminDatabaseResponseDto })
|
||||
@ApiResponse({ status: 404, description: '用户不存在' })
|
||||
@Put('users/:id')
|
||||
async updateUser(
|
||||
@Param('id') id: string,
|
||||
@Body() updateUserDto: AdminUpdateUserDto
|
||||
): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.updateUser(BigInt(id), updateUserDto);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '删除用户',
|
||||
description: '根据用户ID删除用户(软删除)'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '用户ID', example: '1' })
|
||||
@ApiResponse({ status: 200, description: '删除成功' })
|
||||
@ApiResponse({ status: 404, description: '用户不存在' })
|
||||
@LogAdminOperation({
|
||||
operationType: 'DELETE',
|
||||
targetType: 'users',
|
||||
description: '删除用户',
|
||||
isSensitive: true
|
||||
})
|
||||
@Delete('users/:id')
|
||||
async deleteUser(@Param('id') id: string): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.deleteUser(BigInt(id));
|
||||
}
|
||||
|
||||
// ==================== 用户档案管理接口 ====================
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取用户档案列表',
|
||||
description: '分页获取用户档案列表,包含位置信息和档案数据'
|
||||
})
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认20,最大100)', example: 20 })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)', example: 0 })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@Get('user-profiles')
|
||||
async getUserProfileList(
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number,
|
||||
@Query('offset', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_OFFSET), ParseIntPipe) offset: number
|
||||
): Promise<AdminListResponse> {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.USER_LIST_MAX_LIMIT);
|
||||
return await this.databaseManagementService.getUserProfileList(safeLimit, offset);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取用户档案详情',
|
||||
description: '根据档案ID获取详细的用户档案信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '档案ID', example: '1' })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@ApiResponse({ status: 404, description: '档案不存在' })
|
||||
@Get('user-profiles/:id')
|
||||
async getUserProfileById(@Param('id') id: string): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.getUserProfileById(BigInt(id));
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '根据地图获取用户档案',
|
||||
description: '获取指定地图中的所有用户档案信息'
|
||||
})
|
||||
@ApiParam({ name: 'mapId', description: '地图ID', example: 'plaza' })
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认20,最大100)', example: 20 })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)', example: 0 })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@Get('user-profiles/by-map/:mapId')
|
||||
async getUserProfilesByMap(
|
||||
@Param('mapId') mapId: string,
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number,
|
||||
@Query('offset', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_OFFSET), ParseIntPipe) offset: number
|
||||
): Promise<AdminListResponse> {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.USER_LIST_MAX_LIMIT);
|
||||
return await this.databaseManagementService.getUserProfilesByMap(mapId, safeLimit, offset);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '创建用户档案',
|
||||
description: '为指定用户创建档案信息'
|
||||
})
|
||||
@ApiBody({ type: 'AdminCreateUserProfileDto', description: '用户档案创建数据' })
|
||||
@ApiResponse({ status: 201, description: '创建成功' })
|
||||
@ApiResponse({ status: 400, description: '请求参数错误' })
|
||||
@ApiResponse({ status: 409, description: '用户档案已存在' })
|
||||
@Post('user-profiles')
|
||||
async createUserProfile(@Body() createProfileDto: any): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.createUserProfile(createProfileDto);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '更新用户档案',
|
||||
description: '根据档案ID更新用户档案信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '档案ID', example: '1' })
|
||||
@ApiBody({ type: 'AdminUpdateUserProfileDto', description: '用户档案更新数据' })
|
||||
@ApiResponse({ status: 200, description: '更新成功' })
|
||||
@ApiResponse({ status: 404, description: '档案不存在' })
|
||||
@Put('user-profiles/:id')
|
||||
async updateUserProfile(
|
||||
@Param('id') id: string,
|
||||
@Body() updateProfileDto: any
|
||||
): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.updateUserProfile(BigInt(id), updateProfileDto);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '删除用户档案',
|
||||
description: '根据档案ID删除用户档案'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '档案ID', example: '1' })
|
||||
@ApiResponse({ status: 200, description: '删除成功' })
|
||||
@ApiResponse({ status: 404, description: '档案不存在' })
|
||||
@Delete('user-profiles/:id')
|
||||
async deleteUserProfile(@Param('id') id: string): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.deleteUserProfile(BigInt(id));
|
||||
}
|
||||
|
||||
// ==================== Zulip账号关联管理接口 ====================
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取Zulip账号关联列表',
|
||||
description: '分页获取Zulip账号关联列表,包含关联状态和错误信息'
|
||||
})
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认20,最大100)', example: 20 })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)', example: 0 })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@Get('zulip-accounts')
|
||||
async getZulipAccountList(
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number,
|
||||
@Query('offset', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_OFFSET), ParseIntPipe) offset: number
|
||||
): Promise<AdminListResponse> {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.USER_LIST_MAX_LIMIT);
|
||||
return await this.databaseManagementService.getZulipAccountList(safeLimit, offset);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取Zulip账号关联详情',
|
||||
description: '根据关联ID获取详细的Zulip账号关联信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '关联ID', example: '1' })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@ApiResponse({ status: 404, description: '关联不存在' })
|
||||
@Get('zulip-accounts/:id')
|
||||
async getZulipAccountById(@Param('id') id: string): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.getZulipAccountById(id);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '获取Zulip账号关联统计',
|
||||
description: '获取各种状态的Zulip账号关联数量统计信息'
|
||||
})
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@Get('zulip-accounts/statistics')
|
||||
async getZulipAccountStatistics(): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.getZulipAccountStatistics();
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '创建Zulip账号关联',
|
||||
description: '创建游戏用户与Zulip账号的关联'
|
||||
})
|
||||
@ApiBody({ type: 'AdminCreateZulipAccountDto', description: 'Zulip账号关联创建数据' })
|
||||
@ApiResponse({ status: 201, description: '创建成功' })
|
||||
@ApiResponse({ status: 400, description: '请求参数错误' })
|
||||
@ApiResponse({ status: 409, description: '关联已存在' })
|
||||
@Post('zulip-accounts')
|
||||
async createZulipAccount(@Body() createAccountDto: any): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.createZulipAccount(createAccountDto);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '更新Zulip账号关联',
|
||||
description: '根据关联ID更新Zulip账号关联信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '关联ID', example: '1' })
|
||||
@ApiBody({ type: 'AdminUpdateZulipAccountDto', description: 'Zulip账号关联更新数据' })
|
||||
@ApiResponse({ status: 200, description: '更新成功' })
|
||||
@ApiResponse({ status: 404, description: '关联不存在' })
|
||||
@Put('zulip-accounts/:id')
|
||||
async updateZulipAccount(
|
||||
@Param('id') id: string,
|
||||
@Body() updateAccountDto: any
|
||||
): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.updateZulipAccount(id, updateAccountDto);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '删除Zulip账号关联',
|
||||
description: '根据关联ID删除Zulip账号关联'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '关联ID', example: '1' })
|
||||
@ApiResponse({ status: 200, description: '删除成功' })
|
||||
@ApiResponse({ status: 404, description: '关联不存在' })
|
||||
@Delete('zulip-accounts/:id')
|
||||
async deleteZulipAccount(@Param('id') id: string): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.deleteZulipAccount(id);
|
||||
}
|
||||
|
||||
@ApiOperation({
|
||||
summary: '批量更新Zulip账号状态',
|
||||
description: '批量更新多个Zulip账号关联的状态'
|
||||
})
|
||||
@ApiBody({ type: AdminBatchUpdateStatusDto, description: '批量更新数据' })
|
||||
@ApiResponse({ status: 200, description: '批量更新完成', type: AdminDatabaseResponseDto })
|
||||
@LogAdminOperation({
|
||||
operationType: 'BATCH',
|
||||
targetType: 'zulip_accounts',
|
||||
description: '批量更新Zulip账号状态',
|
||||
isSensitive: true
|
||||
})
|
||||
@Post('zulip-accounts/batch-update-status')
|
||||
async batchUpdateZulipAccountStatus(@Body() batchUpdateDto: AdminBatchUpdateStatusDto): Promise<AdminApiResponse> {
|
||||
return await this.databaseManagementService.batchUpdateZulipAccountStatus(
|
||||
batchUpdateDto.ids,
|
||||
batchUpdateDto.status,
|
||||
batchUpdateDto.reason
|
||||
);
|
||||
}
|
||||
|
||||
// ==================== 系统健康检查接口 ====================
|
||||
|
||||
@ApiOperation({
|
||||
summary: '数据库管理系统健康检查',
|
||||
description: '检查数据库管理系统的运行状态和连接情况'
|
||||
})
|
||||
@ApiResponse({ status: 200, description: '系统正常', type: AdminHealthCheckResponseDto })
|
||||
@Get('health')
|
||||
async healthCheck(): Promise<AdminApiResponse> {
|
||||
return createSuccessResponse({
|
||||
status: 'healthy',
|
||||
timestamp: getCurrentTimestamp(),
|
||||
services: {
|
||||
users: 'connected',
|
||||
user_profiles: 'connected',
|
||||
zulip_accounts: 'connected'
|
||||
}
|
||||
}, '数据库管理系统运行正常', REQUEST_ID_PREFIXES.HEALTH_CHECK);
|
||||
}
|
||||
}
|
||||
570
src/business/admin/admin_database.dto.ts
Normal file
570
src/business/admin/admin_database.dto.ts
Normal file
@@ -0,0 +1,570 @@
|
||||
/**
|
||||
* 管理员数据库管理 DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* - 定义管理员数据库管理相关的请求和响应数据结构
|
||||
* - 提供完整的数据验证规则
|
||||
* - 支持Swagger文档自动生成
|
||||
*
|
||||
* 职责分离:
|
||||
* - 请求数据结构定义和验证
|
||||
* - 响应数据结构定义
|
||||
* - API文档生成支持
|
||||
* - 类型安全保障
|
||||
*
|
||||
* DTO分类:
|
||||
* - Query DTOs: 查询参数验证
|
||||
* - Create DTOs: 创建操作数据验证
|
||||
* - Update DTOs: 更新操作数据验证
|
||||
* - Response DTOs: 响应数据结构定义
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 注释规范优化 - 为所有DTO类添加类注释,完善文档说明 (修改者: moyin)
|
||||
* - 2026-01-08: 文件夹扁平化 - 从dto/子文件夹移动到上级目录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员数据库管理DTO (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.3
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
|
||||
import { IsOptional, IsString, IsInt, Min, Max, IsEnum, IsEmail, IsArray, IsBoolean, IsNumber } from 'class-validator';
|
||||
import { Transform } from 'class-transformer';
|
||||
import { UserStatus } from '../../core/db/users/user_status.enum';
|
||||
|
||||
// ==================== 通用查询 DTOs ====================
|
||||
|
||||
/**
|
||||
* 管理员分页查询DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义分页查询的通用参数结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - 作为其他查询DTO的基类
|
||||
* - 提供统一的分页参数验证
|
||||
*/
|
||||
export class AdminPaginationDto {
|
||||
@ApiPropertyOptional({ description: '返回数量(默认20,最大100)', example: 20, minimum: 1, maximum: 100 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
@Min(1)
|
||||
@Max(100)
|
||||
@Transform(({ value }) => parseInt(value))
|
||||
limit?: number = 20;
|
||||
|
||||
@ApiPropertyOptional({ description: '偏移量(默认0)', example: 0, minimum: 0 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
@Min(0)
|
||||
@Transform(({ value }) => parseInt(value))
|
||||
offset?: number = 0;
|
||||
}
|
||||
|
||||
// ==================== 用户管理 DTOs ====================
|
||||
|
||||
/**
|
||||
* 管理员查询用户DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义用户查询接口的请求参数结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/database/users 接口的查询参数
|
||||
* - 支持关键词搜索和分页查询
|
||||
*/
|
||||
export class AdminQueryUsersDto extends AdminPaginationDto {
|
||||
@ApiPropertyOptional({ description: '搜索关键词(用户名、邮箱、昵称)', example: 'admin' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
search?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '用户状态过滤', enum: UserStatus, example: UserStatus.ACTIVE })
|
||||
@IsOptional()
|
||||
@IsEnum(UserStatus)
|
||||
status?: UserStatus;
|
||||
|
||||
@ApiPropertyOptional({ description: '角色过滤', example: 1 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
@Min(0)
|
||||
@Max(9)
|
||||
role?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员创建用户DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义创建用户接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/database/users 接口的请求体
|
||||
* - 包含用户创建所需的所有必要信息
|
||||
*/
|
||||
export class AdminCreateUserDto {
|
||||
@ApiProperty({ description: '用户名', example: 'newuser' })
|
||||
@IsString()
|
||||
username: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '邮箱', example: 'user@example.com' })
|
||||
@IsOptional()
|
||||
@IsEmail()
|
||||
email?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '手机号', example: '13800138000' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
phone?: string;
|
||||
|
||||
@ApiProperty({ description: '昵称', example: '新用户' })
|
||||
@IsString()
|
||||
nickname: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '密码哈希', example: 'hashed_password' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
password_hash?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: 'GitHub ID', example: 'github123' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
github_id?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '头像URL', example: 'https://example.com/avatar.jpg' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
avatar_url?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '角色', example: 1, minimum: 0, maximum: 9 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
@Min(0)
|
||||
@Max(9)
|
||||
role?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: '邮箱是否已验证', example: false })
|
||||
@IsOptional()
|
||||
@IsBoolean()
|
||||
email_verified?: boolean;
|
||||
|
||||
@ApiPropertyOptional({ description: '用户状态', enum: UserStatus, example: UserStatus.ACTIVE })
|
||||
@IsOptional()
|
||||
@IsEnum(UserStatus)
|
||||
status?: UserStatus;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员更新用户DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义更新用户接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - PUT /admin/database/users/:id 接口的请求体
|
||||
* - 支持部分字段更新,所有字段都是可选的
|
||||
*/
|
||||
export class AdminUpdateUserDto {
|
||||
@ApiPropertyOptional({ description: '用户名', example: 'updateduser' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
username?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '邮箱', example: 'updated@example.com' })
|
||||
@IsOptional()
|
||||
@IsEmail()
|
||||
email?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '手机号', example: '13900139000' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
phone?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '昵称', example: '更新用户' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
nickname?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '头像URL', example: 'https://example.com/new-avatar.jpg' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
avatar_url?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '角色', example: 2, minimum: 0, maximum: 9 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
@Min(0)
|
||||
@Max(9)
|
||||
role?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: '邮箱是否已验证', example: true })
|
||||
@IsOptional()
|
||||
@IsBoolean()
|
||||
email_verified?: boolean;
|
||||
|
||||
@ApiPropertyOptional({ description: '用户状态', enum: UserStatus, example: UserStatus.INACTIVE })
|
||||
@IsOptional()
|
||||
@IsEnum(UserStatus)
|
||||
status?: UserStatus;
|
||||
}
|
||||
|
||||
// ==================== 用户档案管理 DTOs ====================
|
||||
|
||||
/**
|
||||
* 管理员查询用户档案DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义用户档案查询接口的请求参数结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/database/user-profiles 接口的查询参数
|
||||
* - 支持地图过滤和分页查询
|
||||
*/
|
||||
export class AdminQueryUserProfileDto extends AdminPaginationDto {
|
||||
@ApiPropertyOptional({ description: '当前地图过滤', example: 'plaza' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
current_map?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '状态过滤', example: 1 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
status?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: '用户ID过滤', example: '1' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
user_id?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员创建用户档案DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义创建用户档案接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/database/user-profiles 接口的请求体
|
||||
* - 包含用户档案创建所需的所有信息
|
||||
*/
|
||||
export class AdminCreateUserProfileDto {
|
||||
@ApiProperty({ description: '用户ID', example: '1' })
|
||||
@IsString()
|
||||
user_id: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '个人简介', example: '这是我的个人简介' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
bio?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '简历内容', example: '工作经历和技能' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
resume_content?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '标签', example: '["开发者", "游戏爱好者"]' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
tags?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '社交链接', example: '{"github": "https://github.com/user"}' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
social_links?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '皮肤ID', example: 'skin_001' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
skin_id?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '当前地图', example: 'plaza' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
current_map?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: 'X坐标', example: 100.5 })
|
||||
@IsOptional()
|
||||
@IsNumber()
|
||||
pos_x?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: 'Y坐标', example: 200.3 })
|
||||
@IsOptional()
|
||||
@IsNumber()
|
||||
pos_y?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: '状态', example: 1 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
status?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员更新用户档案DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义更新用户档案接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - PUT /admin/database/user-profiles/:id 接口的请求体
|
||||
* - 支持部分字段更新,所有字段都是可选的
|
||||
*/
|
||||
export class AdminUpdateUserProfileDto {
|
||||
@ApiPropertyOptional({ description: '个人简介', example: '更新后的个人简介' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
bio?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '简历内容', example: '更新后的简历内容' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
resume_content?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '标签', example: '["高级开发者", "技术专家"]' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
tags?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '社交链接', example: '{"linkedin": "https://linkedin.com/in/user"}' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
social_links?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '皮肤ID', example: 'skin_002' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
skin_id?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '当前地图', example: 'forest' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
current_map?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: 'X坐标', example: 150.7 })
|
||||
@IsOptional()
|
||||
@IsNumber()
|
||||
pos_x?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: 'Y坐标', example: 250.9 })
|
||||
@IsOptional()
|
||||
@IsNumber()
|
||||
pos_y?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: '状态', example: 0 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
status?: number;
|
||||
}
|
||||
|
||||
// ==================== Zulip账号关联管理 DTOs ====================
|
||||
|
||||
/**
|
||||
* 管理员查询Zulip账号DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义Zulip账号关联查询接口的请求参数结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/database/zulip-accounts 接口的查询参数
|
||||
* - 支持用户ID过滤和分页查询
|
||||
*/
|
||||
export class AdminQueryZulipAccountDto extends AdminPaginationDto {
|
||||
@ApiPropertyOptional({ description: '游戏用户ID过滤', example: '1' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
gameUserId?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: 'Zulip用户ID过滤', example: 12345 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
zulipUserId?: number;
|
||||
|
||||
@ApiPropertyOptional({ description: 'Zulip邮箱过滤', example: 'user@zulip.com' })
|
||||
@IsOptional()
|
||||
@IsEmail()
|
||||
zulipEmail?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '状态过滤', example: 'active', enum: ['active', 'inactive', 'suspended', 'error'] })
|
||||
@IsOptional()
|
||||
@IsEnum(['active', 'inactive', 'suspended', 'error'])
|
||||
status?: 'active' | 'inactive' | 'suspended' | 'error';
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员创建Zulip账号DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义创建Zulip账号关联接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/database/zulip-accounts 接口的请求体
|
||||
* - 包含Zulip账号关联创建所需的所有信息
|
||||
*/
|
||||
export class AdminCreateZulipAccountDto {
|
||||
@ApiProperty({ description: '游戏用户ID', example: '1' })
|
||||
@IsString()
|
||||
gameUserId: string;
|
||||
|
||||
@ApiProperty({ description: 'Zulip用户ID', example: 12345 })
|
||||
@IsInt()
|
||||
zulipUserId: number;
|
||||
|
||||
@ApiProperty({ description: 'Zulip邮箱', example: 'user@zulip.com' })
|
||||
@IsEmail()
|
||||
zulipEmail: string;
|
||||
|
||||
@ApiProperty({ description: 'Zulip全名', example: '张三' })
|
||||
@IsString()
|
||||
zulipFullName: string;
|
||||
|
||||
@ApiProperty({ description: 'Zulip API密钥(加密)', example: 'encrypted_api_key' })
|
||||
@IsString()
|
||||
zulipApiKeyEncrypted: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '状态', example: 'active', enum: ['active', 'inactive', 'suspended', 'error'] })
|
||||
@IsOptional()
|
||||
@IsEnum(['active', 'inactive', 'suspended', 'error'])
|
||||
status?: 'active' | 'inactive' | 'suspended' | 'error';
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员更新Zulip账号DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义更新Zulip账号关联接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - PUT /admin/database/zulip-accounts/:id 接口的请求体
|
||||
* - 支持部分字段更新,所有字段都是可选的
|
||||
*/
|
||||
export class AdminUpdateZulipAccountDto {
|
||||
@ApiPropertyOptional({ description: 'Zulip全名', example: '李四' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
zulipFullName?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: 'Zulip API密钥(加密)', example: 'new_encrypted_api_key' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
zulipApiKeyEncrypted?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '状态', example: 'suspended', enum: ['active', 'inactive', 'suspended', 'error'] })
|
||||
@IsOptional()
|
||||
@IsEnum(['active', 'inactive', 'suspended', 'error'])
|
||||
status?: 'active' | 'inactive' | 'suspended' | 'error';
|
||||
|
||||
@ApiPropertyOptional({ description: '错误信息', example: '连接超时' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
errorMessage?: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '重试次数', example: 3 })
|
||||
@IsOptional()
|
||||
@IsInt()
|
||||
@Min(0)
|
||||
retryCount?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员批量更新状态DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义批量更新状态接口的请求数据结构和验证规则
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/database/zulip-accounts/batch-update-status 接口的请求体
|
||||
* - 支持批量更新多个记录的状态
|
||||
*/
|
||||
export class AdminBatchUpdateStatusDto {
|
||||
@ApiProperty({ description: 'ID列表', example: ['1', '2', '3'] })
|
||||
@IsArray()
|
||||
@IsString({ each: true })
|
||||
ids: string[];
|
||||
|
||||
@ApiProperty({ description: '目标状态', example: 'active', enum: ['active', 'inactive', 'suspended', 'error'] })
|
||||
@IsEnum(['active', 'inactive', 'suspended', 'error'])
|
||||
status: 'active' | 'inactive' | 'suspended' | 'error';
|
||||
|
||||
@ApiPropertyOptional({ description: '操作原因', example: '批量激活账号' })
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
reason?: string;
|
||||
}
|
||||
|
||||
// ==================== 响应 DTOs ====================
|
||||
|
||||
/**
|
||||
* 管理员数据库响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员数据库操作的通用响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - 各种数据库管理接口的响应体基类
|
||||
* - 包含操作状态、数据和消息信息
|
||||
*/
|
||||
export class AdminDatabaseResponseDto {
|
||||
@ApiProperty({ description: '是否成功', example: true })
|
||||
success: boolean;
|
||||
|
||||
@ApiProperty({ description: '消息', example: '操作成功' })
|
||||
message: string;
|
||||
|
||||
@ApiPropertyOptional({ description: '数据' })
|
||||
data?: any;
|
||||
|
||||
@ApiPropertyOptional({ description: '错误码', example: 'RESOURCE_NOT_FOUND' })
|
||||
error_code?: string;
|
||||
|
||||
@ApiProperty({ description: '时间戳', example: '2026-01-08T10:30:00.000Z' })
|
||||
timestamp: string;
|
||||
|
||||
@ApiProperty({ description: '请求ID', example: 'req_1641636600000_abc123' })
|
||||
request_id: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员数据库列表响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员数据库列表查询的响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - 各种列表查询接口的响应体
|
||||
* - 包含列表数据和分页信息
|
||||
*/
|
||||
export class AdminDatabaseListResponseDto extends AdminDatabaseResponseDto {
|
||||
@ApiProperty({ description: '列表数据' })
|
||||
data: {
|
||||
items: any[];
|
||||
total: number;
|
||||
limit: number;
|
||||
offset: number;
|
||||
has_more: boolean;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员健康检查响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义系统健康检查接口的响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/database/health 接口的响应体
|
||||
* - 包含系统健康状态信息
|
||||
*/
|
||||
export class AdminHealthCheckResponseDto extends AdminDatabaseResponseDto {
|
||||
@ApiProperty({ description: '健康检查数据' })
|
||||
data: {
|
||||
status: string;
|
||||
timestamp: string;
|
||||
services: {
|
||||
users: string;
|
||||
user_profiles: string;
|
||||
zulip_accounts: string;
|
||||
};
|
||||
};
|
||||
}
|
||||
435
src/business/admin/admin_database.integration.spec.ts
Normal file
435
src/business/admin/admin_database.integration.spec.ts
Normal file
@@ -0,0 +1,435 @@
|
||||
/**
|
||||
* 管理员数据库管理集成测试
|
||||
*
|
||||
* 功能描述:
|
||||
* - 测试管理员数据库管理的完整功能
|
||||
* - 验证CRUD操作的正确性
|
||||
* - 测试权限控制和错误处理
|
||||
* - 验证响应格式的一致性
|
||||
*
|
||||
* 测试覆盖:
|
||||
* - 用户管理功能测试
|
||||
* - 用户档案管理功能测试
|
||||
* - Zulip账号关联管理功能测试
|
||||
* - 批量操作功能测试
|
||||
* - 错误处理和边界条件测试
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员数据库管理集成测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
import { AdminDatabaseController } from '../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../admin.guard';
|
||||
import { UserStatus } from '../../../core/db/users/user_status.enum';
|
||||
|
||||
describe('Admin Database Management Integration Tests', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
let service: DatabaseManagementService;
|
||||
|
||||
// 测试数据
|
||||
const testUser = {
|
||||
username: 'admin-test-user',
|
||||
nickname: '管理员测试用户',
|
||||
email: 'admin-test@example.com',
|
||||
role: 1,
|
||||
status: UserStatus.ACTIVE
|
||||
};
|
||||
|
||||
const testProfile = {
|
||||
user_id: '1',
|
||||
bio: '管理员测试档案',
|
||||
current_map: 'test-plaza',
|
||||
pos_x: 100.5,
|
||||
pos_y: 200.3,
|
||||
status: 1
|
||||
};
|
||||
|
||||
const testZulipAccount = {
|
||||
gameUserId: '1',
|
||||
zulipUserId: 12345,
|
||||
zulipEmail: 'test@zulip.com',
|
||||
zulipFullName: '测试用户',
|
||||
zulipApiKeyEncrypted: 'encrypted_test_key',
|
||||
status: 'active'
|
||||
};
|
||||
|
||||
beforeAll(async () => {
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
// Mock AdminOperationLogService for testing
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
// Mock AdminOperationLogInterceptor
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockResolvedValue({ ...testUser, id: BigInt(1) }),
|
||||
create: jest.fn().mockResolvedValue({ ...testUser, id: BigInt(1) }),
|
||||
update: jest.fn().mockResolvedValue({ ...testUser, id: BigInt(1) }),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
search: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockResolvedValue({ ...testProfile, id: BigInt(1) }),
|
||||
create: jest.fn().mockResolvedValue({ ...testProfile, id: BigInt(1) }),
|
||||
update: jest.fn().mockResolvedValue({ ...testProfile, id: BigInt(1) }),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
findByMap: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: {
|
||||
findMany: jest.fn().mockResolvedValue({ accounts: [] }),
|
||||
findById: jest.fn().mockResolvedValue(testZulipAccount),
|
||||
create: jest.fn().mockResolvedValue({ ...testZulipAccount, id: '1' }),
|
||||
update: jest.fn().mockResolvedValue({ ...testZulipAccount, id: '1' }),
|
||||
delete: jest.fn().mockResolvedValue(undefined),
|
||||
getStatusStatistics: jest.fn().mockResolvedValue({
|
||||
active: 0,
|
||||
inactive: 0,
|
||||
suspended: 0,
|
||||
error: 0,
|
||||
total: 0
|
||||
})
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
service = module.get<DatabaseManagementService>(DatabaseManagementService);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
describe('用户管理功能测试', () => {
|
||||
it('应该成功获取用户列表', async () => {
|
||||
const result = await controller.getUserList(20, 0);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.items).toBeInstanceOf(Array);
|
||||
expect(result.data.total).toBeDefined();
|
||||
expect(result.data.limit).toBe(20);
|
||||
expect(result.data.offset).toBe(0);
|
||||
expect(result.message).toBe('用户列表获取成功');
|
||||
});
|
||||
|
||||
it('应该成功获取用户详情', async () => {
|
||||
const result = await controller.getUserById('1');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.username).toBe(testUser.username);
|
||||
expect(result.message).toBe('用户详情获取成功');
|
||||
});
|
||||
|
||||
it('应该成功创建用户', async () => {
|
||||
const result = await controller.createUser(testUser);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.username).toBe(testUser.username);
|
||||
expect(result.message).toBe('用户创建成功');
|
||||
});
|
||||
|
||||
it('应该成功更新用户', async () => {
|
||||
const updateData = { nickname: '更新后的昵称' };
|
||||
const result = await controller.updateUser('1', updateData);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.message).toBe('用户更新成功');
|
||||
});
|
||||
|
||||
it('应该成功删除用户', async () => {
|
||||
const result = await controller.deleteUser('1');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.deleted).toBe(true);
|
||||
expect(result.message).toBe('用户删除成功');
|
||||
});
|
||||
|
||||
it('应该成功搜索用户', async () => {
|
||||
const result = await controller.searchUsers('admin', 20);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.items).toBeInstanceOf(Array);
|
||||
expect(result.message).toBe('用户搜索成功');
|
||||
});
|
||||
});
|
||||
|
||||
describe('用户档案管理功能测试', () => {
|
||||
it('应该成功获取用户档案列表', async () => {
|
||||
const result = await controller.getUserProfileList(20, 0);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.items).toBeInstanceOf(Array);
|
||||
expect(result.message).toBe('用户档案列表获取成功');
|
||||
});
|
||||
|
||||
it('应该成功获取用户档案详情', async () => {
|
||||
const result = await controller.getUserProfileById('1');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.user_id).toBe(testProfile.user_id);
|
||||
expect(result.message).toBe('用户档案详情获取成功');
|
||||
});
|
||||
|
||||
it('应该成功创建用户档案', async () => {
|
||||
const result = await controller.createUserProfile(testProfile);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.user_id).toBe(testProfile.user_id);
|
||||
expect(result.message).toBe('用户档案创建成功');
|
||||
});
|
||||
|
||||
it('应该成功更新用户档案', async () => {
|
||||
const updateData = { bio: '更新后的简介' };
|
||||
const result = await controller.updateUserProfile('1', updateData);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.message).toBe('用户档案更新成功');
|
||||
});
|
||||
|
||||
it('应该成功删除用户档案', async () => {
|
||||
const result = await controller.deleteUserProfile('1');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.deleted).toBe(true);
|
||||
expect(result.message).toBe('用户档案删除成功');
|
||||
});
|
||||
|
||||
it('应该成功根据地图获取用户档案', async () => {
|
||||
const result = await controller.getUserProfilesByMap('plaza', 20, 0);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.items).toBeInstanceOf(Array);
|
||||
expect(result.message).toBe('地图 plaza 的用户档案获取成功');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Zulip账号关联管理功能测试', () => {
|
||||
it('应该成功获取Zulip账号关联列表', async () => {
|
||||
const result = await controller.getZulipAccountList(20, 0);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.items).toBeInstanceOf(Array);
|
||||
expect(result.message).toBe('Zulip账号关联列表获取成功');
|
||||
});
|
||||
|
||||
it('应该成功获取Zulip账号关联详情', async () => {
|
||||
const result = await controller.getZulipAccountById('1');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.gameUserId).toBe(testZulipAccount.gameUserId);
|
||||
expect(result.message).toBe('Zulip账号关联详情获取成功');
|
||||
});
|
||||
|
||||
it('应该成功创建Zulip账号关联', async () => {
|
||||
const result = await controller.createZulipAccount(testZulipAccount);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.gameUserId).toBe(testZulipAccount.gameUserId);
|
||||
expect(result.message).toBe('Zulip账号关联创建成功');
|
||||
});
|
||||
|
||||
it('应该成功更新Zulip账号关联', async () => {
|
||||
const updateData = { status: 'inactive' };
|
||||
const result = await controller.updateZulipAccount('1', updateData);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.message).toBe('Zulip账号关联更新成功');
|
||||
});
|
||||
|
||||
it('应该成功删除Zulip账号关联', async () => {
|
||||
const result = await controller.deleteZulipAccount('1');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.deleted).toBe(true);
|
||||
expect(result.message).toBe('Zulip账号关联删除成功');
|
||||
});
|
||||
|
||||
it('应该成功批量更新Zulip账号状态', async () => {
|
||||
const batchData = {
|
||||
ids: ['1', '2', '3'],
|
||||
status: 'active' as 'active' | 'inactive' | 'suspended' | 'error',
|
||||
reason: '批量激活测试'
|
||||
};
|
||||
const result = await controller.batchUpdateZulipAccountStatus(batchData);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.total).toBe(3);
|
||||
expect(result.message).toContain('批量更新完成');
|
||||
});
|
||||
|
||||
it('应该成功获取Zulip账号关联统计', async () => {
|
||||
const result = await controller.getZulipAccountStatistics();
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.total).toBeDefined();
|
||||
expect(result.message).toBe('Zulip账号关联统计获取成功');
|
||||
});
|
||||
});
|
||||
|
||||
describe('系统功能测试', () => {
|
||||
it('应该成功进行健康检查', async () => {
|
||||
const result = await controller.healthCheck();
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toBeDefined();
|
||||
expect(result.data.status).toBe('healthy');
|
||||
expect(result.data.services).toBeDefined();
|
||||
expect(result.message).toBe('数据库管理系统运行正常');
|
||||
});
|
||||
});
|
||||
|
||||
describe('响应格式一致性测试', () => {
|
||||
it('所有成功响应应该有统一的格式', async () => {
|
||||
const responses = [
|
||||
await controller.getUserList(20, 0),
|
||||
await controller.getUserById('1'),
|
||||
await controller.getUserProfileList(20, 0),
|
||||
await controller.getZulipAccountList(20, 0),
|
||||
await controller.healthCheck()
|
||||
];
|
||||
|
||||
responses.forEach(response => {
|
||||
expect(response).toHaveProperty('success');
|
||||
expect(response).toHaveProperty('message');
|
||||
expect(response).toHaveProperty('data');
|
||||
expect(response).toHaveProperty('timestamp');
|
||||
expect(response).toHaveProperty('request_id');
|
||||
expect(response.success).toBe(true);
|
||||
expect(typeof response.message).toBe('string');
|
||||
expect(typeof response.timestamp).toBe('string');
|
||||
expect(typeof response.request_id).toBe('string');
|
||||
});
|
||||
});
|
||||
|
||||
it('列表响应应该有分页信息', async () => {
|
||||
const listResponses = [
|
||||
await controller.getUserList(20, 0),
|
||||
await controller.getUserProfileList(20, 0),
|
||||
await controller.getZulipAccountList(20, 0)
|
||||
];
|
||||
|
||||
listResponses.forEach(response => {
|
||||
expect(response.data).toHaveProperty('items');
|
||||
expect(response.data).toHaveProperty('total');
|
||||
expect(response.data).toHaveProperty('limit');
|
||||
expect(response.data).toHaveProperty('offset');
|
||||
expect(response.data).toHaveProperty('has_more');
|
||||
expect(Array.isArray(response.data.items)).toBe(true);
|
||||
expect(typeof response.data.total).toBe('number');
|
||||
expect(typeof response.data.limit).toBe('number');
|
||||
expect(typeof response.data.offset).toBe('number');
|
||||
expect(typeof response.data.has_more).toBe('boolean');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('参数验证测试', () => {
|
||||
it('应该正确处理分页参数限制', async () => {
|
||||
// 测试超过最大限制的情况
|
||||
const result = await controller.getUserList(200, 0);
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
});
|
||||
|
||||
it('应该正确处理搜索参数限制', async () => {
|
||||
const result = await controller.searchUsers('test', 100);
|
||||
expect(result).toBeDefined();
|
||||
expect(result.success).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
271
src/business/admin/admin_database_exception.filter.ts
Normal file
271
src/business/admin/admin_database_exception.filter.ts
Normal file
@@ -0,0 +1,271 @@
|
||||
/**
|
||||
* 管理员数据库操作异常过滤器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 统一处理管理员数据库管理操作中的异常
|
||||
* - 标准化错误响应格式
|
||||
* - 记录详细的错误日志
|
||||
* - 提供用户友好的错误信息
|
||||
*
|
||||
* 职责分离:
|
||||
* - 异常捕获:捕获所有未处理的异常
|
||||
* - 错误转换:将系统异常转换为用户友好的错误信息
|
||||
* - 日志记录:记录详细的错误信息用于调试
|
||||
* - 响应格式化:统一错误响应的格式
|
||||
*
|
||||
* 支持的异常类型:
|
||||
* - BadRequestException: 400 - 请求参数错误
|
||||
* - UnauthorizedException: 401 - 未授权访问
|
||||
* - ForbiddenException: 403 - 权限不足
|
||||
* - NotFoundException: 404 - 资源不存在
|
||||
* - ConflictException: 409 - 资源冲突
|
||||
* - UnprocessableEntityException: 422 - 数据验证失败
|
||||
* - InternalServerErrorException: 500 - 系统内部错误
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员数据库异常过滤器 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import {
|
||||
ExceptionFilter,
|
||||
Catch,
|
||||
ArgumentsHost,
|
||||
HttpException,
|
||||
HttpStatus,
|
||||
Logger,
|
||||
BadRequestException,
|
||||
UnauthorizedException,
|
||||
ForbiddenException,
|
||||
NotFoundException,
|
||||
ConflictException,
|
||||
UnprocessableEntityException,
|
||||
InternalServerErrorException
|
||||
} from '@nestjs/common';
|
||||
import { Request, Response } from 'express';
|
||||
import { SENSITIVE_FIELDS } from './admin_constants';
|
||||
import { generateRequestId, getCurrentTimestamp } from './admin_utils';
|
||||
|
||||
/**
|
||||
* 错误响应接口
|
||||
*/
|
||||
interface ErrorResponse {
|
||||
success: false;
|
||||
message: string;
|
||||
error_code: string;
|
||||
details?: {
|
||||
field?: string;
|
||||
constraint?: string;
|
||||
received_value?: any;
|
||||
}[];
|
||||
timestamp: string;
|
||||
request_id: string;
|
||||
path: string;
|
||||
method: string;
|
||||
}
|
||||
|
||||
@Catch()
|
||||
export class AdminDatabaseExceptionFilter implements ExceptionFilter {
|
||||
private readonly logger = new Logger(AdminDatabaseExceptionFilter.name);
|
||||
|
||||
catch(exception: any, host: ArgumentsHost) {
|
||||
const ctx = host.switchToHttp();
|
||||
const response = ctx.getResponse<Response>();
|
||||
const request = ctx.getRequest<Request>();
|
||||
|
||||
const errorResponse = this.buildErrorResponse(exception, request);
|
||||
|
||||
// 记录错误日志
|
||||
this.logError(exception, request, errorResponse);
|
||||
|
||||
response.status(errorResponse.status).json({
|
||||
success: errorResponse.body.success,
|
||||
message: errorResponse.body.message,
|
||||
error_code: errorResponse.body.error_code,
|
||||
details: errorResponse.body.details,
|
||||
timestamp: errorResponse.body.timestamp,
|
||||
request_id: errorResponse.body.request_id,
|
||||
path: errorResponse.body.path,
|
||||
method: errorResponse.body.method
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 构建错误响应
|
||||
*
|
||||
* @param exception 异常对象
|
||||
* @param request 请求对象
|
||||
* @returns 错误响应对象
|
||||
*/
|
||||
private buildErrorResponse(exception: any, request: Request): { status: number; body: ErrorResponse } {
|
||||
let status: number;
|
||||
let message: string;
|
||||
let error_code: string;
|
||||
let details: any[] | undefined;
|
||||
|
||||
if (exception instanceof HttpException) {
|
||||
status = exception.getStatus();
|
||||
const exceptionResponse = exception.getResponse();
|
||||
|
||||
if (typeof exceptionResponse === 'string') {
|
||||
message = exceptionResponse;
|
||||
} else if (typeof exceptionResponse === 'object' && exceptionResponse !== null) {
|
||||
const responseObj = exceptionResponse as any;
|
||||
message = responseObj.message || responseObj.error || exception.message;
|
||||
details = responseObj.details;
|
||||
} else {
|
||||
message = exception.message;
|
||||
}
|
||||
|
||||
// 根据异常类型设置错误码
|
||||
error_code = this.getErrorCodeByException(exception);
|
||||
} else {
|
||||
// 未知异常,返回500
|
||||
status = HttpStatus.INTERNAL_SERVER_ERROR;
|
||||
message = '系统内部错误,请稍后重试';
|
||||
error_code = 'INTERNAL_SERVER_ERROR';
|
||||
}
|
||||
|
||||
const body: ErrorResponse = {
|
||||
success: false,
|
||||
message,
|
||||
error_code,
|
||||
details,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId('err'),
|
||||
path: request.url,
|
||||
method: request.method
|
||||
};
|
||||
|
||||
return { status, body };
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据异常类型获取错误码
|
||||
*
|
||||
* @param exception 异常对象
|
||||
* @returns 错误码
|
||||
*/
|
||||
private getErrorCodeByException(exception: HttpException): string {
|
||||
if (exception instanceof BadRequestException) {
|
||||
return 'BAD_REQUEST';
|
||||
}
|
||||
if (exception instanceof UnauthorizedException) {
|
||||
return 'UNAUTHORIZED';
|
||||
}
|
||||
if (exception instanceof ForbiddenException) {
|
||||
return 'FORBIDDEN';
|
||||
}
|
||||
if (exception instanceof NotFoundException) {
|
||||
return 'NOT_FOUND';
|
||||
}
|
||||
if (exception instanceof ConflictException) {
|
||||
return 'CONFLICT';
|
||||
}
|
||||
if (exception instanceof UnprocessableEntityException) {
|
||||
return 'UNPROCESSABLE_ENTITY';
|
||||
}
|
||||
if (exception instanceof InternalServerErrorException) {
|
||||
return 'INTERNAL_SERVER_ERROR';
|
||||
}
|
||||
|
||||
// 根据HTTP状态码设置错误码
|
||||
const status = exception.getStatus();
|
||||
switch (status) {
|
||||
case HttpStatus.BAD_REQUEST:
|
||||
return 'BAD_REQUEST';
|
||||
case HttpStatus.UNAUTHORIZED:
|
||||
return 'UNAUTHORIZED';
|
||||
case HttpStatus.FORBIDDEN:
|
||||
return 'FORBIDDEN';
|
||||
case HttpStatus.NOT_FOUND:
|
||||
return 'NOT_FOUND';
|
||||
case HttpStatus.CONFLICT:
|
||||
return 'CONFLICT';
|
||||
case HttpStatus.UNPROCESSABLE_ENTITY:
|
||||
return 'UNPROCESSABLE_ENTITY';
|
||||
case HttpStatus.TOO_MANY_REQUESTS:
|
||||
return 'TOO_MANY_REQUESTS';
|
||||
case HttpStatus.INTERNAL_SERVER_ERROR:
|
||||
return 'INTERNAL_SERVER_ERROR';
|
||||
case HttpStatus.BAD_GATEWAY:
|
||||
return 'BAD_GATEWAY';
|
||||
case HttpStatus.SERVICE_UNAVAILABLE:
|
||||
return 'SERVICE_UNAVAILABLE';
|
||||
case HttpStatus.GATEWAY_TIMEOUT:
|
||||
return 'GATEWAY_TIMEOUT';
|
||||
default:
|
||||
return 'UNKNOWN_ERROR';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 记录错误日志
|
||||
*
|
||||
* @param exception 异常对象
|
||||
* @param request 请求对象
|
||||
* @param errorResponse 错误响应对象
|
||||
*/
|
||||
private logError(exception: any, request: Request, errorResponse: { status: number; body: ErrorResponse }): void {
|
||||
const { status, body } = errorResponse;
|
||||
|
||||
const logContext = {
|
||||
request_id: body.request_id,
|
||||
method: request.method,
|
||||
url: request.url,
|
||||
user_agent: request.get('User-Agent'),
|
||||
ip: request.ip,
|
||||
status,
|
||||
error_code: body.error_code,
|
||||
message: body.message,
|
||||
timestamp: body.timestamp
|
||||
};
|
||||
|
||||
if (status >= 500) {
|
||||
// 服务器错误,记录详细的错误信息
|
||||
this.logger.error('服务器内部错误', {
|
||||
...logContext,
|
||||
stack: exception instanceof Error ? exception.stack : undefined,
|
||||
exception_type: exception.constructor?.name,
|
||||
details: body.details
|
||||
});
|
||||
} else if (status >= 400) {
|
||||
// 客户端错误,记录警告信息
|
||||
this.logger.warn('客户端请求错误', {
|
||||
...logContext,
|
||||
request_body: this.sanitizeRequestBody(request.body),
|
||||
query_params: request.query
|
||||
});
|
||||
} else {
|
||||
// 其他情况,记录普通日志
|
||||
this.logger.log('请求处理异常', logContext);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 清理请求体中的敏感信息
|
||||
*
|
||||
* @param body 请求体
|
||||
* @returns 清理后的请求体
|
||||
*/
|
||||
private sanitizeRequestBody(body: any): any {
|
||||
if (!body || typeof body !== 'object') {
|
||||
return body;
|
||||
}
|
||||
|
||||
const sanitized = { ...body };
|
||||
|
||||
for (const field of SENSITIVE_FIELDS) {
|
||||
if (sanitized[field]) {
|
||||
sanitized[field] = '[REDACTED]';
|
||||
}
|
||||
}
|
||||
|
||||
return sanitized;
|
||||
}
|
||||
}
|
||||
71
src/business/admin/admin_login.dto.ts
Normal file
71
src/business/admin/admin_login.dto.ts
Normal file
@@ -0,0 +1,71 @@
|
||||
/**
|
||||
* 管理员相关 DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* - 定义管理员登录与用户密码重置的请求结构
|
||||
* - 提供完整的数据验证规则
|
||||
* - 支持Swagger文档自动生成
|
||||
*
|
||||
* 职责分离:
|
||||
* - 请求数据结构定义
|
||||
* - 输入参数验证规则
|
||||
* - API文档生成支持
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 文件夹扁平化 - 从dto/子文件夹移动到上级目录 (修改者: moyin)
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
* - 2026-01-08: 注释规范优化 - 补充类注释,完善DTO文档说明 (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.3
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
import { IsNotEmpty, IsString, MinLength } from 'class-validator';
|
||||
|
||||
/**
|
||||
* 管理员登录请求DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员登录接口的请求数据结构和验证规则
|
||||
*
|
||||
* 验证规则:
|
||||
* - identifier: 必填字符串,支持用户名/邮箱/手机号
|
||||
* - password: 必填字符串,管理员密码
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/auth/login 接口的请求体
|
||||
*/
|
||||
export class AdminLoginDto {
|
||||
@ApiProperty({ description: '登录标识符(用户名/邮箱/手机号)', example: 'admin' })
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
identifier: string;
|
||||
|
||||
@ApiProperty({ description: '密码', example: 'Admin123456' })
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
password: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员重置密码请求DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员重置用户密码接口的请求数据结构和验证规则
|
||||
*
|
||||
* 验证规则:
|
||||
* - newPassword: 必填字符串,至少8位,需包含字母和数字
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/users/:id/reset-password 接口的请求体
|
||||
*/
|
||||
export class AdminResetPasswordDto {
|
||||
@ApiProperty({ description: '新密码(至少8位,包含字母和数字)', example: 'NewPass1234' })
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
@MinLength(8)
|
||||
newPassword: string;
|
||||
}
|
||||
373
src/business/admin/admin_operation_log.controller.ts
Normal file
373
src/business/admin/admin_operation_log.controller.ts
Normal file
@@ -0,0 +1,373 @@
|
||||
/**
|
||||
* 管理员操作日志控制器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供管理员操作日志的查询和管理接口
|
||||
* - 支持日志的分页查询和过滤
|
||||
* - 提供操作统计和分析功能
|
||||
* - 支持敏感操作日志的特殊查询
|
||||
*
|
||||
* 职责分离:
|
||||
* - HTTP请求处理:接收和验证HTTP请求参数
|
||||
* - 权限控制:通过AdminGuard确保只有管理员可以访问
|
||||
* - 业务委托:将业务逻辑委托给AdminOperationLogService处理
|
||||
* - 响应格式化:返回统一格式的HTTP响应
|
||||
*
|
||||
* API端点:
|
||||
* - GET /admin/operation-logs 获取操作日志列表
|
||||
* - GET /admin/operation-logs/:id 获取操作日志详情
|
||||
* - GET /admin/operation-logs/statistics 获取操作统计
|
||||
* - GET /admin/operation-logs/sensitive 获取敏感操作日志
|
||||
* - DELETE /admin/operation-logs/cleanup 清理过期日志
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 功能新增 - 创建管理员操作日志控制器 (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.0
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import {
|
||||
Controller,
|
||||
Get,
|
||||
Delete,
|
||||
Param,
|
||||
Query,
|
||||
UseGuards,
|
||||
UseFilters,
|
||||
UseInterceptors,
|
||||
ParseIntPipe,
|
||||
DefaultValuePipe,
|
||||
BadRequestException
|
||||
} from '@nestjs/common';
|
||||
import {
|
||||
ApiTags,
|
||||
ApiBearerAuth,
|
||||
ApiOperation,
|
||||
ApiParam,
|
||||
ApiQuery,
|
||||
ApiResponse
|
||||
} from '@nestjs/swagger';
|
||||
import { AdminGuard } from './admin.guard';
|
||||
import { AdminDatabaseExceptionFilter } from './admin_database_exception.filter';
|
||||
import { AdminOperationLogInterceptor } from './admin_operation_log.interceptor';
|
||||
import { LogAdminOperation } from './log_admin_operation.decorator';
|
||||
import { AdminOperationLogService, LogQueryParams } from './admin_operation_log.service';
|
||||
import { PAGINATION_LIMITS, LOG_RETENTION, USER_QUERY_LIMITS } from './admin_constants';
|
||||
import { safeLimitValue, safeOffsetValue, safeDaysToKeep, createSuccessResponse, createListResponse } from './admin_utils';
|
||||
|
||||
@ApiTags('admin-operation-logs')
|
||||
@Controller('admin/operation-logs')
|
||||
@UseGuards(AdminGuard)
|
||||
@UseFilters(AdminDatabaseExceptionFilter)
|
||||
@UseInterceptors(AdminOperationLogInterceptor)
|
||||
@ApiBearerAuth('JWT-auth')
|
||||
export class AdminOperationLogController {
|
||||
constructor(
|
||||
private readonly logService: AdminOperationLogService
|
||||
) {}
|
||||
|
||||
/**
|
||||
* 获取操作日志列表
|
||||
*
|
||||
* 功能描述:
|
||||
* 分页获取管理员操作日志,支持多种过滤条件
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证查询参数
|
||||
* 2. 构建查询条件
|
||||
* 3. 调用日志服务查询
|
||||
* 4. 返回分页结果
|
||||
*
|
||||
* @param limit 返回数量,默认50,最大200
|
||||
* @param offset 偏移量,默认0
|
||||
* @param adminUserId 管理员用户ID过滤,可选
|
||||
* @param operationType 操作类型过滤,可选
|
||||
* @param targetType 目标类型过滤,可选
|
||||
* @param operationResult 操作结果过滤,可选
|
||||
* @param startDate 开始日期过滤,可选
|
||||
* @param endDate 结束日期过滤,可选
|
||||
* @param isSensitive 是否敏感操作过滤,可选
|
||||
* @returns 操作日志列表和分页信息
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 获取最近50条操作日志
|
||||
* GET /admin/operation-logs?limit=50&offset=0
|
||||
*
|
||||
* // 获取特定管理员的操作日志
|
||||
* GET /admin/operation-logs?adminUserId=123&limit=20
|
||||
*
|
||||
* // 获取敏感操作日志
|
||||
* GET /admin/operation-logs?isSensitive=true
|
||||
* ```
|
||||
*/
|
||||
@ApiOperation({
|
||||
summary: '获取操作日志列表',
|
||||
description: '分页获取管理员操作日志,支持多种过滤条件'
|
||||
})
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认50,最大200)', example: 50 })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)', example: 0 })
|
||||
@ApiQuery({ name: 'adminUserId', required: false, description: '管理员用户ID过滤', example: '123' })
|
||||
@ApiQuery({ name: 'operationType', required: false, description: '操作类型过滤', example: 'CREATE' })
|
||||
@ApiQuery({ name: 'targetType', required: false, description: '目标类型过滤', example: 'users' })
|
||||
@ApiQuery({ name: 'operationResult', required: false, description: '操作结果过滤', example: 'SUCCESS' })
|
||||
@ApiQuery({ name: 'startDate', required: false, description: '开始日期(ISO格式)', example: '2026-01-01T00:00:00.000Z' })
|
||||
@ApiQuery({ name: 'endDate', required: false, description: '结束日期(ISO格式)', example: '2026-01-08T23:59:59.999Z' })
|
||||
@ApiQuery({ name: 'isSensitive', required: false, description: '是否敏感操作', example: true })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@ApiResponse({ status: 401, description: '未授权访问' })
|
||||
@ApiResponse({ status: 403, description: '权限不足' })
|
||||
@LogAdminOperation({
|
||||
operationType: 'QUERY',
|
||||
targetType: 'admin_logs',
|
||||
description: '获取操作日志列表',
|
||||
isSensitive: false
|
||||
})
|
||||
@Get()
|
||||
async getOperationLogs(
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number,
|
||||
@Query('offset', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_OFFSET), ParseIntPipe) offset: number,
|
||||
@Query('adminUserId') adminUserId?: string,
|
||||
@Query('operationType') operationType?: string,
|
||||
@Query('targetType') targetType?: string,
|
||||
@Query('operationResult') operationResult?: string,
|
||||
@Query('startDate') startDate?: string,
|
||||
@Query('endDate') endDate?: string,
|
||||
@Query('isSensitive') isSensitive?: string
|
||||
) {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.LOG_LIST_MAX_LIMIT);
|
||||
const safeOffset = safeOffsetValue(offset);
|
||||
|
||||
const queryParams: LogQueryParams = {
|
||||
limit: safeLimit,
|
||||
offset: safeOffset
|
||||
};
|
||||
|
||||
if (adminUserId) queryParams.adminUserId = adminUserId;
|
||||
if (operationType) queryParams.operationType = operationType;
|
||||
if (targetType) queryParams.targetType = targetType;
|
||||
if (operationResult) queryParams.operationResult = operationResult;
|
||||
if (isSensitive !== undefined) queryParams.isSensitive = isSensitive === 'true';
|
||||
|
||||
if (startDate && endDate) {
|
||||
queryParams.startDate = new Date(startDate);
|
||||
queryParams.endDate = new Date(endDate);
|
||||
|
||||
if (isNaN(queryParams.startDate.getTime()) || isNaN(queryParams.endDate.getTime())) {
|
||||
throw new BadRequestException('日期格式无效,请使用ISO格式');
|
||||
}
|
||||
}
|
||||
|
||||
const { logs, total } = await this.logService.queryLogs(queryParams);
|
||||
|
||||
return createListResponse(
|
||||
logs,
|
||||
total,
|
||||
safeLimit,
|
||||
safeOffset,
|
||||
'操作日志列表获取成功'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取操作日志详情
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据日志ID获取操作日志的详细信息
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证日志ID格式
|
||||
* 2. 查询日志详细信息
|
||||
* 3. 返回日志详情
|
||||
*
|
||||
* @param id 日志ID
|
||||
* @returns 操作日志详细信息
|
||||
*
|
||||
* @throws NotFoundException 当日志不存在时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await controller.getOperationLogById('uuid-123');
|
||||
* ```
|
||||
*/
|
||||
@ApiOperation({
|
||||
summary: '获取操作日志详情',
|
||||
description: '根据日志ID获取操作日志的详细信息'
|
||||
})
|
||||
@ApiParam({ name: 'id', description: '日志ID', example: 'uuid-123' })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@ApiResponse({ status: 404, description: '日志不存在' })
|
||||
@Get(':id')
|
||||
async getOperationLogById(@Param('id') id: string) {
|
||||
const log = await this.logService.getLogById(id);
|
||||
|
||||
if (!log) {
|
||||
throw new BadRequestException('操作日志不存在');
|
||||
}
|
||||
|
||||
return createSuccessResponse(log, '操作日志详情获取成功');
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取操作统计信息
|
||||
*
|
||||
* 功能描述:
|
||||
* 获取管理员操作的统计信息,包括操作数量、类型分布等
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 解析时间范围参数
|
||||
* 2. 调用统计服务
|
||||
* 3. 返回统计结果
|
||||
*
|
||||
* @param startDate 开始日期,可选
|
||||
* @param endDate 结束日期,可选
|
||||
* @returns 操作统计信息
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 获取全部统计
|
||||
* GET /admin/operation-logs/statistics
|
||||
*
|
||||
* // 获取指定时间范围的统计
|
||||
* GET /admin/operation-logs/statistics?startDate=2026-01-01&endDate=2026-01-08
|
||||
* ```
|
||||
*/
|
||||
@ApiOperation({
|
||||
summary: '获取操作统计信息',
|
||||
description: '获取管理员操作的统计信息,包括操作数量、类型分布等'
|
||||
})
|
||||
@ApiQuery({ name: 'startDate', required: false, description: '开始日期(ISO格式)', example: '2026-01-01T00:00:00.000Z' })
|
||||
@ApiQuery({ name: 'endDate', required: false, description: '结束日期(ISO格式)', example: '2026-01-08T23:59:59.999Z' })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@Get('statistics')
|
||||
async getOperationStatistics(
|
||||
@Query('startDate') startDate?: string,
|
||||
@Query('endDate') endDate?: string
|
||||
) {
|
||||
let parsedStartDate: Date | undefined;
|
||||
let parsedEndDate: Date | undefined;
|
||||
|
||||
if (startDate && endDate) {
|
||||
parsedStartDate = new Date(startDate);
|
||||
parsedEndDate = new Date(endDate);
|
||||
|
||||
if (isNaN(parsedStartDate.getTime()) || isNaN(parsedEndDate.getTime())) {
|
||||
throw new BadRequestException('日期格式无效,请使用ISO格式');
|
||||
}
|
||||
}
|
||||
|
||||
const statistics = await this.logService.getStatistics(parsedStartDate, parsedEndDate);
|
||||
|
||||
return createSuccessResponse(statistics, '操作统计信息获取成功');
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取敏感操作日志
|
||||
*
|
||||
* 功能描述:
|
||||
* 获取标记为敏感的操作日志,用于安全审计
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证查询参数
|
||||
* 2. 查询敏感操作日志
|
||||
* 3. 返回分页结果
|
||||
*
|
||||
* @param limit 返回数量,默认50,最大200
|
||||
* @param offset 偏移量,默认0
|
||||
* @returns 敏感操作日志列表
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 获取最近50条敏感操作日志
|
||||
* GET /admin/operation-logs/sensitive?limit=50
|
||||
* ```
|
||||
*/
|
||||
@ApiOperation({
|
||||
summary: '获取敏感操作日志',
|
||||
description: '获取标记为敏感的操作日志,用于安全审计'
|
||||
})
|
||||
@ApiQuery({ name: 'limit', required: false, description: '返回数量(默认50,最大200)', example: 50 })
|
||||
@ApiQuery({ name: 'offset', required: false, description: '偏移量(默认0)', example: 0 })
|
||||
@ApiResponse({ status: 200, description: '获取成功' })
|
||||
@LogAdminOperation({
|
||||
operationType: 'QUERY',
|
||||
targetType: 'admin_logs',
|
||||
description: '获取敏感操作日志',
|
||||
isSensitive: true
|
||||
})
|
||||
@Get('sensitive')
|
||||
async getSensitiveOperations(
|
||||
@Query('limit', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_LIMIT), ParseIntPipe) limit: number,
|
||||
@Query('offset', new DefaultValuePipe(PAGINATION_LIMITS.DEFAULT_OFFSET), ParseIntPipe) offset: number
|
||||
) {
|
||||
const safeLimit = safeLimitValue(limit, PAGINATION_LIMITS.LOG_LIST_MAX_LIMIT);
|
||||
const safeOffset = safeOffsetValue(offset);
|
||||
|
||||
const { logs, total } = await this.logService.getSensitiveOperations(safeLimit, safeOffset);
|
||||
|
||||
return createListResponse(
|
||||
logs,
|
||||
total,
|
||||
safeLimit,
|
||||
safeOffset,
|
||||
'敏感操作日志获取成功'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 清理过期日志
|
||||
*
|
||||
* 功能描述:
|
||||
* 清理超过指定天数的操作日志,释放存储空间
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证保留天数参数
|
||||
* 2. 调用清理服务
|
||||
* 3. 返回清理结果
|
||||
*
|
||||
* @param daysToKeep 保留天数,默认90天,最少7天,最多365天
|
||||
* @returns 清理结果,包含删除的记录数
|
||||
*
|
||||
* @throws BadRequestException 当保留天数超出范围时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 清理90天前的日志
|
||||
* DELETE /admin/operation-logs/cleanup?daysToKeep=90
|
||||
* ```
|
||||
*/
|
||||
@ApiOperation({
|
||||
summary: '清理过期日志',
|
||||
description: '清理超过指定天数的操作日志,释放存储空间'
|
||||
})
|
||||
@ApiQuery({ name: 'daysToKeep', required: false, description: '保留天数(默认90,最少7,最多365)', example: 90 })
|
||||
@ApiResponse({ status: 200, description: '清理成功' })
|
||||
@ApiResponse({ status: 400, description: '参数错误' })
|
||||
@LogAdminOperation({
|
||||
operationType: 'DELETE',
|
||||
targetType: 'admin_logs',
|
||||
description: '清理过期操作日志',
|
||||
isSensitive: true
|
||||
})
|
||||
@Delete('cleanup')
|
||||
async cleanupExpiredLogs(
|
||||
@Query('daysToKeep', new DefaultValuePipe(LOG_RETENTION.DEFAULT_DAYS), ParseIntPipe) daysToKeep: number
|
||||
) {
|
||||
const safeDays = safeDaysToKeep(daysToKeep, LOG_RETENTION.MIN_DAYS, LOG_RETENTION.MAX_DAYS);
|
||||
|
||||
if (safeDays !== daysToKeep) {
|
||||
throw new BadRequestException(`保留天数必须在${LOG_RETENTION.MIN_DAYS}-${LOG_RETENTION.MAX_DAYS}天之间`);
|
||||
}
|
||||
|
||||
const deletedCount = await this.logService.cleanupExpiredLogs(safeDays);
|
||||
|
||||
return createSuccessResponse({
|
||||
deleted_count: deletedCount,
|
||||
days_to_keep: safeDays,
|
||||
cleanup_date: new Date().toISOString()
|
||||
}, `过期日志清理完成,删除了${deletedCount}条记录`);
|
||||
}
|
||||
}
|
||||
102
src/business/admin/admin_operation_log.entity.ts
Normal file
102
src/business/admin/admin_operation_log.entity.ts
Normal file
@@ -0,0 +1,102 @@
|
||||
/**
|
||||
* 管理员操作日志实体
|
||||
*
|
||||
* 功能描述:
|
||||
* - 记录管理员的所有数据库操作
|
||||
* - 提供详细的审计跟踪
|
||||
* - 支持操作前后数据状态记录
|
||||
* - 便于安全审计和问题排查
|
||||
*
|
||||
* 职责分离:
|
||||
* - 数据持久化:操作日志的数据库存储
|
||||
* - 审计跟踪:完整的操作历史记录
|
||||
* - 安全监控:敏感操作的详细记录
|
||||
* - 问题排查:操作异常的详细信息
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员操作日志实体 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, Index } from 'typeorm';
|
||||
|
||||
@Entity('admin_operation_logs')
|
||||
@Index(['admin_user_id', 'created_at'])
|
||||
@Index(['operation_type', 'created_at'])
|
||||
@Index(['target_type', 'target_id'])
|
||||
export class AdminOperationLog {
|
||||
@PrimaryGeneratedColumn('uuid')
|
||||
id: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 50, comment: '管理员用户ID' })
|
||||
@Index()
|
||||
admin_user_id: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 100, comment: '管理员用户名' })
|
||||
admin_username: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 50, comment: '操作类型 (CREATE/UPDATE/DELETE/QUERY/BATCH)' })
|
||||
operation_type: 'CREATE' | 'UPDATE' | 'DELETE' | 'QUERY' | 'BATCH';
|
||||
|
||||
@Column({ type: 'varchar', length: 100, comment: '目标资源类型 (users/user_profiles/zulip_accounts)' })
|
||||
target_type: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 50, nullable: true, comment: '目标资源ID' })
|
||||
target_id?: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 200, comment: '操作描述' })
|
||||
operation_description: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 100, comment: 'HTTP方法和路径' })
|
||||
http_method_path: string;
|
||||
|
||||
@Column({ type: 'json', nullable: true, comment: '请求参数' })
|
||||
request_params?: Record<string, any>;
|
||||
|
||||
@Column({ type: 'json', nullable: true, comment: '操作前数据状态' })
|
||||
before_data?: Record<string, any>;
|
||||
|
||||
@Column({ type: 'json', nullable: true, comment: '操作后数据状态' })
|
||||
after_data?: Record<string, any>;
|
||||
|
||||
@Column({ type: 'varchar', length: 20, comment: '操作结果 (SUCCESS/FAILED)' })
|
||||
operation_result: 'SUCCESS' | 'FAILED';
|
||||
|
||||
@Column({ type: 'text', nullable: true, comment: '错误信息' })
|
||||
error_message?: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 50, nullable: true, comment: '错误码' })
|
||||
error_code?: string;
|
||||
|
||||
@Column({ type: 'int', comment: '操作耗时(毫秒)' })
|
||||
duration_ms: number;
|
||||
|
||||
@Column({ type: 'varchar', length: 45, nullable: true, comment: '客户端IP地址' })
|
||||
client_ip?: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 500, nullable: true, comment: '用户代理' })
|
||||
user_agent?: string;
|
||||
|
||||
@Column({ type: 'varchar', length: 50, comment: '请求ID' })
|
||||
request_id: string;
|
||||
|
||||
@Column({ type: 'json', nullable: true, comment: '额外的上下文信息' })
|
||||
context?: Record<string, any>;
|
||||
|
||||
@CreateDateColumn({ comment: '创建时间' })
|
||||
created_at: Date;
|
||||
|
||||
@Column({ type: 'boolean', default: false, comment: '是否为敏感操作' })
|
||||
is_sensitive: boolean;
|
||||
|
||||
@Column({ type: 'int', default: 0, comment: '影响的记录数量' })
|
||||
affected_records: number;
|
||||
|
||||
@Column({ type: 'varchar', length: 100, nullable: true, comment: '批量操作的批次ID' })
|
||||
batch_id?: string;
|
||||
}
|
||||
203
src/business/admin/admin_operation_log.interceptor.ts
Normal file
203
src/business/admin/admin_operation_log.interceptor.ts
Normal file
@@ -0,0 +1,203 @@
|
||||
/**
|
||||
* 管理员操作日志拦截器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 自动拦截管理员操作并记录日志
|
||||
* - 记录操作前后的数据状态
|
||||
* - 监控操作性能和错误
|
||||
* - 支持敏感操作的特殊处理
|
||||
*
|
||||
* 职责分离:
|
||||
* - 操作拦截:拦截控制器方法的执行
|
||||
* - 数据捕获:记录请求参数和响应数据
|
||||
* - 日志记录:调用日志服务记录操作
|
||||
* - 错误处理:记录操作异常信息
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员操作日志拦截器 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import {
|
||||
Injectable,
|
||||
NestInterceptor,
|
||||
ExecutionContext,
|
||||
CallHandler,
|
||||
Logger,
|
||||
} from '@nestjs/common';
|
||||
import { Reflector } from '@nestjs/core';
|
||||
import { Observable, throwError } from 'rxjs';
|
||||
import { tap, catchError } from 'rxjs/operators';
|
||||
import { AdminOperationLogService } from './admin_operation_log.service';
|
||||
import { LOG_ADMIN_OPERATION_KEY, LogAdminOperationOptions } from './log_admin_operation.decorator';
|
||||
import { SENSITIVE_FIELDS } from './admin_constants';
|
||||
import { extractClientIp, generateRequestId, sanitizeRequestBody } from './admin_utils';
|
||||
|
||||
@Injectable()
|
||||
export class AdminOperationLogInterceptor implements NestInterceptor {
|
||||
private readonly logger = new Logger(AdminOperationLogInterceptor.name);
|
||||
|
||||
constructor(
|
||||
private readonly reflector: Reflector,
|
||||
private readonly logService: AdminOperationLogService,
|
||||
) {}
|
||||
|
||||
intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
|
||||
const logOptions = this.reflector.get<LogAdminOperationOptions>(
|
||||
LOG_ADMIN_OPERATION_KEY,
|
||||
context.getHandler(),
|
||||
);
|
||||
|
||||
// 如果没有日志配置,直接执行
|
||||
if (!logOptions) {
|
||||
return next.handle();
|
||||
}
|
||||
|
||||
const request = context.switchToHttp().getRequest();
|
||||
const response = context.switchToHttp().getResponse();
|
||||
const startTime = Date.now();
|
||||
|
||||
// 提取请求信息
|
||||
const adminUser = request.user;
|
||||
const clientIp = extractClientIp(request);
|
||||
const userAgent = request.headers['user-agent'] || 'unknown';
|
||||
const httpMethodPath = `${request.method} ${request.route?.path || request.url}`;
|
||||
const requestId = generateRequestId();
|
||||
|
||||
// 提取请求参数
|
||||
const requestParams = logOptions.captureRequestParams !== false ? {
|
||||
params: request.params,
|
||||
query: request.query,
|
||||
body: sanitizeRequestBody(request.body)
|
||||
} : undefined;
|
||||
|
||||
// 提取目标ID(如果存在)
|
||||
const targetId = request.params?.id || request.body?.id || request.query?.id;
|
||||
|
||||
let beforeData: any = undefined;
|
||||
let operationError: any = null;
|
||||
|
||||
return next.handle().pipe(
|
||||
tap((responseData) => {
|
||||
// 操作成功,记录日志
|
||||
this.recordLog({
|
||||
logOptions,
|
||||
adminUser,
|
||||
clientIp,
|
||||
userAgent,
|
||||
httpMethodPath,
|
||||
requestId,
|
||||
requestParams,
|
||||
targetId,
|
||||
beforeData,
|
||||
afterData: logOptions.captureAfterData !== false ? responseData : undefined,
|
||||
operationResult: 'SUCCESS',
|
||||
durationMs: Date.now() - startTime,
|
||||
affectedRecords: this.extractAffectedRecords(responseData),
|
||||
});
|
||||
}),
|
||||
catchError((error) => {
|
||||
// 操作失败,记录错误日志
|
||||
operationError = error;
|
||||
this.recordLog({
|
||||
logOptions,
|
||||
adminUser,
|
||||
clientIp,
|
||||
userAgent,
|
||||
httpMethodPath,
|
||||
requestId,
|
||||
requestParams,
|
||||
targetId,
|
||||
beforeData,
|
||||
operationResult: 'FAILED',
|
||||
errorMessage: error.message || String(error),
|
||||
errorCode: error.code || error.status || 'UNKNOWN_ERROR',
|
||||
durationMs: Date.now() - startTime,
|
||||
});
|
||||
|
||||
return throwError(() => error);
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 记录操作日志
|
||||
*/
|
||||
private async recordLog(params: {
|
||||
logOptions: LogAdminOperationOptions;
|
||||
adminUser: any;
|
||||
clientIp: string;
|
||||
userAgent: string;
|
||||
httpMethodPath: string;
|
||||
requestId: string;
|
||||
requestParams?: any;
|
||||
targetId?: string;
|
||||
beforeData?: any;
|
||||
afterData?: any;
|
||||
operationResult: 'SUCCESS' | 'FAILED';
|
||||
errorMessage?: string;
|
||||
errorCode?: string;
|
||||
durationMs: number;
|
||||
affectedRecords?: number;
|
||||
}) {
|
||||
try {
|
||||
await this.logService.createLog({
|
||||
adminUserId: params.adminUser?.id || 'unknown',
|
||||
adminUsername: params.adminUser?.username || 'unknown',
|
||||
operationType: params.logOptions.operationType,
|
||||
targetType: params.logOptions.targetType,
|
||||
targetId: params.targetId,
|
||||
operationDescription: params.logOptions.description,
|
||||
httpMethodPath: params.httpMethodPath,
|
||||
requestParams: params.requestParams,
|
||||
beforeData: params.beforeData,
|
||||
afterData: params.afterData,
|
||||
operationResult: params.operationResult,
|
||||
errorMessage: params.errorMessage,
|
||||
errorCode: params.errorCode,
|
||||
durationMs: params.durationMs,
|
||||
clientIp: params.clientIp,
|
||||
userAgent: params.userAgent,
|
||||
requestId: params.requestId,
|
||||
isSensitive: params.logOptions.isSensitive || false,
|
||||
affectedRecords: params.affectedRecords || 0,
|
||||
});
|
||||
} catch (error) {
|
||||
this.logger.error('记录操作日志失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
adminUserId: params.adminUser?.id,
|
||||
operationType: params.logOptions.operationType,
|
||||
targetType: params.logOptions.targetType,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 提取影响的记录数量
|
||||
*/
|
||||
private extractAffectedRecords(responseData: any): number {
|
||||
if (!responseData || typeof responseData !== 'object') {
|
||||
return 0;
|
||||
}
|
||||
|
||||
// 从响应数据中提取影响的记录数
|
||||
if (responseData.data) {
|
||||
if (Array.isArray(responseData.data.items)) {
|
||||
return responseData.data.items.length;
|
||||
}
|
||||
if (responseData.data.total !== undefined) {
|
||||
return responseData.data.total;
|
||||
}
|
||||
if (responseData.data.success !== undefined && responseData.data.failed !== undefined) {
|
||||
return responseData.data.success + responseData.data.failed;
|
||||
}
|
||||
}
|
||||
|
||||
return 1; // 默认为1条记录
|
||||
}
|
||||
}
|
||||
498
src/business/admin/admin_operation_log.service.ts
Normal file
498
src/business/admin/admin_operation_log.service.ts
Normal file
@@ -0,0 +1,498 @@
|
||||
/**
|
||||
* 管理员操作日志服务
|
||||
*
|
||||
* 功能描述:
|
||||
* - 记录管理员的所有数据库操作
|
||||
* - 提供操作日志的查询和统计功能
|
||||
* - 支持敏感操作的特殊标记
|
||||
* - 实现日志的自动清理和归档
|
||||
*
|
||||
* 职责分离:
|
||||
* - 日志记录:记录操作的详细信息
|
||||
* - 日志查询:提供灵活的日志查询接口
|
||||
* - 日志统计:生成操作统计报告
|
||||
* - 日志管理:自动清理和归档功能
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 注释规范优化 - 为接口添加注释,完善文档说明 (修改者: moyin)
|
||||
* - 2026-01-08: 注释规范优化 - 添加类注释,完善服务文档说明 (修改者: moyin)
|
||||
* - 2026-01-08: 代码质量优化 - 提取魔法数字为常量,重构长方法,补充导入 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员操作日志服务 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.2.0
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Injectable, Logger } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository } from 'typeorm';
|
||||
import { AdminOperationLog } from './admin_operation_log.entity';
|
||||
import { LOG_QUERY_LIMITS, USER_QUERY_LIMITS, LOG_RETENTION } from './admin_constants';
|
||||
|
||||
/**
|
||||
* 创建日志参数接口
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义创建管理员操作日志所需的所有参数
|
||||
*
|
||||
* 使用场景:
|
||||
* - AdminOperationLogService.createLog()方法的参数类型
|
||||
* - 记录管理员操作的详细信息
|
||||
*/
|
||||
export interface CreateLogParams {
|
||||
adminUserId: string;
|
||||
adminUsername: string;
|
||||
operationType: 'CREATE' | 'UPDATE' | 'DELETE' | 'QUERY' | 'BATCH';
|
||||
targetType: string;
|
||||
targetId?: string;
|
||||
operationDescription: string;
|
||||
httpMethodPath: string;
|
||||
requestParams?: Record<string, any>;
|
||||
beforeData?: Record<string, any>;
|
||||
afterData?: Record<string, any>;
|
||||
operationResult: 'SUCCESS' | 'FAILED';
|
||||
errorMessage?: string;
|
||||
errorCode?: string;
|
||||
durationMs: number;
|
||||
clientIp?: string;
|
||||
userAgent?: string;
|
||||
requestId: string;
|
||||
context?: Record<string, any>;
|
||||
isSensitive?: boolean;
|
||||
affectedRecords?: number;
|
||||
batchId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 日志查询参数接口
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义查询管理员操作日志的过滤条件
|
||||
*
|
||||
* 使用场景:
|
||||
* - AdminOperationLogService.queryLogs()方法的参数类型
|
||||
* - 支持多维度的日志查询和过滤
|
||||
*/
|
||||
export interface LogQueryParams {
|
||||
adminUserId?: string;
|
||||
operationType?: string;
|
||||
targetType?: string;
|
||||
operationResult?: string;
|
||||
startDate?: Date;
|
||||
endDate?: Date;
|
||||
isSensitive?: boolean;
|
||||
limit?: number;
|
||||
offset?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 日志统计信息接口
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员操作日志的统计数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - AdminOperationLogService.getStatistics()方法的返回类型
|
||||
* - 提供操作统计和分析数据
|
||||
*/
|
||||
export interface LogStatistics {
|
||||
totalOperations: number;
|
||||
successfulOperations: number;
|
||||
failedOperations: number;
|
||||
operationsByType: Record<string, number>;
|
||||
operationsByTarget: Record<string, number>;
|
||||
averageDuration: number;
|
||||
sensitiveOperations: number;
|
||||
uniqueAdmins: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员操作日志服务
|
||||
*
|
||||
* 功能描述:
|
||||
* - 记录管理员的所有数据库操作
|
||||
* - 提供操作日志的查询和统计功能
|
||||
* - 支持敏感操作的特殊标记
|
||||
* - 实现日志的自动清理和归档
|
||||
*
|
||||
* 职责分离:
|
||||
* - 日志记录:记录操作的详细信息
|
||||
* - 日志查询:提供灵活的日志查询接口
|
||||
* - 日志统计:生成操作统计报告
|
||||
* - 日志管理:自动清理和归档功能
|
||||
*
|
||||
* 主要方法:
|
||||
* - createLog() - 创建操作日志记录
|
||||
* - queryLogs() - 查询操作日志
|
||||
* - getLogById() - 获取单个日志详情
|
||||
* - getStatistics() - 获取操作统计
|
||||
* - getSensitiveOperations() - 获取敏感操作日志
|
||||
* - getAdminOperationHistory() - 获取管理员操作历史
|
||||
* - cleanupExpiredLogs() - 清理过期日志
|
||||
*
|
||||
* 使用场景:
|
||||
* - 管理员操作审计
|
||||
* - 安全监控和异常检测
|
||||
* - 系统操作统计分析
|
||||
*/
|
||||
@Injectable()
|
||||
export class AdminOperationLogService {
|
||||
private readonly logger = new Logger(AdminOperationLogService.name);
|
||||
|
||||
constructor(
|
||||
@InjectRepository(AdminOperationLog)
|
||||
private readonly logRepository: Repository<AdminOperationLog>,
|
||||
) {
|
||||
this.logger.log('AdminOperationLogService初始化完成');
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建操作日志
|
||||
*
|
||||
* @param params 日志参数
|
||||
* @returns 创建的日志记录
|
||||
*/
|
||||
async createLog(params: CreateLogParams): Promise<AdminOperationLog> {
|
||||
try {
|
||||
const log = this.logRepository.create({
|
||||
admin_user_id: params.adminUserId,
|
||||
admin_username: params.adminUsername,
|
||||
operation_type: params.operationType,
|
||||
target_type: params.targetType,
|
||||
target_id: params.targetId,
|
||||
operation_description: params.operationDescription,
|
||||
http_method_path: params.httpMethodPath,
|
||||
request_params: params.requestParams,
|
||||
before_data: params.beforeData,
|
||||
after_data: params.afterData,
|
||||
operation_result: params.operationResult,
|
||||
error_message: params.errorMessage,
|
||||
error_code: params.errorCode,
|
||||
duration_ms: params.durationMs,
|
||||
client_ip: params.clientIp,
|
||||
user_agent: params.userAgent,
|
||||
request_id: params.requestId,
|
||||
context: params.context,
|
||||
is_sensitive: params.isSensitive || false,
|
||||
affected_records: params.affectedRecords || 0,
|
||||
batch_id: params.batchId,
|
||||
});
|
||||
|
||||
const savedLog = await this.logRepository.save(log);
|
||||
|
||||
this.logger.log('操作日志记录成功', {
|
||||
logId: savedLog.id,
|
||||
adminUserId: params.adminUserId,
|
||||
operationType: params.operationType,
|
||||
targetType: params.targetType,
|
||||
operationResult: params.operationResult
|
||||
});
|
||||
|
||||
return savedLog;
|
||||
} catch (error) {
|
||||
this.logger.error('操作日志记录失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
params
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 构建查询条件
|
||||
*
|
||||
* @param queryBuilder 查询构建器
|
||||
* @param params 查询参数
|
||||
*/
|
||||
private buildQueryConditions(queryBuilder: any, params: LogQueryParams): void {
|
||||
if (params.adminUserId) {
|
||||
queryBuilder.andWhere('log.admin_user_id = :adminUserId', { adminUserId: params.adminUserId });
|
||||
}
|
||||
|
||||
if (params.operationType) {
|
||||
queryBuilder.andWhere('log.operation_type = :operationType', { operationType: params.operationType });
|
||||
}
|
||||
|
||||
if (params.targetType) {
|
||||
queryBuilder.andWhere('log.target_type = :targetType', { targetType: params.targetType });
|
||||
}
|
||||
|
||||
if (params.operationResult) {
|
||||
queryBuilder.andWhere('log.operation_result = :operationResult', { operationResult: params.operationResult });
|
||||
}
|
||||
|
||||
if (params.startDate && params.endDate) {
|
||||
queryBuilder.andWhere('log.created_at BETWEEN :startDate AND :endDate', {
|
||||
startDate: params.startDate,
|
||||
endDate: params.endDate
|
||||
});
|
||||
}
|
||||
|
||||
if (params.isSensitive !== undefined) {
|
||||
queryBuilder.andWhere('log.is_sensitive = :isSensitive', { isSensitive: params.isSensitive });
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 查询操作日志
|
||||
*
|
||||
* @param params 查询参数
|
||||
* @returns 日志列表和总数
|
||||
*/
|
||||
async queryLogs(params: LogQueryParams): Promise<{ logs: AdminOperationLog[]; total: number }> {
|
||||
try {
|
||||
const queryBuilder = this.logRepository.createQueryBuilder('log');
|
||||
|
||||
// 构建查询条件
|
||||
this.buildQueryConditions(queryBuilder, params);
|
||||
|
||||
// 排序
|
||||
queryBuilder.orderBy('log.created_at', 'DESC');
|
||||
|
||||
// 分页
|
||||
const limit = params.limit || LOG_QUERY_LIMITS.DEFAULT_LOG_QUERY_LIMIT;
|
||||
const offset = params.offset || 0;
|
||||
queryBuilder.limit(limit).offset(offset);
|
||||
|
||||
const [logs, total] = await queryBuilder.getManyAndCount();
|
||||
|
||||
this.logger.log('操作日志查询成功', {
|
||||
total,
|
||||
returned: logs.length,
|
||||
params
|
||||
});
|
||||
|
||||
return { logs, total };
|
||||
} catch (error) {
|
||||
this.logger.error('操作日志查询失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
params
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据ID获取操作日志详情
|
||||
*
|
||||
* @param id 日志ID
|
||||
* @returns 日志详情
|
||||
*/
|
||||
async getLogById(id: string): Promise<AdminOperationLog | null> {
|
||||
try {
|
||||
const log = await this.logRepository.findOne({ where: { id } });
|
||||
|
||||
if (log) {
|
||||
this.logger.log('操作日志详情获取成功', { logId: id });
|
||||
} else {
|
||||
this.logger.warn('操作日志不存在', { logId: id });
|
||||
}
|
||||
|
||||
return log;
|
||||
} catch (error) {
|
||||
this.logger.error('操作日志详情获取失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
logId: id
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取操作统计信息
|
||||
*
|
||||
* @param startDate 开始日期
|
||||
* @param endDate 结束日期
|
||||
* @returns 统计信息
|
||||
*/
|
||||
async getStatistics(startDate?: Date, endDate?: Date): Promise<LogStatistics> {
|
||||
try {
|
||||
const queryBuilder = this.logRepository.createQueryBuilder('log');
|
||||
|
||||
if (startDate && endDate) {
|
||||
queryBuilder.where('log.created_at BETWEEN :startDate AND :endDate', {
|
||||
startDate,
|
||||
endDate
|
||||
});
|
||||
}
|
||||
|
||||
// 基础统计
|
||||
const totalOperations = await queryBuilder.getCount();
|
||||
|
||||
const successfulOperations = await queryBuilder
|
||||
.clone()
|
||||
.andWhere('log.operation_result = :result', { result: 'SUCCESS' })
|
||||
.getCount();
|
||||
|
||||
const failedOperations = totalOperations - successfulOperations;
|
||||
|
||||
const sensitiveOperations = await queryBuilder
|
||||
.clone()
|
||||
.andWhere('log.is_sensitive = :sensitive', { sensitive: true })
|
||||
.getCount();
|
||||
|
||||
// 按操作类型统计
|
||||
const operationTypeStats = await queryBuilder
|
||||
.clone()
|
||||
.select('log.operation_type', 'type')
|
||||
.addSelect('COUNT(*)', 'count')
|
||||
.groupBy('log.operation_type')
|
||||
.getRawMany();
|
||||
|
||||
const operationsByType = operationTypeStats.reduce((acc, stat) => {
|
||||
acc[stat.type] = parseInt(stat.count);
|
||||
return acc;
|
||||
}, {} as Record<string, number>);
|
||||
|
||||
// 按目标类型统计
|
||||
const targetTypeStats = await queryBuilder
|
||||
.clone()
|
||||
.select('log.target_type', 'type')
|
||||
.addSelect('COUNT(*)', 'count')
|
||||
.groupBy('log.target_type')
|
||||
.getRawMany();
|
||||
|
||||
const operationsByTarget = targetTypeStats.reduce((acc, stat) => {
|
||||
acc[stat.type] = parseInt(stat.count);
|
||||
return acc;
|
||||
}, {} as Record<string, number>);
|
||||
|
||||
// 平均耗时
|
||||
const avgDurationResult = await queryBuilder
|
||||
.clone()
|
||||
.select('AVG(log.duration_ms)', 'avgDuration')
|
||||
.getRawOne();
|
||||
|
||||
const averageDuration = parseFloat(avgDurationResult?.avgDuration || '0');
|
||||
|
||||
// 唯一管理员数量
|
||||
const uniqueAdminsResult = await queryBuilder
|
||||
.clone()
|
||||
.select('COUNT(DISTINCT log.admin_user_id)', 'uniqueAdmins')
|
||||
.getRawOne();
|
||||
|
||||
const uniqueAdmins = parseInt(uniqueAdminsResult?.uniqueAdmins || '0');
|
||||
|
||||
const statistics: LogStatistics = {
|
||||
totalOperations,
|
||||
successfulOperations,
|
||||
failedOperations,
|
||||
operationsByType,
|
||||
operationsByTarget,
|
||||
averageDuration,
|
||||
sensitiveOperations,
|
||||
uniqueAdmins
|
||||
};
|
||||
|
||||
this.logger.log('操作统计获取成功', statistics);
|
||||
|
||||
return statistics;
|
||||
} catch (error) {
|
||||
this.logger.error('操作统计获取失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
startDate,
|
||||
endDate
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 清理过期日志
|
||||
*
|
||||
* @param daysToKeep 保留天数
|
||||
* @returns 清理的记录数
|
||||
*/
|
||||
async cleanupExpiredLogs(daysToKeep: number = LOG_RETENTION.DEFAULT_DAYS): Promise<number> {
|
||||
try {
|
||||
const cutoffDate = new Date();
|
||||
cutoffDate.setDate(cutoffDate.getDate() - daysToKeep);
|
||||
|
||||
const result = await this.logRepository
|
||||
.createQueryBuilder()
|
||||
.delete()
|
||||
.where('created_at < :cutoffDate', { cutoffDate })
|
||||
.andWhere('is_sensitive = :sensitive', { sensitive: false }) // 保留敏感操作日志
|
||||
.execute();
|
||||
|
||||
const deletedCount = result.affected || 0;
|
||||
|
||||
this.logger.log('过期日志清理完成', {
|
||||
deletedCount,
|
||||
cutoffDate,
|
||||
daysToKeep
|
||||
});
|
||||
|
||||
return deletedCount;
|
||||
} catch (error) {
|
||||
this.logger.error('过期日志清理失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
daysToKeep
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取管理员操作历史
|
||||
*
|
||||
* @param adminUserId 管理员用户ID
|
||||
* @param limit 限制数量
|
||||
* @returns 操作历史
|
||||
*/
|
||||
async getAdminOperationHistory(adminUserId: string, limit: number = USER_QUERY_LIMITS.ADMIN_HISTORY_DEFAULT_LIMIT): Promise<AdminOperationLog[]> {
|
||||
try {
|
||||
const logs = await this.logRepository.find({
|
||||
where: { admin_user_id: adminUserId },
|
||||
order: { created_at: 'DESC' },
|
||||
take: limit
|
||||
});
|
||||
|
||||
this.logger.log('管理员操作历史获取成功', {
|
||||
adminUserId,
|
||||
count: logs.length
|
||||
});
|
||||
|
||||
return logs;
|
||||
} catch (error) {
|
||||
this.logger.error('管理员操作历史获取失败', {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
adminUserId
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取敏感操作日志
|
||||
*
|
||||
* @param limit 限制数量
|
||||
* @param offset 偏移量
|
||||
* @returns 敏感操作日志
|
||||
*/
|
||||
async getSensitiveOperations(limit: number = LOG_QUERY_LIMITS.SENSITIVE_LOG_DEFAULT_LIMIT, offset: number = 0): Promise<{ logs: AdminOperationLog[]; total: number }> {
|
||||
try {
|
||||
const [logs, total] = await this.logRepository.findAndCount({
|
||||
where: { is_sensitive: true },
|
||||
order: { created_at: 'DESC' },
|
||||
take: limit,
|
||||
skip: offset
|
||||
});
|
||||
|
||||
this.logger.log('敏感操作日志获取成功', {
|
||||
total,
|
||||
returned: logs.length
|
||||
});
|
||||
|
||||
return { logs, total };
|
||||
} catch (error) {
|
||||
this.logger.error('敏感操作日志获取失败', {
|
||||
error: error instanceof Error ? error.message : String(error)
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
258
src/business/admin/admin_property_test.base.ts
Normal file
258
src/business/admin/admin_property_test.base.ts
Normal file
@@ -0,0 +1,258 @@
|
||||
/**
|
||||
* 管理员系统属性测试基础框架
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供属性测试的基础工具和断言
|
||||
* - 实现通用的测试数据生成器
|
||||
* - 支持随机化测试和边界条件验证
|
||||
*
|
||||
* 属性测试原理:
|
||||
* - 验证系统在各种输入条件下的通用正确性属性
|
||||
* - 通过大量随机测试用例发现边界问题
|
||||
* - 确保系统行为的一致性和可靠性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 注释规范优化 - 为接口添加注释,完善文档说明 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建属性测试基础框架 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.2
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { faker } from '@faker-js/faker';
|
||||
import { Logger } from '@nestjs/common';
|
||||
import { UserStatus } from '../user_mgmt/user_status.enum';
|
||||
|
||||
/**
|
||||
* 属性测试配置接口
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义属性测试的运行配置参数
|
||||
*
|
||||
* 使用场景:
|
||||
* - 配置属性测试的迭代次数和超时时间
|
||||
* - 设置随机种子以确保测试的可重现性
|
||||
*/
|
||||
export interface PropertyTestConfig {
|
||||
iterations: number;
|
||||
timeout: number;
|
||||
seed?: number;
|
||||
}
|
||||
|
||||
export const DEFAULT_PROPERTY_CONFIG: PropertyTestConfig = {
|
||||
iterations: 100,
|
||||
timeout: 30000,
|
||||
seed: 12345
|
||||
};
|
||||
|
||||
/**
|
||||
* 属性测试生成器
|
||||
*/
|
||||
export class PropertyTestGenerators {
|
||||
private static setupFaker(seed?: number) {
|
||||
if (seed) {
|
||||
faker.seed(seed);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成随机用户数据
|
||||
*/
|
||||
static generateUser(seed?: number) {
|
||||
this.setupFaker(seed);
|
||||
return {
|
||||
username: faker.internet.username(),
|
||||
nickname: faker.person.fullName(),
|
||||
email: faker.internet.email(),
|
||||
phone: faker.phone.number(),
|
||||
role: faker.number.int({ min: 0, max: 9 }),
|
||||
status: faker.helpers.enumValue(UserStatus),
|
||||
avatar_url: faker.image.avatar(),
|
||||
github_id: faker.string.alphanumeric(10)
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成随机用户档案数据
|
||||
*/
|
||||
static generateUserProfile(seed?: number) {
|
||||
this.setupFaker(seed);
|
||||
return {
|
||||
user_id: faker.string.numeric(10),
|
||||
bio: faker.lorem.paragraph(),
|
||||
resume_content: faker.lorem.paragraphs(3),
|
||||
tags: JSON.stringify(faker.helpers.arrayElements(['developer', 'designer', 'manager'], { min: 1, max: 3 })),
|
||||
social_links: JSON.stringify({
|
||||
github: faker.internet.url(),
|
||||
linkedin: faker.internet.url()
|
||||
}),
|
||||
skin_id: faker.string.alphanumeric(8),
|
||||
current_map: faker.helpers.arrayElement(['plaza', 'forest', 'beach', 'mountain']),
|
||||
pos_x: faker.number.float({ min: 0, max: 1000 }),
|
||||
pos_y: faker.number.float({ min: 0, max: 1000 }),
|
||||
status: faker.number.int({ min: 0, max: 2 })
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成随机Zulip账号数据
|
||||
*/
|
||||
static generateZulipAccount(seed?: number) {
|
||||
this.setupFaker(seed);
|
||||
return {
|
||||
gameUserId: faker.string.numeric(10),
|
||||
zulipUserId: faker.number.int({ min: 1, max: 999999 }),
|
||||
zulipEmail: faker.internet.email(),
|
||||
zulipFullName: faker.person.fullName(),
|
||||
zulipApiKeyEncrypted: faker.string.alphanumeric(32),
|
||||
status: faker.helpers.arrayElement(['active', 'inactive', 'suspended', 'error'] as const)
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成随机分页参数
|
||||
*/
|
||||
static generatePaginationParams(seed?: number) {
|
||||
this.setupFaker(seed);
|
||||
return {
|
||||
limit: faker.number.int({ min: 1, max: 100 }),
|
||||
offset: faker.number.int({ min: 0, max: 1000 })
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成边界值测试数据
|
||||
*/
|
||||
static generateBoundaryValues() {
|
||||
return {
|
||||
limits: [0, 1, 50, 100, 101, 999, 1000],
|
||||
offsets: [0, 1, 100, 999, 1000, 9999],
|
||||
strings: ['', 'a', 'x'.repeat(50), 'x'.repeat(255), 'x'.repeat(256)],
|
||||
numbers: [-1, 0, 1, 999, 1000, 9999, 99999]
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 属性测试断言工具
|
||||
*/
|
||||
export class PropertyTestAssertions {
|
||||
/**
|
||||
* 验证API响应格式一致性
|
||||
*/
|
||||
static assertApiResponseFormat(response: any, shouldHaveData: boolean = true) {
|
||||
expect(response).toHaveProperty('success');
|
||||
expect(response).toHaveProperty('message');
|
||||
expect(response).toHaveProperty('timestamp');
|
||||
expect(response).toHaveProperty('request_id');
|
||||
|
||||
expect(typeof response.success).toBe('boolean');
|
||||
expect(typeof response.message).toBe('string');
|
||||
expect(typeof response.timestamp).toBe('string');
|
||||
expect(typeof response.request_id).toBe('string');
|
||||
|
||||
if (shouldHaveData && response.success) {
|
||||
expect(response).toHaveProperty('data');
|
||||
}
|
||||
|
||||
if (!response.success) {
|
||||
expect(response).toHaveProperty('error_code');
|
||||
expect(typeof response.error_code).toBe('string');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 验证列表响应格式
|
||||
*/
|
||||
static assertListResponseFormat(response: any) {
|
||||
this.assertApiResponseFormat(response, true);
|
||||
|
||||
expect(response.data).toHaveProperty('items');
|
||||
expect(response.data).toHaveProperty('total');
|
||||
expect(response.data).toHaveProperty('limit');
|
||||
expect(response.data).toHaveProperty('offset');
|
||||
expect(response.data).toHaveProperty('has_more');
|
||||
|
||||
expect(Array.isArray(response.data.items)).toBe(true);
|
||||
expect(typeof response.data.total).toBe('number');
|
||||
expect(typeof response.data.limit).toBe('number');
|
||||
expect(typeof response.data.offset).toBe('number');
|
||||
expect(typeof response.data.has_more).toBe('boolean');
|
||||
}
|
||||
|
||||
/**
|
||||
* 验证分页逻辑正确性
|
||||
*/
|
||||
static assertPaginationLogic(response: any, requestedLimit: number, requestedOffset: number) {
|
||||
this.assertListResponseFormat(response);
|
||||
|
||||
const { items, total, limit, offset, has_more } = response.data;
|
||||
|
||||
// 验证分页参数
|
||||
expect(limit).toBeLessThanOrEqual(100); // 最大限制
|
||||
expect(offset).toBeGreaterThanOrEqual(0);
|
||||
|
||||
// 验证has_more逻辑
|
||||
const expectedHasMore = offset + items.length < total;
|
||||
expect(has_more).toBe(expectedHasMore);
|
||||
|
||||
// 验证返回项目数量
|
||||
expect(items.length).toBeLessThanOrEqual(limit);
|
||||
}
|
||||
|
||||
/**
|
||||
* 验证CRUD操作一致性
|
||||
*/
|
||||
static assertCrudConsistency(createResponse: any, readResponse: any, updateResponse: any) {
|
||||
// 创建和读取的数据应该一致
|
||||
expect(createResponse.success).toBe(true);
|
||||
expect(readResponse.success).toBe(true);
|
||||
expect(createResponse.data.id).toBe(readResponse.data.id);
|
||||
|
||||
// 更新后的数据应该反映变更
|
||||
expect(updateResponse.success).toBe(true);
|
||||
expect(updateResponse.data.id).toBe(createResponse.data.id);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 属性测试运行器
|
||||
*/
|
||||
export class PropertyTestRunner {
|
||||
static async runPropertyTest<T>(
|
||||
testName: string,
|
||||
generator: () => T,
|
||||
testFunction: (input: T) => Promise<void>,
|
||||
config: PropertyTestConfig = DEFAULT_PROPERTY_CONFIG
|
||||
): Promise<void> {
|
||||
const logger = new Logger('PropertyTestRunner');
|
||||
logger.log(`Running property test: ${testName} with ${config.iterations} iterations`);
|
||||
|
||||
const failures: Array<{ iteration: number; input: T; error: any }> = [];
|
||||
|
||||
for (let i = 0; i < config.iterations; i++) {
|
||||
try {
|
||||
const input = generator();
|
||||
await testFunction(input);
|
||||
} catch (error) {
|
||||
failures.push({
|
||||
iteration: i,
|
||||
input: generator(), // 重新生成用于错误报告
|
||||
error
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (failures.length > 0) {
|
||||
const failureRate = (failures.length / config.iterations) * 100;
|
||||
logger.error(`Property test failed: ${failures.length}/${config.iterations} iterations failed (${failureRate.toFixed(2)}%)`);
|
||||
logger.error('First failure:', failures[0]);
|
||||
throw new Error(`Property test "${testName}" failed with ${failures.length} failures`);
|
||||
}
|
||||
|
||||
logger.log(`Property test "${testName}" passed all ${config.iterations} iterations`);
|
||||
}
|
||||
}
|
||||
166
src/business/admin/admin_response.dto.ts
Normal file
166
src/business/admin/admin_response.dto.ts
Normal file
@@ -0,0 +1,166 @@
|
||||
/**
|
||||
* 管理员响应 DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* - 定义管理员相关接口的响应格式
|
||||
* - 提供统一的API响应结构
|
||||
* - 支持Swagger文档自动生成
|
||||
*
|
||||
* 职责分离:
|
||||
* - 响应数据结构定义
|
||||
* - API文档生成支持
|
||||
* - 类型安全保障
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 为所有DTO类添加类注释,完善文档说明 (修改者: moyin)
|
||||
* - 2026-01-08: 文件夹扁平化 - 从dto/子文件夹移动到上级目录 (修改者: moyin)
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.3
|
||||
* @since 2025-12-19
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
|
||||
/**
|
||||
* 管理员登录响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员登录接口的响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - POST /admin/auth/login 接口的响应体
|
||||
* - 包含登录状态、Token和管理员基本信息
|
||||
*/
|
||||
export class AdminLoginResponseDto {
|
||||
@ApiProperty({ description: '是否成功', example: true })
|
||||
success: boolean;
|
||||
|
||||
@ApiProperty({ description: '消息', example: '登录成功' })
|
||||
message: string;
|
||||
|
||||
@ApiProperty({ description: 'JWT Token', example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' })
|
||||
token?: string;
|
||||
|
||||
@ApiProperty({ description: '管理员信息', required: false })
|
||||
admin?: {
|
||||
id: string;
|
||||
username: string;
|
||||
email: string;
|
||||
role: number;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员用户列表响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义获取用户列表接口的响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/users 接口的响应体
|
||||
* - 包含用户列表和分页信息
|
||||
*/
|
||||
export class AdminUsersResponseDto {
|
||||
@ApiProperty({ description: '是否成功', example: true })
|
||||
success: boolean;
|
||||
|
||||
@ApiProperty({ description: '消息', example: '获取用户列表成功' })
|
||||
message: string;
|
||||
|
||||
@ApiProperty({ description: '用户列表', type: 'array' })
|
||||
users?: Array<{
|
||||
id: string;
|
||||
username: string;
|
||||
email: string;
|
||||
phone: string;
|
||||
role: number;
|
||||
status: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}>;
|
||||
|
||||
@ApiProperty({ description: '总数', example: 100 })
|
||||
total?: number;
|
||||
|
||||
@ApiProperty({ description: '偏移量', example: 0 })
|
||||
offset?: number;
|
||||
|
||||
@ApiProperty({ description: '限制数量', example: 100 })
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员用户详情响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义获取单个用户详情接口的响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/users/:id 接口的响应体
|
||||
* - 包含用户的详细信息
|
||||
*/
|
||||
export class AdminUserResponseDto {
|
||||
@ApiProperty({ description: '是否成功', example: true })
|
||||
success: boolean;
|
||||
|
||||
@ApiProperty({ description: '消息', example: '获取用户详情成功' })
|
||||
message: string;
|
||||
|
||||
@ApiProperty({ description: '用户信息', required: false })
|
||||
user?: {
|
||||
id: string;
|
||||
username: string;
|
||||
email: string;
|
||||
phone: string;
|
||||
role: number;
|
||||
status: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
last_login_at?: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员通用响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员操作的通用响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - 各种管理员操作接口的通用响应体
|
||||
* - 包含操作状态和消息信息
|
||||
*/
|
||||
export class AdminCommonResponseDto {
|
||||
@ApiProperty({ description: '是否成功', example: true })
|
||||
success: boolean;
|
||||
|
||||
@ApiProperty({ description: '消息', example: '操作成功' })
|
||||
message: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员运行日志响应DTO
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义获取系统运行日志接口的响应数据结构
|
||||
*
|
||||
* 使用场景:
|
||||
* - GET /admin/logs/runtime 接口的响应体
|
||||
* - 包含系统运行日志内容
|
||||
*/
|
||||
export class AdminRuntimeLogsResponseDto {
|
||||
@ApiProperty({ description: '是否成功', example: true })
|
||||
success: boolean;
|
||||
|
||||
@ApiProperty({ description: '消息', example: '获取日志成功' })
|
||||
message: string;
|
||||
|
||||
@ApiProperty({ description: '日志内容', type: 'array', items: { type: 'string' } })
|
||||
logs?: string[];
|
||||
|
||||
@ApiProperty({ description: '返回行数', example: 200 })
|
||||
lines?: number;
|
||||
}
|
||||
316
src/business/admin/admin_utils.ts
Normal file
316
src/business/admin/admin_utils.ts
Normal file
@@ -0,0 +1,316 @@
|
||||
/**
|
||||
* 管理员模块工具函数
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供管理员模块通用的工具函数
|
||||
* - 消除重复代码,提高代码复用性
|
||||
* - 统一处理常见的业务逻辑
|
||||
*
|
||||
* 职责分离:
|
||||
* - 工具函数集中管理
|
||||
* - 重复逻辑抽象
|
||||
* - 通用功能封装
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 重构 - 文件夹扁平化,移动到上级目录并更新import路径 (修改者: moyin)
|
||||
* - 2026-01-08: 代码质量优化 - 提取魔法数字为常量,添加用户格式化工具和操作监控工具 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员模块工具函数 (修改者: moyin)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.3.0
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { PAGINATION_LIMITS, REQUEST_ID_PREFIXES, SENSITIVE_FIELDS } from './admin_constants';
|
||||
|
||||
/**
|
||||
* 请求ID生成常量
|
||||
*/
|
||||
const REQUEST_ID_RANDOM_LENGTH = 9; // 随机字符串长度
|
||||
const REQUEST_ID_RANDOM_START = 2; // 跳过'0.'前缀
|
||||
|
||||
/**
|
||||
* 安全限制查询数量
|
||||
*
|
||||
* @param limit 请求的限制数量
|
||||
* @param maxLimit 最大允许的限制数量
|
||||
* @returns 安全的限制数量
|
||||
*/
|
||||
export function safeLimitValue(limit: number, maxLimit: number): number {
|
||||
return Math.min(Math.max(limit, 1), maxLimit);
|
||||
}
|
||||
|
||||
/**
|
||||
* 安全限制偏移量
|
||||
*
|
||||
* @param offset 请求的偏移量
|
||||
* @returns 安全的偏移量(不小于0)
|
||||
*/
|
||||
export function safeOffsetValue(offset: number): number {
|
||||
return Math.max(offset, PAGINATION_LIMITS.DEFAULT_OFFSET);
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成唯一的请求ID
|
||||
*
|
||||
* @param prefix 请求ID前缀
|
||||
* @returns 唯一的请求ID
|
||||
*/
|
||||
export function generateRequestId(prefix: string = REQUEST_ID_PREFIXES.GENERAL): string {
|
||||
return `${prefix}_${Date.now()}_${Math.random().toString(36).substring(REQUEST_ID_RANDOM_START, REQUEST_ID_RANDOM_START + REQUEST_ID_RANDOM_LENGTH)}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取当前时间戳字符串
|
||||
*
|
||||
* @returns ISO格式的时间戳字符串
|
||||
*/
|
||||
export function getCurrentTimestamp(): string {
|
||||
return new Date().toISOString();
|
||||
}
|
||||
|
||||
/**
|
||||
* 清理请求体中的敏感信息
|
||||
*
|
||||
* @param body 请求体对象
|
||||
* @returns 清理后的请求体
|
||||
*/
|
||||
export function sanitizeRequestBody(body: any): any {
|
||||
if (!body || typeof body !== 'object') {
|
||||
return body;
|
||||
}
|
||||
|
||||
const sanitized = { ...body };
|
||||
|
||||
for (const field of SENSITIVE_FIELDS) {
|
||||
if (sanitized[field]) {
|
||||
sanitized[field] = '***REDACTED***';
|
||||
}
|
||||
}
|
||||
|
||||
return sanitized;
|
||||
}
|
||||
|
||||
/**
|
||||
* 提取客户端IP地址
|
||||
*
|
||||
* @param request 请求对象
|
||||
* @returns 客户端IP地址
|
||||
*/
|
||||
export function extractClientIp(request: any): string {
|
||||
return request.ip ||
|
||||
request.connection?.remoteAddress ||
|
||||
request.socket?.remoteAddress ||
|
||||
(request.connection?.socket as any)?.remoteAddress ||
|
||||
request.headers['x-forwarded-for']?.split(',')[0] ||
|
||||
request.headers['x-real-ip'] ||
|
||||
'unknown';
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建标准的成功响应
|
||||
*
|
||||
* @param data 响应数据
|
||||
* @param message 响应消息
|
||||
* @param requestIdPrefix 请求ID前缀
|
||||
* @returns 标准格式的成功响应
|
||||
*/
|
||||
export function createSuccessResponse<T>(
|
||||
data: T,
|
||||
message: string,
|
||||
requestIdPrefix?: string
|
||||
): {
|
||||
success: true;
|
||||
data: T;
|
||||
message: string;
|
||||
timestamp: string;
|
||||
request_id: string;
|
||||
} {
|
||||
return {
|
||||
success: true,
|
||||
data,
|
||||
message,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId(requestIdPrefix)
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建标准的错误响应
|
||||
*
|
||||
* @param message 错误消息
|
||||
* @param errorCode 错误码
|
||||
* @param requestIdPrefix 请求ID前缀
|
||||
* @returns 标准格式的错误响应
|
||||
*/
|
||||
export function createErrorResponse(
|
||||
message: string,
|
||||
errorCode?: string,
|
||||
requestIdPrefix?: string
|
||||
): {
|
||||
success: false;
|
||||
message: string;
|
||||
error_code?: string;
|
||||
timestamp: string;
|
||||
request_id: string;
|
||||
} {
|
||||
return {
|
||||
success: false,
|
||||
message,
|
||||
error_code: errorCode,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId(requestIdPrefix)
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建标准的列表响应
|
||||
*
|
||||
* @param items 列表项
|
||||
* @param total 总数
|
||||
* @param limit 限制数量
|
||||
* @param offset 偏移量
|
||||
* @param message 响应消息
|
||||
* @param requestIdPrefix 请求ID前缀
|
||||
* @returns 标准格式的列表响应
|
||||
*/
|
||||
export function createListResponse<T>(
|
||||
items: T[],
|
||||
total: number,
|
||||
limit: number,
|
||||
offset: number,
|
||||
message: string,
|
||||
requestIdPrefix?: string
|
||||
): {
|
||||
success: true;
|
||||
data: {
|
||||
items: T[];
|
||||
total: number;
|
||||
limit: number;
|
||||
offset: number;
|
||||
has_more: boolean;
|
||||
};
|
||||
message: string;
|
||||
timestamp: string;
|
||||
request_id: string;
|
||||
} {
|
||||
return {
|
||||
success: true,
|
||||
data: {
|
||||
items,
|
||||
total,
|
||||
limit,
|
||||
offset,
|
||||
has_more: offset + items.length < total
|
||||
},
|
||||
message,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId(requestIdPrefix)
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 限制保留天数在合理范围内
|
||||
*
|
||||
* @param daysToKeep 请求的保留天数
|
||||
* @param minDays 最少保留天数
|
||||
* @param maxDays 最多保留天数
|
||||
* @returns 安全的保留天数
|
||||
*/
|
||||
export function safeDaysToKeep(daysToKeep: number, minDays: number, maxDays: number): number {
|
||||
return Math.max(minDays, Math.min(daysToKeep, maxDays));
|
||||
}
|
||||
|
||||
/**
|
||||
* 用户数据格式化工具
|
||||
*/
|
||||
export class UserFormatter {
|
||||
/**
|
||||
* 格式化用户基本信息
|
||||
*
|
||||
* @param user 用户实体
|
||||
* @returns 格式化的用户信息
|
||||
*/
|
||||
static formatBasicUser(user: any) {
|
||||
return {
|
||||
id: user.id.toString(),
|
||||
username: user.username,
|
||||
nickname: user.nickname,
|
||||
email: user.email,
|
||||
phone: user.phone,
|
||||
role: user.role,
|
||||
status: user.status,
|
||||
email_verified: user.email_verified,
|
||||
avatar_url: user.avatar_url,
|
||||
created_at: user.created_at,
|
||||
updated_at: user.updated_at
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 格式化用户详细信息(包含GitHub ID)
|
||||
*
|
||||
* @param user 用户实体
|
||||
* @returns 格式化的用户详细信息
|
||||
*/
|
||||
static formatDetailedUser(user: any) {
|
||||
return {
|
||||
...this.formatBasicUser(user),
|
||||
github_id: user.github_id
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 操作性能监控工具
|
||||
*/
|
||||
export class OperationMonitor {
|
||||
/**
|
||||
* 执行带性能监控的操作
|
||||
*
|
||||
* @param operationName 操作名称
|
||||
* @param context 操作上下文
|
||||
* @param operation 要执行的操作
|
||||
* @param logger 日志记录器
|
||||
* @returns 操作结果
|
||||
*/
|
||||
static async executeWithMonitoring<T>(
|
||||
operationName: string,
|
||||
context: Record<string, any>,
|
||||
operation: () => Promise<T>,
|
||||
logger: (level: 'log' | 'warn' | 'error', message: string, context: Record<string, any>) => void
|
||||
): Promise<T> {
|
||||
const startTime = Date.now();
|
||||
|
||||
logger('log', `开始${operationName}`, {
|
||||
operation: operationName,
|
||||
...context
|
||||
});
|
||||
|
||||
try {
|
||||
const result = await operation();
|
||||
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
logger('log', `${operationName}成功`, {
|
||||
operation: operationName,
|
||||
duration,
|
||||
...context
|
||||
});
|
||||
|
||||
return result;
|
||||
} catch (error) {
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
logger('error', `${operationName}失败`, {
|
||||
operation: operationName,
|
||||
duration,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
...context
|
||||
});
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
271
src/business/admin/api_response_format.property.spec.ts
Normal file
271
src/business/admin/api_response_format.property.spec.ts
Normal file
@@ -0,0 +1,271 @@
|
||||
/**
|
||||
* API响应格式一致性属性测试
|
||||
*
|
||||
* Property 7: API响应格式一致性
|
||||
* Validates: Requirements 4.1, 4.2, 4.3
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证所有API端点返回统一的响应格式
|
||||
* - 确保成功和失败响应都符合规范
|
||||
* - 验证响应字段类型和必需性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建API响应格式属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: API响应格式一致性', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
|
||||
beforeAll(async () => {
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockImplementation(() => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return Promise.resolve({ ...user, id: BigInt(1) });
|
||||
}),
|
||||
create: jest.fn().mockImplementation((userData) => {
|
||||
return Promise.resolve({ ...userData, id: BigInt(1) });
|
||||
}),
|
||||
update: jest.fn().mockImplementation((id, updateData) => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return Promise.resolve({ ...user, ...updateData, id });
|
||||
}),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
search: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockImplementation(() => {
|
||||
const profile = PropertyTestGenerators.generateUserProfile();
|
||||
return Promise.resolve({ ...profile, id: BigInt(1) });
|
||||
}),
|
||||
create: jest.fn().mockImplementation((profileData) => {
|
||||
return Promise.resolve({ ...profileData, id: BigInt(1) });
|
||||
}),
|
||||
update: jest.fn().mockImplementation((id, updateData) => {
|
||||
const profile = PropertyTestGenerators.generateUserProfile();
|
||||
return Promise.resolve({ ...profile, ...updateData, id });
|
||||
}),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
findByMap: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: {
|
||||
findMany: jest.fn().mockResolvedValue({ accounts: [] }),
|
||||
findById: jest.fn().mockImplementation(() => {
|
||||
const account = PropertyTestGenerators.generateZulipAccount();
|
||||
return Promise.resolve({ ...account, id: '1' });
|
||||
}),
|
||||
create: jest.fn().mockImplementation((accountData) => {
|
||||
return Promise.resolve({ ...accountData, id: '1' });
|
||||
}),
|
||||
update: jest.fn().mockImplementation((id, updateData) => {
|
||||
const account = PropertyTestGenerators.generateZulipAccount();
|
||||
return Promise.resolve({ ...account, ...updateData, id });
|
||||
}),
|
||||
delete: jest.fn().mockResolvedValue(undefined),
|
||||
getStatusStatistics: jest.fn().mockResolvedValue({
|
||||
active: 0,
|
||||
inactive: 0,
|
||||
suspended: 0,
|
||||
error: 0,
|
||||
total: 0
|
||||
})
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
describe('Property 7: API响应格式一致性', () => {
|
||||
it('所有成功响应应该有统一的格式', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'API成功响应格式一致性',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 测试用户管理端点
|
||||
const userListResponse = await controller.getUserList(20, 0);
|
||||
PropertyTestAssertions.assertListResponseFormat(userListResponse);
|
||||
|
||||
const userDetailResponse = await controller.getUserById('1');
|
||||
PropertyTestAssertions.assertApiResponseFormat(userDetailResponse, true);
|
||||
|
||||
const createUserResponse = await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
PropertyTestAssertions.assertApiResponseFormat(createUserResponse, true);
|
||||
|
||||
// 测试用户档案管理端点
|
||||
const profileListResponse = await controller.getUserProfileList(20, 0);
|
||||
PropertyTestAssertions.assertListResponseFormat(profileListResponse);
|
||||
|
||||
const profileDetailResponse = await controller.getUserProfileById('1');
|
||||
PropertyTestAssertions.assertApiResponseFormat(profileDetailResponse, true);
|
||||
|
||||
// 测试Zulip账号管理端点
|
||||
const zulipListResponse = await controller.getZulipAccountList(20, 0);
|
||||
PropertyTestAssertions.assertListResponseFormat(zulipListResponse);
|
||||
|
||||
const zulipDetailResponse = await controller.getZulipAccountById('1');
|
||||
PropertyTestAssertions.assertApiResponseFormat(zulipDetailResponse, true);
|
||||
|
||||
const zulipStatsResponse = await controller.getZulipAccountStatistics();
|
||||
PropertyTestAssertions.assertApiResponseFormat(zulipStatsResponse, true);
|
||||
|
||||
// 测试系统端点
|
||||
const healthResponse = await controller.healthCheck();
|
||||
PropertyTestAssertions.assertApiResponseFormat(healthResponse, true);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 50 }
|
||||
);
|
||||
});
|
||||
|
||||
it('所有列表响应应该有正确的分页信息', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'列表响应分页格式一致性',
|
||||
() => PropertyTestGenerators.generatePaginationParams(),
|
||||
async (paginationParams) => {
|
||||
const { limit, offset } = paginationParams;
|
||||
|
||||
// 限制参数范围以避免无效请求
|
||||
const safeLimit = Math.min(Math.max(limit, 1), 100);
|
||||
const safeOffset = Math.max(offset, 0);
|
||||
|
||||
// 测试所有列表端点
|
||||
const userListResponse = await controller.getUserList(safeLimit, safeOffset);
|
||||
PropertyTestAssertions.assertPaginationLogic(userListResponse, safeLimit, safeOffset);
|
||||
|
||||
const profileListResponse = await controller.getUserProfileList(safeLimit, safeOffset);
|
||||
PropertyTestAssertions.assertPaginationLogic(profileListResponse, safeLimit, safeOffset);
|
||||
|
||||
const zulipListResponse = await controller.getZulipAccountList(safeLimit, safeOffset);
|
||||
PropertyTestAssertions.assertPaginationLogic(zulipListResponse, safeLimit, safeOffset);
|
||||
|
||||
const mapProfilesResponse = await controller.getUserProfilesByMap('plaza', safeLimit, safeOffset);
|
||||
PropertyTestAssertions.assertPaginationLogic(mapProfilesResponse, safeLimit, safeOffset);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
|
||||
it('响应时间戳应该是有效的ISO格式', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'响应时间戳格式验证',
|
||||
() => ({}),
|
||||
async () => {
|
||||
const response = await controller.healthCheck();
|
||||
|
||||
expect(response.timestamp).toBeDefined();
|
||||
expect(typeof response.timestamp).toBe('string');
|
||||
|
||||
// 验证ISO 8601格式
|
||||
const timestamp = new Date(response.timestamp);
|
||||
expect(timestamp.toISOString()).toBe(response.timestamp);
|
||||
|
||||
// 验证时间戳是最近的(在过去1分钟内)
|
||||
const now = new Date();
|
||||
const timeDiff = now.getTime() - timestamp.getTime();
|
||||
expect(timeDiff).toBeLessThan(60000); // 1分钟
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('请求ID应该是唯一的', async () => {
|
||||
const requestIds = new Set<string>();
|
||||
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'请求ID唯一性验证',
|
||||
() => ({}),
|
||||
async () => {
|
||||
const response = await controller.healthCheck();
|
||||
|
||||
expect(response.request_id).toBeDefined();
|
||||
expect(typeof response.request_id).toBe('string');
|
||||
expect(response.request_id.length).toBeGreaterThan(0);
|
||||
|
||||
// 验证请求ID唯一性
|
||||
expect(requestIds.has(response.request_id)).toBe(false);
|
||||
requestIds.add(response.request_id);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 100 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
564
src/business/admin/database_management.service.ts
Normal file
564
src/business/admin/database_management.service.ts
Normal file
@@ -0,0 +1,564 @@
|
||||
/**
|
||||
* 数据库管理服务
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供统一的数据库管理接口,集成所有数据库服务的CRUD操作
|
||||
* - 实现管理员专用的数据库操作功能
|
||||
* - 提供统一的响应格式和错误处理
|
||||
* - 支持操作日志记录和审计功能
|
||||
*
|
||||
* 职责分离:
|
||||
* - 业务逻辑编排:协调各个数据库服务的操作
|
||||
* - 数据转换:DTO与实体之间的转换
|
||||
* - 权限控制:确保只有管理员可以执行操作
|
||||
* - 日志记录:记录所有数据库操作的详细日志
|
||||
*
|
||||
* 集成的服务:
|
||||
* - UsersService: 用户数据管理
|
||||
* - UserProfilesService: 用户档案管理
|
||||
* - ZulipAccountsService: Zulip账号关联管理
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 注释规范优化 - 完善方法注释,添加@param、@returns、@throws和@example (修改者: moyin)
|
||||
* - 2026-01-08: 代码规范优化 - 将魔法数字20提取为常量DEFAULT_PAGE_SIZE (修改者: moyin)
|
||||
* - 2026-01-08: 代码质量优化 - 提取用户格式化逻辑,补充缺失方法实现,使用操作监控工具 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建数据库管理服务,支持管理员数据库操作 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.2.0
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Injectable, Logger, NotFoundException, BadRequestException, ConflictException, Inject } from '@nestjs/common';
|
||||
import { UsersService } from '../../core/db/users/users.service';
|
||||
import { generateRequestId, getCurrentTimestamp, UserFormatter, OperationMonitor } from './admin_utils';
|
||||
|
||||
/**
|
||||
* 常量定义
|
||||
*/
|
||||
const DEFAULT_PAGE_SIZE = 20;
|
||||
|
||||
/**
|
||||
* 管理员API统一响应格式
|
||||
*/
|
||||
export interface AdminApiResponse<T = any> {
|
||||
success: boolean;
|
||||
data?: T;
|
||||
message: string;
|
||||
error_code?: string;
|
||||
timestamp?: string;
|
||||
request_id?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 管理员列表响应格式
|
||||
*/
|
||||
export interface AdminListResponse<T = any> {
|
||||
success: boolean;
|
||||
data: {
|
||||
items: T[];
|
||||
total: number;
|
||||
limit: number;
|
||||
offset: number;
|
||||
has_more: boolean;
|
||||
};
|
||||
message: string;
|
||||
error_code?: string;
|
||||
timestamp?: string;
|
||||
request_id?: string;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class DatabaseManagementService {
|
||||
private readonly logger = new Logger(DatabaseManagementService.name);
|
||||
|
||||
constructor(
|
||||
@Inject('UsersService') private readonly usersService: UsersService,
|
||||
) {
|
||||
this.logger.log('DatabaseManagementService初始化完成');
|
||||
}
|
||||
|
||||
/**
|
||||
* 记录操作日志
|
||||
*
|
||||
* @param level 日志级别
|
||||
* @param message 日志消息
|
||||
* @param context 日志上下文
|
||||
*/
|
||||
private logOperation(level: 'log' | 'warn' | 'error', message: string, context: Record<string, any>): void {
|
||||
this.logger[level](message, {
|
||||
...context,
|
||||
timestamp: getCurrentTimestamp()
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建标准的成功响应
|
||||
*
|
||||
* 功能描述:
|
||||
* 创建符合管理员API标准格式的成功响应对象
|
||||
*
|
||||
* @param data 响应数据
|
||||
* @param message 响应消息
|
||||
* @returns 标准格式的成功响应
|
||||
*/
|
||||
private createSuccessResponse<T>(data: T, message: string): AdminApiResponse<T> {
|
||||
return {
|
||||
success: true,
|
||||
data,
|
||||
message,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建标准的错误响应
|
||||
*
|
||||
* 功能描述:
|
||||
* 创建符合管理员API标准格式的错误响应对象
|
||||
*
|
||||
* @param message 错误消息
|
||||
* @param errorCode 错误码
|
||||
* @returns 标准格式的错误响应
|
||||
*/
|
||||
private createErrorResponse(message: string, errorCode?: string): AdminApiResponse {
|
||||
return {
|
||||
success: false,
|
||||
message,
|
||||
error_code: errorCode,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建标准的列表响应
|
||||
*
|
||||
* 功能描述:
|
||||
* 创建符合管理员API标准格式的列表响应对象,包含分页信息
|
||||
*
|
||||
* @param items 列表项
|
||||
* @param total 总数
|
||||
* @param limit 限制数量
|
||||
* @param offset 偏移量
|
||||
* @param message 响应消息
|
||||
* @returns 标准格式的列表响应
|
||||
*/
|
||||
private createListResponse<T>(
|
||||
items: T[],
|
||||
total: number,
|
||||
limit: number,
|
||||
offset: number,
|
||||
message: string
|
||||
): AdminListResponse<T> {
|
||||
return {
|
||||
success: true,
|
||||
data: {
|
||||
items,
|
||||
total,
|
||||
limit,
|
||||
offset,
|
||||
has_more: offset + items.length < total
|
||||
},
|
||||
message,
|
||||
timestamp: getCurrentTimestamp(),
|
||||
request_id: generateRequestId()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 处理服务异常
|
||||
*
|
||||
* @param error 异常对象
|
||||
* @param operation 操作名称
|
||||
* @param context 操作上下文
|
||||
* @returns 错误响应
|
||||
*/
|
||||
private handleServiceError(error: any, operation: string, context: Record<string, any>): AdminApiResponse {
|
||||
this.logOperation('error', `${operation}失败`, {
|
||||
operation,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
context
|
||||
});
|
||||
|
||||
if (error instanceof NotFoundException) {
|
||||
return this.createErrorResponse(error.message, 'RESOURCE_NOT_FOUND');
|
||||
}
|
||||
|
||||
if (error instanceof ConflictException) {
|
||||
return this.createErrorResponse(error.message, 'RESOURCE_CONFLICT');
|
||||
}
|
||||
|
||||
if (error instanceof BadRequestException) {
|
||||
return this.createErrorResponse(error.message, 'INVALID_REQUEST');
|
||||
}
|
||||
|
||||
return this.createErrorResponse(`${operation}失败,请稍后重试`, 'INTERNAL_ERROR');
|
||||
}
|
||||
|
||||
/**
|
||||
* 处理列表查询异常
|
||||
*
|
||||
* @param error 异常对象
|
||||
* @param operation 操作名称
|
||||
* @param context 操作上下文
|
||||
* @returns 空列表响应
|
||||
*/
|
||||
private handleListError(error: any, operation: string, context: Record<string, any>): AdminListResponse {
|
||||
this.logOperation('error', `${operation}失败`, {
|
||||
operation,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
context
|
||||
});
|
||||
|
||||
return this.createListResponse([], 0, context.limit || DEFAULT_PAGE_SIZE, context.offset || 0, `${operation}失败,返回空列表`);
|
||||
}
|
||||
|
||||
// ==================== 用户管理方法 ====================
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
*
|
||||
* 功能描述:
|
||||
* 分页获取系统中的用户列表,支持限制数量和偏移量参数
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 记录操作开始时间和参数
|
||||
* 2. 调用用户服务获取用户数据和总数
|
||||
* 3. 格式化用户信息,隐藏敏感字段
|
||||
* 4. 记录操作成功日志和性能数据
|
||||
* 5. 返回标准化的列表响应
|
||||
*
|
||||
* @param limit 限制数量,默认20,最大100
|
||||
* @param offset 偏移量,默认0,用于分页
|
||||
* @returns 包含用户列表、总数和分页信息的响应对象
|
||||
*
|
||||
* @throws NotFoundException 当查询条件无效时
|
||||
* @throws InternalServerErrorException 当数据库操作失败时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await service.getUserList(20, 0);
|
||||
* console.log(result.data.items.length); // 用户数量
|
||||
* console.log(result.data.total); // 总用户数
|
||||
* ```
|
||||
*/
|
||||
async getUserList(limit: number = DEFAULT_PAGE_SIZE, offset: number = 0): Promise<AdminListResponse> {
|
||||
return await OperationMonitor.executeWithMonitoring(
|
||||
'获取用户列表',
|
||||
{ limit, offset },
|
||||
async () => {
|
||||
const users = await this.usersService.findAll(limit, offset);
|
||||
const total = await this.usersService.count();
|
||||
const formattedUsers = users.map(user => UserFormatter.formatBasicUser(user));
|
||||
return this.createListResponse(formattedUsers, total, limit, offset, '用户列表获取成功');
|
||||
},
|
||||
this.logOperation.bind(this)
|
||||
).catch(error => this.handleListError(error, '获取用户列表', { limit, offset }));
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据ID获取用户详情
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据用户ID获取指定用户的详细信息
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 记录操作开始时间和用户ID
|
||||
* 2. 调用用户服务查询用户信息
|
||||
* 3. 格式化用户详细信息
|
||||
* 4. 记录操作成功日志和性能数据
|
||||
* 5. 返回标准化的详情响应
|
||||
*
|
||||
* @param id 用户ID,必须是有效的bigint类型
|
||||
* @returns 包含用户详细信息的响应对象
|
||||
*
|
||||
* @throws NotFoundException 当用户不存在时
|
||||
* @throws BadRequestException 当用户ID格式无效时
|
||||
* @throws InternalServerErrorException 当数据库操作失败时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await service.getUserById(BigInt(123));
|
||||
* console.log(result.data.username); // 用户名
|
||||
* console.log(result.data.email); // 邮箱
|
||||
* ```
|
||||
*/
|
||||
async getUserById(id: bigint): Promise<AdminApiResponse> {
|
||||
return await OperationMonitor.executeWithMonitoring(
|
||||
'获取用户详情',
|
||||
{ userId: id.toString() },
|
||||
async () => {
|
||||
const user = await this.usersService.findOne(id);
|
||||
const formattedUser = UserFormatter.formatDetailedUser(user);
|
||||
return this.createSuccessResponse(formattedUser, '用户详情获取成功');
|
||||
},
|
||||
this.logOperation.bind(this)
|
||||
).catch(error => this.handleServiceError(error, '获取用户详情', { userId: id.toString() }));
|
||||
}
|
||||
|
||||
/**
|
||||
* 搜索用户
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据关键词搜索用户,支持用户名、邮箱、昵称等字段的模糊匹配
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 记录搜索操作开始时间和关键词
|
||||
* 2. 调用用户服务执行搜索查询
|
||||
* 3. 格式化搜索结果
|
||||
* 4. 记录搜索成功日志和性能数据
|
||||
* 5. 返回标准化的搜索响应
|
||||
*
|
||||
* @param keyword 搜索关键词,支持用户名、邮箱、昵称的模糊匹配
|
||||
* @param limit 返回结果数量限制,默认20,最大50
|
||||
* @returns 包含搜索结果的响应对象
|
||||
*
|
||||
* @throws BadRequestException 当关键词为空或格式无效时
|
||||
* @throws InternalServerErrorException 当搜索操作失败时
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const result = await service.searchUsers('admin', 10);
|
||||
* console.log(result.data.items); // 搜索结果列表
|
||||
* ```
|
||||
*/
|
||||
async searchUsers(keyword: string, limit: number = DEFAULT_PAGE_SIZE): Promise<AdminListResponse> {
|
||||
return await OperationMonitor.executeWithMonitoring(
|
||||
'搜索用户',
|
||||
{ keyword, limit },
|
||||
async () => {
|
||||
const users = await this.usersService.search(keyword, limit);
|
||||
const formattedUsers = users.map(user => UserFormatter.formatBasicUser(user));
|
||||
return this.createListResponse(formattedUsers, users.length, limit, 0, '用户搜索成功');
|
||||
},
|
||||
this.logOperation.bind(this)
|
||||
).catch(error => this.handleListError(error, '搜索用户', { keyword, limit }));
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建用户
|
||||
*
|
||||
* @param userData 用户数据
|
||||
* @returns 创建结果响应
|
||||
*/
|
||||
async createUser(userData: any): Promise<AdminApiResponse> {
|
||||
return await OperationMonitor.executeWithMonitoring(
|
||||
'创建用户',
|
||||
{ username: userData.username },
|
||||
async () => {
|
||||
const newUser = await this.usersService.create(userData);
|
||||
const formattedUser = UserFormatter.formatBasicUser(newUser);
|
||||
return this.createSuccessResponse(formattedUser, '用户创建成功');
|
||||
},
|
||||
this.logOperation.bind(this)
|
||||
).catch(error => this.handleServiceError(error, '创建用户', { username: userData.username }));
|
||||
}
|
||||
|
||||
/**
|
||||
* 更新用户
|
||||
*
|
||||
* @param id 用户ID
|
||||
* @param updateData 更新数据
|
||||
* @returns 更新结果响应
|
||||
*/
|
||||
async updateUser(id: bigint, updateData: any): Promise<AdminApiResponse> {
|
||||
return await OperationMonitor.executeWithMonitoring(
|
||||
'更新用户',
|
||||
{ userId: id.toString(), updateFields: Object.keys(updateData) },
|
||||
async () => {
|
||||
const updatedUser = await this.usersService.update(id, updateData);
|
||||
const formattedUser = UserFormatter.formatBasicUser(updatedUser);
|
||||
return this.createSuccessResponse(formattedUser, '用户更新成功');
|
||||
},
|
||||
this.logOperation.bind(this)
|
||||
).catch(error => this.handleServiceError(error, '更新用户', { userId: id.toString(), updateData }));
|
||||
}
|
||||
|
||||
/**
|
||||
* 删除用户
|
||||
*
|
||||
* @param id 用户ID
|
||||
* @returns 删除结果响应
|
||||
*/
|
||||
async deleteUser(id: bigint): Promise<AdminApiResponse> {
|
||||
return await OperationMonitor.executeWithMonitoring(
|
||||
'删除用户',
|
||||
{ userId: id.toString() },
|
||||
async () => {
|
||||
await this.usersService.remove(id);
|
||||
return this.createSuccessResponse({ deleted: true, id: id.toString() }, '用户删除成功');
|
||||
},
|
||||
this.logOperation.bind(this)
|
||||
).catch(error => this.handleServiceError(error, '删除用户', { userId: id.toString() }));
|
||||
}
|
||||
|
||||
// ==================== 用户档案管理方法 ====================
|
||||
|
||||
/**
|
||||
* 获取用户档案列表
|
||||
*
|
||||
* @param limit 限制数量
|
||||
* @param offset 偏移量
|
||||
* @returns 用户档案列表响应
|
||||
*/
|
||||
async getUserProfileList(limit: number = DEFAULT_PAGE_SIZE, offset: number = 0): Promise<AdminListResponse> {
|
||||
// TODO: 实现用户档案列表查询
|
||||
return this.createListResponse([], 0, limit, offset, '用户档案列表获取成功(暂未实现)');
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据ID获取用户档案详情
|
||||
*
|
||||
* @param id 档案ID
|
||||
* @returns 用户档案详情响应
|
||||
*/
|
||||
async getUserProfileById(id: bigint): Promise<AdminApiResponse> {
|
||||
// TODO: 实现用户档案详情查询
|
||||
return this.createErrorResponse('用户档案详情查询暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据地图获取用户档案
|
||||
*
|
||||
* @param mapId 地图ID
|
||||
* @param limit 限制数量
|
||||
* @param offset 偏移量
|
||||
* @returns 用户档案列表响应
|
||||
*/
|
||||
async getUserProfilesByMap(mapId: string, limit: number = DEFAULT_PAGE_SIZE, offset: number = 0): Promise<AdminListResponse> {
|
||||
// TODO: 实现按地图查询用户档案
|
||||
return this.createListResponse([], 0, limit, offset, `地图 ${mapId} 的用户档案列表获取成功(暂未实现)`);
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建用户档案
|
||||
*
|
||||
* @param createProfileDto 创建数据
|
||||
* @returns 创建结果响应
|
||||
*/
|
||||
async createUserProfile(createProfileDto: any): Promise<AdminApiResponse> {
|
||||
// TODO: 实现用户档案创建
|
||||
return this.createErrorResponse('用户档案创建暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 更新用户档案
|
||||
*
|
||||
* @param id 档案ID
|
||||
* @param updateProfileDto 更新数据
|
||||
* @returns 更新结果响应
|
||||
*/
|
||||
async updateUserProfile(id: bigint, updateProfileDto: any): Promise<AdminApiResponse> {
|
||||
// TODO: 实现用户档案更新
|
||||
return this.createErrorResponse('用户档案更新暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 删除用户档案
|
||||
*
|
||||
* @param id 档案ID
|
||||
* @returns 删除结果响应
|
||||
*/
|
||||
async deleteUserProfile(id: bigint): Promise<AdminApiResponse> {
|
||||
// TODO: 实现用户档案删除
|
||||
return this.createErrorResponse('用户档案删除暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
// ==================== Zulip账号关联管理方法 ====================
|
||||
|
||||
/**
|
||||
* 获取Zulip账号关联列表
|
||||
*
|
||||
* @param limit 限制数量
|
||||
* @param offset 偏移量
|
||||
* @returns Zulip账号关联列表响应
|
||||
*/
|
||||
async getZulipAccountList(limit: number = DEFAULT_PAGE_SIZE, offset: number = 0): Promise<AdminListResponse> {
|
||||
// TODO: 实现Zulip账号关联列表查询
|
||||
return this.createListResponse([], 0, limit, offset, 'Zulip账号关联列表获取成功(暂未实现)');
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据ID获取Zulip账号关联详情
|
||||
*
|
||||
* @param id 关联ID
|
||||
* @returns Zulip账号关联详情响应
|
||||
*/
|
||||
async getZulipAccountById(id: string): Promise<AdminApiResponse> {
|
||||
// TODO: 实现Zulip账号关联详情查询
|
||||
return this.createErrorResponse('Zulip账号关联详情查询暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取Zulip账号关联统计
|
||||
*
|
||||
* @returns 统计信息响应
|
||||
*/
|
||||
async getZulipAccountStatistics(): Promise<AdminApiResponse> {
|
||||
// TODO: 实现Zulip账号关联统计
|
||||
return this.createSuccessResponse({
|
||||
total: 0,
|
||||
active: 0,
|
||||
inactive: 0,
|
||||
error: 0
|
||||
}, 'Zulip账号关联统计获取成功(暂未实现)');
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建Zulip账号关联
|
||||
*
|
||||
* @param createAccountDto 创建数据
|
||||
* @returns 创建结果响应
|
||||
*/
|
||||
async createZulipAccount(createAccountDto: any): Promise<AdminApiResponse> {
|
||||
// TODO: 实现Zulip账号关联创建
|
||||
return this.createErrorResponse('Zulip账号关联创建暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 更新Zulip账号关联
|
||||
*
|
||||
* @param id 关联ID
|
||||
* @param updateAccountDto 更新数据
|
||||
* @returns 更新结果响应
|
||||
*/
|
||||
async updateZulipAccount(id: string, updateAccountDto: any): Promise<AdminApiResponse> {
|
||||
// TODO: 实现Zulip账号关联更新
|
||||
return this.createErrorResponse('Zulip账号关联更新暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 删除Zulip账号关联
|
||||
*
|
||||
* @param id 关联ID
|
||||
* @returns 删除结果响应
|
||||
*/
|
||||
async deleteZulipAccount(id: string): Promise<AdminApiResponse> {
|
||||
// TODO: 实现Zulip账号关联删除
|
||||
return this.createErrorResponse('Zulip账号关联删除暂未实现', 'NOT_IMPLEMENTED');
|
||||
}
|
||||
|
||||
/**
|
||||
* 批量更新Zulip账号状态
|
||||
*
|
||||
* @param ids ID列表
|
||||
* @param status 新状态
|
||||
* @param reason 操作原因
|
||||
* @returns 批量更新结果响应
|
||||
*/
|
||||
async batchUpdateZulipAccountStatus(ids: string[], status: string, reason?: string): Promise<AdminApiResponse> {
|
||||
// TODO: 实现Zulip账号关联批量状态更新
|
||||
return this.createSuccessResponse({
|
||||
success_count: 0,
|
||||
failed_count: ids.length,
|
||||
total_count: ids.length,
|
||||
errors: ids.map(id => ({ id, error: '批量更新暂未实现' }))
|
||||
}, 'Zulip账号关联批量状态更新完成(暂未实现)');
|
||||
}
|
||||
}
|
||||
597
src/business/admin/database_management.service.unit.spec.ts
Normal file
597
src/business/admin/database_management.service.unit.spec.ts
Normal file
@@ -0,0 +1,597 @@
|
||||
/**
|
||||
* DatabaseManagementService 单元测试
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证服务类各个方法的具体实现
|
||||
* - 测试边界条件和异常情况
|
||||
* - 确保代码覆盖率达标
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建DatabaseManagementService单元测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
|
||||
describe('DatabaseManagementService Unit Tests', () => {
|
||||
let service: DatabaseManagementService;
|
||||
let mockUsersService: any;
|
||||
let mockUserProfilesService: any;
|
||||
let mockZulipAccountsService: any;
|
||||
let mockLogService: any;
|
||||
|
||||
beforeEach(async () => {
|
||||
mockUsersService = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn(),
|
||||
search: jest.fn(),
|
||||
count: jest.fn()
|
||||
};
|
||||
|
||||
mockUserProfilesService = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn(),
|
||||
findByMap: jest.fn(),
|
||||
count: jest.fn()
|
||||
};
|
||||
|
||||
mockZulipAccountsService = {
|
||||
findMany: jest.fn(),
|
||||
findById: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
delete: jest.fn(),
|
||||
getStatusStatistics: jest.fn()
|
||||
};
|
||||
|
||||
mockLogService = {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
};
|
||||
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: mockLogService
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: mockUsersService
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: mockUserProfilesService
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: mockZulipAccountsService
|
||||
}
|
||||
]
|
||||
}).compile();
|
||||
|
||||
service = module.get<DatabaseManagementService>(DatabaseManagementService);
|
||||
});
|
||||
|
||||
describe('User Management', () => {
|
||||
describe('getUserList', () => {
|
||||
it('should return paginated user list with correct format', async () => {
|
||||
const mockUsers = [
|
||||
{ id: BigInt(1), username: 'user1', email: 'user1@test.com' },
|
||||
{ id: BigInt(2), username: 'user2', email: 'user2@test.com' }
|
||||
];
|
||||
const totalCount = 10;
|
||||
|
||||
mockUsersService.findAll.mockResolvedValue(mockUsers);
|
||||
mockUsersService.count.mockResolvedValue(totalCount);
|
||||
|
||||
const result = await service.getUserList(5, 0);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.items).toEqual(mockUsers.map(u => ({ ...u, id: u.id.toString() })));
|
||||
expect(result.data.total).toBe(totalCount);
|
||||
expect(result.data.limit).toBe(5);
|
||||
expect(result.data.offset).toBe(0);
|
||||
expect(result.data.has_more).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle empty result set', async () => {
|
||||
mockUsersService.findAll.mockResolvedValue([]);
|
||||
mockUsersService.count.mockResolvedValue(0);
|
||||
|
||||
const result = await service.getUserList(10, 0);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.items).toEqual([]);
|
||||
expect(result.data.total).toBe(0);
|
||||
expect(result.data.has_more).toBe(false);
|
||||
});
|
||||
|
||||
it('should apply limit and offset correctly', async () => {
|
||||
const mockUsers = [{ id: BigInt(1), username: 'user1' }];
|
||||
mockUsersService.findAll.mockResolvedValue(mockUsers);
|
||||
mockUsersService.count.mockResolvedValue(1);
|
||||
|
||||
await service.getUserList(20, 10);
|
||||
|
||||
expect(mockUsersService.findAll).toHaveBeenCalledWith(undefined, 20, 10);
|
||||
});
|
||||
|
||||
it('should enforce maximum limit', async () => {
|
||||
mockUsersService.findAll.mockResolvedValue([]);
|
||||
mockUsersService.count.mockResolvedValue(0);
|
||||
|
||||
await service.getUserList(200, 0); // 超过最大限制
|
||||
|
||||
expect(mockUsersService.findAll).toHaveBeenCalledWith(undefined, 100, 0);
|
||||
});
|
||||
|
||||
it('should handle negative offset', async () => {
|
||||
mockUsersService.findAll.mockResolvedValue([]);
|
||||
mockUsersService.count.mockResolvedValue(0);
|
||||
|
||||
await service.getUserList(10, -5);
|
||||
|
||||
expect(mockUsersService.findAll).toHaveBeenCalledWith(undefined, 10, 0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUserById', () => {
|
||||
it('should return user when found', async () => {
|
||||
const mockUser = { id: BigInt(1), username: 'testuser', email: 'test@example.com' };
|
||||
mockUsersService.findOne.mockResolvedValue(mockUser);
|
||||
|
||||
const result = await service.getUserById('1');
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual({ ...mockUser, id: '1' });
|
||||
expect(mockUsersService.findOne).toHaveBeenCalledWith(BigInt(1));
|
||||
});
|
||||
|
||||
it('should return error when user not found', async () => {
|
||||
mockUsersService.findOne.mockResolvedValue(null);
|
||||
|
||||
const result = await service.getUserById('999');
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('USER_NOT_FOUND');
|
||||
expect(result.message).toContain('User with ID 999 not found');
|
||||
});
|
||||
|
||||
it('should handle invalid ID format', async () => {
|
||||
const result = await service.getUserById('invalid');
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('INVALID_USER_ID');
|
||||
});
|
||||
|
||||
it('should handle service errors', async () => {
|
||||
mockUsersService.findOne.mockRejectedValue(new Error('Database error'));
|
||||
|
||||
const result = await service.getUserById('1');
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('DATABASE_ERROR');
|
||||
});
|
||||
});
|
||||
|
||||
describe('createUser', () => {
|
||||
it('should create user successfully', async () => {
|
||||
const userData = {
|
||||
username: 'newuser',
|
||||
email: 'new@example.com',
|
||||
status: UserStatus.ACTIVE
|
||||
};
|
||||
const createdUser = { ...userData, id: BigInt(1) };
|
||||
|
||||
mockUsersService.create.mockResolvedValue(createdUser);
|
||||
|
||||
const result = await service.createUser(userData);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual({ ...createdUser, id: '1' });
|
||||
expect(mockUsersService.create).toHaveBeenCalledWith(userData);
|
||||
});
|
||||
|
||||
it('should handle duplicate username error', async () => {
|
||||
const userData = { username: 'existing', email: 'test@example.com', status: UserStatus.ACTIVE };
|
||||
mockUsersService.create.mockRejectedValue(new Error('Duplicate key violation'));
|
||||
|
||||
const result = await service.createUser(userData);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('DUPLICATE_USERNAME');
|
||||
});
|
||||
|
||||
it('should validate required fields', async () => {
|
||||
const invalidData = { username: '', email: 'test@example.com', status: UserStatus.ACTIVE };
|
||||
|
||||
const result = await service.createUser(invalidData);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
});
|
||||
|
||||
it('should validate email format', async () => {
|
||||
const invalidData = { username: 'test', email: 'invalid-email', status: UserStatus.ACTIVE };
|
||||
|
||||
const result = await service.createUser(invalidData);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateUser', () => {
|
||||
it('should update user successfully', async () => {
|
||||
const updateData = { nickname: 'Updated Name' };
|
||||
const existingUser = { id: BigInt(1), username: 'test', email: 'test@example.com' };
|
||||
const updatedUser = { ...existingUser, ...updateData };
|
||||
|
||||
mockUsersService.findOne.mockResolvedValue(existingUser);
|
||||
mockUsersService.update.mockResolvedValue(updatedUser);
|
||||
|
||||
const result = await service.updateUser('1', updateData);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual({ ...updatedUser, id: '1' });
|
||||
expect(mockUsersService.update).toHaveBeenCalledWith(BigInt(1), updateData);
|
||||
});
|
||||
|
||||
it('should return error when user not found', async () => {
|
||||
mockUsersService.findOne.mockResolvedValue(null);
|
||||
|
||||
const result = await service.updateUser('999', { nickname: 'New Name' });
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('USER_NOT_FOUND');
|
||||
});
|
||||
|
||||
it('should handle empty update data', async () => {
|
||||
const result = await service.updateUser('1', {});
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
expect(result.message).toContain('No valid fields to update');
|
||||
});
|
||||
});
|
||||
|
||||
describe('deleteUser', () => {
|
||||
it('should delete user successfully', async () => {
|
||||
const existingUser = { id: BigInt(1), username: 'test' };
|
||||
mockUsersService.findOne.mockResolvedValue(existingUser);
|
||||
mockUsersService.remove.mockResolvedValue(undefined);
|
||||
|
||||
const result = await service.deleteUser('1');
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.deleted).toBe(true);
|
||||
expect(result.data.id).toBe('1');
|
||||
expect(mockUsersService.remove).toHaveBeenCalledWith(BigInt(1));
|
||||
});
|
||||
|
||||
it('should return error when user not found', async () => {
|
||||
mockUsersService.findOne.mockResolvedValue(null);
|
||||
|
||||
const result = await service.deleteUser('999');
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('USER_NOT_FOUND');
|
||||
});
|
||||
});
|
||||
|
||||
describe('searchUsers', () => {
|
||||
it('should search users successfully', async () => {
|
||||
const mockUsers = [
|
||||
{ id: BigInt(1), username: 'testuser', email: 'test@example.com' }
|
||||
];
|
||||
mockUsersService.search.mockResolvedValue(mockUsers);
|
||||
|
||||
const result = await service.searchUsers('test', 10);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.items).toEqual(mockUsers.map(u => ({ ...u, id: u.id.toString() })));
|
||||
expect(mockUsersService.search).toHaveBeenCalledWith('test', 10);
|
||||
});
|
||||
|
||||
it('should handle empty search term', async () => {
|
||||
const result = await service.searchUsers('', 10);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
expect(result.message).toContain('Search term cannot be empty');
|
||||
});
|
||||
|
||||
it('should apply search limit', async () => {
|
||||
mockUsersService.search.mockResolvedValue([]);
|
||||
|
||||
await service.searchUsers('test', 200); // 超过限制
|
||||
|
||||
expect(mockUsersService.search).toHaveBeenCalledWith('test', 100);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('User Profile Management', () => {
|
||||
describe('getUserProfileList', () => {
|
||||
it('should return paginated profile list', async () => {
|
||||
const mockProfiles = [
|
||||
{ id: BigInt(1), user_id: '1', bio: 'Test bio' }
|
||||
];
|
||||
mockUserProfilesService.findAll.mockResolvedValue(mockProfiles);
|
||||
mockUserProfilesService.count.mockResolvedValue(1);
|
||||
|
||||
const result = await service.getUserProfileList(10, 0);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.items).toEqual(mockProfiles.map(p => ({ ...p, id: p.id.toString() })));
|
||||
});
|
||||
});
|
||||
|
||||
describe('createUserProfile', () => {
|
||||
it('should create profile successfully', async () => {
|
||||
const profileData = {
|
||||
user_id: '1',
|
||||
bio: 'Test bio',
|
||||
current_map: 'plaza',
|
||||
pos_x: 100,
|
||||
pos_y: 200
|
||||
};
|
||||
const createdProfile = { ...profileData, id: BigInt(1) };
|
||||
|
||||
mockUserProfilesService.create.mockResolvedValue(createdProfile);
|
||||
|
||||
const result = await service.createUserProfile(profileData);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual({ ...createdProfile, id: '1' });
|
||||
});
|
||||
|
||||
it('should validate position coordinates', async () => {
|
||||
const invalidData = {
|
||||
user_id: '1',
|
||||
bio: 'Test',
|
||||
pos_x: 'invalid' as any,
|
||||
pos_y: 100
|
||||
};
|
||||
|
||||
const result = await service.createUserProfile(invalidData);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUserProfilesByMap', () => {
|
||||
it('should return profiles by map', async () => {
|
||||
const mockProfiles = [
|
||||
{ id: BigInt(1), user_id: '1', current_map: 'plaza' }
|
||||
];
|
||||
mockUserProfilesService.findByMap.mockResolvedValue(mockProfiles);
|
||||
mockUserProfilesService.count.mockResolvedValue(1);
|
||||
|
||||
const result = await service.getUserProfilesByMap('plaza', 10, 0);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.items).toEqual(mockProfiles.map(p => ({ ...p, id: p.id.toString() })));
|
||||
expect(mockUserProfilesService.findByMap).toHaveBeenCalledWith('plaza', undefined, 10, 0);
|
||||
});
|
||||
|
||||
it('should validate map name', async () => {
|
||||
const result = await service.getUserProfilesByMap('', 10, 0);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
expect(result.message).toContain('Map name cannot be empty');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Zulip Account Management', () => {
|
||||
describe('getZulipAccountList', () => {
|
||||
it('should return paginated account list', async () => {
|
||||
const mockAccounts = [
|
||||
{ id: '1', gameUserId: '1', zulipEmail: 'test@zulip.com' }
|
||||
];
|
||||
mockZulipAccountsService.findMany.mockResolvedValue({
|
||||
accounts: mockAccounts,
|
||||
total: 1
|
||||
});
|
||||
|
||||
const result = await service.getZulipAccountList(10, 0);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.items).toEqual(mockAccounts);
|
||||
expect(result.data.total).toBe(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('createZulipAccount', () => {
|
||||
it('should create account successfully', async () => {
|
||||
const accountData = {
|
||||
gameUserId: '1',
|
||||
zulipUserId: 123,
|
||||
zulipEmail: 'test@zulip.com',
|
||||
zulipFullName: 'Test User',
|
||||
zulipApiKeyEncrypted: 'encrypted_key',
|
||||
status: 'active' as const
|
||||
};
|
||||
const createdAccount = { ...accountData, id: '1' };
|
||||
|
||||
mockZulipAccountsService.create.mockResolvedValue(createdAccount);
|
||||
|
||||
const result = await service.createZulipAccount(accountData);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual(createdAccount);
|
||||
});
|
||||
|
||||
it('should validate required fields', async () => {
|
||||
const invalidData = {
|
||||
gameUserId: '',
|
||||
zulipUserId: 123,
|
||||
zulipEmail: 'test@zulip.com',
|
||||
zulipFullName: 'Test',
|
||||
zulipApiKeyEncrypted: 'key',
|
||||
status: 'active' as const
|
||||
};
|
||||
|
||||
const result = await service.createZulipAccount(invalidData);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
});
|
||||
});
|
||||
|
||||
describe('batchUpdateZulipAccountStatus', () => {
|
||||
it('should update multiple accounts successfully', async () => {
|
||||
const batchData = {
|
||||
ids: ['1', '2'],
|
||||
status: 'active' as const,
|
||||
reason: 'Test update'
|
||||
};
|
||||
|
||||
mockZulipAccountsService.update
|
||||
.mockResolvedValueOnce({ id: '1', status: 'active' })
|
||||
.mockResolvedValueOnce({ id: '2', status: 'active' });
|
||||
|
||||
const result = await service.batchUpdateZulipAccountStatus(batchData);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.total).toBe(2);
|
||||
expect(result.data.success).toBe(2);
|
||||
expect(result.data.failed).toBe(0);
|
||||
expect(result.data.results).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('should handle partial failures', async () => {
|
||||
const batchData = {
|
||||
ids: ['1', '2'],
|
||||
status: 'active' as const,
|
||||
reason: 'Test update'
|
||||
};
|
||||
|
||||
mockZulipAccountsService.update
|
||||
.mockResolvedValueOnce({ id: '1', status: 'active' })
|
||||
.mockRejectedValueOnce(new Error('Update failed'));
|
||||
|
||||
const result = await service.batchUpdateZulipAccountStatus(batchData);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.total).toBe(2);
|
||||
expect(result.data.success).toBe(1);
|
||||
expect(result.data.failed).toBe(1);
|
||||
expect(result.data.errors).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should validate batch data', async () => {
|
||||
const invalidData = {
|
||||
ids: [],
|
||||
status: 'active' as const,
|
||||
reason: 'Test'
|
||||
};
|
||||
|
||||
const result = await service.batchUpdateZulipAccountStatus(invalidData);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error_code).toBe('VALIDATION_ERROR');
|
||||
expect(result.message).toContain('No account IDs provided');
|
||||
});
|
||||
});
|
||||
|
||||
describe('getZulipAccountStatistics', () => {
|
||||
it('should return statistics successfully', async () => {
|
||||
const mockStats = {
|
||||
active: 10,
|
||||
inactive: 5,
|
||||
suspended: 2,
|
||||
error: 1,
|
||||
total: 18
|
||||
};
|
||||
mockZulipAccountsService.getStatusStatistics.mockResolvedValue(mockStats);
|
||||
|
||||
const result = await service.getZulipAccountStatistics();
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual(mockStats);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Health Check', () => {
|
||||
describe('healthCheck', () => {
|
||||
it('should return healthy status', async () => {
|
||||
const result = await service.healthCheck();
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.status).toBe('healthy');
|
||||
expect(result.data.timestamp).toBeDefined();
|
||||
expect(result.data.services).toBeDefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Error Handling', () => {
|
||||
it('should handle service injection errors', () => {
|
||||
expect(service).toBeDefined();
|
||||
expect(service['usersService']).toBeDefined();
|
||||
expect(service['userProfilesService']).toBeDefined();
|
||||
expect(service['zulipAccountsService']).toBeDefined();
|
||||
});
|
||||
|
||||
it('should format BigInt IDs correctly', async () => {
|
||||
const mockUser = { id: BigInt(123456789012345), username: 'test' };
|
||||
mockUsersService.findOne.mockResolvedValue(mockUser);
|
||||
|
||||
const result = await service.getUserById('123456789012345');
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.id).toBe('123456789012345');
|
||||
});
|
||||
|
||||
it('should handle concurrent operations', async () => {
|
||||
const mockUser = { id: BigInt(1), username: 'test' };
|
||||
mockUsersService.findOne.mockResolvedValue(mockUser);
|
||||
|
||||
const promises = [
|
||||
service.getUserById('1'),
|
||||
service.getUserById('1'),
|
||||
service.getUserById('1')
|
||||
];
|
||||
|
||||
const results = await Promise.all(promises);
|
||||
|
||||
results.forEach(result => {
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data.id).toBe('1');
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
500
src/business/admin/error_handling.property.spec.ts
Normal file
500
src/business/admin/error_handling.property.spec.ts
Normal file
@@ -0,0 +1,500 @@
|
||||
/**
|
||||
* 错误处理属性测试
|
||||
*
|
||||
* Property 9: 错误处理标准化
|
||||
*
|
||||
* Validates: Requirements 4.6
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证错误处理的标准化和一致性
|
||||
* - 确保错误响应格式统一
|
||||
* - 验证不同类型错误的正确处理
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建错误处理属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: 错误处理功能', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
let mockUsersService: any;
|
||||
let mockUserProfilesService: any;
|
||||
let mockZulipAccountsService: any;
|
||||
|
||||
beforeAll(async () => {
|
||||
mockUsersService = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn(),
|
||||
search: jest.fn(),
|
||||
count: jest.fn()
|
||||
};
|
||||
|
||||
mockUserProfilesService = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn(),
|
||||
findByMap: jest.fn(),
|
||||
count: jest.fn()
|
||||
};
|
||||
|
||||
mockZulipAccountsService = {
|
||||
findMany: jest.fn(),
|
||||
findById: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
delete: jest.fn(),
|
||||
getStatusStatistics: jest.fn()
|
||||
};
|
||||
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: mockUsersService
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: mockUserProfilesService
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: mockZulipAccountsService
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
describe('Property 9: 错误处理标准化', () => {
|
||||
it('数据库连接错误应该返回标准化错误响应', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'数据库连接错误标准化',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 模拟数据库连接错误
|
||||
mockUsersService.create.mockRejectedValueOnce(
|
||||
new Error('Connection timeout')
|
||||
);
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
// 如果没有抛出异常,验证错误响应格式
|
||||
if (!response.success) {
|
||||
expect(response).toHaveProperty('success', false);
|
||||
expect(response).toHaveProperty('message');
|
||||
expect(response).toHaveProperty('error_code');
|
||||
expect(response).toHaveProperty('timestamp');
|
||||
expect(response).toHaveProperty('request_id');
|
||||
|
||||
expect(typeof response.message).toBe('string');
|
||||
expect(typeof response.error_code).toBe('string');
|
||||
expect(typeof response.timestamp).toBe('string');
|
||||
expect(typeof response.request_id).toBe('string');
|
||||
}
|
||||
} catch (error) {
|
||||
// 如果抛出异常,验证异常被正确处理
|
||||
expect(error).toBeDefined();
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('资源不存在错误应该返回一致的404响应', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'资源不存在错误一致性',
|
||||
() => ({
|
||||
entityType: ['User', 'UserProfile', 'ZulipAccount'][Math.floor(Math.random() * 3)],
|
||||
entityId: `nonexistent_${Math.floor(Math.random() * 1000)}`
|
||||
}),
|
||||
async ({ entityType, entityId }) => {
|
||||
// 模拟资源不存在
|
||||
if (entityType === 'User') {
|
||||
mockUsersService.findOne.mockResolvedValueOnce(null);
|
||||
} else if (entityType === 'UserProfile') {
|
||||
mockUserProfilesService.findOne.mockResolvedValueOnce(null);
|
||||
} else {
|
||||
mockZulipAccountsService.findById.mockResolvedValueOnce(null);
|
||||
}
|
||||
|
||||
try {
|
||||
let response;
|
||||
if (entityType === 'User') {
|
||||
response = await controller.getUserById(entityId);
|
||||
} else if (entityType === 'UserProfile') {
|
||||
response = await controller.getUserProfileById(entityId);
|
||||
} else {
|
||||
response = await controller.getZulipAccountById(entityId);
|
||||
}
|
||||
|
||||
// 验证404错误响应格式
|
||||
if (!response.success) {
|
||||
expect(response.success).toBe(false);
|
||||
expect(response.error_code).toContain('NOT_FOUND');
|
||||
expect(response.message).toContain('not found');
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
}
|
||||
} catch (error: any) {
|
||||
// 验证异常包含正确信息
|
||||
expect(error.message).toContain('not found');
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('数据验证错误应该返回详细的错误信息', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'数据验证错误详细信息',
|
||||
() => {
|
||||
const invalidData = {
|
||||
username: '', // 空用户名
|
||||
email: 'invalid-email', // 无效邮箱格式
|
||||
role: -1, // 无效角色
|
||||
status: 'INVALID_STATUS' as any // 无效状态
|
||||
};
|
||||
|
||||
return invalidData;
|
||||
},
|
||||
async (invalidData) => {
|
||||
// 模拟验证错误
|
||||
mockUsersService.create.mockRejectedValueOnce(
|
||||
new Error('Validation failed: username is required, email format invalid')
|
||||
);
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...invalidData,
|
||||
nickname: 'Test Nickname' // 添加必需的nickname字段
|
||||
});
|
||||
|
||||
if (!response.success) {
|
||||
expect(response.success).toBe(false);
|
||||
expect(response.error_code).toContain('VALIDATION');
|
||||
expect(response.message).toContain('validation');
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
|
||||
// 验证错误信息包含具体字段
|
||||
expect(response.message.toLowerCase()).toMatch(/(username|email|role|status)/);
|
||||
}
|
||||
} catch (error: any) {
|
||||
expect(error.message).toContain('validation');
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('权限不足错误应该返回标准化403响应', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'权限不足错误标准化',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 模拟权限不足错误
|
||||
mockUsersService.create.mockRejectedValueOnce(
|
||||
new Error('Insufficient permissions')
|
||||
);
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
if (!response.success) {
|
||||
expect(response.success).toBe(false);
|
||||
expect(response.error_code).toContain('FORBIDDEN');
|
||||
expect(response.message).toContain('permission');
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
}
|
||||
} catch (error: any) {
|
||||
expect(error.message).toContain('permission');
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('并发冲突错误应该返回适当的错误响应', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'并发冲突错误处理',
|
||||
() => ({
|
||||
user: PropertyTestGenerators.generateUser(),
|
||||
conflictType: ['duplicate_key', 'version_conflict', 'resource_locked'][
|
||||
Math.floor(Math.random() * 3)
|
||||
]
|
||||
}),
|
||||
async ({ user, conflictType }) => {
|
||||
// 模拟不同类型的并发冲突
|
||||
let errorMessage;
|
||||
switch (conflictType) {
|
||||
case 'duplicate_key':
|
||||
errorMessage = 'Duplicate key violation: username already exists';
|
||||
break;
|
||||
case 'version_conflict':
|
||||
errorMessage = 'Version conflict: resource was modified by another user';
|
||||
break;
|
||||
case 'resource_locked':
|
||||
errorMessage = 'Resource is locked by another operation';
|
||||
break;
|
||||
}
|
||||
|
||||
mockUsersService.create.mockRejectedValueOnce(new Error(errorMessage));
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...user,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
if (!response.success) {
|
||||
expect(response.success).toBe(false);
|
||||
expect(response.error_code).toContain('CONFLICT');
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
|
||||
// 验证错误信息反映冲突类型
|
||||
if (conflictType === 'duplicate_key') {
|
||||
expect(response.message).toContain('duplicate');
|
||||
} else if (conflictType === 'version_conflict') {
|
||||
expect(response.message).toContain('conflict');
|
||||
} else {
|
||||
expect(response.message).toContain('locked');
|
||||
}
|
||||
}
|
||||
} catch (error: any) {
|
||||
expect(error.message).toBe(errorMessage);
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('系统内部错误应该返回通用错误响应', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'系统内部错误处理',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 模拟系统内部错误
|
||||
mockUsersService.create.mockRejectedValueOnce(
|
||||
new Error('Internal system error: unexpected null pointer')
|
||||
);
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
if (!response.success) {
|
||||
expect(response.success).toBe(false);
|
||||
expect(response.error_code).toContain('INTERNAL_ERROR');
|
||||
expect(response.message).toContain('internal error');
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
|
||||
// 内部错误不应该暴露敏感信息
|
||||
expect(response.message).not.toContain('null pointer');
|
||||
expect(response.message).not.toContain('stack trace');
|
||||
}
|
||||
} catch (error: any) {
|
||||
// 如果抛出异常,验证异常被适当处理
|
||||
expect(error).toBeDefined();
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('网络超时错误应该返回适当的错误响应', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'网络超时错误处理',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 模拟网络超时错误
|
||||
const timeoutError = new Error('Request timeout');
|
||||
timeoutError.name = 'TimeoutError';
|
||||
mockUsersService.create.mockRejectedValueOnce(timeoutError);
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
if (!response.success) {
|
||||
expect(response.success).toBe(false);
|
||||
expect(response.error_code).toContain('TIMEOUT');
|
||||
expect(response.message).toContain('timeout');
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
}
|
||||
} catch (error: any) {
|
||||
expect(error.message).toContain('timeout');
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('错误响应应该包含有用的调试信息', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'错误调试信息完整性',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 模拟带详细信息的错误
|
||||
mockUsersService.create.mockRejectedValueOnce(
|
||||
new Error('Database constraint violation: unique_username_constraint')
|
||||
);
|
||||
|
||||
try {
|
||||
const response = await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
if (!response.success) {
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, false);
|
||||
|
||||
// 验证调试信息
|
||||
expect(response.timestamp).toBeDefined();
|
||||
expect(response.request_id).toBeDefined();
|
||||
expect(response.error_code).toBeDefined();
|
||||
|
||||
// 验证时间戳格式
|
||||
const timestamp = new Date(response.timestamp);
|
||||
expect(timestamp.toISOString()).toBe(response.timestamp);
|
||||
|
||||
// 验证请求ID格式
|
||||
expect(response.request_id).toMatch(/^[a-zA-Z0-9_-]+$/);
|
||||
|
||||
// 验证错误码格式
|
||||
expect(response.error_code).toMatch(/^[A-Z_]+$/);
|
||||
}
|
||||
} catch (error: any) {
|
||||
expect(error).toBeDefined();
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('批量操作中的部分错误应该被正确处理', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'批量操作部分错误处理',
|
||||
() => {
|
||||
const accountIds = Array.from({ length: Math.floor(Math.random() * 5) + 3 },
|
||||
(_, i) => `account_${i + 1}`);
|
||||
const targetStatus = 'active' as const;
|
||||
|
||||
return { accountIds, targetStatus };
|
||||
},
|
||||
async ({ accountIds, targetStatus }) => {
|
||||
// 模拟部分成功,部分失败的批量操作
|
||||
accountIds.forEach((id, index) => {
|
||||
if (index === 0) {
|
||||
// 第一个操作失败
|
||||
mockZulipAccountsService.update.mockRejectedValueOnce(
|
||||
new Error(`Failed to update account ${id}: validation error`)
|
||||
);
|
||||
} else {
|
||||
// 其他操作成功
|
||||
mockZulipAccountsService.update.mockResolvedValueOnce({
|
||||
id,
|
||||
status: targetStatus,
|
||||
...PropertyTestGenerators.generateZulipAccount()
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
const response = await controller.batchUpdateZulipAccountStatus({
|
||||
ids: accountIds,
|
||||
status: targetStatus,
|
||||
reason: '测试批量更新'
|
||||
});
|
||||
|
||||
expect(response.success).toBe(true); // 批量操作本身成功
|
||||
expect(response.data.failed).toBe(1); // 一个失败
|
||||
expect(response.data.success).toBe(accountIds.length - 1); // 其他成功
|
||||
|
||||
// 验证错误信息格式
|
||||
expect(response.data.errors).toHaveLength(1);
|
||||
expect(response.data.errors[0]).toHaveProperty('id');
|
||||
expect(response.data.errors[0]).toHaveProperty('success', false);
|
||||
expect(response.data.errors[0]).toHaveProperty('error');
|
||||
|
||||
PropertyTestAssertions.assertApiResponseFormat(response, true);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
33
src/business/admin/index.ts
Normal file
33
src/business/admin/index.ts
Normal file
@@ -0,0 +1,33 @@
|
||||
/**
|
||||
* 管理员模块统一导出
|
||||
*
|
||||
* 功能描述:
|
||||
* - 导出管理员相关的所有组件
|
||||
* - 提供统一的导入入口
|
||||
* - 简化其他模块的依赖管理
|
||||
*
|
||||
* 职责分离:
|
||||
* - 模块接口统一管理
|
||||
* - 导出控制和版本管理
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-07: 代码规范优化 - 修正文件命名规范,更新作者信息和修改记录
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2025-12-24
|
||||
* @lastModified 2026-01-07
|
||||
*/
|
||||
|
||||
// 控制器
|
||||
export * from './admin.controller';
|
||||
|
||||
// 服务
|
||||
export * from './admin.service';
|
||||
|
||||
// DTO
|
||||
export * from './admin_login.dto';
|
||||
export * from './admin_response.dto';
|
||||
|
||||
// 模块
|
||||
export * from './admin.module';
|
||||
97
src/business/admin/log_admin_operation.decorator.ts
Normal file
97
src/business/admin/log_admin_operation.decorator.ts
Normal file
@@ -0,0 +1,97 @@
|
||||
/**
|
||||
* 管理员操作日志装饰器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 自动记录管理员的数据库操作
|
||||
* - 支持操作前后数据状态记录
|
||||
* - 提供灵活的配置选项
|
||||
* - 集成错误处理和性能监控
|
||||
*
|
||||
* 使用方式:
|
||||
* @LogAdminOperation({
|
||||
* operationType: 'CREATE',
|
||||
* targetType: 'users',
|
||||
* description: '创建用户',
|
||||
* isSensitive: true
|
||||
* })
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 注释规范优化 - 为接口添加注释,完善文档说明 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建管理员操作日志装饰器 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.2
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { SetMetadata, createParamDecorator, ExecutionContext } from '@nestjs/common';
|
||||
|
||||
/**
|
||||
* 管理员操作日志装饰器配置选项
|
||||
*
|
||||
* 功能描述:
|
||||
* 定义管理员操作日志装饰器的配置参数
|
||||
*
|
||||
* 使用场景:
|
||||
* - 配置@LogAdminOperation装饰器的行为
|
||||
* - 指定操作类型、目标类型和敏感性等属性
|
||||
*/
|
||||
export interface LogAdminOperationOptions {
|
||||
operationType: 'CREATE' | 'UPDATE' | 'DELETE' | 'QUERY' | 'BATCH';
|
||||
targetType: string;
|
||||
description: string;
|
||||
isSensitive?: boolean;
|
||||
captureBeforeData?: boolean;
|
||||
captureAfterData?: boolean;
|
||||
captureRequestParams?: boolean;
|
||||
}
|
||||
|
||||
export const LOG_ADMIN_OPERATION_KEY = 'log_admin_operation';
|
||||
|
||||
/**
|
||||
* 管理员操作日志装饰器
|
||||
*
|
||||
* @param options 日志配置选项
|
||||
* @returns 装饰器函数
|
||||
*/
|
||||
export const LogAdminOperation = (options: LogAdminOperationOptions) => {
|
||||
return SetMetadata(LOG_ADMIN_OPERATION_KEY, options);
|
||||
};
|
||||
|
||||
/**
|
||||
* 获取当前管理员信息的参数装饰器
|
||||
*/
|
||||
export const CurrentAdmin = createParamDecorator(
|
||||
(data: unknown, ctx: ExecutionContext) => {
|
||||
const request = ctx.switchToHttp().getRequest();
|
||||
return request.user; // 假设JWT认证后用户信息存储在request.user中
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* 获取客户端IP地址的参数装饰器
|
||||
*/
|
||||
export const ClientIP = createParamDecorator(
|
||||
(data: unknown, ctx: ExecutionContext) => {
|
||||
const request = ctx.switchToHttp().getRequest();
|
||||
return request.ip ||
|
||||
request.connection?.remoteAddress ||
|
||||
request.socket?.remoteAddress ||
|
||||
(request.connection?.socket as any)?.remoteAddress ||
|
||||
request.headers['x-forwarded-for']?.split(',')[0] ||
|
||||
request.headers['x-real-ip'] ||
|
||||
'unknown';
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* 获取用户代理的参数装饰器
|
||||
*/
|
||||
export const UserAgent = createParamDecorator(
|
||||
(data: unknown, ctx: ExecutionContext) => {
|
||||
const request = ctx.switchToHttp().getRequest();
|
||||
return request.headers['user-agent'] || 'unknown';
|
||||
},
|
||||
);
|
||||
509
src/business/admin/operation_logging.property.spec.ts
Normal file
509
src/business/admin/operation_logging.property.spec.ts
Normal file
@@ -0,0 +1,509 @@
|
||||
/**
|
||||
* 操作日志属性测试
|
||||
*
|
||||
* Property 11: 操作日志完整性
|
||||
*
|
||||
* Validates: Requirements 7.1, 7.2, 7.3, 7.4, 7.5
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证操作日志记录的完整性和准确性
|
||||
* - 确保敏感操作被正确记录
|
||||
* - 验证日志查询和统计功能
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建操作日志属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { AdminOperationLogController } from '../../controllers/admin_operation_log.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: 操作日志功能', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let databaseController: AdminDatabaseController;
|
||||
let logController: AdminOperationLogController;
|
||||
let mockLogService: any;
|
||||
let logEntries: any[] = [];
|
||||
|
||||
beforeAll(async () => {
|
||||
logEntries = [];
|
||||
|
||||
mockLogService = {
|
||||
createLog: jest.fn().mockImplementation((logData) => {
|
||||
const logEntry = {
|
||||
id: `log_${logEntries.length + 1}`,
|
||||
...logData,
|
||||
created_at: new Date().toISOString()
|
||||
};
|
||||
logEntries.push(logEntry);
|
||||
return Promise.resolve(logEntry);
|
||||
}),
|
||||
queryLogs: jest.fn().mockImplementation((filters, limit, offset) => {
|
||||
let filteredLogs = [...logEntries];
|
||||
|
||||
if (filters.operation_type) {
|
||||
filteredLogs = filteredLogs.filter(log => log.operation_type === filters.operation_type);
|
||||
}
|
||||
if (filters.admin_id) {
|
||||
filteredLogs = filteredLogs.filter(log => log.admin_id === filters.admin_id);
|
||||
}
|
||||
if (filters.entity_type) {
|
||||
filteredLogs = filteredLogs.filter(log => log.entity_type === filters.entity_type);
|
||||
}
|
||||
|
||||
const total = filteredLogs.length;
|
||||
const paginatedLogs = filteredLogs.slice(offset, offset + limit);
|
||||
|
||||
return Promise.resolve({ logs: paginatedLogs, total });
|
||||
}),
|
||||
getLogById: jest.fn().mockImplementation((id) => {
|
||||
const log = logEntries.find(entry => entry.id === id);
|
||||
return Promise.resolve(log || null);
|
||||
}),
|
||||
getStatistics: jest.fn().mockImplementation(() => {
|
||||
const stats = {
|
||||
totalOperations: logEntries.length,
|
||||
operationsByType: {},
|
||||
operationsByAdmin: {},
|
||||
recentActivity: logEntries.slice(-10)
|
||||
};
|
||||
|
||||
logEntries.forEach(log => {
|
||||
stats.operationsByType[log.operation_type] =
|
||||
(stats.operationsByType[log.operation_type] || 0) + 1;
|
||||
stats.operationsByAdmin[log.admin_id] =
|
||||
(stats.operationsByAdmin[log.admin_id] || 0) + 1;
|
||||
});
|
||||
|
||||
return Promise.resolve(stats);
|
||||
}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockImplementation((adminId) => {
|
||||
const adminLogs = logEntries.filter(log => log.admin_id === adminId);
|
||||
return Promise.resolve(adminLogs);
|
||||
}),
|
||||
getSensitiveOperations: jest.fn().mockImplementation((limit, offset) => {
|
||||
const sensitiveOps = ['DELETE', 'BATCH_UPDATE', 'ADMIN_CREATE'];
|
||||
const sensitiveLogs = logEntries.filter(log =>
|
||||
sensitiveOps.includes(log.operation_type)
|
||||
);
|
||||
const total = sensitiveLogs.length;
|
||||
const paginatedLogs = sensitiveLogs.slice(offset, offset + limit);
|
||||
|
||||
return Promise.resolve({ logs: paginatedLogs, total });
|
||||
})
|
||||
};
|
||||
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController, AdminOperationLogController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: mockLogService
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockImplementation(() => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return Promise.resolve({ ...user, id: BigInt(1) });
|
||||
}),
|
||||
create: jest.fn().mockImplementation((userData) => {
|
||||
return Promise.resolve({ ...userData, id: BigInt(1) });
|
||||
}),
|
||||
update: jest.fn().mockImplementation((id, updateData) => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return Promise.resolve({ ...user, ...updateData, id });
|
||||
}),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
search: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
create: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
update: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
findByMap: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: {
|
||||
findMany: jest.fn().mockResolvedValue({ accounts: [] }),
|
||||
findById: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
create: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
update: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
delete: jest.fn().mockResolvedValue(undefined),
|
||||
getStatusStatistics: jest.fn().mockResolvedValue({
|
||||
active: 0, inactive: 0, suspended: 0, error: 0, total: 0
|
||||
})
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
databaseController = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
logController = module.get<AdminOperationLogController>(AdminOperationLogController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
logEntries.length = 0; // 清空日志记录
|
||||
});
|
||||
|
||||
describe('Property 11: 操作日志完整性', () => {
|
||||
it('所有CRUD操作都应该生成日志记录', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'CRUD操作日志记录完整性',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
const userWithStatus = { ...userData, status: UserStatus.ACTIVE };
|
||||
|
||||
// 执行创建操作
|
||||
await databaseController.createUser(userWithStatus);
|
||||
|
||||
// 执行读取操作
|
||||
await databaseController.getUserById('1');
|
||||
|
||||
// 执行更新操作
|
||||
await databaseController.updateUser('1', { nickname: 'Updated Name' });
|
||||
|
||||
// 执行删除操作
|
||||
await databaseController.deleteUser('1');
|
||||
|
||||
// 验证日志记录
|
||||
expect(mockLogService.createLog).toHaveBeenCalledTimes(4);
|
||||
|
||||
// 验证日志内容包含必要信息
|
||||
const createLogCall = mockLogService.createLog.mock.calls.find(call =>
|
||||
call[0].operation_type === 'CREATE'
|
||||
);
|
||||
const updateLogCall = mockLogService.createLog.mock.calls.find(call =>
|
||||
call[0].operation_type === 'UPDATE'
|
||||
);
|
||||
const deleteLogCall = mockLogService.createLog.mock.calls.find(call =>
|
||||
call[0].operation_type === 'DELETE'
|
||||
);
|
||||
|
||||
expect(createLogCall).toBeDefined();
|
||||
expect(updateLogCall).toBeDefined();
|
||||
expect(deleteLogCall).toBeDefined();
|
||||
|
||||
// 验证日志包含实体信息
|
||||
expect(createLogCall[0].entity_type).toBe('User');
|
||||
expect(updateLogCall[0].entity_type).toBe('User');
|
||||
expect(deleteLogCall[0].entity_type).toBe('User');
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('日志记录应该包含完整的操作上下文', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'日志上下文完整性',
|
||||
() => ({
|
||||
user: PropertyTestGenerators.generateUser(),
|
||||
adminId: `admin_${Math.floor(Math.random() * 1000)}`,
|
||||
ipAddress: `192.168.1.${Math.floor(Math.random() * 255)}`,
|
||||
userAgent: 'Test-Agent/1.0'
|
||||
}),
|
||||
async ({ user, adminId, ipAddress, userAgent }) => {
|
||||
const userWithStatus = { ...user, status: UserStatus.ACTIVE };
|
||||
|
||||
// 模拟带上下文的操作
|
||||
await databaseController.createUser(userWithStatus);
|
||||
|
||||
// 验证日志记录包含上下文信息
|
||||
expect(mockLogService.createLog).toHaveBeenCalled();
|
||||
const logCall = mockLogService.createLog.mock.calls[0][0];
|
||||
|
||||
expect(logCall).toHaveProperty('operation_type');
|
||||
expect(logCall).toHaveProperty('entity_type');
|
||||
expect(logCall).toHaveProperty('entity_id');
|
||||
expect(logCall).toHaveProperty('admin_id');
|
||||
expect(logCall).toHaveProperty('operation_details');
|
||||
expect(logCall).toHaveProperty('timestamp');
|
||||
|
||||
// 验证时间戳格式
|
||||
expect(new Date(logCall.timestamp)).toBeInstanceOf(Date);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('敏感操作应该记录详细的前后状态', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'敏感操作详细日志',
|
||||
() => ({
|
||||
accounts: Array.from({ length: Math.floor(Math.random() * 5) + 2 },
|
||||
() => PropertyTestGenerators.generateZulipAccount()),
|
||||
targetStatus: ['active', 'inactive', 'suspended'][Math.floor(Math.random() * 3)]
|
||||
}),
|
||||
async ({ accounts, targetStatus }) => {
|
||||
const accountIds = accounts.map((_, i) => `account_${i + 1}`);
|
||||
|
||||
// 执行批量更新操作(敏感操作)
|
||||
await databaseController.batchUpdateZulipAccountStatus({
|
||||
ids: accountIds,
|
||||
status: targetStatus as any,
|
||||
reason: '测试批量更新'
|
||||
});
|
||||
|
||||
// 验证敏感操作日志
|
||||
expect(mockLogService.createLog).toHaveBeenCalled();
|
||||
const logCall = mockLogService.createLog.mock.calls[0][0];
|
||||
|
||||
expect(logCall.operation_type).toBe('BATCH_UPDATE');
|
||||
expect(logCall.entity_type).toBe('ZulipAccount');
|
||||
expect(logCall.operation_details).toContain('reason');
|
||||
expect(logCall.operation_details).toContain(targetStatus);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('日志查询应该支持多种过滤条件', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'日志查询过滤功能',
|
||||
() => {
|
||||
// 预先创建一些日志记录
|
||||
const operations = ['CREATE', 'UPDATE', 'DELETE', 'BATCH_UPDATE'];
|
||||
const entities = ['User', 'UserProfile', 'ZulipAccount'];
|
||||
const adminIds = ['admin1', 'admin2', 'admin3'];
|
||||
|
||||
return {
|
||||
operation_type: operations[Math.floor(Math.random() * operations.length)],
|
||||
entity_type: entities[Math.floor(Math.random() * entities.length)],
|
||||
admin_id: adminIds[Math.floor(Math.random() * adminIds.length)]
|
||||
};
|
||||
},
|
||||
async (filters) => {
|
||||
// 预先添加一些测试日志
|
||||
await mockLogService.createLog({
|
||||
operation_type: filters.operation_type,
|
||||
entity_type: filters.entity_type,
|
||||
admin_id: filters.admin_id,
|
||||
entity_id: '1',
|
||||
operation_details: JSON.stringify({ test: true }),
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// 查询日志
|
||||
const response = await logController.queryLogs(
|
||||
filters.operation_type,
|
||||
filters.entity_type,
|
||||
filters.admin_id,
|
||||
undefined,
|
||||
undefined,
|
||||
'20', // 修复:传递字符串而不是数字
|
||||
0
|
||||
);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
PropertyTestAssertions.assertListResponseFormat(response);
|
||||
|
||||
// 验证过滤结果
|
||||
response.data.items.forEach((log: any) => {
|
||||
expect(log.operation_type).toBe(filters.operation_type);
|
||||
expect(log.entity_type).toBe(filters.entity_type);
|
||||
expect(log.admin_id).toBe(filters.admin_id);
|
||||
});
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('日志统计应该准确反映操作情况', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'日志统计准确性',
|
||||
() => {
|
||||
const operations = Array.from({ length: Math.floor(Math.random() * 10) + 5 }, () => ({
|
||||
operation_type: ['CREATE', 'UPDATE', 'DELETE'][Math.floor(Math.random() * 3)],
|
||||
entity_type: ['User', 'UserProfile'][Math.floor(Math.random() * 2)],
|
||||
admin_id: `admin_${Math.floor(Math.random() * 3) + 1}`
|
||||
}));
|
||||
|
||||
return { operations };
|
||||
},
|
||||
async ({ operations }) => {
|
||||
// 创建测试日志
|
||||
for (const op of operations) {
|
||||
await mockLogService.createLog({
|
||||
...op,
|
||||
entity_id: '1',
|
||||
operation_details: JSON.stringify({}),
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
}
|
||||
|
||||
// 获取统计信息
|
||||
const response = await logController.getStatistics();
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.totalOperations).toBe(operations.length);
|
||||
expect(response.data.operationsByType).toBeDefined();
|
||||
expect(response.data.operationsByAdmin).toBeDefined();
|
||||
|
||||
// 验证统计数据准确性
|
||||
const expectedByType = {};
|
||||
const expectedByAdmin = {};
|
||||
|
||||
operations.forEach(op => {
|
||||
expectedByType[op.operation_type] = (expectedByType[op.operation_type] || 0) + 1;
|
||||
expectedByAdmin[op.admin_id] = (expectedByAdmin[op.admin_id] || 0) + 1;
|
||||
});
|
||||
|
||||
expect(response.data.operationsByType).toEqual(expectedByType);
|
||||
expect(response.data.operationsByAdmin).toEqual(expectedByAdmin);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('敏感操作查询应该正确识别和过滤', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'敏感操作识别准确性',
|
||||
() => {
|
||||
const allOperations = ['CREATE', 'READ', 'UPDATE', 'DELETE', 'BATCH_UPDATE', 'ADMIN_CREATE'];
|
||||
const operations = Array.from({ length: Math.floor(Math.random() * 8) + 3 }, () =>
|
||||
allOperations[Math.floor(Math.random() * allOperations.length)]
|
||||
);
|
||||
|
||||
return { operations };
|
||||
},
|
||||
async ({ operations }) => {
|
||||
// 创建测试日志
|
||||
for (const op of operations) {
|
||||
await mockLogService.createLog({
|
||||
operation_type: op,
|
||||
entity_type: 'User',
|
||||
admin_id: 'admin1',
|
||||
entity_id: '1',
|
||||
operation_details: JSON.stringify({}),
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
}
|
||||
|
||||
// 查询敏感操作
|
||||
const response = await logController.getSensitiveOperations(20, 0);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
PropertyTestAssertions.assertListResponseFormat(response);
|
||||
|
||||
// 验证只返回敏感操作
|
||||
const sensitiveOps = ['DELETE', 'BATCH_UPDATE', 'ADMIN_CREATE'];
|
||||
const expectedSensitiveCount = operations.filter(op =>
|
||||
sensitiveOps.includes(op)
|
||||
).length;
|
||||
|
||||
expect(response.data.total).toBe(expectedSensitiveCount);
|
||||
|
||||
response.data.items.forEach((log: any) => {
|
||||
expect(sensitiveOps).toContain(log.operation_type);
|
||||
});
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('管理员操作历史应该完整记录', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'管理员操作历史完整性',
|
||||
() => {
|
||||
const adminId = `admin_${Math.floor(Math.random() * 100)}`;
|
||||
const operations = Array.from({ length: Math.floor(Math.random() * 5) + 2 }, () => ({
|
||||
operation_type: ['CREATE', 'UPDATE', 'DELETE'][Math.floor(Math.random() * 3)],
|
||||
entity_type: 'User',
|
||||
admin_id: adminId
|
||||
}));
|
||||
|
||||
return { adminId, operations };
|
||||
},
|
||||
async ({ adminId, operations }) => {
|
||||
// 创建该管理员的操作日志
|
||||
for (const op of operations) {
|
||||
await mockLogService.createLog({
|
||||
...op,
|
||||
entity_id: '1',
|
||||
operation_details: JSON.stringify({}),
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
}
|
||||
|
||||
// 创建其他管理员的操作日志(干扰数据)
|
||||
await mockLogService.createLog({
|
||||
operation_type: 'CREATE',
|
||||
entity_type: 'User',
|
||||
admin_id: 'other_admin',
|
||||
entity_id: '2',
|
||||
operation_details: JSON.stringify({}),
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// 查询特定管理员的操作历史
|
||||
const response = await logController.getAdminOperationHistory(adminId);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data).toHaveLength(operations.length);
|
||||
|
||||
// 验证所有返回的日志都属于指定管理员
|
||||
response.data.forEach((log: any) => {
|
||||
expect(log.admin_id).toBe(adminId);
|
||||
});
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
431
src/business/admin/pagination_query.property.spec.ts
Normal file
431
src/business/admin/pagination_query.property.spec.ts
Normal file
@@ -0,0 +1,431 @@
|
||||
/**
|
||||
* 分页查询属性测试
|
||||
*
|
||||
* Property 8: 分页查询正确性
|
||||
* Property 14: 分页限制保护
|
||||
*
|
||||
* Validates: Requirements 4.4, 4.5, 8.3
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证分页查询的正确性和一致性
|
||||
* - 确保分页限制保护机制有效
|
||||
* - 验证分页参数的边界处理
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建分页查询属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: 分页查询功能', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
let mockUsersService: any;
|
||||
let mockUserProfilesService: any;
|
||||
let mockZulipAccountsService: any;
|
||||
|
||||
beforeAll(async () => {
|
||||
mockUsersService = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn(),
|
||||
search: jest.fn(),
|
||||
count: jest.fn()
|
||||
};
|
||||
|
||||
mockUserProfilesService = {
|
||||
findAll: jest.fn(),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn(),
|
||||
findByMap: jest.fn(),
|
||||
count: jest.fn()
|
||||
};
|
||||
|
||||
mockZulipAccountsService = {
|
||||
findMany: jest.fn(),
|
||||
findById: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
delete: jest.fn(),
|
||||
getStatusStatistics: jest.fn()
|
||||
};
|
||||
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: mockUsersService
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: mockUserProfilesService
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: mockZulipAccountsService
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
describe('Property 8: 分页查询正确性', () => {
|
||||
it('分页参数应该被正确传递和处理', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'分页参数传递正确性',
|
||||
() => PropertyTestGenerators.generatePaginationParams(),
|
||||
async (params) => {
|
||||
const { limit, offset } = params;
|
||||
const safeLimit = Math.min(Math.max(limit, 1), 100);
|
||||
const safeOffset = Math.max(offset, 0);
|
||||
|
||||
const totalItems = Math.floor(Math.random() * 200) + 50;
|
||||
const itemsToReturn = Math.min(safeLimit, Math.max(0, totalItems - safeOffset));
|
||||
|
||||
// Mock用户列表查询
|
||||
const mockUsers = Array.from({ length: itemsToReturn }, (_, i) => ({
|
||||
...PropertyTestGenerators.generateUser(),
|
||||
id: BigInt(safeOffset + i + 1)
|
||||
}));
|
||||
|
||||
mockUsersService.findAll.mockResolvedValueOnce(mockUsers);
|
||||
mockUsersService.count.mockResolvedValueOnce(totalItems);
|
||||
|
||||
const response = await controller.getUserList(safeLimit, safeOffset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
PropertyTestAssertions.assertPaginationLogic(response, safeLimit, safeOffset);
|
||||
|
||||
// 验证分页计算正确性
|
||||
expect(response.data.limit).toBe(safeLimit);
|
||||
expect(response.data.offset).toBe(safeOffset);
|
||||
expect(response.data.total).toBe(totalItems);
|
||||
expect(response.data.items.length).toBe(itemsToReturn);
|
||||
|
||||
const expectedHasMore = safeOffset + itemsToReturn < totalItems;
|
||||
expect(response.data.has_more).toBe(expectedHasMore);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 50 }
|
||||
);
|
||||
});
|
||||
|
||||
it('不同实体类型的分页查询应该保持一致性', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'多实体分页一致性',
|
||||
() => PropertyTestGenerators.generatePaginationParams(),
|
||||
async (params) => {
|
||||
const { limit, offset } = params;
|
||||
const safeLimit = Math.min(Math.max(limit, 1), 100);
|
||||
const safeOffset = Math.max(offset, 0);
|
||||
|
||||
const totalCount = Math.floor(Math.random() * 100) + 20;
|
||||
const itemCount = Math.min(safeLimit, Math.max(0, totalCount - safeOffset));
|
||||
|
||||
// Mock所有实体类型的查询
|
||||
mockUsersService.findAll.mockResolvedValueOnce(
|
||||
Array.from({ length: itemCount }, () => PropertyTestGenerators.generateUser())
|
||||
);
|
||||
mockUsersService.count.mockResolvedValueOnce(totalCount);
|
||||
|
||||
mockUserProfilesService.findAll.mockResolvedValueOnce(
|
||||
Array.from({ length: itemCount }, () => PropertyTestGenerators.generateUserProfile())
|
||||
);
|
||||
mockUserProfilesService.count.mockResolvedValueOnce(totalCount);
|
||||
|
||||
mockZulipAccountsService.findMany.mockResolvedValueOnce({
|
||||
accounts: Array.from({ length: itemCount }, () => PropertyTestGenerators.generateZulipAccount()),
|
||||
total: totalCount
|
||||
});
|
||||
|
||||
// 测试所有列表端点
|
||||
const userResponse = await controller.getUserList(safeLimit, safeOffset);
|
||||
const profileResponse = await controller.getUserProfileList(safeLimit, safeOffset);
|
||||
const zulipResponse = await controller.getZulipAccountList(safeLimit, safeOffset);
|
||||
|
||||
// 验证所有响应的分页格式一致
|
||||
[userResponse, profileResponse, zulipResponse].forEach(response => {
|
||||
PropertyTestAssertions.assertPaginationLogic(response, safeLimit, safeOffset);
|
||||
expect(response.data.limit).toBe(safeLimit);
|
||||
expect(response.data.offset).toBe(safeOffset);
|
||||
});
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
|
||||
it('边界条件下的分页查询应该正确处理', async () => {
|
||||
const boundaryValues = PropertyTestGenerators.generateBoundaryValues();
|
||||
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'分页边界条件处理',
|
||||
() => {
|
||||
const limits = boundaryValues.limits;
|
||||
const offsets = boundaryValues.offsets;
|
||||
|
||||
return {
|
||||
limit: limits[Math.floor(Math.random() * limits.length)],
|
||||
offset: offsets[Math.floor(Math.random() * offsets.length)]
|
||||
};
|
||||
},
|
||||
async ({ limit, offset }) => {
|
||||
const safeLimit = Math.min(Math.max(limit, 1), 100);
|
||||
const safeOffset = Math.max(offset, 0);
|
||||
|
||||
const totalItems = 150;
|
||||
const itemsToReturn = Math.min(safeLimit, Math.max(0, totalItems - safeOffset));
|
||||
|
||||
mockUsersService.findAll.mockResolvedValueOnce(
|
||||
Array.from({ length: itemsToReturn }, () => PropertyTestGenerators.generateUser())
|
||||
);
|
||||
mockUsersService.count.mockResolvedValueOnce(totalItems);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
|
||||
// 验证边界值被正确处理
|
||||
expect(response.data.limit).toBeGreaterThan(0);
|
||||
expect(response.data.limit).toBeLessThanOrEqual(100);
|
||||
expect(response.data.offset).toBeGreaterThanOrEqual(0);
|
||||
expect(response.data.items.length).toBeLessThanOrEqual(response.data.limit);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 40 }
|
||||
);
|
||||
});
|
||||
|
||||
it('空结果集的分页查询应该正确处理', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'空结果集分页处理',
|
||||
() => PropertyTestGenerators.generatePaginationParams(),
|
||||
async (params) => {
|
||||
const { limit, offset } = params;
|
||||
const safeLimit = Math.min(Math.max(limit, 1), 100);
|
||||
const safeOffset = Math.max(offset, 0);
|
||||
|
||||
// Mock空结果
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
const response = await controller.getUserList(safeLimit, safeOffset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.items).toEqual([]);
|
||||
expect(response.data.total).toBe(0);
|
||||
expect(response.data.has_more).toBe(false);
|
||||
expect(response.data.limit).toBe(safeLimit);
|
||||
expect(response.data.offset).toBe(safeOffset);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Property 14: 分页限制保护', () => {
|
||||
it('超大limit值应该被限制到最大值', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'超大limit限制保护',
|
||||
() => ({
|
||||
limit: Math.floor(Math.random() * 9900) + 101, // 101-10000
|
||||
offset: Math.floor(Math.random() * 100)
|
||||
}),
|
||||
async ({ limit, offset }) => {
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.limit).toBeLessThanOrEqual(100); // 最大限制
|
||||
expect(response.data.limit).toBeGreaterThan(0);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
|
||||
it('负数limit值应该被修正为正数', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'负数limit修正保护',
|
||||
() => ({
|
||||
limit: -Math.floor(Math.random() * 100) - 1, // 负数
|
||||
offset: Math.floor(Math.random() * 100)
|
||||
}),
|
||||
async ({ limit, offset }) => {
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.limit).toBeGreaterThan(0); // 应该被修正为正数
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('负数offset值应该被修正为0', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'负数offset修正保护',
|
||||
() => ({
|
||||
limit: Math.floor(Math.random() * 50) + 1,
|
||||
offset: -Math.floor(Math.random() * 100) - 1 // 负数
|
||||
}),
|
||||
async ({ limit, offset }) => {
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.offset).toBeGreaterThanOrEqual(0); // 应该被修正为非负数
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('零值limit应该被修正为默认值', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'零值limit修正保护',
|
||||
() => ({
|
||||
limit: 0,
|
||||
offset: Math.floor(Math.random() * 100)
|
||||
}),
|
||||
async ({ limit, offset }) => {
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.limit).toBeGreaterThan(0); // 应该被修正为正数
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('极大offset值应该返回空结果但不报错', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'极大offset处理保护',
|
||||
() => ({
|
||||
limit: Math.floor(Math.random() * 50) + 1,
|
||||
offset: Math.floor(Math.random() * 90000) + 10000 // 极大偏移
|
||||
}),
|
||||
async ({ limit, offset }) => {
|
||||
const totalItems = Math.floor(Math.random() * 1000) + 100;
|
||||
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(totalItems);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
|
||||
// 当offset超过总数时,应该返回空结果
|
||||
if (offset >= totalItems) {
|
||||
expect(response.data.items).toEqual([]);
|
||||
expect(response.data.has_more).toBe(false);
|
||||
}
|
||||
|
||||
expect(response.data.offset).toBe(offset); // offset应该保持原值
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('分页保护机制应该在所有端点中一致', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'分页保护一致性',
|
||||
() => ({
|
||||
limit: Math.floor(Math.random() * 200) + 101, // 超过限制的值
|
||||
offset: -Math.floor(Math.random() * 50) - 1 // 负数偏移
|
||||
}),
|
||||
async ({ limit, offset }) => {
|
||||
// Mock所有服务
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
mockUserProfilesService.findAll.mockResolvedValueOnce([]);
|
||||
mockUserProfilesService.count.mockResolvedValueOnce(0);
|
||||
|
||||
mockZulipAccountsService.findMany.mockResolvedValueOnce({ accounts: [], total: 0 });
|
||||
|
||||
// 测试所有列表端点
|
||||
const userResponse = await controller.getUserList(limit, offset);
|
||||
const profileResponse = await controller.getUserProfileList(limit, offset);
|
||||
const zulipResponse = await controller.getZulipAccountList(limit, offset);
|
||||
|
||||
// 验证所有端点的保护机制一致
|
||||
[userResponse, profileResponse, zulipResponse].forEach(response => {
|
||||
expect(response.success).toBe(true);
|
||||
expect(response.data.limit).toBeLessThanOrEqual(100); // 最大限制
|
||||
expect(response.data.limit).toBeGreaterThan(0); // 最小限制
|
||||
expect(response.data.offset).toBeGreaterThanOrEqual(0); // 非负偏移
|
||||
});
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
541
src/business/admin/performance_monitoring.property.spec.ts
Normal file
541
src/business/admin/performance_monitoring.property.spec.ts
Normal file
@@ -0,0 +1,541 @@
|
||||
/**
|
||||
* 性能监控属性测试
|
||||
*
|
||||
* Property 13: 性能监控准确性
|
||||
*
|
||||
* Validates: Requirements 8.1, 8.2
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证性能监控数据的准确性
|
||||
* - 确保性能指标收集的完整性
|
||||
* - 验证性能警告机制的有效性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建性能监控属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: 性能监控功能', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
let performanceMetrics: any[] = [];
|
||||
let mockUsersService: any;
|
||||
let mockUserProfilesService: any;
|
||||
let mockZulipAccountsService: any;
|
||||
|
||||
beforeAll(async () => {
|
||||
performanceMetrics = [];
|
||||
|
||||
// 创建性能监控mock
|
||||
const createPerformanceAwareMock = (serviceName: string, methodName: string, baseDelay: number = 50) => {
|
||||
return jest.fn().mockImplementation(async (...args) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
// 模拟不同的执行时间
|
||||
const randomDelay = baseDelay + Math.random() * 100;
|
||||
await new Promise(resolve => setTimeout(resolve, randomDelay));
|
||||
|
||||
const endTime = Date.now();
|
||||
const duration = endTime - startTime;
|
||||
|
||||
// 记录性能指标
|
||||
performanceMetrics.push({
|
||||
service: serviceName,
|
||||
method: methodName,
|
||||
duration,
|
||||
timestamp: new Date().toISOString(),
|
||||
args: args.length
|
||||
});
|
||||
|
||||
// 根据方法返回适当的mock数据
|
||||
if (methodName === 'findAll') {
|
||||
return [];
|
||||
} else if (methodName === 'count') {
|
||||
return 0;
|
||||
} else if (methodName === 'findOne' || methodName === 'findById') {
|
||||
if (serviceName === 'UsersService') {
|
||||
return { ...PropertyTestGenerators.generateUser(), id: BigInt(1) };
|
||||
} else if (serviceName === 'UserProfilesService') {
|
||||
return { ...PropertyTestGenerators.generateUserProfile(), id: BigInt(1) };
|
||||
} else {
|
||||
return { ...PropertyTestGenerators.generateZulipAccount(), id: '1' };
|
||||
}
|
||||
} else if (methodName === 'create') {
|
||||
if (serviceName === 'UsersService') {
|
||||
return { ...args[0], id: BigInt(1) };
|
||||
} else if (serviceName === 'UserProfilesService') {
|
||||
return { ...args[0], id: BigInt(1) };
|
||||
} else {
|
||||
return { ...args[0], id: '1' };
|
||||
}
|
||||
} else if (methodName === 'update') {
|
||||
if (serviceName === 'UsersService') {
|
||||
return { ...PropertyTestGenerators.generateUser(), ...args[1], id: args[0] };
|
||||
} else if (serviceName === 'UserProfilesService') {
|
||||
return { ...PropertyTestGenerators.generateUserProfile(), ...args[1], id: args[0] };
|
||||
} else {
|
||||
return { ...PropertyTestGenerators.generateZulipAccount(), ...args[1], id: args[0] };
|
||||
}
|
||||
} else if (methodName === 'findMany') {
|
||||
return { accounts: [], total: 0 };
|
||||
} else if (methodName === 'getStatusStatistics') {
|
||||
return { active: 0, inactive: 0, suspended: 0, error: 0, total: 0 };
|
||||
}
|
||||
|
||||
return {};
|
||||
});
|
||||
};
|
||||
|
||||
mockUsersService = {
|
||||
findAll: createPerformanceAwareMock('UsersService', 'findAll', 30),
|
||||
findOne: createPerformanceAwareMock('UsersService', 'findOne', 20),
|
||||
create: createPerformanceAwareMock('UsersService', 'create', 80),
|
||||
update: createPerformanceAwareMock('UsersService', 'update', 60),
|
||||
remove: createPerformanceAwareMock('UsersService', 'remove', 40),
|
||||
search: createPerformanceAwareMock('UsersService', 'search', 100),
|
||||
count: createPerformanceAwareMock('UsersService', 'count', 25)
|
||||
};
|
||||
|
||||
mockUserProfilesService = {
|
||||
findAll: createPerformanceAwareMock('UserProfilesService', 'findAll', 35),
|
||||
findOne: createPerformanceAwareMock('UserProfilesService', 'findOne', 25),
|
||||
create: createPerformanceAwareMock('UserProfilesService', 'create', 90),
|
||||
update: createPerformanceAwareMock('UserProfilesService', 'update', 70),
|
||||
remove: createPerformanceAwareMock('UserProfilesService', 'remove', 45),
|
||||
findByMap: createPerformanceAwareMock('UserProfilesService', 'findByMap', 120),
|
||||
count: createPerformanceAwareMock('UserProfilesService', 'count', 30)
|
||||
};
|
||||
|
||||
mockZulipAccountsService = {
|
||||
findMany: createPerformanceAwareMock('ZulipAccountsService', 'findMany', 40),
|
||||
findById: createPerformanceAwareMock('ZulipAccountsService', 'findById', 30),
|
||||
create: createPerformanceAwareMock('ZulipAccountsService', 'create', 100),
|
||||
update: createPerformanceAwareMock('ZulipAccountsService', 'update', 80),
|
||||
delete: createPerformanceAwareMock('ZulipAccountsService', 'delete', 50),
|
||||
getStatusStatistics: createPerformanceAwareMock('ZulipAccountsService', 'getStatusStatistics', 60)
|
||||
};
|
||||
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: mockUsersService
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: mockUserProfilesService
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: mockZulipAccountsService
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
performanceMetrics.length = 0; // 清空性能指标
|
||||
});
|
||||
|
||||
describe('Property 13: 性能监控准确性', () => {
|
||||
it('操作执行时间应该被准确记录', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'操作执行时间记录准确性',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
// 执行操作
|
||||
await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
const endTime = Date.now();
|
||||
const totalDuration = endTime - startTime;
|
||||
|
||||
// 验证性能指标被记录
|
||||
const createMetrics = performanceMetrics.filter(m =>
|
||||
m.service === 'UsersService' && m.method === 'create'
|
||||
);
|
||||
|
||||
expect(createMetrics.length).toBeGreaterThan(0);
|
||||
|
||||
const createMetric = createMetrics[0];
|
||||
expect(createMetric.duration).toBeGreaterThan(0);
|
||||
expect(createMetric.duration).toBeLessThan(totalDuration + 50); // 允许一些误差
|
||||
expect(createMetric.timestamp).toBeDefined();
|
||||
|
||||
// 验证时间戳格式
|
||||
const timestamp = new Date(createMetric.timestamp);
|
||||
expect(timestamp.toISOString()).toBe(createMetric.timestamp);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('不同操作类型的性能指标应该被正确分类', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'操作类型性能分类',
|
||||
() => ({
|
||||
user: PropertyTestGenerators.generateUser(),
|
||||
profile: PropertyTestGenerators.generateUserProfile(),
|
||||
zulipAccount: PropertyTestGenerators.generateZulipAccount()
|
||||
}),
|
||||
async ({ user, profile, zulipAccount }) => {
|
||||
// 执行不同类型的操作
|
||||
await controller.getUserList(10, 0);
|
||||
await controller.createUser({ ...user, status: UserStatus.ACTIVE });
|
||||
await controller.getUserProfileList(10, 0);
|
||||
await controller.createUserProfile(profile);
|
||||
await controller.getZulipAccountList(10, 0);
|
||||
await controller.createZulipAccount(zulipAccount);
|
||||
|
||||
// 验证不同服务的性能指标
|
||||
const userServiceMetrics = performanceMetrics.filter(m => m.service === 'UsersService');
|
||||
const profileServiceMetrics = performanceMetrics.filter(m => m.service === 'UserProfilesService');
|
||||
const zulipServiceMetrics = performanceMetrics.filter(m => m.service === 'ZulipAccountsService');
|
||||
|
||||
expect(userServiceMetrics.length).toBeGreaterThan(0);
|
||||
expect(profileServiceMetrics.length).toBeGreaterThan(0);
|
||||
expect(zulipServiceMetrics.length).toBeGreaterThan(0);
|
||||
|
||||
// 验证方法分类
|
||||
const createMethods = performanceMetrics.filter(m => m.method === 'create');
|
||||
const findAllMethods = performanceMetrics.filter(m => m.method === 'findAll');
|
||||
const countMethods = performanceMetrics.filter(m => m.method === 'count');
|
||||
|
||||
expect(createMethods.length).toBe(3); // 三个create操作
|
||||
expect(findAllMethods.length).toBe(3); // 三个findAll操作
|
||||
expect(countMethods.length).toBe(3); // 三个count操作
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('复杂查询的性能应该被正确监控', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'复杂查询性能监控',
|
||||
() => ({
|
||||
searchTerm: PropertyTestGenerators.generateUser().username.substring(0, 3),
|
||||
mapName: ['plaza', 'forest', 'beach'][Math.floor(Math.random() * 3)],
|
||||
limit: Math.floor(Math.random() * 50) + 10,
|
||||
offset: Math.floor(Math.random() * 100)
|
||||
}),
|
||||
async ({ searchTerm, mapName, limit, offset }) => {
|
||||
// 执行复杂查询操作
|
||||
await controller.searchUsers(searchTerm, limit);
|
||||
await controller.getUserProfilesByMap(mapName, limit, offset);
|
||||
await controller.getZulipAccountStatistics();
|
||||
|
||||
// 验证复杂查询的性能指标
|
||||
const searchMetrics = performanceMetrics.filter(m => m.method === 'search');
|
||||
const mapQueryMetrics = performanceMetrics.filter(m => m.method === 'findByMap');
|
||||
const statsMetrics = performanceMetrics.filter(m => m.method === 'getStatusStatistics');
|
||||
|
||||
expect(searchMetrics.length).toBeGreaterThan(0);
|
||||
expect(mapQueryMetrics.length).toBeGreaterThan(0);
|
||||
expect(statsMetrics.length).toBeGreaterThan(0);
|
||||
|
||||
// 验证复杂查询通常耗时更长
|
||||
const searchDuration = searchMetrics[0].duration;
|
||||
const mapQueryDuration = mapQueryMetrics[0].duration;
|
||||
const statsDuration = statsMetrics[0].duration;
|
||||
|
||||
expect(searchDuration).toBeGreaterThan(50); // 搜索操作基础延迟100ms
|
||||
expect(mapQueryDuration).toBeGreaterThan(70); // 地图查询基础延迟120ms
|
||||
expect(statsDuration).toBeGreaterThan(30); // 统计查询基础延迟60ms
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('批量操作的性能应该被准确监控', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'批量操作性能监控',
|
||||
() => {
|
||||
const accountIds = Array.from({ length: Math.floor(Math.random() * 5) + 2 },
|
||||
(_, i) => `account_${i + 1}`);
|
||||
const targetStatus = ['active', 'inactive', 'suspended'][Math.floor(Math.random() * 3)];
|
||||
|
||||
return { accountIds, targetStatus };
|
||||
},
|
||||
async ({ accountIds, targetStatus }) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
// 执行批量操作
|
||||
await controller.batchUpdateZulipAccountStatus({
|
||||
ids: accountIds,
|
||||
status: targetStatus as any,
|
||||
reason: '性能测试批量更新'
|
||||
});
|
||||
|
||||
const endTime = Date.now();
|
||||
const totalDuration = endTime - startTime;
|
||||
|
||||
// 验证批量操作的性能指标
|
||||
const updateMetrics = performanceMetrics.filter(m =>
|
||||
m.service === 'ZulipAccountsService' && m.method === 'update'
|
||||
);
|
||||
|
||||
expect(updateMetrics.length).toBe(accountIds.length);
|
||||
|
||||
// 验证每个更新操作的性能
|
||||
updateMetrics.forEach(metric => {
|
||||
expect(metric.duration).toBeGreaterThan(0);
|
||||
expect(metric.duration).toBeLessThan(200); // 单个操作不应超过200ms
|
||||
});
|
||||
|
||||
// 验证总体性能合理性
|
||||
const totalServiceTime = updateMetrics.reduce((sum, m) => sum + m.duration, 0);
|
||||
expect(totalServiceTime).toBeLessThan(totalDuration + 100); // 允许一些并发优化
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 10 }
|
||||
);
|
||||
});
|
||||
|
||||
it('性能异常应该被正确识别', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'性能异常识别',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
// 模拟慢查询(通过增加延迟)
|
||||
const originalFindOne = mockUsersService.findOne;
|
||||
mockUsersService.findOne = jest.fn().mockImplementation(async (...args) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
// 模拟异常慢的查询
|
||||
await new Promise(resolve => setTimeout(resolve, 300));
|
||||
|
||||
const endTime = Date.now();
|
||||
const duration = endTime - startTime;
|
||||
|
||||
performanceMetrics.push({
|
||||
service: 'UsersService',
|
||||
method: 'findOne',
|
||||
duration,
|
||||
timestamp: new Date().toISOString(),
|
||||
args: args.length,
|
||||
slow: duration > 200 // 标记为慢查询
|
||||
});
|
||||
|
||||
return { ...PropertyTestGenerators.generateUser(), id: BigInt(1) };
|
||||
});
|
||||
|
||||
// 执行操作
|
||||
await controller.getUserById('1');
|
||||
|
||||
// 恢复原始mock
|
||||
mockUsersService.findOne = originalFindOne;
|
||||
|
||||
// 验证慢查询被识别
|
||||
const slowQueries = performanceMetrics.filter(m => m.slow === true);
|
||||
expect(slowQueries.length).toBeGreaterThan(0);
|
||||
|
||||
const slowQuery = slowQueries[0];
|
||||
expect(slowQuery.duration).toBeGreaterThan(200);
|
||||
expect(slowQuery.service).toBe('UsersService');
|
||||
expect(slowQuery.method).toBe('findOne');
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 10 }
|
||||
);
|
||||
});
|
||||
|
||||
it('并发操作的性能应该被独立监控', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'并发操作性能监控',
|
||||
() => ({
|
||||
concurrentCount: Math.floor(Math.random() * 3) + 2 // 2-4个并发操作
|
||||
}),
|
||||
async ({ concurrentCount }) => {
|
||||
const promises = [];
|
||||
const startTime = Date.now();
|
||||
|
||||
// 创建并发操作
|
||||
for (let i = 0; i < concurrentCount; i++) {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
promises.push(
|
||||
controller.createUser({
|
||||
...user,
|
||||
status: UserStatus.ACTIVE,
|
||||
username: `${user.username}_${i}` // 确保唯一性
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
// 等待所有操作完成
|
||||
await Promise.all(promises);
|
||||
|
||||
const endTime = Date.now();
|
||||
const totalDuration = endTime - startTime;
|
||||
|
||||
// 验证并发操作的性能指标
|
||||
const createMetrics = performanceMetrics.filter(m =>
|
||||
m.service === 'UsersService' && m.method === 'create'
|
||||
);
|
||||
|
||||
expect(createMetrics.length).toBe(concurrentCount);
|
||||
|
||||
// 验证每个操作都有独立的性能记录
|
||||
createMetrics.forEach((metric, index) => {
|
||||
expect(metric.duration).toBeGreaterThan(0);
|
||||
expect(metric.timestamp).toBeDefined();
|
||||
|
||||
// 验证时间戳在合理范围内
|
||||
const metricTime = new Date(metric.timestamp).getTime();
|
||||
expect(metricTime).toBeGreaterThanOrEqual(startTime);
|
||||
expect(metricTime).toBeLessThanOrEqual(endTime);
|
||||
});
|
||||
|
||||
// 验证并发执行的效率
|
||||
const avgDuration = createMetrics.reduce((sum, m) => sum + m.duration, 0) / concurrentCount;
|
||||
expect(totalDuration).toBeLessThan(avgDuration * concurrentCount * 1.2); // 并发应该有一定效率提升
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 10 }
|
||||
);
|
||||
});
|
||||
|
||||
it('性能统计数据应该准确计算', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'性能统计准确性',
|
||||
() => ({
|
||||
operationCount: Math.floor(Math.random() * 8) + 3 // 3-10个操作
|
||||
}),
|
||||
async ({ operationCount }) => {
|
||||
// 执行多个操作
|
||||
for (let i = 0; i < operationCount; i++) {
|
||||
await controller.getUserList(10, i * 10);
|
||||
}
|
||||
|
||||
// 计算性能统计
|
||||
const findAllMetrics = performanceMetrics.filter(m =>
|
||||
m.service === 'UsersService' && m.method === 'findAll'
|
||||
);
|
||||
|
||||
expect(findAllMetrics.length).toBe(operationCount);
|
||||
|
||||
// 计算统计数据
|
||||
const durations = findAllMetrics.map(m => m.duration);
|
||||
const totalDuration = durations.reduce((sum, d) => sum + d, 0);
|
||||
const avgDuration = totalDuration / durations.length;
|
||||
const minDuration = Math.min(...durations);
|
||||
const maxDuration = Math.max(...durations);
|
||||
|
||||
// 验证统计数据合理性
|
||||
expect(totalDuration).toBeGreaterThan(0);
|
||||
expect(avgDuration).toBeGreaterThan(0);
|
||||
expect(avgDuration).toBeGreaterThanOrEqual(minDuration);
|
||||
expect(avgDuration).toBeLessThanOrEqual(maxDuration);
|
||||
expect(minDuration).toBeLessThanOrEqual(maxDuration);
|
||||
|
||||
// 验证平均值在合理范围内(基础延迟30ms + 随机100ms)
|
||||
expect(avgDuration).toBeGreaterThan(20);
|
||||
expect(avgDuration).toBeLessThan(200);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('性能监控不应该显著影响操作性能', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'性能监控开销验证',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
const iterations = 5;
|
||||
const durations = [];
|
||||
|
||||
// 执行多次相同操作
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
const startTime = Date.now();
|
||||
|
||||
await controller.createUser({
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE,
|
||||
username: `${userData.username}_${i}`
|
||||
});
|
||||
|
||||
const endTime = Date.now();
|
||||
durations.push(endTime - startTime);
|
||||
}
|
||||
|
||||
// 验证性能一致性
|
||||
const avgDuration = durations.reduce((sum, d) => sum + d, 0) / durations.length;
|
||||
const maxVariation = Math.max(...durations) - Math.min(...durations);
|
||||
|
||||
// 性能变化不应该太大(监控开销应该很小)
|
||||
expect(maxVariation).toBeLessThan(avgDuration * 0.5); // 变化不超过平均值的50%
|
||||
|
||||
// 验证所有操作都被监控
|
||||
const createMetrics = performanceMetrics.filter(m =>
|
||||
m.service === 'UsersService' && m.method === 'create'
|
||||
);
|
||||
|
||||
expect(createMetrics.length).toBe(iterations);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 10 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
658
src/business/admin/permission_verification.property.spec.ts
Normal file
658
src/business/admin/permission_verification.property.spec.ts
Normal file
@@ -0,0 +1,658 @@
|
||||
/**
|
||||
* 权限验证属性测试
|
||||
*
|
||||
* Property 10: 权限验证严格性
|
||||
* Property 15: 并发请求限流
|
||||
*
|
||||
* Validates: Requirements 5.1, 8.4
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证权限验证机制的严格性和一致性
|
||||
* - 确保并发请求限流保护有效
|
||||
* - 验证权限边界和异常情况处理
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建权限验证属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: 权限验证功能', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
let mockAdminGuard: any;
|
||||
let requestCount = 0;
|
||||
let concurrentRequests = new Set<string>();
|
||||
|
||||
beforeAll(async () => {
|
||||
requestCount = 0;
|
||||
concurrentRequests.clear();
|
||||
|
||||
mockAdminGuard = {
|
||||
canActivate: jest.fn().mockImplementation((context) => {
|
||||
const request = context.switchToHttp().getRequest();
|
||||
const requestId = request.headers['x-request-id'] || `req_${Date.now()}_${Math.random()}`;
|
||||
|
||||
// 模拟权限验证逻辑
|
||||
const authHeader = request.headers.authorization;
|
||||
const adminRole = request.headers['x-admin-role'];
|
||||
const adminId = request.headers['x-admin-id'];
|
||||
|
||||
// 并发请求跟踪
|
||||
if (concurrentRequests.has(requestId)) {
|
||||
return false; // 重复请求
|
||||
}
|
||||
concurrentRequests.add(requestId);
|
||||
|
||||
// 模拟请求完成后清理
|
||||
setTimeout(() => {
|
||||
concurrentRequests.delete(requestId);
|
||||
}, 100);
|
||||
|
||||
requestCount++;
|
||||
|
||||
// 权限验证规则
|
||||
if (!authHeader || !authHeader.startsWith('Bearer ')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!adminRole || !['super_admin', 'admin', 'moderator'].includes(adminRole)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!adminId || adminId.length < 3) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// 模拟频率限制(每秒最多10个请求)
|
||||
const now = Date.now();
|
||||
const windowStart = Math.floor(now / 1000) * 1000;
|
||||
const recentRequests = Array.from(concurrentRequests).filter(id =>
|
||||
id.startsWith(`req_${windowStart}`)
|
||||
);
|
||||
|
||||
if (recentRequests.length > 10) {
|
||||
return false; // 超过频率限制
|
||||
}
|
||||
|
||||
return true;
|
||||
})
|
||||
};
|
||||
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockImplementation(() => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return Promise.resolve({ ...user, id: BigInt(1) });
|
||||
}),
|
||||
create: jest.fn().mockImplementation((userData) => {
|
||||
return Promise.resolve({ ...userData, id: BigInt(1) });
|
||||
}),
|
||||
update: jest.fn().mockImplementation((id, updateData) => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return Promise.resolve({ ...user, ...updateData, id });
|
||||
}),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
search: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
create: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
update: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
findByMap: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: {
|
||||
findMany: jest.fn().mockResolvedValue({ accounts: [] }),
|
||||
findById: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
create: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
update: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
delete: jest.fn().mockResolvedValue(undefined),
|
||||
getStatusStatistics: jest.fn().mockResolvedValue({
|
||||
active: 0, inactive: 0, suspended: 0, error: 0, total: 0
|
||||
})
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue(mockAdminGuard)
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
requestCount = 0;
|
||||
concurrentRequests.clear();
|
||||
mockAdminGuard.canActivate.mockClear();
|
||||
});
|
||||
|
||||
describe('Property 10: 权限验证严格性', () => {
|
||||
it('有效的管理员凭证应该通过验证', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'有效凭证权限验证',
|
||||
() => {
|
||||
const roles = ['super_admin', 'admin', 'moderator'];
|
||||
return {
|
||||
authToken: `Bearer token_${Math.random().toString(36).substring(7)}`,
|
||||
adminRole: roles[Math.floor(Math.random() * roles.length)],
|
||||
adminId: `admin_${Math.floor(Math.random() * 1000) + 100}`
|
||||
};
|
||||
},
|
||||
async ({ authToken, adminRole, adminId }) => {
|
||||
// 模拟设置请求头
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: authToken,
|
||||
'x-admin-role': adminRole,
|
||||
'x-admin-id': adminId,
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const canActivate = mockAdminGuard.canActivate(mockContext);
|
||||
expect(canActivate).toBe(true);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
|
||||
it('无效的认证令牌应该被拒绝', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'无效令牌权限拒绝',
|
||||
() => {
|
||||
const invalidTokens = [
|
||||
'', // 空令牌
|
||||
'InvalidToken', // 不是Bearer格式
|
||||
'Bearer', // 只有Bearer前缀
|
||||
'Basic dGVzdA==', // 错误的认证类型
|
||||
null,
|
||||
undefined
|
||||
];
|
||||
|
||||
return {
|
||||
authToken: invalidTokens[Math.floor(Math.random() * invalidTokens.length)],
|
||||
adminRole: 'admin',
|
||||
adminId: 'admin_123'
|
||||
};
|
||||
},
|
||||
async ({ authToken, adminRole, adminId }) => {
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: authToken,
|
||||
'x-admin-role': adminRole,
|
||||
'x-admin-id': adminId,
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const canActivate = mockAdminGuard.canActivate(mockContext);
|
||||
expect(canActivate).toBe(false);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('无效的管理员角色应该被拒绝', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'无效角色权限拒绝',
|
||||
() => {
|
||||
const invalidRoles = [
|
||||
'user', // 普通用户角色
|
||||
'guest', // 访客角色
|
||||
'invalid_role', // 无效角色
|
||||
'', // 空角色
|
||||
'ADMIN', // 大小写错误
|
||||
null,
|
||||
undefined
|
||||
];
|
||||
|
||||
return {
|
||||
authToken: 'Bearer valid_token_123',
|
||||
adminRole: invalidRoles[Math.floor(Math.random() * invalidRoles.length)],
|
||||
adminId: 'admin_123'
|
||||
};
|
||||
},
|
||||
async ({ authToken, adminRole, adminId }) => {
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: authToken,
|
||||
'x-admin-role': adminRole,
|
||||
'x-admin-id': adminId,
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const canActivate = mockAdminGuard.canActivate(mockContext);
|
||||
expect(canActivate).toBe(false);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('无效的管理员ID应该被拒绝', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'无效管理员ID权限拒绝',
|
||||
() => {
|
||||
const invalidIds = [
|
||||
'', // 空ID
|
||||
'a', // 太短的ID
|
||||
'ab', // 太短的ID
|
||||
null,
|
||||
undefined,
|
||||
' ', // 只有空格
|
||||
'id with spaces' // 包含空格
|
||||
];
|
||||
|
||||
return {
|
||||
authToken: 'Bearer valid_token_123',
|
||||
adminRole: 'admin',
|
||||
adminId: invalidIds[Math.floor(Math.random() * invalidIds.length)]
|
||||
};
|
||||
},
|
||||
async ({ authToken, adminRole, adminId }) => {
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: authToken,
|
||||
'x-admin-role': adminRole,
|
||||
'x-admin-id': adminId,
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const canActivate = mockAdminGuard.canActivate(mockContext);
|
||||
expect(canActivate).toBe(false);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('权限验证应该在所有端点中一致执行', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'权限验证一致性',
|
||||
() => ({
|
||||
validAuth: {
|
||||
authToken: 'Bearer valid_token_123',
|
||||
adminRole: 'admin',
|
||||
adminId: 'admin_123'
|
||||
},
|
||||
invalidAuth: {
|
||||
authToken: 'InvalidToken',
|
||||
adminRole: 'admin',
|
||||
adminId: 'admin_123'
|
||||
}
|
||||
}),
|
||||
async ({ validAuth, invalidAuth }) => {
|
||||
// 测试有效权限
|
||||
const validRequest = {
|
||||
headers: {
|
||||
authorization: validAuth.authToken,
|
||||
'x-admin-role': validAuth.adminRole,
|
||||
'x-admin-id': validAuth.adminId,
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const validContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => validRequest
|
||||
})
|
||||
};
|
||||
|
||||
expect(mockAdminGuard.canActivate(validContext)).toBe(true);
|
||||
|
||||
// 测试无效权限
|
||||
const invalidRequest = {
|
||||
headers: {
|
||||
authorization: invalidAuth.authToken,
|
||||
'x-admin-role': invalidAuth.adminRole,
|
||||
'x-admin-id': invalidAuth.adminId,
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const invalidContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => invalidRequest
|
||||
})
|
||||
};
|
||||
|
||||
expect(mockAdminGuard.canActivate(invalidContext)).toBe(false);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Property 15: 并发请求限流', () => {
|
||||
it('正常频率的请求应该被允许', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'正常频率请求允许',
|
||||
() => ({
|
||||
requestCount: Math.floor(Math.random() * 5) + 1 // 1-5个请求
|
||||
}),
|
||||
async ({ requestCount }) => {
|
||||
const results = [];
|
||||
|
||||
for (let i = 0; i < requestCount; i++) {
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_123',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': 'admin_123',
|
||||
'x-request-id': `req_${Date.now()}_${i}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const result = mockAdminGuard.canActivate(mockContext);
|
||||
results.push(result);
|
||||
|
||||
// 小延迟避免时间戳冲突
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
}
|
||||
|
||||
// 正常频率的请求都应该被允许
|
||||
results.forEach(result => {
|
||||
expect(result).toBe(true);
|
||||
});
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('重复的请求ID应该被拒绝', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'重复请求ID拒绝',
|
||||
() => ({
|
||||
requestId: `req_${Date.now()}_${Math.random()}`
|
||||
}),
|
||||
async ({ requestId }) => {
|
||||
const mockRequest1 = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_123',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': 'admin_123',
|
||||
'x-request-id': requestId
|
||||
}
|
||||
};
|
||||
|
||||
const mockRequest2 = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_456',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': 'admin_456',
|
||||
'x-request-id': requestId // 相同的请求ID
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext1 = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest1
|
||||
})
|
||||
};
|
||||
|
||||
const mockContext2 = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest2
|
||||
})
|
||||
};
|
||||
|
||||
// 第一个请求应该成功
|
||||
const result1 = mockAdminGuard.canActivate(mockContext1);
|
||||
expect(result1).toBe(true);
|
||||
|
||||
// 第二个请求(重复ID)应该被拒绝
|
||||
const result2 = mockAdminGuard.canActivate(mockContext2);
|
||||
expect(result2).toBe(false);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('并发请求数量应该被正确跟踪', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'并发请求跟踪',
|
||||
() => ({
|
||||
concurrentCount: Math.floor(Math.random() * 8) + 3 // 3-10个并发请求
|
||||
}),
|
||||
async ({ concurrentCount }) => {
|
||||
const promises = [];
|
||||
const results = [];
|
||||
|
||||
// 创建并发请求
|
||||
for (let i = 0; i < concurrentCount; i++) {
|
||||
const promise = new Promise((resolve) => {
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_123',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': `admin_${i}`,
|
||||
'x-request-id': `req_${Date.now()}_${i}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const result = mockAdminGuard.canActivate(mockContext);
|
||||
results.push(result);
|
||||
resolve(result);
|
||||
});
|
||||
|
||||
promises.push(promise);
|
||||
}
|
||||
|
||||
// 等待所有请求完成
|
||||
await Promise.all(promises);
|
||||
|
||||
// 验证并发控制
|
||||
const successCount = results.filter(r => r === true).length;
|
||||
const failureCount = results.filter(r => r === false).length;
|
||||
|
||||
expect(successCount + failureCount).toBe(concurrentCount);
|
||||
|
||||
// 如果并发数超过限制,应该有一些请求被拒绝
|
||||
if (concurrentCount > 10) {
|
||||
expect(failureCount).toBeGreaterThan(0);
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 15 }
|
||||
);
|
||||
});
|
||||
|
||||
it('请求完成后应该释放并发槽位', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'并发槽位释放',
|
||||
() => ({}),
|
||||
async () => {
|
||||
const initialConcurrentSize = concurrentRequests.size;
|
||||
|
||||
// 创建一个请求
|
||||
const mockRequest = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_123',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': 'admin_123',
|
||||
'x-request-id': `req_${Date.now()}_${Math.random()}`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest
|
||||
})
|
||||
};
|
||||
|
||||
const result = mockAdminGuard.canActivate(mockContext);
|
||||
expect(result).toBe(true);
|
||||
|
||||
// 验证并发计数增加
|
||||
expect(concurrentRequests.size).toBe(initialConcurrentSize + 1);
|
||||
|
||||
// 等待请求完成(模拟的100ms超时)
|
||||
await new Promise(resolve => setTimeout(resolve, 150));
|
||||
|
||||
// 验证并发计数恢复
|
||||
expect(concurrentRequests.size).toBe(initialConcurrentSize);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 10 }
|
||||
);
|
||||
});
|
||||
|
||||
it('不同时间窗口的请求应该独立计算', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'时间窗口独立计算',
|
||||
() => ({}),
|
||||
async () => {
|
||||
const timestamp1 = Date.now();
|
||||
const timestamp2 = timestamp1 + 1100; // 下一秒
|
||||
|
||||
// 第一个时间窗口的请求
|
||||
const mockRequest1 = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_123',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': 'admin_123',
|
||||
'x-request-id': `req_${timestamp1}_1`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext1 = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest1
|
||||
})
|
||||
};
|
||||
|
||||
const result1 = mockAdminGuard.canActivate(mockContext1);
|
||||
expect(result1).toBe(true);
|
||||
|
||||
// 模拟时间推进
|
||||
await new Promise(resolve => setTimeout(resolve, 1100));
|
||||
|
||||
// 第二个时间窗口的请求
|
||||
const mockRequest2 = {
|
||||
headers: {
|
||||
authorization: 'Bearer valid_token_123',
|
||||
'x-admin-role': 'admin',
|
||||
'x-admin-id': 'admin_123',
|
||||
'x-request-id': `req_${timestamp2}_1`
|
||||
}
|
||||
};
|
||||
|
||||
const mockContext2 = {
|
||||
switchToHttp: () => ({
|
||||
getRequest: () => mockRequest2
|
||||
})
|
||||
};
|
||||
|
||||
const result2 = mockAdminGuard.canActivate(mockContext2);
|
||||
expect(result2).toBe(true);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 5 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
358
src/business/admin/user_management.property.spec.ts
Normal file
358
src/business/admin/user_management.property.spec.ts
Normal file
@@ -0,0 +1,358 @@
|
||||
/**
|
||||
* 用户管理属性测试
|
||||
*
|
||||
* Property 1: 用户管理CRUD操作一致性
|
||||
* Property 2: 用户搜索结果准确性
|
||||
* Property 12: 数据验证完整性
|
||||
*
|
||||
* Validates: Requirements 1.1-1.6, 6.1-6.6
|
||||
*
|
||||
* 测试目标:
|
||||
* - 验证用户CRUD操作的一致性和正确性
|
||||
* - 确保搜索功能返回准确结果
|
||||
* - 验证数据验证规则的完整性
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2026-01-08: 注释规范优化 - 修正@author字段,更新版本号和修改记录 (修改者: moyin)
|
||||
* - 2026-01-08: 功能新增 - 创建用户管理属性测试 (修改者: assistant)
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2026-01-08
|
||||
* @lastModified 2026-01-08
|
||||
*/
|
||||
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { AdminDatabaseController } from '../../controllers/admin_database.controller';
|
||||
import { DatabaseManagementService } from '../../services/database_management.service';
|
||||
import { AdminOperationLogService } from '../../services/admin_operation_log.service';
|
||||
import { AdminOperationLogInterceptor } from '../../admin_operation_log.interceptor';
|
||||
import { AdminDatabaseExceptionFilter } from '../../admin_database_exception.filter';
|
||||
import { AdminGuard } from '../../admin.guard';
|
||||
import { UserStatus } from '../../../../core/db/users/user_status.enum';
|
||||
import {
|
||||
PropertyTestRunner,
|
||||
PropertyTestGenerators,
|
||||
PropertyTestAssertions,
|
||||
DEFAULT_PROPERTY_CONFIG
|
||||
} from './admin_property_test.base';
|
||||
|
||||
describe('Property Test: 用户管理功能', () => {
|
||||
let app: INestApplication;
|
||||
let module: TestingModule;
|
||||
let controller: AdminDatabaseController;
|
||||
let mockUsersService: any;
|
||||
|
||||
beforeAll(async () => {
|
||||
mockUsersService = {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
search: jest.fn(),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
};
|
||||
|
||||
module = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
isGlobal: true,
|
||||
envFilePath: ['.env.test', '.env']
|
||||
})
|
||||
],
|
||||
controllers: [AdminDatabaseController],
|
||||
providers: [
|
||||
DatabaseManagementService,
|
||||
{
|
||||
provide: AdminOperationLogService,
|
||||
useValue: {
|
||||
createLog: jest.fn().mockResolvedValue({}),
|
||||
queryLogs: jest.fn().mockResolvedValue({ logs: [], total: 0 }),
|
||||
getLogById: jest.fn().mockResolvedValue(null),
|
||||
getStatistics: jest.fn().mockResolvedValue({}),
|
||||
cleanupExpiredLogs: jest.fn().mockResolvedValue(0),
|
||||
getAdminOperationHistory: jest.fn().mockResolvedValue([]),
|
||||
getSensitiveOperations: jest.fn().mockResolvedValue({ logs: [], total: 0 })
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: AdminOperationLogInterceptor,
|
||||
useValue: {
|
||||
intercept: jest.fn().mockImplementation((context, next) => next.handle())
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'UsersService',
|
||||
useValue: mockUsersService
|
||||
},
|
||||
{
|
||||
provide: 'IUserProfilesService',
|
||||
useValue: {
|
||||
findAll: jest.fn().mockResolvedValue([]),
|
||||
findOne: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
create: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
update: jest.fn().mockResolvedValue({ id: BigInt(1) }),
|
||||
remove: jest.fn().mockResolvedValue(undefined),
|
||||
findByMap: jest.fn().mockResolvedValue([]),
|
||||
count: jest.fn().mockResolvedValue(0)
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: 'ZulipAccountsService',
|
||||
useValue: {
|
||||
findMany: jest.fn().mockResolvedValue({ accounts: [] }),
|
||||
findById: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
create: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
update: jest.fn().mockResolvedValue({ id: '1' }),
|
||||
delete: jest.fn().mockResolvedValue(undefined),
|
||||
getStatusStatistics: jest.fn().mockResolvedValue({
|
||||
active: 0, inactive: 0, suspended: 0, error: 0, total: 0
|
||||
})
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
.overrideGuard(AdminGuard)
|
||||
.useValue({ canActivate: () => true })
|
||||
.compile();
|
||||
|
||||
app = module.createNestApplication();
|
||||
app.useGlobalFilters(new AdminDatabaseExceptionFilter());
|
||||
await app.init();
|
||||
|
||||
controller = module.get<AdminDatabaseController>(AdminDatabaseController);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
describe('Property 1: 用户管理CRUD操作一致性', () => {
|
||||
it('创建用户后应该能够读取相同的数据', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'用户创建-读取一致性',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
const userWithStatus = { ...userData, status: UserStatus.ACTIVE };
|
||||
|
||||
// Mock创建和读取操作
|
||||
const createdUser = { ...userWithStatus, id: BigInt(1) };
|
||||
mockUsersService.create.mockResolvedValueOnce(createdUser);
|
||||
mockUsersService.findOne.mockResolvedValueOnce(createdUser);
|
||||
|
||||
// 执行创建操作
|
||||
const createResponse = await controller.createUser(userWithStatus);
|
||||
|
||||
// 执行读取操作
|
||||
const readResponse = await controller.getUserById('1');
|
||||
|
||||
// 验证一致性
|
||||
PropertyTestAssertions.assertCrudConsistency(
|
||||
createResponse,
|
||||
readResponse,
|
||||
createResponse // 使用创建响应作为更新响应的占位符
|
||||
);
|
||||
|
||||
expect(createResponse.data.username).toBe(userWithStatus.username);
|
||||
expect(readResponse.data.username).toBe(userWithStatus.username);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
|
||||
it('更新用户后数据应该反映变更', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'用户更新一致性',
|
||||
() => ({
|
||||
original: PropertyTestGenerators.generateUser(),
|
||||
updates: PropertyTestGenerators.generateUser()
|
||||
}),
|
||||
async ({ original, updates }) => {
|
||||
const originalWithId = { ...original, id: BigInt(1), status: UserStatus.ACTIVE };
|
||||
const updatedUser = { ...originalWithId, ...updates, status: UserStatus.ACTIVE };
|
||||
|
||||
// Mock操作
|
||||
mockUsersService.findOne.mockResolvedValueOnce(originalWithId);
|
||||
mockUsersService.update.mockResolvedValueOnce(updatedUser);
|
||||
|
||||
// 执行更新操作
|
||||
const updateResponse = await controller.updateUser('1', {
|
||||
...updates,
|
||||
status: UserStatus.ACTIVE
|
||||
});
|
||||
|
||||
expect(updateResponse.success).toBe(true);
|
||||
expect(updateResponse.data.id).toBe('1');
|
||||
|
||||
// 验证更新的字段
|
||||
if (updates.username) {
|
||||
expect(updateResponse.data.username).toBe(updates.username);
|
||||
}
|
||||
if (updates.email) {
|
||||
expect(updateResponse.data.email).toBe(updates.email);
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
|
||||
it('删除用户后应该无法读取', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'用户删除一致性',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
const userWithId = { ...userData, id: BigInt(1), status: UserStatus.ACTIVE };
|
||||
|
||||
// Mock删除操作
|
||||
mockUsersService.remove.mockResolvedValueOnce(undefined);
|
||||
|
||||
// 执行删除操作
|
||||
const deleteResponse = await controller.deleteUser('1');
|
||||
|
||||
expect(deleteResponse.success).toBe(true);
|
||||
expect(deleteResponse.data.deleted).toBe(true);
|
||||
expect(deleteResponse.data.id).toBe('1');
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Property 2: 用户搜索结果准确性', () => {
|
||||
it('搜索结果应该包含匹配的用户', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'用户搜索准确性',
|
||||
() => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return {
|
||||
user,
|
||||
searchTerm: user.username.substring(0, 3) // 使用用户名前3个字符作为搜索词
|
||||
};
|
||||
},
|
||||
async ({ user, searchTerm }) => {
|
||||
const userWithId = { ...user, id: BigInt(1), status: UserStatus.ACTIVE };
|
||||
|
||||
// Mock搜索操作 - 如果搜索词匹配,返回用户
|
||||
const shouldMatch = user.username.toLowerCase().includes(searchTerm.toLowerCase()) ||
|
||||
user.email?.toLowerCase().includes(searchTerm.toLowerCase()) ||
|
||||
user.nickname?.toLowerCase().includes(searchTerm.toLowerCase());
|
||||
|
||||
mockUsersService.search.mockResolvedValueOnce(shouldMatch ? [userWithId] : []);
|
||||
|
||||
// 执行搜索操作
|
||||
const searchResponse = await controller.searchUsers(searchTerm, 20);
|
||||
|
||||
expect(searchResponse.success).toBe(true);
|
||||
PropertyTestAssertions.assertListResponseFormat(searchResponse);
|
||||
|
||||
if (shouldMatch) {
|
||||
expect(searchResponse.data.items.length).toBeGreaterThan(0);
|
||||
const foundUser = searchResponse.data.items[0];
|
||||
expect(foundUser.username).toBe(user.username);
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 25 }
|
||||
);
|
||||
});
|
||||
|
||||
it('空搜索词应该返回空结果或错误', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'空搜索词处理',
|
||||
() => ({ searchTerm: '' }),
|
||||
async ({ searchTerm }) => {
|
||||
mockUsersService.search.mockResolvedValueOnce([]);
|
||||
|
||||
const searchResponse = await controller.searchUsers(searchTerm, 20);
|
||||
|
||||
// 空搜索应该返回空结果
|
||||
expect(searchResponse.success).toBe(true);
|
||||
expect(searchResponse.data.items).toEqual([]);
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 10 }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Property 12: 数据验证完整性', () => {
|
||||
it('有效的用户数据应该通过验证', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'有效用户数据验证',
|
||||
() => PropertyTestGenerators.generateUser(),
|
||||
async (userData) => {
|
||||
const validUser = {
|
||||
...userData,
|
||||
status: UserStatus.ACTIVE,
|
||||
email: userData.email || 'test@example.com', // 确保有有效邮箱
|
||||
role: Math.max(0, Math.min(userData.role || 1, 9)) // 确保角色在有效范围内
|
||||
};
|
||||
|
||||
const createdUser = { ...validUser, id: BigInt(1) };
|
||||
mockUsersService.create.mockResolvedValueOnce(createdUser);
|
||||
|
||||
const createResponse = await controller.createUser(validUser);
|
||||
|
||||
expect(createResponse.success).toBe(true);
|
||||
expect(createResponse.data).toBeDefined();
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 40 }
|
||||
);
|
||||
});
|
||||
|
||||
it('边界值应该被正确处理', async () => {
|
||||
const boundaryValues = PropertyTestGenerators.generateBoundaryValues();
|
||||
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'边界值验证',
|
||||
() => {
|
||||
const user = PropertyTestGenerators.generateUser();
|
||||
return {
|
||||
...user,
|
||||
role: boundaryValues.numbers[Math.floor(Math.random() * boundaryValues.numbers.length)],
|
||||
username: boundaryValues.strings[Math.floor(Math.random() * boundaryValues.strings.length)] || 'defaultuser',
|
||||
status: UserStatus.ACTIVE
|
||||
};
|
||||
},
|
||||
async (userData) => {
|
||||
// 只测试有效的边界值
|
||||
if (userData.role >= 0 && userData.role <= 9 && userData.username.length > 0) {
|
||||
const createdUser = { ...userData, id: BigInt(1) };
|
||||
mockUsersService.create.mockResolvedValueOnce(createdUser);
|
||||
|
||||
const createResponse = await controller.createUser(userData);
|
||||
expect(createResponse.success).toBe(true);
|
||||
} else {
|
||||
// 无效值应该被拒绝,但我们的mock不会抛出错误
|
||||
// 在实际实现中,这些会被DTO验证拦截
|
||||
expect(true).toBe(true); // 占位符断言
|
||||
}
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 20 }
|
||||
);
|
||||
});
|
||||
|
||||
it('分页参数应该被正确验证和限制', async () => {
|
||||
await PropertyTestRunner.runPropertyTest(
|
||||
'分页参数验证',
|
||||
() => PropertyTestGenerators.generatePaginationParams(),
|
||||
async (params) => {
|
||||
const { limit, offset } = params;
|
||||
|
||||
mockUsersService.findAll.mockResolvedValueOnce([]);
|
||||
mockUsersService.count.mockResolvedValueOnce(0);
|
||||
|
||||
const response = await controller.getUserList(limit, offset);
|
||||
|
||||
expect(response.success).toBe(true);
|
||||
|
||||
// 验证分页参数被正确限制
|
||||
expect(response.data.limit).toBeLessThanOrEqual(100); // 最大限制
|
||||
expect(response.data.offset).toBeGreaterThanOrEqual(0); // 最小偏移
|
||||
},
|
||||
{ ...DEFAULT_PROPERTY_CONFIG, iterations: 30 }
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user