@gravito/core 1.6.1 → 2.0.1

package/dist/events/EventPriorityQueue.d.ts

@@ -0,0 +1,63 @@
+import type { Span } from '@opentelemetry/api';
+import type { ActionCallback } from '../HookManager';
+import type { BackpressureManager } from './BackpressureManager';
+import type { DeadLetterQueue } from './DeadLetterQueue';
+import type { EventBackend } from './EventBackend';
+import type { EventOptions } from './EventOptions';
+import type { EventMetrics } from './observability/EventMetrics';
+import type { EventTracing } from './observability/EventTracing';
+import type { OTelEventMetrics } from './observability/OTelEventMetrics';
+import type { PriorityStatistics } from './PriorityEscalationManager';
+import type { RetryScheduler } from './RetryScheduler';
+import type { BackpressureStrategy, EventQueueConfig, EventTask, MultiPriorityQueueDepth } from './types';
+import type { WorkerPool } from './WorkerPool';
+export type { EventTask, EventQueueConfig, BackpressureStrategy };
+/**
+ * Priority queue for event processing.
+ * Events are processed based on their priority level:
+ * - Critical priority events are processed first (< 1ms)
+ * - High priority events are processed second (< 50ms)
+ * - Normal priority events are processed third (< 200ms)
+ * - Low priority events are processed last (< 500ms)
+ *
+ * Supports automatic priority escalation based on wait time.
+ *
+ * Composed of:
+ * - {@link QueueCore}: queue data structures and backpressure logic
+ * - {@link TaskExecutor}: task execution, retry, circuit breaker, DLQ
+ *
+ * @internal
+ */
+export declare class EventPriorityQueue implements EventBackend {
+    private queueCore;
+    private taskExecutor;
+    private processing;
+    private workerPool?;
+    constructor(config?: EventQueueConfig);
+    setDeadLetterQueue(dlq: DeadLetterQueue): void;
+    setPersistentDLQHandler(handler: (hook: string, args: unknown, options: EventOptions, error: Error, retryCount: number, firstFailedAt: number) => Promise<void>): void;
+    setEventMetrics(metrics: EventMetrics): void;
+    setOTelEventMetrics(metrics: OTelEventMetrics): void;
+    setPriorityStatistics(stats: PriorityStatistics): void;
+    getPriorityStatistics(): PriorityStatistics | undefined;
+    setEventTracing(tracing: EventTracing): void;
+    setCurrentDispatchSpan(span: Span | undefined): void;
+    getCurrentDispatchSpan(): Span | undefined;
+    setRetryScheduler(scheduler: RetryScheduler): void;
+    getRetryScheduler(): RetryScheduler | undefined;
+    getCircuitBreaker(hook: string): import("./CircuitBreaker").CircuitBreaker;
+    getCircuitBreakers(): Map<string, import("./CircuitBreaker").CircuitBreaker>;
+    resetCircuitBreaker(hook: string): boolean;
+    setWorkerPool(pool: WorkerPool): void;
+    getWorkerPool(): WorkerPool | undefined;
+    getBackpressureManager(): BackpressureManager | undefined;
+    enqueue(task: EventTask): string;
+    enqueue(hook: string, args: unknown, callbacks: ActionCallback[], options: EventOptions): string;
+    enqueueBatch(tasks: EventTask[]): string[];
+    getDepth(): number;
+    getDepthByPriority(priority: 'critical' | 'high' | 'normal' | 'low'): number;
+    getQueueDepthByPriority(): MultiPriorityQueueDepth;
+    clear(): void;
+    dequeue(): EventTask | undefined;
+    private processNext;
+}

package/dist/events/FlowControlStrategy.d.ts

