@ti-engine/core 1.3.1 → 1.3.5

package/bin/localization/labels.json

@@ -1,65 +1,99 @@
-{
-  "labels": {
-    "general": {
-      "exceptions": {
-        "0": {
-          "en": "Unidentified error encountered or unrecognized exception code provided."
-        },
-        "1000": {
-          "en": "Error thrown by internal JS source."
-        },
-        "1001": {
-          "en": "Attempt to construct an abstract class detected."
-        },
-        "1002": {
-          "en": "Attempt to call an abstract method detected."
-        },
-        "1003": {
-          "en": "Invalid or no service domain name provided at microservice startup."
-        },
-        "1004": {
-          "en": "The system cache required for proper engine operation is unavailable."
-        },
-        "1005": {
-          "en": "The provided service handler is not a proper function."
-        },
-        "1006": {
-          "en": "The requested feature is not supported by current configuration or version."
-        },
-        "2000": {
-          "en": "Invalid authorization token provided."
-        },
-        "2001": {
-          "en": "Invalid or expired session encountered."
-        },
-        "2002": {
-          "en": "Attempt for unauthorized access detected."
-        },
-        "2003": {
-          "en": "The system detected tampering with the message received via message exchange."
-        },
-        "3000": {
-          "en": "General error during cross-application communication."
-        },
-        "3001": {
-          "en": "The message sender instance is currently unavailable."
-        },
-        "3002": {
-          "en": "The execution of a service could not complete within the allowed timeout."
-        },
-        "3003": {
-          "en": "The specified service is not found in the service registry."
-        },
-        "3004": {
-          "en": "The specified service is not found in the service definition interface."
-        },
-        "3005": {
-          "en": "No handler found in the interface for the specified service or service version."
-        },
-        "3010": {
-          "en": "Connection retry attempts exceeded the configured limit."
-        }
-      }
-    }
-  }
+{
+  "system": {
+    "exceptions": {
+      "0": {
+        "en": "Unidentified error encountered or unrecognized exception code provided."
+      },
+      "1000": {
+        "en": "Error thrown by internal JS source."
+      },
+      "1001": {
+        "en": "Attempt to construct an abstract class detected."
+      },
+      "1002": {
+        "en": "Attempt to call an abstract method detected."
+      },
+      "1003": {
+        "en": "Invalid or no service domain name provided at microservice startup."
+      },
+      "1004": {
+        "en": "The system cache required for proper engine operation is unavailable."
+      },
+      "1005": {
+        "en": "The provided service handler is not a proper function."
+      },
+      "1006": {
+        "en": "The requested feature is not supported by current configuration or version."
+      },
+      "2000": {
+        "en": "Invalid authorization token provided."
+      },
+      "2001": {
+        "en": "Invalid or expired session encountered."
+      },
+      "2002": {
+        "en": "Attempt for unauthorized access detected."
+      },
+      "2003": {
+        "en": "The system detected tampering with the message received via message exchange."
+      },
+      "3000": {
+        "en": "General error during cross-application communication."
+      },
+      "3001": {
+        "en": "The message sender instance is currently unavailable."
+      },
+      "3002": {
+        "en": "The execution of a service could not complete within the allowed timeout."
+      },
+      "3003": {
+        "en": "The specified service is not found in the service registry."
+      },
+      "3004": {
+        "en": "The specified service is not found in the service definition interface."
+      },
+      "3005": {
+        "en": "No handler found in the interface for the specified service or service version."
+      },
+      "3006": {
+        "en": "The message receiver instance is currently unavailable."
+      },
+      "3007": {
+        "en": "The message exchange is irrevocably broken and cannot be used any longer."
+      },
+      "3010": {
+        "en": "Connection retry attempts exceeded the configured limit."
+      },
+      "4000": {
+        "en": "The request method is not recognized or not supported."
+      },
+      "4001": {
+        "en": "The request URI is not recognized or not supported."
+      },
+      "4002": {
+        "en": "The request body is not recognized or not supported."
+      },
+      "4003": {
+        "en": "The request query is not recognized or not supported."
+      },
+      "4004": {
+        "en": "The request headers are not recognized or not supported."
+      },
+      "4005": {
+        "en": "The request parameters are not recognized or not supported."
+      },
+      "4006": {
+        "en": "The request format is not recognized or not supported."
+      },
+      "4007": {
+        "en": "The request content type is not recognized or not supported."
+      },
+      "4008": {
+        "en": "The request content length is not recognized or not supported."
+      },
+      "4009": {
+        "en": "The request content encoding is not recognized or not supported."
+      }
+    }
+  }
 }

package/components/auditing.js

@@ -11,9 +11,10 @@ const tools = require( "#tools" );
 const logger = require( "#logger" );
 const config = require( "#config" );
 const gcloud = require( "#gcloud-integration" );
+const ServiceInstance = require( "#service-instance" );
 
 /**
- * @typedef {Object} LogEntry
+ * @typedef {Object} TiLogEntry
  * @property {string} _id Unique identifier that can be used to identify the document in a NoSQL database.
  * @property {TiLogSeverity} severity The log severity level.
  * @property {string} thread The categorization of the log message.
@@ -59,19 +60,19 @@ class Auditing {
      */
     log( message, severity = logger.logSeverity.DEFAULT, thread = "main", data = {} ) {
         try {
-            // log entries bellow the min allowed level will be ignored:
+            // Log entries below the minimum allowed level will be directly ignored:
             if ( severity >= config.getSetting( config.setting.AUDITING_LOG_MIN_LEVEL ) ) {
-                // obscure any passwords that might have landed in the data object;
-                // also make sure to convert a potential Error object to a JSON:
+                // Obscure any passwords that might have landed in the data object;
+                // Also make sure to convert a potential Error object to a JSON:
                 let copyOfData = ( config.getSetting( config.setting.AUDITING_LOG_DETAILS ) === true ) ? _.cloneDeep( data ) : undefined;
                 let logEntry = Auditing.#createLogEntry( severity, thread, message, copyOfData );
 
-                // make sure there is a console available:
+                // Make sure there is a console available (especially important for Cloud or containerized environments):
                 if ( config.getSetting( config.setting.AUDITING_LOG_CONSOLE_ENABLED ) === true && console ) {
                     Auditing.#logToConsole( logEntry );
                 }
 
-                // if this is an actual error, then send it to GCloud error reporting system as well:
+                // If this is an actual error, then send it to GCloud error reporting system as well:
                 if ( logEntry.severity >= logger.logSeverity.WARNING && data instanceof Error && gcloud.isEnabled() ) {
                     gcloud.reportError( data );
                 }
@@ -91,14 +92,14 @@ class Auditing {
      * @param {string} thread
      * @param {string} message
      * @param {Object} data
-     * @returns {LogEntry}
+     * @returns {TiLogEntry}
      * @private
      */
     static #createLogEntry( severity, thread, message, data ) {
         let currentDate = new Date();
         let logDate = tools.getUTCDateString( currentDate );
         let logTime = tools.getUTCTimeString( currentDate, true );
-        let reporter = process.env.TI_INSTANCE_ID;
+        let reporter = ServiceInstance.instanceID;
 
         return {
             _id: `${ logDate }-${ logTime }-${ thread }-${ reporter }-${ logger.getSeverityName( severity ) }-${ tools.getUUID() }`,
@@ -112,13 +113,13 @@ class Auditing {
     }
 
     /**
-     * Used to write the log entries to the system console (i.e. STD OUT and STD ERR).
+     * Used to write the log entries to the system console (i.e., STD OUT and STD ERR).
      * <br/>
      * NOTE: There was an issue in previous Node versions with console that can crash the application if the number of
-     *    outputs exceeds several thousands per second. To be monitored and adjusted as necessary!
+     * outputs exceeds several thousands per second. To be monitored and adjusted as necessary!
      *
      * @method
-     * @param {LogEntry} logEntry
+     * @param {TiLogEntry} logEntry
      * @private
      */
     static #logToConsole( logEntry ) {
@@ -140,7 +141,7 @@ class Auditing {
      * Used to format a log entry for the Node console.
      *
      * @method
-     * @param {LogEntry} logEntry
+     * @param {TiLogEntry} logEntry
      * @returns {string}
      * @private
      */
@@ -153,7 +154,7 @@ class Auditing {
      * Used to format a log entry data payload for the Node console.
      *
      * @method
-     * @param {LogEntry} logEntry
+     * @param {TiLogEntry} logEntry
      * @returns {string}
      * @private
      */

package/components/service-caller.js

@@ -48,7 +48,7 @@ const messageDispatcher = require( "#message-dispatcher" );
 
 /**
  * @typedef {Object} ServiceCallResult
- * @property {Object|undefined} exception If there was exception during the service call processing, it will be set here. Otherwise, it will be 'undefined'.
+ * @property {Exception|undefined} exception If there was exception during the service call processing, it will be set here. Otherwise, it will be 'undefined'.
  * @property {boolean} isSuccessful A flag indicating if this service call can be considered successful or not.
  * @property {Object|string|undefined} payload The payload containing the results from the service call processing. If a string, it is ID of the payload in the memory cache instead.
  */
@@ -187,7 +187,7 @@ class ServiceCallProcessor {
         } ).catch( ( error ) => {
             clearTimeout( this.#timeoutHandle );
             this.#isProcessed = true;
-            logger.log( `Error during service call execution!`, logger.logSeverity.ERROR, error );
+            logger.log( `Error during service call execution!`, logger.logSeverity.DEBUG, error );
             return {
                 isSuccessful: false,
                 exception: exceptions.raise( error ),
@@ -293,7 +293,7 @@ class ServiceCaller extends MessageObserver {
      * @public
      */
     executeServiceCall( serviceAddress, serviceParams, serviceExecContext ) {
-        return new Promise( ( resolve, reject ) => {
+        return new Promise( ( resolve ) => {
             let processor = new ServiceCallProcessor( serviceAddress, serviceParams, serviceExecContext );
             this.#addProcessor( processor.messageID, processor );
             processor.process().then( ( serviceCallResult ) => {

package/components/service-consumer.js

@@ -32,9 +32,9 @@ class ServiceConsumer extends ServiceInstance {
     /**
      * @constructor
      * @param {string} serviceDomainName The service domain name for this service instance.
-     * @param {Object} [serviceConfig={}] The JSON configuration for this service.
+     * @param {ServiceConfiguration} [serviceConfig] The JSON configuration for this service.
      */
-    constructor( serviceDomainName, serviceConfig = {} ) {
+    constructor( serviceDomainName, serviceConfig ) {
         super( serviceDomainName, serviceConfig );
 
         // make sure this abstract class cannot be instantiated:

package/components/service-instance.js

@@ -17,7 +17,7 @@ const messageDispatcher = require( "#message-dispatcher" );
 
 /**
  * @typedef {Object} ServiceConfiguration
- * @property {ServiceDefinition[]} services A list of service definitions to be registered with the {@link ServiceProvider}.
+ * @property {ServiceDefinition[]} [services] A list of service definitions to be registered with the {@link ServiceProvider}.
  */
 
 /**
@@ -42,9 +42,9 @@ class ServiceInstance {
     /**
      * @constructor
      * @param {string} serviceDomainName The service domain name for this service instance.
-     * @param {Object} [serviceConfig={}] The JSON configuration for this service.
+     * @param {ServiceConfiguration} [serviceConfig={ services: [] }] The JSON configuration for this service.
      */
-    constructor( serviceDomainName, serviceConfig = {} ) {
+    constructor( serviceDomainName, serviceConfig = { services: [] } ) {
         // Ensure this abstract class cannot be instantiated:
         if ( new.target === ServiceInstance ) {
             throw exceptions.raise( exceptions.exceptionCode.E_GEN_ABSTRACT_CLASS_INIT, { name: this.constructor.name } );

package/components/service-provider.js

@@ -37,9 +37,9 @@ class ServiceProvider extends ServiceConsumer {
     /**
      * @constructor
      * @param {string} serviceDomainName The service domain name for this service instance.
-     * @param {Object} [serviceConfig={}] The JSON configuration for this service.
+     * @param {ServiceConfiguration} [serviceConfig] The JSON configuration for this service.
      */
-    constructor( serviceDomainName, serviceConfig = {} ) {
+    constructor( serviceDomainName, serviceConfig ) {
         super( serviceDomainName, serviceConfig );
 
         // make sure this abstract class cannot be instantiated:

package/integrations/redis-integration.js

@@ -118,7 +118,7 @@ class RedisClient {
     /* Public interface */
 
     /**
-     * Used to return the Redis client identifier.
+     * Used to return the Redis client identifier assigned internally.
      *
      * @property
      * @returns {string}
@@ -129,7 +129,7 @@ class RedisClient {
     }
 
     /**
-     * Used to return the Redis client ID.
+     * Used to return the client ID assigned by the Redis server.
      *
      * @property
      * @returns {number}
@@ -195,9 +195,9 @@ class RedisClient {
                     // Fetch the server information and store it:
                     return this.#fetchServerInfo();
                 } ).then( () => {
-                    return this.#getClientId();
+                    return this.#getClientID();
                 } ).then( ( clientID ) => {
-                    // Store the client ID:
+                    // Store the connection ID:
                     this.#redisClientID = clientID;
                     resolve();
                 } ).catch( ( error ) => {
@@ -476,10 +476,12 @@ class RedisClient {
 
                 this.#redisConnection.once( "ready", () => {
                     this.#clientStatus = clientStatusEnum.CONNECTED;
+                    logger.log( `Connection to Redis server '${ this.#redisConnection.options.host }:${ this.#redisConnection.options.port }' established by client '${ this.identifier }' and is ready to be used.`, logger.logSeverity.INFO );
                     this.#notifyConnectionObservers();
 
                     this.#redisConnection.on( "ready", () => {
                         this.#clientStatus = clientStatusEnum.CONNECTED;
+                        logger.log( `Connection to Redis server '${ this.#redisConnection.options.host }:${ this.#redisConnection.options.port }' reestablished by client '${ this.identifier }' and is ready to be used.`, logger.logSeverity.INFO );
                         this.#notifyConnectionObservers();
                     } );
 
@@ -515,14 +517,13 @@ class RedisClient {
      */
     #notifyConnectionObservers() {
         // Notify all connection observers about the event:
-        _.forEach( this.#connectionObservers, ( connectionObservers ) => {
+        _.forEach( this.#connectionObservers, ( connectionObserver ) => {
             if ( this.#clientStatus === clientStatusEnum.CONNECTED ) {
-                logger.log( `Connection to Redis server ${ this.#redisConnection.options.host }:${ this.#redisConnection.options.port } (re)established by client '${ this.identifier }' and is ready to be used.`, logger.logSeverity.INFO );
-                connectionObservers.onConnectionRecovered( this.#clientIdentifier );
+                connectionObserver.onConnectionRecovered( this.#clientIdentifier );
             } else if ( this.#clientStatus === clientStatusEnum.DISRUPTED ) {
-                connectionObservers.onConnectionDisrupted( this.#clientIdentifier );
+                connectionObserver.onConnectionDisrupted( this.#clientIdentifier );
             } else if ( this.#clientStatus === clientStatusEnum.DISCONNECTED ) {
-                connectionObservers.onConnectionLost( this.#clientIdentifier );
+                connectionObserver.onConnectionLost( this.#clientIdentifier );
             }
         } );
     }
@@ -574,7 +575,7 @@ class RedisClient {
      * @returns {Promise<number>}
      * @private
      */
-    #getClientId() {
+    #getClientID() {
         let commandArguments = [ "client", "id" ];
         return this.callCommand( commandArguments ).then( ( clientID ) => Number( clientID ) );
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ti-engine/core",
-  "version": "1.3.1",
+  "version": "1.3.5",
   "description": "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.",
   "author": "Boris Kostadinov <kostadinov.boris@gmail.com>",
   "license": "GPL-3.0-or-later",

package/utils/config.js

@@ -73,7 +73,7 @@ const tools = require( "#tools" );
 /**
  * @typedef {Object} SettingsLocalization
  * @property {Array<string>} labelsPath
- * @property {string} language
+ * @property {TiLocalizationLanguage} language
  */
 
 /**
@@ -113,7 +113,7 @@ const tools = require( "#tools" );
  * @readonly
  * @enum {string} Keys of this ENUM are strings.
  */
-let settingsEnum = tools.enum( {
+const settingsEnum = tools.enum( {
     AUDITING_LOG_CONSOLE_ENABLED: [ "auditing.logConsoleEnabled", "logConsoleEnabled", "" ],
     AUDITING_LOG_DETAILS: [ "auditing.logDetails", "logDetails", "" ],
     AUDITING_LOG_MIN_LEVEL: [ "auditing.logMinLevel", "logMinLevel", "" ],
@@ -152,7 +152,7 @@ module.exports.setting = settingsEnum;
 /** @type {SettingsMain} */
 const settings = require( "#settings" );
 
-// override remaining settings with ENV variables (if provided):
+// Override the remaining settings with ENV variables (if provided):
 if ( settings.auditing ) {
     settings.auditing.logConsoleEnabled = ( process.env.TI_AUDITING_LOG_CONSOLE_ENABLED !== undefined ) ? tools.toBool( process.env.TI_AUDITING_LOG_CONSOLE_ENABLED ) : settings.auditing.logConsoleEnabled;
     settings.auditing.logDetails = ( process.env.TI_AUDITING_LOG_DETAILS !== undefined ) ? tools.toBool( process.env.TI_AUDITING_LOG_DETAILS ) : settings.auditing.logDetails;
@@ -160,7 +160,7 @@ if ( settings.auditing ) {
     settings.auditing.logUsesJSON = ( process.env.TI_AUDITING_LOG_USES_JSON !== undefined ) ? tools.toBool( process.env.TI_AUDITING_LOG_USES_JSON ) : settings.auditing.logUsesJSON;
 }
 if ( settings.localization ) {
-    settings.localization.labelsPath = ( process.env.TI_LOCALIZATION_LABELS_PATH !== undefined ) ? process.env.TI_LOCALIZATION_LABELS_PATH : settings.localization.labelsPath;
+    settings.localization.labelsPath = ( process.env.TI_LOCALIZATION_LABELS_PATH !== undefined ) ? [ process.env.TI_LOCALIZATION_LABELS_PATH ] : settings.localization.labelsPath;
     settings.localization.language = ( process.env.TI_LOCALIZATION_LANGUAGE !== undefined ) ? process.env.TI_LOCALIZATION_LANGUAGE : settings.localization.language;
 }
 if ( settings.memoryCache ) {
@@ -186,7 +186,7 @@ if ( process.env.TI_GCLOUD_ENABLED === true && settings.gcloudIntegration ) {
 
 settings.operationMode = process.env.NODE_ENV || settings.operationMode;
 
-// prevent further modifications to the settings object:
+// Prevent further modifications to the settings object:
 Object.freeze( settings );
 
 /**