mehdi-shokohi/neucluster

Multi Protocol Server Builder and Process Manager Platform

NeuCluster

Router base Http ,WebSocket ,RPC and Other Protocols Server Builder by Node.js

this project run only on linux os

this project is an multi process server builder for backend and microservice's with below components :

http builder with router and middleware

scheduler Builder

native http builder

rpc server (websocket jsonrpc2.0) for inter microservice communication

rpc client

WebSocket Server Builder

HTTP/2

Custom Server Builder - e.g., Socket.IO Implemented

Sequelize ORM

tmpfs (Ram Base) Config Store , RunTime Config Change By neuconf Tool

Run Project

# npm install
# npm start

Sample Code

due to the fact that system is designed for microservices applications , included services and controller file structure .

you can set services folder by below line code .

Loading Services Folder's Files , For using Service Class , Build It Based On Sample Template , those will be accessible By File Name in global space .

require('./component/service_loader')(__dirname+"/services")

Router Base HTTP Server

let ControllerPath = __dirname+"/api_2030";
//Set Port and Controller Path Folder Name. and Cluster Instance Number
var http_server = new httpBuilder(2030,null,ControllerPath,1);
var x=0;

Use Middleware For Router Of Http Server

http_server.getRouter().use(bodyParser.json());
http_server.getRouter().use(compression())
//Run Http Server
http_server.run();

Event hook in Pre Route . This Function will Run Before Process Of any middleware and route . In This Sample xx variable Added To req , that is Accessible In Any Controller .

http_server.on('pre_route', req=>{
  req.xx={alpha:++x}
})

Job Scheduler

var job = new sch(__dirname+"/jobs",['job1','job2']) // Set Job's Folder and File's
job.run();

Run second HttpServer with Port 2040 And Added version by /v1 to Path by prePath Option , Https Options(HTTP/2) and related Controller Path

In First Generate Self Sign Certificate For key and cert Value

# openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./server.key -out server.crt

ControllerPath = __dirname+"/api_2040";

let key = path.join(__dirname, 'server.key');
let cert = path.join(__dirname, 'server.crt');
var options = {
  prePath: "/v1",
  key: fs.readFileSync(key),
  cert: fs.readFileSync(cert),
  requestCert: false, //Set True on Release
  rejectUnauthorized: false, //Set True on Release

};
ControllerPath = __dirname+"/api_2040";
var httpServer2 = new httpBuilder(2040,options,ControllerPath,1);
httpServer2.getRouter().use(bodyParser.json());
httpServer2.getRouter().use(compression())
httpServer2.run()

Native Nodejs HTTP Protocol Without Any Middleware and Router

For HTTPS and HTTP/2 Communication set Options for initiation of NativeHttp Class

let nativeHTTP=new nativeHttp(2060,options,1);
nativeHTTP.run()
nativeHTTP.on('onRequest',(req,res)=>{

  res.writeHead(200, {'Content-Type': 'application/json'});
  var q = url.parse(req.url, true).query;

  res.end(JSON.stringify({Value : q.value}));

})

Initiate and Running RPC Server

var rpc = new rpc_server(8080,__dirname+'/rpcFunctions',1)
rpc.run()

Rpc Client Sample : call api_2030/message => http://localhost:2030/message

initiate WebSocket Server .

For SSL WebSocket Communication set Options for initiation of websocket Class

var ws = new websocket(3000,null,3) 
ws.run();
ws.on('startServer',()=>{
  console.log("WebSocket Server  Started .")
})

ws.on('request',(req)=>{
//req.reject()  if (your logic.)
})

ws.on('connection',(connection)=>{
  console.log(`Client ${connection.remoteAddress} Connected.`)

  connection.on('message', function(message) {

      console.log('Client Message is ' + message.utf8Data);
      connection.sendUTF(`Your Message Is ${message.utf8Data} . Thanx For Message`);


  });

  connection.on('close', function(closeCode, data) {
    console.log(connection.remoteAddress + ' disconnected.');
  });
})