@@ -0,0 +1,109 @@
+/**
+ * @gravito/core - Flow Control Strategies
+ *
+ * Implements various flow control strategies for backpressure management.
+ * Strategies can be composed to create flexible backpressure policies.
+ *
+ * 流控策略：支援多種組合策略進行靈活的背壓管理。
+ */
+import { type BackpressureConfig, type BackpressureDecision, BackpressureState } from './BackpressureManager';
+/**
+ * 流控評估上下文。
+ *
+ * @public
+ */
+export interface FlowControlContext {
+    /** 當前背壓狀態 */
+    state: BackpressureState;
+    /** 事件優先級 */
+    priority: 'high' | 'normal' | 'low';
+    /** 總隊列深度 */
+    totalDepth: number;
+    /** 分優先級隊列深度 */
+    depthByPriority: {
+        high: number;
+        normal: number;
+        low: number;
+    };
+    /** 當前入隊速率（events/sec） */
+    currentRate: number;
+    /** 配置 */
+    config: Omit<BackpressureConfig, 'onRejected' | 'onStateChange'>;
+}
+/**
+ * 流控策略介面。
+ *
+ * @public
+ */
+export interface FlowControlStrategy {
+    /** 策略名稱 */
+    readonly name: string;
+    /** 評估是否應該限制此事件 */
+    evaluate(context: FlowControlContext): BackpressureDecision;
+}
+/**
+ * 隊列深度策略。
+ *
+ * 根據總隊列深度和分優先級隊列深度決定是否限制事件入隊。
+ */
+export declare class QueueDepthStrategy implements FlowControlStrategy {
+    readonly name = "queue-depth";
+    evaluate(context: FlowControlContext): BackpressureDecision;
+}
+/**
+ * 速率限制策略。
+ *
+ * 根據每秒入隊速率限制事件入隊。
+ */
+export declare class RateLimitStrategy implements FlowControlStrategy {
+    readonly name = "rate-limit";
+    evaluate(context: FlowControlContext): BackpressureDecision;
+}
+/**
+ * 優先級平衡策略。
+ *
+ * 在 WARNING 和 CRITICAL 狀態下降級低優先級事件，防止高優先級飢餓。
+ */
+export declare class PriorityRebalanceStrategy implements FlowControlStrategy {
+    readonly name = "priority-rebalance";
+    evaluate(context: FlowControlContext): BackpressureDecision;
+}
+/**
+ * 反飢餓保護策略。
+ *
+ * 防止低優先級事件被長期壓制。
+ * 當事件等待超過 starvationTimeoutMs 時，自動提升其優先級。
+ */
+export declare class StarvationProtectionStrategy implements FlowControlStrategy {
+    readonly name = "starvation-protection";
+    evaluate(_context: FlowControlContext): BackpressureDecision;
+}
+/**
+ * 組合策略。
+ *
+ * 組合多個策略。評估時所有子策略必須允許，否則拒絕。
+ * 取最嚴格的決策（拒絕 > 延遲 > 允許）。
+ */
+export declare class CompositeStrategy implements FlowControlStrategy {
+    readonly name: string;
+    private strategies;
+    constructor(name: string, strategies: FlowControlStrategy[]);
+    evaluate(context: FlowControlContext): BackpressureDecision;
+    /**
+     * 新增子策略。
+     */
+    addStrategy(strategy: FlowControlStrategy): void;
+    /**
+     * 移除指定名稱的子策略。
+     */
+    removeStrategy(name: string): boolean;
+}
+/**
+ * 工廠方法：建立預設流控策略組合。
+ *
+ * @param config 背壓配置
+ * @returns 組合策略實例
+ *
+ * @public
+ */
+export declare function createDefaultStrategies(_config: Omit<BackpressureConfig, 'onRejected' | 'onStateChange'>): FlowControlStrategy[];

