@gravito/core 1.6.1 → 2.0.1

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

package/dist/events/aggregation/EventAggregationManager.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Event aggregation manager (FS-102)
+ *
+ * Coordinates deduplication and batching for optimal event processing:
+ * - Event deduplication (pattern-based or idempotency-key based)
+ * - Micro-batching (time and size dual-trigger)
+ * - Backpressure-aware window adjustment
+ * - Complete statistics tracking
+ *
+ * Ported from: examples/flash-sale-fullstack/src/cache/events/EventAggregator.ts
+ */
+import type { BackpressureManager } from '../BackpressureManager';
+import type { EventTask } from '../types';
+import { AggregationWindow } from './AggregationWindow';
+import { DeduplicationManager } from './DeduplicationManager';
+import { EventBatcher } from './EventBatcher';
+import type { AggregationConfig, AggregationStats } from './types';
+/**
+ * Event aggregation manager.
+ */
+export declare class EventAggregationManager {
+    private deduplicator;
+    private batcher;
+    private window;
+    private config;
+    private backpressureManager?;
+    private submitToQueueFn?;
+    private disabled;
+    /**
+     * Create an event aggregation manager.
+     */
+    constructor(config?: Partial<AggregationConfig>);
+    /**
+     * Set backpressure manager for window adjustment.
+     * FS-103：Also sets BackpressureManager on AggregationWindow for feedback loop.
+     */
+    setBackpressureManager(backpressure: BackpressureManager): void;
+    /**
+     * Set the actual queue submission function.
+     */
+    setSubmitToQueueFn(fn: (tasks: EventTask[]) => Promise<void>): void;
+    /**
+     * Submit an event for aggregation.
+     *
+     * Returns true if accepted, false if rejected due to backpressure.
+     */
+    submit(task: EventTask): Promise<boolean>;
+    /**
+     * Submit multiple events.
+     */
+    submitBatch(tasks: EventTask[]): Promise<number>;
+    /**
+     * Flush current batch to queue.
+     */
+    flush(): Promise<EventTask[]>;
+    /**
+     * Get aggregation statistics.
+     */
+    getStats(): AggregationStats;
+    /**
+     * Reset statistics.
+     */
+    resetStats(): void;
+    /**
+     * Clear aggregation state.
+     */
+    clear(): void;
+    /**
+     * Check if there are pending events.
+     */
+    hasPending(): boolean;
+    /**
+     * Get pending event count.
+     */
+    getPendingCount(): number;
+    /**
+     * Disable the aggregation manager.
+     */
+    disable(): void;
+    /**
+     * Enable the aggregation manager.
+     */
+    enable(): void;
+    /**
+     * Check if aggregation manager is enabled.
+     */
+    isEnabled(): boolean;
+    /**
+     * Shutdown the aggregation manager.
+     */
+    shutdown(): Promise<EventTask[]>;
+    /**
+     * Submit deduplicated events to queue.
+     */
+    private submitToQueue;
+    /**
+     * Get deduplication manager (for testing).
+     */
+    __getDeduplicator(): DeduplicationManager;
+    /**
+     * Get event batcher (for testing).
+     */
+    __getBatcher(): EventBatcher;
+    /**
+     * Get aggregation window (for testing).
+     */
+    __getWindow(): AggregationWindow;
+}

package/dist/events/aggregation/EventBatcher.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Event batcher for microbatching optimization (FS-102)
+ *
+ * Implements dual-trigger batching:
+ * - Time window trigger (default 50ms)
+ * - Batch size trigger (default 50 events)
+ *
+ * Expected improvements: 10-15% throughput increase
+ *
+ * Ported from: examples/flash-sale-fullstack/src/cache/events/BatchSubmitter.ts
+ */
+import type { EventTask } from '../types';
+import type { BatchStats } from './types';
+/**
+ * Event batcher for optimizing submission throughput.
+ */
+export declare class EventBatcher {
+    private queue;
+    private readonly batchSize;
+    private readonly flushIntervalMs;
+    private flushTimer;
+    private stats;
+    private submitFn;
+    /**
+     * Create an event batcher.
+     *
+     * @param batchSize - Batch size threshold (default 50)
+     * @param flushIntervalMs - Time window (ms, default 50)
+     * @param submitFn - Function to submit batches
+     */
+    constructor(batchSize: number, flushIntervalMs: number, submitFn: (tasks: EventTask[]) => Promise<void>);
+    /**
+     * Enqueue an event.
+     *
+     * Automatically triggers flush if:
+     * 1. Batch size is reached
+     * 2. Time window expires
+     */
+    enqueue(task: EventTask): Promise<void>;
+    /**
+     * Enqueue multiple events.
+     */
+    enqueueBatch(tasks: EventTask[]): Promise<void>;
+    /**
+     * Flush queued events.
+     *
+     * @param auto - Whether this is an auto-triggered flush
+     * @returns Array of flushed events
+     */
+    flush(auto?: boolean): Promise<EventTask[]>;
+    /**
+     * Get statistics.
+     */
+    getStats(): BatchStats;
+    /**
+     * Get pending event count.
+     */
+    getPendingCount(): number;
+    /**
+     * Check if there are pending events.
+     */
+    hasPending(): boolean;
+    /**
+     * Clear the queue.
+     */
+    clear(): void;
+    /**
+     * Reset statistics.
+     */
+    resetStats(): void;
+    /**
+     * Stop the batcher and flush remaining events.
+     */
+    stop(): Promise<EventTask[]>;
+    /**
+     * Start time-window timer.
+     */
+    private startTimer;
+    /**
+     * Clear timer.
+     */
+    private clearTimer;
+    /**
+     * Adjust batch size.
+     */
+    setBatchSize(newSize: number): void;
+    /**
+     * Adjust flush interval.
+     */
+    setFlushInterval(_newIntervalMs: number): void;
+    /**
+     * Get batch size.
+     */
+    getBatchSize(): number;
+    /**
+     * Get flush interval.
+     */
+    getFlushInterval(): number;
+}

package/dist/events/aggregation/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Event aggregation and deduplication module (FS-102)
+ * @public
+ */
+export { AggregationWindow } from './AggregationWindow';
+export { DeduplicationManager } from './DeduplicationManager';
+export { EventAggregationManager } from './EventAggregationManager';
+export { EventBatcher } from './EventBatcher';
+export type { AggregationConfig, AggregationStats, BatchStats, DeduplicationStats, WindowAdjustmentConfig, WindowStats, } from './types';
+export { DEFAULT_AGGREGATION_CONFIG, DEFAULT_WINDOW_ADJUSTMENT, getSuggestedWindow, PRIORITY_ORDER, } from './types';