@ti-engine/core 1.6.1 → 1.7.2

package/components/service-executor.js

@@ -1,279 +1,279 @@
-/*
- * 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 MessageObserver = require( "#message-observer" );
-const ServiceInstance = require( "#service-instance" );
-const _ = require( "lodash" );
-const exceptions = require( "#exceptions" );
-const logger = require( "#logger" );
-const config = require( "#config" );
-const cache = require( "#cache" );
-const messageDispatcher = require( "#message-dispatcher" );
-
-/**
- * @callback VerifyAccessMethod
- * @param {string} authToken
- * @param {ServiceAddress} serviceAddress
- * @returns {Promise}
- */
-
-/**
- * @callback ServiceHandlerMethod
- * @param {ServiceDefinition} serviceDefinition The service definition as provided during the service registration.
- * @param {Object} serviceParams Set of named parameters provided to the called service.
- * @param {ServiceExecContext} serviceExecContext The context in which the service call is being executed.
- * @returns {Promise<Object|undefined>} Optional payload to be returned to the service caller.
- */
-
-/**
- * A class defining a service executor behavior.
- *
- * @class ServiceExecutor
- * @extends MessageObserver
- * @public
- */
-class ServiceExecutor extends MessageObserver {
-
-    /** @type ServiceInterface */
-    #serviceInterface = {};
-    /** @type VerifyAccessMethod */
-    #verifyAccess;
-
-    /**
-     * @constructor
-     */
-    constructor() {
-        super();
-
-        // Set up a default empty verify access method:
-        this.#verifyAccess = () => {
-            return Promise.resolve();
-        };
-
-        cache.instance.addConnectionObserver( this );
-    }
-
-    /* Public interface */
-
-    /**
-     * Property returning the current service interface.
-     *
-     * @property
-     * @returns {ServiceInterface}
-     * @public
-     */
-    get serviceInterface() {
-        return this.#serviceInterface;
-    }
-
-    /**
-     *
-     *
-     * @method
-     * @param {string} identifier The identifier of the observed connection.
-     * @param {ServiceCall} serviceCall The service call message for processing.
-     * @returns {ServiceCall} The service call message that was received.
-     * @override
-     * @public
-     */
-    onMessage( identifier, serviceCall ) {
-        this.#processServiceCall( serviceCall ).then( ( serviceCall ) => {
-            return messageDispatcher.instance.sendResponse( serviceCall );
-        } ).catch( ( error ) => {
-            logger.log( `Failed to send service call response after processing! Service call message ID was: '${ serviceCall.messageID }'`, logger.logSeverity.ERROR, error );
-        } );
-
-        return serviceCall;
-    }
-
-    /**
-     * Needs to be invoked by the connection handler when the connection is disrupted.
-     *
-     * @method
-     * @param {string} identifier The identifier of the observed connection.
-     * @override
-     * @public
-     */
-    onConnectionDisrupted( identifier ) {
-        super.onConnectionDisrupted( identifier );
-    }
-
-    /**
-     * Needs to be invoked by the connection handler when the connection is recovered.
-     *
-     * @method
-     * @param {string} identifier The identifier of the observed connection.
-     * @override
-     * @public
-     */
-    onConnectionRecovered( identifier ) {
-        super.onConnectionRecovered( identifier );
-    }
-
-    /**
-     * Needs to be invoked by the connection handler when the connection is irrevocably lost.
-     *
-     * @method
-     * @param {string} identifier The identifier of the observed connection.
-     * @override
-     * @public
-     */
-    onConnectionLost( identifier ) {
-        super.onConnectionLost( identifier );
-    }
-
-    /**
-     * Used to set up the method for service access verification.
-     *
-     * @method
-     * @param {VerifyAccessMethod} verifyAccess
-     * @public
-     */
-    configureVerifyAccess( verifyAccess ) {
-        if ( typeof ( verifyAccess ) === "function" ) {
-            this.#verifyAccess = verifyAccess;
-        } else {
-            logger.log( `Attempting to setup service verification method that is not a function!`, logger.logSeverity.WARNING );
-        }
-    }
-
-    /**
-     * Used to add a service handler to the service interface.
-     * <br/>
-     * NOTE: If the same version of the service handler already exists, it will be overridden!
-     *
-     * @method
-     * @param {ServiceHandlerMethod} serviceHandler
-     * @param {ServiceDefinition} serviceDefinition
-     * @param {ServiceInstance} serviceInstance This will be used as context to bind all business services.
-     * @returns {Promise}
-     * @public
-     */
-    addServiceHandler( serviceHandler, serviceDefinition, serviceInstance ) {
-        return new Promise( ( resolve, reject ) => {
-            this.#registerServiceToCatalog( serviceDefinition.serviceAlias ).then( () => {
-                // Bind the service handler to the service alias and version:
-                if ( !this.#serviceInterface[ serviceDefinition.serviceAlias ] ) {
-                    this.#serviceInterface[ serviceDefinition.serviceAlias ] = {};
-                }
-                if ( this.#serviceInterface[ serviceDefinition.serviceAlias ][ serviceDefinition.serviceVersion ] ) {
-                    logger.log( `Service handler for '${ serviceDefinition.serviceAlias }' version '${ serviceDefinition.serviceVersion }' already existed and will be overridden.`, logger.logSeverity.WARNING );
-                }
-                this.#serviceInterface[ serviceDefinition.serviceAlias ][ serviceDefinition.serviceVersion ] = serviceHandler.bind( serviceInstance, _.cloneDeep( serviceDefinition ) );
-
-                resolve();
-            } ).catch( ( error ) => {
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /* Private interface */
-
-    /**
-     * Used to assemble {@link ServiceExecContext} from the provided service call object.
-     *
-     * @method
-     * @param {ServiceCall} serviceCall
-     * @returns {ServiceExecContext}
-     * @private
-     */
-    static #assembleServiceExecContext( serviceCall ) {
-        return {
-            authToken: serviceCall.authToken,
-            previousServiceCall: {
-                chainID: serviceCall.chainID,
-                chainLevel: serviceCall.chainLevel,
-                destination: serviceCall.destination,
-                messageID: serviceCall.messageID,
-                payload: serviceCall.payload,
-                predecessor: serviceCall.predecessor,
-                serviceAddress: serviceCall.serviceAddress,
-                serviceParams: serviceCall.serviceParams,
-                source: serviceCall.source
-            }
-        };
-    }
-
-    /**
-     * Used to register a service in the service registry.
-     *
-     * @method
-     * @param {string} serviceAlias
-     * @returns {Promise}
-     * @private
-     */
-    #registerServiceToCatalog( serviceAlias ) {
-        return new Promise( ( resolve, reject ) => {
-            let serviceCatalog = config.getSetting( config.setting.SERVICE_REGISTRY_ADDRESS ) + ServiceInstance.serviceDomainName;
-            cache.instance.addToSet( serviceCatalog, serviceAlias ).then( () => {
-                resolve();
-            } ).catch( ( error ) => {
-                logger.log( `Record for service '${ serviceAlias }' could not be added to the service registry. Service will not be visible to Service Consumers!`, logger.logSeverity.ERROR, error );
-                reject( exceptions.raise( error ) );
-            } );
-        } );
-    }
-
-    /**
-     * Used to process the actual service call.
-     *
-     * @method
-     * @param {ServiceCall} serviceCall
-     * @returns {Promise<ServiceCall>}
-     * @private
-     */
-    #processServiceCall( serviceCall ) {
-        return new Promise( ( resolve ) => {
-            this.#verifyAccess( serviceCall.authToken, serviceCall.serviceAddress ).then( () => {
-                return this.#identifyService( serviceCall.serviceAddress );
-            } ).then( ( serviceHandler ) => {
-                return serviceHandler( serviceCall.serviceParams, ServiceExecutor.#assembleServiceExecContext( serviceCall ) );
-            } ).then( ( payload ) => {
-                serviceCall.isSuccessful = true;
-                serviceCall.payload = payload;
-                resolve( serviceCall );
-            } ).catch( ( error ) => {
-                serviceCall.isSuccessful = false;
-                serviceCall.exception = exceptions.raise( error ).asJSON();
-                resolve( serviceCall );
-            } );
-        } );
-    }
-
-    /**
-     * Used to identify the service in the service interface and retrieve its definition.
-     *
-     * @method
-     * @param {ServiceAddress} serviceAddress
-     * @returns {Promise<ServiceHandlerMethod>}
-     * @private
-     */
-    #identifyService( serviceAddress ) {
-        return new Promise( ( resolve, reject ) => {
-            if ( this.#serviceInterface[ serviceAddress.serviceAlias ] ) {
-                let serviceVersion = serviceAddress.serviceVersion;
-                if ( !serviceVersion ) {
-                    serviceVersion = _.last( _.sortBy( _.keys( this.#serviceInterface[ serviceAddress.serviceAlias ] ) ) );
-                }
-
-                let serviceHandler = this.#serviceInterface[ serviceAddress.serviceAlias ][ serviceVersion ];
-                if ( serviceHandler ) {
-                    resolve( serviceHandler );
-                } else {
-                    reject( exceptions.raise( exceptions.exceptionCode.E_COM_SERVICE_HANDLER_NOT_FOUND ) );
-                }
-            } else {
-                reject( exceptions.raise( exceptions.exceptionCode.E_COM_SERVICE_NOT_FOUND ) );
-            }
-        } );
-    }
-
-}
-
+/*
+ * 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 MessageObserver = require( "#message-observer" );
+const ServiceInstance = require( "#service-instance" );
+const _ = require( "lodash" );
+const exceptions = require( "#exceptions" );
+const logger = require( "#logger" );
+const config = require( "#config" );
+const cache = require( "#cache" );
+const messageDispatcher = require( "#message-dispatcher" );
+
+/**
+ * @callback VerifyAccessMethod
+ * @param {string} authToken
+ * @param {ServiceAddress} serviceAddress
+ * @returns {Promise}
+ */
+
+/**
+ * @callback ServiceHandlerMethod
+ * @param {ServiceDefinition} serviceDefinition The service definition as provided during the service registration.
+ * @param {Object} serviceParams Set of named parameters provided to the called service.
+ * @param {ServiceExecContext} serviceExecContext The context in which the service call is being executed.
+ * @returns {Promise<Object|undefined>} Optional payload to be returned to the service caller.
+ */
+
+/**
+ * A class defining a service executor behavior.
+ *
+ * @class ServiceExecutor
+ * @extends MessageObserver
+ * @public
+ */
+class ServiceExecutor extends MessageObserver {
+
+    /** @type ServiceInterface */
+    #serviceInterface = {};
+    /** @type VerifyAccessMethod */
+    #verifyAccess;
+
+    /**
+     * @constructor
+     */
+    constructor() {
+        super();
+
+        // Set up a default empty verify access method:
+        this.#verifyAccess = () => {
+            return Promise.resolve();
+        };
+
+        cache.instance.addConnectionObserver( this );
+    }
+
+    /* Public interface */
+
+    /**
+     * Property returning the current service interface.
+     *
+     * @property
+     * @returns {ServiceInterface}
+     * @public
+     */
+    get serviceInterface() {
+        return this.#serviceInterface;
+    }
+
+    /**
+     *
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @param {ServiceCall} serviceCall The service call message for processing.
+     * @returns {ServiceCall} The service call message that was received.
+     * @override
+     * @public
+     */
+    onMessage( identifier, serviceCall ) {
+        this.#processServiceCall( serviceCall ).then( ( serviceCall ) => {
+            return messageDispatcher.instance.sendResponse( serviceCall );
+        } ).catch( ( error ) => {
+            logger.log( `Failed to send service call response after processing! Service call message ID was: '${ serviceCall.messageID }'`, logger.logSeverity.ERROR, error );
+        } );
+
+        return serviceCall;
+    }
+
+    /**
+     * Needs to be invoked by the connection handler when the connection is disrupted.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @override
+     * @public
+     */
+    onConnectionDisrupted( identifier ) {
+        super.onConnectionDisrupted( identifier );
+    }
+
+    /**
+     * Needs to be invoked by the connection handler when the connection is recovered.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @override
+     * @public
+     */
+    onConnectionRecovered( identifier ) {
+        super.onConnectionRecovered( identifier );
+    }
+
+    /**
+     * Needs to be invoked by the connection handler when the connection is irrevocably lost.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @override
+     * @public
+     */
+    onConnectionLost( identifier ) {
+        super.onConnectionLost( identifier );
+    }
+
+    /**
+     * Used to set up the method for service access verification.
+     *
+     * @method
+     * @param {VerifyAccessMethod} verifyAccess
+     * @public
+     */
+    configureVerifyAccess( verifyAccess ) {
+        if ( typeof ( verifyAccess ) === "function" ) {
+            this.#verifyAccess = verifyAccess;
+        } else {
+            logger.log( `Attempting to setup service verification method that is not a function!`, logger.logSeverity.WARNING );
+        }
+    }
+
+    /**
+     * Used to add a service handler to the service interface.
+     * <br/>
+     * NOTE: If the same version of the service handler already exists, it will be overridden!
+     *
+     * @method
+     * @param {ServiceHandlerMethod} serviceHandler
+     * @param {ServiceDefinition} serviceDefinition
+     * @param {ServiceInstance} serviceInstance This will be used as context to bind all business services.
+     * @returns {Promise}
+     * @public
+     */
+    addServiceHandler( serviceHandler, serviceDefinition, serviceInstance ) {
+        return new Promise( ( resolve, reject ) => {
+            this.#registerServiceToCatalog( serviceDefinition.serviceAlias ).then( () => {
+                // Bind the service handler to the service alias and version:
+                if ( !this.#serviceInterface[ serviceDefinition.serviceAlias ] ) {
+                    this.#serviceInterface[ serviceDefinition.serviceAlias ] = {};
+                }
+                if ( this.#serviceInterface[ serviceDefinition.serviceAlias ][ serviceDefinition.serviceVersion ] ) {
+                    logger.log( `Service handler for '${ serviceDefinition.serviceAlias }' version '${ serviceDefinition.serviceVersion }' already existed and will be overridden.`, logger.logSeverity.WARNING );
+                }
+                this.#serviceInterface[ serviceDefinition.serviceAlias ][ serviceDefinition.serviceVersion ] = serviceHandler.bind( serviceInstance, _.cloneDeep( serviceDefinition ) );
+
+                resolve();
+            } ).catch( ( error ) => {
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /* Private interface */
+
+    /**
+     * Used to assemble {@link ServiceExecContext} from the provided service call object.
+     *
+     * @method
+     * @param {ServiceCall} serviceCall
+     * @returns {ServiceExecContext}
+     * @private
+     */
+    static #assembleServiceExecContext( serviceCall ) {
+        return {
+            authToken: serviceCall.authToken,
+            previousServiceCall: {
+                chainID: serviceCall.chainID,
+                chainLevel: serviceCall.chainLevel,
+                destination: serviceCall.destination,
+                messageID: serviceCall.messageID,
+                payload: serviceCall.payload,
+                predecessor: serviceCall.predecessor,
+                serviceAddress: serviceCall.serviceAddress,
+                serviceParams: serviceCall.serviceParams,
+                source: serviceCall.source
+            }
+        };
+    }
+
+    /**
+     * Used to register a service in the service registry.
+     *
+     * @method
+     * @param {string} serviceAlias
+     * @returns {Promise}
+     * @private
+     */
+    #registerServiceToCatalog( serviceAlias ) {
+        return new Promise( ( resolve, reject ) => {
+            let serviceCatalog = config.getSetting( config.setting.SERVICE_REGISTRY_ADDRESS ) + ServiceInstance.serviceDomainName;
+            cache.instance.addToSet( serviceCatalog, serviceAlias ).then( () => {
+                resolve();
+            } ).catch( ( error ) => {
+                logger.log( `Record for service '${ serviceAlias }' could not be added to the service registry. Service will not be visible to Service Consumers!`, logger.logSeverity.ERROR, error );
+                reject( exceptions.raise( error ) );
+            } );
+        } );
+    }
+
+    /**
+     * Used to process the actual service call.
+     *
+     * @method
+     * @param {ServiceCall} serviceCall
+     * @returns {Promise<ServiceCall>}
+     * @private
+     */
+    #processServiceCall( serviceCall ) {
+        return new Promise( ( resolve ) => {
+            this.#verifyAccess( serviceCall.authToken, serviceCall.serviceAddress ).then( () => {
+                return this.#identifyService( serviceCall.serviceAddress );
+            } ).then( ( serviceHandler ) => {
+                return serviceHandler( serviceCall.serviceParams, ServiceExecutor.#assembleServiceExecContext( serviceCall ) );
+            } ).then( ( payload ) => {
+                serviceCall.isSuccessful = true;
+                serviceCall.payload = payload;
+                resolve( serviceCall );
+            } ).catch( ( error ) => {
+                serviceCall.isSuccessful = false;
+                serviceCall.exception = exceptions.raise( error ).asJSON();
+                resolve( serviceCall );
+            } );
+        } );
+    }
+
+    /**
+     * Used to identify the service in the service interface and retrieve its definition.
+     *
+     * @method
+     * @param {ServiceAddress} serviceAddress
+     * @returns {Promise<ServiceHandlerMethod>}
+     * @private
+     */
+    #identifyService( serviceAddress ) {
+        return new Promise( ( resolve, reject ) => {
+            if ( this.#serviceInterface[ serviceAddress.serviceAlias ] ) {
+                let serviceVersion = serviceAddress.serviceVersion;
+                if ( !serviceVersion ) {
+                    serviceVersion = _.last( _.sortBy( _.keys( this.#serviceInterface[ serviceAddress.serviceAlias ] ) ) );
+                }
+
+                let serviceHandler = this.#serviceInterface[ serviceAddress.serviceAlias ][ serviceVersion ];
+                if ( serviceHandler ) {
+                    resolve( serviceHandler );
+                } else {
+                    reject( exceptions.raise( exceptions.exceptionCode.E_COM_SERVICE_HANDLER_NOT_FOUND ) );
+                }
+            } else {
+                reject( exceptions.raise( exceptions.exceptionCode.E_COM_SERVICE_NOT_FOUND ) );
+            }
+        } );
+    }
+
+}
+
 module.exports = ServiceExecutor;