package/dist/events/IdempotencyCache.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Idempotency cache for deduplicating events.
+ * Prevents duplicate events from being processed within a configurable TTL window.
+ * @internal
+ */
+export declare class IdempotencyCache {
+    private cache;
+    private cleanupInterval;
+    private readonly defaultCleanupIntervalMs;
+    constructor();
+    /**
+     * Check if an event with the given idempotency key is a duplicate.
+     * @param key - Idempotency key
+     * @param ttlMs - Time-to-live in milliseconds
+     * @returns True if this is a duplicate, false if it's a new event
+     */
+    isDuplicate(key: string, ttlMs: number): boolean;
+    /**
+     * Record an event in the cache.
+     * @param key - Idempotency key
+     */
+    recordEvent(key: string): void;
+    /**
+     * Remove an entry from the cache.
+     * @param key - Idempotency key
+     * @returns True if entry was removed, false if not found
+     */
+    remove(key: string): boolean;
+    /**
+     * Clear all entries from the cache.
+     */
+    clear(): void;
+    /**
+     * Get the current cache size.
+     * @returns Number of entries in cache
+     */
+    getSize(): number;
+    /**
+     * Start periodic cleanup of expired entries.
+     * @internal
+     */
+    private startCleanup;
+    /**
+     * Stop the periodic cleanup.
+     * @internal
+     */
+    stopCleanup(): void;
+    /**
+     * Clean up expired entries from the cache.
+     * This is called periodically and doesn't use strict TTL checking,
+     * so entries older than a reasonable default (24 hours) are removed.
+     * @internal
+     */
+    private cleanup;
+    /**
+     * Destructor to clean up resources.
+     * @internal
+     */
+    destroy(): void;
+}