Web Socket Client

<script>
    var wsServer = 'ws://127.0.0.1:3000'; //wss for ssl
    
    var websocket = new WebSocket(wsServer); 
    websocket.onopen = function (evt) { 
        console.log("Connected to WebSocket server.");
    }; 
    
    websocket.onclose = function (evt) { 
        console.log("Disconnected"); 
    }; 
    
    websocket.onmessage = function (evt) { 
        console.log( evt.data); 
    
    }; 
    
    websocket.onerror = function (evt, e) {
        console.log('Error occured: ' + evt.data);
    };
    </script> 

Android WebSocket Client

https://github.com/TakahikoKawasaki/nv-websocket-client

Custom Server Builder

In case of Create and Add your Custom Server,the only thing you need to do is to Extend serverBuilder Class and Implement serverInit Method .

As an example, We have a Custom Server with Socket.io Protocol below

const server = require('./component/serverBuilder')

class mySocketIO extends server{
  constructor (port,instance,option){
    super(port, instance)

  }

  // set Log Message Or other Operation In server Process's Start Up
  afterStart(){
    console.log(`my Custom Server(Socket.IO) Worker ${process.pid} started for Port ${this.port}`);
  }

  serverInit(){
    this.server = require('http').createServer();
    const io = require('socket.io')(this.server);


    io.on('connection', client => {
      client.on('hello',(data)=>{
        console.log(data)
        client.emit('hi',{data:`hi Client ${client.id}`})
      })
     client.on('disconnect', () => {});
    });
    this.server.listen(this.port);
  }

}

// initiate my Custom Class 
// port : 10010
// instance : 2
var sio = new mySocketIO(10010,2,null)
sio.run()

Socket.IO Client

<!DOCTYPE html>
<html lang="en">
<head>
    <script src="https://cdn.jsdelivr.net/npm/socket.io-client@2/dist/socket.io.js"></script>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<script>
  var socket = io('http://localhost:10010',{transports: ['websocket']}); 
  socket.on('connect', function(){
    console.log('socket io connected')

  });
  socket.on('hi', function(data){
    console.log(data)
  });
  socket.on('disconnect', function(){});
</script>
</body>
</html>

in Chrome or Mozilla Console run socket.emit("hello",{yourkey : 'yourValue'}); for sending data to Server.

ORM and Sequelize Models Loader

https://sequelize.org

Load DB Models Folder and set a File For Associate Models Relations.

let config = {
  "development": {
    "username": "root",
    "password": "123456",
    "database": "my_db",
    "host": "localhost",
    "dialect": "mariadb",
    "port": 3306,
    "pool": {
      "max": 10,
      "min": 0,
      "acquire": 30000,
      "idle": 10000
    },
    "define": {
      "underscored": false,
      "syncOnAssociation": true,
      "charset": "utf8mb4",
      "collate": "utf8mb4_general_ci",
      "timestamps": false
    },    
    dialectOptions: {
      useUTC: true,
      timezone: 'Etc/GMT+0'
    },
    timezone: 'Etc/GMT+0' 
  }
}


let models_folder = __dirname+'/models'
let relations_file = __dirname+'/models/relations.js'
let db = require('./component/db_models_loader')(config.development,models_folder,relations_file)

e.g. ,

  db.user.findOne({
    where :{
      userId : 1000,

    }
  }).then(user_data=>{

  }).catch(err=>{
    
  })

Change Value of Config Setting

 # chmod a+x bin/neuconf
 # neuconf set key value  
 # neuconf get key
 # neuconf get 

For Example, analyticsUrl by default is https://analytics.server1.com that Will Be Changed By below Command

# neuconf set analyticsUrl https://analytic.server22.com

For Using New Value in RunTime,

var mem = require('./tools').shmem
mem.shmGet_dyn('analyticsUrl')

How Can I Create a Custom Extended Server Based on NeuCluster ?

For Instance https://github.com/mehdi-shokohi/MyNeuCluster Repo is A Custom Extended HTTP Server