libretic/etherpad-lite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

socket.io: Disconnect clients when closing HTTP server

Browse source
This commit is contained in:
Richard Hansen 2020-12-07 15:48:28 -05:00
parent 9f7d42185d
commit f31232dd20
2 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/ep.json
View file

@ -83,6 +83,7 @@
{
"name": "socketio",
"hooks": {
"expressCloseServer": "ep_etherpad-lite/node/hooks/express/socketio",
"expressCreateServer": "ep_etherpad-lite/node/hooks/express/socketio"
}
},

23
src/node/hooks/express/socketio.js
View file

@ -6,15 +6,34 @@ const settings = require('../../utils/Settings');
const socketio = require('socket.io');
const socketIORouter = require('../../handler/SocketIORouter');
const hooks = require('../../../static/js/pluginfw/hooks');
const padMessageHandler = require('../../handler/PadMessageHandler');
const util = require('util');
let io;
exports.expressCloseServer = async () => {
// According to the socket.io documentation every client is always in the default namespace (and
// may also be in other namespaces).
const ns = io.sockets; // The Namespace object for the default namespace.
// Disconnect all socket.io clients. This probably isn't necessary; closing the socket.io Engine
// (see below) probably gracefully disconnects all clients. But that is not documented, and this
// doesn't seem to hurt, so hedge against surprising and undocumented socket.io behavior.
for (const id of await util.promisify(ns.clients.bind(ns))()) {
ns.connected[id].disconnect(true);
}
// Don't call io.close() because that closes the underlying HTTP server, which is already done
// elsewhere. (Closing an HTTP server twice throws an exception.) The `engine` property of
// socket.io Server objects is undocumented, but I don't see any other way to shut down socket.io
// without also closing the HTTP server.
io.engine.close();
};
exports.expressCreateServer = (hookName, args, cb) => {
// init socket.io and redirect all requests to the MessageHandler
// there shouldn't be a browser that isn't compatible to all
// transports in this list at once
// e.g. XHR is disabled in IE by default, so in IE it should use jsonp-polling
const io = socketio({
io = socketio({
transports: settings.socketTransportProtocols,
}).listen(args.server, {
/*