refactor: Move cache key prefix into CMCache

* Makes adding prefix cache provider agnostic
* Prepares for #115

Author: FoxxMD

src/Bot/ResourcesManager.ts

@@ -147,7 +147,7 @@ export class BotResourcesManager {
             } else if(res !== undefined && res.cache.equalProvider(candidateProvider)) {
                 opts.cache = res.cache;
             } else {
-                opts.cache = new CMCache(createCacheManager(candidateProvider), candidateProvider, false, opts.ttl, this.logger, candidateProvider.prefix);
+                opts.cache = new CMCache(createCacheManager(candidateProvider), candidateProvider, false, opts.ttl, this.logger);
                 await runMigrations(opts.cache.cache, opts.cache.logger, candidateProvider.prefix);
             }
 

src/Common/Cache/index.ts

@@ -23,7 +23,7 @@ export const buildCacheOptionsFromProvider = (provider: CacheProvider | any): Ca
     }
 }
 export const createCacheManager = (options: CacheOptions): Cache => {
-    const {store, max, ttl = 60, host = 'localhost', port, auth_pass, db, ...rest} = options;
+    const {store, max, ttl = 60, host = 'localhost', port, auth_pass, db, prefix, ...rest} = options;
     switch (store) {
         case 'none':
             return cacheManager.caching({store: 'none', max, ttl});
@@ -52,11 +52,11 @@ export class CMCache {
     providerOptions: CacheOptions;
     logger!: Logger;
 
-    constructor(cache: Cache, providerOptions: CacheOptions, defaultCache: boolean, ttls: Partial<StrongTTLConfig>, logger: Logger, prefix?: string) {
+    constructor(cache: Cache, providerOptions: CacheOptions, defaultCache: boolean, ttls: Partial<StrongTTLConfig>, logger: Logger) {
         this.cache = cache;
         this.providerOptions = providerOptions
-        this.prefix = prefix;
         this.isDefaultCache = defaultCache;
+        this.prefix = this.providerOptions.prefix ?? '';
 
         this.setLogger(logger);
 
@@ -176,22 +176,23 @@ export class CMCache {
     }
 
     del(key: string): Promise<any> {
-        return this.cache.del(key);
+        return this.cache.del(`${this.prefix}${key}`);
     }
 
     get<T>(key: string): Promise<T | undefined> {
-        return this.cache.get(key);
+        return this.cache.get(`${this.prefix}${key}`);
     }
 
     reset(): Promise<void> {
         return this.cache.reset();
     }
 
     set<T>(key: string, value: T, options?: CachingConfig): Promise<T> {
-        return this.cache.set(key, value, options);
+        return this.cache.set(`${this.prefix}${key}`, value, options);
     }
 
     wrap<T>(...args: WrapArgsType<T>[]): Promise<T> {
+        args[0] = `${this.prefix}${args[0]}`;
         return this.cache.wrap(...args);
     }
 

src/Common/interfaces.ts

@@ -791,6 +791,11 @@ export interface CacheOptions {
      * */
     max?: number
 
+    /**
+     * A prefix to add to all keys
+     * */
+    prefix?: string
+
     [key:string]: any
 }
 

src/Schema/App.json

@@ -1181,6 +1181,10 @@
                     ],
                     "type": "number"
                 },
+                "prefix": {
+                    "description": "A prefix to add to all keys",
+                    "type": "string"
+                },
                 "store": {
                     "$ref": "#/definitions/CacheProvider"
                 },

src/Schema/OperatorConfig.json

@@ -474,6 +474,10 @@
                     ],
                     "type": "number"
                 },
+                "prefix": {
+                    "description": "A prefix to add to all keys",
+                    "type": "string"
+                },
                 "store": {
                     "$ref": "#/definitions/CacheProvider"
                 },