@vulkano/core 1.3.0 → 1.4.0

package/bootstrap/express.js

@@ -7,6 +7,8 @@ module.exports = function getExpressConfiguration() {
     cors,
     jwt,
     settings,
+    sockets,
+    redis,
     cookies,
     // Folder express config files
     express: expressServerConfig
@@ -41,6 +43,8 @@ module.exports = function getExpressConfiguration() {
     cors: {},
     cookies: {},
     jwt: {},
+    sockets: {},
+    redis: {},
     multer: {
       dest: 'public/files'
     },
@@ -65,7 +69,9 @@ module.exports = function getExpressConfiguration() {
     {
       cookies,
       jwt,
-      cors
+      cors,
+      sockets,
+      redis
     },
     expressDefaultConfig || {},
     expressServerConfig || {},

package/bootstrap/server.js

@@ -4,7 +4,7 @@
 
 const express = require('express');
 const frameguard = require('frameguard');
-// const { Server } = require('socket.io');
+const { Server } = require('socket.io');
 const nunjucks = require('nunjucks');
 const morgan = require('morgan');
 const compression = require('compression');
@@ -13,8 +13,8 @@ const helmet = require('helmet');
 const timeout = require('connect-timeout');
 const useragent = require('express-useragent');
 const cookieParser = require('cookie-parser');
-// const { createClient } = require('redis');
-// const { createAdapter } = require('@socket.io/redis-adapter');
+const { createClient } = require('redis');
+const { createAdapter } = require('@socket.io/redis-adapter');
 
 // Include all api controllers
 const AllControllers = require('include-all')({
@@ -23,21 +23,29 @@ const AllControllers = require('include-all')({
   optional: true
 });
 
+// Views Config
 const viewsConfig = require('./views');
 
-const responses = require('./responses');
-
-const JWT = require('../libs/Jwt');
+// JWT Middleware
+const jwtMiddleware = require('../libs/Jwt');
 
+// Express Config
 const expressConfig = require('./express')();
 
+// Express Responses
+const responses = require('./responses');
+
 module.exports = {
 
   routes: {},
 
   start: async function loadServerApplication(cb) {
 
-    const jwtMiddleware = JWT;
+    // Get ENV Vars
+    const {
+      JWT_SECRET_KEY,
+      COOKIES_SECRET_KEY
+    } = process.env || {};
 
     const vulkano = express();
 
@@ -73,7 +81,7 @@ module.exports = {
     // COOKIES - File: app/config/express/cookies.js
     // ---------------
     if (expressConfig.cookies && expressConfig.cookies.enabled) {
-      const cookiesSecretKey = process.env.COOKIES_SECRET_KEY || expressConfig.cookies.key || expressConfig.cookies.secret || '';
+      const cookiesSecretKey = COOKIES_SECRET_KEY || expressConfig.cookies.key || expressConfig.cookies.secret || '';
       if (!cookiesSecretKey) {
         console.log(' \x1b[33mWARNING\x1b[0m: Set the secret key in the config/express/cookie.js file or COOKIES_SECRET_KEY in the .env file.');
       }
@@ -171,7 +179,7 @@ module.exports = {
     // ---------------
     if (expressConfig.jwt && expressConfig.jwt.enabled) {
 
-      const jwtSecretKey = process.env.JWT_SECRET_KEY || expressConfig.jwt.key || expressConfig.jwt.secret || '';
+      const jwtSecretKey = JWT_SECRET_KEY || expressConfig.jwt.key || expressConfig.jwt.secret || '';
       if (!jwtSecretKey) {
         console.log(' \x1b[41mERROR\x1b[0m: Can not get key in config/express/jwt.js file or JWT_SECRET_KEY in .env file');
         return;
@@ -299,6 +307,14 @@ module.exports = {
       }
     });
 
+    // ---------------
+    // PUBLIC PATH - File: app/config/settings.js
+    // (if are using Vite)
+    // ---------------
+    if (!app.viteProxy) {
+      vulkano.use(express.static(PUBLIC_PATH));
+    }
+
     // ---------------
     // ROUTES
     // ---------------
@@ -423,14 +439,163 @@ module.exports = {
     });
 
     // ---------------
-    // PUBLIC PATH - File: app/config/settings.js
+    // PUBLIC PATH
+    // (if not are using Vite)
     // ---------------
-    vulkano.use(express.static(PUBLIC_PATH));
+    if (app.viteProxy) {
+      vulkano.use(express.static(PUBLIC_PATH));
+    }
 
     app.vulkano = vulkano;
     app.server = server;
 
-    cb();
+    // ---------------
+    // SOCKETS
+    // ---------------
+    const {
+      sockets,
+      redis
+    } = expressConfig || {};
+
+    if (!sockets || (sockets && !sockets.enabled)) {
+      cb();
+      return;
+    }
+
+    const socketProps = {
+      pingTimeout: +sockets.timeout || 4000,
+      pingInterval: +sockets.interval || 2000,
+      transports: sockets.transports || ['websocket', 'polling']
+    };
+
+    if (sockets.cors) {
+      if (typeof sockets.cors === 'function') {
+        socketProps.allowRequest = sockets.cors;
+      } else if (typeof sockets.cors === 'string') {
+        socketProps.cors = sockets.cors || '';
+      }
+    }
+
+    if (sockets.redis && !redis.enabled) {
+      throw new Error('Enable the Redis config "app/config/redis.js" to connect the sockets');
+    }
+
+    const io = new Server(server, socketProps);
+
+    let pubClient = null;
+    let subClient = null;
+
+    if (sockets.redis) {
+
+      if (sockets.transports.includes('polling')) {
+        throw new Error('To enable Sockets with Redis support, the transports must be set ¨websocket¨ only');
+      }
+
+      const propsToRedis = {
+        host: redis.host,
+        port: redis.port
+      };
+
+      if (redis.password) {
+        propsToRedis.password = redis.password;
+      }
+
+      pubClient = createClient(propsToRedis);
+      subClient = pubClient.duplicate();
+
+      io.adapter(createAdapter(pubClient, subClient));
+
+    }
+
+    Promise
+      .all([
+        (sockets.redis ? pubClient.connect() : null),
+        (sockets.redis ? subClient.connect() : null)
+      ])
+      .then(() => {
+
+        io.on('connection', (socket) => {
+
+          if ( typeof sockets.onConnect === 'function') {
+            sockets.onConnect(socket);
+          }
+
+          const socketEvents = sockets.events || {};
+
+          Object.keys(socketEvents).forEach( (i) => {
+
+            const checkPath = socketEvents[i] || '';
+
+            let toExecute = null;
+            let module = null;
+            let controller = null;
+            let action = null;
+
+            if (typeof checkPath === 'function') {
+
+              toExecute = checkPath;
+
+            } else {
+
+              const fullPath = checkPath.split('.');
+
+              if (fullPath.length > 2) { // Has folder
+
+                [
+                  module,
+                  controller,
+                  action
+                ] = fullPath;
+
+              } else {
+
+                [
+                  controller,
+                  action
+                ] = fullPath;
+
+              }
+
+              try {
+                toExecute = module
+                  ? (AllControllers[module][controller][action])
+                  : AllControllers[controller][action];
+              } catch (e) {
+                toExecute = null;
+              }
+
+            }
+
+            if (toExecute) {
+              socket.on(i, (body) => {
+                toExecute({ socket, body: body || {} });
+              });
+            } else {
+              console.error('\x1b[31mError:', 'Controller not found in', (module) ? `${module}.${controller}.${action}` : `${controller}.${action}`, '\x1b[0m', 'to socket event', i);
+            }
+
+          });
+
+          vulkano.set('socket', socket);
+          app.socket = socket;
+
+        });
+
+        // next line is the money
+        global.io = io;
+        vulkano.set('socketio', io);
+
+        // middleware
+        if (sockets.middleware && typeof sockets.middleware === 'function') {
+          io.use(sockets.middleware);
+        }
+
+        // override vulkano
+        app.vulkano = vulkano;
+
+        cb();
+
+      });
 
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vulkano/core",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A MVC framework using Express 4",
   "license": "MIT",
   "author": "Vulkano Team",