@nest-omni/core 4.1.3-2 → 4.1.3-20

package/http-client/utils/call-stack-extractor.util.js

@@ -1,18 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CallStackExtractor = void 0;
+/**
+ * 调用栈提取工具
+ * 用于自动提取HTTP请求的调用服务和方法信息
+ */
 class CallStackExtractor {
+    /**
+     * 设置装饰器上下文
+     */
+    static setDecoratorContext(context) {
+        // 只在最外层设置
+        if (this.decoratorContextDepth === 0) {
+            this.decoratorContext = context;
+        }
+        this.decoratorContextDepth++;
+    }
+    /**
+     * 获取装饰器上下文
+     */
+    static getDecoratorContext() {
+        return this.decoratorContext;
+    }
+    /**
+     * 清除装饰器上下文
+     */
+    static clearDecoratorContext() {
+        this.decoratorContextDepth--;
+        // 只在最外层清除
+        if (this.decoratorContextDepth <= 0) {
+            this.decoratorContext = null;
+            this.decoratorContextDepth = 0;
+        }
+    }
+    /**
+     * 从调用栈中提取服务和方法信息
+     */
     static extractCallInfo() {
         const stack = new Error().stack;
         if (!stack) {
             return {};
         }
         const lines = stack.split('\n');
+        // 跳过当前函数和HTTP客户端内部调用
         const httpClientIndex = lines.findIndex((line) => line.includes('http-client.service.ts') ||
             line.includes('HttpClientService'));
         if (httpClientIndex === -1) {
             return {};
         }
+        // 查找实际的业务调用
         for (let i = httpClientIndex + 1; i < lines.length; i++) {
             const line = lines[i];
             const callInfo = this.parseStackLine(line);
@@ -22,7 +58,11 @@ class CallStackExtractor {
         }
         return {};
     }
+    /**
+     * 手动设置调用信息（当自动检测失败时）
+     */
     static setCallInfo(serviceClass, methodName, operationName) {
+        // 存储到当前上下文中
         if (typeof global !== 'undefined') {
             global.httpCallContext = {
                 serviceClass,
@@ -32,9 +72,13 @@ class CallStackExtractor {
             };
         }
     }
+    /**
+     * 获取手动设置的调用信息
+     */
     static getManualCallInfo() {
         if (typeof global !== 'undefined' && global.httpCallContext) {
             const context = global.httpCallContext;
+            // 清理过期的上下文（超过1秒）
             if (Date.now() - context.timestamp < 1000) {
                 return {
                     serviceClass: context.serviceClass,
@@ -46,18 +90,29 @@ class CallStackExtractor {
         }
         return null;
     }
+    /**
+     * 清理手动设置的调用信息
+     */
     static clearCallInfo() {
         if (typeof global !== 'undefined' && global.httpCallContext) {
             delete global.httpCallContext;
         }
     }
+    /**
+     * 获取调用信息（优先使用手动设置的信息）
+     */
     static getCallInfo() {
+        // 首先尝试获取手动设置的信息
         const manualInfo = this.getManualCallInfo();
         if (manualInfo) {
             return manualInfo;
         }
+        // 然后尝试从调用栈中自动提取
         return this.extractCallInfo();
     }
+    /**
+     * 从装饰器中提取调用信息
+     */
     static extractFromDecorator(target, propertyKey) {
         var _a;
         const serviceClass = (_a = target.constructor) === null || _a === void 0 ? void 0 : _a.name;
@@ -70,13 +125,18 @@ class CallStackExtractor {
                 : undefined,
         };
     }
+    /**
+     * 生成操作名称
+     */
     static generateOperationName(serviceClass, methodName, config) {
         if (!serviceClass || !methodName) {
             return 'Unknown';
         }
+        // 根据URL生成操作名称
         let operationName = `${serviceClass}.${methodName}`;
         if (config === null || config === void 0 ? void 0 : config.url) {
             const url = config.url;
+            // 提取URL中的关键路径部分
             const pathParts = url
                 .split('/')
                 .filter((part) => part && !part.includes('{'));
@@ -89,20 +149,32 @@ class CallStackExtractor {
         }
         return operationName;
     }
+    /**
+     * 格式化服务类名
+     */
     static formatServiceClass(serviceClass) {
         if (!serviceClass)
             return 'Unknown';
+        // 移除常见的后缀
         return serviceClass.replace(/Service|Controller|Provider|Handler$/, '');
     }
+    /**
+     * 格式化方法名
+     */
     static formatMethodName(methodName) {
         if (!methodName)
             return 'unknown';
+        // 将驼峰命名转换为更友好的格式
         return methodName
             .replace(/([A-Z])/g, ' $1')
             .replace(/^./, (str) => str.toUpperCase())
             .trim();
     }
+    /**
+     * 解析调用栈行
+     */
     static parseStackLine(line) {
+        // 匹配格式：at ClassName.methodName (/path/to/file.js:line:column)
         const match = line.match(/at\s+([^.]+)\.([^(]+)\s*\(/);
         if (!match) {
             return null;
@@ -114,6 +186,9 @@ class CallStackExtractor {
             operationName: `${serviceClass}.${methodName}`,
         };
     }
+    /**
+     * 判断是否为内部调用
+     */
     static isInternalCall(serviceClass) {
         if (!serviceClass)
             return true;
@@ -136,3 +211,11 @@ class CallStackExtractor {
     }
 }
 exports.CallStackExtractor = CallStackExtractor;
+/**
+ * 存储装饰器上下文（用于传递装饰器信息到HTTP客户端）
+ */
+CallStackExtractor.decoratorContext = null;
+/**
+ * 装饰器上下文引用计数，用于处理多个装饰器嵌套的情况
+ */
+CallStackExtractor.decoratorContextDepth = 0;

package/http-client/utils/context-extractor.util.d.ts

@@ -1,4 +1,11 @@
+/**
+ * 上下文信息提取器
+ * 从ContextProvider获取请求相关的上下文信息
+ */
 export declare class ContextExtractor {
+    /**
+     * 获取完整的HTTP请求上下文
+     */
     static getHttpContext(): {
         requestId?: string;
         userId?: string;
@@ -8,14 +15,41 @@ export declare class ContextExtractor {
         metadata?: Record<string, any>;
         tags?: string[];
     };
+    /**
+     * 获取请求ID
+     */
     static getRequestId(): string | undefined;
+    /**
+     * 获取用户ID
+     */
     static getUserId(): string | undefined;
+    /**
+     * 获取客户端IP
+     */
     static getClientIp(): string | undefined;
+    /**
+     * 获取用户代理
+     */
     static getUserAgent(): string | undefined;
+    /**
+     * 获取服务名称
+     */
     static getServiceName(): string | undefined;
+    /**
+     * 获取元数据
+     */
     static getMetadata(): Record<string, any> | undefined;
+    /**
+     * 获取标签
+     */
     static getTags(): string[];
+    /**
+     * 添加标签到上下文
+     */
     static addTag(tag: string): void;
+    /**
+     * 获取上下文摘要
+     */
     static getContextSummary(): {
         requestId?: string;
         userId?: string;
@@ -24,13 +58,22 @@ export declare class ContextExtractor {
         hasUser: boolean;
         requestSource: string;
     };
+    /**
+     * 获取请求来源信息
+     */
     static getRequestSource(): {
         source: 'internal' | 'external' | 'unknown';
         ip?: string;
         userAgent?: string;
         service?: string;
     };
+    /**
+     * 判断是否为内部请求
+     */
     static isInternalRequest(): boolean;
+    /**
+     * 获取安全上下文
+     */
     static getSecurityContext(): {
         isAuthenticated: boolean;
         userId?: string;
@@ -39,6 +82,12 @@ export declare class ContextExtractor {
         permissions: string[];
         securityLevel: 'low' | 'medium' | 'high';
     };
+    /**
+     * 生成Span ID
+     */
     private static generateSpanId;
+    /**
+     * 检查172.x.x.x是否为内网IP (172.16.0.0 - 172.31.255.255)
+     */
     private static isInternal172IP;
 }

package/http-client/utils/context-extractor.util.js

@@ -2,7 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextExtractor = void 0;
 const providers_1 = require("../../providers");
+/**
+ * 上下文信息提取器
+ * 从ContextProvider获取请求相关的上下文信息
+ */
 class ContextExtractor {
+    /**
+     * 获取完整的HTTP请求上下文
+     */
     static getHttpContext() {
         try {
             const requestId = providers_1.ContextProvider.getRequestId();
@@ -21,11 +28,15 @@ class ContextExtractor {
             };
         }
         catch (_a) {
+            // If no context is available, return empty context
             return {
                 tags: [],
             };
         }
     }
+    /**
+     * 获取请求ID
+     */
     static getRequestId() {
         try {
             return providers_1.ContextProvider.getRequestId();
@@ -34,6 +45,9 @@ class ContextExtractor {
             return undefined;
         }
     }
+    /**
+     * 获取用户ID
+     */
     static getUserId() {
         try {
             const authUser = providers_1.ContextProvider.getAuthUser();
@@ -43,6 +57,9 @@ class ContextExtractor {
             return undefined;
         }
     }
+    /**
+     * 获取客户端IP
+     */
     static getClientIp() {
         try {
             const router = providers_1.ContextProvider.getRouter();
@@ -52,6 +69,9 @@ class ContextExtractor {
             return undefined;
         }
     }
+    /**
+     * 获取用户代理
+     */
     static getUserAgent() {
         try {
             const router = providers_1.ContextProvider.getRouter();
@@ -61,6 +81,9 @@ class ContextExtractor {
             return undefined;
         }
     }
+    /**
+     * 获取服务名称
+     */
     static getServiceName() {
         try {
             const authUser = providers_1.ContextProvider.getAuthUser();
@@ -70,6 +93,9 @@ class ContextExtractor {
             return undefined;
         }
     }
+    /**
+     * 获取元数据
+     */
     static getMetadata() {
         try {
             const authUser = providers_1.ContextProvider.getAuthUser();
@@ -83,6 +109,9 @@ class ContextExtractor {
             return undefined;
         }
     }
+    /**
+     * 获取标签
+     */
     static getTags() {
         try {
             const context = this.getHttpContext();
@@ -92,6 +121,9 @@ class ContextExtractor {
             return [];
         }
     }
+    /**
+     * 添加标签到上下文
+     */
     static addTag(tag) {
         try {
             const context = this.getHttpContext();
@@ -102,8 +134,12 @@ class ContextExtractor {
             }
         }
         catch (_a) {
+            // Silently fail if context is not available
         }
     }
+    /**
+     * 获取上下文摘要
+     */
     static getContextSummary() {
         const context = this.getHttpContext();
         return {
@@ -115,11 +151,15 @@ class ContextExtractor {
             requestSource: this.getRequestSource().source,
         };
     }
+    /**
+     * 获取请求来源信息
+     */
     static getRequestSource() {
         const context = this.getHttpContext();
         if (!context.clientIp) {
             return { source: 'unknown' };
         }
+        // Check if it's an internal IP
         const internalIPs = ['::1', '127.0.0.1', 'localhost'];
         const isInternal = internalIPs.includes(context.clientIp) ||
             context.clientIp.startsWith('192.168.') ||
@@ -133,10 +173,16 @@ class ContextExtractor {
             service: context.appId,
         };
     }
+    /**
+     * 判断是否为内部请求
+     */
     static isInternalRequest() {
         const requestSource = this.getRequestSource();
         return requestSource.source === 'internal';
     }
+    /**
+     * 获取安全上下文
+     */
     static getSecurityContext() {
         try {
             const authUser = providers_1.ContextProvider.getAuthUser();
@@ -157,9 +203,15 @@ class ContextExtractor {
             };
         }
     }
+    /**
+     * 生成Span ID
+     */
     static generateSpanId() {
         return Math.random().toString(36).substring(2, 15);
     }
+    /**
+     * 检查172.x.x.x是否为内网IP (172.16.0.0 - 172.31.255.255)
+     */
     static isInternal172IP(ip) {
         if (!ip.startsWith('172.'))
             return false;

package/http-client/utils/curl-generator.util.d.ts

@@ -1,9 +1,30 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
+/**
+ * HTTP请求curl命令生成器
+ */
 export declare class CurlGenerator {
+    /**
+     * 生成curl命令
+     */
     static generateCurlCommand(config: AxiosRequestConfig, response?: AxiosResponse): string;
+    /**
+     * 生成简化的curl命令（用于日志记录）
+     */
     static generateSimplifiedCurl(config: AxiosRequestConfig): string;
+    /**
+     * 生成用于调试的详细curl命令
+     */
     static generateDebugCurl(config: AxiosRequestConfig, response?: AxiosResponse): string;
+    /**
+     * 从curl命令解析请求配置
+     */
     static parseCurlCommand(curlCommand: string): Partial<AxiosRequestConfig>;
+    /**
+     * 构建完整URL
+     */
     private static buildUrl;
+    /**
+     * 过滤敏感头信息
+     */
     private static sanitizeHeaderValue;
 }

package/http-client/utils/curl-generator.util.js

@@ -1,14 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CurlGenerator = void 0;
+/**
+ * HTTP请求curl命令生成器
+ */
 class CurlGenerator {
+    /**
+     * 生成curl命令
+     */
     static generateCurlCommand(config, response) {
         const parts = ['curl'];
+        // 添加方法
         if (config.method && config.method.toLowerCase() !== 'get') {
             parts.push(`-X ${config.method.toUpperCase()}`);
         }
+        // 添加URL
         const url = this.buildUrl(config);
         parts.push(`'${url}'`);
+        // 添加头信息
         if (config.headers) {
             Object.entries(config.headers).forEach(([key, value]) => {
                 if (value !== undefined && value !== null) {
@@ -16,12 +25,14 @@ class CurlGenerator {
                 }
             });
         }
+        // 添加数据
         if (config.data) {
             const data = typeof config.data === 'string'
                 ? config.data
                 : JSON.stringify(config.data, null, 2);
             parts.push(`-d '${data}'`);
         }
+        // 添加表单数据
         if (config.data instanceof FormData) {
             const formDataParts = [];
             config.data.forEach((value, key) => {
@@ -34,26 +45,35 @@ class CurlGenerator {
             });
             parts.push(...formDataParts);
         }
+        // 添加查询参数（如果不在URL中）
         if (config.params && !url.includes('?')) {
             const params = new URLSearchParams(config.params).toString();
             if (params) {
                 parts[parts.length - 1] = parts[parts.length - 1].replace(/'/, `?${params}'`);
             }
         }
-        parts.push('-i');
-        parts.push('-s');
-        parts.push('-L');
+        // 添加其他选项
+        parts.push('-i'); // 包含头信息
+        parts.push('-s'); // 静默模式
+        parts.push('-L'); // 跟随重定向
+        // 添加响应状态码注释
         if (response) {
             parts.push(`# Response: ${response.status} ${response.statusText}`);
         }
         return parts.join(' \\\n  ');
     }
+    /**
+     * 生成简化的curl命令（用于日志记录）
+     */
     static generateSimplifiedCurl(config) {
         const parts = ['curl'];
+        // 添加方法
         if (config.method && config.method.toLowerCase() !== 'get') {
             parts.push(`-X ${config.method.toUpperCase()}`);
         }
+        // 添加URL
         parts.push(`'${this.buildUrl(config)}'`);
+        // 只添加重要的头信息
         const importantHeaders = [
             'content-type',
             'accept',
@@ -65,11 +85,13 @@ class CurlGenerator {
                 .filter(([key]) => importantHeaders.includes(key.toLowerCase()))
                 .forEach(([key, value]) => {
                 if (value !== undefined && value !== null) {
+                    // 过滤敏感信息
                     const sanitizedValue = this.sanitizeHeaderValue(key, String(value));
                     parts.push(`-H '${key}: ${sanitizedValue}'`);
                 }
             });
         }
+        // 添加数据（简化版）
         if (config.data) {
             const data = typeof config.data === 'string'
                 ? config.data.substring(0, 200) +
@@ -79,9 +101,13 @@ class CurlGenerator {
         }
         return parts.join(' ');
     }
+    /**
+     * 生成用于调试的详细curl命令
+     */
     static generateDebugCurl(config, response) {
         var _a, _b, _c;
         const curl = this.generateCurlCommand(config, response);
+        // 添加调试信息注释
         const debugInfo = [
             '# Debug Information:',
             `# Timestamp: ${new Date().toISOString()}`,
@@ -94,17 +120,23 @@ class CurlGenerator {
         }
         return debugInfo.join('\n') + '\n' + curl;
     }
+    /**
+     * 从curl命令解析请求配置
+     */
     static parseCurlCommand(curlCommand) {
         const config = {};
         try {
+            // 提取方法
             const methodMatch = curlCommand.match(/-X\s+(\w+)/);
             if (methodMatch) {
                 config.method = methodMatch[1].toLowerCase();
             }
+            // 提取URL
             const urlMatch = curlCommand.match(/curl[^']*'([^']+)'/);
             if (urlMatch) {
                 config.url = urlMatch[1];
             }
+            // 提取头信息
             const headerMatches = curlCommand.match(/-H\s+'([^:]+):\s*([^']+)'/g) || [];
             config.headers = {};
             headerMatches.forEach((header) => {
@@ -113,6 +145,7 @@ class CurlGenerator {
                     config.headers[headerMatch[1]] = headerMatch[2];
                 }
             });
+            // 提取数据
             const dataMatch = curlCommand.match(/-d\s+'([^']+)'/);
             if (dataMatch) {
                 try {
@@ -128,11 +161,16 @@ class CurlGenerator {
         }
         return config;
     }
+    /**
+     * 构建完整URL
+     */
     static buildUrl(config) {
         let url = config.url || '';
+        // 处理相对URL
         if (config.baseURL && !url.startsWith('http')) {
             url = config.baseURL.replace(/\/$/, '') + '/' + url.replace(/^\//, '');
         }
+        // 添加查询参数
         if (config.params) {
             const searchParams = new URLSearchParams();
             Object.entries(config.params).forEach(([key, value]) => {
@@ -147,6 +185,9 @@ class CurlGenerator {
         }
         return url;
     }
+    /**
+     * 过滤敏感头信息
+     */
     static sanitizeHeaderValue(key, value) {
         const sensitiveKeys = [
             'authorization',

package/http-client/utils/index.d.ts

@@ -2,3 +2,4 @@ export * from './curl-generator.util';
 export * from './retry-recorder.util';
 export * from './context-extractor.util';
 export * from './call-stack-extractor.util';
+export * from './proxy-environment.util';

package/http-client/utils/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./curl-generator.util"), exports);
 __exportStar(require("./retry-recorder.util"), exports);
 __exportStar(require("./context-extractor.util"), exports);
 __exportStar(require("./call-stack-extractor.util"), exports);
+__exportStar(require("./proxy-environment.util"), exports);

package/http-client/utils/proxy-environment.util.d.ts

@@ -0,0 +1,42 @@
+import { ProxyConfig } from '../interfaces/http-client-config.interface';
+/**
+ * 代理环境变量解析工具
+ * 支持标准的代理环境变量：HTTP_PROXY, HTTPS_PROXY, NO_PROXY
+ */
+export declare class ProxyEnvironmentParser {
+    private static readonly logger;
+    /**
+     * 从环境变量解析代理配置
+     * @param protocol 请求协议 (http 或 https)
+     * @param targetUrl 目标 URL（用于检查 NO_PROXY）
+     * @returns 解析后的代理配置，如果不应使用代理则返回 false
+     */
+    static parseFromEnvironment(protocol?: 'http' | 'https', targetUrl?: string): false | Required<Omit<ProxyConfig, 'enabled' | 'fromEnvironment'>>;
+    /**
+     * 解析代理 URL
+     * 支持格式: http://proxy:port, http://user:pass@proxy:port
+     */
+    private static parseProxyUrl;
+    /**
+     * 检查是否应该绕过代理
+     * 基于 NO_PROXY 环境变量
+     */
+    private static shouldBypassProxy;
+    /**
+     * 简单的 IP 地址匹配
+     * 支持精确匹配和 CIDR 表示法
+     */
+    private static isIpMatch;
+    /**
+     * 获取所有代理相关的环境变量
+     */
+    static getProxyEnvironmentVariables(): {
+        HTTP_PROXY?: string;
+        HTTPS_PROXY?: string;
+        NO_PROXY?: string;
+    };
+    /**
+     * 检查是否设置了代理环境变量
+     */
+    static hasProxyEnvironment(): boolean;
+}