Merge branch 'cache-ttl-decorate' of https://github.com/joeyslack/nest into joeyslack-cache-ttl-decorate

Author: kamilmysliwiec

packages/common/cache/cache.constants.ts

@@ -1,3 +1,4 @@
 export const CACHE_MANAGER = 'CACHE_MANAGER';
 export const CACHE_MODULE_OPTIONS = 'CACHE_MODULE_OPTIONS';
 export const CACHE_KEY_METADATA = 'cache_module:cache_key';
+export const CACHE_TTL_METADATA = 5;

packages/common/cache/decorators/cache-ttl.decorator.ts

@@ -0,0 +1,15 @@
+import { SetMetadata } from '../../decorators';
+import { CACHE_TTL_METADATA } from '../cache.constants';
+
+/**
+ * Decorator that sets the cache ttl setting the duration for cache expiration.
+ *
+ * For example: `@CacheTTL(5)`
+ *
+ * @param ttl number set the cache expiration time
+ *
+ * @see [Caching](https://docs.nestjs.com/techniques/caching)
+ *
+ * @publicApi
+ */
+export const CacheTTL = (ttl: number) => SetMetadata(CACHE_TTL_METADATA, ttl);

packages/common/cache/decorators/index.ts

@@ -1 +1,2 @@
 export * from './cache-key.decorator';
+export * from './cache-ttl.decorator';

packages/common/cache/interceptors/cache.interceptor.ts

@@ -7,7 +7,7 @@ import {
   HttpServer,
   NestInterceptor,
 } from '../../interfaces';
-import { CACHE_KEY_METADATA, CACHE_MANAGER } from '../cache.constants';
+import { CACHE_KEY_METADATA, CACHE_TTL_METADATA, CACHE_MANAGER } from '../cache.constants';
 
 const HTTP_ADAPTER_HOST = 'HttpAdapterHost';
 const REFLECTOR = 'Reflector';
@@ -32,6 +32,8 @@ export class CacheInterceptor implements NestInterceptor {
     next: CallHandler,
   ): Promise<Observable<any>> {
     const key = this.trackBy(context);
+    const ttl = this.reflector.get(CACHE_TTL_METADATA, context.getHandler()) || null;
+
     if (!key) {
       return next.handle();
     }
@@ -40,9 +42,13 @@ export class CacheInterceptor implements NestInterceptor {
       if (value) {
         return of(value);
       }
+
       return next
         .handle()
-        .pipe(tap(response => this.cacheManager.set(key, response)));
+        .pipe(tap(response => {
+          const args = ttl ? [key, response, {ttl}] : [key, response];
+          this.cacheManager.set.apply(this.cacheManager, args);
+        }));
     } catch {
       return next.handle();
     }
@@ -51,10 +57,12 @@ export class CacheInterceptor implements NestInterceptor {
   trackBy(context: ExecutionContext): string | undefined {
     const httpAdapter = this.httpAdapterHost.httpAdapter;
     const isHttpApp = httpAdapter && !!httpAdapter.getRequestMethod;
+    const cacheMetadata = this.reflector.get(CACHE_KEY_METADATA, context.getHandler());
 
-    if (!isHttpApp) {
-      return this.reflector.get(CACHE_KEY_METADATA, context.getHandler());
+    if (!isHttpApp || cacheMetadata) {
+      return cacheMetadata;
     }
+
     const request = context.getArgByIndex(0);
     if (httpAdapter.getRequestMethod(request) !== 'GET') {
       return undefined;

packages/common/package-lock.json

@@ -0,0 +1,36 @@
+import { expect } from 'chai';
+import { CacheKey, CacheInterceptor, CacheTTL } from '../../cache';
+import { CACHE_KEY_METADATA, CACHE_TTL_METADATA } from '../../cache/cache.constants';
+import { UseInterceptors } from '../../decorators';
+import { Controller } from '../../decorators/core/controller.decorator';
+
+describe('@Cache', () => {
+  @Controller('test')
+  @CacheKey('/a_different_cache_key')
+  @CacheTTL(99999)
+  @UseInterceptors(CacheInterceptor)
+  class TestAll {}
+
+  @Controller()
+  @UseInterceptors(CacheInterceptor)
+  @CacheKey('/a_different_cache_key')
+  class TestKey {}
+
+  @Controller()
+  @UseInterceptors(CacheInterceptor)
+  @CacheTTL(99999)
+  class TestTTL {}
+
+  it('should override global defaults for CacheKey and CacheTTL', () => {
+    expect(Reflect.getMetadata(CACHE_KEY_METADATA, TestAll)).to.be.eql('/a_different_cache_key') &&
+    expect(Reflect.getMetadata(CACHE_TTL_METADATA, TestAll)).to.be.greaterThan(9999);
+  });
+
+  it('should override only the TTL', () => {
+    expect(Reflect.getMetadata(CACHE_TTL_METADATA, TestTTL)).to.be.greaterThan(9999);
+  });
+
+  it('should override only the Key', () => {
+    expect(Reflect.getMetadata(CACHE_KEY_METADATA, TestKey)).to.be.eql('/a_different_cache_key');
+  });
+});