@mimik/rediser 1.2.5 → 1.4.6

package/.eslintrc

@@ -1,17 +1,34 @@
-// Use this file as a starting point for your project's .eslintrc.
-// Copy this file, and add rule overrides as needed.
 {
+  "plugins": [
+    "@mimik/document-env",
+    "@mimik/dependencies"
+  ],
   "env": {
     "node": true
   },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "extends": "airbnb",
   "rules": {
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
     "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
     "no-confusing-arrow": [0], // arrow isnt confusing
     "max-len": [1, 180, { "ignoreComments": true }],
     "linebreak-style": 0,
     "quotes": [1, "single"],
-    "semi": [1, "always"]
+    "semi": [1, "always"],
+    "no-process-env": ["error"],
+    "@mimik/document-env/validate-document-env": 2,
+    "@mimik/dependencies/case-sensitive": 2,
+    "@mimik/dependencies/no-cycles": 2,
+    "@mimik/dependencies/no-unresolved": 2,
+    "@mimik/dependencies/require-json-ext": 2
+  },
+  "settings":{
+    "react": {
+      "version": "latest"
+    }
   },
   "globals": {
     "module": true,

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run commit-ready

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run test

package/.nycrc

@@ -0,0 +1,4 @@
+{
+  "exclude": ["gulpfile.js"],
+  "reporter": ["lcov", "text"]
+}

package/Gulpfile.js

@@ -1,29 +1,33 @@
 /* eslint-disable import/no-extraneous-dependencies */
+const fs = require('fs');
 const log = require('fancy-log');
 const gulp = require('gulp');
 const eslint = require('gulp-eslint');
 const git = require('gulp-git');
-const gulpJsdoc2md = require('gulp-jsdoc-to-markdown');
-const rename = require('gulp-rename');
+const jsdoc2md = require('jsdoc-to-markdown');
 
 const files = [
   'index.js',
   'Gulpfile.js',
-  'test/*.spec.js',
+  'test/**.js',
+  'lib/**.js',
 ];
 
-gulp.task('docs', () => gulp.src('index.js')
-  .pipe(gulpJsdoc2md({ conf: 'jsdoc.json' }))
-  .on('error', (err) => {
-    log.error('docs creation failed:', err.message);
-  })
-  .pipe(rename('README.md'))
-  .pipe(gulp.dest('.')));
+const createDocs = (done) => {
+  jsdoc2md.render({ files: 'index.js' })
+    .then((output) => fs.writeFileSync('README.md', output))
+    .catch((err) => log.error('docs creation failed:', err.message))
+    .finally(() => done());
+};
 
-gulp.task('lint', () => gulp.src(files)
+const lint = () => gulp.src(files)
   .pipe(eslint({}))
-  .pipe(eslint.format())
-  .pipe(eslint.failOnError()));
+  .pipe(eslint.format());
 
-gulp.task('add', () => gulp.src('README.md')
-  .pipe(git.add({ quiet: true })));
+const add = () => gulp.src('README.md')
+  .pipe(git.add({ quiet: true }));
+
+const docs = gulp.series(createDocs, add);
+
+gulp.task('docs', docs);
+gulp.task('lint', lint);

package/README.md

@@ -17,7 +17,7 @@ const redis = require('@mimik/rediser');
 ### rediser~validate() ⇒ <code>Promise</code>
 Database connection validation.
 
-**Kind**: inner method of <code>[rediser](#module_rediser)</code>  
+**Kind**: inner method of [<code>rediser</code>](#module_rediser)  
 **Returns**: <code>Promise</code> - .  
 **Category**: async  
 **Throws**:
@@ -33,7 +33,7 @@ Will exit 1 if the connection request times out and the connection state is not
 ### rediser~initializeSync() ⇒ <code>object</code>
 Database initialization.
 
-**Kind**: inner method of <code>[rediser](#module_rediser)</code>  
+**Kind**: inner method of [<code>rediser</code>](#module_rediser)  
 **Returns**: <code>object</code> - The database object.  
 **Category**: sync  
 **Requires**: <code>module:sumologic-winston-logger</code>  

package/index.js

@@ -1,4 +1,5 @@
 const logger = require('@mimik/sumologic-winston-logger');
+const { isProd, MASK } = require('@mimik/lib-filters');
 const redis = require('redis');
 const Promise = require('bluebird');
 /**
@@ -9,8 +10,8 @@ const Promise = require('bluebird');
 
 Promise.promisifyAll(redis.RedisClient.prototype);
 
-const correlationId = 'cache-start';
 const type = 'redis';
+const correlationId = `${type}-cache-start@0/${new Date().toISOString()}`;
 
 const VALIDATION_CHECK = 100; // in ms
 const CONNECTED = 1;
@@ -20,6 +21,7 @@ let display = true;
 let state = DISCONNECTED;
 
 module.exports = (set, config) => {
+  const { redisSettings } = config;
   /**
    * Database initialization.
    *
@@ -35,9 +37,17 @@ module.exports = (set, config) => {
       display = false;
       return null;
     }
-    if (display) logger.info('creating a cache connection', { type, settings: config.redisSettings }, correlationId);
+    if (display) {
+      if (isProd(config.nodeEnvironment)) {
+        const redisSettingsClone = { ...redisSettings };
+
+        if (redisSettings.password) redisSettingsClone.url = `${redisSettings.url.split('=')[0]}=${MASK}`;
+        logger.info('creating a cache connection', { type, settings: redisSettingsClone }, correlationId);
+      }
+      else logger.info('creating a cache connection', { type, settings: redisSettings }, correlationId);
+    }
     display = false;
-    const client = redis.createClient(config.redisSettings.url, config.redisSettings.options);
+    const client = redis.createClient(redisSettings.url, redisSettings.options);
 
     client.on('error', (err) => {
       state = err;
@@ -74,7 +84,7 @@ module.exports = (set, config) => {
     const interval = setInterval(() => {
       if (state !== CONNECTED) {
         logger.error('fatal error: Timeout in connecting to database', {
-          type, error: state, timeout: config.redisSettings.connectTimeout,
+          type, error: state, timeout: redisSettings.connectTimeout,
         }, correlationId);
         logger.flushAndExit(1);
       }

package/package.json

@@ -1,45 +1,53 @@
 {
   "name": "@mimik/rediser",
-  "version": "1.2.5",
+  "version": "1.4.6",
   "description": "Helper for setting up redis using redis for mimik microservices",
+  "main": "index.js",
   "scripts": {
     "lint": "gulp lint",
     "docs": "gulp docs",
-    "test": "exit 0"
+    "test": "exit 0",
+    "prepublishOnly": "gulp docs; gulp lint; npm run test",
+    "commit-ready": "gulp docs; gulp lint; npm run test",
+    "prepare": "husky install"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run lint; npm run docs; gulp add; npm run test",
-      "pre-push": "npm run lint; npm run test"
+      "pre-commit": "npm run commit-ready",
+      "pre-push": "npm run test"
     }
   },
   "keywords": [
     "mimik",
     "microservice"
   ],
-  "author": "mimik",
+  "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/rediser"
   },
   "dependencies": {
-    "@mimik/sumologic-winston-logger": "1.1.1",
-    "bluebird": "3.5.4",
-    "redis": "2.8.0"
+    "@mimik/lib-filters": "^1.4.3",
+    "@mimik/sumologic-winston-logger": "^1.6.6",
+    "bluebird": "3.7.2",
+    "redis": "4.0.1"
   },
   "devDependencies": {
-    "eslint": "5.16.0",
-    "eslint-config-airbnb": "17.1.0",
-    "eslint-plugin-import": "2.17.2",
-    "eslint-plugin-jsx-a11y": "6.2.1",
-    "eslint-plugin-react": "7.12.4",
+    "@mimik/eslint-plugin-dependencies": "^2.4.1",
+    "@mimik/eslint-plugin-document-env": "^1.0.0",
+    "eslint": "8.4.1",
+    "eslint-config-airbnb": "18.2.1",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-jsx-a11y": "6.5.1",
+    "eslint-plugin-react": "7.27.1",
+    "eslint-plugin-react-hooks": "4.3.0",
     "fancy-log": "1.3.3",
-    "gulp": "4.0.1",
-    "gulp-eslint": "5.0.0",
-    "gulp-git": "2.9.0",
-    "gulp-jsdoc-to-markdown": "1.2.2",
-    "gulp-rename": "1.4.0",
-    "husky": "2.2.0"
+    "gulp": "4.0.2",
+    "gulp-eslint": "6.0.0",
+    "gulp-git": "2.10.1",
+    "gulp-rename": "2.0.0",
+    "husky": "7.0.4",
+    "jsdoc-to-markdown": "7.1.0"
   }
 }

package/jsdoc.json

@@ -1,6 +0,0 @@
-{
-    "source": {
-        "includePattern": ".+\\.js(doc|x)?$",
-        "excludePattern": ""
-    }
-}