systemlynx 1.7.2 → 1.8.3

package/API.md

@@ -101,6 +101,13 @@ constr OrdersConstructor = function () {
 const Users = Service.module("Users", UsersConstructor);
 
 const Orders = Service.module("Orders", OrdersConstructor);
+
+Orders.before('find', (req, res, next)=>{
+
+})
+Orders.before((req, res, next)=>{
+
+})
 ```
 
 ## Service.startService(options)

package/README.md

@@ -1,6 +1,6 @@
 # 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 in NodeJS. It's a wrapper on top of ExpressJS and Socket.io. With SystemLynx, instead of creating a server with many endpoints, you can simply create objects and load those 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 is a NodeJS framework for building modular web APIs, built on top of ExpressJS and Socket.io. It allows you to create objects and load them from a server into a client application.
 
 SystemLynx comes with the following objects that are used for web app development:
 
@@ -8,11 +8,9 @@ SystemLynx comes with the following objects that are used for web app developmen
 const { App, Service, Client, LoadBalancer } = require("systemlynx");
 ```
 
-Call `require("systemlynx")` and destructrue from the object it returns. The main abstractions used for client-to-server interactions are the following:
-
 - **Service** - Used to create and host objects that can be loaded and used by a SystemLynx Client.
-- **Client** - Used in a client application to load a **Service**, which contains all the objects added to the **Service**.
-- **App** - Provides a modular interface and lifecycle methods for asynchronously creating and loading **Services**.
+- **Client** - Used in a client application to load a **Service**, providing access to all the objects hosted by the **Service**.
+- **App** - provides a modular interface for creating and loading Services.
 
 Find the full [API Documentation](https://github.com/Odion100/SystemLynx/blob/master/API.md#tasksjs-api-documentation) here.
 
@@ -173,3 +171,11 @@ Service.module("Orders", function () {
 
 Service.startService({ route: "test/service", port: "4400", host: "localhost" });
 ```
+
+# temp
+
+/\* systemlynx
+
+1.  update systemlynx config to work to create universal values that are applied to every module. Every prop or method add to the this value or the App.config method will be applied to all this value through out the system. So we should use the SystemContext class that I already created to implement this.
+2.  any method that begins with a dollar sign will not be exposed to the client
+    \*/

package/index.js

@@ -1,21 +1,21 @@
 //These are all the abstractions that make up SystemLynx
 const { isNode } = require("./utils/ProcessChecker");
-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 createApp = require("./systemlynx/App/App");
+const createLoadBalancer = require("./systemlynx/LoadBalancer/LoadBalancer");
+const createService = require("./systemlynx/Service/Service");
+const createServerManager = require("./systemlynx/ServerManager/ServerManager");
+const createClient = require("./systemlynx/Client/Client");
+const createHttpClient = require("./systemlynx/HttpClient/HttpClient");
+const createDispatcher = require("./systemlynx/Dispatcher/Dispatcher");
 
-const ServerManager = isNode ? SystemLynxServerManager() : null;
-const Service = isNode ? SystemLynxService() : null;
-const LoadBalancer = isNode ? SystemLynxLoadBalancer() : null;
+const ServerManager = isNode ? createServerManager() : null;
+const Service = isNode ? createService() : null;
+const LoadBalancer = isNode ? createLoadBalancer() : null;
 
-const App = SystemLynxApp();
-const HttpClient = SystemLynxHttpClient();
-const Client = SystemLynxClient();
-const Dispatcher = SystemLynxDispatcher();
+const App = createApp();
+const HttpClient = createHttpClient();
+const Client = createClient();
+const Dispatcher = createDispatcher();
 
 module.exports = {
   //Export these pre-created objects for convenient object destructuring
@@ -28,13 +28,12 @@ module.exports = {
   ServerManager,
   Dispatcher,
   //export all modules themselves
-  //all these modules export factory functions
-  //to ensure non-singleton behavior
-  SystemLynxApp,
-  SystemLynxLoadBalancer,
-  SystemLynxService,
-  SystemLynxClient,
-  SystemLynxHttpClient,
-  SystemLynxServerManager,
-  SystemLynxDispatcher,
+  //all these modules export a functions
+  createApp,
+  createLoadBalancer,
+  createService,
+  createClient,
+  createHttpClient,
+  createServerManager,
+  createDispatcher,
 };

package/index.test.js

@@ -6,22 +6,22 @@ const {
   Client,
   Service,
   ServerManager,
-  SystemLynxApp,
-  SystemLynxLoadBalancer,
-  SystemLynxService,
-  SystemLynxClient,
-  SystemLynxHttpClient,
-  SystemLynxServerManager,
+  createApp,
+  createLoadBalancer,
+  createService,
+  createClient,
+  createHttpClient,
+  createServerManager,
 } = require("./index");
 
 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");
+    expect(createApp).to.be.a("function");
+    expect(createLoadBalancer).to.be.a("function");
+    expect(createService).to.be.a("function");
+    expect(createClient).to.be.a("function");
+    expect(createHttpClient).to.be.a("function");
+    expect(createServerManager).to.be.a("function");
   });
 
   it("should return an instance of each SystemLynx abstraction", () => {});
@@ -35,6 +35,8 @@ describe("SystemLynx Objects", () => {
         "module",
         "on",
         "emit",
+        "$clearEvent",
+        "before",
         "use",
         "startService",
         "loadService",
@@ -46,6 +48,8 @@ describe("SystemLynx Objects", () => {
       .that.respondsTo("module")
       .that.respondsTo("on")
       .that.respondsTo("emit")
+      .that.respondsTo("$clearEvent")
+      .that.respondsTo("before")
       .that.respondsTo("use")
       .that.respondsTo("startService")
       .that.respondsTo("loadService")
@@ -71,14 +75,33 @@ describe("SystemLynx Objects", () => {
   it("should return a SystemLynx LoadBalancer", () => {
     expect(LoadBalancer)
       .to.be.an("object")
-      .that.has.all.keys("startService", "server", "WebSocket", "clones", "module")
+      .that.has.all.keys(
+        "startService",
+        "server",
+        "WebSocket",
+        "clones",
+        "module",
+        "before"
+      )
       .that.respondsTo("startService")
-      .that.respondsTo("module");
+      .that.respondsTo("module")
+      .that.respondsTo("before");
     expect(LoadBalancer.clones)
       .to.be.an("object")
-      .that.has.all.keys("on", "emit", "clones", "register", "dispatch", "assignDispatch")
+      .that.has.all.keys(
+        "before",
+        "on",
+        "emit",
+        "$clearEvent",
+        "clones",
+        "register",
+        "dispatch",
+        "assignDispatch"
+      )
       .that.respondsTo("emit")
+      .that.respondsTo("$clearEvent")
       .that.respondsTo("on")
+      .that.respondsTo("before")
       .that.respondsTo("register")
       .that.respondsTo("dispatch")
       .that.respondsTo("assignDispatch")
@@ -89,9 +112,16 @@ describe("SystemLynx Objects", () => {
   it("should return a SystemLynx ServerManager instance", () => {
     expect(ServerManager)
       .to.be.an("Object")
-      .that.has.all.keys(["startService", "addModule", "server", "WebSocket"])
+      .that.has.all.keys([
+        "startService",
+        "addModule",
+        "addRouteHandler",
+        "server",
+        "WebSocket",
+      ])
       .that.respondsTo("startService")
-      .that.respondsTo("addModule");
+      .that.respondsTo("addModule")
+      .that.respondsTo("addRouteHandler");
   });
 
   it("should return a new instance of a Service", () => {

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "systemlynx",
-  "version": "1.7.2",
+  "version": "1.8.3",
   "description": "",
   "main": "index.js",
   "scripts": {
     "start": "node index.js",
-    "test": "jest --verbose --testPathIgnorePatterns 'client-setup.test.js'"
+    "test": "jest --verbose"
   },
   "dependencies": {
-    "body-parser": "^1.18.3",
-    "express": "^4.16.4",
+    "express": "^4.18.2",
     "mime": "^2.4.0",
     "multer": "^1.4.2",
     "request": "^2.88.0",

package/systemlynx/App/App.js

@@ -1,25 +1,25 @@
 "use strict";
 const { isNode } = require("../../utils/ProcessChecker");
-const SystemLynxService = require("../Service/Service");
-const SystemLynxDispatcher = require("../Dispatcher/Dispatcher");
+const createService = require("../Service/Service");
+const createDispatcher = require("../Dispatcher/Dispatcher");
 const initializeApp = require("./components/initializeApp");
 const SystemLynxContext = require("../utils/SystemContext");
 const System = require("../utils/System");
 
-module.exports = function SystemLynxApp() {
+module.exports = function createApp(server, WebSocket, customClient) {
   const system = new System();
   const systemContext = SystemLynxContext(system);
-  const App = SystemLynxDispatcher(undefined, systemContext);
+  const App = new createDispatcher(undefined, systemContext);
   const plugins = [];
   setTimeout(() => {
     plugins.forEach((plugin) => {
       if (typeof plugin === "function") plugin.apply({}, [App, system]);
     });
-    initializeApp(system, App, systemContext);
+    initializeApp(system, App, customClient, systemContext);
   }, 0);
 
   if (isNode) {
-    system.Service = SystemLynxService(systemContext);
+    system.Service = createService(server, WebSocket, systemContext);
 
     App.startService = (options) => {
       system.routing = options;
@@ -30,6 +30,11 @@ module.exports = function SystemLynxApp() {
       system.modules.push({ name, __constructor });
       return App;
     };
+
+    App.before = (...args) => {
+      system.Service.before(...args);
+      return App;
+    };
     App.server = system.Service.server;
     App.WebSocket = system.Service.WebSocket;
   }

package/systemlynx/App/components/initializeApp.js

@@ -1,7 +1,7 @@
 const loadModules = require("./loadModules");
 const loadServices = require("./loadServices");
 
-module.exports = async function initApp(system, App, systemContext) {
+module.exports = async function initApp(system, App, customClient, systemContext) {
   let configComplete = false;
   const continuationERROR = () => {
     if (!configComplete)
@@ -16,7 +16,7 @@ module.exports = async function initApp(system, App, systemContext) {
   };
 
   try {
-    await loadServices(system, App, systemContext);
+    await loadServices(system, App, customClient, systemContext);
   } catch (err) {
     throw `[SystemLynx][App][Error]: Initialization Error - failed to load all services`;
   }

package/systemlynx/App/components/loadServices.js

@@ -1,7 +1,7 @@
-const SystemLynxClient = require("../../Client/Client");
+const createClient = require("../../Client/Client");
 
-module.exports = ({ services }, App, systemContext) => {
-  const Client = SystemLynxClient(systemContext);
+module.exports = ({ services }, App, customClient, systemContext) => {
+  const Client = createClient(customClient, systemContext);
 
   return Promise.all(
     services.map((serviceData) => {

package/systemlynx/App/tests/App.test.js

@@ -1,11 +1,11 @@
 const { expect } = require("chai");
-const SystemLynxApp = require("../App");
+const createApp = require("../App");
 const HttpClient = require("../../HttpClient/HttpClient")();
-const SystemLynxService = require("../../Service/Service");
+const createService = require("../../Service/Service");
 
-describe("SystemLynxApp()", () => {
+describe("createApp()", () => {
   it("should return a SystemLynx App", () => {
-    const App = SystemLynxApp();
+    const App = createApp();
 
     expect(App)
       .to.be.an("object")
@@ -13,6 +13,8 @@ describe("SystemLynxApp()", () => {
         "module",
         "on",
         "emit",
+        "before",
+        "$clearEvent",
         "use",
         "startService",
         "loadService",
@@ -24,6 +26,8 @@ describe("SystemLynxApp()", () => {
       .that.respondsTo("module")
       .that.respondsTo("on")
       .that.respondsTo("emit")
+      .that.respondsTo("$clearEvent")
+      .that.respondsTo("before")
       .that.respondsTo("use")
       .that.respondsTo("startService")
       .that.respondsTo("loadService")
@@ -33,7 +37,7 @@ describe("SystemLynxApp()", () => {
 });
 describe("App: Loading Services", () => {
   it("should be able to use App.loadService(str_url) to load as hosted Service", async () => {
-    const Service = SystemLynxService();
+    const Service = createService();
     const route = "test-service";
     const port = "8503";
 
@@ -45,7 +49,7 @@ describe("App: Loading Services", () => {
     await Service.startService({ route, port });
 
     await new Promise((resolve) => {
-      const App = SystemLynxApp();
+      const App = createApp();
       App.loadService("test", `http://localhost:${port}/${route}`).on(
         "ready",
         (system) => {
@@ -53,9 +57,17 @@ describe("App: Loading Services", () => {
 
           expect(system.services[0].client)
             .to.be.an("object")
-            .that.has.all.keys("emit", "on", "resetConnection", "disconnect", "mod")
+            .that.has.all.keys(
+              "emit",
+              "on",
+              "$clearEvent",
+              "resetConnection",
+              "disconnect",
+              "mod"
+            )
             .that.respondsTo("emit")
             .that.respondsTo("on")
+            .that.respondsTo("$clearEvent")
             .that.respondsTo("resetConnection")
             .that.respondsTo("disconnect");
           resolve();
@@ -65,7 +77,7 @@ describe("App: Loading Services", () => {
   });
 
   it("should be able to use App.loadService(...).onLoad(handler) to fire a callback when the Service connects", async () => {
-    const Service = SystemLynxService();
+    const Service = createService();
     const route = "test-service";
     const port = "8422";
     const url = `http://localhost:${port}/${route}`;
@@ -78,12 +90,20 @@ describe("App: Loading Services", () => {
     await Service.startService({ route, port });
 
     await new Promise((resolve) => {
-      const App = SystemLynxApp();
+      const App = createApp();
       App.loadService("test", url).onLoad((test) => {
         expect(test)
           .to.be.an("object")
-          .that.has.all.keys("emit", "on", "resetConnection", "disconnect", "mod")
+          .that.has.all.keys(
+            "emit",
+            "on",
+            "$clearEvent",
+            "resetConnection",
+            "disconnect",
+            "mod"
+          )
           .that.respondsTo("emit")
+          .that.respondsTo("$clearEvent")
           .that.respondsTo("on")
           .that.respondsTo("resetConnection")
           .that.respondsTo("disconnect");
@@ -93,7 +113,7 @@ describe("App: Loading Services", () => {
   });
 
   it('should use App.on("service_loaded[:name]", callback) to fire when a Service has loaded', async () => {
-    const Service = SystemLynxService();
+    const Service = createService();
     const route = "test-service";
     const port = "8423";
     const url = `http://localhost:${port}/${route}`;
@@ -105,21 +125,37 @@ describe("App: Loading Services", () => {
     await Service.startService({ route, port });
 
     await new Promise((resolve) => {
-      const App = SystemLynxApp();
+      const App = createApp();
       App.loadService("test", url)
         .on("service_loaded", (test) => {
           expect(test)
             .to.be.an("object")
-            .that.has.all.keys("emit", "on", "resetConnection", "disconnect", "mod")
+            .that.has.all.keys(
+              "emit",
+              "on",
+              "$clearEvent",
+              "resetConnection",
+              "disconnect",
+              "mod"
+            )
             .that.respondsTo("emit")
+            .that.respondsTo("$clearEvent")
             .that.respondsTo("on")
             .that.respondsTo("resetConnection");
         })
         .on("service_loaded:test", (test) => {
           expect(test)
             .to.be.an("object")
-            .that.has.all.keys("emit", "on", "resetConnection", "disconnect", "mod")
+            .that.has.all.keys(
+              "emit",
+              "on",
+              "$clearEvent",
+              "resetConnection",
+              "disconnect",
+              "mod"
+            )
             .that.respondsTo("emit")
+            .that.respondsTo("$clearEvent")
             .that.respondsTo("on")
             .that.respondsTo("resetConnection");
           resolve();
@@ -128,7 +164,7 @@ describe("App: Loading Services", () => {
   });
 
   it("should be accessible to SystemObjects via the module.useService method", async () => {
-    const Service = SystemLynxService();
+    const Service = createService();
     const route = "test-service";
     const port = "8442";
     const url = `http://localhost:${port}/${route}`;
@@ -141,14 +177,22 @@ describe("App: Loading Services", () => {
     await Service.startService({ route, port });
 
     await new Promise((resolve) => {
-      const App = SystemLynxApp();
+      const App = createApp();
       App.loadService("test", url)
         .module("module_name", function () {
           const test = this.useService("test");
           expect(test)
             .to.be.an("object")
-            .that.has.all.keys("emit", "on", "resetConnection", "disconnect", "mod")
+            .that.has.all.keys(
+              "emit",
+              "on",
+              "$clearEvent",
+              "resetConnection",
+              "disconnect",
+              "mod"
+            )
             .that.respondsTo("emit")
+            .that.respondsTo("$clearEvent")
             .that.respondsTo("on")
             .that.respondsTo("resetConnection");
           resolve();
@@ -160,32 +204,52 @@ describe("App: Loading Services", () => {
 
 describe("App SystemObjects: Initializing Modules,  Modules and configurations", () => {
   it("should be able to use App.module to initialize a module", async () => {
-    const App = SystemLynxApp();
+    const App = createApp();
     return new Promise((resolve) =>
       App.module("test", function () {
         expect(this)
           .to.be.an("object")
-          .that.has.all.keys("useModule", "useService", "useConfig", "on", "emit")
+          .that.has.all.keys(
+            "useModule",
+            "useService",
+            "useConfig",
+            "on",
+            "emit",
+            "$clearEvent",
+            "before"
+          )
           .that.respondsTo("useModule")
           .that.respondsTo("useService")
           .that.respondsTo("useConfig")
           .that.respondsTo("on")
-          .that.respondsTo("emit");
+          .that.respondsTo("emit")
+          .that.respondsTo("$clearEvent")
+          .that.respondsTo("before");
       }).module("test2", function () {
         expect(this)
           .to.be.an("object")
-          .that.has.all.keys("useModule", "useService", "useConfig", "on", "emit")
+          .that.has.all.keys(
+            "useModule",
+            "useService",
+            "useConfig",
+            "on",
+            "emit",
+            "$clearEvent",
+            "before"
+          )
           .that.respondsTo("useModule")
           .that.respondsTo("useService")
           .that.respondsTo("useConfig")
           .that.respondsTo("on")
-          .that.respondsTo("emit");
+          .that.respondsTo("emit")
+          .that.respondsTo("$clearEvent")
+          .that.respondsTo("before");
         resolve();
       })
     );
   });
   it("should be able to use App.startService to start as Service", async () => {
-    const App = SystemLynxApp();
+    const App = createApp();
     const route = "test-service";
     const port = "8493";
     const url = `http://localhost:${port}/${route}`;
@@ -211,7 +275,7 @@ describe("App SystemObjects: Initializing Modules,  Modules and configurations",
     expect(connData.serviceUrl).to.equal(url);
   });
   it("should be able to use App.module to add a hosted Module to the Service", async () => {
-    const App = SystemLynxApp();
+    const App = createApp();
     const route = "test-service";
     const port = "8494";
     const url = `http://localhost:${port}/${route}`;
@@ -256,7 +320,7 @@ describe("App SystemObjects: Initializing Modules,  Modules and configurations",
   });
 
   it('should be able to use App.on("ready", callback) fire a callback when App initialization is complete', async () => {
-    const App = SystemLynxApp();
+    const App = createApp();
     const route = "system-test";
     const port = "4242";
     App.startService({ route, port });
@@ -286,7 +350,7 @@ describe("App SystemObjects: Initializing Modules,  Modules and configurations",
   });
 
   it("should be able to use App.config(constructor) to construct a configuration module", async () => {
-    const App = SystemLynxApp();
+    const App = createApp();
 
     App.module("mod", function () {
       this.test = () => {};
@@ -318,7 +382,7 @@ describe("App SystemObjects: Initializing Modules,  Modules and configurations",
 });
 describe("Use App.use(SystemLynxPlugin), to initializing Modules, and load Services", () => {
   it("should allow for adding new modules and services before app initialization", async () => {
-    const Service = SystemLynxService();
+    const Service = createService();
     const route = "test-service";
     const port = "8520";
     const pluginUrl = `http://localhost:${port}/${route}`;
@@ -333,7 +397,7 @@ describe("Use App.use(SystemLynxPlugin), to initializing Modules, and load Servi
       App.module("plugin", { testMethod: (data) => data });
     };
     await new Promise((resolve) => {
-      const App = SystemLynxApp();
+      const App = createApp();
       App.module("testModule", { testFunction: () => data })
         .use(plugin)
         .on("ready", (system) => {
@@ -350,7 +414,7 @@ describe("Use App.use(SystemLynxPlugin), to initializing Modules, and load Servi
 });
 describe("SystemContext", () => {
   it("should be able to use this.useModule and this.useService within modules and Module", () => {
-    const App = SystemLynxApp();
+    const App = createApp();
     App.module("mod1", function () {
       expect(this)
         .to.be.an("object")
@@ -406,7 +470,7 @@ describe("SystemContext", () => {
     return new Promise((resolve) => App.on("ready", () => resolve()));
   });
   it("[SystemLynx][App][Client][on] should have access to systemContext during event callbacks.", async () => {
-    const AppBackend = SystemLynxApp();
+    const AppBackend = createApp();
     const eventName = "testing-this";
     const _route = "test-service";
     const _port = "8900";
@@ -426,7 +490,7 @@ describe("SystemContext", () => {
     });
     await AppBackend.startService({ route: _route, port: _port });
 
-    const AppClient = SystemLynxApp();
+    const AppClient = createApp();
     const route = "test-service";
     const port = "8901";
 

package/systemlynx/Client/Client.js

@@ -2,8 +2,9 @@
 const loadConnectionData = require("./components/loadConnectionData");
 const SocketDispatcher = require("./components/SocketDispatcher");
 const ClientModule = require("./components/ClientModule");
+const HttpClient = require("../HttpClient/HttpClient");
 
-module.exports = function SystemLynxClient(systemContext) {
+module.exports = function createClient(httpClient = HttpClient(), systemContext) {
   const Client = {};
   Client.loadedServices = {};
 
@@ -11,7 +12,7 @@ module.exports = function SystemLynxClient(systemContext) {
     if (Client.loadedServices[url] && !options.forceReload)
       return Client.loadedServices[url];
 
-    const connData = await loadConnectionData(url, options);
+    const connData = await loadConnectionData(httpClient, url, options);
     const Service = Client.createService(connData);
     Client.loadedServices[url] = Service;
     await new Promise((resolve) => Service.on("connect", resolve));
@@ -23,12 +24,13 @@ module.exports = function SystemLynxClient(systemContext) {
     if (Client.loadedServices[connData.serviceUrl])
       return Client.loadedServices[connData.serviceUrl];
 
-    const Service = SocketDispatcher(connData.namespace, events, systemContext);
+    const Service = new SocketDispatcher(connData.namespace, events, systemContext);
 
     Client.loadedServices[connData.serviceUrl] = Service;
 
     Service.resetConnection = async (cb) => {
       const { modules, host, port, namespace } = await loadConnectionData(
+        httpClient,
         connData.serviceUrl
       );
       SocketDispatcher.apply(Service, [namespace, events, systemContext]);
@@ -47,6 +49,7 @@ module.exports = function SystemLynxClient(systemContext) {
     connData.modules.forEach(
       (mod) =>
         (Service[mod.name] = ClientModule(
+          httpClient,
           mod,
           connData,
           Service.resetConnection,