eip-cloud-services 1.1.7 → 1.1.9

package/eslint.config.js

@@ -0,0 +1,51 @@
+module.exports = [ {
+    languageOptions: {
+        ecmaVersion: 2021,
+        sourceType: 'module',
+        parserOptions: {
+            ecmaFeatures: {
+                jsx: true
+            }
+        }
+    },
+    rules: {
+        'max-len': 'off',
+        'semi': [ 'error', 'always' ],
+        'no-underscore-dangle': 'off',
+        'class-methods-use-this': 'off',
+        'no-param-reassign': 'off',
+        'no-restricted-syntax': 'warn',
+        'no-continue': 'warn',
+        'consistent-return': 'warn',
+        'guard-for-in': 'warn',
+        'import/no-commonjs': 'off',
+        'import/no-dynamic-require': 'off',
+        'new-cap': 'warn',
+        'no-nested-ternary': 'off',
+        'prefer-const': 'error',
+        'newline-before-return': [ 'error', 'always' ],
+        'quotes': [ 'error', 'single' ],
+        'no-multiple-empty-lines': [ 'error', { max: 1 } ],
+        'space-before-function-paren': [ 'error', 'always' ],
+        'func-call-spacing': [ 'error', 'always' ],
+        'block-spacing': [ 'error', 'always' ],
+        'space-in-parens': [ 'error', 'always' ],
+        'object-curly-spacing': [ 'error', 'always' ],
+        'no-spaced-func': 'off',
+        'space-unary-ops': [ 'error', { 'words': true, 'nonwords': false, 'overrides': { 'new': false, '++': false } } ],
+        'arrow-spacing': [ 'error', { 'before': true, 'after': true } ],
+        'indent': [ 'error', 4, { 'SwitchCase': 1 } ],
+        'key-spacing': [ 'error', { 'beforeColon': false, 'afterColon': true } ],
+        'computed-property-spacing': [ 'error', 'always' ],
+        'array-bracket-spacing': [ 'error', 'never' ],
+        'comma-spacing': [ 'error', { 'before': false, 'after': true } ],
+        'brace-style': [ 'error', 'stroustrup' ],
+        'space-infix-ops': 'error',
+        'keyword-spacing': [ 'error', { overrides: {
+            if: { after: true },
+            for: { after: true },
+            while: { after: true }
+        } } ],
+        'array-bracket-spacing': [ 'error', 'always' ],
+    },
+} ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "Houses a collection of helpers for connecting with Cloud services.",
   "main": "index.js",
   "scripts": {
@@ -10,6 +10,7 @@
   "license": "ISC",
   "devDependencies": {
     "chai": "^4.3.7",
+    "eslint": "^9.1.1",
     "mocha": "^10.2.0"
   },
   "dependencies": {
@@ -23,4 +24,4 @@
     "mysql": "^2.18.1",
     "redis": "^4.6.7"
   }
-}
+}

package/src/redis.js

@@ -78,6 +78,13 @@ const getClient = async ( clientId = 'main' ) => {
     }
 };
 
+const deleteClient = async ( clientId ) => {
+    if ( clients[ clientId ] ){
+        await clients[ clientId ].quit ();
+        delete clients[ clientId ];
+    }
+};
+
 /**
  * Retrieves a Redis client based on the provided identifier.
  * This function is primarily used internally within the module.
@@ -700,6 +707,7 @@ exports.subscribe = async ( channel, messageHandler ) => {
                     messageHandler ( message );
                 }
             } );
+
             await client.subscribe ( channel );
         
             return;
@@ -714,6 +722,35 @@ exports.subscribe = async ( channel, messageHandler ) => {
     }
 };
 
+/**
+ * Unsubscribes from a channel.
+ * @param {string} channel - The channel to unsubscribe from.
+ * @returns {Promise<void>} - A promise that resolves when the unsubscribe is complete.
+ *
+ * @description This method unsubscribes from the specified channel in Redis for incoming messages. 
+ */
+exports.unsubscribe = async ( channel ) => {
+    try {
+        if ( typeof channel === 'string' ) {
+            const client = await getClient ( `${channel}_sub` );
+
+            client.removeAllListeners ( 'message' );
+
+            await client.unsubscribe ( channel );
+            await deleteClient ( `${channel}_sub` );
+
+            return;
+        }
+        else {
+            throw new Error ( 'redis.unsubscribe expects a string channel and a function as handler' );
+        }
+    }
+    catch ( error ) {
+        console.error ( 'REDIS LIB ERROR [unsubscribe]', error );
+        throw error;
+    }
+};
+
 /**
  * Retrieves information and statistics about the Redis server.
  * @returns {Promise<string>} - A promise that resolves with server information.