@nest-omni/core 4.1.3-1 → 4.1.3-11

package/http-client/examples/auth-with-waiting-lock.example.js

@@ -24,6 +24,10 @@ const common_1 = require("@nestjs/common");
 const http_client_service_1 = require("../services/http-client.service");
 const http_log_query_service_1 = require("../services/http-log-query.service");
 const http_replay_service_1 = require("../services/http-replay.service");
+/**
+ * 使用等待锁的认证示例
+ * 演示如何在原有的HTTP客户端中使用等待锁机制
+ */
 let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWaitingLockExample {
     constructor(httpClient, logQueryService, replayService) {
         this.httpClient = httpClient;
@@ -31,6 +35,10 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
         this.replayService = replayService;
         this.logger = new common_1.Logger(AuthWithWaitingLockExample_1.name);
     }
+    /**
+     * 示例1: 基本的带等待锁的认证请求
+     * 演示如何使用authRequest方法确保只有一个进程获取token
+     */
     basicAuthWithLock() {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log('=== 示例1: 基本带等待锁的认证请求 ===');
@@ -41,18 +49,21 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
                     Accept: 'application/vnd.github.v3+json',
                 },
             };
+            // Token提供函数
             const tokenProvider = () => __awaiter(this, void 0, void 0, function* () {
                 this.logger.log('开始获取GitHub访问令牌...');
+                // 模拟token获取过程
                 yield new Promise((resolve) => setTimeout(resolve, 1000));
                 const token = `ghp_${Math.random().toString(36).substring(2, 15)}${Date.now()}`;
                 this.logger.log(`成功获取令牌: ${token.substring(0, 20)}...`);
                 return token;
             });
             try {
+                // 使用等待锁执行认证请求
                 const response = yield this.httpClient.authRequest(requestConfig, tokenProvider, {
                     lockKey: 'github-token-refresh',
-                    lockTimeout: 30000,
-                    waitTimeout: 60000,
+                    lockTimeout: 30000, // 30秒锁超时
+                    waitTimeout: 60000, // 60秒等待超时
                     enableRetry: true,
                 });
                 this.logger.log('认证请求成功完成');
@@ -64,6 +75,10 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
             }
         });
     }
+    /**
+     * 示例2: 批量带等待锁的认证请求
+     * 演示如何在批量操作中共享token，避免重复认证
+     */
     batchAuthWithLock() {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log('=== 示例2: 批量带等待锁的认证请求 ===');
@@ -90,6 +105,7 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
                     key: 'user-followers',
                 },
             ];
+            // Token提供函数
             const tokenProvider = () => __awaiter(this, void 0, void 0, function* () {
                 this.logger.log('开始获取批量操作的GitHub访问令牌...');
                 yield new Promise((resolve) => setTimeout(resolve, 1500));
@@ -99,11 +115,12 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
             });
             try {
                 const startTime = Date.now();
+                // 使用批量认证请求，所有请求共享同一个token
                 const results = yield this.httpClient.authBatchRequest(requests, tokenProvider, {
                     lockKey: 'github-batch-token-refresh',
-                    lockTimeout: 60000,
-                    waitTimeout: 120000,
-                    maxConcurrency: 3,
+                    lockTimeout: 60000, // 60秒锁超时
+                    waitTimeout: 120000, // 2分钟等待超时
+                    maxConcurrency: 3, // 最大并发数
                 });
                 const endTime = Date.now();
                 const duration = endTime - startTime;
@@ -125,10 +142,15 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
             }
         });
     }
