@ti-engine/core 1.1.5 → 1.1.9

package/utils/cache.js

@@ -1,6 +1,6 @@
 /*
  * The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.
- * Copyright © 2021-2023 Boris Kostadinov <kostadinov.boris@gmail.com>
+ * Copyright © 2021-2025 Boris Kostadinov <kostadinov.boris@gmail.com>
  * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  * You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
@@ -36,13 +36,6 @@ class CommonMemoryCache extends ConnectionObserver {
         super();
 
         if ( !CommonMemoryCache.#instance ) {
-            let host = config.getSetting( config.setting.MEMORY_CACHE_REDIS_HOST );
-            let port = config.getSetting( config.setting.MEMORY_CACHE_REDIS_PORT );
-            let db = config.getSetting( config.setting.MEMORY_CACHE_REDIS_DB );
-            let authKey = config.getSetting( config.setting.MEMORY_CACHE_AUTH_KEY );
-            let user = config.getSetting( config.setting.MEMORY_CACHE_USER );
-            this.#redisClient = redis.createRedisClient( this.#connectionIdentifier, host, port, authKey, user, db );
-            this.#redisClient.addConnectionObserver( this );
             CommonMemoryCache.#instance = this;
         }
         return CommonMemoryCache.#instance;
@@ -57,7 +50,9 @@ class CommonMemoryCache extends ConnectionObserver {
      * @returns {boolean}
      * @public
      */
