@ti-engine/core 1.6.1 → 1.7.2

package/components/exchange/default/default-message-sender.js

@@ -1,101 +1,101 @@
-/*
- * 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-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/>.
-*/
-
-const MessageSender = require( "#message-sender" );
-const _ = require( "lodash" );
-const config = require( "#config" );
-const exceptions = require( "#exceptions" );
-const memoryCache = require( "#message-memory-cache" );
-
-/**
- * The default {@link MessageSender} behavior for the Ti Engine using Redis for message exchange.
- *
- * @class DefaultMessageSender
- * @extends MessageSender
- * @public
- */
-class DefaultMessageSender extends MessageSender {
-
-    #memoryCache;
-
-    /**
-     * @constructor
-     * @param {string} identifier An identifier for this message handler. Should be unique in the context of the message exchange.
-     */
-    constructor( identifier ) {
-        super( identifier );
-    }
-
-    /**
-     * 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).
-     *
-     * @method
-     * @param {Message} message The message to send.
-     * @param {string} queue The route to destination (queue) for the message as recognized by the {@link MessageExchange} implementation.
-     * @returns {Promise}
-     * @override
-     * @public
-     */
-    onSend( message, queue ) {
-        return new Promise( ( resolve, reject ) => {
-            this.#memoryCache.storeMessagePayload( message.payload, config.getSetting( config.setting.MESSAGE_EXCHANGE_MESSAGE_STORE ) ).then( ( storeID ) => {
-                let lightweightMessage = _.cloneDeep( message );
-                lightweightMessage.payload = storeID;
-                return this.#memoryCache.sendMessage( lightweightMessage, queue );
-            } ).then( () => {
-                resolve();
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to initialize and enable the communication capabilities of the handler.
-     *
-     * @method
-     * @returns {Promise}
-     * @override
-     * @public
-     */
-    enable() {
-        return new Promise( ( resolve, reject ) => {
-            this.#memoryCache = memoryCache.create( this.connectionIdentifier );
-            this.#memoryCache.addConnectionObserver( this );
-            this.#memoryCache.initialize().then( () => {
-                resolve();
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to shut down and disable the communication behavior of the handler.
-     *
-     * @method
-     * @returns {Promise}
-     * @override
-     * @public
-     */
-    disable() {
-        return new Promise( ( resolve, reject ) => {
-            this.isAvailable = false;
-            this.#memoryCache.shutDown().then( () => {
-                this.#memoryCache = null;
-                resolve();
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-}
-
+/*
+ * 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-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/>.
+*/
+
+const MessageSender = require( "#message-sender" );
+const _ = require( "lodash" );
+const config = require( "#config" );
+const exceptions = require( "#exceptions" );
+const memoryCache = require( "#message-memory-cache" );
+
+/**
+ * The default {@link MessageSender} behavior for the Ti Engine using Redis for message exchange.
+ *
+ * @class DefaultMessageSender
+ * @extends MessageSender
+ * @public
+ */
+class DefaultMessageSender extends MessageSender {
+
+    #memoryCache;
+
+    /**
+     * @constructor
+     * @param {string} identifier An identifier for this message handler. Should be unique in the context of the message exchange.
+     */
+    constructor( identifier ) {
+        super( identifier );
+    }
+
+    /**
+     * 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).
+     *
+     * @method
+     * @param {Message} message The message to send.
+     * @param {string} queue The route to destination (queue) for the message as recognized by the {@link MessageExchange} implementation.
+     * @returns {Promise}
+     * @override
+     * @public
+     */
+    onSend( message, queue ) {
+        return new Promise( ( resolve, reject ) => {
+            this.#memoryCache.storeMessagePayload( message.payload, config.getSetting( config.setting.MESSAGE_EXCHANGE_MESSAGE_STORE ) ).then( ( storeID ) => {
+                let lightweightMessage = _.cloneDeep( message );
+                lightweightMessage.payload = storeID;
+                return this.#memoryCache.sendMessage( lightweightMessage, queue );
+            } ).then( () => {
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to initialize and enable the communication capabilities of the handler.
+     *
+     * @method
+     * @returns {Promise}
+     * @override
+     * @public
+     */
+    enable() {
+        return new Promise( ( resolve, reject ) => {
+            this.#memoryCache = memoryCache.create( this.connectionIdentifier );
+            this.#memoryCache.addConnectionObserver( this );
+            this.#memoryCache.initialize().then( () => {
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to shut down and disable the communication behavior of the handler.
+     *
+     * @method
+     * @returns {Promise}
+     * @override
+     * @public
+     */
+    disable() {
+        return new Promise( ( resolve, reject ) => {
+            this.isAvailable = false;
+            this.#memoryCache.shutDown().then( () => {
+                this.#memoryCache = null;
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+}
+
 module.exports = DefaultMessageSender;

package/components/exchange/message-dispatcher.js

@@ -1,169 +1,169 @@
-/*
- * 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-2026 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/>.
-*/
-
-const tools = require( "#tools" );
-const exceptions = require( "#exceptions" );
-const logger = require( "#logger" );
-const messageTracer = require( "#message-tracer" );
-
-/**
- * Used to create and/or return a Message Dispatcher singleton instance.
- * This class handles the internal message dispatching between the microservices.
- *
- * @class MessageDispatcher
- * @singleton
- * @public
- */
-class MessageDispatcher {
-
-    static #instance = null;
-    #messageExchange;
-
-    /**
-     * @constructor
-     * @returns {MessageDispatcher}
-     */
-    constructor() {
-        if ( !MessageDispatcher.#instance ) {
-            MessageDispatcher.#instance = this;
-        }
-
-        return MessageDispatcher.#instance;
-    }
-
-    /* Public interface */
-
-    /**
-     * Used to initialize the message dispatcher and enable the message exchange.
-     *
-     * @method
-     * @param {MessageExchange} messageExchange The message exchange instance to be used by the dispatcher.
-     * @param {boolean} configureInbound If set to 'true' it tells the message exchange to set up inbound messaging.
-     * @param {boolean} configureOutbound If set to 'true' it tells the message exchange to set up outbound messaging.
-     * @returns {Promise}
-     * @public
-     */
-    initialize( messageExchange, configureInbound, configureOutbound ) {
-        return new Promise( ( resolve, reject ) => {
-            this.#messageExchange = messageExchange;
-
-            // Initialize the message tracer before enabling the message exchange:
-            messageTracer.instance.initialize().then( () => {
-                return this.#messageExchange.enableMessaging( configureInbound, configureOutbound );
-            } ).then( () => {
-                resolve();
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to shut down the message dispatcher and disable the message exchange.
-     *
-     * @method
-     * @returns {Promise}
-     * @public
-     */
-    shutDown() {
-        return new Promise( ( resolve, reject ) => {
-            this.#messageExchange.disableMessaging().then( () => {
-                this.#messageExchange = null;
-                resolve();
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to send a message request via the message exchange system.
-     *
-     * @method
-     * @param {Message} message The message to send. This can also be a subclass of {@link Message}.
-     * @returns {Promise<string>}
-     * @public
-     */
-    sendRequest( message ) {
-        return new Promise( ( resolve, reject ) => {
-            let retry = new tools.RetryPolicy( 3 );
-            retry.onFailedAttempt( ( error ) => {
-                logger.log( `Failed to send message request with chain ID: ${ message.chainID }`, logger.logSeverity.WARNING, error );
-            } );
-            retry.onRetry( ( attempt, error ) => {
-                logger.log( `Retrying to send message response with chain ID: ${ message.chainID }. This is attempt ${ attempt }...`, logger.logSeverity.NOTICE, ( error ) ? { error: tools.errorToJSON( error ) } : undefined );
-            } );
-
-            messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_REQUEST, messageTracer.dispatchEvent.SENT, messageTracer.messageState.PENDING );
-
-            retry.execute( this.#messageExchange, this.#messageExchange.sendMessageRequest, [ message ] ).then( () => {
-                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_REQUEST, messageTracer.dispatchEvent.DELIVERED, messageTracer.messageState.PENDING );
-                resolve( message.messageID );
-            } ).catch( ( error ) => {
-                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_REQUEST, messageTracer.dispatchEvent.FAILED, messageTracer.messageState.PENDING );
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to send a message response via the message exchange system.
-     *
-     * @method
-     * @param {Message} message The message to send. This can also be a subclass of {@link Message}.
-     * @returns {Promise}
-     * @public
-     */
-    sendResponse( message ) {
-        return new Promise( ( resolve, reject ) => {
-            let retry = new tools.RetryPolicy( 3 );
-            retry.onFailedAttempt( ( error ) => {
-                logger.log( `Failed to send message response with chain ID: ${ message.chainID }`, logger.logSeverity.WARNING, error );
-            } );
-            retry.onRetry( ( attempt, error ) => {
-                logger.log( `Retrying to send message response with chain ID: ${ message.chainID }. This is attempt ${ attempt }...`, logger.logSeverity.NOTICE, ( error ) ? { error: tools.errorToJSON( error ) } : undefined );
-            } );
-
-            messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_RESPONSE, messageTracer.dispatchEvent.SENT, messageTracer.messageState.PROCESSED );
-
-            retry.execute( this.#messageExchange, this.#messageExchange.sendMessageResponse, [ message ] ).then( () => {
-                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_RESPONSE, messageTracer.dispatchEvent.DELIVERED, messageTracer.messageState.PROCESSED );
-                resolve();
-            } ).catch( ( error ) => {
-                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_RESPONSE, messageTracer.dispatchEvent.FAILED, messageTracer.messageState.PROCESSED );
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to add an additional {@link MessageObserver} to the connection for the incoming message requests.
-     *
-     * @method
-     * @param {MessageObserver} messageObserver
-     * @public
-     */
-    addMessageObserverRequestsIn( messageObserver ) {
-        this.#messageExchange.addMessageObserverRequestsIn( messageObserver );
-    }
-
-    /**
-     * Used to add an additional {@link MessageObserver} to the connection for the incoming message responses.
-     *
-     * @method
-     * @param {MessageObserver} messageObserver
-     * @public
-     */
-    addMessageObserverResponsesIn( messageObserver ) {
-        this.#messageExchange.addMessageObserverResponsesIn( messageObserver );
-    }
-
-}
-
-const instance = new MessageDispatcher();
+/*
+ * 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-2026 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/>.
+*/
+
+const tools = require( "#tools" );
+const exceptions = require( "#exceptions" );
+const logger = require( "#logger" );
+const messageTracer = require( "#message-tracer" );
+
+/**
+ * Used to create and/or return a Message Dispatcher singleton instance.
+ * This class handles the internal message dispatching between the microservices.
+ *
+ * @class MessageDispatcher
+ * @singleton
+ * @public
+ */
+class MessageDispatcher {
+
+    static #instance = null;
+    #messageExchange;
+
+    /**
+     * @constructor
+     * @returns {MessageDispatcher}
+     */
+    constructor() {
+        if ( !MessageDispatcher.#instance ) {
+            MessageDispatcher.#instance = this;
+        }
+
+        return MessageDispatcher.#instance;
+    }
+
+    /* Public interface */
+
+    /**
+     * Used to initialize the message dispatcher and enable the message exchange.
+     *
+     * @method
+     * @param {MessageExchange} messageExchange The message exchange instance to be used by the dispatcher.
+     * @param {boolean} configureInbound If set to 'true' it tells the message exchange to set up inbound messaging.
+     * @param {boolean} configureOutbound If set to 'true' it tells the message exchange to set up outbound messaging.
+     * @returns {Promise}
+     * @public
+     */
+    initialize( messageExchange, configureInbound, configureOutbound ) {
+        return new Promise( ( resolve, reject ) => {
+            this.#messageExchange = messageExchange;
+
+            // Initialize the message tracer before enabling the message exchange:
+            messageTracer.instance.initialize().then( () => {
+                return this.#messageExchange.enableMessaging( configureInbound, configureOutbound );
+            } ).then( () => {
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to shut down the message dispatcher and disable the message exchange.
+     *
+     * @method
+     * @returns {Promise}
+     * @public
+     */
+    shutDown() {
+        return new Promise( ( resolve, reject ) => {
+            this.#messageExchange.disableMessaging().then( () => {
+                this.#messageExchange = null;
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to send a message request via the message exchange system.
+     *
+     * @method
+     * @param {Message} message The message to send. This can also be a subclass of {@link Message}.
+     * @returns {Promise<string>}
+     * @public
+     */
+    sendRequest( message ) {
+        return new Promise( ( resolve, reject ) => {
+            let retry = new tools.RetryPolicy( 3 );
+            retry.onFailedAttempt( ( error ) => {
+                logger.log( `Failed to send message request with chain ID: ${ message.chainID }`, logger.logSeverity.WARNING, error );
+            } );
+            retry.onRetry( ( attempt, error ) => {
+                logger.log( `Retrying to send message response with chain ID: ${ message.chainID }. This is attempt ${ attempt }...`, logger.logSeverity.NOTICE, ( error ) ? { error: tools.errorToJSON( error ) } : undefined );
+            } );
+
+            messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_REQUEST, messageTracer.dispatchEvent.SENT, messageTracer.messageState.PENDING );
+
+            retry.execute( this.#messageExchange, this.#messageExchange.sendMessageRequest, [ message ] ).then( () => {
+                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_REQUEST, messageTracer.dispatchEvent.DELIVERED, messageTracer.messageState.PENDING );
+                resolve( message.messageID );
+            } ).catch( ( error ) => {
+                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_REQUEST, messageTracer.dispatchEvent.FAILED, messageTracer.messageState.PENDING );
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to send a message response via the message exchange system.
+     *
+     * @method
+     * @param {Message} message The message to send. This can also be a subclass of {@link Message}.
+     * @returns {Promise}
+     * @public
+     */
+    sendResponse( message ) {
+        return new Promise( ( resolve, reject ) => {
+            let retry = new tools.RetryPolicy( 3 );
+            retry.onFailedAttempt( ( error ) => {
+                logger.log( `Failed to send message response with chain ID: ${ message.chainID }`, logger.logSeverity.WARNING, error );
+            } );
+            retry.onRetry( ( attempt, error ) => {
+                logger.log( `Retrying to send message response with chain ID: ${ message.chainID }. This is attempt ${ attempt }...`, logger.logSeverity.NOTICE, ( error ) ? { error: tools.errorToJSON( error ) } : undefined );
+            } );
+
+            messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_RESPONSE, messageTracer.dispatchEvent.SENT, messageTracer.messageState.PROCESSED );
+
+            retry.execute( this.#messageExchange, this.#messageExchange.sendMessageResponse, [ message ] ).then( () => {
+                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_RESPONSE, messageTracer.dispatchEvent.DELIVERED, messageTracer.messageState.PROCESSED );
+                resolve();
+            } ).catch( ( error ) => {
+                messageTracer.instance.recordTraceEntry( message, messageTracer.messageType.MESSAGE_RESPONSE, messageTracer.dispatchEvent.FAILED, messageTracer.messageState.PROCESSED );
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to add an additional {@link MessageObserver} to the connection for the incoming message requests.
+     *
+     * @method
+     * @param {MessageObserver} messageObserver
+     * @public
+     */
+    addMessageObserverRequestsIn( messageObserver ) {
+        this.#messageExchange.addMessageObserverRequestsIn( messageObserver );
+    }
+
+    /**
+     * Used to add an additional {@link MessageObserver} to the connection for the incoming message responses.
+     *
+     * @method
+     * @param {MessageObserver} messageObserver
+     * @public
+     */
+    addMessageObserverResponsesIn( messageObserver ) {
+        this.#messageExchange.addMessageObserverResponsesIn( messageObserver );
+    }
+
+}
+
+const instance = new MessageDispatcher();
 module.exports.instance = Object.freeze( instance );