@gravito/ripple 4.0.0 → 4.0.3

package/dist/core/src/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/core/src/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/core/src/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 };

package/dist/core/src/events/WorkerPoolConfig.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Worker Pool Configuration and Types
+ *
+ * Defines configuration interfaces and data types for worker pool management.
+ *
+ * @internal
+ */
+import type { EventTask } from './types';
+/**
+ * Task source interface for fetching and acknowledging tasks.
+ * Supports integration with external task systems like Bull Queue.
+ */
+export interface TaskSource {
+    /**
+     * Fetch the next task from the source.
+     * Returns null if no tasks available.
+     */
+    fetchTask(): Promise<EventTask | null>;
+    /**
+     * Acknowledge successful task completion.
+     */
+    acknowledgeCompletion(taskId: string): Promise<void>;
+    /**
+     * Acknowledge task failure.
+     */
+    acknowledgeFailure(taskId: string, error: Error): Promise<void>;
+}
+/**
+ * Worker Pool Configuration
+ */
+export interface WorkerPoolConfig {
+    /**
+     * Maximum number of concurrent tasks being processed.
+     * @default 4
+     */
+    concurrency?: number;
+    /**
+     * Number of worker threads to maintain.
+     * @default Number of CPU cores
+     */
+    workerThreads?: number;
+    /**
+     * Task execution timeout in milliseconds.
+     * @default 30000
+     */
+    taskTimeout?: number;
+    /**
+     * Maximum number of retries for failed tasks.
+     * @default 3
+     */
+    maxRetries?: number;
+    /**
+     * Enable automatic scaling based on load.
+     * @default true
+     */
+    enableAutoScaling?: boolean;
+    /**
+     * Minimum number of workers for auto-scaling.
+     * @default 1
+     */
+    minWorkers?: number;
+    /**
+     * Maximum number of workers for auto-scaling.
+     * @default 2 * CPU cores
+     */
+    maxWorkers?: number;
+    /**
+     * Worker utilization threshold for scaling up (0-1).
+     * @default 0.8
+     */
+    scaleUpThreshold?: number;
+    /**
+     * Worker utilization threshold for scaling down (0-1).
+     * @default 0.2
+     */
+    scaleDownThreshold?: number;
+    /**
+     * Interval for collecting metrics in milliseconds.
+     * @default 5000
+     */
+    metricsInterval?: number;
+    /**
+     * External task source (e.g., Bull Queue).
+     * When provided, workers fetch tasks from this source.
+     */
+    taskSource?: TaskSource;
+}
+/**
+ * Worker State
+ */
+export type WorkerState = 'idle' | 'busy' | 'terminated';
+/**
+ * Worker Statistics
+ */
+export interface WorkerStats {
+    /**
+     * Unique worker identifier.
+     */
+    id: string;
+    /**
+     * Current worker state.
+     */
+    state: WorkerState;
+    /**
+     * Total tasks processed by this worker.
+     */
+    tasksProcessed: number;
+    /**
+     * Total successful tasks.
+     */
+    tasksSuccess: number;
+    /**
+     * Total failed tasks.
+     */
+    tasksFailed: number;
+    /**
+     * Average task execution duration in milliseconds.
+     */
+    avgDurationMs: number;
+    /**
+     * Worker uptime in milliseconds.
+     */
+    uptime: number;
+}
+/**
+ * Worker Pool Statistics
+ */
+export interface WorkerPoolStats {
+    /**
+     * Total tasks in queue.
+     */
+    queueDepth: number;
+    /**
+     * Worker utilization (0-1).
+     */
+    utilization: number;
+    /**
+     * Current number of active workers.
+     */
+    activeWorkers: number;
+    /**
+     * Total tasks processed.
+     */
+    totalTasksProcessed: number;
+    /**
+     * Total successful tasks.
+     */
+    totalSuccess: number;
+    /**
+     * Total failed tasks.
+     */
+    totalFailures: number;
+}

