chore(deps): support cache-manager v6

Author: zhx47

.eslintrc.js

@@ -21,5 +21,6 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-use-before-define': 'off',
     '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-require-imports': 'off',
   },
 };

lib/cache.module.ts

@@ -1,12 +1,13 @@
 import { DynamicModule, Module } from '@nestjs/common';
-import type { Cache as CoreCache } from 'cache-manager'
+import { Events } from 'cache-manager';
 import { CACHE_MANAGER } from './cache.constants';
 import { ConfigurableModuleClass } from './cache.module-definition';
 import { createCacheManager } from './cache.providers';
 import {
   CacheModuleAsyncOptions,
   CacheModuleOptions,
 } from './interfaces/cache-module.interface';
+import EventEmitter from 'node:events';
 
 /**
  * This is just the same as the `Cache` interface from `cache-manager` but you can
@@ -15,7 +16,41 @@ import {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
 export abstract class Cache {}
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
-export interface Cache extends CoreCache {}
+export interface Cache {
+  get: <T>(key: string) => Promise<T | null>;
+  mget: <T>(keys: string[]) => Promise<(Awaited<T> | null)[]>;
+  set: <T>(key: string, value: T, ttl?: number) => Promise<T>;
+  mset: <T>(
+    list: Array<{
+      key: string;
+      value: T;
+      ttl?: number;
+    }>,
+  ) => Promise<
+    {
+      key: string;
+      value: T;
+      ttl?: number;
+    }[]
+  >;
+  del: (key: string) => Promise<boolean>;
+  mdel: (keys: string[]) => Promise<boolean>;
+  clear: () => Promise<boolean>;
+  wrap: <T>(
+    key: string,
+    fnc: () => T | Promise<T>,
+    ttl?: number | ((value: T) => number),
+    refreshThreshold?: number,
+  ) => Promise<T>;
+  on: <E extends keyof Events>(
+    event: E,
+    listener: Events[E],
+  ) => EventEmitter<[never]>;
+  off: <E extends keyof Events>(
+    event: E,
+    listener: Events[E],
+  ) => EventEmitter<[never]>;
+}
 
 /**
  * Module that provides Nest cache-manager.
@@ -30,7 +65,7 @@ export interface Cache extends CoreCache {}
     {
       provide: Cache,
       useExisting: CACHE_MANAGER,
-    }
+    },
   ],
   exports: [CACHE_MANAGER, Cache],
 })

lib/cache.providers.ts

@@ -7,6 +7,7 @@ import {
   CacheManagerOptions,
   CacheStore,
 } from './interfaces/cache-manager.interface';
+import { Keyv, KeyvStoreAdapter } from 'keyv';
 
 /**
  * Creates a CacheManager Provider.
@@ -22,19 +23,41 @@ export function createCacheManager(): Provider {
         require('cache-manager'),
       );
       const cacheManagerIsv5OrGreater = 'memoryStore' in cacheManager;
+      const cacheManagerIsv6OrGreater = 'KeyvAdapter' in cacheManager;
       const cachingFactory = async (
         store: CacheManagerOptions['store'],
         options: Omit<CacheManagerOptions, 'store'>,
       ): Promise<Record<string, any>> => {
+        if (cacheManagerIsv6OrGreater) {
+          return store
+            ? cacheManager.createCache({
+                stores: [
+                  new Keyv(
+                    {
+                      store,
+                    },
+                    {
+                      ...defaultCacheOptions,
+                      ...options,
+                    },
+                  ),
+                ],
+              })
+            : cacheManager.createCache({
+                ...defaultCacheOptions,
+                ...options,
+              });
+        }
+
         if (!cacheManagerIsv5OrGreater) {
           return cacheManager.caching({
             ...defaultCacheOptions,
             ...{ ...options, store },
           });
         }
 
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        let cache: string | Function | CacheStore = 'memory';
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+        let cache: string | Function | CacheStore | KeyvStoreAdapter = 'memory';
         defaultCacheOptions.ttl *= 1000;
         if (typeof store === 'object') {
           if ('create' in store) {

lib/interceptors/cache.interceptor.ts

@@ -33,6 +33,7 @@ export class CacheInterceptor implements NestInterceptor {
   protected allowedMethods = ['GET'];
 
   private cacheManagerIsv5OrGreater: boolean;
+  private cacheManagerIsv6OrGreater: boolean;
 
   constructor(
     @Inject(CACHE_MANAGER) protected readonly cacheManager: any,
@@ -46,6 +47,7 @@ export class CacheInterceptor implements NestInterceptor {
       () => require('cache-manager'),
     );
     this.cacheManagerIsv5OrGreater = 'memoryStore' in cacheManagerPackage;
+    this.cacheManagerIsv6OrGreater = 'KeyvAdapter' in cacheManager;
   }
 
   async intercept(
@@ -78,7 +80,11 @@ export class CacheInterceptor implements NestInterceptor {
 
           const args = [key, response];
           if (!isNil(ttl)) {
-            args.push(this.cacheManagerIsv5OrGreater ? ttl : { ttl });
+            args.push(
+              this.cacheManagerIsv5OrGreater || this.cacheManagerIsv6OrGreater
+                ? ttl
+                : { ttl },
+            );
           }
 
           try {

lib/interfaces/cache-manager.interface.ts

@@ -1,3 +1,5 @@
+import { KeyvStoreAdapter } from 'keyv';
+
 export interface LiteralObject {
   [key: string]: any;
 }
@@ -70,7 +72,7 @@ export interface CacheManagerOptions {
    * [Different stores](https://docs.nestjs.com/techniques/caching#different-stores)
    * for more info.
    */
