exframe-cache-manager 1.1.3 → 1.3.1

package/.eslintignore

@@ -1,5 +1,5 @@
-node_modules
-test
-documentation
-dist
-debug.js
+node_modules
+test
+documentation
+dist
+debug.js

package/.eslintrc.json

@@ -1,24 +1,17 @@
-{
-  "env": {
-    "es6": true,
-    "node": true
-  },
-  "extends": "airbnb-base",
-  "rules": {
-    "comma-dangle": [2, "never"],
-    "consistent-return": [0],
-    "arrow-body-style": [1, "as-needed"],
-    "import/no-unresolved": [0],
-    "strict": [0, "global"],
-    "linebreak-style": ["error", "windows"],
-    "indent": 0,
-    "max-len": ["error", 200],
-    "no-param-reassign": ["error", { "props": false }],
-    "no-else-return": 0,
-    "eol-last": 0,
-    "no-useless-escape": 0,
-    "no-underscore-dangle": 0,
-    "no-fallthrough": 0,
-    "arrow-parens": "off"
-  }
-}
+{
+  "env": {
+    "es6": true,
+    "node": true
+  },
+  "extends": "airbnb-base",
+  "rules": {
+    "comma-dangle": ["error", "never"],
+    "strict": ["off", "global"] ,
+    "consistent-return": "off",
+    "linebreak-style": ["error", "windows"],
+    "max-len": ["error", 200],
+    "no-param-reassign": ["error", { "props": false }],
+    "no-underscore-dangle": "off",
+    "arrow-parens": "off"
+  }
+}

package/Dockerfile

@@ -1,17 +1,17 @@
-FROM node:8-alpine
-
-LABEL maintainer=Exzeo
-
-RUN apk update && \
-  apk --no-cache add bash libc6-compat && \
-  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
-
-# Override the command, to run the test instead of the application
-CMD ["npm", "run", "unit-test"]
+FROM node:14-alpine
+
+LABEL maintainer=Exzeo
+
+RUN apk update && \
+  apk --no-cache add bash libc6-compat && \
+  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
+
+# Override the command, to run the test instead of the application
+CMD ["npm", "run", "unit-test"]

package/README.md

@@ -1,2 +1,2 @@
-# exframe-cache-manager
-
+# exframe-cache-manager
+

package/docker-compose.yml

@@ -1,18 +1,17 @@
-version: "2"
-services:
-  exframe-cache-manager:
-    container_name: exframe-cache-manager
-    build:
-      context: .
-    volumes:
-      - .:/app
-      - /app/node_modules
-    depends_on:
-      - "redis"
-    environment:
-      - "HOST=redis"
-  redis:
-    image: "redis"
-    container_name: Redis
-    ports:
+version: "2"
+services:
+  exframe-cache-manager:
+    container_name: exframe-cache-manager
+    build:
+      context: .
+    volumes:
+      - .:/app
+    depends_on:
+      - "redis"
+    environment:
+      - "HOST=redis"
+  redis:
+    image: "redis"
+    container_name: Redis
+    ports:
       - "6379:6379"

package/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-
 const CacheManager = require('cache-manager');
 const RedisStore = require('cache-manager-redis');
 const util = require('util');
+const { lazyInstrument } = require('exframe-metrics');
 
 const db = 0;
 
