systemlynx 1.16.11 → 1.18.11

package/README.md

@@ -1,3 +1,5 @@
+<img src="./logo.png" alt="Alt text" style="background:white; border-radius:20px; padding:10px"/>
+
 # 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 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systemlynx",
-  "version": "1.16.11",
+  "version": "1.18.11",
   "description": "",
   "main": "index.js",
   "browser": {
@@ -16,7 +16,8 @@
     "mime": "^2.4.0",
     "multer": "^1.4.2",
     "shortid": "^2.2.14",
-    "socket.io": "^2.2.0"
+    "socket.io": "^4.8.1",
+    "socket.io-client": "^4.8.1"
   },
   "repository": {
     "type": "git",

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

@@ -294,7 +294,8 @@ describe("App SystemObjects: Initializing Modules,  Modules and configurations",
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array").that.is.empty;
@@ -329,7 +330,8 @@ describe("App SystemObjects: Initializing Modules,  Modules and configurations",
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array");

package/systemlynx/Client/Client.js

@@ -27,21 +27,24 @@ module.exports = function createClient(httpClient = HttpClient(), systemContext)
       return Client.cachedServices[connData.serviceUrl];
 
     const Service = {};
-    SocketDispatcher.apply(Service, [connData.namespace, events, systemContext]);
+    SocketDispatcher.apply(Service, [connData, events, systemContext]);
     HeaderSetter.apply(Service);
     Client.cachedServices[connData.serviceUrl] = Service;
 
     Service.resetConnection = async (cb) => {
       try {
-        const { modules, host, port, namespace } = await loadConnectionData(
-          httpClient,
-          connData.serviceUrl
-        );
-        SocketDispatcher.apply(Service, [namespace, events, systemContext]);
+        const { modules, host, port, route, namespace, socketPath } =
+          await loadConnectionData(httpClient, connData.serviceUrl);
+
+        SocketDispatcher.apply(Service, [
+          { socketPath, namespace },
+          events,
+          systemContext,
+        ]);
 
         modules.forEach(({ namespace, route, name }) => {
           if (Service[name]) {
-            Service[name].__setConnection(host, port, route, namespace);
+            Service[name].__setConnection({ host, port, route, namespace, socketPath });
             Service[name].emit("reconnect");
           }
         });

package/systemlynx/Client/components/ClientModule.js

@@ -7,26 +7,30 @@ const getProtocol = (url) => url.match(/^(\w+):\/\//)[0];
 module.exports = function SystemLynxClientModule(
   httpClient,
   { methods, namespace, route, connectionData, name },
-  { port, host, serviceUrl },
+  { port, host, serviceUrl, socketPath },
   Service,
   systemContext
 ) {
   const events = {};
   const ClientModule = headerSetter.apply({});
 
-  ClientModule.__setConnection = (host, port, route, namespace) => {
+  ClientModule.__setConnection = ({ host, port, route, namespace, socketPath }) => {
     ClientModule.__connectionData = () => ({ route, host, port });
 
-    SocketDispatcher.apply(ClientModule, [namespace, events, systemContext]);
+    SocketDispatcher.apply(ClientModule, [
+      { namespace, socketPath },
+      events,
+      systemContext,
+    ]);
   };
-  ClientModule.__setConnection(host, port, route, namespace);
+  ClientModule.__setConnection({ host, port, route, namespace, socketPath });
 
   const reconnectModule = async (cb) => {
     try {
       const url = connectionData.serviceUrl + `?modules=${name}`;
-      const { modules, port, host } = await loadConnectionData(url);
-      const { namespace, route } = modules[0];
-      ClientModule.__setConnection(host, port, route, namespace);
+      const { modules, port, host, socketPath } = await loadConnectionData(url);
+      const { route, namespace } = modules[0];
+      ClientModule.__setConnection({ host, port, route, namespace, socketPath });
 
       if (typeof cb === "function") cb();
     } catch (error) {

package/systemlynx/Client/components/SocketDispatcher.js

@@ -2,18 +2,28 @@
 const io = require("socket.io-client");
 const createDispatcher = require("../../Dispatcher/Dispatcher");
 
-module.exports = function SocketDispatcher(namespace, events = {}, systemContext) {
+module.exports = function SocketDispatcher(
+  { namespace, socketPath: path },
+  events = {},
+  systemContext
+) {
   const dispatcher =
     (this || {}).on && (this || {}).emit
       ? this
       : createDispatcher.apply(this, [events, systemContext]);
-  const socket = io.connect(namespace, { reconnection: false });
+
+  const socket = io.connect(namespace, { path });
+
   socket.on("dispatch", (event) => dispatcher.emit(event.name, event.data, event));
+
   socket.on("disconnect", () => {
     socket.disconnect();
     dispatcher.emit("disconnect");
   });
-  socket.on("connect", () => dispatcher.emit("connect"));
+
+  socket.on("connect", () => {
+    dispatcher.emit("connect");
+  });
 
   dispatcher.disconnect = () => socket.disconnect();
   return dispatcher;

package/systemlynx/Client/tests/SocketDispatcher.test.js

@@ -1,17 +1,21 @@
 const { expect } = require("chai");
 const SocketDispatcher = require("../components/SocketDispatcher");
-const { WebSocket, SocketServer } =
-  require("../../ServerManager/components/WebSocketServer")();
-
-const namespace = "test-namespace";
 const port = 4592;
-const socket = WebSocket.of(`/${namespace}`);
+const socketPath = "/test-namespace";
+const route = `/events`;
+const namespace = `http://localhost:${port}${route}`;
+const { WebSocket, SocketServer } =
+  require("../../ServerManager/components/WebSocketServer")(socketPath);
 
+const socket = WebSocket.of(route);
+socket.on("connect", ({ id }) => {
+  console.log(`socket connected with id:${id}`);
+});
 SocketServer.listen(port);
 
 describe("SocketDispatcher", () => {
   const eventName = "test-event";
-  const dispatcher = new SocketDispatcher(`http://localhost:${port}/${namespace}`);
+  const dispatcher = new SocketDispatcher({ namespace, socketPath });
   it("should return an EventDispatcher object with methods on and emit", async () => {
     expect(dispatcher)
       .to.be.an("object")
@@ -36,9 +40,7 @@ describe("SocketDispatcher", () => {
 
 describe("SocketDispatcher.apply()", () => {
   const eventName = "testing-event";
-  const dispatcher = SocketDispatcher.apply({}, [
-    `http://localhost:${port}/${namespace}`,
-  ]);
+  const dispatcher = SocketDispatcher.apply({}, [{ namespace, socketPath }]);
   it("should return an EventDispatcher object with methods on and emit", async () => {
     expect(dispatcher)
       .to.be.an("object")

package/systemlynx/LoadBalancer/tests/LoadBalancer.test.js

@@ -67,7 +67,8 @@ describe("LoadBalancer", () => {
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array")
@@ -132,7 +133,8 @@ describe("LoadBalancer.clones (Module)", () => {
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array")

package/systemlynx/ServerManager/ServerManager.js

@@ -3,7 +3,6 @@ const createServer = require("./components/Server");
 const createRouter = require("./components/Router");
 const SocketEmitter = require("./components/SocketEmitter");
 const parseMethods = require("./components/parseMethods");
-const shortId = require("shortid");
 const http = require("http");
 const https = require("https");
 const socketIO = require("socket.io");
@@ -19,10 +18,10 @@ module.exports = function createServerManager(customServer) {
     port: null,
     useREST: false,
     useService: true,
-    staticRouting: false,
     ssl: { key: "", cert: "" },
     beforeware: { $all: [] },
     afterware: { $all: [] },
+    protocol: "http",
   };
 
   const server = createServer(customServer);
@@ -33,32 +32,22 @@ module.exports = function createServerManager(customServer) {
   const ServerManager = { server };
 
   ServerManager.startService = (options) => {
-    let { route, host = "localhost", port, staticRouting, ssl } = options;
+    let { route, host = "localhost", port, ssl, protocol } = options;
 
     route = route.charAt(0) === "/" ? route.substr(1) : route;
     route = route.charAt(route.length - 1) === "/" ? route.slice(0, -1) : route;
 
-    const namespace = staticRouting ? route : shortId();
-
-    const protocol = ssl ? "https" : "http";
+    if (!["http", "https"].includes(protocol)) protocol = ssl ? "https" : "http";
     const serviceUrl = `${protocol}://${host}:${port}/${route}`;
 
     const httpServer = ssl ? https.createServer(ssl, server) : http.createServer(server);
+    const socketPath = `/${route}/socket.io`;
 
-    const WebSocket = socketIO(httpServer);
+    const WebSocket = socketIO(httpServer, { path: socketPath });
 
-    SocketEmitter.apply(ServerManager, [namespace, WebSocket]);
+    SocketEmitter.apply(ServerManager, [route, WebSocket]);
 
-    Object.assign(serverConfigurations, {
-      ...options,
-      server: httpServer,
-      WebSocket,
-      serviceUrl,
-      route,
-      port,
-      ssl,
-    });
-    const wsProtocol = ssl ? "wss" : "ws";
+    const wsProtocol = protocol === "https" ? "wss" : "ws";
 
     const connectionData = {
       modules,
@@ -66,10 +55,21 @@ module.exports = function createServerManager(customServer) {
       route: `/${route}`,
       port,
       serviceUrl,
-      namespace: `${wsProtocol}://${host}:${port}/${namespace}`,
+      socketPath,
+      namespace: `${wsProtocol}://${host}:${port}/${route}`,
       SystemLynxService: true,
     };
 
+    Object.assign(serverConfigurations, {
+      ...options,
+      server: httpServer,
+      WebSocket,
+      serviceUrl,
+      route,
+      port,
+      protocol,
+    });
+
     server.get(`/${route}`, (req, res) => {
       res.json({ ...connectionData, modules });
     });
@@ -91,14 +91,13 @@ module.exports = function createServerManager(customServer) {
       host,
       route,
       serviceUrl,
-      staticRouting,
       useService,
       useREST,
       port,
       beforeware,
       afterware,
       WebSocket,
-      ssl,
+      protocol,
     } = serverConfigurations;
 
     if (!serviceUrl) return moduleQueue.push({ name, Module, reserved_methods });
@@ -112,19 +111,18 @@ module.exports = function createServerManager(customServer) {
       ...reserved_methods,
     ];
     const methods = parseMethods(Module, exclude_methods, useREST);
-    const namespace = staticRouting ? name : shortId();
-
-    SocketEmitter.apply(Module, [namespace, WebSocket]);
+    const path = `${route}/${name}`;
 
     const before_validators = [...beforeware.$all, ...(beforeware[name] || [])];
     const after_validators = [...afterware.$all, ...(afterware[name] || [])];
 
     if (useService) {
-      const path = staticRouting ? `${route}/${name}` : `${shortId()}/${shortId()}`;
-      const wsProtocol = ssl ? "wss" : "ws";
+      SocketEmitter.apply(Module, [path, WebSocket]);
+
+      const wsProtocol = protocol === "https" ? "wss" : "ws";
 
       modules.push({
-        namespace: `${wsProtocol}://${host}:${port}/${namespace}`,
+        namespace: `${wsProtocol}://${host}:${port}/${path}`,
         route: `/${path}`,
         name,
         methods,

package/systemlynx/ServerManager/components/WebSocketServer.js

@@ -1,7 +1,7 @@
-module.exports = function createWebSocket(server) {
+module.exports = function createWebSocket(path) {
   const express = require("express");
-  const SocketServer = require("http").Server(server || express());
-  const WebSocket = require("socket.io")(SocketServer);
+  const SocketServer = require("http").Server(express());
+  const WebSocket = require("socket.io")(SocketServer, { path });
 
   return { WebSocket, SocketServer };
 };

package/systemlynx/ServerManager/tests/ServerManager.test.js

@@ -40,6 +40,7 @@ describe("ServerManager", () => {
       .that.has.all.keys(
         "SystemLynxService",
         "serviceUrl",
+        "socketPath",
         "route",
         "host",
         "port",
@@ -71,6 +72,7 @@ describe("ServerManager", () => {
       .that.has.all.keys(
         "SystemLynxService",
         "serviceUrl",
+        "socketPath",
         "route",
         "host",
         "port",
@@ -108,6 +110,7 @@ describe("ServerManager", () => {
       .that.has.all.keys(
         "SystemLynxService",
         "serviceUrl",
+        "socketPath",
         "route",
         "host",
         "port",

package/systemlynx/Service/Service.test.js

@@ -45,7 +45,8 @@ describe("Service factory", () => {
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array").that.is.empty;
@@ -94,7 +95,8 @@ describe("Service.module(constructor)", () => {
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array");
@@ -232,7 +234,8 @@ describe("Service.module(object)", () => {
         "modules",
         "route",
         "namespace",
-        "serviceUrl"
+        "serviceUrl",
+        "socketPath"
       )
       .that.has.property("modules")
       .that.is.an("array");