-    get isOperational() { return this.#isOperational; }
+    get isOperational() {
+        return this.#isOperational;
+    }
 
     /**
      * Property returning the connection identifier of the cache service.
@@ -66,7 +61,40 @@ class CommonMemoryCache extends ConnectionObserver {
      * @returns {string}
      * @public
      */
-    get connectionIdentifier() { return this.#connectionIdentifier; }
+    get connectionIdentifier() {
+        return this.#connectionIdentifier;
+    }
+
+    /**
+     * Used to initialize the cache service.
+     *
+     * @method
+     * @returns {Promise}
+     * @public
+     */
+    initialize() {
+        let host = config.getSetting( config.setting.MEMORY_CACHE_REDIS_HOST );
+        let port = config.getSetting( config.setting.MEMORY_CACHE_REDIS_PORT );
+        let db = config.getSetting( config.setting.MEMORY_CACHE_REDIS_DB );
+        let authKey = config.getSetting( config.setting.MEMORY_CACHE_AUTH_KEY );
+        let user = config.getSetting( config.setting.MEMORY_CACHE_USER );
+
+        this.#redisClient = redis.createRedisClient( this.#connectionIdentifier );
+        this.#redisClient.addConnectionObserver( this );
+
+        return this.#redisClient.initialize( host, port, authKey, user, db );
+    }
+
+    /**
+     * Used to gracefully shut down the cache service.
+     *
+     * @method
+     * @return {Promise}
+     * @public
+     */
+    shutDown() {
+        return this.#redisClient.shutDown( 250 );
+    }
 
     /**
      * Needs to be invoked by the connection handler when the connection is disrupted.
@@ -108,7 +136,7 @@ class CommonMemoryCache extends ConnectionObserver {
     }
 
     /**
-     * Used to search for keys by given pattern.
+     * Used to search for keys by a given pattern.
      *
      * @method
      * @param {string} pattern
@@ -364,7 +392,7 @@ class CommonMemoryCache extends ConnectionObserver {
     /**
      * Used to add multiple values to multiple sets in one transactional request.
      * <br/>
-     * NOTE: The two arrays of keys and values must have correct index relations (i.e. first pair on keys[0] and values[0] and so on)!
+     * NOTE: The two arrays of keys and values must have correct index relations (i.e., first pair on keys[0] and values[0] and so on)!
      *
      * @method
      * @param {string[]} keys
@@ -391,7 +419,7 @@ class CommonMemoryCache extends ConnectionObserver {
     }
 
     /**
-     * Used to check if the provided value is member of the specified set.
+     * Used to check if the provided value is a member of the specified set.
      *
      * @method
      * @param {string} setName
@@ -470,6 +498,7 @@ class CommonMemoryCache extends ConnectionObserver {
      * Used to set a single hash field.
      *
      * @method
+     * @deprecated
      * @param {string} key
      * @param {string} name
      * @param {*} value
@@ -495,6 +524,7 @@ class CommonMemoryCache extends ConnectionObserver {
      * Used to set multiple hash fields.
      *
      * @method
+     * @deprecated
      * @param {string} key
      * @param {Object[]} fields
      * @param {string} fields[].name
@@ -646,4 +676,4 @@ class CommonMemoryCache extends ConnectionObserver {
 }
 
 const instance = new CommonMemoryCache();
-module.exports = Object.freeze( instance );
+module.exports.instance = Object.freeze( instance );

package/utils/config.js

@@ -1,6 +1,6 @@
 /*
  * The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.
- * Copyright © 2021-2023 Boris Kostadinov <kostadinov.boris@gmail.com>
+ * Copyright © 2021-2025 Boris Kostadinov <kostadinov.boris@gmail.com>
  * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  * You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
@@ -33,6 +33,8 @@ const tools = require( "#tools" );
  * @property {EnvironmentVariable} env.TI_MEMORY_CACHE_REDIS_DB
  * @property {EnvironmentVariable} env.TI_MEMORY_CACHE_REDIS_HOST
  * @property {EnvironmentVariable} env.TI_MEMORY_CACHE_REDIS_PORT
+ * @property {EnvironmentVariable} env.TI_MEMORY_CACHE_RETRY_MAX_ATTEMPTS
+ * @property {EnvironmentVariable} env.TI_MEMORY_CACHE_RETRY_MAX_INTERVAL
  * @property {EnvironmentVariable} env.TI_MEMORY_CACHE_USER
  * @property {EnvironmentVariable} env.TI_MESSAGE_EXCHANGE_SECURITY_HASH_ENABLED
  * @property {EnvironmentVariable} env.TI_MESSAGE_EXCHANGE_SECURITY_HASH_KEY
@@ -80,6 +82,8 @@ const tools = require( "#tools" );
  * @property {number} redisDB
  * @property {string} redisHost
  * @property {number} redisPort
+ * @property {number} retryMaxAttempts
+ * @property {number} retryMaxInterval
  * @property {string} user
  */
 
@@ -122,6 +126,8 @@ let settingsEnum = tools.enum( {
     MEMORY_CACHE_REDIS_DB: [ "memoryCache.redisDB", "redisDB", "" ],
     MEMORY_CACHE_REDIS_HOST: [ "memoryCache.redisHost", "redisHost", "" ],
     MEMORY_CACHE_REDIS_PORT: [ "memoryCache.redisPort", "redisPort", "" ],
+    MEMORY_CACHE_RETRY_MAX_ATTEMPTS: [ "memoryCache.retryMaxAttempts", "retryMaxAttempts", "" ],
+    MEMORY_CACHE_RETRY_MAX_INTERVAL: [ "memoryCache.retryMaxInterval", "retryMaxInterval", "" ],
     MEMORY_CACHE_USER: [ "memoryCache.user", "user", "" ],
     MESSAGE_EXCHANGE_QUEUE_PREFIX: [ "messageExchange.messageQueuePrefix", "messageQueuePrefix", "" ],
     MESSAGE_EXCHANGE_MESSAGE_STORE: [ "messageExchange.messageStore", "messageStore", "" ],
@@ -162,6 +168,8 @@ if ( settings.memoryCache ) {
     settings.memoryCache.redisDB = ( process.env.TI_MEMORY_CACHE_REDIS_DB !== undefined ) ? process.env.TI_MEMORY_CACHE_REDIS_DB : settings.memoryCache.redisDB;
     settings.memoryCache.redisHost = ( process.env.TI_MEMORY_CACHE_REDIS_HOST !== undefined ) ? process.env.TI_MEMORY_CACHE_REDIS_HOST : settings.memoryCache.redisHost;
     settings.memoryCache.redisPort = ( process.env.TI_MEMORY_CACHE_REDIS_PORT !== undefined ) ? process.env.TI_MEMORY_CACHE_REDIS_PORT : settings.memoryCache.redisPort;
+    settings.memoryCache.retryMaxAttempts = ( process.env.TI_MEMORY_CACHE_RETRY_MAX_ATTEMPTS !== undefined ) ? process.env.TI_MEMORY_CACHE_RETRY_MAX_ATTEMPTS : settings.memoryCache.retryMaxAttempts;
+    settings.memoryCache.retryMaxInterval = ( process.env.TI_MEMORY_CACHE_RETRY_MAX_INTERVAL !== undefined ) ? process.env.TI_MEMORY_CACHE_RETRY_MAX_INTERVAL : settings.memoryCache.retryMaxInterval;
     settings.memoryCache.user = ( process.env.TI_MEMORY_CACHE_USER !== undefined ) ? process.env.TI_MEMORY_CACHE_USER : settings.memoryCache.user;
 }
 if ( settings.messageExchange ) {

package/utils/localization.js

@@ -1,6 +1,6 @@
 /*
  * The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.
- * Copyright © 2021-2023 Boris Kostadinov <kostadinov.boris@gmail.com>
+ * Copyright © 2021-2025 Boris Kostadinov <kostadinov.boris@gmail.com>
  * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  * You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
@@ -27,4 +27,4 @@ Object.freeze( labels );
  */
 module.exports.getLabel = ( label ) => {
     return _.get( labels, label + "." + config.getSetting( config.setting.LOCALIZATION_LANGUAGE ), defaultEmptyLabel );
-};
+};

package/utils/logger.js

@@ -1,6 +1,6 @@
 /*
  * The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.
- * Copyright © 2021-2023 Boris Kostadinov <kostadinov.boris@gmail.com>
+ * Copyright © 2021-2025 Boris Kostadinov <kostadinov.boris@gmail.com>
  * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  * You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
@@ -72,7 +72,6 @@ const exceptionToLog = ( exception ) => {
  * @public
  */
 module.exports.log = ( message, level = logSeverityEnum.DEFAULT, data = {}, thread = "main" ) => {
-    /** @type {Auditing} */
     const auditing = require( "#auditing" );
 
     if ( data instanceof Error ) {
@@ -83,5 +82,5 @@ module.exports.log = ( message, level = logSeverityEnum.DEFAULT, data = {}, thre
         data.exception = exceptionToLog( data.exception );
     }
 
-    auditing.log( message, level, thread, data );
-};
+    auditing.instance.log( message, level, thread, data );
+};