@ti-engine/core 1.1.10 → 1.2.3

package/CHANGELOG.md

@@ -1,133 +1,155 @@
-# ti-engine changelog
-
-This document will contain the list of changes made to the framework. The format is based on the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
-
-## Version 1.1.10
-* fix(cache): fix redis client creation sequence. It is now created inside the constructor as intended. It still needs to be initialized explicitly using the `initialize` method.
-
-## Version 1.1.9
-* feat(redis integration)!: change the way the `redis` client is initialized. Instead of happening automatically on class instantiation, it is now initialized on demand using the `initialize` method.
-* feat(cache): change the way the main cache instance is initialized in compliance with the new redis integration
-* feat(message memory cache)!: change the way the message memory cache is initialized in compliance with the new redis integration. The `initialize` method needs to be called explicitly to initialize the cache instance before it can be used.
-* fix(message dispatcher): fix the way the `messageExchange` is initialized in the `MessageDispatcher` class (was not returning a promise)
-
-## Version 1.1.8
-* feat(auditing): change export of the singleton class in an `instance` variable for consistency and clarity
-* feat(message dispatcher): change export of the singleton class in an `instance` variable for consistency and clarity
-* feat(cache): change export of the singleton class in an `instance` variable for consistency and clarity
-* feat(service executor): implement service registration retry policy
-
-## Version 1.1.7
-* feat(start instance): add support for the detection of `SIGBREAK` events and graceful shutdown on Windows
-* feat(service instance)!: prevent the initialization of multiple `ServiceInstance` within the same process
-* feat(message tracer)!: covert to singleton instance and add initialization method
-* feat(message dispatcher): initialize the message tracer on start before message exchange is enabled
-* fix(message tracer): optimize `recordTraceEntry` to not call set JSON command on every request
-* fix(gcloud integration): fix the bool conversion of the `TI_GCLOUD_ENABLED` ENV variable
-* fix(redis integration): update links to official commands documentation
-
-## Version 1.1.6
-* feat(start instance): add fail-fast mode as default behavior on promise unhandled rejections
-* feat(start instance): implement functionality to derive safe default service domain name when none is provided in the configuration
-* feat(config): add support for new ENV variable `TI_FAIL_FAST_ON_UNHANDLED_OFF` that controls the fail-fast mode
-* feat(service instance): ensure instance ID naming standard is followed when creating new instances and no ID is provided in the configuration
-* feat(redis integration): marked command `hmset` as deprecated (according to official documentation)
-* feat(redis integration)!: change redis client default behavior: set to automatically resend all pending commands on connection recovery with no limit on the retry attempts. This behavior cannot be changed. Arguments `autoRetryUnfulfilled` and `maxRetries` have been removed from the constructor
-* feat(redis integration)!: add options to configure redis connection retry policy. This can be controlled with two new arguments in the constructor `retryMaxIntervalMs` and `retryMaxAttempts`.
-* feat(redis integration)!: improve and extend the behavior of pub/sub implementation functionality. The `subscribeCommand` method can now only subscribe once to the same channel. The client instance will keep a map of all channels it has subscribed to. To unsubscribe, use the `unsubscribeCommand` method
-* feat(redis integration): add a `shutDown` method to gracefully close a redis connection. This is now used on instance shut down sequence as well as in the default message sender and receiver implementations
-* fix(start instance): fix the logging of reason for unhandled rejections and multiple resolves
-* fix(service instance): use the static service domain name to initialize the health check instead of the ENV variable
-* fix(redis integration): add detection of ReJSON2 in the verification of JSON support in the redis server
-* build(npm): update npm dependencies to their latest versions
-* docs: add section about ENV variables to the `README.md` file
-
-## Version 1.1.5
-
-* fix(service instance): add overrides of the `reportHealthy` method in `ServiceConsumer` and `ServiceProvider` classes
-* fix(tester): implement `reportHealthy` method
-* docs(license): add a `LICENSE` file
-* docs(license): change all licensing information in source files to GNU 3.0
-* docs: improve the information in `README.md` file
-
-## Version 1.1.4
-
-* feat(service instance): expose method `reportHealthy` and mark it as virtual to allow for overrides with custom health status reporting logic
-
-## Version 1.1.3
-
-* feat(config)!: removed ENV variable `TI_OPERATION_MODE` as it was duplicating the practical purpose of `NODE_ENV`
-* feat(config)!: setting `OPERATION_MODE` is now initialized by the `NODE_ENV` ENV variable (if provided)
-* feat(service instance): show application operation mode in log at successful startup
-* docs: add more sections and information in `README.md`
-
-## Version 1.1.2
-
-* feat(localization): add new functionality for localization based on labels and system language. It is currently utilized by the `exceptions` module for localizing the exception descriptions. The new `localization` module can also be accessed externally in the implementing application's files via standard import
-* feat(config): add new setting `localization.labelsPath` that specifies the file path for the localization labels
-* feat(config): add new setting `localization.language` that specifies the language to be used for the labels
-* feat(config): add new ENV variable `TI_LOCALIZATION_LABELS_PATH` that controls the `localization.labelsPath` setting
-* feat(config): add new ENV variable `TI_LOCALIZATION_LANGUAGE` that controls the `localization.language` setting
-* feat(logger): log exception label instead of system-level description
-* fix(start instance): fix the order of ENV loading in the `start-instance.js` script. It will now properly load the `.env` file first and then proceed with any configuration overrides in `config` module
-* fix(service provider): normalize service file paths on dynamic service handler loading
-* build(npm): update npm dependencies to their latest versions
-
-## Version 1.1.1
-
-* feat(config): add new ENV variable `TI_AUDITING_LOG_DETAILS` that controls the `auditing.logDetails` setting
-* feat(service provider): add a method that returns a list of the currently registered services
-* feat(tester service): improved the structure, configuration, and inline docs of tester service
-* fix(logger): fix the way Exception is logged when it's a part of the main logging data object
-* docs(readme): expanded the general documentation in `README.md` with a new section and improved many of the older sections
-* docs: improved some of the JSDoc definitions across the framework
-
-## Version 1.1.0
-
-* feat(redis integration): implement better process for fetching and storing the remote Redis server settings and enabled features
-* feat(redis integration): add getter method `serverVersion` that returns the Redis server version
-* feat(redis integration): add support for RedisJSON functionality
-* feat(redis integration): add getter method `isJSONSupported` to verify if this module is enabled/supported in Redis server
-* feat(redis integration): add separate enum for override modes `TiRedisOverrideMode`
-* feat(redis integration): add support for executing any single command in Redis that is otherwise unsupported by the underlying framework. Use method `callCommand` for that in case you need to access something more exotic or currently unimplemented
-* feat(cache): add support for working with JSON values. Currently supporting operations `set`, `get`, and `append array` with more coming in future versions
-* feat(cache): add support for setting manual expiration of values
-* feat(message tracer): change log level of trace entries from `DEBUG` to `NOTICE` for all events
-* feat(message tracer): add functionality for storing the trace entries in the `cache` in JSON format. This is the default behavior and will always work. Traces can later be retrieved from the `cache` for further processing by specialized application
-* feat(message tracer): add new property `traceTimestamp` to the trace entries as it may differ from the actual message timestamp
-* feat(config): add new setting `messageExchange.traceExpirationTime` that controls the preservation time for all trace entries. Default is one hour and will be refreshed every time a new trace is generated. Setting this to `0` will disable
-  expiration altogether
-* feat(config): add new setting `messageExchange.traceRepository` that specifies the name of the key in `cache` that will store the trace entries. The default one should be sufficient for most cases
-* feat(config): change default of setting `messageExchange.traceLogEnabled` to `false`. With this change trace entries will not be written to the standard log output
-* feat(exceptions): add new exception code `1006` as `E_GEN_FEATURE_UNSUPPORTED` to indicate functionality that is unsupported by the system or integrated application
-* refactor(config)!: correct the name of the ENV variable controlling `memoryCache.user` to `TI_MEMORY_CACHE_USER` from previous `MEMORY_CACHE_USER`
-* build(npm): update npm development dependencies to their latest versions
-* docs: update some JSDoc types and other entries to reflect the current state of the code
-
-## Version 1.0.14
-
-* feat(message exchange): improve the behavior of `onConnectionRecovered` and `onConnectionDisrupted` events in modules `cache`, `message-handler` and `service-executor` to prevent cross-activation or deactivation
-* feat(redis integration): improve Redis integration for greater stability, support of Redis Cloud, and support for Redis 7
-* feat(config): enable setting `auditing.logDetails` by default for all logs
-* docs: update general documentation
-
-## Version 1.0.13
-
-* build(npm): update npm dependencies to their latest versions
-
-## Version 1.0.12
-
-* build(npm): update npm dependencies to their latest versions
-
-## Version 1.0.11
-
-* feat(message exchange): implement message tampering and insertion protection
-* feat(config): provide option to turn on/off the message tampering and insertion protection
-* feat(config): provide option to turn on/off message tracing
-* build(npm): update npm dependencies to their latest versions
-* refactor(config)!: rename all environment variables that set configuration settings to match their related setting
-* docs: add a change log
-
-## Version 1.0.0
-
+# ti-engine changelog
+
+This document will contain the list of changes made to the framework. The format is based on the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+## Version 1.2.3
+* feat(start instance): add support for providing a custom path to the `.env` file to be used at service startup as process argument. Accepted arguments are `--env`, `--env-file`, `--dotenv`, `--dotenv-path`, and `-e`. The path itself should be relative to the working directory and should include the file name
+
+## Version 1.2.2
+* feat(start instance): change package `dotenv` to `@dotenvx/dotenvx` for loading of ENV variables. The new package supports encrypting the ENV variables. For more information see https://dotenvx.com/docs/
+
+## Version 1.2.1
+* feat(localization): add support for adding custom labels to the localization system. These have to follow the same format as the system labels
+* docs: add section about localization to the `README.md` file
+
+## Version 1.2.0
+* feat(config)!: change the setting `localization.labelsPath` to be an array of strings. It can now be used to supply any additional custom labels in one or more files to the framework
+* feat(message memory cache): implement graceful exception handling during shut down procedure in `receiveMessage` and `sendMessage` methods
+* fix(default message sender): add missing initialization of the memory cache on enable
+* fix(default message receiver): add missing initialization of the memory cache on enable
+* fix(message receiver): ensure `receive` method is no longer called recursively when the receiver has been disabled
+* fix(redis integration)!: change the way the Redis client is initialized as the previous sequence was leaving unresolved promises and in some cases failed to fetch the Redis server settings. Also, it will now notify the listeners only once when the server settings are fetched and the connection is ready to be used
+* fix(localization)!: change the way system labels are loaded as the previous implementation could cause a critical startup error if the working dir was different from expected
+* fix(package): add the missing main export to the `start-instance.js` script. Without it was impossible to start the framework in specific cases like in a workspaces repository
+* fix(message tracer): exclude `E_GEN_FEATURE_UNSUPPORTED` exception from the initialization of the message tracer exception handler
+* fix(service executor)!: change the individual service registration process to ensure service registration does actually happen before the service provider finishes its initialization
+
+## Version 1.1.10
+* fix(cache): fix redis client creation sequence. It is now created inside the constructor as intended. It still needs to be initialized explicitly using the `initialize` method.
+
+## Version 1.1.9
+* feat(redis integration)!: change the way the `redis` client is initialized. Instead of happening automatically on class instantiation, it is now initialized on demand using the `initialize` method.
+* feat(cache): change the way the main cache instance is initialized in compliance with the new redis integration
+* feat(message memory cache)!: change the way the message memory cache is initialized in compliance with the new redis integration. The `initialize` method needs to be called explicitly to initialize the cache instance before it can be used.
+* fix(message dispatcher): fix the way the `messageExchange` is initialized in the `MessageDispatcher` class (was not returning a promise)
+
+## Version 1.1.8
+* feat(auditing): change export of the singleton class in an `instance` variable for consistency and clarity
+* feat(message dispatcher): change export of the singleton class in an `instance` variable for consistency and clarity
+* feat(cache): change export of the singleton class in an `instance` variable for consistency and clarity
+* feat(service executor): implement service registration retry policy
+
+## Version 1.1.7
+* feat(start instance): add support for the detection of `SIGBREAK` events and graceful shutdown on Windows
+* feat(service instance)!: prevent the initialization of multiple `ServiceInstance` within the same process
+* feat(message tracer)!: covert to singleton instance and add initialization method
+* feat(message dispatcher): initialize the message tracer on start before message exchange is enabled
+* fix(message tracer): optimize `recordTraceEntry` to not call set JSON command on every request
+* fix(gcloud integration): fix the bool conversion of the `TI_GCLOUD_ENABLED` ENV variable
+* fix(redis integration): update links to official commands documentation
+
+## Version 1.1.6
+* feat(start instance): add fail-fast mode as default behavior on promise unhandled rejections
+* feat(start instance): implement functionality to derive safe default service domain name when none is provided in the configuration
+* feat(config): add support for new ENV variable `TI_FAIL_FAST_ON_UNHANDLED_OFF` that controls the fail-fast mode
+* feat(service instance): ensure instance ID naming standard is followed when creating new instances and no ID is provided in the configuration
+* feat(redis integration): marked command `hmset` as deprecated (according to official documentation)
+* feat(redis integration)!: change redis client default behavior: set to automatically resend all pending commands on connection recovery with no limit on the retry attempts. This behavior cannot be changed. Arguments `autoRetryUnfulfilled` and `maxRetries` have been removed from the constructor
+* feat(redis integration)!: add options to configure redis connection retry policy. This can be controlled with two new arguments in the constructor `retryMaxIntervalMs` and `retryMaxAttempts`.
+* feat(redis integration)!: improve and extend the behavior of pub/sub implementation functionality. The `subscribeCommand` method can now only subscribe once to the same channel. The client instance will keep a map of all channels it has subscribed to. To unsubscribe, use the `unsubscribeCommand` method
+* feat(redis integration): add a `shutDown` method to gracefully close a redis connection. This is now used on instance shut down sequence as well as in the default message sender and receiver implementations
+* fix(start instance): fix the logging of reason for unhandled rejections and multiple resolves
+* fix(service instance): use the static service domain name to initialize the health check instead of the ENV variable
+* fix(redis integration): add detection of ReJSON2 in the verification of JSON support in the redis server
+* build(npm): update npm dependencies to their latest versions
+* docs: add section about ENV variables to the `README.md` file
+
+## Version 1.1.5
+
+* fix(service instance): add overrides of the `reportHealthy` method in `ServiceConsumer` and `ServiceProvider` classes
+* fix(tester): implement `reportHealthy` method
+* docs(license): add a `LICENSE` file
+* docs(license): change all licensing information in source files to GNU 3.0
+* docs: improve the information in `README.md` file
+
+## Version 1.1.4
+
+* feat(service instance): expose method `reportHealthy` and mark it as virtual to allow for overrides with custom health status reporting logic
+
+## Version 1.1.3
+
+* feat(config)!: removed ENV variable `TI_OPERATION_MODE` as it was duplicating the practical purpose of `NODE_ENV`
+* feat(config)!: setting `OPERATION_MODE` is now initialized by the `NODE_ENV` ENV variable (if provided)
+* feat(service instance): show application operation mode in log at successful startup
+* docs: add more sections and information in `README.md`
+
+## Version 1.1.2
+
+* feat(localization): add new functionality for localization based on labels and system language. It is currently utilized by the `exceptions` module for localizing the exception descriptions. The new `localization` module can also be accessed externally in the implementing application's files via standard import
+* feat(config): add new setting `localization.labelsPath` that specifies the file path for the localization labels
+* feat(config): add new setting `localization.language` that specifies the language to be used for the labels
+* feat(config): add new ENV variable `TI_LOCALIZATION_LABELS_PATH` that controls the `localization.labelsPath` setting
+* feat(config): add new ENV variable `TI_LOCALIZATION_LANGUAGE` that controls the `localization.language` setting
+* feat(logger): log exception label instead of system-level description
+* fix(start instance): fix the order of ENV loading in the `start-instance.js` script. It will now properly load the `.env` file first and then proceed with any configuration overrides in `config` module
+* fix(service provider): normalize service file paths on dynamic service handler loading
+* build(npm): update npm dependencies to their latest versions
+
+## Version 1.1.1
+
+* feat(config): add new ENV variable `TI_AUDITING_LOG_DETAILS` that controls the `auditing.logDetails` setting
+* feat(service provider): add a method that returns a list of the currently registered services
+* feat(tester service): improved the structure, configuration, and inline docs of tester service
+* fix(logger): fix the way Exception is logged when it's a part of the main logging data object
+* docs(readme): expanded the general documentation in `README.md` with a new section and improved many of the older sections
+* docs: improved some of the JSDoc definitions across the framework
+
+## Version 1.1.0
+
+* feat(redis integration): implement better process for fetching and storing the remote Redis server settings and enabled features
+* feat(redis integration): add getter method `serverVersion` that returns the Redis server version
+* feat(redis integration): add support for RedisJSON functionality
+* feat(redis integration): add getter method `isJSONSupported` to verify if this module is enabled/supported in Redis server
+* feat(redis integration): add separate enum for override modes `TiRedisOverrideMode`
+* feat(redis integration): add support for executing any single command in Redis that is otherwise unsupported by the underlying framework. Use method `callCommand` for that in case you need to access something more exotic or currently unimplemented
+* feat(cache): add support for working with JSON values. Currently supporting operations `set`, `get`, and `append array` with more coming in future versions
+* feat(cache): add support for setting manual expiration of values
+* feat(message tracer): change log level of trace entries from `DEBUG` to `NOTICE` for all events
+* feat(message tracer): add functionality for storing the trace entries in the `cache` in JSON format. This is the default behavior and will always work. Traces can later be retrieved from the `cache` for further processing by specialized application
+* feat(message tracer): add new property `traceTimestamp` to the trace entries as it may differ from the actual message timestamp
+* feat(config): add new setting `messageExchange.traceExpirationTime` that controls the preservation time for all trace entries. Default is one hour and will be refreshed every time a new trace is generated. Setting this to `0` will disable
+  expiration altogether
+* feat(config): add new setting `messageExchange.traceRepository` that specifies the name of the key in `cache` that will store the trace entries. The default one should be sufficient for most cases
+* feat(config): change default of setting `messageExchange.traceLogEnabled` to `false`. With this change trace entries will not be written to the standard log output
+* feat(exceptions): add new exception code `1006` as `E_GEN_FEATURE_UNSUPPORTED` to indicate functionality that is unsupported by the system or integrated application
+* refactor(config)!: correct the name of the ENV variable controlling `memoryCache.user` to `TI_MEMORY_CACHE_USER` from previous `MEMORY_CACHE_USER`
+* build(npm): update npm development dependencies to their latest versions
+* docs: update some JSDoc types and other entries to reflect the current state of the code
+
+## Version 1.0.14
+
+* feat(message exchange): improve the behavior of `onConnectionRecovered` and `onConnectionDisrupted` events in modules `cache`, `message-handler` and `service-executor` to prevent cross-activation or deactivation
+* feat(redis integration): improve Redis integration for greater stability, support of Redis Cloud, and support for Redis 7
+* feat(config): enable setting `auditing.logDetails` by default for all logs
+* docs: update general documentation
+
+## Version 1.0.13
+
+* build(npm): update npm dependencies to their latest versions
+
+## Version 1.0.12
+
+* build(npm): update npm dependencies to their latest versions
+
+## Version 1.0.11
+
+* feat(message exchange): implement message tampering and insertion protection
+* feat(config): provide option to turn on/off the message tampering and insertion protection
+* feat(config): provide option to turn on/off message tracing
+* build(npm): update npm dependencies to their latest versions
+* refactor(config)!: rename all environment variables that set configuration settings to match their related setting
+* docs: add a change log
+
+## Version 1.0.0
+
 * feat: create initial version of the framework

