1.2.2 • Published 3 years ago

http-shutdown v1.2.2

Weekly downloads
34,281
License
MIT
Repository
github
Last release
3 years ago

Http-Shutdown NPM version Build status Test coverage

Shutdown a Nodejs HTTP server gracefully by doing the following:

  1. Close the listening socket to prevent new connections
  2. Close all idle keep-alive sockets to prevent new requests during shutdown
  3. Wait for all in-flight requests to finish before closing their sockets.
  4. Profit!

Other solutions might just use server.close which only terminates the listening socket and waits for other sockets to close - which is incomplete since keep-alive sockets can still make requests. Or, they may use ref()/unref() to simply cause Nodejs to terminate if the sockets are idle - which doesn't help if you have other things to shutdown after the server shutsdown.

http-shutdown is a complete solution. It uses idle indicators combined with an active socket list to safely, and gracefully, close all sockets. It does not use ref()/unref() but, instead, actively closes connections as they finish meaning that socket 'close' events still work correctly since the sockets are actually closing - you're not just unrefing and forgetting about them.

Installation

$ npm install http-shutdown

Usage

There are currently two ways to use this library. The first is explicit wrapping of the Server object:

// Create the http server
var server = require('http').createServer(function(req, res) {
  res.end('Good job!');
});

// Wrap the server object with additional functionality.
// This should be done immediately after server construction, or before you start listening.
// Additional functionailiy needs to be added for http server events to properly shutdown.
server = require('http-shutdown')(server);

// Listen on a port and start taking requests.
server.listen(3000);

// Sometime later... shutdown the server.
server.shutdown(function(err) {
	if (err) {
		return console.log('shutdown failed', err.message);
	}
	console.log('Everything is cleanly shutdown.');
});

The second is implicitly adding prototype functionality to the Server object:

// .extend adds a .withShutdown prototype method to the Server object
require('http-shutdown').extend();

var server = require('http').createServer(function(req, res) {
  res.end('God job!');
}).withShutdown(); // <-- Easy to chain. Returns the Server object

// Sometime later, shutdown the server.
server.shutdown(function(err) {
	if (err) {
		return console.log('shutdown failed', err.message);
	}
  console.log('Everything is cleanly shutdown.');
});

Test

$ npm test
drakov-js@yarvis/ws@webgeodatavore/tileserver-gl-light@whitewater-guide/logbook-serveractive-observerairic-api-gateway-config-serverairic-api-gateway-key-server@youon/videojs-abloop@ezs/coredrakovbuhoibs-liteavobackkbash.origin.expressboat-cliaswh@requestnetwork/request-node@smujaddid/drakovexpress-quick-builderexpress-listen-oneeventgateezschromaticaelectron-ssrflintcmsflairjs-fabric-defaultsflaksluminati-proxy-strippedgamoramarkserv-climathoidmay-it-servelisthengraceful-shutdown-expressh2o-proxyl10n-toolskoa-enhanced-serverkinvey-universal-runnerkeuss-serverinfra-workframehttp-test-serverhttps-proxy-serverhazyairjest-puppe-shots-envjbjaresmeta-proxy-managermetaform@trigo/atrix-soap@simplej/spry-core@serenity-js/local-server@teselagen/s3-uploadsnode-red-appnode-multi-webservermockingjaysmyclaspmu-koan-serverrest-api-servicerest-in-contractslevomat-tileserver-gl-lightservice-template-nodeskymet-proxy-managernode-standupnode-rtsp-stream-jsmpegnpg_rangeroly-httppam-http_en@acalcutt/tileserver-gl@acalcutt/tileserver-gl-light@absanger/npg_rangersteedos-node-redtelegram-test-apitileserver-gltileserver-gl-lighttileserver-gl-light-customtrinity-jesttoor@ascot/http@ascot/http-server@arso-project/sonar-server@arsonar/server@andrew-codes/marcoyyl-seed-test-utils3cf1gsandbox-test-serverspotify-personal-authsrc2imgsumbal-tileserver-glstencila-nodestencila-node-0.26.0unito@jdesboeufs/tileserver-gl@jdesboeufs/tileserver-gl-light@horwood/server@grishah/npg_ranger@leopradel/telegram-test-api@nexusapp/luminati-proxy@nickpeihl/tileserver-gl@nickpeihl/tileserver-gl-light@coboxcoop/seeder
1.2.2

3 years ago

1.2.1

4 years ago

1.2.0

6 years ago

1.1.0

6 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago