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

express: New expressCloseServer hook

Browse source 
This will be used by a future commit to close all socket.io
connections during server restart.
This commit is contained in:
Richard Hansen 2020-12-14 15:48:13 -05:00
parent 3e8c3e5789
commit 8c1afc3399
2 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/api/hooks_server-side.md
View file

@ -76,6 +76,25 @@ Things in context:
This hook gets called after the application object has been created, but before it starts listening. This is similar to the expressConfigure hook, but it's not guaranteed that the application object will have all relevant configuration variables.
## expressCloseServer
Called from: src/node/hooks/express.js
Things in context: Nothing
This hook is called when the HTTP server is closing, which happens during
shutdown (see the shutdown hook) and when the server restarts (e.g., when a
plugin is installed via the `/admin/plugins` page). The HTTP server may or may
not already be closed when this hook executes.
Example:
```
exports.expressCloseServer = async () => {
await doSomeCleanup();
};
```
## eejsBlock_`<name>`
Called from: src/node/eejs/index.js

5
src/node/hooks/express.js
View file

@ -20,7 +20,10 @@ exports.server = null;
const closeServer = async () => {
if (exports.server == null) return;
logger.info('Closing HTTP server...');
await util.promisify(exports.server.close.bind(exports.server))();
await Promise.all([
util.promisify(exports.server.close.bind(exports.server))(),
hooks.aCallAll('expressCloseServer'),
]);
exports.server = null;
logger.info('HTTP server closed');
};