package/README.md

@@ -395,9 +395,9 @@ GCLOUD_PROJECT_ID (Alpha)
 : This setting holds the project ID for the GCloud integration module.
 
 LOCALIZATION_LABELS_PATH
-: JSON path `localization.labelsPath`, type `string`, default `../core/bin/localization/labels.json`
+: JSON path `localization.labelsPath`, type `Array<string>`, default `[]`
 : ENV variable `TI_LOCALIZATION_LABELS_PATH`
-: This setting holds the file system path to the `.json` file containing the localization information. By default, the framework provides such a file with english texts that can be customized further. Alternatively, you can provide your own file from a different location, but it still has to follow the rules of the `localization` module.
+: This setting holds a list of paths to custom `.json` files containing additional localization information. By default, the framework also provides such a file with english texts that can be customized further. All additional JSONs in these files have to follow the rules and structure of the `localization` module.
 
 LOCALIZATION_LANGUAGE
 : JSON path `localization.language`, type `string`, default `en`
@@ -497,4 +497,24 @@ OPERATION_MODE
 
 ## Advanced topics
 
-Under development...
+### Localization
+
+The **ti-engine** framework provides a localization mechanism that allows you to translate labels into localized text. The framework comes with a default set of labels that can be found in the `localization` module. You can add your own custom labels to this set by providing one or more JSON files with the same structure as the default one (see below). The path to these files should be specified in the `LOCALIZATION_LABELS_PATH` setting. On startup, the framework will load all the JSON files and merge them into a single repository.
+
+The following is an example of a custom localization file (the names in brackets can be replaced with your own values):
+
+```json
+{
+  "labels": {
+    "[category]": {
+      "[sub-category]": {
+        "[label]": {
+          "en": "[localized label text]"
+        }
+      }
+    }
+  }
+}
+```
+
+The individual languages are specified with a two-letter code. The default language is `en` (English). If you want to use a different language, you can set the `LOCALIZATION_LANGUAGE` setting to the desired language code.

