Spaces:
Sleeping
Sleeping
File size: 10,622 Bytes
da2e594 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | /**
* Cache utilities for flexible instance configuration
* Provides hash creation, metrics tracking, and cache configuration
*/
import { createHash } from 'crypto';
import { LRUCache } from 'lru-cache';
import { logger } from './logger';
/**
* Cache metrics for monitoring and optimization
*/
export interface CacheMetrics {
hits: number;
misses: number;
evictions: number;
sets: number;
deletes: number;
clears: number;
size: number;
maxSize: number;
avgHitRate: number;
createdAt: Date;
lastResetAt: Date;
}
/**
* Cache configuration options
*/
export interface CacheConfig {
max: number;
ttlMinutes: number;
}
/**
* Simple memoization cache for hash results
* Limited size to prevent memory growth
*/
const hashMemoCache = new Map<string, string>();
const MAX_MEMO_SIZE = 1000;
/**
* Metrics tracking for cache operations
*/
class CacheMetricsTracker {
private metrics!: CacheMetrics;
private startTime: Date;
constructor() {
this.startTime = new Date();
this.reset();
}
/**
* Reset all metrics to initial state
*/
reset(): void {
this.metrics = {
hits: 0,
misses: 0,
evictions: 0,
sets: 0,
deletes: 0,
clears: 0,
size: 0,
maxSize: 0,
avgHitRate: 0,
createdAt: this.startTime,
lastResetAt: new Date()
};
}
/**
* Record a cache hit
*/
recordHit(): void {
this.metrics.hits++;
this.updateHitRate();
}
/**
* Record a cache miss
*/
recordMiss(): void {
this.metrics.misses++;
this.updateHitRate();
}
/**
* Record a cache eviction
*/
recordEviction(): void {
this.metrics.evictions++;
}
/**
* Record a cache set operation
*/
recordSet(): void {
this.metrics.sets++;
}
/**
* Record a cache delete operation
*/
recordDelete(): void {
this.metrics.deletes++;
}
/**
* Record a cache clear operation
*/
recordClear(): void {
this.metrics.clears++;
}
/**
* Update cache size metrics
*/
updateSize(current: number, max: number): void {
this.metrics.size = current;
this.metrics.maxSize = max;
}
/**
* Update average hit rate
*/
private updateHitRate(): void {
const total = this.metrics.hits + this.metrics.misses;
if (total > 0) {
this.metrics.avgHitRate = this.metrics.hits / total;
}
}
/**
* Get current metrics snapshot
*/
getMetrics(): CacheMetrics {
return { ...this.metrics };
}
/**
* Get formatted metrics for logging
*/
getFormattedMetrics(): string {
const { hits, misses, evictions, avgHitRate, size, maxSize } = this.metrics;
return `Cache Metrics: Hits=${hits}, Misses=${misses}, HitRate=${(avgHitRate * 100).toFixed(2)}%, Size=${size}/${maxSize}, Evictions=${evictions}`;
}
}
// Global metrics tracker instance
export const cacheMetrics = new CacheMetricsTracker();
/**
* Get cache configuration from environment variables or defaults
* @returns Cache configuration with max size and TTL
*/
export function getCacheConfig(): CacheConfig {
const max = parseInt(process.env.INSTANCE_CACHE_MAX || '100', 10);
const ttlMinutes = parseInt(process.env.INSTANCE_CACHE_TTL_MINUTES || '30', 10);
// Validate configuration bounds
const validatedMax = Math.max(1, Math.min(10000, max)) || 100;
const validatedTtl = Math.max(1, Math.min(1440, ttlMinutes)) || 30; // Max 24 hours
if (validatedMax !== max || validatedTtl !== ttlMinutes) {
logger.warn('Cache configuration adjusted to valid bounds', {
requestedMax: max,
requestedTtl: ttlMinutes,
actualMax: validatedMax,
actualTtl: validatedTtl
});
}
return {
max: validatedMax,
ttlMinutes: validatedTtl
};
}
/**
* Create a secure hash for cache key with memoization
* @param input - The input string to hash
* @returns SHA-256 hash as hex string
*/
export function createCacheKey(input: string): string {
// Check memoization cache first
if (hashMemoCache.has(input)) {
return hashMemoCache.get(input)!;
}
// Create hash
const hash = createHash('sha256').update(input).digest('hex');
// Add to memoization cache with size limit
if (hashMemoCache.size >= MAX_MEMO_SIZE) {
// Remove oldest entries (simple FIFO)
const firstKey = hashMemoCache.keys().next().value;
if (firstKey) {
hashMemoCache.delete(firstKey);
}
}
hashMemoCache.set(input, hash);
return hash;
}
/**
* Create LRU cache with metrics tracking
* @param onDispose - Optional callback for when items are evicted
* @returns Configured LRU cache instance
*/
export function createInstanceCache<T extends {}>(
onDispose?: (value: T, key: string) => void
): LRUCache<string, T> {
const config = getCacheConfig();
return new LRUCache<string, T>({
max: config.max,
ttl: config.ttlMinutes * 60 * 1000, // Convert to milliseconds
updateAgeOnGet: true,
dispose: (value, key) => {
cacheMetrics.recordEviction();
if (onDispose) {
onDispose(value, key);
}
logger.debug('Cache eviction', {
cacheKey: key.substring(0, 8) + '...',
metrics: cacheMetrics.getFormattedMetrics()
});
}
});
}
/**
* Mutex implementation for cache operations
* Prevents race conditions during concurrent access
*/
export class CacheMutex {
private locks: Map<string, Promise<void>> = new Map();
private lockTimeouts: Map<string, NodeJS.Timeout> = new Map();
private readonly timeout: number = 5000; // 5 second timeout
/**
* Acquire a lock for the given key
* @param key - The cache key to lock
* @returns Promise that resolves when lock is acquired
*/
async acquire(key: string): Promise<() => void> {
while (this.locks.has(key)) {
try {
await this.locks.get(key);
} catch {
// Previous lock failed, we can proceed
}
}
let releaseLock: () => void;
const lockPromise = new Promise<void>((resolve) => {
releaseLock = () => {
resolve();
this.locks.delete(key);
const timeout = this.lockTimeouts.get(key);
if (timeout) {
clearTimeout(timeout);
this.lockTimeouts.delete(key);
}
};
});
this.locks.set(key, lockPromise);
// Set timeout to prevent stuck locks
const timeout = setTimeout(() => {
logger.warn('Cache lock timeout, forcefully releasing', { key: key.substring(0, 8) + '...' });
releaseLock!();
}, this.timeout);
this.lockTimeouts.set(key, timeout);
return releaseLock!;
}
/**
* Check if a key is currently locked
* @param key - The cache key to check
* @returns True if the key is locked
*/
isLocked(key: string): boolean {
return this.locks.has(key);
}
/**
* Clear all locks (use with caution)
*/
clearAll(): void {
this.lockTimeouts.forEach(timeout => clearTimeout(timeout));
this.locks.clear();
this.lockTimeouts.clear();
}
}
/**
* Retry configuration for API operations
*/
export interface RetryConfig {
maxAttempts: number;
baseDelayMs: number;
maxDelayMs: number;
jitterFactor: number;
}
/**
* Default retry configuration
*/
export const DEFAULT_RETRY_CONFIG: RetryConfig = {
maxAttempts: 3,
baseDelayMs: 1000,
maxDelayMs: 10000,
jitterFactor: 0.3
};
/**
* Calculate exponential backoff delay with jitter
* @param attempt - Current attempt number (0-based)
* @param config - Retry configuration
* @returns Delay in milliseconds
*/
export function calculateBackoffDelay(attempt: number, config: RetryConfig = DEFAULT_RETRY_CONFIG): number {
const exponentialDelay = Math.min(
config.baseDelayMs * Math.pow(2, attempt),
config.maxDelayMs
);
// Add jitter to prevent thundering herd
const jitter = exponentialDelay * config.jitterFactor * Math.random();
return Math.floor(exponentialDelay + jitter);
}
/**
* Execute function with retry logic
* @param fn - Function to execute
* @param config - Retry configuration
* @param context - Optional context for logging
* @returns Result of the function
*/
export async function withRetry<T>(
fn: () => Promise<T>,
config: RetryConfig = DEFAULT_RETRY_CONFIG,
context?: string
): Promise<T> {
let lastError: Error;
for (let attempt = 0; attempt < config.maxAttempts; attempt++) {
try {
return await fn();
} catch (error) {
lastError = error as Error;
// Check if error is retryable
if (!isRetryableError(error)) {
throw error;
}
if (attempt < config.maxAttempts - 1) {
const delay = calculateBackoffDelay(attempt, config);
logger.debug('Retrying operation after delay', {
context,
attempt: attempt + 1,
maxAttempts: config.maxAttempts,
delayMs: delay,
error: lastError.message
});
await new Promise(resolve => setTimeout(resolve, delay));
}
}
}
logger.error('All retry attempts exhausted', {
context,
attempts: config.maxAttempts,
lastError: lastError!.message
});
throw lastError!;
}
/**
* Check if an error is retryable
* @param error - The error to check
* @returns True if the error is retryable
*/
function isRetryableError(error: any): boolean {
// Network errors
if (error.code === 'ECONNREFUSED' ||
error.code === 'ECONNRESET' ||
error.code === 'ETIMEDOUT' ||
error.code === 'ENOTFOUND') {
return true;
}
// HTTP status codes that are retryable
if (error.response?.status) {
const status = error.response.status;
return status === 429 || // Too Many Requests
status === 503 || // Service Unavailable
status === 504 || // Gateway Timeout
(status >= 500 && status < 600); // Server errors
}
// Timeout errors
if (error.message && error.message.toLowerCase().includes('timeout')) {
return true;
}
return false;
}
/**
* Format cache statistics for logging or display
* @returns Formatted statistics string
*/
export function getCacheStatistics(): string {
const metrics = cacheMetrics.getMetrics();
const runtime = Date.now() - metrics.createdAt.getTime();
const runtimeMinutes = Math.floor(runtime / 60000);
return `
Cache Statistics:
Runtime: ${runtimeMinutes} minutes
Total Operations: ${metrics.hits + metrics.misses}
Hit Rate: ${(metrics.avgHitRate * 100).toFixed(2)}%
Current Size: ${metrics.size}/${metrics.maxSize}
Total Evictions: ${metrics.evictions}
Sets: ${metrics.sets}, Deletes: ${metrics.deletes}, Clears: ${metrics.clears}
`.trim();
} |