-  store?: string | CacheStoreFactory | CacheStore;
+  store?: string | CacheStoreFactory | CacheStore | KeyvStoreAdapter;
   /**
    * Time to live - amount of time that a response is cached before it
    * is deleted. Subsequent request will call through the route handler and refresh
@@ -83,4 +85,8 @@ export interface CacheManagerOptions {
    */
   max?: number;
   isCacheableValue?: (value: any) => boolean;
+  /**
+   * Add Cache Manager v6, Namespace for the current instance.
+   */
+  namespace?: string;
 }

package-lock.json

@@ -37,6 +37,7 @@
     "eslint-plugin-import": "2.30.0",
     "husky": "9.1.6",
     "jest": "29.7.0",
+    "keyv": "^5.0.3",
     "lint-staged": "15.2.10",
     "prettier": "3.3.3",
     "reflect-metadata": "0.2.2",

package.json

@@ -1,5 +1,5 @@
 import { Controller, Get, Inject } from '@nestjs/common';
-import { Cache } from 'cache-manager';
+import { Cache } from '../../../lib';
 import { CACHE_MANAGER } from '../../../lib';
 
 @Controller()

tests/src/async-register-extra-providers/async-register-extra.controller.ts

@@ -1,5 +1,5 @@
 import { Controller, Get, Inject } from '@nestjs/common';
-import { Cache } from 'cache-manager';
+import { Cache } from '../../../lib';
 import { CACHE_MANAGER } from '../../../lib';
 
 @Controller()

tests/src/async-register/async-register.controller.ts

@@ -1,5 +1,5 @@
 import { Controller, Get, Inject } from '@nestjs/common';
-import { Cache } from 'cache-manager';
+import { Cache } from '../../../lib';
 import { CACHE_MANAGER } from '../../../lib';
 
 @Controller()

tests/src/default-ttl/default-ttl.controller.ts

@@ -1,5 +1,5 @@
 import { Controller, Get, Inject } from '@nestjs/common';
-import { Cache } from 'cache-manager';
+import { Cache } from '../../../lib';
 import { CACHE_MANAGER } from '../../../lib';
 
 @Controller()