@@ -33,7 +33,7 @@ function cachemanager(options) {
   const cacheStorePool = Object.assign(redisStore._pool, { db });
   cacheStorePool.setMaxListeners(0);
 
-  return {
+  const instance = {
     /**
      *
      * @param {string} key
@@ -95,7 +95,7 @@ function cachemanager(options) {
      * @returns {Promise<true>}
      */
     async healthCheck() {
-      return await this.processRedisCommands(client => client && client.server_info.loading === '0');
+      return this.processRedisCommands(client => client && client.server_info.loading === '0');
     },
 
     close() {
@@ -168,16 +168,23 @@ function cachemanager(options) {
           context.log.info('matched keys', {
             keys: result[1]
           });
-          if (keys.length <= 0) {
-            return;
+          if (keys.length > 0) {
+            // eslint-disable-next-line no-await-in-loop
+            await delAsync(...keys);
           }
-          // eslint-disable-next-line no-await-in-loop
-          await delAsync(...keys);
         } while (cursor !== '0');
       });
     },
     cacheStorePool
   };
+
+  Object.keys(instance).forEach((key) => {
+    if (typeof instance[key] === 'function') {
+      instance[key] = lazyInstrument(instance[key].bind(instance), { metricPrefix: 'cache' });
+    }
+  });
+
+  return instance;
 }
 
 module.exports = {

package/package.json

@@ -1,33 +1,49 @@
-{
-  "name": "exframe-cache-manager",
-  "version": "1.1.3",
-  "description": "Managing the cache",
-  "main": "index.js",
-  "scripts": {
-    "test": "docker-compose -f docker-compose.yml up --abort-on-container-exit --exit-code-from exframe-cache-manager",
-    "unit-test": "istanbul cover --dir ./documentation/coverage node_modules/mocha/bin/_mocha \"./test/**/*.test.js\""
-  },
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@types/cache-manager": "^1.2.8",
-    "@types/redis": "^2.8.13",
-    "assert": "^1.4.1",
-    "cache-manager": "^2.9.0",
-    "cache-manager-redis": "^0.6.0"
-  },
-  "devDependencies": {
-    "chai": "^4.2.0",
-    "cross-env": "^3.2.4",
-    "eslint": "^3.1.1",
-    "eslint-config-airbnb-base": "^5.0.0",
-    "eslint-plugin-import": "^1.12.0",
-    "istanbul": "^1.1.0-alpha.1",
-    "loadtest": "^2.3.0",
-    "mocha": "^3.5.3",
-    "mocha-teamcity-reporter": "^2.2.1",
-    "nodemon": "^1.18.7",
-    "sinon": "^2.4.1",
-    "sinon-mongoose": "^2.0.2"
-  }
-}
+{
+  "name": "exframe-cache-manager",
+  "version": "1.3.1",
+  "description": "Managing the cache",
+  "main": "index.js",
+  "config": {
+    "reporter": "mocha-exzeo-reporter"
+  },
+  "mocha": {
+    "recursive": true
+  },
+  "scripts": {
+    "pretest": "npm-install-peers && npm run lint",
+    "lint": "./node_modules/eslint/bin/eslint.js .",
+    "test": "docker-compose -f docker-compose.yml up --abort-on-container-exit --exit-code-from exframe-cache-manager",
+    "unit-test": "nyc -r lcov --report-dir ./documentation/coverage -t ./documentation/coverage mocha --reporter $npm_package_config_reporter \"./test/**/*.test.js\""
+  },
+  "author": "Exzeo",
+  "license": "ISC",
+  "peerDependencies": {
+    "exframe-health": "*",
+    "exframe-logger": "*",
+    "exframe-service": "*"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "chai": "^4.3.4",
+    "eslint": "^8.3.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.25.3",
+    "mocha": "*",
+    "mocha-exzeo-reporter": "0.0.3",
+    "npm-install-peers": "*",
+    "nyc": "*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://bitbucket.org/exzeo-usa/exframe",
+    "directory": "packages/exframe-cache-manager"
+  },
+  "gitHead": "8a3a00cd3f3111be2cf9d3c6487de58d6b880000"
+}

package/sonar-project.properties

