systemlynx 1.3.0 → 1.4.0

package/README.md

@@ -1,8 +1,8 @@
-# SystemLynx ![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg) ![JS 100%](https://img.shields.io/badge/JavaScript-100%25-green)
+# SystemLynx JS ![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg) ![JS 100%](https://img.shields.io/badge/JavaScript-100%25-green)
 
-SystemLynx is a framework for developing modular web APIs. It's a wrapper on top of ExpressJS and Socket.io. With SystemLynx, instead of creating a server with many endpoints, you can simply export objects from the server to the client application. Basically any objects added to a SystemLynx Service can be loaded and used by a SystemLynx Client.
+SystemLynx is a framework for developing modular web APIs in NodeJS. It's a wrapper on top of ExpressJS and Socket.io. With SystemLynx, instead of developing a server with endpoints, you can simply export objects from a server into a client application. Basically any objects hosted by a SystemLynx Service can be loaded and used by a SystemLynx Client.
 
-SystemLynx comes with the following objects that are used for web API development:
+SystemLynx comes with the following objects that are used for web app development:
 
 ```javascript
 const { App, Service, Client, LoadBalancer } = require("systemlynx");
@@ -22,7 +22,7 @@ Find the full [API Documentation](https://github.com/Odion100/SystemLynx/blob/ta
 
 ## Service.ServerModule(name, constructor [,options])
 
-Use the `Service.ServerModule(name, constructor/object)` method to register an object to be hosted by a **SystemLynx Service**. This will allows you to load an instance of that object onto a client application, and call any methods on that object remotely.
+Use the `Service.ServerModule(name, constructor/object)` method to add an object to be hosted by a **SystemLynx Service**. This will allows you to load an instance of that object into a client application, and call any methods on that object remotely.
 
 ```javascript
 const { Service } = require("systemlynx");
@@ -39,8 +39,7 @@ Service.ServerModule("Users", Users);
 
 In the code above we assigned an object to the variable `Users` and gave it an add method. The `Service.ServerModule(name, constructor/object)` function takes the name assigned to the object as the first argument and the object itself as the second argument.
 
-Alternatively, you can use a constructor function instead of an object as the second argument. In the example below we create another **ServerModule** called
-"Orders". This time we use a constructor function as the second argument of the to **ServerModule** function. The `this` value is the initial instance of the **ServerModule** object. Every method added to the `this` value will be accessible when the object is loaded by a **SystemLynx Client**. Note: **ServerModule** methods can be synchronous or asynchronous functions.
+Alternatively, you can use a constructor function instead of an object as the second argument. In the example below we create another **ServerModule** called "Orders". This time we use a constructor function as the second argument of the to **Service.ServerModule** function. The `this` value is the initial instance of the **ServerModule** object. Every method added to the `this` value will be accessible when the object is loaded by a **SystemLynx Client**. Note: **ServerModule** methods can be synchronous or asynchronous functions.
 
 ```javascript
 const { Service } = require("systemlynx");
@@ -148,7 +147,7 @@ const response = await Orders.find("hello", "world");
 console.log(response);
 ```
 