package/dist/events/MessageQueueBridge.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @gravito/core - Message Queue Bridge
+ *
+ * 橋接層，連接 HookManager 與 Bull Queue (via StreamEventBackend)
+ * 支持分佈式事件流：HookManager → Bull Queue → Worker → 完成/DLQ
+ */
+import type { HookManager } from '../HookManager';
+import type { DeadLetterQueueManager } from '../reliability/DeadLetterQueueManager';
+import type { EventBackend } from './EventBackend';
+import type { EventTask } from './types';
+import type { WorkerPool } from './WorkerPool';
+/**
+ * 事件執行狀態
+ */
+export interface EventStatus {
+    eventId: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed' | 'in_dlq';
+    attempts: number;
+    lastError?: string;
+    createdAt: number;
+    processedAt?: number;
+}
+/**
+ * MessageQueueBridge 配置
+ */
+export interface MessageQueueBridgeConfig {
+    /**
+     * HookManager 實例
+     */
+    hookManager: HookManager;
+    /**
+     * Worker 線程池（可選）
+     */
+    workerPool?: WorkerPool;
+    /**
+     * 分佈式事件後端（Bull Queue）
+     */
+    eventBackend: EventBackend;
+    /**
+     * Dead Letter Queue 管理器
+     */
+    dlqManager: DeadLetterQueueManager;
+    /**
+     * 是否啟用 CircuitBreaker 檢查
+     * @default false
+     */
+    enableCircuitBreaker?: boolean;
+}
+/**
+ * MessageQueueBridge - 連接 HookManager 與 Bull Queue 的橋接層
+ *
+ * 功能：
+ * 1. 通過 Bull Queue 分發事件（dispatchWithQueue）
+ * 2. Worker 中處理隊列事件（processQueuedEvent）
+ * 3. 失敗任務轉移至 DLQ（handleJobFailure）
+ * 4. 查詢事件執行狀態（getEventStatus）
+ *
+ * @example
+ * ```typescript
+ * const bridge = new MessageQueueBridge({
+ *   hookManager,
+ *   eventBackend: streamEventBackend,
+ *   dlqManager,
+ *   enableCircuitBreaker: true
+ * })
+ *
+ * // 分發事件至 Bull Queue
+ * const jobId = await bridge.dispatchWithQueue('order:created', { orderId: 123 })
+ *
+ * // Worker 處理事件
+ * await bridge.processQueuedEvent(jobId, task)
+ * ```
+ */
+export declare class MessageQueueBridge {
+    private config;
+    constructor(config: MessageQueueBridgeConfig);
+    /**
+     * 通過 Bull Queue 分發事件（分佈式異步處理）
+     *
+     * 流程：
+     * 1. 驗證事件 listeners 存在
+     * 2. 檢查 CircuitBreaker 狀態（如果啟用）
+     * 3. 構建 EventTask
+     * 4. 入隊到 eventBackend (Bull Queue)
+     *
+     * @param eventName - 事件名稱
+     * @param args - 事件參數
+     * @param options - 事件選項（可選）
+     * @returns Job ID
+     * @throws 如果沒有 listeners 或 CircuitBreaker 打開
+     *
+     * @example
+     * ```typescript
+     * const jobId = await bridge.dispatchWithQueue('order:created', {
+     *   orderId: 'ORD-123',
+     *   amount: 999.99
+     * })
+     * ```
+     */
+    dispatchWithQueue<TArgs = unknown>(eventName: string, args: TArgs, options?: any): Promise<string>;
+    /**
+     * 處理隊列事件（由 Bull Queue Worker 調用）
+     *
+     * 重要：使用 doActionSync() 避免遞迴
+     * - 不能使用 doActionAsync()（會導致事件再次入隊）
+     * - Worker 中直接同步執行 callbacks
+     *
+     * 流程：
+     * 1. 直接執行 callbacks（不使用 doActionSync，避免吞掉錯誤）
+     * 2. 記錄成功或失敗
+     * 3. 拋出錯誤讓 Bull Queue 處理重試
+     *
+     * @param jobId - Bull Queue Job ID
+     * @param task - 事件任務
+     * @throws 如果 callback 執行失敗，讓 Bull Queue 處理重試
+     *
+     * @example
+     * ```typescript
+     * // 在 Bull Queue Worker 中：
+     * await bridge.processQueuedEvent(jobId, task)
+     * ```
+     */
+    processQueuedEvent(jobId: string, task: EventTask): Promise<void>;
+    /**
+     * 處理 Bull Queue 任務失敗（由 onFailed callback 調用）
+     *
+     * 流程：
+     * 1. 記錄警告日誌
+     * 2. 移至 persistent DLQ（DeadLetterQueueManager）
+     * 3. 持久化到 event_dlq 表，支持延遲重試
+     *
+     * @param jobId - Bull Queue Job ID
+     * @param task - 事件任務
+     * @param error - 導致失敗的錯誤
+     * @param retryCount - 已重試次數（可選）
+     *
+     * @example
+     * ```typescript
+     * // 在 Bull Queue onFailed callback 中：
+     * await bridge.handleJobFailure(jobId, task, error, 3)
+     * ```
+     */
+    handleJobFailure(jobId: string, task: EventTask, error: Error, retryCount?: number): Promise<void>;
+    /**
+     * 查詢事件執行狀態
+     *
+     * 支持查詢：
+     * 1. 待處理事件
+     * 2. 正在處理的事件
+     * 3. 已完成事件
+     * 4. 失敗事件（在 DLQ 中）
+     *
+     * @param eventId - 事件 ID（task.id 或 jobId）
+     * @returns 事件狀態
+     *
+     * @example
+     * ```typescript
+     * const status = await bridge.getEventStatus('queue-1707000000000-abc123')
+     * console.log(status) // { eventId, status, attempts, ... }
+     * ```
+     */
+    getEventStatus(eventId: string): Promise<EventStatus>;
+    /**
+     * 獲取 EventBackend 實例（用於高級操作）
+     *
+     * @returns EventBackend 實例
+     * @internal
+     */
+    getEventBackend(): EventBackend;
+    /**
+     * 獲取 DLQ 管理器實例（用於高級操作）
+     *
+     * @returns DeadLetterQueueManager 實例
+     * @internal
+     */
+    getDLQManager(): DeadLetterQueueManager;
+    /**
+     * 獲取 HookManager 實例（用於高級操作）
+     *
+     * @returns HookManager 實例
+     * @internal
+     */
+    getHookManager(): HookManager;
+}

package/dist/events/PriorityEscalationManager.d.ts

