@gravito/ripple 3.1.0 → 4.0.1

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

@@ -0,0 +1,204 @@
+/**
+ * Event dispatch options for async event handling.
+ * @public
+ */
+export interface EventOptions {
+    /**
+     * Whether to dispatch the event asynchronously.
+     * @default false
+     */
+    async?: boolean;
+    /**
+     * Priority level for event processing.
+     * - 'critical': Immediate processing, bypass queue (< 1ms)
+     * - 'high': High priority events (< 50ms)
+     * - 'normal': Standard events (< 200ms)
+     * - 'low': Non-critical events (< 500ms)
+     * @default 'normal'
+     */
+    priority?: 'critical' | 'high' | 'normal' | 'low';
+    /**
+     * Automatic priority escalation configuration.
+     * Events can be automatically upgraded to higher priority based on wait time.
+     */
+    escalation?: {
+        /**
+         * Whether to enable automatic priority escalation.
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * Escalation thresholds in milliseconds.
+         * Events exceeding these wait times are promoted.
+         */
+        thresholds?: {
+            /**
+             * Wait time before LOW events are promoted to NORMAL.
+             * @default 200
+             */
+            lowToNormal?: number;
+            /**
+             * Wait time before NORMAL events are promoted to HIGH.
+             * @default 100
+             */
+            normalToHigh?: number;
+            /**
+             * Wait time before HIGH events are promoted to CRITICAL.
+             * @default 50
+             */
+            highToCritical?: number;
+        };
+        /**
+         * Maximum wait time before forcing CRITICAL priority.
+         * @default 500
+         */
+        maxWaitTimeMs?: number;
+    };
+    /**
+     * Execution timeout in milliseconds.
+     * If a listener exceeds this timeout, it will be terminated.
+     * @default 5000
+     */
+    timeout?: number;
+    /**
+     * Ordering guarantee strategy.
+     * - 'strict': Global strict ordering (slow, serialized)
+     * - 'partition': Partition-based ordering (recommended, balanced)
+     * - 'none': No ordering guarantee (fastest, parallel)
+     * @default 'none'
+     */
+    ordering?: 'strict' | 'partition' | 'none';
+    /**
+     * Partition key for partition-based ordering.
+     * Events with the same partition key are processed in order.
+     * Only used when ordering is 'partition'.
+     * @example 'order:123' or 'user:456'
+     */
+    partitionKey?: string;
+    /**
+     * Idempotency key for deduplication.
+     * Events with the same idempotency key within the TTL window
+     * will be processed only once.
+     * @example 'order:123:created'
+     */
+    idempotencyKey?: string;
+    /**
+     * Time-to-live for idempotency key in milliseconds.
+     * @default 3600000 (1 hour)
+     */
+    ttl?: number;
+    /**
+     * Retry policy for failed event processing.
+     */
+    retry?: {
+        /**
+         * Maximum number of retry attempts.
+         * @default 0
+         */
+        maxRetries?: number;
+        /**
+         * Backoff strategy for retries.
+         * - 'exponential': Delay doubles with each retry (1s, 2s, 4s, 8s...)
+         * - 'linear': Fixed delay between retries
+         * @default 'exponential'
+         */
+        backoff?: 'exponential' | 'linear';
+        /**
+         * Initial delay in milliseconds before first retry.
+         * @default 1000
+         */
+        initialDelayMs?: number;
+        /**
+         * Maximum delay in milliseconds between retries.
+         * @default 30000
+         */
+        maxDelayMs?: number;
+        /**
+         * Whether to send failed events to Dead Letter Queue after max retries.
+         * @default false
+         */
+        dlqAfterMaxRetries?: boolean;
+    };
+    /**
+     * Circuit breaker options for this event.
+     */
+    circuitBreaker?: {
+        /**
+         * Number of consecutive failures before opening the circuit.
+         * @default 5
+         */
+        failureThreshold?: number;
+        /**
+         * Time in milliseconds to wait before attempting to close the circuit.
+         * @default 30000
+         */
+        resetTimeout?: number;
+        /**
+         * Number of test requests to allow in half-open state.
+         * @default 3
+         */
+        halfOpenRequests?: number;
+    };
+    /**
+     * Event aggregation configuration (FS-102).
+     * Enables deduplication and micro-batching for improved throughput.
+     * @default undefined (disabled)
+     */
+    aggregation?: {
+        /**
+         * Enable event aggregation.
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * Aggregation window size in milliseconds.
+         * Backpressure-aware adjustment: 50-500ms
+         * @default 200
+         */
+        windowMs?: number;
+        /**
+         * Batch size threshold for auto-flush.
+         * @default 50
+         */
+        batchSize?: number;
+        /**
+         * Deduplication strategy.
+         * @default 'pattern'
+         */
+        deduplication?: 'pattern' | 'idempotencyKey' | 'off';
+        /**
+         * Deduplication pattern (string or function).
+         * String: hook-based pattern
+         * Function: custom pattern from event args
+         */
+        pattern?: string | ((args: unknown) => string);
+        /**
+         * Priority merge strategy.
+         * - 'highest': keep highest priority event
+         * - 'earliest': keep earliest event
+         * - 'latest': keep latest event
+         * @default 'highest'
+         */
+        mergePriority?: 'highest' | 'earliest' | 'latest';
+        /**
+         * Enable automatic cleanup of expired entries.
+         * @default true
+         */
+        enableCleanup?: boolean;
+        /**
+         * Cleanup interval in milliseconds.
+         * @default 300000 (5 minutes)
+         */
+        cleanupIntervalMs?: number;
+        /**
+         * TTL for entries in milliseconds.
+         * @default 600000 (10 minutes)
+         */
+        ttlMs?: number;
+    };
+}
+/**
+ * Default event options.
+ * @internal
+ */
+export declare const DEFAULT_EVENT_OPTIONS: Required<EventOptions>;

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

