@pawells/nestjs-shared 1.0.0-dev.3052c75

package/build/common/services/error-categorizer.service.js

@@ -0,0 +1,339 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var ErrorCategorizerService_1;
+import { Injectable } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { HTTP_STATUS_BAD_REQUEST, HTTP_STATUS_UNAUTHORIZED, HTTP_STATUS_FORBIDDEN, HTTP_STATUS_NOT_FOUND, HTTP_STATUS_TOO_MANY_REQUESTS, HTTP_STATUS_BAD_GATEWAY, HTTP_STATUS_SERVICE_UNAVAILABLE, HTTP_STATUS_GATEWAY_TIMEOUT, HTTP_STATUS_UNPROCESSABLE_ENTITY, } from '../constants/http-status.constants.js';
+import { AppLogger } from './logger.service.js';
+// Backoff times in milliseconds
+const BACKOFF_RETRY_MS = 1000;
+const BACKOFF_TIMEOUT_MS = 2000;
+const BACKOFF_DATABASE_MS = 5000;
+const BACKOFF_RATE_LIMIT_MS = 10000;
+/**
+ * Error Categorizer Service.
+ * Classifies errors as transient or permanent and recommends recovery strategies.
+ *
+ * Categories:
+ * - **Transient** (retryable): Network errors, timeouts, database connection errors, rate limits, server errors (5xx)
+ * - **Permanent** (not retryable): Validation errors, bad requests (4xx), authentication/authorization, not found
+ *
+ * Recovery strategies:
+ * - **retry**: Immediate retry (for network errors)
+ * - **backoff**: Exponential backoff retry (for timeouts, database, rate limits)
+ * - **fail**: Fast failure without retry (for validation, authentication, not found)
+ *
+ * @remarks
+ * - Node.js error codes (ECONNRESET, ECONNREFUSED, ETIMEDOUT, ENOTFOUND, EAI_AGAIN) are always transient
+ * - Database connection errors are always transient with long backoff (5s)
+ * - Timeout errors get medium backoff (2s)
+ * - Rate limit errors get maximum backoff (10s)
+ * - Unknown errors default to permanent/fail strategy
+ *
+ * @example
+ * ```typescript
+ * const category = errorCategorizer.categorizeError(error);
+ * if (category.retryable) {
+ *   // Retry with backoff: category.backoffMs
+ * } else {
+ *   // Fail fast
+ * }
+ * ```
+ */
+let ErrorCategorizerService = ErrorCategorizerService_1 = class ErrorCategorizerService {
+    _contextualLogger;
+    Module;
+    constructor(module) {
+        this.Module = module;
+    }
+    /**
+     * Get contextual logger for error categorizer
+     */
+    get Logger() {
+        if (!this._contextualLogger) {
+            const baseLogger = this.Module.get(AppLogger);
+            this._contextualLogger = baseLogger.createContextualLogger(ErrorCategorizerService_1.name);
+        }
+        return this._contextualLogger;
+    }
+    /**
+     * Check if an error is retryable
+     */
+    isRetryable(error) {
+        const category = this.categorizeError(error);
+        return category.retryable;
+    }
+    /**
+     * Categorize an error and determine recovery strategy
+     */
+    categorizeError(error) {
+        const err = error;
+        const errorMessage = err?.message ?? String(error);
+        const errorCode = err?.code ?? err?.status;
+        // Node.js network error codes are always transient (checked first before pattern matching)
+        const NODE_TRANSIENT_CODES = new Set(['ECONNRESET', 'ECONNREFUSED', 'ETIMEDOUT', 'ENOTFOUND', 'EAI_AGAIN']);
+        if (error && NODE_TRANSIENT_CODES.has(error.code ?? '')) {
+            this.Logger.debug('Categorized as transient network error (Node.js error code)', {
+                error: errorMessage,
+                code: errorCode,
+                category: 'transient',
+                strategy: 'backoff',
+            });
+            return {
+                type: 'transient',
+                retryable: true,
+                strategy: 'backoff',
+                backoffMs: BACKOFF_RETRY_MS,
+            };
+        }
+        // Database connection errors (transient) - check before timeout since "timeout" may be in message
+        if (this.isDatabaseError(error)) {
+            this.Logger.debug('Categorized as transient database error', {
+                error: errorMessage,
+                category: 'transient',
+                strategy: 'backoff',
+            });
+            return {
+                type: 'transient',
+                retryable: true,
+                strategy: 'backoff',
+                backoffMs: BACKOFF_DATABASE_MS,
+            };
+        }
+        // Timeout errors (transient) - check before generic network errors since ETIMEDOUT is in networkCodes
+        if (this.isTimeoutError(error)) {
+            this.Logger.debug('Categorized as transient timeout error', {
+                error: errorMessage,
+                category: 'transient',
+                strategy: 'backoff',
+            });
+            return {
+                type: 'transient',
+                retryable: true,
+                strategy: 'backoff',
+                backoffMs: BACKOFF_TIMEOUT_MS,
+            };
+        }
+        // Network errors (transient)
+        if (this.isNetworkError(error)) {
+            this.Logger.debug('Categorized as transient network error', {
+                error: errorMessage,
+                category: 'transient',
+                strategy: 'retry',
+            });
+            return {
+                type: 'transient',
+                retryable: true,
+                strategy: 'retry',
+                backoffMs: BACKOFF_RETRY_MS,
+            };
+        }
+        // Server errors (transient) - 502, 503, 504
+        if (this.isServerError(error)) {
+            this.Logger.debug('Categorized as transient server error', {
+                error: errorMessage,
+                status: errorCode,
+                category: 'transient',
+                strategy: 'backoff',
+            });
+            return {
+                type: 'transient',
+                retryable: true,
+                strategy: 'backoff',
+                backoffMs: BACKOFF_TIMEOUT_MS,
+            };
+        }
+        // Rate limit errors (transient) - 429
+        if (this.isRateLimitError(error)) {
+            this.Logger.debug('Categorized as transient rate limit error', {
+                error: errorMessage,
+                category: 'transient',
+                strategy: 'backoff',
+            });
+            return {
+                type: 'transient',
+                retryable: true,
+                strategy: 'backoff',
+                backoffMs: BACKOFF_RATE_LIMIT_MS,
+            };
+        }
+        // Bad request errors (permanent) - 400, 422
+        if (this.isBadRequestError(error)) {
+            this.Logger.debug('Categorized as permanent bad request error', {
+                error: errorMessage,
+                category: 'permanent',
+                strategy: 'fail',
+            });
+            return {
+                type: 'permanent',
+                retryable: false,
+                strategy: 'fail',
+            };
+        }
+        // Validation errors (permanent)
+        if (this.isValidationError(error)) {
+            this.Logger.debug('Categorized as permanent validation error', {
+                error: errorMessage,
+                category: 'permanent',
+                strategy: 'fail',
+            });
+            return {
+                type: 'permanent',
+                retryable: false,
+                strategy: 'fail',
+            };
+        }
+        // Authentication errors (permanent) - 401
+        if (this.isAuthError(error)) {
+            this.Logger.debug('Categorized as permanent authentication error', {
+                error: errorMessage,
+                category: 'permanent',
+                strategy: 'fail',
+            });
+            return {
+                type: 'permanent',
+                retryable: false,
+                strategy: 'fail',
+            };
+        }
+        // Authorization errors (permanent) - 403
+        if (this.isAuthzError(error)) {
+            this.Logger.debug('Categorized as permanent authorization error', {
+                error: errorMessage,
+                category: 'permanent',
+                strategy: 'fail',
+            });
+            return {
+                type: 'permanent',
+                retryable: false,
+                strategy: 'fail',
+            };
+        }
+        // Not found errors (permanent) - 404
+        if (this.isNotFoundError(error)) {
+            this.Logger.debug('Categorized as permanent not found error', {
+                error: errorMessage,
+                category: 'permanent',
+                strategy: 'fail',
+            });
+            return {
+                type: 'permanent',
+                retryable: false,
+                strategy: 'fail',
+            };
+        }
+        // Default to permanent error
+        this.Logger.warn('Uncategorized error treated as permanent', {
+            error: errorMessage,
+            code: errorCode,
+            category: 'permanent',
+            strategy: 'fail',
+        });
+        return {
+            type: 'permanent',
+            retryable: false,
+            strategy: 'fail',
+        };
+    }
+    /**
+     * Log error recovery attempt
+     */
+    logRecoveryAttempt(error, attempt, maxAttempts) {
+        const category = this.categorizeError(error);
+        this.Logger.info('Error recovery attempt', {
+            attempt,
+            maxAttempts,
+            errorType: category.type,
+            strategy: category.strategy,
+            backoffMs: category.backoffMs,
+            error: error?.message ?? String(error),
+        });
+    }
+    /**
+     * Log successful recovery
+     */
+    logRecoverySuccess(error, attempts) {
+        this.Logger.info('Error recovery successful', {
+            attempts,
+            error: error?.message ?? String(error),
+        });
+    }
+    /**
+     * Log failed recovery
+     */
+    logRecoveryFailed(error, attempts) {
+        const err = error;
+        const category = this.categorizeError(error);
+        this.Logger.error('Error recovery failed', undefined, undefined, {
+            attempts,
+            errorType: category.type,
+            retryable: category.retryable,
+            error: err?.message ?? String(error),
+        });
+    }
+    isNetworkError(error) {
+        const err = error;
+        const networkCodes = ['ECONNREFUSED', 'ENOTFOUND', 'ECONNRESET', 'EPIPE'];
+        return networkCodes.includes(err?.code) || /\bnetwork\b/i.test(err?.message) || /\bconnection\b/i.test(err?.message);
+    }
+    isTimeoutError(error) {
+        const err = error;
+        return err?.code === 'ETIMEDOUT' ||
+            /\btimeout\b|\btimed out\b/i.test(err?.message);
+    }
+    isDatabaseError(error) {
+        const err = error;
+        return /\bconnection\b/i.test(err?.message) &&
+            (/\bdatabase\b/i.test(err?.message) ||
+                /\bmongodb\b/i.test(err?.message) ||
+                /\bredis\b/i.test(err?.message));
+    }
+    isBadRequestError(error) {
+        const err = error;
+        return err?.status === HTTP_STATUS_BAD_REQUEST ||
+            err?.status === HTTP_STATUS_UNPROCESSABLE_ENTITY;
+    }
+    isValidationError(error) {
+        const err = error;
+        return /\bvalidation\b/i.test(err?.message) ||
+            err?.name === 'ValidationError';
+    }
+    isAuthError(error) {
+        const err = error;
+        return err?.status === HTTP_STATUS_UNAUTHORIZED || /\bunauthorized\b/i.test(err?.message) ||
+            /\bauthentication\b/i.test(err?.message);
+    }
+    isAuthzError(error) {
+        const err = error;
+        return err?.status === HTTP_STATUS_FORBIDDEN || /\bforbidden\b/i.test(err?.message) ||
+            /\bauthorization\b/i.test(err?.message);
+    }
+    isNotFoundError(error) {
+        const err = error;
+        return err?.status === HTTP_STATUS_NOT_FOUND || /\bnot found\b/i.test(err?.message);
+    }
+    isServerError(error) {
+        const err = error;
+        return err?.status === HTTP_STATUS_BAD_GATEWAY ||
+            err?.status === HTTP_STATUS_SERVICE_UNAVAILABLE ||
+            err?.status === HTTP_STATUS_GATEWAY_TIMEOUT;
+    }
+    isRateLimitError(error) {
+        const err = error;
+        return err?.status === HTTP_STATUS_TOO_MANY_REQUESTS || /\brate limit\b/i.test(err?.message) ||
+            /\btoo many requests\b/i.test(err?.message);
+    }
+};
+ErrorCategorizerService = ErrorCategorizerService_1 = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [ModuleRef])
+], ErrorCategorizerService);
+export { ErrorCategorizerService };
+//# sourceMappingURL=error-categorizer.service.js.map