@@ -0,0 +1,82 @@
+import type { EventOptions } from './EventOptions';
+import type { EventTask } from './types';
+/**
+ * 優先級升級管理器
+ *
+ * 根據事件等待時間動態調整優先級，實施優先級提升機制。
+ * 確保關鍵事件不會因為隊列深度而長時間等待。
+ *
+ * 升級規則（可配置）：
+ * - LOW 等待 > 200ms → NORMAL
+ * - NORMAL 等待 > 100ms → HIGH
+ * - HIGH 等待 > 50ms → CRITICAL
+ * - 超過 maxWaitTimeMs → 強制 CRITICAL
+ *
+ * @internal
+ */
+export declare class PriorityEscalationManager {
+    /**
+     * 計算事件當前應該的優先級
+     * 根據等待時間動態調整
+     */
+    static calculateCurrentPriority(task: EventTask, config?: EventOptions['escalation']): 'critical' | 'high' | 'normal' | 'low';
+    /**
+     * 比較兩個事件的優先級
+     * @returns 負數表示 task1 優先級更高，正數表示 task2 優先級更高
+     */
+    static comparePriority(task1: EventTask, task2: EventTask): number;
+    /**
+     * 判斷事件是否應該立即處理（跳過隊列）
+     */
+    static shouldProcessImmediately(task: EventTask, config?: EventOptions['escalation']): boolean;
+    /**
+     * 獲取事件當前的超期時間（毫秒）
+     * 正數表示已超期，0 表示未超期
+     */
+    static calculateOverdueTime(task: EventTask, config?: EventOptions['escalation']): number;
+}
+/**
+ * 優先級統計器
+ * 追蹤優先級分布和升級事件
+ *
+ * @internal
+ */
+export declare class PriorityStatistics {
+    private eventCounts;
+    private escalationCounts;
+    private totalEscalations;
+    /**
+     * 記錄一個優先級的事件
+     */
+    recordEvent(priority: 'critical' | 'high' | 'normal' | 'low'): void;
+    /**
+     * 記錄優先級升級
+     */
+    recordEscalation(fromPriority: 'critical' | 'high' | 'normal' | 'low', toPriority: 'critical' | 'high' | 'normal' | 'low'): void;
+    /**
+     * 獲取優先級分布
+     */
+    getDistribution(): Record<'critical' | 'high' | 'normal' | 'low', string>;
+    /**
+     * 獲取升級統計
+     */
+    getEscalationStats(): {
+        total: number;
+        byTransition: Record<string, number>;
+    };
+    /**
+     * 重置統計信息
+     */
+    reset(): void;
+    /**
+     * 獲取所有統計信息
+     */
+    getStats(): {
+        eventCounts: Record<'critical' | 'high' | 'normal' | 'low', number>;
+        escalationStats: {
+            total: number;
+            byTransition: Record<string, number>;
+        };
+        distribution: Record<'critical' | 'high' | 'normal' | 'low', string>;
+    };
+}

package/dist/events/RetryScheduler.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @gravito/core - Retry Scheduler
+ *
+ * 分佈式重試排程器，使用 Bull Queue 進行異步延遲重試。
+ * 支援指數回退、Redis 持久化、重試失敗回呼。
+ *
+ * Distributed retry scheduler using Bull Queue for async delayed retries.
+ * Supports exponential backoff, Redis persistence, and failure callbacks.
+ */
+import type { EventOptions } from './EventOptions';
+/**
+ * 重試排程器配置介面
+ */
+export interface RetrySchedulerConfig {
+    /** 是否啟用 Bull Queue 重試（預設 true） */
+    enabled?: boolean;
+    /** Redis 連接配置（可選，使用全域 Redis） */
+    redisUrl?: string;
+    /** 預設最大重試次數（預設 5） */
+    maxRetries?: number;
+    /** 初始延遲時間（ms，預設 1000） */
+    initialDelayMs?: number;
+    /** 指數回退倍數（預設 2.0） */
+    backoffMultiplier?: number;
+    /** 最大延遲時間（ms，預設 1h） */
+    maxDelayMs?: number;
+    /** 重試失敗回呼 */
+    onRetryFailed?: (eventName: string, error: Error, retryCount: number) => void;
+}
+/**
+ * 隊列統計資訊
+ */
+export interface QueueStats {
+    name: string;
+    jobCounts: {
+        waiting: number;
+        active: number;
+        delayed: number;
+        failed: number;
+    };
+    completedCount: number;
+    failedCount: number;
+}
+/**
+ * 重試排程器
+ *
+ * 提供異步分佈式重試機制，利用 Bull Queue 進行延遲重試。
+ * 支援指數回退、Redis 持久化、隊列統計。
+ */
+export declare class RetryScheduler {
+    private enabled;
+    private config;
+    private queues;
+    private bullmqModule;
+    private bullmqLoadError;
+    constructor(config?: RetrySchedulerConfig);
+    /**
+     * 動態加載 bullmq 模組
+     */
+    private loadBullmq;
+    /**
+     * 檢查排程器是否啟用
+     */
+    isEnabled(): boolean;
+    /**
+     * 計算指數回退延遲時間
+     *
+     * @param retryCount 當前重試次數（從 0 開始）
+     * @returns 延遲時間（毫秒）
+     */
+    private calculateDelay;
+    /**
+     * 獲取或創建隊列
+     *
+     * @param eventName 事件名稱
+     * @returns Queue 實例
+     */
+    private getOrCreateQueue;
+    /**
+     * 排程重試任務
+     *
+     * @param eventName 事件名稱
+     * @param payload 事件負載
+     * @param options 事件選項
+     * @param error 原始錯誤
+     * @param retryCount 當前重試次數
+     */
+    scheduleRetry(eventName: string, payload: unknown, _options: EventOptions, error: Error, retryCount: number): Promise<void>;
+    /**
+     * 獲取特定事件的隊列
+     *
+     * @param eventName 事件名稱
+     * @returns Queue 實例或 undefined
+     */
+    getQueue(eventName: string): unknown;
+    /**
+     * 取得所有隊列統計
+     */
+    getStats(): Map<string, QueueStats>;
+    /**
+     * 關閉所有隊列並清理資源
+     */
+    shutdown(): Promise<void>;
+}

