diff --git a/package-lock.json b/package-lock.json index 759dcb19..ba89021b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,6 +9,7 @@ "version": "1.0.0", "license": "MIT", "dependencies": { + "@nestjs/cache-manager": "^3.1.1", "@nestjs/common": "^10.3.0", "@nestjs/config": "^3.1.1", "@nestjs/core": "^10.3.0", @@ -17,6 +18,8 @@ "@nestjs/swagger": "^7.1.16", "@prisma/client": "^6.19.2", "bcrypt": "^6.0.0", + "cache-manager": "^7.2.8", + "cache-manager-redis-store": "^3.0.1", "class-transformer": "^0.5.1", "class-validator": "^0.14.1", "csv-parse": "^6.2.1", @@ -25,6 +28,7 @@ "passport": "^0.7.0", "passport-jwt": "^4.0.1", "pg": "^8.11.3", + "redis": "^5.12.1", "reflect-metadata": "^0.1.13", "rxjs": "^7.8.1", "swagger-ui-express": "^5.0.1" @@ -777,6 +781,16 @@ "url": "https://github.com/sponsors/Borewit" } }, + "node_modules/@cacheable/utils": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/@cacheable/utils/-/utils-2.4.1.tgz", + "integrity": "sha512-eiFgzCbIneyMlLOmNG4g9xzF7Hv3Mga4LjxjcSC/ues6VYq2+gUbQI8JqNuw/ZM8tJIeIaBGpswAsqV2V7ApgA==", + "license": "MIT", + "dependencies": { + "hashery": "^1.5.1", + "keyv": "^5.6.0" + } + }, "node_modules/@colors/colors": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", @@ -1620,6 +1634,12 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "node_modules/@keyv/serialize": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@keyv/serialize/-/serialize-1.1.1.tgz", + "integrity": "sha512-dXn3FZhPv0US+7dtJsIi2R+c7qWYiReoEh5zUntWCf4oSpMNib8FDhSoed6m3QyZdx5hK7iLFkYk3rNxwt8vTA==", + "license": "MIT" + }, "node_modules/@ljharb/through": { "version": "2.3.14", "resolved": "https://registry.npmjs.org/@ljharb/through/-/through-2.3.14.tgz", @@ -1642,6 +1662,19 @@ "node": ">=8" } }, + "node_modules/@nestjs/cache-manager": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@nestjs/cache-manager/-/cache-manager-3.1.1.tgz", + "integrity": "sha512-KEZ+s4RIdWi0BTAvjTIk2UWvCibacSlKBhyNugPwGNb8OewHywzPCAUqPxIjeuprkw6d4sj4oe9+FLEpFopWdg==", + "license": "MIT", + "peerDependencies": { + "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0", + "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0", + "cache-manager": ">=6", + "keyv": ">=5", + "rxjs": "^7.8.1" + } + }, "node_modules/@nestjs/cli": { "version": "10.4.9", "resolved": "https://registry.npmjs.org/@nestjs/cli/-/cli-10.4.9.tgz", @@ -2300,6 +2333,35 @@ "@prisma/debug": "6.19.2" } }, + "node_modules/@redis/client": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.6.1.tgz", + "integrity": "sha512-/KCsg3xSlR+nCK8/8ZYSknYxvXHwubJrU82F3Lm1Fp6789VQ0/3RJKfsmRXjqfaTA++23CvC3hqmqe/2GEt6Kw==", + "license": "MIT", + "dependencies": { + "cluster-key-slot": "1.1.2", + "generic-pool": "3.9.0", + "yallist": "4.0.0" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/@redis/client/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "license": "ISC" + }, + "node_modules/@redis/graph": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.1.1.tgz", + "integrity": "sha512-FEMTcTHZozZciLRl6GiiIB4zGm5z5F3F6a6FZCyrfxdKOhFlGkiAqlexWMBzCi4DcRoyiOsuLfW+cjlGWyExOw==", + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, "node_modules/@sinclair/typebox": { "version": "0.27.8", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", @@ -3823,6 +3885,81 @@ "url": "https://paulmillr.com/funding/" } }, + "node_modules/cache-manager": { + "version": "7.2.8", + "resolved": "https://registry.npmjs.org/cache-manager/-/cache-manager-7.2.8.tgz", + "integrity": "sha512-0HDaDLBBY/maa/LmUVAr70XUOwsiQD+jyzCBjmUErYZUKdMS9dT59PqW59PpVqfGM7ve6H0J6307JTpkCYefHQ==", + "license": "MIT", + "dependencies": { + "@cacheable/utils": "^2.3.3", + "keyv": "^5.5.5" + } + }, + "node_modules/cache-manager-redis-store": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/cache-manager-redis-store/-/cache-manager-redis-store-3.0.1.tgz", + "integrity": "sha512-o560kw+dFqusC9lQJhcm6L2F2fMKobJ5af+FoR2PdnMVdpQ3f3Bz6qzvObTGyvoazQJxjQNWgMQeChP4vRTuXQ==", + "license": "MIT", + "dependencies": { + "redis": "^4.3.1" + }, + "engines": { + "node": ">= 16.18.0" + } + }, + "node_modules/cache-manager-redis-store/node_modules/@redis/bloom": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.2.0.tgz", + "integrity": "sha512-HG2DFjYKbpNmVXsa0keLHp/3leGJz1mjh09f2RLGGLQZzSHpkmZWuwJbAvo3QcRY8p80m5+ZdXZdYOSBLlp7Cg==", + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/cache-manager-redis-store/node_modules/@redis/json": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.7.tgz", + "integrity": "sha512-6UyXfjVaTBTJtKNG4/9Z8PSpKE6XgSyEb8iwaqDcy+uKrd/DGYHTWkUdnQDyzm727V7p21WUMhsqz5oy65kPcQ==", + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/cache-manager-redis-store/node_modules/@redis/search": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.2.0.tgz", + "integrity": "sha512-tYoDBbtqOVigEDMAcTGsRlMycIIjwMCgD8eR2t0NANeQmgK/lvxNAvYyb6bZDD4frHRhIHkJu2TBRvB0ERkOmw==", + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/cache-manager-redis-store/node_modules/@redis/time-series": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.1.0.tgz", + "integrity": "sha512-c1Q99M5ljsIuc4YdaCwfUEXsofakb9c8+Zse2qxTadu8TalLXuAESzLvFAvNVbkmSlvlzIQOLpBCmWI9wTOt+g==", + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/cache-manager-redis-store/node_modules/redis": { + "version": "4.7.1", + "resolved": "https://registry.npmjs.org/redis/-/redis-4.7.1.tgz", + "integrity": "sha512-S1bJDnqLftzHXHP8JsT5II/CtHWQrASX5K96REjWjlmWKrviSOLWmM7QnRLstAWsu1VBBV1ffV6DzCvxNP0UJQ==", + "license": "MIT", + "workspaces": [ + "./packages/*" + ], + "dependencies": { + "@redis/bloom": "1.2.0", + "@redis/client": "1.6.1", + "@redis/graph": "1.1.1", + "@redis/json": "1.0.7", + "@redis/search": "1.2.0", + "@redis/time-series": "1.1.0" + } + }, "node_modules/call-bind": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", @@ -4104,6 +4241,15 @@ "node": ">=0.8" } }, + "node_modules/cluster-key-slot": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.2.tgz", + "integrity": "sha512-RMr0FhtfXemyinomL4hrWcYJxmX6deFdCxpJzhDttxgO1+bcCnkk+9drydLVDmAMG7NE6aN/fl4F7ucU/90gAA==", + "license": "Apache-2.0", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/co": { "version": "4.6.0", "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", @@ -5517,6 +5663,16 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/flat-cache/node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "json-buffer": "3.0.1" + } + }, "node_modules/flat-cache/node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -5709,6 +5865,15 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/generic-pool": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/generic-pool/-/generic-pool-3.9.0.tgz", + "integrity": "sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -6013,6 +6178,18 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/hashery": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/hashery/-/hashery-1.5.1.tgz", + "integrity": "sha512-iZyKG96/JwPz1N55vj2Ie2vXbhu440zfUfJvSwEqEbeLluk7NnapfGqa7LH0mOsnDxTF85Mx8/dyR6HfqcbmbQ==", + "license": "MIT", + "dependencies": { + "hookified": "^1.15.0" + }, + "engines": { + "node": ">=20" + } + }, "node_modules/hasown": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", @@ -6025,6 +6202,12 @@ "node": ">= 0.4" } }, + "node_modules/hookified": { + "version": "1.15.1", + "resolved": "https://registry.npmjs.org/hookified/-/hookified-1.15.1.tgz", + "integrity": "sha512-MvG/clsADq1GPM2KGo2nyfaWVyn9naPiXrqIe4jYjXNZQt238kWyOGrsyc/DmRAQ+Re6yeo6yX/yoNCG5KAEVg==", + "license": "MIT" + }, "node_modules/html-escaper": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", @@ -7377,13 +7560,12 @@ } }, "node_modules/keyv": { - "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", - "dev": true, + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-5.6.0.tgz", + "integrity": "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==", "license": "MIT", "dependencies": { - "json-buffer": "3.0.1" + "@keyv/serialize": "^1.1.1" } }, "node_modules/kleur": { @@ -8820,6 +9002,94 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, + "node_modules/redis": { + "version": "5.12.1", + "resolved": "https://registry.npmjs.org/redis/-/redis-5.12.1.tgz", + "integrity": "sha512-LDsoVvb/CpoV9EN3FXvgvSHNJWuCIzl9MiO3ppOevuGLpSGJhwfQjpEwfFJcQvNSddHADDdZaWx0HnmMxRXG7g==", + "license": "MIT", + "dependencies": { + "@redis/bloom": "5.12.1", + "@redis/client": "5.12.1", + "@redis/json": "5.12.1", + "@redis/search": "5.12.1", + "@redis/time-series": "5.12.1" + }, + "engines": { + "node": ">= 18.19.0" + } + }, + "node_modules/redis/node_modules/@redis/bloom": { + "version": "5.12.1", + "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-5.12.1.tgz", + "integrity": "sha512-PUUfv+ms7jgPSBVoo/DN4AkPHj4D5TZSd6SbJX7egzBplkYUcKmHRE8RKia7UtZ8bSQbLguLvxVO+asKtQfZWA==", + "license": "MIT", + "engines": { + "node": ">= 18.19.0" + }, + "peerDependencies": { + "@redis/client": "^5.12.1" + } + }, + "node_modules/redis/node_modules/@redis/client": { + "version": "5.12.1", + "resolved": "https://registry.npmjs.org/@redis/client/-/client-5.12.1.tgz", + "integrity": "sha512-7aPGWeqA3uFm43o19umzdl16CEjK/JQGtSXVPevplTaOU3VJA/rseBC1QvYUz9lLDIMBimc4SW/zrW4S89BaCA==", + "license": "MIT", + "dependencies": { + "cluster-key-slot": "1.1.2" + }, + "engines": { + "node": ">= 18.19.0" + }, + "peerDependencies": { + "@node-rs/xxhash": "^1.1.0", + "@opentelemetry/api": ">=1 <2" + }, + "peerDependenciesMeta": { + "@node-rs/xxhash": { + "optional": true + }, + "@opentelemetry/api": { + "optional": true + } + } + }, + "node_modules/redis/node_modules/@redis/json": { + "version": "5.12.1", + "resolved": "https://registry.npmjs.org/@redis/json/-/json-5.12.1.tgz", + "integrity": "sha512-eOze75esLve4vfqDel7aMX08CNaiLLQS2fV8mpRN9NxPe1rVR4vQyYiW/OgtGUysF6QOr9ANhfxABKNOJfXdKg==", + "license": "MIT", + "engines": { + "node": ">= 18.19.0" + }, + "peerDependencies": { + "@redis/client": "^5.12.1" + } + }, + "node_modules/redis/node_modules/@redis/search": { + "version": "5.12.1", + "resolved": "https://registry.npmjs.org/@redis/search/-/search-5.12.1.tgz", + "integrity": "sha512-ItlxbxC9cKI6IU1TLWoczwJCRb6TdmkEpWv05UrPawqaAnWGRu3rcIqsc5vN483T2fSociuyV1UkWIL5I4//2w==", + "license": "MIT", + "engines": { + "node": ">= 18.19.0" + }, + "peerDependencies": { + "@redis/client": "^5.12.1" + } + }, + "node_modules/redis/node_modules/@redis/time-series": { + "version": "5.12.1", + "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-5.12.1.tgz", + "integrity": "sha512-c6JL6E3EcZJuNqKFz+KM+l9l5mpcQiKvTwgA3blt5glWJ8hjDk0yeHN3beE/MpqYIQ8UEX44ItQzgkE/gCBELQ==", + "license": "MIT", + "engines": { + "node": ">= 18.19.0" + }, + "peerDependencies": { + "@redis/client": "^5.12.1" + } + }, "node_modules/reflect-metadata": { "version": "0.1.14", "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.1.14.tgz", diff --git a/package.json b/package.json index f66f4173..bac11a6c 100644 --- a/package.json +++ b/package.json @@ -26,6 +26,7 @@ "db:studio": "prisma studio" }, "dependencies": { + "@nestjs/cache-manager": "^3.1.1", "@nestjs/common": "^10.3.0", "@nestjs/config": "^3.1.1", "@nestjs/core": "^10.3.0", @@ -34,6 +35,8 @@ "@nestjs/swagger": "^7.1.16", "@prisma/client": "^6.19.2", "bcrypt": "^6.0.0", + "cache-manager": "^7.2.8", + "cache-manager-redis-store": "^3.0.1", "class-transformer": "^0.5.1", "class-validator": "^0.14.1", "csv-parse": "^6.2.1", @@ -42,6 +45,7 @@ "passport": "^0.7.0", "passport-jwt": "^4.0.1", "pg": "^8.11.3", + "redis": "^5.12.1", "reflect-metadata": "^0.1.13", "rxjs": "^7.8.1", "swagger-ui-express": "^5.0.1" diff --git a/src/app.module.ts b/src/app.module.ts index 4371526d..258f2230 100644 --- a/src/app.module.ts +++ b/src/app.module.ts @@ -9,6 +9,7 @@ import { PropertiesModule } from './properties/properties.module'; import { PrismaModule } from './database/prisma.module'; import { VersioningModule } from './versioning/versioning.module'; import { ApiDocumentationModule } from './config/api-documentation.module'; +import { CacheModuleConfig } from './cache/cache.module'; import { AppController } from './app.controller'; @Module({ @@ -17,6 +18,7 @@ import { AppController } from './app.controller'; isGlobal: true, envFilePath: ['.env.local', '.env'], }), + CacheModuleConfig, PrismaModule, VersioningModule, ApiDocumentationModule, diff --git a/src/cache/cache-metrics.interceptor.ts b/src/cache/cache-metrics.interceptor.ts new file mode 100644 index 00000000..548ee1ea --- /dev/null +++ b/src/cache/cache-metrics.interceptor.ts @@ -0,0 +1,25 @@ +/** + * Cache Metrics Interceptor + * Automatically tracks cache performance metrics + */ + +import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common'; +import { Observable } from 'rxjs'; +import { tap } from 'rxjs/operators'; +import { CacheMonitoringService } from './cache-monitoring.service'; + +@Injectable() +export class CacheMetricsInterceptor implements NestInterceptor { + constructor(private cacheMonitoringService: CacheMonitoringService) {} + + intercept(context: ExecutionContext, next: CallHandler): Observable { + const startTime = Date.now(); + + return next.handle().pipe( + tap(() => { + const responseTime = Date.now() - startTime; + this.cacheMonitoringService.recordResponseTime(responseTime); + }), + ); + } +} diff --git a/src/cache/cache-monitoring.service.ts b/src/cache/cache-monitoring.service.ts new file mode 100644 index 00000000..8c502606 --- /dev/null +++ b/src/cache/cache-monitoring.service.ts @@ -0,0 +1,131 @@ +/** + * Cache Monitoring Service + * Monitors cache performance, hits/misses, and health + */ + +import { Injectable, Logger } from '@nestjs/common'; + +export interface CacheMetrics { + hits: number; + misses: number; + hitRate: number; + totalRequests: number; + avgResponseTime: number; + timestamp: Date; +} + +export interface CacheHealthStatus { + isConnected: boolean; + memoryUsage: number; + keysCount: number; + uptime: number; + commandsProcessed: number; +} + +@Injectable() +export class CacheMonitoringService { + private readonly logger = new Logger(CacheMonitoringService.name); + + private metrics = { + hits: 0, + misses: 0, + totalRequests: 0, + responseTimes: [] as number[], + }; + + /** + * Record cache hit + */ + recordHit(): void { + this.metrics.hits++; + this.metrics.totalRequests++; + } + + /** + * Record cache miss + */ + recordMiss(): void { + this.metrics.misses++; + this.metrics.totalRequests++; + } + + /** + * Record response time + */ + recordResponseTime(timeMs: number): void { + this.metrics.responseTimes.push(timeMs); + // Keep only last 1000 measurements + if (this.metrics.responseTimes.length > 1000) { + this.metrics.responseTimes.shift(); + } + } + + /** + * Get current cache metrics + */ + getMetrics(): CacheMetrics { + const hitRate = + this.metrics.totalRequests > 0 + ? (this.metrics.hits / this.metrics.totalRequests) * 100 + : 0; + + const avgResponseTime = + this.metrics.responseTimes.length > 0 + ? this.metrics.responseTimes.reduce((a, b) => a + b, 0) / + this.metrics.responseTimes.length + : 0; + + return { + hits: this.metrics.hits, + misses: this.metrics.misses, + hitRate: parseFloat(hitRate.toFixed(2)), + totalRequests: this.metrics.totalRequests, + avgResponseTime: parseFloat(avgResponseTime.toFixed(2)), + timestamp: new Date(), + }; + } + + /** + * Reset metrics + */ + resetMetrics(): void { + this.metrics = { + hits: 0, + misses: 0, + totalRequests: 0, + responseTimes: [], + }; + this.logger.log('Cache metrics reset'); + } + + /** + * Get cache alerts based on performance + */ + getAlerts(): string[] { + const alerts: string[] = []; + const metrics = this.getMetrics(); + + // Alert if hit rate is too low + if (metrics.hitRate < 30 && metrics.totalRequests > 100) { + alerts.push(`⚠️ Low cache hit rate: ${metrics.hitRate}%`); + } + + // Alert if average response time is high + if (metrics.avgResponseTime > 100) { + alerts.push(`⚠️ High average response time: ${metrics.avgResponseTime}ms`); + } + + return alerts; + } + + /** + * Log cache performance summary + */ + logSummary(): void { + const metrics = this.getMetrics(); + this.logger.log( + `Cache Performance - Hits: ${metrics.hits}, Misses: ${metrics.misses}, ` + + `Hit Rate: ${metrics.hitRate}%, Avg Response: ${metrics.avgResponseTime}ms`, + ); + } +} diff --git a/src/cache/cache-warming.service.ts b/src/cache/cache-warming.service.ts new file mode 100644 index 00000000..5f694bab --- /dev/null +++ b/src/cache/cache-warming.service.ts @@ -0,0 +1,124 @@ +/** + * Cache Warming Service + * Pre-loads frequently accessed data on startup + */ + +import { Injectable, Logger, OnModuleInit } from '@nestjs/common'; +import { CacheService } from './cache.service'; +import { CACHE_KEYS, CACHE_TTL } from './cache.config'; + +@Injectable() +export class CacheWarmingService implements OnModuleInit { + private readonly logger = new Logger(CacheWarmingService.name); + + constructor(private cacheService: CacheService) {} + + async onModuleInit(): Promise { + if (process.env.CACHE_WARMING_ENABLED === 'true') { + this.logger.log('Starting cache warming...'); + await this.warmCache(); + } + } + + /** + * Warm up cache with frequently accessed data + */ + private async warmCache(): Promise { + try { + // Warm up static/system data that doesn't change often + await this.warmSystemCache(); + + // Schedule periodic cache warming + if (process.env.CACHE_WARMING_INTERVAL) { + const interval = parseInt(process.env.CACHE_WARMING_INTERVAL, 10); + setInterval(() => this.warmCache(), interval); + this.logger.log(`Cache warming scheduled every ${interval}ms`); + } + } catch (error) { + this.logger.error('Error warming cache:', error); + } + } + + /** + * Warm system cache + */ + private async warmSystemCache(): Promise { + try { + // Add system-level cache warming here + // Example: popular properties, top-rated users, etc. + + this.logger.log('System cache warming completed'); + } catch (error) { + this.logger.error('Error warming system cache:', error); + } + } + + /** + * Warm specific user cache + */ + async warmUserCache(userId: string, userData: any): Promise { + try { + await this.cacheService.set( + CACHE_KEYS.USER_BY_ID(userId), + userData, + CACHE_TTL.USER_PROFILE, + ); + this.logger.debug(`User cache warmed for ${userId}`); + } catch (error) { + this.logger.error(`Error warming user cache for ${userId}:`, error); + } + } + + /** + * Warm dashboard cache + */ + async warmDashboardCache( + userId: string, + dashboardData: any, + ): Promise { + try { + await this.cacheService.set( + CACHE_KEYS.DASHBOARD_STATS(userId), + dashboardData, + CACHE_TTL.DASHBOARD_STATS, + ); + this.logger.debug(`Dashboard cache warmed for ${userId}`); + } catch (error) { + this.logger.error(`Error warming dashboard cache for ${userId}:`, error); + } + } + + /** + * Warm trust score leaderboard + */ + async warmLeaderboardCache(leaderboardData: any): Promise { + try { + await this.cacheService.set( + CACHE_KEYS.TRUST_SCORES_LEADERBOARD, + leaderboardData, + CACHE_TTL.LEADERBOARD, + ); + this.logger.debug('Leaderboard cache warmed'); + } catch (error) { + this.logger.error('Error warming leaderboard cache:', error); + } + } + + /** + * Warm featured properties cache + */ + async warmFeaturedPropertiesCache( + propertiesData: any, + ): Promise { + try { + await this.cacheService.set( + CACHE_KEYS.PROPERTIES_FEATURED, + propertiesData, + CACHE_TTL.FEATURED_PROPERTIES, + ); + this.logger.debug('Featured properties cache warmed'); + } catch (error) { + this.logger.error('Error warming featured properties cache:', error); + } + } +} diff --git a/src/cache/cache.config.ts b/src/cache/cache.config.ts new file mode 100644 index 00000000..6673e3b6 --- /dev/null +++ b/src/cache/cache.config.ts @@ -0,0 +1,142 @@ +/** + * Redis Cache Configuration + * Comprehensive caching setup with custom strategies + */ + +import { CacheModuleOptions } from '@nestjs/cache-manager'; +import * as redisStore from 'cache-manager-redis-store'; + +export const REDIS_CONFIG: CacheModuleOptions = { + isGlobal: true, + store: redisStore as any, + host: process.env.REDIS_HOST || 'localhost', + port: parseInt(process.env.REDIS_PORT || '6379', 10), + password: process.env.REDIS_PASSWORD, + db: parseInt(process.env.REDIS_DB || '0', 10), + ttl: 600, // Default TTL: 10 minutes +}; + +/** + * Cache key constants + */ +export const CACHE_KEYS = { + // User cache keys + USER_BY_ID: (id: string) => `user:${id}`, + USER_BY_EMAIL: (email: string) => `user:email:${email}`, + USERS_LIST: 'users:list', + USERS_SEARCH: (query: string) => `users:search:${query}`, + + // Property cache keys + PROPERTY_BY_ID: (id: string) => `property:${id}`, + PROPERTIES_LIST: 'properties:list', + PROPERTIES_SEARCH: (query: string) => `properties:search:${query}`, + PROPERTIES_FEATURED: 'properties:featured', + + // Dashboard cache keys + DASHBOARD_STATS: (userId: string) => `dashboard:stats:${userId}`, + DASHBOARD_ANALYTICS: (userId: string) => `dashboard:analytics:${userId}`, + + // Trust score cache keys + TRUST_SCORE: (userId: string) => `trust-score:${userId}`, + TRUST_SCORES_LEADERBOARD: 'trust-scores:leaderboard', + + // Session cache keys + SESSION_BY_ID: (id: string) => `session:${id}`, + SESSIONS_BY_USER: (userId: string) => `sessions:user:${userId}`, + + // Authentication cache keys + AUTH_TOKENS: (userId: string) => `auth:tokens:${userId}`, + API_KEY_VALID: (key: string) => `api-key:valid:${key}`, + + // Email verification cache keys + EMAIL_VERIFICATION: (email: string) => `email-verify:${email}`, + + // Rate limiting cache keys + RATE_LIMIT_LOGIN: (email: string) => `rate-limit:login:${email}`, + RATE_LIMIT_API: (apiKey: string) => `rate-limit:api:${apiKey}`, +}; + +/** + * Cache TTL configurations (in seconds) + */ +export const CACHE_TTL = { + // Short term cache (1-5 minutes) + SHORT: 300, + + // Medium term cache (5-15 minutes) + MEDIUM: 900, + + // Long term cache (1 hour) + LONG: 3600, + + // Very long cache (1 day) + VERY_LONG: 86400, + + // Trust score specific + TRUST_SCORE: 3600, // 1 hour + LEADERBOARD: 1800, // 30 minutes + + // Dashboard specific + DASHBOARD_STATS: 600, // 10 minutes + DASHBOARD_ANALYTICS: 1800, // 30 minutes + + // Featured properties + FEATURED_PROPERTIES: 3600, // 1 hour + + // Search results (shorter, as data changes frequently) + SEARCH_RESULTS: 300, // 5 minutes + + // User profile + USER_PROFILE: 1800, // 30 minutes + + // Session data + SESSION: 7200, // 2 hours + + // Email verification + EMAIL_VERIFICATION: 600, // 10 minutes + + // Rate limiting + RATE_LIMIT: 900, // 15 minutes +}; + +/** + * Cache tags for grouped invalidation + */ +export const CACHE_TAGS = { + USERS: 'users', + PROPERTIES: 'properties', + DASHBOARD: 'dashboard', + TRUST_SCORE: 'trust-score', + SESSIONS: 'sessions', + AUTHENTICATION: 'authentication', + EMAIL: 'email', + RATE_LIMIT: 'rate-limit', +}; + +/** + * Get Redis connection string + */ +export function getRedisConnectionString(): string { + const password = process.env.REDIS_PASSWORD ? `${process.env.REDIS_PASSWORD}@` : ''; + const host = process.env.REDIS_HOST || 'localhost'; + const port = process.env.REDIS_PORT || '6379'; + const db = process.env.REDIS_DB || '0'; + + return `redis://${password}${host}:${port}/${db}`; +} + +/** + * Get Redis configuration from environment + */ +export function getRedisConfig() { + return { + host: process.env.REDIS_HOST || 'localhost', + port: parseInt(process.env.REDIS_PORT || '6379', 10), + password: process.env.REDIS_PASSWORD || undefined, + db: parseInt(process.env.REDIS_DB || '0', 10), + retryStrategy: (times: number) => { + const delay = Math.min(times * 50, 2000); + return delay; + }, + }; +} diff --git a/src/cache/cache.decorator.ts b/src/cache/cache.decorator.ts new file mode 100644 index 00000000..1f61b25a --- /dev/null +++ b/src/cache/cache.decorator.ts @@ -0,0 +1,20 @@ +/** + * Cache Decorators + * Decorators for easy caching in controllers and services + */ + +import { Inject } from '@nestjs/common'; +import { CacheService } from './cache.service'; +import { CACHE_TTL } from './cache.config'; + +/** + * Decorator to inject CacheService + */ +export function InjectCacheService() { + return Inject(CacheService); +} + +/** + * Note: For method-level caching, use NestJS @Cacheable decorator + * or implement within your service methods directly using CacheService + */ diff --git a/src/cache/cache.module.ts b/src/cache/cache.module.ts new file mode 100644 index 00000000..470da77f --- /dev/null +++ b/src/cache/cache.module.ts @@ -0,0 +1,30 @@ +/** + * Cache Module + * Comprehensive caching layer with Redis, monitoring, and warming + */ + +import { Module, Global } from '@nestjs/common'; +import { CacheModule as NestCacheModule } from '@nestjs/cache-manager'; +import { REDIS_CONFIG } from './cache.config'; +import { CacheService } from './cache.service'; +import { CacheMonitoringService } from './cache-monitoring.service'; +import { CacheWarmingService } from './cache-warming.service'; +import { CacheMetricsInterceptor } from './cache-metrics.interceptor'; + +@Global() +@Module({ + imports: [NestCacheModule.register(REDIS_CONFIG)], + providers: [ + CacheService, + CacheMonitoringService, + CacheWarmingService, + CacheMetricsInterceptor, + ], + exports: [ + CacheService, + CacheMonitoringService, + CacheWarmingService, + CacheMetricsInterceptor, + ], +}) +export class CacheModuleConfig {} diff --git a/src/cache/cache.service.ts b/src/cache/cache.service.ts new file mode 100644 index 00000000..c16e9e19 --- /dev/null +++ b/src/cache/cache.service.ts @@ -0,0 +1,273 @@ +/** + * Cache Service + * Manages cache operations with custom strategies and invalidation + */ + +import { Inject, Injectable, Logger } from '@nestjs/common'; +import { CACHE_MANAGER } from '@nestjs/cache-manager'; +import { Cache } from 'cache-manager'; +import { CACHE_KEYS, CACHE_TTL, CACHE_TAGS } from './cache.config'; + +@Injectable() +export class CacheService { + private readonly logger = new Logger(CacheService.name); + private cacheTagMap = new Map>(); + + constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {} + + /** + * Get cache entry + */ + async get(key: string): Promise { + try { + const value = await this.cacheManager.get(key); + if (value) { + this.logger.debug(`Cache HIT: ${key}`); + } else { + this.logger.debug(`Cache MISS: ${key}`); + } + return value; + } catch (error) { + this.logger.error(`Error getting cache key ${key}:`, error); + return undefined; + } + } + + /** + * Set cache entry + */ + async set( + key: string, + value: T, + ttl: number = CACHE_TTL.MEDIUM, + tag?: string, + ): Promise { + try { + await this.cacheManager.set(key, value, ttl * 1000); + if (tag) { + this.tagKey(tag, key); + } + this.logger.debug(`Cache SET: ${key} (TTL: ${ttl}s)`); + } catch (error) { + this.logger.error(`Error setting cache key ${key}:`, error); + } + } + + /** + * Delete cache entry + */ + async del(key: string): Promise { + try { + await this.cacheManager.del(key); + this.logger.debug(`Cache DELETED: ${key}`); + } catch (error) { + this.logger.error(`Error deleting cache key ${key}:`, error); + } + } + + /** + * Delete multiple cache entries + */ + async delMultiple(keys: string[]): Promise { + try { + await Promise.all(keys.map((key) => this.cacheManager.del(key))); + this.logger.debug(`Cache DELETED: ${keys.length} keys`); + } catch (error) { + this.logger.error(`Error deleting multiple cache keys:`, error); + } + } + + /** + * Clear all cache + */ + async clear(): Promise { + try { + // Use reset from underlying store if available + const store = (this.cacheManager as any).store; + if (store.reset) { + await store.reset(); + } else if (store.clear) { + await store.clear(); + } + this.cacheTagMap.clear(); + this.logger.log('All cache cleared'); + } catch (error) { + this.logger.error('Error clearing cache:', error); + } + } + + /** + * Get or set cache (cache-aside pattern) + */ + async getOrSet( + key: string, + factory: () => Promise, + ttl: number = CACHE_TTL.MEDIUM, + tag?: string, + ): Promise { + try { + // Try to get from cache + let value = await this.get(key); + + // If not in cache, fetch and cache it + if (value === undefined) { + value = await factory(); + await this.set(key, value, ttl, tag); + } + + return value; + } catch (error) { + this.logger.error(`Error in getOrSet for key ${key}:`, error); + throw error; + } + } + + /** + * Invalidate cache by tag + */ + async invalidateByTag(tag: string): Promise { + try { + const keys = this.cacheTagMap.get(tag); + if (keys && keys.size > 0) { + await this.delMultiple(Array.from(keys)); + this.cacheTagMap.delete(tag); + } + this.logger.debug(`Cache invalidated by tag: ${tag}`); + } catch (error) { + this.logger.error(`Error invalidating cache by tag ${tag}:`, error); + } + } + + /** + * Tag a cache key for grouped invalidation + */ + private tagKey(tag: string, key: string): void { + if (!this.cacheTagMap.has(tag)) { + this.cacheTagMap.set(tag, new Set()); + } + this.cacheTagMap.get(tag)!.add(key); + } + + /** + * Invalidate user-related cache + */ + async invalidateUserCache(userId: string): Promise { + const keys = [ + CACHE_KEYS.USER_BY_ID(userId), + CACHE_KEYS.DASHBOARD_STATS(userId), + CACHE_KEYS.DASHBOARD_ANALYTICS(userId), + CACHE_KEYS.TRUST_SCORE(userId), + CACHE_KEYS.SESSIONS_BY_USER(userId), + CACHE_KEYS.AUTH_TOKENS(userId), + ]; + await this.delMultiple(keys); + } + + /** + * Invalidate property-related cache + */ + async invalidatePropertyCache(propertyId?: string): Promise { + const keys = [ + CACHE_KEYS.PROPERTIES_LIST, + CACHE_KEYS.PROPERTIES_FEATURED, + ]; + if (propertyId) { + keys.push(CACHE_KEYS.PROPERTY_BY_ID(propertyId)); + } + await this.delMultiple(keys); + } + + /** + * Invalidate dashboard cache + */ + async invalidateDashboardCache(userId: string): Promise { + const keys = [ + CACHE_KEYS.DASHBOARD_STATS(userId), + CACHE_KEYS.DASHBOARD_ANALYTICS(userId), + ]; + await this.delMultiple(keys); + } + + /** + * Invalidate trust score cache + */ + async invalidateTrustScoreCache(userId?: string): Promise { + const keys = [CACHE_KEYS.TRUST_SCORES_LEADERBOARD]; + if (userId) { + keys.push(CACHE_KEYS.TRUST_SCORE(userId)); + } + await this.delMultiple(keys); + } + + /** + * Warm up cache for featured properties + */ + async warmFeaturedPropertiesCache( + factory: () => Promise, + ): Promise { + try { + const data = await factory(); + await this.set( + CACHE_KEYS.PROPERTIES_FEATURED, + data, + CACHE_TTL.FEATURED_PROPERTIES, + CACHE_TAGS.PROPERTIES, + ); + this.logger.log('Featured properties cache warmed'); + } catch (error) { + this.logger.error('Error warming featured properties cache:', error); + } + } + + /** + * Warm up cache for trust score leaderboard + */ + async warmTrustScoreLeaderboardCache( + factory: () => Promise, + ): Promise { + try { + const data = await factory(); + await this.set( + CACHE_KEYS.TRUST_SCORES_LEADERBOARD, + data, + CACHE_TTL.LEADERBOARD, + CACHE_TAGS.TRUST_SCORE, + ); + this.logger.log('Trust score leaderboard cache warmed'); + } catch (error) { + this.logger.error('Error warming trust score leaderboard cache:', error); + } + } + + /** + * Get cache statistics + */ + async getStats(): Promise { + try { + const info = (await (this.cacheManager as any).store.getClient().info?.()) || {}; + return { + connected: true, + taggedKeys: this.cacheTagMap.size, + redisInfo: info, + }; + } catch (error) { + this.logger.error('Error getting cache stats:', error); + return { + connected: false, + error: error instanceof Error ? error.message : 'Unknown error', + }; + } + } + + /** + * Check if Redis is connected + */ + async isConnected(): Promise { + try { + await this.get('__health_check__'); + return true; + } catch { + return false; + } + } +} diff --git a/src/main.ts b/src/main.ts index d96ccc13..7ea1f59f 100644 --- a/src/main.ts +++ b/src/main.ts @@ -3,6 +3,8 @@ import { Logger, ValidationPipe } from '@nestjs/common'; import { AppModule } from './app.module'; import { VersionHeaderInterceptor } from './versioning/version-header.interceptor'; import { DeprecationWarningInterceptor } from './versioning/deprecation-warning.interceptor'; +import { CacheMetricsInterceptor } from './cache/cache-metrics.interceptor'; +import { CacheMonitoringService } from './cache/cache-monitoring.service'; import { setupSwagger } from './config/swagger.config'; async function bootstrap() { @@ -30,6 +32,10 @@ async function bootstrap() { // Apply deprecation warning interceptor app.useGlobalInterceptors(new DeprecationWarningInterceptor(app.get('Reflector'))); + // Apply cache metrics interceptor + const cacheMonitoringService = app.get(CacheMonitoringService); + app.useGlobalInterceptors(new CacheMetricsInterceptor(cacheMonitoringService)); + // Setup Swagger documentation setupSwagger(app); @@ -39,5 +45,6 @@ async function bootstrap() { logger.log(`API Versioning enabled. Supported versions: v1, v2`); logger.log(`📚 Swagger UI available at http://localhost:${port}/api/docs`); logger.log(`📋 OpenAPI spec available at http://localhost:${port}/api/openapi.json`); + logger.log(`💾 Redis Caching enabled`); } bootstrap();