@gravito/core 1.6.0 → 2.0.0

package/dist/error-handling/RequestScopeErrorContext.d.ts

@@ -0,0 +1,126 @@
+/**
+ * RequestScope-Aware Error Handling
+ *
+ * Integrates RequestScope lifecycle with error handling to provide:
+ * - Error context with request-scoped resources
+ * - Automatic cleanup of scoped services on error
+ * - Request tracing and diagnostics
+ * - Resource leak detection
+ */
+import type { RequestScopeManager } from '../Container/RequestScopeManager';
+import type { RequestScopeMetrics } from '../Container/RequestScopeMetrics';
+import type { GravitoContext } from '../http/types';
+/**
+ * Extended error context with RequestScope information
+ *
+ * Provides error handlers access to request-scoped resources
+ * for proper resource cleanup and error diagnostics.
+ */
+export interface RequestScopeErrorContext {
+    /**
+     * The original error that was thrown
+     */
+    error: unknown;
+    /**
+     * HTTP context where error occurred
+     */
+    context: GravitoContext;
+    /**
+     * RequestScope manager for this request
+     * Allows error handlers to access or clean up scoped resources
+     */
+    scope?: RequestScopeManager;
+    /**
+     * Metrics about the request scope state
+     * Useful for diagnostics and understanding resource usage
+     */
+    scopeMetrics?: RequestScopeMetrics;
+    /**
+     * Number of scoped services at time of error
+     * High numbers might indicate resource leaks
+     */
+    scopeSize?: number;
+    /**
+     * Request processing time in milliseconds
+     * Useful for timeout errors
+     */
+    duration?: number;
+    /**
+     * Additional diagnostic information
+     */
+    diagnostics?: {
+        servicesCleanedUp?: string[];
+        cleanupErrors?: Array<{
+            service: string;
+            error: unknown;
+        }>;
+        peakMemoryMb?: number;
+    };
+}
+/**
+ * Error that occurred during RequestScope cleanup
+ *
+ * Wraps original error with cleanup context for proper error reporting
+ */
+export declare class RequestScopeCleanupError extends Error {
+    originalError: unknown;
+    cleanupErrors: Array<{
+        service: string;
+        error: unknown;
+    }>;
+    constructor(message: string, originalError: unknown, cleanupErrors: Array<{
+        service: string;
+        error: unknown;
+    }>);
+}
+/**
+ * Helper to extract RequestScope context from GravitoContext
+ *
+ * @param ctx - Gravito context
+ * @returns RequestScope error context with available information
+ */
+export declare function extractRequestScopeErrorContext(ctx: GravitoContext, error: unknown): RequestScopeErrorContext;
+/**
+ * Cleanup scoped services safely during error handling
+ *
+ * Ensures all scoped services are cleaned up even if some fail,
+ * and collects cleanup errors for diagnostics.
+ *
+ * @param scope - RequestScope manager
+ * @returns Array of cleanup errors if any occurred
+ */
+export declare function cleanupRequestScopeOnError(scope?: RequestScopeManager): Promise<Array<{
+    service: string;
+    error: unknown;
+}>>;
+/**
+ * Safe error handler wrapper that manages RequestScope cleanup
+ *
+ * Ensures scoped services are properly cleaned up before returning error response.
+ * Use this to wrap error handlers to make them RequestScope-aware.
+ *
+ * @example
+ * ```typescript
+ * const errorHandler = withRequestScopeCleanup(async (ctx, error) => {
+ *   // Handle error...
+ *   return ctx.json({ error: error.message }, 500)
+ * })
+ *
+ * // In your app:
+ * try {
+ *   // Handle request...
+ * } catch (error) {
+ *   return errorHandler(ctx, error)
+ * }
+ * ```
+ */
+export declare function withRequestScopeCleanup<T extends (ctx: GravitoContext, error: unknown) => Promise<Response>>(handler: T): T;
+/**
+ * Detect potential resource leaks in RequestScope
+ *
+ * Returns diagnostic information about suspicious resource usage patterns
+ */
+export declare function detectRequestScopeLeaks(context: RequestScopeErrorContext): {
+    potentialLeaks: boolean;
+    warnings: string[];
+};

package/dist/events/BackpressureManager.d.ts