package/dist/core/src/events/WorkerPoolMetrics.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Worker Pool Metrics for OpenTelemetry integration.
+ *
+ * Tracks worker pool statistics and emits metrics using OpenTelemetry.
+ * Follows the Provider Callback pattern for dynamic metric collection.
+ *
+ * @internal
+ */
+import type { Meter } from '@opentelemetry/api';
+/**
+ * Worker Pool Metrics Recorder
+ */
+export declare class WorkerPoolMetrics {
+    private meter;
+    private taskDurationHistogram?;
+    private taskCounter?;
+    private autoScalingCounter?;
+    private poolSizeCallback?;
+    private utilizationCallback?;
+    private queueDepthCallback?;
+    constructor(meter: Meter);
+    /**
+     * Initialize OpenTelemetry metrics
+     */
+    private initializeMetrics;
+    /**
+     * Set provider callback for pool size metric
+     */
+    setPoolSizeProvider(callback: () => number): void;
+    /**
+     * Set provider callback for utilization metric
+     */
+    setUtilizationProvider(callback: () => number): void;
+    /**
+     * Set provider callback for queue depth metric
+     */
+    setQueueDepthProvider(callback: () => number): void;
+    /**
+     * Record task execution
+     *
+     * @param durationMs - Task execution duration in milliseconds
+     * @param priority - Task priority level
+     * @param success - Whether task succeeded
+     */
+    recordTaskExecution(durationMs: number, priority: string, success: boolean): void;
+    /**
+     * Record auto-scaling event
+     *
+     * @param action - 'scale-up' or 'scale-down'
+     * @param reason - Reason for scaling
+     */
+    recordAutoScaling(action: 'scale-up' | 'scale-down', reason: string): void;
+    /**
+     * Get the current pool size (for provider callbacks)
+     */
+    getPoolSize(): number;
+    /**
+     * Get the current utilization (for provider callbacks)
+     */
+    getUtilization(): number;
+    /**
+     * Get the current queue depth (for provider callbacks)
+     */
+    getQueueDepth(): number;
+}

package/dist/core/src/events/aggregation/AggregationWindow.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Aggregation window with backpressure awareness (FS-102)
+ *
+ * Adjusts batching window based on backpressure state:
+ * - NORMAL: 200ms (optimal aggregation)
+ * - WARNING: 150ms (accelerate processing)
+ * - CRITICAL: 100ms (fast drain)
+ * - OVERFLOW: 50ms (minimum latency)
+ *
+ * FS-103 增強：
+ * - 與 BackpressureManager 雙向反饋
+ * - 窗口調整通知機制
+ */
+import type { BackpressureManager } from '../BackpressureManager';
+import { BackpressureState } from '../BackpressureManager';
+import type { WindowStats } from './types';
+/**
+ * Aggregation window manager with backpressure awareness.
+ */
+export declare class AggregationWindow {
+    private currentWindowMs;
+    private readonly minWindowMs;
+    private readonly maxWindowMs;
+    private stats;
+    private backpressureManager?;
+    /**
+     * Create an aggregation window.
+     *
+     * @param initialWindowMs - Initial window size (default 200ms)
+     */
+    constructor(initialWindowMs?: number);
+    /**
+     * Set the BackpressureManager for feedback loop (FS-103).
+     *
+     * @param manager - BackpressureManager instance
+     */
+    setBackpressureManager(manager: BackpressureManager): void;
+    /**
+     * Adjust window based on backpressure state.
+     *
+     * @param state - Current backpressure state
+     */
+    adjustWindow(state: BackpressureState): number;
+    /**
+     * Notify BackpressureManager of window adjustment (FS-103).
+     * Part of the backpressure feedback loop for automatic state recovery.
+     *
+     * @param oldWindowMs - Previous window size
+     * @param newWindowMs - New window size
+     * @private
+     */
+    private notifyBackpressureManager;
+    /**
+     * Get current window size.
+     */
+    getCurrentWindow(): number;
+    /**
+     * Get minimum window size.
+     */
+    getMinWindow(): number;
+    /**
+     * Get maximum window size.
+     */
+    getMaxWindow(): number;
+    /**
+     * Get statistics.
+     */
+    getStats(): WindowStats;
+    /**
+     * Reset statistics.
+     */
+    resetStats(): void;
+    /**
+     * Reset window to initial size.
+     */
+    reset(windowMs?: number): void;
+}