-Now let's go to our server application and call the `this.emit(event_name, data)` method to emit a websocket event that can be received by its corresponding Clients. Below, notice that we've added `this.emit("new_user", { message:"new_user event test" })` at the end of the `Users.add` method, so the `new_user` event will be emitted every time this method is called. The `this` value of a **ServerModule** method will always be scoped to the **ServerModule** itself.
+Now let's go to our server application and call the `Users.emit(event_name, data)` method to emit a websocket event that can be received by its corresponding Clients. Below, notice that we've added `this.emit("new_user", { message:"new_user event test" })` at the end of the `Users.add` method, so the `new_user` event will be emitted every time this method is called. The `this` value of a **ServerModule** method will always be scoped to the **ServerModule** itself.
 
 ```javascript
 const { Service } = require("systemlynx");

package/index.js

@@ -1,21 +1,21 @@
 //These are all the abstractions that make up SystemLynx
 const { isNode } = require("./utils/ProcessChecker");
-const AppFactory = require("./systemlynx/App/App");
-const LoadBalancerFactory = require("./systemlynx/LoadBalancer/LoadBalancer");
-const ServiceFactory = require("./systemlynx/Service/Service");
-const ServerManagerFactory = require("./systemlynx/ServerManager/ServerManager");
-const ClientFactory = require("./systemlynx/Client/Client");
-const HttpClientFactory = require("./systemlynx/HttpClient/HttpClient");
-const DispatcherFactory = require("./systemlynx/Dispatcher/Dispatcher");
+const SystemLynxApp = require("./systemlynx/App/App");
+const SystemLynxLoadBalancer = require("./systemlynx/LoadBalancer/LoadBalancer");
+const SystemLynxService = require("./systemlynx/Service/Service");
+const SystemLynxServerManager = require("./systemlynx/ServerManager/ServerManager");
+const SystemLynxClient = require("./systemlynx/Client/Client");
+const SystemLynxHttpClient = require("./systemlynx/HttpClient/HttpClient");
+const SystemLynxDispatcher = require("./systemlynx/Dispatcher/Dispatcher");
 
-const ServerManager = isNode ? ServerManagerFactory() : null;
-const Service = isNode ? ServiceFactory() : null;
-const LoadBalancer = isNode ? LoadBalancerFactory() : null;
+const ServerManager = isNode ? SystemLynxServerManager() : null;
+const Service = isNode ? SystemLynxService() : null;
+const LoadBalancer = isNode ? SystemLynxLoadBalancer() : null;
 
-const App = AppFactory();
-const HttpClient = HttpClientFactory();
-const Client = ClientFactory();
-const Dispatcher = DispatcherFactory();
+const App = SystemLynxApp();
+const HttpClient = SystemLynxHttpClient();
+const Client = SystemLynxClient();
+const Dispatcher = SystemLynxDispatcher();
 
 module.exports = {
   //Export these pre-created objects for convenient object destructuring
@@ -30,11 +30,11 @@ module.exports = {
   //export all modules themselves
   //all these modules export factory functions
   //to ensure non-singleton behavior
-  AppFactory,
-  LoadBalancerFactory,
-  ServiceFactory,
-  ClientFactory,
-  HttpClientFactory,
-  ServerManagerFactory,
-  DispatcherFactory,
+  SystemLynxApp,
+  SystemLynxLoadBalancer,
+  SystemLynxService,
+  SystemLynxClient,
+  SystemLynxHttpClient,
+  SystemLynxServerManager,
+  SystemLynxDispatcher,
 };

package/index.test.js

@@ -6,22 +6,22 @@ const {
   Client,
   Service,
   ServerManager,
-  AppFactory,
-  LoadBalancerFactory,
-  ServiceFactory,
-  ClientFactory,
-  HttpClientFactory,
-  ServerManagerFactory,
+  SystemLynxApp,
+  SystemLynxLoadBalancer,
+  SystemLynxService,
+  SystemLynxClient,
+  SystemLynxHttpClient,
+  SystemLynxServerManager,
 } = require("./index");
 
-describe("SystemLynx Factory functions", () => {
-  it("should return a factory functions for each SystemLynx abstraction", () => {
-    expect(AppFactory).to.be.a("function");
-    expect(LoadBalancerFactory).to.be.a("function");
-    expect(ServiceFactory).to.be.a("function");
-    expect(ClientFactory).to.be.a("function");
-    expect(HttpClientFactory).to.be.a("function");
-    expect(ServerManagerFactory).to.be.a("function");
+describe("SystemLynxSystemLynx  functions", () => {
+  it("should return aSystemLynx  functions for each SystemLynx abstraction", () => {
+    expect(SystemLynxApp).to.be.a("function");
+    expect(SystemLynxLoadBalancer).to.be.a("function");
+    expect(SystemLynxService).to.be.a("function");
+    expect(SystemLynxClient).to.be.a("function");
+    expect(SystemLynxHttpClient).to.be.a("function");
+    expect(SystemLynxServerManager).to.be.a("function");
   });
 
   it("should return an instance of each SystemLynx abstraction", () => {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systemlynx",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/systemlynx/App/App.js

@@ -4,7 +4,6 @@ const ServiceFactory = require("../Service/Service");
 const SystemObject = require("./components/SystemObject");
 const Dispatcher = require("../Dispatcher/Dispatcher");
 const initializeApp = require("./components/initializeApp");
-const URL = require("url");
 
 module.exports = function SystemLynxApp() {
   const App = Dispatcher();
@@ -67,7 +66,7 @@ module.exports = function SystemLynxApp() {
       system.configurations = { __constructor, module: SystemObject(system) };
     else
       throw Error(
-        "App.config methods requires a constructor function as it first parameter."
+        "[SystemLynx][App][Error]: App.config(...) methods requires a constructor function as its first parameter."
       );
     return App;
   };

package/systemlynx/App/components/initializeApp.js

@@ -18,7 +18,7 @@ module.exports = async function initApp(system) {
   try {
     await loadServices(system);
   } catch (err) {
-    throw `(AppERROR): Initialization Error - failed to load all services`;
+    throw `[SystemLynx][App][Error]: Initialization Error - failed to load all services`;
   }
 
   if (typeof system.configurations.__constructor === "function") {
@@ -27,7 +27,7 @@ module.exports = async function initApp(system) {
       () => {
         configComplete = true;
         loadModules(system);
-      }
+      },
     ]);
   } else loadModules(system);
 };

package/systemlynx/Client/components/ServiceRequestHandler.js

@@ -49,7 +49,7 @@ module.exports = function ServiceRequestHandler(method, fn, resetConnection) {
         console.log(err);
         errCount++;
         resetConnection(() => tryRequest(cb, errCount));
-      } else throw Error(`(SystemLynxServiceError): Invalid route:${err}`);
+      } else throw Error(`[SystemLynx][Service][Error]: Invalid route:${err}`);
     };
 
     return new Promise((resolve, reject) =>

package/systemlynx/Client/components/loadConnectionData.js

@@ -11,7 +11,7 @@ module.exports = function loadConnectionData(url, { limit = 10, wait = 150 } = {
         if (errors.length < limit)
           setTimeout(() => getData(resolve), errors.length * wait);
         else
-          throw `SystemLynx loadConnectionData() Error: url:${url}, attempts:${errors.length}`;
+          throw `[SystemLynx][Client][Error]: Failed to load Service @${url} after ${errors.length} attempts.`;
       } else resolve(results);
     });
   });

package/systemlynx/Dispatcher/Dispatcher.js

@@ -10,7 +10,7 @@ module.exports = function SystemLynxDispatcher(events = {}) {
   Dispatcher.on = (eventName, callback) => {
     if (typeof callback !== "function")
       throw Error(
-        "SystemLynxDispatcher Error: object.on(eventName, callback) invalid parameters"
+        "[SystemLynx][EventHandler][Error]: EventHandler.on(eventName, callback) received invalid parameters"
       );
     if (!events[eventName]) events[eventName] = [];
     events[eventName].push(callback);

package/systemlynx/ServerManager/ServerManager.js

@@ -63,7 +63,7 @@ module.exports = function SystemLynxServerManager() {
 
     return new Promise((resolve) =>
       server.listen(port, () => {
-        console.log(`(SystemLynxService): ${route} --> Listening on ${host}:${port}`);
+        console.log(`[SystemLynx][Service]: Listening on ${serviceUrl}`);
         moduleQueue.forEach(({ name, object, reserved_methods }) =>
           ServerManager.addModule(name, object, reserved_methods)
         );

package/systemlynx/Service/Service.js

@@ -15,11 +15,17 @@ module.exports = function ServiceFactory({ defaultModule = {} } = {}) {
 
     if (typeof constructor === "function") {
       if (constructor.constructor.name === "AsyncFunction")
-        throw `(ServerModule Error): ServerModule(name, constructor) function requires a non-async function as the constructor`;
+        throw `[SystemLynx][ServerModule][Error]: ServerModule(name, constructor) function cannot receive an async function as the constructor`;
 
       const ServerModule = Dispatcher.apply({ ...Service.defaultModule });
-      const exclude_methods = [...reserved_methods, ...Object.getOwnPropertyNames(ServerModule)];
-      constructor.apply(ServerModule, [ServerManager.Server(), ServerManager.WebSocket()]);
+      const exclude_methods = [
+        ...reserved_methods,
+        ...Object.getOwnPropertyNames(ServerModule),
+      ];
+      constructor.apply(ServerModule, [
+        ServerManager.Server(),
+        ServerManager.WebSocket(),
+      ]);
       ServerManager.addModule(name, ServerModule, exclude_methods);
       return ServerModule;
     }