package/build/common/services/error-categorizer.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-categorizer.service.js","sourceRoot":"","sources":["../../../src/common/services/error-categorizer.service.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EACN,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,qBAAqB,EACrB,6BAA6B,EAC7B,uBAAuB,EACvB,+BAA+B,EAC/B,2BAA2B,EAC3B,gCAAgC,GAChC,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,gCAAgC;AAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAChC,MAAM,mBAAmB,GAAG,IAAI,CAAC;AACjC,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAYpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEI,IAAM,uBAAuB,+BAA7B,MAAM,uBAAuB;IAC3B,iBAAiB,CAAwB;IAEjC,MAAM,CAAY;IAElC,YAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QAChB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,sBAAsB,CAAC,yBAAuB,CAAC,IAAI,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,KAAc;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC,SAAS,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,KAAc;QACpC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,MAAM,YAAY,GAAG,GAAG,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,GAAG,EAAE,IAAI,IAAI,GAAG,EAAE,MAAM,CAAC;QAE3C,2FAA2F;QAC3F,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;QAC5G,IAAI,KAAK,IAAI,oBAAoB,CAAC,GAAG,CAAE,KAA2B,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;YAChF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6DAA6D,EAAE;gBAChF,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,gBAAgB;aAC3B,CAAC;QACH,CAAC;QAED,kGAAkG;QAClG,IAAI,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,EAAE;gBAC5D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,mBAAmB;aAC9B,CAAC;QACH,CAAC;QAED,sGAAsG;QACtG,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE;gBAC3D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,kBAAkB;aAC7B,CAAC;QACH,CAAC;QAED,6BAA6B;QAC7B,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE;gBAC3D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,OAAO;aACjB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,OAAO;gBACjB,SAAS,EAAE,gBAAgB;aAC3B,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE;gBAC1D,KAAK,EAAE,YAAY;gBACnB,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,kBAAkB;aAC7B,CAAC;QACH,CAAC;QAED,sCAAsC;QACtC,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,EAAE;gBAC9D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,qBAAqB;aAChC,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,IAAI,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE;gBAC/D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;aAChB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,MAAM;aAChB,CAAC;QACH,CAAC;QAED,gCAAgC;QAChC,IAAI,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,EAAE;gBAC9D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;aAChB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,MAAM;aAChB,CAAC;QACH,CAAC;QAED,0CAA0C;QAC1C,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+CAA+C,EAAE;gBAClE,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;aAChB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,MAAM;aAChB,CAAC;QACH,CAAC;QAED,yCAAyC;QACzC,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE;gBACjE,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;aAChB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,MAAM;aAChB,CAAC;QACH,CAAC;QAED,qCAAqC;QACrC,IAAI,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,EAAE;gBAC7D,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;aAChB,CAAC,CAAC;YACH,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,MAAM;aAChB,CAAC;QACH,CAAC;QAED,6BAA6B;QAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0CAA0C,EAAE;YAC5D,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,MAAM;SAChB,CAAC,CAAC;QAEH,OAAO;YACN,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,KAAK;YAChB,QAAQ,EAAE,MAAM;SAChB,CAAC;IACH,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,KAAc,EAAE,OAAe,EAAE,WAAmB;QAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE;YAC1C,OAAO;YACP,WAAW;YACX,SAAS,EAAE,QAAQ,CAAC,IAAI;YACxB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,KAAK,EAAG,KAA6B,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC;SAC/D,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,KAAc,EAAE,QAAgB;QACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE;YAC7C,QAAQ;YACR,KAAK,EAAG,KAA6B,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC;SAC/D,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,KAAc,EAAE,QAAgB;QACxD,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,SAAS,EAAE,SAAS,EAAE;YAChE,QAAQ;YACR,SAAS,EAAE,QAAQ,CAAC,IAAI;YACxB,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,KAAK,EAAE,GAAG,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC;SACpC,CAAC,CAAC;IACJ,CAAC;IAEO,cAAc,CAAC,KAAc;QACpC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,MAAM,YAAY,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAC1E,OAAO,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACtH,CAAC;IAEO,cAAc,CAAC,KAAc;QACpC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,IAAI,KAAK,WAAW;YAC/B,4BAA4B,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAEO,eAAe,CAAC,KAAc;QACrC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;YAC1C,CACC,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;gBAClC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;gBACjC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAC/B,CAAC;IACJ,CAAC;IAEO,iBAAiB,CAAC,KAAc;QACvC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,MAAM,KAAK,uBAAuB;YAC7C,GAAG,EAAE,MAAM,KAAK,gCAAgC,CAAC;IACnD,CAAC;IAEO,iBAAiB,CAAC,KAAc;QACvC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;YAC1C,GAAG,EAAE,IAAI,KAAK,iBAAiB,CAAC;IAClC,CAAC;IAEO,WAAW,CAAC,KAAc;QACjC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,MAAM,KAAK,wBAAwB,IAAI,mBAAmB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;YACxF,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEO,YAAY,CAAC,KAAc;QAClC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,MAAM,KAAK,qBAAqB,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;YAClF,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAEO,eAAe,CAAC,KAAc;QACrC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,MAAM,KAAK,qBAAqB,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAEO,aAAa,CAAC,KAAc;QACnC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,MAAM,KAAK,uBAAuB;YAC7C,GAAG,EAAE,MAAM,KAAK,+BAA+B;YAC/C,GAAG,EAAE,MAAM,KAAK,2BAA2B,CAAC;IAC9C,CAAC;IAEO,gBAAgB,CAAC,KAAc;QACtC,MAAM,GAAG,GAAG,KAA4B,CAAC;QACzC,OAAO,GAAG,EAAE,MAAM,KAAK,6BAA6B,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;YAC3F,wBAAwB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;CACD,CAAA;AA5TY,uBAAuB;IADnC,UAAU,EAAE;qCAMQ,SAAS;GALjB,uBAAuB,CA4TnC"}

