@mimik/rediser 1.5.2 → 2.0.0

package/README.md

@@ -3,7 +3,7 @@
 ## rediser
 **Example**  
 ```js
-const redis = require('@mimik/rediser');
+import redis from '@mimik/rediser';
 ```
 
 * [rediser](#module_rediser)

package/eslint.config.js

@@ -0,0 +1,63 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import processDoc from '@mimik/eslint-plugin-document-env';
+import stylistic from '@stylistic/eslint-plugin';
+
+const MAX_LENGTH_LINE = 180;
+const MAX_FUNCTION_PARAMETERS = 6;
+const MAX_LINES_IN_FILES = 600;
+const MAX_LINES_IN_FUNCTION = 150;
+const MAX_STATEMENTS_IN_FUNCTION = 45;
+const MIN_KEYS_IN_OBJECT = 10;
+const MAX_COMPLEXITY = 30;
+
+export default [
+  {
+    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+  },
+  importPlugin.flatConfigs.recommended,
+  stylistic.configs['recommended-flat'],
+  js.configs.all,
+  {
+    plugins: {
+      processDoc,
+    },
+    languageOptions: {
+      ecmaVersion: 2022,
+      globals: {
+        console: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        require: 'readonly',
+      },
+      sourceType: 'module',
+    },
+    rules: {
+      '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
+      '@stylistic/line-comment-position': ['off'],
+      '@stylistic/semi': ['error', 'always'],
+      'capitalized-comments': ['off'],
+      'complexity': ['error', MAX_COMPLEXITY],
+      'curly': ['off'],
+      'id-length': ['error', { exceptions: ['x', 'y', 'z', 'i', 'j', 'k'] }],
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
+      'init-declarations': ['off'],
+      'linebreak-style': ['off'],
+      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
+      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
+      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
+      'max-params': ['error', MAX_FUNCTION_PARAMETERS],
+      'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
+      'no-confusing-arrow': ['off'], // arrow isnt confusing
+      'no-inline-comments': ['off'],
+      'no-process-env': ['error'],
+      'no-ternary': ['off'],
+      'no-undefined': ['off'],
+      'one-var': ['error', 'never'],
+      'processDoc/validate-document-env': ['error'],
+      'quotes': ['warn', 'single'],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+    },
+  },
+];

package/index.js

@@ -1,11 +1,18 @@
-const logger = require('@mimik/sumologic-winston-logger');
-const { isProd, MASK } = require('@mimik/lib-filters');
-const redis = require('redis');
-const Promise = require('bluebird');
+import {
+  MASK,
+  isProd,
+} from '@mimik/lib-filters';
+import {
+  clearInterval,
+  setInterval,
+} from 'timers';
+import Promise from 'bluebird';
+import logger from '@mimik/sumologic-winston-logger';
+import redis from 'redis';
 /**
  * @module rediser
  * @example
- * const redis = require('@mimik/rediser');
+ * import redis from '@mimik/rediser';
  */
 
 const type = 'redis';
@@ -13,13 +20,16 @@ const correlationId = `${type}-cache-start@0/${new Date().toISOString()}`;
 
 const CONNECTED = 1;
 const DISCONNECTED = 2;
+const FIRST = 0;
+const ISSUE_EXIT = 1;
+const MILLI_SEC = 1000;
 
 let displayCreate = true;
 let displayDisconnect = true;
 let state = DISCONNECTED;
 let clusterConnectInterval;
 
-module.exports = (set, config) => {
+export default (set, config) => {
   const { redisSettings } = config;
   /**
    * Database initialization.
@@ -43,20 +53,20 @@ module.exports = (set, config) => {
       state = DISCONNECTED;
       if (!interval) {
         interval = setInterval(() => {
-          if (state !== CONNECTED) {
+          if (state === CONNECTED) {
+            clearInterval(interval);
+            interval = null;
+          }
+          else {
             if (displayDisconnect) {
               logger.error('fatal error: Timeout in connecting to cache', {
                 type, error: state, timeout: redisSettings.connectTimeout,
               }, correlationId);
               displayDisconnect = false;
             }
-            logger.flushAndExit(1);
+            logger.flushAndExit(ISSUE_EXIT);
           }
-          else {
-            clearInterval(interval);
-            interval = null;
-          }
-        }, config.redisSettings.connectTimeout * 1000); // convert in seconds
+        }, config.redisSettings.connectTimeout * MILLI_SEC); // convert in seconds
       }
     };
 
@@ -64,7 +74,7 @@ module.exports = (set, config) => {
       if (isProd(config.nodeEnvironment)) {
         const redisSettingsClone = { ...redisSettings };
 
-        if (redisSettings.password) redisSettingsClone.url = `${redisSettings.url.split('=')[0]}=${MASK}`;
+        if (redisSettings.password) redisSettingsClone.url = `${redisSettings.url.split('=')[FIRST]}=${MASK}`;
         logger.info('creating a cache connection', { type, settings: redisSettingsClone }, correlationId);
       }
       else logger.info('creating a cache connection', { type, settings: redisSettings }, correlationId);
@@ -74,7 +84,7 @@ module.exports = (set, config) => {
     const isClusterEnabled = redisSettings.cluster.set === 'on';
     if (isClusterEnabled) {
       const clusterConfig = {
-        rootNodes: redisSettings.domain.split(',').map((url) => ({ url: `redis://${url}` })),
+        rootNodes: redisSettings.domain.split(',').map(url => ({ url: `redis://${url}` })),
         useReplicas: redisSettings.cluster.useReplicas === 'on',
         minimizeConnections: redisSettings.cluster.minimizeConnections === 'on',
       };
@@ -103,11 +113,17 @@ module.exports = (set, config) => {
       .on('end', () => disconnectHandler)
       .connect();
 
+    // eslint-disable-next-line no-warning-comments
     // Todo: remove this if block, when redis library has events implemented for cluster connections
     if (!clusterConnectInterval && isClusterEnabled) {
       const connectionTestKey = 'b7ddc6b6-57a8-4cde-80a1-c6a8f174f386';
+
       clusterConnectInterval = setInterval(() => {
-        if (state !== CONNECTED) {
+        if (state === CONNECTED) {
+          clearInterval(clusterConnectInterval);
+          clusterConnectInterval = null;
+        }
+        else {
           client.set('connectionTestKey', connectionTestKey)
             .then(() => client.get('connectionTestKey'))
             .then((value) => {
@@ -117,10 +133,6 @@ module.exports = (set, config) => {
               logger.error('connection not ready yet', { error }, correlationId);
             });
         }
-        else {
-          clearInterval(clusterConnectInterval);
-          clusterConnectInterval = null;
-        }
       }, redisSettings.validationCheck);
     }
     return client;
@@ -147,9 +159,9 @@ module.exports = (set, config) => {
         logger.error('fatal error: Timeout in connecting to cache', {
           type, error: state, timeout: redisSettings.connectTimeout,
         }, correlationId);
-        logger.flushAndExit(1);
+        logger.flushAndExit(ISSUE_EXIT);
       }
-    }, config.redisSettings.connectTimeout * 1000); // convert in seconds
+    }, config.redisSettings.connectTimeout * MILLI_SEC); // convert in seconds
 
     return Promise.delay(redisSettings.validationCheck)
       .then(() => {

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@mimik/rediser",
-  "version": "1.5.2",
+  "version": "2.0.0",
   "description": "Helper for setting up redis using redis for mimik microservices",
-  "main": "index.js",
+  "main": "./index.js",
+  "type": "module",
   "scripts": {
-    "lint": "eslint --ignore-path .gitignore .",
+    "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
     "test": "echo \"Error: no test specified\" && exit 0",
     "test-ci": "echo \"Error: no test specified\" && exit 0",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
-    "commit-ready": "npm run docs && npm run lint && npm run test-ci",
-    "prepare": "husky install"
+    "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
   "husky": {
     "hooks": {
@@ -29,21 +29,18 @@
     "url": "https://bitbucket.org/mimiktech/rediser"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^1.4.8",
-    "@mimik/sumologic-winston-logger": "^1.6.19",
+    "@mimik/lib-filters": "^2.0.1",
+    "@mimik/sumologic-winston-logger": "^2.0.1",
     "bluebird": "3.7.2",
-    "redis": "4.6.10"
+    "redis": "4.7.0"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.5",
-    "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "eslint": "8.50.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsx-a11y": "6.7.1",
-    "eslint-plugin-react": "7.33.2",
-    "eslint-plugin-react-hooks": "4.6.0",
-    "husky": "8.0.3",
-    "jsdoc-to-markdown": "8.0.0"
+    "@eslint/js": "9.22.0",
+    "@mimik/eslint-plugin-document-env": "^2.0.2",
+    "@stylistic/eslint-plugin": "4.2.0",
+    "eslint": "9.22.0",
+    "eslint-plugin-import": "2.31.0",
+    "husky": "9.1.7",
+    "jsdoc-to-markdown": "9.1.1"
   }
 }

package/.eslintrc

@@ -1,43 +0,0 @@
-{
-  "plugins": [
-    "@mimik/document-env",
-    "@mimik/dependencies"
-  ],
-  "env": {
-    "node": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020
-  },
-  "extends": "airbnb",
-  "rules": {
-    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
-    "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": 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"],
-    "no-process-env": ["error"],
-    "@mimik/document-env/validate-document-env": 2,
-    "@mimik/dependencies/case-sensitive": 2,
-    "@mimik/dependencies/no-cycles": 2,
-    "@mimik/dependencies/require-json-ext": 2
-  },
-  "settings":{
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "module": true,
-    "require": true,
-    "const": false,
-    "it": false,
-    "describe": false,
-    "before": true,
-    "after": true,
-    "JSON": true
-  }
-}