package/bin/settings.json

@@ -12,7 +12,7 @@
     "projectID": ""
   },
   "localization": {
-    "labelsPath": "../core/bin/localization/labels.json",
+    "labelsPath": [],
     "language": "en"
   },
   "memoryCache": {

package/bin/start-instance.js

@@ -11,7 +11,28 @@
 const path = require( "path" );
 
 // Load any ENV variables defined in a .env file - before including any framework files:
-require( "dotenv" ).config( { path: path.join( process.cwd(), ".env" ) } );
+// - If an env file path is provided via process arguments, use it; otherwise, default to CWD/.env
+const envFilePath = ( () => {
+    let envPath = path.join( process.cwd(), ".env" );
+    try {
+        const argv = Array.isArray( process.argv ) ? process.argv.slice( 2 ) : [];
+        const aliases = [ "--env", "--env-file", "--dotenv", "--dotenv-path", "-e" ];
+        for ( const key of aliases ) {
+            const idx = argv.indexOf( key );
+            if ( idx !== -1 && idx + 1 < argv.length ) {
+                const value = argv[ idx + 1 ];
+                if ( typeof value === "string" && !value.startsWith( "-" ) ) {
+                    envPath = path.join( process.cwd(), value.trim() );
+                    break;
+                }
+            }
+        }
+    } catch {
+    }
+    return envPath;
+} )();
+
+require( "@dotenvx/dotenvx" ).config( { path: envFilePath } );
 
 const tools = require( "#tools" );
 const logger = require( "#logger" );
@@ -36,7 +57,7 @@ const defaultNameFromClass = ( () => {
 
 process.env.TI_INSTANCE_NAME = process.env.TI_INSTANCE_NAME || defaultNameFromClass;
 
-// Configure the process error handlers:
+// Configure the process termination handlers to ensure a graceful shutdown:
 
 /**
  * Will be used to gracefully shut down the instance.
@@ -75,6 +96,8 @@ process.on( "SIGBREAK", () => {
     shutDownInstance( 0 );
 } );
 
+// Configure the process general error handlers:
+
 process.on( "unhandledRejection", ( reason ) => {
     // Check if the fail-fast behavior has been forcefully disabled:
     const failFastDisabled = tools.toBool( process.env.TI_FAIL_FAST_ON_UNHANDLED_OFF || "" );

package/components/exchange/default/default-message-receiver.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/>.
@@ -43,8 +43,13 @@ class DefaultMessageReceiver extends MessageReceiver {
         return new Promise( ( resolve, reject ) => {
             this.#memoryCache = memoryCache.create( this.connectionIdentifier );
             this.#memoryCache.addConnectionObserver( this );
-            this.receive();
-            resolve();
+            this.#memoryCache.initialize().then( () => {
+                this.isReceiving = true;
+                this.receive();
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
         } );
     }
 
@@ -60,6 +65,7 @@ class DefaultMessageReceiver extends MessageReceiver {
         return new Promise( ( resolve, reject ) => {
             this.isAvailable = false;
             this.#memoryCache.shutDown().then( () => {
+                this.isReceiving = false;
                 this.#memoryCache = null;
                 resolve();
             } ).catch( ( error ) => {
@@ -80,6 +86,7 @@ class DefaultMessageReceiver extends MessageReceiver {
      */
     onReceive() {
         return new Promise( ( resolve, reject ) => {
+            // NOTE: The method execution will block on this call until a message is received:
             this.#memoryCache.receiveMessage( this.receiveQueue ).then( ( lightweightMessage ) => {
                 return this.#memoryCache.retrieveMessagePayload( lightweightMessage, config.getSetting( config.setting.MESSAGE_EXCHANGE_MESSAGE_STORE ) );
             } ).then( ( message ) => {
@@ -92,4 +99,4 @@ class DefaultMessageReceiver extends MessageReceiver {
 
 }
 
-module.exports = DefaultMessageReceiver;
+module.exports = DefaultMessageReceiver;

package/components/exchange/default/default-message-sender.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/>.
@@ -34,7 +34,7 @@ class DefaultMessageSender extends MessageSender {
     /**
      * Used to perform the actual sending of a message.
      * <br/>
-     * NOTE: The default message exchange works with lightweight messages (i.e. will keep the payloads stored in Redis while exchanging).
+     * NOTE: The default message exchange works with lightweight messages (i.e., will keep the payloads stored in Redis while exchanging).
      *
      * @method
      * @param {Message} message The message to send.
@@ -69,7 +69,11 @@ class DefaultMessageSender extends MessageSender {
         return new Promise( ( resolve, reject ) => {
             this.#memoryCache = memoryCache.create( this.connectionIdentifier );
             this.#memoryCache.addConnectionObserver( this );
-            resolve();
+            this.#memoryCache.initialize().then( () => {
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
         } );
     }
 
@@ -94,4 +98,4 @@ class DefaultMessageSender extends MessageSender {
     }
 }
 
-module.exports = DefaultMessageSender;
+module.exports = DefaultMessageSender;

package/components/exchange/message-handler.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/>.
@@ -170,7 +170,7 @@ class MessageHandler extends ConnectionObserver {
     }
 
     /**
-     * An event-triggered method that will notify any observers about primary connection disrupted state.
+     * An event-triggered method that will notify any observers about the primary connection disrupted state.
      * <br/>
      * NOTE: You can override this to add custom functionality but make sure to also call the base method
      * using: super.onConnectionDisrupted( identifier )
@@ -191,4 +191,4 @@ class MessageHandler extends ConnectionObserver {
 
 }
 
-module.exports = MessageHandler;
+module.exports = MessageHandler;

package/components/exchange/message-memory-cache.js

@@ -20,6 +20,7 @@ const redis = require( "#redis-integration" );
 class MessageMemoryCache {
 
     #redisClient = null;
+    #isShuttingDown = false;
 
     /**
      * @constructor
@@ -60,6 +61,7 @@ class MessageMemoryCache {
      * @public
      */
     shutDown( timeoutMs ) {
+        this.#isShuttingDown = true;
         return this.#redisClient.shutDown( timeoutMs );
     }
 
@@ -85,13 +87,17 @@ class MessageMemoryCache {
      */
     sendMessage( message, queue ) {
         return new Promise( ( resolve, reject ) => {
-            let command = [ redis.cacheCommands.LIST_PUSH, queue, tools.stringifyJSON( message ) ];
-            this.#redisClient.executeCommands( [ command ] ).then( ( results ) => {
-                results = results[ 0 ];
-                resolve( ( results && results.length > 1 ) ? results[ 1 ] : undefined );
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
+            if ( this.#isShuttingDown === true ) {
+                reject( exceptions.raise( exceptions.exceptionCode.E_COM_MESSAGE_SENDER_UNAVAILABLE ) );
+            } else {
+                let command = [ redis.cacheCommands.LIST_PUSH, queue, tools.stringifyJSON( message ) ];
+                this.#redisClient.executeCommands( [ command ] ).then( ( results ) => {
+                    results = results[ 0 ];
+                    resolve( ( results && results.length > 1 ) ? results[ 1 ] : undefined );
+                } ).catch( ( error ) => {
+                    reject( exceptions.raise( error ) );
+                } );
+            }
         } );
     }
 
@@ -134,7 +140,11 @@ class MessageMemoryCache {
                 results = ( results && results.length > 1 ) ? results[ 1 ] : undefined;
                 resolve( tools.parseJSON( results ) );
             } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
+                if ( this.#isShuttingDown === true ) {
+                    reject( exceptions.raise( exceptions.exceptionCode.E_COM_MESSAGE_RECEIVER_UNAVAILABLE ) );
+                } else {
+                    reject( exceptions.raise( error ) );
+                }
             } );
         } );
     }