package/build/common/services/error-sanitizer.service.d.ts

@@ -0,0 +1,146 @@
+import { ModuleRef } from '@nestjs/core';
+import { LazyModuleRefService } from '../utils/lazy-getter.types.js';
+/**
+ * Options for configuring the ErrorSanitizerService.
+ */
+export interface ErrorSanitizerOptions {
+    /**
+     * Additional regex patterns to apply for message sanitization.
+     */
+    additionalPatterns?: RegExp[];
+    /**
+     * Additional field names to treat as sensitive and redact.
+     */
+    additionalSensitiveKeys?: string[];
+}
+/**
+ * Injection token for ErrorSanitizerService configuration.
+ */
+export declare const ERROR_SANITIZER_OPTIONS = "ERROR_SANITIZER_OPTIONS";
+/**
+ * Error Sanitizer Service.
+ * Sanitizes error responses and error context to prevent information disclosure in production.
+ * Removes sensitive information like stack traces, file paths, database URIs, API keys, email addresses,
+ * IP addresses, and custom sensitive fields.
+ *
+ * Implements defense-in-depth by sanitizing:
+ * - Error messages (via regex patterns)
+ * - Nested context objects (via field name matching)
+ * - Stack traces (removed in production)
+ *
+ * Sensitive patterns redacted:
+ * - File paths (e.g., `/home/user/app.ts` -> `[FILE]`)
+ * - Database URIs (e.g., `mongodb://...` -> `[REDACTED]`)
+ * - API keys and tokens (e.g., `Bearer sk_live_...` -> `Bearer [REDACTED]`)
+ * - Email addresses (e.g., `user@example.com` -> `[EMAIL]`)
+ * - IP addresses (IPv4 and IPv6) -> `[IP]`
+ * - Sensitive field values (passwords, tokens, API keys, etc.) -> `***REDACTED***`
+ *
+ * @remarks
+ * - Maximum message length: 5000 chars (prevents ReDoS attacks on regex patterns)
+ * - Maximum context depth: 5 levels (prevents deeply nested structure processing)
+ * - Circular reference detection prevents infinite loops
+ * - Case-insensitive field name matching for sensitivity
+ *
+ * @example
+ * ```typescript
+ * const error = {
+ *   message: 'Error at /home/user/app.ts, Bearer sk_live_abc123',
+ *   context: { password: 'secret123', userId: '456' }
+ * };
+ * const sanitized = errorSanitizer.sanitizeErrorResponse(error, false);
+ * // message: 'Error at [FILE], Bearer [REDACTED]'
+ * // context: { password: '***REDACTED***', userId: '456' }
+ * ```
+ */
+export declare class ErrorSanitizerService implements LazyModuleRefService {
+    /**
+     * Maximum length for error messages before truncation.
+     * Prevents ReDoS (Regular Expression Denial of Service) attacks by limiting
+     * the input size to regex patterns used in message sanitization.
+     */
+    private static readonly MAX_MESSAGE_LENGTH;
+    /**
+     * Maximum nesting depth for context object serialization.
+     * Prevents deeply nested structures from causing performance issues.
+     */
+    private static readonly MAX_CONTEXT_DEPTH;
+    /**
+     * Precompiled regex pattern for matching file paths with code extensions
+     * Used to redact file paths from error messages
+     */
+    private static readonly FILE_PATH_REGEX;
+    /**
+     * Precompiled regex pattern for matching IPv4 addresses
+     */
+    private static readonly IPV4_REGEX;
+    /**
+     * Precompiled regex pattern for matching IPv6 addresses
+     * Covers various IPv6 formats: full form, compressed form, ::1, ::ffff:IPv4, bare ::
+     * Uses a simpler, non-backtracking pattern to avoid ReDoS (Regular Expression Denial of Service)
+     */
+    private static readonly IPV6_REGEX;
+    /**
+     * Default sensitive field names that are always redacted from context
+     * Stored as lowercase for case-insensitive matching
+     */
+    private static readonly DEFAULT_SENSITIVE_KEYS;
+    readonly Module: ModuleRef;
+    constructor(module: ModuleRef);
+    private get Options();
+    /**
+     * Sanitize error response for client
+     * Removes sensitive information like stack traces, file paths, etc.
+     */
+    sanitizeErrorResponse(error: Record<string, any>, isDevelopment?: boolean): Record<string, any>;
+    /**
+     * Sanitize an error message to remove sensitive information.
+     * Redacts file paths, database connection strings, API keys, Bearer tokens,
+     * email addresses, and IP addresses. Truncates overly long messages to prevent
+     * ReDoS attacks and ensure reasonable log sizes.
+     *
+     * @param message - The error message string to sanitize
+     * @returns Sanitized message with sensitive patterns replaced by placeholder strings
+     *
+     * @example
+     * ```typescript
+     * const msg = 'Error at /home/user/app.ts, Bearer sk_live_abc123';
+     * const sanitized = sanitizeMessage(msg);
+     * // Returns: 'Error at [FILE], Bearer [REDACTED]'
+     * ```
+     */
+    private sanitizeMessage;
+    /**
+     * Recursively sanitize an error context object to remove sensitive field values.
+     * Identifies sensitive fields by name (e.g., password, token, secret) and replaces
+     * their values with a redaction marker. Handles nested objects and arrays while
+     * detecting circular references to prevent infinite loops.
+     *
+     * @param context - The context object to sanitize
+     * @returns Sanitized context with sensitive field values replaced
+     *
+     * @example
+     * ```typescript
+     * const ctx = { user: 'john', password: 'secret123', nested: { apiKey: 'sk_live' } };
+     * const sanitized = sanitizeContext(ctx);
+     * // Returns: { user: 'john', password: '***REDACTED***', nested: { apiKey: '***REDACTED***' } }
+     * ```
+     */
+    private sanitizeContext;
+    /**
+     * Recursively serialize an object with depth limiting and circular reference detection.
+     * Handles nested objects and arrays while preventing infinite loops.
+     *
+     * @param obj - The object to serialize
+     * @param maxDepth - Maximum nesting depth (default 5)
+     * @param currentDepth - Current recursion depth
+     * @param seen - Set of already-visited objects to detect cycles
+     * @returns Serialized object with sensitive fields redacted
+     */
+    private serializeWithDepthLimit;
+    /**
+     * Check if field is sensitive (case-insensitive comparison)
+     */
+    private isSensitiveField;
+}
+//# sourceMappingURL=error-sanitizer.service.d.ts.map

package/build/common/services/error-sanitizer.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-sanitizer.service.d.ts","sourceRoot":"","sources":["../../../src/common/services/error-sanitizer.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,4BAA4B,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,qBACa,qBAAsB,YAAW,oBAAoB;IACjE;;;;OAIG;IAEH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAQ;IAElD;;;OAGG;IAEH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAK;IAE9C;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAqE;IAE5G;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAkC;IAEpE;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAqgB;IAEviB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CA+B5C;IAEF,SAAgB,MAAM,EAAE,SAAS,CAAC;gBAEtB,MAAM,EAAE,SAAS;IAI7B,OAAO,KAAK,OAAO,GAMlB;IAED;;;OAGG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,aAAa,GAAE,OAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAoB7G;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,eAAe;IAkDvB;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,eAAe;IAWvB;;;;;;;;;OASG;IACH,OAAO,CAAC,uBAAuB;IA6D/B;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAWxB"}