@ti-engine/core 1.7.1 → 1.8.0

package/bin/localization/labels.json

@@ -1,123 +1,123 @@
-{
-  "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."
-      },
-      "1007": {
-        "en": "The provided argument is not of the expected type."
-      },
-      "1008": {
-        "en": "The invoked framework component is not initialized."
-      },
-      "1009": {
-        "en": "Attempt to override a protected or private method or property detected."
-      },
-      "1010": {
-        "en": "The requested functionality is not yet implemented."
-      },
-      "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."
-      },
-      "2004": {
-        "en": "The requested authentication method is not recognized or supported."
-      },
-      "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."
-      },
-      "3008": {
-        "en": "The execution of a service reported a failure. This might be a business logic error or a system error."
-      },
-      "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."
-      },
-      "5004": {
-        "en": "The requested resource cannot be found. See details for more information."
-      },
-      "5005": {
-        "en": "The application service encountered an error. See details for more information."
-      }
-    }
-  }
+{
+  "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."
+      },
+      "1007": {
+        "en": "The provided argument is not of the expected type."
+      },
+      "1008": {
+        "en": "The invoked framework component is not initialized."
+      },
+      "1009": {
+        "en": "Attempt to override a protected or private method or property detected."
+      },
+      "1010": {
+        "en": "The requested functionality is not yet implemented."
+      },
+      "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."
+      },
+      "2004": {
+        "en": "The requested authentication method is not recognized or supported."
+      },
+      "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."
+      },
+      "3008": {
+        "en": "The execution of a service reported a failure. This might be a business logic error or a system error."
+      },
+      "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."
+      },
+      "5004": {
+        "en": "The requested resource cannot be found. See details for more information."
+      },
+      "5005": {
+        "en": "The application service encountered an error. See details for more information."
+      }
+    }
+  }
 }

package/bin/settings.json

