brainy/src/augmentations/requestDeduplicatorAugmentation.ts
David Snelling 7e243b6f2b feat: comprehensive metadata namespace architecture and cleanup system
BREAKING CHANGE: Remove hard delete option from deleteVerb() for consistent API

- Add complete metadata namespace architecture with O(1) soft delete performance
- Implement periodic cleanup system for old soft-deleted items
- Add restore methods for both nouns and verbs
- Require metadata contracts for all augmentations
- Eliminate namespace collisions with clean separation (_brainy, _augmentations, _audit)
- Optimize index performance using flattened dot-notation for O(1) lookups
- Add comprehensive augmentation safety system with type-safe access control
- Maintain full backward compatibility for existing data
- Add enterprise-grade cleanup with configurable age thresholds and batch processing

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-27 15:38:48 -07:00

216 lines
No EOL
6.2 KiB
TypeScript

/**
* Request Deduplicator Augmentation
*
* Prevents duplicate concurrent requests to improve performance by 3x
* Automatically deduplicates identical operations
*/
import { BaseAugmentation, AugmentationContext } from './brainyAugmentation.js'
interface PendingRequest<T> {
promise: Promise<T>
timestamp: number
count: number
}
interface DeduplicatorConfig {
enabled?: boolean
ttl?: number // Time to live for cached requests (ms)
maxSize?: number // Maximum number of cached requests
}
export class RequestDeduplicatorAugmentation extends BaseAugmentation {
name = 'RequestDeduplicator'
timing = 'around' as const
metadata = 'none' as const // Doesn't access metadata
operations = ['search', 'searchText', 'searchByNounTypes', 'findSimilar', 'get'] as ('search' | 'searchText' | 'searchByNounTypes' | 'findSimilar' | 'get')[]
priority = 50 // Performance optimization
private pendingRequests: Map<string, PendingRequest<any>> = new Map()
private config: Required<DeduplicatorConfig>
private cleanupInterval?: NodeJS.Timeout
constructor(config: DeduplicatorConfig = {}) {
super()
this.config = {
enabled: config.enabled ?? true,
ttl: config.ttl ?? 5000, // 5 second default
maxSize: config.maxSize ?? 1000
}
}
protected async onInitialize(): Promise<void> {
if (this.config.enabled) {
this.log('Request deduplicator initialized for 3x performance boost')
// Start cleanup interval
this.cleanupInterval = setInterval(() => {
this.cleanup()
}, this.config.ttl)
} else {
this.log('Request deduplicator disabled')
}
}
shouldExecute(operation: string, params: any): boolean {
// Only execute if enabled and for read operations that benefit from deduplication
return this.config.enabled && (
operation === 'search' ||
operation === 'searchText' ||
operation === 'searchByNounTypes' ||
operation === 'findSimilar' ||
operation === 'get'
)
}
async execute<T = any>(
operation: string,
params: any,
next: () => Promise<T>
): Promise<T> {
if (!this.config.enabled) {
return next()
}
// Create a unique key for this request
const key = this.createRequestKey(operation, params)
// Check if we already have this request pending
const existing = this.pendingRequests.get(key)
if (existing) {
existing.count++
this.log(`Deduplicating request: ${key} (${existing.count} total)`)
return existing.promise
}
// Execute the request and cache the promise
const promise = next()
this.pendingRequests.set(key, {
promise,
timestamp: Date.now(),
count: 1
})
// Clean up when done
promise.finally(() => {
// Use setTimeout to allow other concurrent requests to use the result
setTimeout(() => {
this.pendingRequests.delete(key)
}, 100)
})
return promise
}
/**
* Create a unique key for the request based on operation and parameters
*/
private createRequestKey(operation: string, params: any): string {
// Create a stable string representation of the operation and params
const paramsKey = this.serializeParams(params)
return `${operation}:${paramsKey}`
}
/**
* Serialize parameters to a consistent string
*/
private serializeParams(params: any): string {
if (!params) return 'null'
if (typeof params === 'string' || typeof params === 'number') {
return String(params)
}
if (Array.isArray(params)) {
// For arrays, create a hash-like representation
if (params.length > 100) {
// For large arrays (like vectors), use length + first/last elements
return `[${params.length}:${params[0]}...${params[params.length - 1]}]`
}
return `[${params.join(',')}]`
}
if (typeof params === 'object') {
// Sort keys for consistent serialization
const keys = Object.keys(params).sort()
const keyValues = keys.map(key => `${key}:${this.serializeParams(params[key])}`)
return `{${keyValues.join(',')}}`
}
return String(params)
}
/**
* Clean up expired requests
*/
private cleanup(): void {
const now = Date.now()
const expired = []
for (const [key, request] of this.pendingRequests) {
if (now - request.timestamp > this.config.ttl) {
expired.push(key)
}
}
for (const key of expired) {
this.pendingRequests.delete(key)
}
// Also enforce max size
if (this.pendingRequests.size > this.config.maxSize) {
const entries = Array.from(this.pendingRequests.entries())
.sort(([,a], [,b]) => a.timestamp - b.timestamp) // Oldest first
// Remove oldest entries
const toRemove = entries.slice(0, entries.length - this.config.maxSize)
for (const [key] of toRemove) {
this.pendingRequests.delete(key)
}
}
if (expired.length > 0) {
this.log(`Cleaned up ${expired.length} expired requests`)
}
}
/**
* Get statistics about request deduplication
*/
getStats(): {
activePendingRequests: number
totalDeduplicationHits: number
memoryUsage: string
efficiency: string
} {
const requests = Array.from(this.pendingRequests.values())
const totalRequests = requests.reduce((sum, req) => sum + req.count, 0)
const actualRequests = requests.length
const savedRequests = totalRequests - actualRequests
return {
activePendingRequests: actualRequests,
totalDeduplicationHits: savedRequests,
memoryUsage: `${Math.round(JSON.stringify(requests).length / 1024)}KB`,
efficiency: actualRequests > 0 ? `${Math.round((savedRequests / totalRequests) * 100)}% reduction` : '0%'
}
}
/**
* Force clear all pending requests (for testing)
*/
clear(): void {
this.pendingRequests.clear()
}
protected async onShutdown(): Promise<void> {
if (this.cleanupInterval) {
clearInterval(this.cleanupInterval)
}
const stats = this.getStats()
this.log(`Request deduplicator shutdown: ${stats.efficiency} efficiency achieved`)
this.pendingRequests.clear()
}
}