feat(caching): Add file system cache (#316)

Author: JForsaken

.gitignore

@@ -3,6 +3,9 @@ dist
 tmp
 /out-tsc
 
+# cache
+.cache
+
 # dependencies
 node_modules
 /.pnp

package.json

@@ -27,6 +27,7 @@
     "bitcoin-address-validation": "^2.2.1",
     "esbuild": "^0.14.27",
     "esbuild-runner": "^2.2.1",
+    "file-system-cache": "^1.0.5",
     "fs-extra": "^10.0.1",
     "inquirer": "^8.2.2",
     "lodash": "^4.17.21",

pnpm-lock.yaml

@@ -1,6 +1,6 @@
-import { CACHE_MANAGER, Inject, Injectable, Logger, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import { Inject, Injectable, Logger, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
 import { DiscoveryService, MetadataScanner, Reflector } from '@nestjs/core';
-import { Cache } from 'cache-manager';
+import Cache from 'file-system-cache';
 
 import {
   CacheOnIntervalOptions,
@@ -13,15 +13,20 @@ export class CacheOnIntervalService implements OnModuleInit, OnModuleDestroy {
   private readonly intervals: NodeJS.Timer[] = [];
   private readonly registeredCacheKeys: string[] = [];
   private logger = new Logger(CacheOnIntervalService.name);
+  private cacheManager = Cache({
+    basePath: './.cache',
+    ns: '@CacheOnInterval',
+  });
 
   constructor(
-    @Inject(CACHE_MANAGER) private readonly cacheManager: Cache,
     @Inject(DiscoveryService) private readonly discoveryService: DiscoveryService,
     @Inject(MetadataScanner) private readonly metadataScanner: MetadataScanner,
     @Inject(Reflector) private readonly reflector: Reflector,
   ) {}
 
-  onModuleInit() {
+  async onModuleInit() {
+    await this.cacheManager.load();
+
     const instanceWrappers = this.discoveryService.getProviders();
     instanceWrappers
       .filter(wrapper => wrapper.isDependencyTreeStatic() && !!wrapper.instance)

src/cache/cache-on-interval.service.ts

@@ -1,22 +1,27 @@
-import { CACHE_MANAGER, Inject, Injectable, Logger, OnModuleInit } from '@nestjs/common';
+import { Inject, Injectable, Logger, OnModuleInit } from '@nestjs/common';
 import { DiscoveryService, MetadataScanner, Reflector } from '@nestjs/core';
-import { Cache } from 'cache-manager';
+import Cache from 'file-system-cache';
 import { isNil } from 'lodash';
 
 import { CacheOptions, CACHE_KEY, CACHE_TTL } from './cache.decorator';
 
 @Injectable()
 export class CacheService implements OnModuleInit {
   private logger = new Logger(CacheService.name);
+  private cacheManager = Cache({
+    basePath: './.cache',
+    ns: '@Cache',
+  });
 
   constructor(
-    @Inject(CACHE_MANAGER) private readonly cacheManager: Cache,
     @Inject(DiscoveryService) private readonly discoveryService: DiscoveryService,
     @Inject(MetadataScanner) private readonly metadataScanner: MetadataScanner,
     @Inject(Reflector) private readonly reflector: Reflector,
   ) {}
 
-  onModuleInit() {
+  async onModuleInit() {
+    await this.cacheManager.load();
+
     const instanceWrappers = this.discoveryService.getProviders();
     instanceWrappers
       .filter(wrapper => wrapper.isDependencyTreeStatic() && !!wrapper.instance)

src/cache/cache.service.ts

@@ -22,7 +22,8 @@
     "baseUrl": "./src",
     "paths": {
       "~*": ["./*"]
-    }
+    },
+    "typeRoots": ["types", "node_modules/@types"]
   },
   "include": ["./src/**/*"]
 }

tsconfig.json

@@ -0,0 +1,15 @@
+declare module 'file-system-cache' {
+  interface CacheManager {
+    get(key: string): Promise<string>;
+    getSync(key: string): string;
+    set(key: string, value: string): Promise<void>;
+    setSync(key: string, value: string): void;
+    remove(key: string): Promise<void>;
+    clear(): Promise<void>;
+    load(): Promise<void>;
+  }
+
+  type factoryOpts = { basePath?: string; ns?: string };
+  function factory(opts?: factoryOpts): CacheManager;
+  export default factory;
+}