@@ -1,42 +1,42 @@
-{
-  "auditing": {
-    "logConsoleEnabled": true,
-    "logDetails": true,
-    "logMinLevel": 0,
-    "logUsesJSON": false
-  },
-  "gcloudIntegration": {
-    "apiKey": "",
-    "loggingEnabled": false,
-    "logName": "ti-engine",
-    "projectID": ""
-  },
-  "localization": {
-    "labelsPath": [],
-    "language": "en"
-  },
-  "memoryCache": {
-    "authKey": null,
-    "redisDB": 0,
-    "redisHost": "127.0.0.1",
-    "redisPort": 6379,
-    "user": "default"
-  },
-  "messageExchange": {
-    "messageQueuePrefix": "ti:messages:",
-    "messageStore": "ti:messages:store",
-    "securityHashEnabled": true,
-    "securityHashKey": "",
-    "traceExpirationTime": 3600,
-    "traceLogEnabled": false,
-    "traceRepository": "ti:messages:trace"
-  },
-  "serviceConfig": {
-    "executionTimeout": 180000,
-    "healthCheckAddress": "ti:services:registry:health:",
-    "healthCheckInterval": "*/1 * * * * *",
-    "healthCheckTimeout": 3,
-    "serviceRegistryAddress": "ti:services:registry:catalog:"
-  },
-  "operationMode": "production"
+{
+  "auditing": {
+    "logConsoleEnabled": true,
+    "logDetails": true,
+    "logMinLevel": 0,
+    "logUsesJSON": false
+  },
+  "gcloudIntegration": {
+    "apiKey": "",
+    "loggingEnabled": false,
+    "logName": "ti-engine",
+    "projectID": ""
+  },
+  "localization": {
+    "labelsPath": [],
+    "language": "en"
+  },
+  "memoryCache": {
+    "authKey": null,
+    "redisDB": 0,
+    "redisHost": "127.0.0.1",
+    "redisPort": 6379,
+    "user": "default"
+  },
+  "messageExchange": {
+    "messageQueuePrefix": "ti:messages:",
+    "messageStore": "ti:messages:store",
+    "securityHashEnabled": true,
+    "securityHashKey": "",
+    "traceExpirationTime": 3600,
+    "traceLogEnabled": false,
+    "traceRepository": "ti:messages:trace"
+  },
+  "serviceConfig": {
+    "executionTimeout": 180000,
+    "healthCheckAddress": "ti:services:registry:health:",
+    "healthCheckInterval": "*/1 * * * * *",
+    "healthCheckTimeout": 3,
+    "serviceRegistryAddress": "ti:services:registry:catalog:"
+  },
+  "operationMode": "production"
 }

package/bin/start-instance.js

@@ -1,165 +1,165 @@
-/*
- * 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/>.
-*/
-
-"use strict";
-
-const path = require( "path" );
-
-// Load any ENV variables defined in a .env file - before including any framework files:
-// - 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" );
-    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;
-            }
-        }
-    }
-    return envPath;
-} )();
-
-// Load the resolved .env file using the native Node loader (Node >= 20.12). A missing file is not fatal —
-// environment variables may be supplied entirely by the OS/container. Existing process.env values are NOT overridden.
-try {
-    process.loadEnvFile( envFilePath );
-} catch ( error ) {
-    if ( error.code !== "ENOENT" ) {
-        throw error;
-    }
-}
-
-const tools = require( "#tools" );
-const logger = require( "#logger" );
-
-// Configure the current instance variables before requiring any platform modules and store the necessary ones in memory cache:
-process.env.TI_INSTANCE_ID = "ti-" + tools.getUUID();
-process.env.TI_INSTANCE_CLASS = process.env.TI_INSTANCE_CLASS || "";
-
-// Derive a safe default service domain name if not explicitly provided:
-// - Normalize path separators
-// - Strip directory and file extension
-const defaultNameFromClass = ( () => {
-    try {
-        const normalized = ( process.env.TI_INSTANCE_CLASS || "" ).replace( /\\/g, "/" );
-        const base = path.posix.basename( normalized );
-        const name = path.parse( base ).name;
-        return name || "";
-    } catch {
-        return "";
-    }
-} )();
-
-process.env.TI_INSTANCE_NAME = process.env.TI_INSTANCE_NAME || defaultNameFromClass;
-
-// Configure the process termination handlers to ensure a graceful shutdown:
-
-/**
- * Will be used to gracefully shut down the instance.
- * <br/>
- * NOTE: Will be overridden below after the instance creation.
- *
- * @method
- * @param {number} exitCode
- * @abstract
- * @private
- */
-let shutDownInstance = ( exitCode ) => {
-    process.exit( exitCode );
-};
-
-// This event will handle the process termination (Ctrl + C):
-process.on( "SIGINT", () => {
-    logger.log( `SIGINT event detected in main instance process.`, logger.logSeverity.NOTICE );
-    shutDownInstance( 0 );
-} );
-
-// This event will handle the process termination via terminal hangup (CMD close) - not delivered on all platforms:
-process.on( "SIGHUP", () => {
-    logger.log( `SIGHUP event detected in main instance process.`, logger.logSeverity.NOTICE );
-    shutDownInstance( 0 );
-} );
-
-// This event will handle the process termination:
-process.on( "SIGTERM", () => {
-    logger.log( `SIGTERM event detected in main instance process.`, logger.logSeverity.NOTICE );
-    shutDownInstance( 0 );
-} );
-
-// Handle Windows console break (Ctrl + Break):
-process.on( "SIGBREAK", () => {
-    logger.log( `SIGBREAK event detected in main instance process.`, logger.logSeverity.NOTICE );
-    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 || "" );
-    logger.log( `Unhandled promise rejection identified! Make sure this isn't a software bug.`, logger.logSeverity.WARNING, {
-        reason: tools.errorToJSON && reason instanceof Error ? tools.errorToJSON( reason ) : reason
-    } );
-    if ( failFastDisabled !== true ) {
-        setImmediate( () => process.exit( 1 ) );
-    }
-} );
-
-process.on( "multipleResolves", ( type, promise, reason ) => {
-    logger.log( `Multiple promise resolves detected! Make sure this isn't a software bug.`, logger.logSeverity.WARNING, {
-        type,
-        reason: tools.errorToJSON && reason instanceof Error ? tools.errorToJSON( reason ) : reason
-    } );
-} );
-
-process.on( "uncaughtException", ( error ) => {
-    logger.log( `Some nasty and uncaught error just occurred in the application!`, logger.logSeverity.ALERT, error );
-    setImmediate( () => process.exit( 1 ) );
-} );
-
-// Start the instance:
-try {
-    const serviceConstructor = require( path.join( process.cwd(), process.env.TI_INSTANCE_CLASS ) );
-    const serviceConfigPath = process.env.TI_INSTANCE_CONFIG;
-    /** @type ServiceConfiguration */
-    let serviceConfig;
-    if ( serviceConfigPath ) {
-        serviceConfig = require( path.join( process.cwd(), process.env.TI_INSTANCE_CONFIG ) );
-    }
-    /** @type ServiceInstance */
-    const mainInstance = new serviceConstructor( process.env.TI_INSTANCE_NAME, serviceConfig );
-
-    /** @override */
-    shutDownInstance = ( exitCode ) => {
-        mainInstance.stop().then( () => {
-            setImmediate( () => process.exit( exitCode ) );
-        } ).catch( ( error ) => {
-            logger.log( `Error occurred during shut down of instance '${ process.env.TI_INSTANCE_ID }'! Exit code changed from '${ exitCode }' to '1'.`, logger.logSeverity.ERROR, error );
-            setImmediate( () => process.exit( 1 ) );
-        } );
-    };
-
-    if ( mainInstance.isServiceInstance ) {
-        logger.log( `Starting new instance of type '${ process.env.TI_INSTANCE_NAME }' with instance ID '${ process.env.TI_INSTANCE_ID }'.`, logger.logSeverity.NOTICE );
-        mainInstance.start().catch( ( error ) => {
-            logger.log( `Error detected during instance '${ process.env.TI_INSTANCE_ID }' startup!`, logger.logSeverity.ALERT, error );
-            setImmediate( () => process.exit( 1 ) );
-        } );
-    } else {
-        logger.log( `Attempting to start a module that does not implement the ServiceInstance abstract class!`, logger.logSeverity.CRITICAL );
-        setImmediate( () => process.exit( 1 ) );
-    }
-} catch ( error ) {
-    logger.log( `Error detected in the instance startup script!`, logger.logSeverity.ALERT, error );
-    setImmediate( () => process.exit( 1 ) );
+/*
+ * 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/>.
+*/
+
+"use strict";
+
+const path = require( "path" );
+
+// Load any ENV variables defined in a .env file - before including any framework files:
+// - 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" );
+    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;
+            }
+        }
+    }
+    return envPath;
+} )();
+
+// Load the resolved .env file using the native Node loader (Node >= 20.12). A missing file is not fatal —
+// environment variables may be supplied entirely by the OS/container. Existing process.env values are NOT overridden.
+try {
+    process.loadEnvFile( envFilePath );
+} catch ( error ) {
+    if ( error.code !== "ENOENT" ) {
+        throw error;
+    }
+}
+
+const tools = require( "#tools" );
+const logger = require( "#logger" );
+
+// Configure the current instance variables before requiring any platform modules and store the necessary ones in memory cache:
+process.env.TI_INSTANCE_ID = "ti-" + tools.getUUID();
+process.env.TI_INSTANCE_CLASS = process.env.TI_INSTANCE_CLASS || "";
+
+// Derive a safe default service domain name if not explicitly provided:
+// - Normalize path separators
+// - Strip directory and file extension
+const defaultNameFromClass = ( () => {
+    try {
+        const normalized = ( process.env.TI_INSTANCE_CLASS || "" ).replace( /\\/g, "/" );
+        const base = path.posix.basename( normalized );
+        const name = path.parse( base ).name;
+        return name || "";
+    } catch {
+        return "";
+    }
+} )();
+
+process.env.TI_INSTANCE_NAME = process.env.TI_INSTANCE_NAME || defaultNameFromClass;
+
+// Configure the process termination handlers to ensure a graceful shutdown:
+
+/**
+ * Will be used to gracefully shut down the instance.
+ * <br/>
+ * NOTE: Will be overridden below after the instance creation.
+ *
+ * @method
+ * @param {number} exitCode
+ * @abstract
+ * @private
+ */
+let shutDownInstance = ( exitCode ) => {
+    process.exit( exitCode );
+};
+
+// This event will handle the process termination (Ctrl + C):
+process.on( "SIGINT", () => {
+    logger.log( `SIGINT event detected in main instance process.`, logger.logSeverity.NOTICE );
+    shutDownInstance( 0 );
+} );
+
+// This event will handle the process termination via terminal hangup (CMD close) - not delivered on all platforms:
+process.on( "SIGHUP", () => {
+    logger.log( `SIGHUP event detected in main instance process.`, logger.logSeverity.NOTICE );
+    shutDownInstance( 0 );
+} );
+
+// This event will handle the process termination:
+process.on( "SIGTERM", () => {
+    logger.log( `SIGTERM event detected in main instance process.`, logger.logSeverity.NOTICE );
+    shutDownInstance( 0 );
+} );
+
+// Handle Windows console break (Ctrl + Break):
+process.on( "SIGBREAK", () => {
+    logger.log( `SIGBREAK event detected in main instance process.`, logger.logSeverity.NOTICE );
+    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 || "" );
+    logger.log( `Unhandled promise rejection identified! Make sure this isn't a software bug.`, logger.logSeverity.WARNING, {
+        reason: tools.errorToJSON && reason instanceof Error ? tools.errorToJSON( reason ) : reason
+    } );
+    if ( failFastDisabled !== true ) {
+        setImmediate( () => process.exit( 1 ) );
+    }
+} );
+
+process.on( "multipleResolves", ( type, promise, reason ) => {
+    logger.log( `Multiple promise resolves detected! Make sure this isn't a software bug.`, logger.logSeverity.WARNING, {
+        type,
+        reason: tools.errorToJSON && reason instanceof Error ? tools.errorToJSON( reason ) : reason
+    } );
+} );
+
+process.on( "uncaughtException", ( error ) => {
+    logger.log( `Some nasty and uncaught error just occurred in the application!`, logger.logSeverity.ALERT, error );
+    setImmediate( () => process.exit( 1 ) );
+} );
+
+// Start the instance:
+try {
+    const serviceConstructor = require( path.join( process.cwd(), process.env.TI_INSTANCE_CLASS ) );
+    const serviceConfigPath = process.env.TI_INSTANCE_CONFIG;
+    /** @type ServiceConfiguration */
+    let serviceConfig;
+    if ( serviceConfigPath ) {
+        serviceConfig = require( path.join( process.cwd(), process.env.TI_INSTANCE_CONFIG ) );
+    }
+    /** @type ServiceInstance */
+    const mainInstance = new serviceConstructor( process.env.TI_INSTANCE_NAME, serviceConfig );
+
+    /** @override */
+    shutDownInstance = ( exitCode ) => {
+        mainInstance.stop().then( () => {
+            setImmediate( () => process.exit( exitCode ) );
+        } ).catch( ( error ) => {
+            logger.log( `Error occurred during shut down of instance '${ process.env.TI_INSTANCE_ID }'! Exit code changed from '${ exitCode }' to '1'.`, logger.logSeverity.ERROR, error );
+            setImmediate( () => process.exit( 1 ) );
+        } );
+    };
+
+    if ( mainInstance.isServiceInstance ) {
+        logger.log( `Starting new instance of type '${ process.env.TI_INSTANCE_NAME }' with instance ID '${ process.env.TI_INSTANCE_ID }'.`, logger.logSeverity.NOTICE );
+        mainInstance.start().catch( ( error ) => {
+            logger.log( `Error detected during instance '${ process.env.TI_INSTANCE_ID }' startup!`, logger.logSeverity.ALERT, error );
+            setImmediate( () => process.exit( 1 ) );
+        } );
+    } else {
+        logger.log( `Attempting to start a module that does not implement the ServiceInstance abstract class!`, logger.logSeverity.CRITICAL );
+        setImmediate( () => process.exit( 1 ) );
+    }
+} catch ( error ) {
+    logger.log( `Error detected in the instance startup script!`, logger.logSeverity.ALERT, error );
+    setImmediate( () => process.exit( 1 ) );
 }