feat: add support for Socket.IO cluster

Author: darrachequesne

lib/God.js

@@ -27,6 +27,10 @@ var timesLimit = require('async/timesLimit');
 var Configuration = require('./Configuration.js');
 var semver = require('semver');
 
+const http = require('http');
+const { setupMaster } = require('@socket.io/sticky');
+const { setupPrimary } = require('@socket.io/cluster-adapter');
+
 /**
  * Override cluster module configuration
  */
@@ -39,7 +43,8 @@ if (semver.lt(process.version, '10.0.0')) {
 else {
  cluster.setupMaster({
  windowsHide: true,
- exec : path.resolve(path.dirname(module.filename), 'ProcessContainer.js')
+ exec : path.resolve(path.dirname(module.filename), 'ProcessContainer.js'),
+ serialization: 'advanced', // for packets containing buffers (https://nodejs.org/api/child_process.html#child_process_advanced_serialization)
  });
 }
 
@@ -82,6 +87,16 @@ God.init = function() {
  setTimeout(function() {
  God.Worker.start()
  }, 500)
+
+ const httpServer = http.createServer();
+
+ setupMaster(httpServer, {
+ loadBalancingMethod: 'least-connection',
+ });
+
+ setupPrimary();
+
+ httpServer.listen(process.env.PM2_PORT || 8080);
 }
 
 God.writeExitSeparator = function(pm2_env, code, signal) {

lib/God/ClusterMode.js

@@ -57,6 +57,10 @@ module.exports = function ClusterMode(God) {
  * Broadcast message to God
  */
  clu.on('message', function cluMessage(msg) {
+ if (msg && msg.source === '_sio_adapter') {
+ // ignore messages from the @socket.io/cluster-adapter (https://github.com/socketio/socket.io-cluster-adapter)
+ return;
+ }
  /*********************************
  * If you edit this function
  * Do the same in ForkMode.js !

package.json

@@ -1,5 +1,5 @@
 {
- "name": "pm2",
+ "name": "@socket.io/pm2",
  "preferGlobal": true,
  "version": "5.1.0",
  "engines": {
@@ -170,6 +170,8 @@
  "@pm2/io": "~5.0.0",
  "@pm2/js-api": "~0.6.7",
  "@pm2/pm2-version-check": "latest",
+ "@socket.io/cluster-adapter": "^0.1.0",
+ "@socket.io/sticky": "^1.0.0",
  "async": "~3.2.0",
  "blessed": "0.1.81",
  "chalk": "3.0.0",