package/dist/events/WorkerPool.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Worker Pool for concurrent event task processing.
+ *
+ * Manages a pool of workers for executing event tasks concurrently.
+ * Supports auto-scaling, health checks, and OpenTelemetry metrics integration.
+ *
+ * @internal
+ */
+import type { Meter } from '@opentelemetry/api';
+import type { EventTask } from './types';
+import type { WorkerPoolConfig, WorkerPoolStats, WorkerStats } from './WorkerPoolConfig';
+/**
+ * Worker Pool for managing concurrent task execution
+ */
+export declare class WorkerPool {
+    private workers;
+    private taskQueue;
+    private config;
+    private metrics?;
+    private healthCheckTimer?;
+    private metricsTimer?;
+    private isRunning;
+    private scaleDownCounter;
+    constructor(config?: WorkerPoolConfig, meter?: Meter);
+    /**
+     * Start the worker pool
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the worker pool
+     */
+    stop(): Promise<void>;
+    /**
+     * Submit a task to the worker pool
+     */
+    submitTask(task: EventTask): Promise<void>;
+    /**
+     * Process next task in queue
+     */
+    private processQueue;
+    /**
+     * Execute task on a worker
+     */
+    private executeTask;
+    /**
+     * Execute task callbacks
+     */
+    private executeTaskCallbacks;
+    /**
+     * Create a timeout promise
+     */
+    private createTimeout;
+    /**
+     * Create a new worker
+     */
+    private createWorker;
+    /**
+     * Remove a worker
+     */
+    private removeWorker;
+    /**
+     * Perform health check and cleanup
+     */
+    private performHealthCheck;
+    /**
+     * Perform auto-scaling based on load
+     */
+    private performAutoScaling;
+    /**
+     * Collect metrics
+     */
+    private collectMetrics;
+    /**
+     * Get number of active workers (not terminated)
+     */
+    private getActiveWorkerCount;
+    /**
+     * Get worker utilization (0-1)
+     */
+    private getUtilization;
+    /**
+     * Get queue depth
+     */
+    getQueueDepth(): number;
+    /**
+     * Get worker utilization
+     */
+    getWorkerUtilization(): number;
+    /**
+     * Get worker statistics
+     */
+    getWorkerStats(): WorkerStats[];
+    /**
+     * Get pool statistics
+     */
+    getPoolStats(): WorkerPoolStats;
+}
+export type { WorkerPoolConfig, WorkerStats, WorkerPoolStats };