systemlynx 1.15.11 → 1.17.11

package/index.test.js

@@ -124,7 +124,6 @@ describe("SystemLynx Objects", () => {
         "addBeforware",
         "addAfterware",
         "server",
-        "WebSocket",
       ])
       .that.respondsTo("startService")
       .that.respondsTo("addModule")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systemlynx",
-  "version": "1.15.11",
+  "version": "1.17.11",
   "description": "",
   "main": "index.js",
   "browser": {

package/systemlynx/ServerManager/ServerManager.js

@@ -2,83 +2,81 @@
 const createServer = require("./components/Server");
 const createRouter = require("./components/Router");
 const SocketEmitter = require("./components/SocketEmitter");
-const createWebSocket = require("./components/WebSocketServer");
 const parseMethods = require("./components/parseMethods");
 const shortId = require("shortid");
-const randomPort = () => Math.floor(Math.random() * (65535 - 49152 + 1)) + 49152;
-const createSSLServer = (app, options) => {
-  const https = require("https");
-  return https.createServer(options, app);
-};
+const http = require("http");
+const https = require("https");
+const socketIO = require("socket.io");
 
-module.exports = function createServerManager(customServer, customWebSocketServer) {
+module.exports = function createServerManager(customServer) {
   let serverConfigurations = {
+    server: null,
+    WebSocket: null,
     route: null,
     port: null,
     host: "localhost",
     serviceUrl: null,
-    socketPort: null,
+    port: null,
     useREST: false,
     useService: true,
     staticRouting: false,
     ssl: { key: "", cert: "" },
     beforeware: { $all: [] },
     afterware: { $all: [] },
+    protocol: "http",
   };
+
   const server = createServer(customServer);
   const router = createRouter(server, () => serverConfigurations);
-  const { SocketServer, WebSocket } = createWebSocket(customWebSocketServer);
   const moduleQueue = [];
   const modules = [];
 
-  const ServerManager = { server, WebSocket };
+  const ServerManager = { server };
 
   ServerManager.startService = (options) => {
-    let {
-      route,
-      host = "localhost",
-      port,
-      socketPort = randomPort(),
-      staticRouting,
-      ssl,
-    } = options;
+    let { route, host = "localhost", port, staticRouting, 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();
-    SocketServer.listen(socketPort);
+    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 WebSocket = socketIO(httpServer);
+
     SocketEmitter.apply(ServerManager, [namespace, WebSocket]);
 
-    route = route.charAt(0) === "/" ? route.substr(1) : route;
-    route =
-      route.charAt(route.length - 1) === "/" ? route.substr(route.length - 1) : route;
-    const protocol = ssl ? "https" : "http";
-    const serviceUrl = `${protocol}://${host}:${port}/${route}`;
+    const wsProtocol = protocol === "https" ? "wss" : "ws";
 
-    serverConfigurations = {
-      ...serverConfigurations,
-      ...options,
-      serviceUrl,
-      route,
-      socketPort,
-    };
     const connectionData = {
       modules,
       host,
       route: `/${route}`,
       port,
       serviceUrl,
-      namespace: `ws://${host}:${socketPort}/${namespace}`,
+      namespace: `${wsProtocol}://${host}:${port}/${namespace}`,
       SystemLynxService: true,
     };
 
+    Object.assign(serverConfigurations, {
+      ...options,
+      server: httpServer,
+      WebSocket,
+      serviceUrl,
+      route,
+      port,
+      protocol,
+    });
+
     server.get(`/${route}`, (req, res) => {
-      //The route will return connection data for the service including an array of
-      //modules (objects) which contain instructions on how to make request to each object
       res.json({ ...connectionData, modules });
     });
 
     return new Promise((resolve) => {
-      const _server = ssl ? createSSLServer(server, ssl) : server;
-      _server.listen(port, () => {
+      httpServer.listen(port, () => {
         console.log(`[SystemLynx][Service]: Listening on ${serviceUrl}\n`);
         moduleQueue.forEach(({ name, Module, reserved_methods }) =>
           ServerManager.addModule(name, Module, reserved_methods)
@@ -97,12 +95,15 @@ module.exports = function createServerManager(customServer, customWebSocketServe
       staticRouting,
       useService,
       useREST,
-      socketPort,
+      port,
       beforeware,
       afterware,
+      WebSocket,
+      protocol,
     } = serverConfigurations;
 
     if (!serviceUrl) return moduleQueue.push({ name, Module, reserved_methods });
+
     const exclude_methods = [
       "on",
       "emit",
@@ -115,30 +116,36 @@ module.exports = function createServerManager(customServer, customWebSocketServe
     const namespace = staticRouting ? name : shortId();
 
     SocketEmitter.apply(Module, [namespace, WebSocket]);
+
     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 = protocol === "https" ? "wss" : "ws";
 
       modules.push({
-        namespace: `ws://${host}:${socketPort}/${namespace}`,
+        namespace: `${wsProtocol}://${host}:${port}/${namespace}`,
         route: `/${path}`,
         name,
         methods,
       });
+
       methods.forEach((method) => {
         const nsp = `${name}.${method.fn}`;
         const beforeValidators = [...before_validators, ...(beforeware[nsp] || [])];
         const afterValidators = [...after_validators, ...(afterware[nsp] || [])];
+
         router.addService(Module, path, method, name, beforeValidators, afterValidators);
       });
     }
+
     if (useREST)
       methods.forEach((method) => {
         const nsp = `${name}.${method.fn}`;
         const beforeValidators = [...before_validators, ...(beforeware[nsp] || [])];
         const afterValidators = [...after_validators, ...(afterware[nsp] || [])];
+
         switch (method.fn) {
           case "get":
           case "put":
@@ -156,7 +163,6 @@ module.exports = function createServerManager(customServer, customWebSocketServe
       });
   };
 
-  // Shared function for adding middleware (both beforeware and afterware)
   const addMiddleware = (type, ...args) => {
     const name = typeof args[0] === "string" ? args.shift() : "$all";
     args.forEach(async (middleware) => {
@@ -168,7 +174,6 @@ module.exports = function createServerManager(customServer, customWebSocketServe
     });
   };
 
-  // Helper function to add a single middleware item
   const addMiddlewareItem = (type, name, middleware) => {
     if (Array.isArray(middleware))
       return middleware.map((m) => addMiddlewareItem(type, name, m));
@@ -186,18 +191,8 @@ module.exports = function createServerManager(customServer, customWebSocketServe
     });
   };
 
-  // Use the shared function for both middleware types
   ServerManager.addBeforware = (...args) => addMiddleware("beforeware", ...args);
   ServerManager.addAfterware = (...args) => addMiddleware("afterware", ...args);
+
   return ServerManager;
 };
-
-//creating an ssl setup with openssl cli
-//1. `openssl genrsa -out key.pem` to generate a private key
-//2. create a certificate signing request using the key we just generated
-// `openssl req -new -key key.pem -out csr.pem`
-//3. Answer the prompts in the terminal
-//4. use the newly generate csr to generate a ssl certificate
-// openssl x509 -req -days 365 -in csr.pem -signkey key.pem -out cert.pem
-//(x509 is the standard to use for the certificate, days are the number of day the cert is valid)
-//5. csr.pem is no longer needed

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

@@ -14,7 +14,6 @@ describe("createServerManager function", () => {
         "addBeforware",
         "addAfterware",
         "server",
-        "WebSocket",
       ])
       .that.respondsTo("startService")
       .that.respondsTo("addModule")
@@ -89,7 +88,7 @@ describe("ServerManager", () => {
   it("should be able call ServerManager.addModule method before or after calling ServerManager.startService", async () => {
     const ServerManager = createServerManager();
     const route = "/testService";
-    const port = 4500;
+    const port = 4600;
     const url = `http://localhost:${port}${route}`;
     const name = "TestModule";
 

package/systemlynx/Service/Service.test.js

@@ -26,7 +26,7 @@ describe("Service factory", () => {
   it("should be able to use Service.startService to initiate a ServerManager instance that hosts the Service Connection Data", async () => {
     const Service = createService();
     const route = "/testService";
-    const port = 5500;
+    const port = 5600;
     const url = `http://localhost:${port}${route}`;
 
     await Service.startService({ route, port });
@@ -109,9 +109,7 @@ describe("Service.module(constructor)", () => {
     ]);
     expect(results.modules[0].name, "mod");
     expect(results.modules[0].route).to.be.a("String");
-    expect(results.modules[0].namespace).to.match(
-      new RegExp("https?://localhost:\\d+/.+")
-    );
+    expect(results.modules[0].namespace).to.match(new RegExp("wss?://localhost:\\d+/.+"));
     expect(results.SystemLynxServerService, {
       serviceUrl: "localhost:6542/test/service",
     });
@@ -249,9 +247,7 @@ describe("Service.module(object)", () => {
     ]);
     expect(results.modules[0].name, "mod");
     expect(results.modules[0].route).to.be.a("String");
-    expect(results.modules[0].namespace).to.match(
-      new RegExp("https?://localhost:\\d+/.+")
-    );
+    expect(results.modules[0].namespace).to.match(new RegExp("wss?://localhost:\\d+/.+"));
     expect(results.SystemLynxServerService, {
       serviceUrl: "localhost:6542/test/service",
     });