@@ -0,0 +1,215 @@
+/**
+ * @gravito/core - Event System Backpressure Management
+ *
+ * Implements a backpressure management system to prevent high-priority events
+ * from starving low-priority events when the queue is under resource constraints.
+ *
+ * 背壓管理器：在資源受限時進行智慧型流量控制，防止優先級飢餓。
+ *
+ * FS-103 增強：
+ * - 多優先級隊列深度監控
+ * - 背壓反饋迴路支持
+ * - 智能 DLQ 路由決策
+ */
+import type { DeadLetterDecision, MultiPriorityQueueDepth } from './types';
+/**
+ * 背壓狀態枚舉。
+ *
+ * 狀態轉換：Normal → Warning → Critical → Overflow
+ * 恢復方向：遲滯設計（需降至觸發閾值的 80%）
+ *
+ * @public
+ */
+export declare enum BackpressureState {
+    /** 正常運作，無背壓 */
+    NORMAL = "NORMAL",
+    /** 警告狀態，開始限制低優先級事件 */
+    WARNING = "WARNING",
+    /** 危急狀態，僅允許高優先級事件 */
+    CRITICAL = "CRITICAL",
+    /** 溢位狀態，全部拒絕 */
+    OVERFLOW = "OVERFLOW"
+}
+/**
+ * 背壓配置選項。
+ *
+ * @public
+ */
+export interface BackpressureConfig {
+    /** 是否啟用背壓管理器（預設 true） */
+    enabled?: boolean;
+    /** 總隊列深度限制（預設無限） */
+    maxQueueSize?: number;
+    /** 分優先級隊列深度限制 */
+    maxSizeByPriority?: {
+        critical?: number;
+        high?: number;
+        normal?: number;
+        low?: number;
+    };
+    /** 每秒最大入隊速率（events/sec，預設無限） */
+    maxEnqueueRate?: number;
+    /** 速率限制滑動視窗大小（ms，預設 1000） */
+    rateLimitWindowMs?: number;
+    /** 背壓狀態閾值（佔 maxQueueSize 的百分比） */
+    thresholds?: {
+        /** WARNING 觸發百分比（預設 0.6 = 60%） */
+        warning?: number;
+        /** CRITICAL 觸發百分比（預設 0.85 = 85%） */
+        critical?: number;
+        /** OVERFLOW 觸發百分比（預設 1.0 = 100%） */
+        overflow?: number;
+    };
+    /** 被拒絕事件的處理策略（預設 'drop-with-callback'） */
+    rejectionPolicy?: 'throw' | 'drop-silent' | 'drop-with-callback';
+    /** 當 rejectionPolicy 為 'drop-with-callback' 時的回呼 */
+    onRejected?: (eventName: string, priority: string, reason: string) => void;
+    /** 背壓狀態變更回呼 */
+    onStateChange?: (from: BackpressureState, to: BackpressureState) => void;
+    /** 低優先級事件在 WARNING 狀態下的延遲入隊時間（ms，預設 100） */
+    lowPriorityDelayMs?: number;
+    /** 是否啟用優先級反轉防護（預設 true） */
+    enableStarvationProtection?: boolean;
+    /** 低優先級事件最大等待時間，超過則提升優先級（ms，預設 5000） */
+    starvationTimeoutMs?: number;
+    /** 當進入 OVERFLOW 狀態時，是否將被拒絕事件路由到 DLQ（預設 false） */
+    dlqOnOverflow?: boolean;
+    /** OVERFLOW 時的重試策略（預設 'dlq-only'） */
+    overflowRetryStrategy?: 'immediate' | 'delayed' | 'dlq-only';
+    /** OVERFLOW 延遲重試的基礎延遲時間（ms，預設 5000） */
+    overflowRetryDelayMs?: number;
+}
+/**
+ * 背壓決策結果。
+ *
+ * @public
+ */
+export interface BackpressureDecision {
+    /** 是否允許入隊 */
+    allowed: boolean;
+    /** 拒絕原因（若不允許） */
+    reason?: string;
+    /** 是否需要延遲入隊 */
+    delayed?: boolean;
+    /** 延遲時間（ms） */
+    delayMs?: number;
+    /** 建議降級後的優先級（若降級） */
+    degradedPriority?: 'high' | 'normal' | 'low';
+    /** 是否是由於 OVERFLOW 狀態被拒絕 */
+    isOverflow?: boolean;
+    /** OVERFLOW 時的重試策略建議（'immediate'、'delayed'、'dlq-only'） */
+    retryStrategy?: 'immediate' | 'delayed' | 'dlq-only';
+}
+/**
+ * 背壓指標快照。
+ *
+ * @public
+ */
+export interface BackpressureMetricsSnapshot {
+    state: BackpressureState;
+    totalDepth: number;
+    depthByPriority: {
+        critical: number;
+        high: number;
+        normal: number;
+        low: number;
+    };
+    enqueueRate: number;
+    rejectedCount: number;
+    degradedCount: number;
+    stateTransitions: number;
+    dlqRouteCount?: number;
+    windowAdjustmentCount?: number;
+}
+/**
+ * 背壓管理器。
+ *
+ * 根據隊列深度、速率、優先級等因素，決定是否允許新事件入隊，
+ * 以及是否需要降級優先級或延遲入隊。
+ *
+ * @public
+ */
+export declare class BackpressureManager {
+    private enabled;
+    private config;
+    private onRejected?;
+    private onStateChange?;
+    private state;
+    private rejectedCount;
+    private degradedCount;
+    private stateTransitions;
+    private rateCounter;
+    private depthByPriority;
+    private windowAdjustmentHistory;
+    private dlqRouteCount;
+    constructor(config?: BackpressureConfig);
+    /**
+     * 評估是否允許新事件入隊。
+     *
+     * @param eventName 事件名稱
+     * @param priority 事件優先級
+     * @param queueDepth 當前隊列深度
+     * @param depthByPriority 分優先級隊列深度
+     * @returns 背壓決策結果
+     */
+    evaluate(eventName: string, priority: 'critical' | 'high' | 'normal' | 'low', queueDepth: number, depthByPriority: {
+        critical: number;
+        high: number;
+        normal: number;
+        low: number;
+    }): BackpressureDecision;
+    /**
+     * 獲取當前背壓狀態。
+     */
+    getState(): BackpressureState;
+    /**
+     * 獲取背壓指標快照。
+     */
+    getMetrics(): BackpressureMetricsSnapshot;
+    /**
+     * 重置背壓管理器狀態。
+     */
+    reset(): void;
+    /**
+     * 同步隊列深度（由 EventPriorityQueue 調用）。
+     * FS-103：多優先級隊列深度監控
+     */
+    updateQueueDepth(depths: MultiPriorityQueueDepth): void;
+    /**
+     * 獲取各優先級的隊列深度。
+     * FS-103：提供實時隊列深度快照
+     */
+    getQueueDepthByPriority(): MultiPriorityQueueDepth;
+    /**
+     * 獲取總隊列深度。
+     */
+    getTotalQueueDepth(): number;
+    /**
+     * 接收來自 AggregationWindow 的窗口調整通知。
+     * FS-103：背壓反饋迴路
+     */
+    notifyWindowAdjustment(oldWindowMs: number, newWindowMs: number): void;
+    /**
+     * 檢查是否可以從 CRITICAL 或更高級別降級。
+     * FS-103：自動狀態恢復機制
+     */
+    private checkStateRecovery;
+    /**
+     * 決定是否應該將事件路由到死信隊列。
+     * FS-103：智能 DLQ 路由決策
+     */
+    makeDeadLetterDecision(_eventName: string, priority: 'critical' | 'high' | 'normal' | 'low'): DeadLetterDecision;
+    /**
+     * 更新背壓狀態。
+     * 使用遲滯設計（80% 回復比例）避免邊界震盪。
+     */
+    private updateState;
+    /**
+     * 執行狀態轉換。
+     */
+    private transitionTo;
+    /**
+     * 建立決策結果並記錄拒絕。
+     */
+    private createDecision;
+}

