exframe-cache-manager 2.0.5 → 2.0.7

package/Dockerfile

@@ -10,7 +10,7 @@ COPY ./package.json /app/package.json
 COPY . /app
 
 WORKDIR /app
-RUN yarn install
+RUN npm install
 RUN npm run peers
 
 # Override the command, to run the test instead of the application

package/index.js

@@ -1,13 +1,13 @@
 'use strict';
 
+const util = require('util');
+const { setTimeout: waitTimeout } = require('timers/promises');
 const CacheManager = require('cache-manager');
 const RedisStore = require('cache-manager-redis-store');
-const util = require('util');
 const { lazyInstrument } = require('exframe-metrics');
 const health = require('exframe-health');
 const service = require('exframe-service');
 const { generateShortId } = require('exframe-utilities');
-const { setTimeout: waitTimeout } = require('timers/promises');
 
 const db = 0;
 
@@ -54,8 +54,31 @@ function cachemanager(options) {
     /**
      *
      * @param {string} key
+     * @param {object} context
+     * @param {Options} options
      */
-    getItem(key) {
+
+    async getItem(context, key, { timeout } = {}) {
+      if (arguments.length === 1) {
+        // context = key, param order was switched in function def to preserve backwards compatability
+        return redisCache.get(context);
+      }
+
+      const controller = new AbortController();
+      if (timeout) {
+        const result = await Promise.race([
+          redisCache.get(key),
+          waitTimeout(timeout, false, { signal: controller.signal, ref: false })
+        ]);
+
+        if (!result) {
+          context.log.info('CACHE TIMEOUT ERROR');
+          return Promise.reject(new Error('Timed out attempting to retrieve item from cache.'));
+        }
+
+        controller.abort();
+        return result;
+      }
       return redisCache.get(key);
     },
 
@@ -168,7 +191,8 @@ function cachemanager(options) {
         } while (cursor !== '0');
       });
     },
-    redisClient
+    redisClient,
+    redisCache
   };
 
   health.add(`redis-${instance.id}`, async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exframe-cache-manager",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "Managing the cache",
   "main": "index.js",
   "config": {
@@ -46,5 +46,5 @@
     "url": "https://bitbucket.org/exzeo-usa/exframe",
     "directory": "packages/exframe-cache-manager"
   },
-  "gitHead": "9b41242e2d499ea24109ab29d51c76652ee03f43"
+  "gitHead": "d9641658b6e0f058726402b7fe6a859cfd4b11ab"
 }

package/test/cacheManager.test.js

@@ -4,6 +4,7 @@ const { expect } = require('chai');
 const sinon = require('sinon');
 const service = require('exframe-service');
 const health = require('exframe-health');
+const { setTimeout: waitTimeout } = require('timers/promises');
 const cacheManager = require('../index');
 
 const { prometheusClient } = service;
@@ -77,6 +78,36 @@ context('Test User Profile Middleware', () => {
         await app.flushCache({ log: { info: (info) => { console.log(info); } } }, cacheKey);
       });
 
+      it('validate the getItem function on the basis of key, including context', async () => {
+        await app.setItem(cacheKey, 'someValue');
+        const context = { log: { info: (info) => { console.log(info); } } };
+
+        const value = await app.getItem(context, cacheKey);
+        expect(value).to.eql('someValue');
+        const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('getItem'));
+        expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+        await app.flushCache({ log: { info: (info) => { console.log(info); } } }, cacheKey);
+      });
+
+      it('validate the getItem function, including optional context and timeout delay value', async () => {
+        const fake = async function (key) {
+          await waitTimeout(5000)
+          return 'finished';
+        }
+        const stub = sinon.stub(app.redisCache, "get").callsFake(fake)
+
+        await app.setItem(cacheKey, 'someValue');
+        const context = { log: { info: (info) => { console.log(info); } } };
+        try {
+          const value = await app.getItem(context, cacheKey, { timeout: 250 });
+          expect(value).to.eql('Request should have timed out');
+        } catch (err) {
+          expect(err.message).to.eql('Timed out attempting to retrieve item from cache.');
+        }
+        await app.flushCache(context, cacheKey);
+        stub.restore();
+      });
+
       it('validate the addSetItem function on the basis of key', async () => {
         const key = 'SetTestKey';
         await app.addSetItem(key, 'someSetValue');