exframe-cache-manager 1.3.3 → 2.0.2

package/Dockerfile

@@ -7,11 +7,11 @@ RUN apk update && \
   addgroup -S docker && adduser -S -G docker docker
 
 COPY ./package.json /app/package.json
-WORKDIR /app
-RUN npm install && \
-  npm cache clean --force
-
 COPY . /app
 
+WORKDIR /app
+RUN yarn install
+RUN npm run peers
+
 # Override the command, to run the test instead of the application
 CMD ["npm", "run", "unit-test"]

package/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const CacheManager = require('cache-manager');
-const RedisStore = require('cache-manager-redis');
+const RedisStore = require('cache-manager-redis-store');
 const util = require('util');
 const { lazyInstrument } = require('exframe-metrics');
 
@@ -27,13 +27,25 @@ function cachemanager(options) {
 
   // @ts-ignore
   const redisStore = redisCache.store;
+  const redisClient = redisStore.getClient();
+  redisClient.setMaxListeners(0);
 
-  // need to expose the store's connection pool after it's created by the cache manager as it does not seem to have a way to pass it in
-  // if we use something besides redis, we'll have to tackle this differently
-  const cacheStorePool = Object.assign(redisStore._pool, { db });
-  cacheStorePool.setMaxListeners(0);
+  redisClient.on('error', (e) => {
+    console.log('Unhandled Redis Error', { errorDetails: e }); // eslint-disable-line
+  });
+
+  process.on('beforeExit', () => {
+    if (redisClient.connected) {
+      redisClient.removeAllListeners();
+      redisClient.end(true);
+    }
+  });
 
   const instance = {
+    get cacheStorePool() {
+      return redisClient;
+    },
+
     /**
      *
      * @param {string} key
@@ -100,33 +112,20 @@ function cachemanager(options) {
 
     close() {
       return new Promise(res => {
-        cacheStorePool.drain(res);
+        redisClient.removeAllListeners();
+        redisClient.end(true);
+        res();
       });
     },
 
     getClient() {
       return new Promise((resolve, reject) => {
-        cacheStorePool.acquireDb(async (connError, client) => {
-          let timeout;
-
-          if (connError) {
-            return reject(connError);
-          }
-
-          if (client.connected) {
-            return resolve(client);
-          }
-
-          client.once('ready', () => {
-            clearTimeout(timeout);
-            resolve(client);
-          });
+        if (redisClient.connected) {
+          return resolve(redisClient);
+        }
 
-          timeout = setTimeout(() => {
-            cacheStorePool.release(client);
-            reject(new Error('Timeout waiting for redis client connection'));
-          }, 10000);
-        }, db);
+        redisClient.on('ready', () => resolve(redisClient));
+        redisClient.on('error', (e) => reject(e));
       });
     },
 
@@ -135,17 +134,8 @@ function cachemanager(options) {
      * @param {(client: any) => any} fn
      */
     async processRedisCommands(fn) {
-      let client;
-      let result;
-
-      try {
-        client = await this.getClient();
-        result = await fn(client);
-      } finally {
-        if (client) {
-          cacheStorePool.release(client);
-        }
-      }
+      const client = await this.getClient();
+      const result = await fn(client);
 
       return result;
     },
@@ -173,7 +163,7 @@ function cachemanager(options) {
         } while (cursor !== '0');
       });
     },
-    cacheStorePool
+    redisClient
   };
 
   Object.keys(instance).forEach((key) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exframe-cache-manager",
-  "version": "1.3.3",
+  "version": "2.0.2",
   "description": "Managing the cache",
   "main": "index.js",
   "config": {
@@ -12,8 +12,9 @@
   "scripts": {
     "pretest": "npm-install-peers && npm run lint",
     "lint": "eslint ./",
+    "peers": "npm-install-peers",
     "test": "docker-compose -f docker-compose.yml up --abort-on-container-exit --exit-code-from exframe-cache-manager",
-    "unit-test": "./node_modules/.bin/nyc -r lcov --report-dir ./documentation/coverage -t ./documentation/coverage mocha --reporter $npm_package_config_reporter \"./test/**/*.test.js\""
+    "unit-test": "./node_modules/.bin/nyc -r lcov --report-dir ./documentation/coverage -t ./documentation/coverage mocha --exit --reporter $npm_package_config_reporter \"./test/**/*.test.js\""
   },
   "author": "Exzeo",
   "license": "ISC",
@@ -24,26 +25,25 @@
   },
   "dependencies": {
     "@types/cache-manager": "^3.4.2",
-    "@types/redis": "^2.8.32",
     "cache-manager": "^3.6.0",
-    "cache-manager-redis": "^0.6.0",
-    "exframe-metrics": "^1.1.0",
-    "redis": "^3.1.2"
+    "cache-manager-redis-store": "^2.0.0",
+    "exframe-metrics": "^1.1.0"
   },
   "devDependencies": {
-    "chai": "^4.3.4",
-    "eslint": "^8.3.0",
+    "chai": "*",
+    "eslint": "*",
     "eslint-config-exzeo": "*",
-    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-import": "*",
     "mocha": "*",
-    "mocha-exzeo-reporter": "0.0.3",
+    "mocha-exzeo-reporter": "*",
     "npm-install-peers": "*",
-    "nyc": "*"
+    "nyc": "*",
+    "sinon": "*"
   },
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/exzeo-usa/exframe",
     "directory": "packages/exframe-cache-manager"
   },
-  "gitHead": "ef87c842aa08c54cbcb03ee075db8463ebc8fd43"
+  "gitHead": "3ff1cd2d1bc50184f5aae8d1ea35e04e1cb718b2"
 }

package/test/cacheManager.test.js

@@ -105,7 +105,7 @@ context('Test User Profile Middleware', () => {
         const result = await app1.getItem(cacheKey);
         expect(result).to.not.be.ok();
       } catch (ex) {
-        expect(ex.message).to.be.equal('pool is draining and cannot accept work');
+        expect(ex.message).to.be.equal('GET can\'t be processed. The connection is already closed.');
         const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('close'));
         expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
       }
@@ -122,7 +122,6 @@ context('Test User Profile Middleware', () => {
     it('validate the cacheStorePool', () => {
       const catchepool = app.cacheStorePool;
       expect(app).to.not.eql(null);
-      expect(catchepool.db).to.eql(0);
       expect(catchepool._maxListeners).to.eql(0);
     });