@@ -0,0 +1,301 @@
+import type { Span } from '@opentelemetry/api';
+import type { ActionCallback } from '../HookManager';
+import { BackpressureManager } from './BackpressureManager';
+import { CircuitBreaker } from './CircuitBreaker';
+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.
+ *
+ * @internal
+ */
+export declare class EventPriorityQueue implements EventBackend {
+    private criticalPriority;
+    private highPriority;
+    private normalPriority;
+    private lowPriority;
+    private processing;
+    private taskIdCounter;
+    private dlq?;
+    private persistentDLQHandler?;
+    private config;
+    private processingPartitions;
+    private eventCircuitBreakers;
+    private eventMetrics?;
+    private otelEventMetrics?;
+    private eventTracing?;
+    private currentDispatchSpan?;
+    private backpressureManager?;
+    private workerPool?;
+    private retryScheduler?;
+    private priorityStats?;
+    constructor(config?: EventQueueConfig);
+    /**
+     * Set the Dead Letter Queue for failed events.
+     *
+     * @param dlq - Dead Letter Queue instance
+     */
+    setDeadLetterQueue(dlq: DeadLetterQueue): void;
+    /**
+     * Set the persistent DLQ handler for failed events.
+     *
+     * @param handler - Async handler function for persistent DLQ
+     */
+    setPersistentDLQHandler(handler: (hook: string, args: unknown, options: EventOptions, error: Error, retryCount: number, firstFailedAt: number) => Promise<void>): void;
+    /**
+     * Set the EventMetrics instance for recording circuit breaker metrics.
+     *
+     * @param metrics - EventMetrics instance
+     * @internal
+     */
+    setEventMetrics(metrics: EventMetrics): void;
+    /**
+     * Set the OTelEventMetrics instance for recording DLQ and backpressure metrics.
+     *
+     * @param metrics - OTelEventMetrics instance
+     * @internal
+     */
+    setOTelEventMetrics(metrics: OTelEventMetrics): void;
+    /**
+     * Set the PriorityStatistics instance for tracking priority distribution.
+     *
+     * @param stats - PriorityStatistics instance
+     * @internal
+     */
+    setPriorityStatistics(stats: PriorityStatistics): void;
+    /**
+     * Get the PriorityStatistics instance.
+     *
+     * @returns PriorityStatistics instance or undefined
+     * @internal
+     */
+    getPriorityStatistics(): PriorityStatistics | undefined;
+    /**
+     * Set the EventTracing instance for distributed tracing.
+     *
+     * @param tracing - EventTracing instance
+     * @internal
+     */
+    setEventTracing(tracing: EventTracing): void;
+    /**
+     * Set the current dispatch span for creating child spans.
+     *
+     * @param span - Parent dispatch span
+     * @internal
+     */
+    setCurrentDispatchSpan(span: Span | undefined): void;
+    /**
+     * Get the current dispatch span.
+     *
+     * @returns Current dispatch span or undefined
+     * @internal
+     */
+    getCurrentDispatchSpan(): Span | undefined;
+    /**
+     * Set the RetryScheduler for async distributed retries.
+     *
+     * @param scheduler - RetryScheduler instance
+     * @internal
+     */
+    setRetryScheduler(scheduler: RetryScheduler): void;
+    /**
+     * Get the RetryScheduler instance.
+     *
+     * @returns RetryScheduler instance or undefined
+     * @internal
+     */
+    getRetryScheduler(): RetryScheduler | undefined;
+    /**
+     * Get or create a circuit breaker for an event hook.
+     *
+     * @param hook - Event hook name
+     * @param config - Circuit breaker configuration
+     * @returns Circuit breaker instance or undefined if not configured
+     * @internal
+     */
+    private getOrCreateEventCircuitBreaker;
+    /**
+     * Enqueue an event task for processing.
+     *
+     * @param hook - Event hook name
+     * @param args - Event arguments
+     * @param callbacks - Callbacks to execute
+     * @param options - Event options
+     * @returns Task ID
+     */
+    enqueue(task: EventTask): string;
+    enqueue(hook: string, args: unknown, callbacks: ActionCallback[], options: EventOptions): string;
+    /**
+     * Handle backpressure when queue is full.
+     * @returns True if space was made, false if event should be dropped
+     */
+    private handleBackpressure;
+    /**
+     * Drop the oldest event from the queue, prioritizing low priority events.
+     * Drops in order: LOW → NORMAL → HIGH → CRITICAL
+     */
+    private dropOldest;
+    /**
+     * Process the next task in the queue.
+     * Tasks are processed in priority order: high > normal > low
+     * If WorkerPool is configured, tasks are submitted to the pool for concurrent execution.
+     *
+     * @internal
+     */
+    private processNext;
+    /**
+     * Dequeue the next task based on priority and partition ordering.
+     * Priority order: CRITICAL > HIGH > NORMAL > LOW
+     *
+     * @returns Next task to process, or undefined if queue is empty
+     * @internal
+     */
+    private dequeue;
+    /**
+     * Dequeue a task from a priority queue, respecting partition ordering.
+     *
+     * @param queue - Priority queue to dequeue from
+     * @returns Next task to process, or undefined if all tasks are blocked by partition locks
+     * @internal
+     */
+    private dequeueFromPriority;
+    /**
+     * Execute an event task by running all its callbacks.
+     * Implements circuit breaker protection, retry logic with exponential backoff, and DLQ integration.
+     * Also handles partition ordering by acquiring and releasing partition locks.
+     *
+     * @param task - Event task to execute
+     * @internal
+     */
+    private executeTask;
+    /**
+     * Calculate retry delay based on backoff strategy.
+     *
+     * @param retryCount - Current retry attempt number
+     * @param backoff - Backoff strategy
+     * @param initialDelay - Initial delay in ms
+     * @param maxDelay - Maximum delay in ms
+     * @returns Delay in milliseconds
+     * @internal
+     */
+    private calculateRetryDelay;
+    /**
+     * Re-enqueue a task for retry.
+     *
+     * @param task - Task to retry
+     * @internal
+     */
+    private enqueueRetry;
+    /**
+     * Execute a callback with timeout.
+     *
+     * @param callback - Callback to execute
+     * @param args - Arguments to pass to callback
+     * @param timeoutMs - Timeout in milliseconds
+     * @internal
+     */
+    private executeWithTimeout;
+    /**
+     * Get the current depth of the queue.
+     *
+     * @returns Total number of tasks in the queue
+     */
+    getDepth(): number;
+    /**
+     * Get the depth of a specific priority queue.
+     *
+     * @param priority - Priority level
+     * @returns Number of tasks in the specified priority queue
+     */
+    getDepthByPriority(priority: 'critical' | 'high' | 'normal' | 'low'): number;
+    /**
+     * Get the BackpressureManager instance if enabled.
+     *
+     * @returns BackpressureManager instance or undefined if not enabled
+     * @internal
+     */
+    getBackpressureManager(): BackpressureManager | undefined;
+    /**
+     * Set the WorkerPool for concurrent task execution.
+     *
+     * @param pool - WorkerPool instance
+     * @internal
+     */
+    setWorkerPool(pool: WorkerPool): void;
+    /**
+     * Get the WorkerPool instance if set.
+     *
+     * @returns WorkerPool instance or undefined if not set
+     * @internal
+     */
+    getWorkerPool(): WorkerPool | undefined;
+    /**
+     * Clear all tasks from the queue.
+     */
+    clear(): void;
+    /**
+     * Get circuit breaker for an event hook.
+     *
+     * @param hook - Event hook name
+     * @returns Circuit breaker instance or undefined
+     * @internal
+     */
+    getCircuitBreaker(hook: string): CircuitBreaker | undefined;
+    /**
+     * Get all circuit breakers.
+     *
+     * @returns Map of circuit breakers keyed by hook name
+     * @internal
+     */
+    getCircuitBreakers(): Map<string, CircuitBreaker>;
+    /**
+     * Reset a circuit breaker for an event hook.
+     *
+     * @param hook - Event hook name
+     * @returns True if reset, false if circuit breaker not found
+     * @internal
+     */
+    resetCircuitBreaker(hook: string): boolean;
+    /**
+     * Batch enqueue multiple tasks (FS-102).
+     * Supports aggregation layer batch submission.
+     *
+     * @param tasks - Array of tasks to enqueue
+     * @returns Array of task IDs
+     * @internal
+     */
+    enqueueBatch(tasks: EventTask[]): string[];
+    /**
+     * Get queue depth for each priority level (FS-103).
+     * Used by BackpressureManager for multi-priority depth monitoring.
+     *
+     * @returns Queue depth snapshot with depths for each priority
+     * @internal
+     */
+    getQueueDepthByPriority(): MultiPriorityQueueDepth;
+    /**
+     * Sync queue depth to BackpressureManager (FS-103).
+     * Called whenever queue depth changes to keep BackpressureManager
+     * synchronized with real-time queue state.
+     *
+     * @private
+     * @internal
+     */
+    private syncBackpressure;
+}

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