serby / express-graceful-shutdown

Ensure that during shutdown express returns correctly with a 503

express-graceful-shutdown

Ensure that during shutdown express returns correctly with a 503

Installation

npm install express-graceful-shutdown --save

Options

• logger: a logger that provides info, warn, and error functions for recording graceful shutdown. Default: console.
• forceTimeout: number of milliseconds to wait for server.close() to complete before calling process.exit(1). Default: 30000.

Usage

var express = require('express'),
  app = express(),
  createGracefulShutdownMiddleware = require('express-graceful-shutdown'),
  http = require('http'),
  server = http.createServer(app)

app.use(createGracefulShutdownMiddleware(server, { forceTimeout: 30000 }))

app.get('/', function(req, res) {
  res.json({ foo: 'bar' })
})

server.listen(3000)

Prettier

This project uses prettier for code formatting and linting. You can set prettier up to auto format code in your editor, or manually format code before committing with yarn prettier.

Credits

Paul Serby follow me on twitter @serby

License

Licensed under the ISC

express-graceful-shutdown's Issues

connection are not taken into account related to async handlers

These types of codes doesn't work with graceful shutdown mw:
app.use('/longop',function(req, res, next) { var i = 0; var callback = function() { if(i == 30) { res.end(); return; } res.write(i + '\n'); i++; setTimeout(callback, 1000); }; callback(); });

This kind of handlers are very important, as they are common when nodejs is the frontend, and after some little logic they propagate the requests for one or more backends.

Consider deprecating in favour of http-terminator

I have answered a variation of "how to terminate a HTTP server" many times on different Node.js support channels. Unfortunately, I couldn't recommend any of the existing libraries because they are lacking in one or another way (https://github.com/gajus/http-terminator#alternative-libraries). I have since put together a package that (I believe) is handling all the cases expected of graceful HTTP termination.

https://github.com/gajus/http-terminator

I would appreciate if you consider contributing to http-terminator and deprecating express-graceful-shutdown.

Code not updated to latest version of npm package

Got the latest npm package with version 1.0.0. But the latest code change was not found here on GitHub.

release & publish on npm

There were some commits merged a couple of weeks ago. When you have a free moment, could you bump the version number and publish the updated module to NPM?

Thanks :)