@mimik/rediser 2.0.2 → 2.1.1

package/README.md

@@ -3,37 +3,52 @@
 ## rediser
 **Example**  
 ```js
-import redis from '@mimik/rediser';
+import rediser from '@mimik/rediser';
 ```
 
 * [rediser](#module_rediser)
-    * _async_
-        * [~validate()](#module_rediser..validate) ⇒ <code>Promise</code>
-    * _sync_
-        * [~initializeSync()](#module_rediser..initializeSync) ⇒ <code>object</code>
+    * [module.exports(set, config)](#exp_module_rediser--module.exports) ⇒ <code>object</code> ⏏
+        * _async_
+            * [~validate()](#module_rediser--module.exports..validate) ⇒ <code>Promise</code>
+        * _sync_
+            * [~initializeSync()](#module_rediser--module.exports..initializeSync) ⇒ <code>object</code> \| <code>null</code>
 
-<a name="module_rediser..validate"></a>
+<a name="exp_module_rediser--module.exports"></a>
 
-### rediser~validate() ⇒ <code>Promise</code>
+### module.exports(set, config) ⇒ <code>object</code> ⏏
+Creates a Redis connection manager.
+
+**Kind**: Exported function  
+**Returns**: <code>object</code> - An object with `initializeSync` and `validate` methods.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| set | <code>string</code> | Whether redis is enabled ('on' or 'off'). |
+| config | <code>object</code> | The application configuration object. |
+| config.redisSettings | <code>object</code> | Redis-specific settings. |
+
+<a name="module_rediser--module.exports..validate"></a>
+
+#### module.exports~validate() ⇒ <code>Promise</code>
 Database connection validation.
 
-**Kind**: inner method of [<code>rediser</code>](#module_rediser)  
-**Returns**: <code>Promise</code> - .  
+**Kind**: inner method of [<code>module.exports</code>](#exp_module_rediser--module.exports)  
+**Returns**: <code>Promise</code> - Resolves with null on success.  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> Will throw an error if the database connection is not `connected` and is not `disconnected`.
+- <code>Error</code> Will throw an error if the database connection is not `connected` and is not `disconnected`.
 
 Will exit 1 if the connection request times out and the connection state is not `connected`.
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>  
 **Fulfil**:  Return `null`.  
-<a name="module_rediser..initializeSync"></a>
+<a name="module_rediser--module.exports..initializeSync"></a>
 
-### rediser~initializeSync() ⇒ <code>object</code>
+#### module.exports~initializeSync() ⇒ <code>object</code> \| <code>null</code>
 Database initialization.
 
-**Kind**: inner method of [<code>rediser</code>](#module_rediser)  
-**Returns**: <code>object</code> - The database object.  
+**Kind**: inner method of [<code>module.exports</code>](#exp_module_rediser--module.exports)  
+**Returns**: <code>object</code> \| <code>null</code> - The database client, or null if cache is not enabled.  
 **Category**: sync  
-**Requires**: <code>module:sumologic-winston-logger</code>  
+**Requires**: <code>module:@mimik/sumologic-winston-logger</code>  

package/index.js

@@ -5,14 +5,14 @@ import {
 import {
   clearInterval,
   setInterval,
-} from 'timers';
-import Promise from 'bluebird';
+  setTimeout,
+} from 'node:timers';
 import logger from '@mimik/sumologic-winston-logger';
 import redis from 'redis';
 /**
  * @module rediser
  * @example
- * import redis from '@mimik/rediser';
+ * import rediser from '@mimik/rediser';
  */
 
 const type = 'redis';
@@ -20,25 +20,37 @@ 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;
+const delay = ms => new Promise((resolve) => {
+  setTimeout(resolve, ms);
+});
 
+/**
+ * Creates a Redis connection manager.
+ *
+ * @param {string} set - Whether redis is enabled ('on' or 'off').
+ * @param {object} config - The application configuration object.
+ * @param {object} config.redisSettings - Redis-specific settings.
+ * @returns {object} An object with `initializeSync` and `validate` methods.
+ */
 export default (set, config) => {
   const { redisSettings } = config;
+
+  let displayCreate = true;
+  let displayDisconnect = true;
+  let state = DISCONNECTED;
+  let clusterConnectInterval;
+
   /**
    * Database initialization.
    *
-   * @requires sumologic-winston-logger
+   * @requires @mimik/sumologic-winston-logger
    *
    * @function initializeSync
    * @category sync
-   * @return {object} The database object.
+   * @return {object|null} The database client, or null if cache is not enabled.
    */
   const initializeSync = () => {
     if (set !== 'on') {
@@ -66,7 +78,7 @@ export default (set, config) => {
             }
             logger.flushAndExit(ISSUE_EXIT);
           }
-        }, config.redisSettings.connectTimeout * MILLI_SEC); // convert in seconds
+        }, config.redisSettings.connectTimeout * MILLI_SEC); // convert seconds to milliseconds
       }
     };
 
@@ -74,7 +86,9 @@ export default (set, config) => {
       if (isProd(config.nodeEnvironment)) {
         const redisSettingsClone = { ...redisSettings };
 
-        if (redisSettings.password) redisSettingsClone.url = `${redisSettings.url.split('=')[FIRST]}=${MASK}`;
+        const eqIdx = redisSettings.url.indexOf('=');
+
+        if (redisSettings.password && eqIdx !== -1) redisSettingsClone.url = `${redisSettings.url.substring(0, eqIdx + 1)}${MASK}`;
         logger.info('creating a cache connection', { type, settings: redisSettingsClone }, correlationId);
       }
       else logger.info('creating a cache connection', { type, settings: redisSettings }, correlationId);
@@ -110,7 +124,7 @@ export default (set, config) => {
           interval = null;
         }
       })
-      .on('end', () => disconnectHandler)
+      .on('end', disconnectHandler)
       .connect();
 
     // eslint-disable-next-line no-warning-comments
@@ -139,16 +153,15 @@ export default (set, config) => {
   };
 
   /**
-   *
    * Database connection validation.
    *
    * @requires @mimik/sumologic-winston-logger
    *
    * @function validate
    * @category async
-   * @returns {Promise}.
+   * @returns {Promise} Resolves with null on success.
    * @fulfil {} Return `null`.
-   * @throws {Promise} Will throw an error if the database connection is not `connected` and is not `disconnected`.
+   * @throws {Error} Will throw an error if the database connection is not `connected` and is not `disconnected`.
    *
    * Will exit 1 if the connection request times out and the connection state is not `connected`.
    */
@@ -161,10 +174,11 @@ export default (set, config) => {
         }, correlationId);
         logger.flushAndExit(ISSUE_EXIT);
       }
-    }, config.redisSettings.connectTimeout * MILLI_SEC); // convert in seconds
+    }, config.redisSettings.connectTimeout * MILLI_SEC); // convert seconds to milliseconds
 