@@ -0,0 +1,21 @@
+# The language the application is written in.
+; sonar.language=js
+sonar.language=JavaScript
+
+# Path is relative to the sonar-project.properties file. Defaults to .
+sonar.sources=.
+
+# # Encoding of the source code. Default is default system encoding
+sonar.sourceEncoding=UTF-8
+
+# # Patterns used to exclude some source files from analysis.
+sonar.exclusions=test*/**/*.js
+
+# # Patterns used to include some test files and only these ones in analysis.
+sonar.test.inclusions=test*/**/*.js
+
+# Patterns used to exclude some files from coverage report.
+sonar.coverage.exclusions=test*/**/*.js,node_modules/*,documentation/coverage/lcov-report/*,junit/*
+
+# Paths (absolute or relative) to the files with LCOV data.
+sonar.javascript.lcov.reportPaths=documentation/coverage/lcov.info

package/test/cacheManager.test.js

@@ -1,124 +1,136 @@
-'use strict';
-
-const sinon = require('sinon');
-const expect = require('chai').expect;
-const cacheManager = require('../index');
-
-const userId = 'auth0|1234567890';
-const cacheKey = `${userId}_profiletest`;
-
-const options =  {
-  "host": process.env.HOST || "localhost",
-  "port": process.env.PORT || 6379,
-  "auth_pass": "",
-  "db": 0,
-  "ttl": 60
-};
-
-const userProfileResponse = {
-  userId: userId,
-  userName: 'CSRMickey',
-  email: 'CMM@discsr.com',
-  profile: {
-    family_name: 'Mickey',
-    given_name: ' Mouse CSR'
-  },
-  resources: [{
-    uri: 'TTIC:FL:HO3:CSR1',
-    right: 'READ'
-  }, {
-    uri: 'TTIC:FL:HO3:CSR2',
-    right: 'WRITE'
-  }]
-};
-
-context('Test User Profile Middleware', () => {
-
-  beforeEach(() => {
-    this.sinon = sinon.sandbox.create();
-  });
-
-  afterEach(() => {
-    this.sinon.restore();
-  });
-
-  describe('Cache Manager', () => {
-    const app = cacheManager.create(options);
-
-    it('validate the setItem function on the basis of key and value', async () => {
-      app.setItem(cacheKey, "value1").then((data)=>{
-        expect(data).to.not.eql(null);
-        expect(data).to.eql("value1");
-      })
-      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, cacheKey);
-    });
-
-    it('validate the getItem function on the basis of key', async () => {
-      await app.setItem(cacheKey,"someValue");
-      const value = await app.getItem(cacheKey);
-      expect(value).to.eql("someValue");
-      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, cacheKey);
-    });
-
-    it('validate the addSetItem function on the basis of key', async () => {
-      const key = 'SetTestKey';
-      await app.addSetItem(key, "someSetValue");
-      const value = await app.isSetMember(key, "someSetValue");
-      expect(value).to.eql(true);
-      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, key);
-    });
-    
-    it('validate the isSetMember function on the basis of key', async () => {
-      const key = 'SetTestKey2';
-      await app.addSetItem(key, "someSetValue");
-      const value1 = await app.isSetMember(key, "someSetValue");
-      expect(value1).to.eql(true);
-      const value2 = await app.isSetMember(key, "notSetValue");
-      expect(value2).to.eql(false, 'expected non-member key to return false for isSetMember');
-      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, key);
-    });
-
-    it('validate the removeSetMember function on the basis of key', async () => {
-      const key = 'SetTestKey3';
-      await app.addSetItem(key, "someSetValue");
-      let value = await app.isSetMember(key, "someSetValue");
-      expect(value).to.eql(true);
-      await app.removeSetItem(key, "someSetValue");
-      value = await app.isSetMember(key, "someSetValue");
-      expect(value).to.eql(false, 'expected non-member key to return false for isSetMember');
-      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, key);
-    });
-
-    it('close drains the redis pool', async () => {
-      const app1 = cacheManager.create(options);
-      await app1.setItem(cacheKey,"someValue");
-      const value = await app1.getItem(cacheKey);
-      expect(value).to.eql("someValue");
-      await app1.close();
-
-      try {
-        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');
-      }      
-    });
-
-    it('validate the flushCache function', async () => {
-      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, '*_profiletest');
-      const value = await app.getItem(cacheKey);
-      expect(value).to.eql(null);
-    });
-
-    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);
-    });
-    it('validate the healthCheck function', async () => {
-      const healthCheck = await app.healthCheck();
-      expect(healthCheck).to.eql(true);
-    });
-  });
+'use strict';
+
+const expect = require('chai').expect;
+const { prometheusClient } = require('exframe-service');
+const cacheManager = require('../index');
+
+const userId = 'auth0|1234567890';
+const cacheKey = `${userId}_profiletest`;
+
+const options =  {
+  "host": process.env.HOST || "localhost",
+  "port": process.env.PORT || 6379,
+  "auth_pass": "",
+  "db": 0,
+  "ttl": 60
+};
+
+const userProfileResponse = {
+  userId: userId,
+  userName: 'CSRMickey',
+  email: 'CMM@discsr.com',
+  profile: {
+    family_name: 'Mickey',
+    given_name: ' Mouse CSR'
+  },
+  resources: [{
+    uri: 'TTIC:FL:HO3:CSR1',
+    right: 'READ'
+  }, {
+    uri: 'TTIC:FL:HO3:CSR2',
+    right: 'WRITE'
+  }]
+};
+
+context('Test User Profile Middleware', () => {
+  describe('Cache Manager', () => {
+    const app = cacheManager.create(options);
+
+    beforeEach(() => {
+      prometheusClient.register.clear();
+      expect(prometheusClient.register.getMetricsAsArray()).to.have.lengthOf(0);
+    });
+
+    it('validate the setItem function on the basis of key and value', async () => {
+      const data = await app.setItem(cacheKey, "value1");
+      expect(data).to.not.eql(null);
+      expect(data).to.eql("value1");
+      const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('setItem'));
+      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 on the basis of key', async () => {
+      await app.setItem(cacheKey,"someValue");
+      const value = await app.getItem(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 addSetItem function on the basis of key', async () => {
+      const key = 'SetTestKey';
+      await app.addSetItem(key, "someSetValue");
+      const value = await app.isSetMember(key, "someSetValue");
+      expect(value).to.eql(true);
+      const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('addSetItem'));
+      expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, key);
+    });
+
+    it('validate the isSetMember function on the basis of key', async () => {
+      const key = 'SetTestKey2';
+      await app.addSetItem(key, "someSetValue");
+      const value1 = await app.isSetMember(key, "someSetValue");
+      expect(value1).to.eql(true);
+      const value2 = await app.isSetMember(key, "notSetValue");
+      expect(value2).to.eql(false, 'expected non-member key to return false for isSetMember');
+      const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('isSetMember'));
+      expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, key);
+    });
+
+    it('validate the removeSetMember function on the basis of key', async () => {
+      const key = 'SetTestKey3';
+      await app.addSetItem(key, "someSetValue");
+      let value = await app.isSetMember(key, "someSetValue");
+      expect(value).to.eql(true);
+      await app.removeSetItem(key, "someSetValue");
+      value = await app.isSetMember(key, "someSetValue");
+      expect(value).to.eql(false, 'expected non-member key to return false for isSetMember');
+      const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('removeSetItem'));
+      expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, key);
+    });
+
+    it('close drains the redis pool', async () => {
+      const app1 = cacheManager.create(options);
+      await app1.setItem(cacheKey,"someValue");
+      const value = await app1.getItem(cacheKey);
+      expect(value).to.eql("someValue");
+      await app1.close();
+
+      try {
+        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');
+        const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('close'));
+        expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+      }
+    });
+
+    it('validate the flushCache function', async () => {
+      await app.flushCache({log:{info:(info)=>{console.log(info)}}}, '*_profiletest');
+      const value = await app.getItem(cacheKey);
+      expect(value).to.eql(null);
+      const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('flushCache'));
+      expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+  });
+
+    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);
+    });
+
+    it('validate the healthCheck function', async () => {
+      const healthCheck = await app.healthCheck();
+      expect(healthCheck).to.eql(true);
+      const metrics = prometheusClient.register.getMetricsAsArray().filter((m) => m.name.includes('healthCheck'));
+      expect(metrics).to.be.an('array').and.to.have.lengthOf.above(0);
+    });
+  });
 });