package/dist/events/CircuitBreaker.d.ts

@@ -0,0 +1,229 @@
+/**
+ * Circuit Breaker state enum.
+ * @public
+ */
+export declare enum CircuitBreakerState {
+    CLOSED = "CLOSED",
+    OPEN = "OPEN",
+    HALF_OPEN = "HALF_OPEN"
+}
+/**
+ * Circuit Breaker metrics snapshot.
+ * @public
+ */
+export interface CircuitBreakerMetrics {
+    /**
+     * Current state of the circuit breaker
+     */
+    state: CircuitBreakerState;
+    /**
+     * Number of failures in the current window
+     */
+    failures: number;
+    /**
+     * Number of successes in the current window
+     */
+    successes: number;
+    /**
+     * Timestamp of the last failure
+     */
+    lastFailureAt?: Date;
+    /**
+     * Timestamp of the last success
+     */
+    lastSuccessAt?: Date;
+    /**
+     * Timestamp when the circuit was opened
+     */
+    openedAt?: Date;
+    /**
+     * Total requests processed
+     */
+    totalRequests: number;
+    /**
+     * Total failures recorded
+     */
+    totalFailures: number;
+    /**
+     * Total successes recorded
+     */
+    totalSuccesses: number;
+}
+/**
+ * Circuit Breaker metrics recorder interface.
+ * @public
+ */
+export interface CircuitBreakerMetricsRecorder {
+    /**
+     * Record current state of the circuit breaker.
+     * @param eventName - Name of the event
+     * @param state - State as number (0=CLOSED, 1=HALF_OPEN, 2=OPEN)
+     */
+    recordState: (eventName: string, state: number) => void;
+    /**
+     * Record state transition.
+     */
+    recordTransition: (eventName: string, fromState: string, toState: string) => void;
+    /**
+     * Record a failure.
+     */
+    recordFailure: (eventName: string) => void;
+    /**
+     * Record a success.
+     */
+    recordSuccess: (eventName: string) => void;
+    /**
+     * Record OPEN state duration.
+     */
+    recordOpenDuration: (eventName: string, seconds: number) => void;
+}
+/**
+ * Circuit Breaker configuration options.
+ * @public
+ */
+export interface CircuitBreakerOptions {
+    /**
+     * Number of consecutive failures before opening the circuit.
+     * @default 5
+     */
+    failureThreshold?: number;
+    /**
+     * Time in milliseconds to wait before attempting to close the circuit (move to HALF_OPEN).
+     * @default 30000
+     */
+    resetTimeout?: number;
+    /**
+     * Number of test requests to allow given the circuit is in HALF_OPEN state.
+     * If these succeed, the circuit closes. If any fail, it opens again.
+     * @default 3
+     */
+    halfOpenRequests?: number;
+    /**
+     * Number of successes required in HALF_OPEN state to close the circuit.
+     * @default 2
+     */
+    successThreshold?: number;
+    /**
+     * Time in milliseconds for the sliding window to track failures.
+     * Failures outside this window are not counted.
+     * @default 60000
+     */
+    windowSize?: number;
+    /**
+     * Enable or disable the circuit breaker.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Callback when circuit opens.
+     */
+    onOpen?: (name?: string) => void;
+    /**
+     * Callback when circuit moves to half-open.
+     */
+    onHalfOpen?: (name?: string) => void;
+    /**
+     * Callback when circuit closes.
+     */
+    onClose?: (name?: string) => void;
+    /**
+     * Metrics recorder for recording circuit breaker events.
+     * Optional - if not provided, metrics will not be recorded.
+     */
+    metricsRecorder?: CircuitBreakerMetricsRecorder | undefined;
+}
+/**
+ * Required Circuit Breaker configuration (with defaults applied).
+ * @internal
+ */
+export interface RequiredCircuitBreakerOptions extends Required<Omit<CircuitBreakerOptions, 'metricsRecorder'>> {
+    metricsRecorder?: CircuitBreakerMetricsRecorder;
+}
+/**
+ * Circuit Breaker implementation for fault tolerance.
+ *
+ * Prevents cascading failures by stopping execution of a failing operation
+ * for a specified period after a threshold of failures is reached.
+ *
+ * Supports sliding window algorithm, enabling/disabling, and detailed metrics.
+ *
+ * @public
+ */
+export declare class CircuitBreaker {
+    private state;
+    private failureCount;
+    private successCount;
+    private name;
+    private config;
+    private metricsRecorder?;
+    private lastFailureAt?;
+    private lastSuccessAt?;
+    private openedAt?;
+    private totalRequests;
+    private totalFailures;
+    private totalSuccesses;
+    private halfOpenAttempts;
+    /**
+     * Create a new Circuit Breaker.
+     *
+     * Supports two signatures for backward compatibility:
+     * - CircuitBreaker(options?: CircuitBreakerOptions) - anonymous breaker
+     * - CircuitBreaker(name: string, options?: CircuitBreakerOptions) - named breaker
+     *
+     * @param nameOrOptions - Circuit breaker name or options
+     * @param maybeOptions - Options (used when first param is a string)
+     */
+    constructor(nameOrOptions?: string | CircuitBreakerOptions, maybeOptions?: CircuitBreakerOptions);
+    /**
+     * Execute an operation through the circuit breaker.
+     *
+     * @param operation - Async operation to execute
+     * @returns Operation result
+     * @throws Error if circuit is open or operation fails
+     */
+    execute<T>(operation: () => Promise<T>): Promise<T>;
+    /**
+     * Check if the circuit breaker is currently OPEN.
+     */
+    isOpen(): boolean;
+    /**
+     * Check if the circuit breaker is currently HALF_OPEN.
+     */
+    isHalfOpen(): boolean;
+    /**
+     * Check if the circuit breaker is currently CLOSED.
+     */
+    isClosed(): boolean;
+    /**
+     * Get current state of the circuit breaker.
+     */
+    getState(): CircuitBreakerState;
+    /**
+     * Get failure count (deprecated, use getMetrics for complete information).
+     */
+    getFailureCount(): number;
+    /**
+     * Get the name of this circuit breaker.
+     */
+    getName(): string;
+    /**
+     * Get detailed metrics snapshot of the circuit breaker.
+     */
+    getMetrics(): CircuitBreakerMetrics;
+    /**
+     * Manually reset the circuit breaker to CLOSED state.
+     */
+    reset(): void;
+    /**
+     * Forcefully reset the circuit breaker (alias for reset).
+     */
+    manualReset(): void;
+    /**
+     * Check for automatic state transitions based on time and sliding window.
+     */
+    checkStateTransition(): void;
+    private onSuccess;
+    private onFailure;
+    private transitionTo;
+    private stateToNumber;
+}