-    return Promise.delay(redisSettings.validationCheck)
+    return delay(redisSettings.validationCheck)
       .then(() => {
+        clearInterval(interval);
         if (state !== DISCONNECTED && state !== CONNECTED) {
           const error = new Error(`cache connection not established: ${state}`);
 
@@ -174,13 +188,12 @@ export default (set, config) => {
         if (state === DISCONNECTED) {
           return validate();
         }
-        clearInterval(interval);
         logger.info('cache connection established', { type }, correlationId);
         return null;
       });
   };
 
-  if (state !== CONNECTED) initializeSync();
+  initializeSync();
   return {
     initializeSync,
     validate,

package/package.json

@@ -1,22 +1,21 @@
 {
   "name": "@mimik/rediser",
-  "version": "2.0.2",
-  "description": "Helper for setting up redis using redis for mimik microservices",
+  "version": "2.1.1",
+  "description": "Redis connection helper for mimik microservices",
   "main": "./index.js",
+  "exports": "./index.js",
+  "engines": {
+    "node": ">=24.0.0"
+  },
   "type": "module",
   "scripts": {
     "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",
+    "test": "mocha --reporter mochawesome --bail --exit --timeout 5000 --node-option loader=esmock test/",
+    "test-ci": "c8 --reporter=lcov --reporter=text npm test",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
-    "commit-ready": "npm run docs && npm run lint && npm run test-ci"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run commit-ready",
-      "pre-push": "npm run test"
-    }
+    "commit-ready": "npm run docs && npm run lint && npm run test-ci",
+    "prepare": "husky"
   },
   "keywords": [
     "mimik",
@@ -29,18 +28,23 @@
     "url": "https://bitbucket.org/mimiktech/rediser"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^2.0.4",
-    "@mimik/sumologic-winston-logger": "^2.0.3",
-    "bluebird": "3.7.2",
-    "redis": "5.6.0"
+    "@mimik/lib-filters": "^2.0.8",
+    "@mimik/sumologic-winston-logger": "^2.2.2",
+    "redis": "5.11.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.31.0",
-    "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.2.0",
-    "eslint": "9.31.0",
+    "@eslint/js": "9.39.4",
+    "@mimik/eslint-plugin-document-env": "^2.0.9",
+    "@mimik/eslint-plugin-logger": "^1.0.3",
+    "@stylistic/eslint-plugin": "5.10.0",
+    "c8": "11.0.0",
+    "eslint": "9.39.4",
     "eslint-plugin-import": "2.32.0",
+    "esmock": "^2.7.3",
+    "globals": "17.4.0",
     "husky": "9.1.7",
-    "jsdoc-to-markdown": "9.1.2"
+    "jsdoc-to-markdown": "9.1.3",
+    "mocha": "11.7.5",
+    "mochawesome": "7.1.4"
   }
 }

package/.husky/pre-commit

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

package/.husky/pre-push

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

package/.nycrc

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

package/eslint.config.js

@@ -1,63 +0,0 @@
-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,
-  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 }],
-    },
-  },
-];