@ti-engine/core 1.0.5 → 1.0.6

package/README.md

@@ -29,7 +29,17 @@ In order to run the basic ti-engine framework you will need a couple of things:
 To get the framework itself, use the command `npm install @ti-engine/core`. And to include it directly in your package.json dependencies execute `npm install @ti-engine/core --save-prod`.
 
 ## getting started
-To start using the ti-engine, you will have to make sure that the framework is properly configured and able to run. More details and instructions will be provided in the next version of this documentation. For now please take a look at the included file `start-instance.js`. It should give you an idea of how the engine operates and what to do in order to create and run your own microservice instance.
+To start using the **ti-engine**, you will have to make sure that all prerequisites are available and operational. If you are working under Windows OS and you need to install Redis, take a look at this [guide](https://redis.com/blog/redis-on-windows-10/).
+
+Once you have all this setup and ready, you should download the **ti-engine** tester module with the command `npm install @ti-engine/tester`. The tester module packages an example microservice that shows the basic approach for using the framework. To make sure everything is working properly, you should try and start the tester service:
+1. Open a command prompt and navigate to the directory of the tester module; it should be something like that `<path to your project>/node_modules/@ti-engine/tester`
+2. 
+
+
+
+the framework is properly configured and able to run. More details and instructions will be provided in the next version of this documentation. For now please take a look at the included file `start-instance.js`. It should give you an idea of how the engine operates and what to do in order to create and run your own microservice instance.
+
+
 
 Under development...
 

package/bin/start-instance.js

@@ -5,14 +5,14 @@
 
 "use strict";
 
-// load any ENV variables defined in a .env file:
-require( "dotenv" ).config();
-
 const _ = require( "lodash" );
-const fs = require( "fs-extra" );
+const path = require( "path" );
 const tools = require( "#tools" );
 const logger = require( "#logger" );
 
+// load any ENV variables defined in a .env file:
+require( "dotenv" ).config( { path: path.join( process.cwd(), ".env" ) } );
+
 // 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 || "";
@@ -75,11 +75,11 @@ try {
     logger.log( `Starting new instance of type '${ process.env.TI_INSTANCE_NAME }' with instance ID '${ process.env.TI_INSTANCE_ID }'.`, logger.logSeverity.NOTICE );
 
     /** @type ServiceInstance */
-    const serviceConstructor = require( process.env.TI_INSTANCE_CLASS );
+    const serviceConstructor = require( path.join( process.cwd(), process.env.TI_INSTANCE_CLASS ) );
     const serviceConfigPath = process.env.TI_INSTANCE_CONFIG;
     let serviceConfig = {};
-    if ( fs.existsSync( serviceConfigPath ) ) {
-        serviceConfig = require( process.env.TI_INSTANCE_CONFIG );
+    if ( serviceConfigPath ) {
+        serviceConfig = require( path.join( process.cwd(), process.env.TI_INSTANCE_CONFIG ) );
     }
     const mainInstance = new serviceConstructor( process.env.TI_INSTANCE_NAME, serviceConfig );
 

package/components/service-provider.js

@@ -5,6 +5,7 @@
 
 const ServiceConsumer = require( "#service-consumer" );
 const _ = require( "lodash" );
+const path = require( "path" );
 const exceptions = require( "#exceptions" );
 const logger = require( "#logger" );
 const messageDispatcher = require( "#message-dispatcher" );
@@ -136,10 +137,11 @@ class ServiceProvider extends ServiceConsumer {
             /** @type {ServiceHandlerMethod} */
             let serviceHandler = null;
             if ( serviceDefinition.serviceFile ) {
+                let serviceFilePath = path.join( process.cwd(), serviceDefinition.serviceFile );
                 try {
-                    serviceHandler = require( serviceDefinition.serviceFile ).service;
+                    serviceHandler = require( serviceFilePath ).service;
                 } catch ( error ) {
-                    logger.log( `Specified service handler file '${ serviceDefinition.serviceFile }' could not be loaded!`, logger.logSeverity.ERROR, error );
+                    logger.log( `Specified service handler file '${ serviceFilePath }' could not be loaded!`, logger.logSeverity.ERROR, error );
                 }
             } else {
                 if ( typeof ( defaultServiceHandler ) === "function" ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ti-engine/core",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "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": "ISC",
@@ -41,6 +41,7 @@
     "#tools": "./utils/tools.js"
   },
   "dependencies": {
+    "blake2": "^4.0.2",
     "dotenv": "^10.0.0",
     "fs-extra": "^10.0.0",
     "lodash": "^4.17.21",