package/dist/core/src/events/aggregation/DeduplicationManager.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Event deduplication manager (FS-102)
+ *
+ * Merges events with the same pattern/idempotency key to reduce duplicates.
+ * - Pattern-based deduplication
+ * - Priority-aware merge strategy
+ * - Wildcard pattern aggregation
+ * - Deduplication rate tracking
+ *
+ * Ported from: examples/flash-sale-fullstack/src/cache/events/EventDeduplicator.ts
+ */
+import type { EventTask } from '../types';
+import type { AggregationConfig, DeduplicationStats } from './types';
+/**
+ * Event deduplication manager using pattern matching.
+ */
+export declare class DeduplicationManager {
+    private patternMap;
+    private stats;
+    private regexCache;
+    private cachedDeduplicated;
+    private deduplicatedDirty;
+    private config;
+    private patternTimestamps;
+    private cleanupTimer;
+    /**
+     * Create a deduplication manager.
+     */
+    constructor(config?: Partial<AggregationConfig>);
+    /**
+     * Add an event for deduplication.
+     *
+     * Rules:
+     * 1. Events with same pattern are merged into one
+     * 2. Higher priority events are kept, lower priority removed
+     * 3. If new event has higher priority, it replaces old event
+     */
+    addEvent(event: EventTask): void;
+    /**
+     * Add multiple events.
+     */
+    addEvents(events: EventTask[]): void;
+    /**
+     * Get all deduplicated events.
+     * Result is cached until next addEvent() call.
+     */
+    getDeduplicated(): EventTask[];
+    /**
+     * Optimize patterns by merging overlapping patterns.
+     *
+     * Example: ['product:1', 'product:2', 'product:3'] -> ['product:*']
+     */
+    optimizePatterns(patterns: string[]): string[];
+    /**
+     * Clear the deduplication manager.
+     */
+    clear(): void;
+    /**
+     * Get statistics.
+     */
+    getStats(): DeduplicationStats;
+    /**
+     * Reset statistics (but keep deduplication data).
+     */
+    resetStats(): void;
+    /**
+     * Get deduplication rate percentage.
+     */
+    getDeduplicationRate(): number;
+    /**
+     * Get pattern count.
+     */
+    getPatternCount(): number;
+    /**
+     * Get event for specific pattern.
+     */
+    getEventForPattern(pattern: string): EventTask | undefined;
+    /**
+     * Check if pattern exists.
+     */
+    hasPattern(pattern: string): boolean;
+    /**
+     * Remove specific pattern.
+     */
+    removePattern(pattern: string): boolean;
+    /**
+     * Remove patterns by prefix.
+     */
+    removePatternByPrefix(prefix: string): number;
+    /**
+     * Get all patterns.
+     */
+    getPatterns(): string[];
+    /**
+     * Find events matching invalidation pattern.
+     * Supports wildcard patterns.
+     */
+    findEventsByPattern(invalidationPattern: string): EventTask[];
+    /**
+     * Shutdown the manager (cleanup resources).
+     */
+    shutdown(): void;
+    /**
+     * Generate deduplication pattern from event.
+     */
+    private generatePattern;
+    /**
+     * Get pattern regex (cached).
+     */
+    private getPatternRegex;
+    /**
+     * Convert pattern to regex.
+     */
+    private patternToRegex;
+    /**
+     * Update deduplication rate.
+     */
+    private updateDeduplicationRate;
+    /**
+     * Start automatic cleanup timer.
+     */
+    private startCleanup;
+    /**
+     * Stop cleanup timer.
+     */
+    private stopCleanup;
+    /**
+     * Perform TTL-based cleanup.
+     */
+    private performCleanup;
+    /**
+     * Internal method for testing.
+     */
+    __getPatternMap(): Map<string, EventTask>;
+}