+    /**
+     * 示例3: 从HTTP日志生成curl命令
+     * 演示如何从已有的HTTP日志生成可执行的curl命令
+     */
     generateCurlFromLogs() {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log('=== 示例3: 从HTTP日志生成curl命令 ===');
             try {
+                // 查询最近的日志
                 const recentLogs = yield this.logQueryService.findLogs({
                     limit: 5,
                     sortBy: 'createdAt',
@@ -139,6 +161,7 @@ let AuthWithWaitingLockExample = AuthWithWaitingLockExample_1 = class AuthWithWa
                     return;
                 }
                 this.logger.log(`找到 ${recentLogs.logs.length} 条最近的HTTP日志`);
+                // 为每条日志生成curl命令
                 for (const log of recentLogs.logs) {
                     const curlCommand = yield this.logQueryService.generateCurlFromLog(log.id);
                     if (curlCommand) {
@@ -148,6 +171,7 @@ ${curlCommand}
           `);
                     }
                 }
+                // 批量生成curl命令
                 const batchCurlCommands = yield this.logQueryService.generateBatchCurlCommands({
                     limit: 3,
                     method: 'GET',
@@ -159,11 +183,16 @@ ${curlCommand}
             }
         });
     }
+    /**
+     * 示例4: 请求重放功能
+     * 演示如何重放已有的HTTP请求
+     */
     demonstrateRequestReplay() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             this.logger.log('=== 示例4: 请求重放功能 ===');
             try {
+                // 查询一个成功的请求进行重放
                 const successfulLogs = yield this.logQueryService.findLogs({
                     limit: 1,
                     success: true,
@@ -177,6 +206,7 @@ ${curlCommand}
                 }
                 const logToReplay = successfulLogs.logs[0];
                 this.logger.log(`准备重放请求: ${logToReplay.method} ${logToReplay.url}`);
+                // 重放请求
                 const replayResult = yield this.replayService.replayByLogId(logToReplay.id, {
                     overrideHeaders: false,
                     additionalHeaders: {
@@ -206,11 +236,16 @@ ${curlCommand}
             }
         });
     }
+    /**
+     * 示例5: 批量重放和比较
+     * 演示如何批量重放请求并比较结果
+     */
     batchReplayAndCompare() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             this.logger.log('=== 示例5: 批量重放和比较 ===');
             try {
+                // 查询最近的3个GET请求进行批量重放
                 const batchReplayResult = yield this.replayService.batchReplayByQuery({
                     method: 'GET',
                     limit: 3,
@@ -234,6 +269,7 @@ ${curlCommand}
 │ 平均响应时间    │ ${batchReplayResult.averageResponseTime.toFixed(1).toString().padStart(7)}ms │
 └─────────────────┴──────────┘
       `);
+                // 详细比较每个重放结果
                 for (let i = 0; i < Math.min(batchReplayResult.results.length, 3); i++) {
                     const result = batchReplayResult.results[i];
                     if (result.originalLog.id) {
@@ -262,12 +298,18 @@ ${curlCommand}
             }
         });
     }
+    /**
+     * 示例6: 综合演示 - 等待锁 + curl生成 + 请求重放
+     * 演示完整的工作流程
+     */
     comprehensiveDemo() {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log('=== 示例6: 综合演示 ===');
             try {
+                // 1. 执行带等待锁的认证请求
                 this.logger.log('步骤1: 执行带等待锁的认证请求');
                 const authResponse = yield this.basicAuthWithLock();
+                // 2. 查询刚才的请求日志
                 this.logger.log('\n步骤2: 查询请求日志');
                 const recentLogs = yield this.logQueryService.findLogs({
                     limit: 1,
@@ -276,12 +318,14 @@ ${curlCommand}
                 });
                 if (recentLogs.logs.length > 0) {
                     const log = recentLogs.logs[0];
+                    // 3. 生成curl命令
                     this.logger.log('\n步骤3: 生成curl命令');
                     const curlCommand = yield this.logQueryService.generateCurlFromLog(log.id);
                     if (curlCommand) {
                         this.logger.log('生成的curl命令:');
                         this.logger.log(curlCommand);
                     }
+                    // 4. 重放请求
                     this.logger.log('\n步骤4: 重放请求');
                     const replayResult = yield this.replayService.replayByLogId(log.id, {
                         additionalHeaders: {
@@ -304,6 +348,9 @@ ${curlCommand}
             }
         });
     }
+    /**
+     * 运行所有示例
+     */
     runAllExamples() {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log('开始运行HTTP客户端等待锁和请求重放示例...\n');

package/http-client/examples/basic-usage.example.d.ts

@@ -1,19 +1,55 @@
 import { HttpClientService, HttpLogQueryService } from '../services';
 import { HttpLogQueryOptions } from '../entities';
+/**
+ * 基本使用示例
+ */
 export declare class BasicHttpExample {
     private readonly httpClient;
     private readonly logQueryService;
     constructor(httpClient: HttpClientService, logQueryService: HttpLogQueryService);
+    /**
+     * 简单GET请求
+     */
     getUser(id: string): Promise<any>;
+    /**
+     * 带参数的GET请求
+     */
     searchUsers(query: string, page?: number, limit?: number): Promise<any>;
+    /**
+     * POST请求
+     */
     createUser(userData: any): Promise<any>;
+    /**
+     * PUT请求
+     */
     updateUser(id: string, userData: any): Promise<any>;
+    /**
+     * DELETE请求
+     */
     deleteUser(id: string): Promise<any>;
+    /**
+     * 文件上传
+     */
     uploadFile(file: Buffer, filename: string): Promise<any>;
+    /**
+     * 自定义请求配置
+     */
     customRequest(): Promise<any>;
+    /**
+     * 获取统计信息
+     */
     getStatistics(): any;
+    /**
+     * 重置统计信息
+     */
     resetStatistics(): void;
+    /**
+     * 生成curl命令
+     */
     generateCurlForRequest(url: string, method?: string, data?: any): string;
+    /**
+     * 查询HTTP日志
+     */
     queryHttpLogs(options?: HttpLogQueryOptions): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
@@ -21,18 +57,30 @@ export declare class BasicHttpExample {
         limit: number;
         totalPages: number;
     }>;
+    /**
+     * 查询错误日志
+     */
     findErrorLogs(limit?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
     }>;
+    /**
+     * 查询慢请求
+     */
     findSlowRequests(minResponseTime?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
     }>;
+    /**
+     * 查询重试日志
+     */
     findRetryLogs(minRetries?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
     }>;
+    /**
+     * 根据服务名称查询日志
+     */
     findLogsByServiceName(serviceName: string, limit?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
@@ -40,6 +88,9 @@ export declare class BasicHttpExample {
         limit: number;
         totalPages: number;
     }>;
+    /**
+     * 根据操作名称查询日志
+     */
     findLogsByOperationName(operationName: string, limit?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
@@ -47,7 +98,16 @@ export declare class BasicHttpExample {
         limit: number;
         totalPages: number;
     }>;
+    /**
+     * 获取HTTP统计信息
+     */
     getHttpStats(startDate?: Date, endDate?: Date): Promise<import("../entities").HttpLogStats>;
+    /**
+     * 根据请求ID查询日志
+     */
     findLogByRequestId(requestId: string): Promise<import("../entities").HttpLogEntity>;
+    /**
+     * 清理旧日志
+     */
     cleanupOldLogs(daysToKeep?: number): Promise<number>;
 }

package/http-client/examples/basic-usage.example.js

@@ -21,16 +21,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicHttpExample = void 0;
 const common_1 = require("@nestjs/common");
 const services_1 = require("../services");
+/**
+ * 基本使用示例
+ */
 let BasicHttpExample = class BasicHttpExample {
     constructor(httpClient, logQueryService) {
         this.httpClient = httpClient;
         this.logQueryService = logQueryService;
     }
+    /**
+     * 简单GET请求
+     */
     getUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.get(`/users/${id}`);
         });
     }
+    /**
+     * 带参数的GET请求
+     */
     searchUsers(query_1) {
         return __awaiter(this, arguments, void 0, function* (query, page = 1, limit = 10) {
             return this.httpClient.get('/users', {
@@ -42,6 +51,9 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * POST请求
+     */
     createUser(userData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.post('/users', userData, {
@@ -51,16 +63,25 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * PUT请求
+     */
     updateUser(id, userData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.put(`/users/${id}`, userData);
         });
     }
+    /**
+     * DELETE请求
+     */
     deleteUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.delete(`/users/${id}`);
         });
     }
+    /**
+     * 文件上传
+     */
     uploadFile(file, filename) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();
@@ -72,6 +93,9 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * 自定义请求配置
+     */
     customRequest() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.request({
@@ -89,12 +113,21 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * 获取统计信息
+     */
     getStatistics() {
         return this.httpClient.getStats();
     }
+    /**
+     * 重置统计信息
+     */
     resetStatistics() {
         this.httpClient.resetStats();
     }
+    /**
+     * 生成curl命令
+     */
     generateCurlForRequest(url, method = 'GET', data) {
         const config = {
             url,
@@ -107,46 +140,73 @@ let BasicHttpExample = class BasicHttpExample {
         };
         return this.httpClient.generateCurlCommand(config);
     }
+    /**
+     * 查询HTTP日志
+     */
     queryHttpLogs() {
         return __awaiter(this, arguments, void 0, function* (options = {}) {
             return this.logQueryService.findLogs(options);
         });
     }
+    /**
+     * 查询错误日志
+     */
     findErrorLogs() {
         return __awaiter(this, arguments, void 0, function* (limit = 10) {
             return this.logQueryService.findErrorLogs({ limit });
         });
     }
+    /**
+     * 查询慢请求
+     */
     findSlowRequests() {
         return __awaiter(this, arguments, void 0, function* (minResponseTime = 5000) {
             return this.logQueryService.findSlowRequests(minResponseTime);
         });
     }
+    /**
+     * 查询重试日志
+     */
     findRetryLogs() {
         return __awaiter(this, arguments, void 0, function* (minRetries = 2) {
             return this.logQueryService.findRetryLogs({ minRetries });
         });
     }
+    /**
+     * 根据服务名称查询日志
+     */
     findLogsByServiceName(serviceName_1) {
         return __awaiter(this, arguments, void 0, function* (serviceName, limit = 20) {
             return this.logQueryService.findLogs({ serviceName, limit });
         });
     }
+    /**
+     * 根据操作名称查询日志
+     */
     findLogsByOperationName(operationName_1) {
         return __awaiter(this, arguments, void 0, function* (operationName, limit = 20) {
             return this.logQueryService.findLogs({ operationName, limit });
         });
     }
+    /**
+     * 获取HTTP统计信息
+     */
     getHttpStats(startDate, endDate) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.logQueryService.getStats({ startDate, endDate });
         });
     }
+    /**
+     * 根据请求ID查询日志
+     */
     findLogByRequestId(requestId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.logQueryService.findLogByRequestId(requestId);
         });
     }
+    /**
+     * 清理旧日志
+     */
     cleanupOldLogs() {
         return __awaiter(this, arguments, void 0, function* (daysToKeep = 30) {
             return this.logQueryService.deleteOldLogs(daysToKeep);

package/http-client/examples/multi-api-configuration.example.d.ts

@@ -1,10 +1,19 @@
 import { ApiClientInstanceConfig, ApiClientRegistryService } from '../services/api-client-registry.service';
+/**
+ * GitHub API 客户端示例
+ */
 export declare class GitHubApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
+    /**
+     * 获取GitHub客户端
+     */
     get github(): GitHubApiClient;
     private initializeClients;
 }
+/**
+ * GitHub API 类型定义
+ */
 export interface GitHubApiClient {
     get<T = any>(url: string, config?: any): Promise<T>;
     post<T = any>(url: string, data?: any, config?: any): Promise<T>;
@@ -14,6 +23,9 @@ export interface GitHubApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * Stripe API 客户端示例
+ */
 export declare class StripeApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
@@ -27,6 +39,9 @@ export interface StripeApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * 微信API客户端示例
+ */
 export declare class WeChatApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
@@ -40,6 +55,9 @@ export interface WeChatApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * 自定义API客户端示例（复杂响应格式）
+ */
 export declare class CustomApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
@@ -59,12 +77,27 @@ export interface CustomApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * API管理服务示例
+ */
 export declare class ApiManagementService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
+    /**
+     * 动态创建API客户端
+     */
     createDynamicClient(name: string, config: Partial<ApiClientInstanceConfig>): any;
+    /**
+     * 获取所有客户端统计信息
+     */
     getAllStats(): Record<string, any>;
+    /**
+     * 重置所有统计信息
+     */
     resetAllStats(): void;
+    /**
+     * 健康检查
+     */
     healthCheck(): Promise<{
         status: "healthy" | "unhealthy";
         clients: Record<string, {
@@ -72,9 +105,18 @@ export declare class ApiManagementService {
             error?: string;
         }>;
     }>;
+    /**
+     * 批量创建客户端
+     */
     createMultipleClients(configs: ApiClientInstanceConfig[]): void;
+    /**
+     * 获取客户端列表
+     */
     listClients(): string[];
 }
+/**
+ * 使用示例控制器
+ */
 export declare class ExampleController {
     private readonly githubApi;
     private readonly stripeApi;
@@ -82,11 +124,29 @@ export declare class ExampleController {
     private readonly customApi;
     private readonly apiManagement;
     constructor(githubApi: GitHubApiService, stripeApi: StripeApiService, wechatApi: WeChatApiService, customApi: CustomApiService, apiManagement: ApiManagementService);
+    /**
+     * GitHub API 示例
+     */
     getGitHubUser(username: string): Promise<any>;
+    /**
+     * Stripe API 示例
+     */
     createStripePayment(amount: number, currency: string): Promise<any>;
+    /**
+     * 微信 API 示例
+     */
     sendWeChatMessage(openid: string, content: string): Promise<any>;
+    /**
+     * 自定义API 示例
+     */
     getCustomData(id: string): Promise<any>;
+    /**
+     * 动态API示例
+     */
     callDynamicApi(url: string): Promise<any>;
+    /**
+     * API管理示例
+     */
     getApiHealth(): Promise<{
         status: "healthy" | "unhealthy";
         clients: Record<string, {