factorio-clusterio/packages/controller/src/HttpCloser.js

"use strict";
const http = require("http");
const https = require("https");

/**
 * Gracefully close a Node.js HTTP(S) server
 *
 * Helper class to properly close down a Node.js HTTP(S) server.  This is
 * necessary due to connections being able to linger around forever with the
 * keep-alive logic in HTTP.
 *
 * @example
 * // during server initialization
 * const server = http.createServer();
 * const serverCloser = new HttpCloser(server);
 *
 * // in the shutdown logic
 * await serverCloser.close();
 *
 * @alias module:controller/src/HttpCloser
 */
class HttpCloser {
	/**
	 * Server to attach this closer to.
	 * @param {https.Server | http.Server} server - HTTP(S) to attach to
	 */
	constructor(server) {
		this._server = server;
		this._sockets = new Set();
		this._responses = new Set();

		if (this._server instanceof http.Server) {
			this._server.on("connection", this._addSocket.bind(this));
		} else if (this._server instanceof https.Server) {
			this._server.on("secureConnection", this._addSocket.bind(this));
		} else {
			throw Error("server must be an instance of either http.Server or https.Server.");
		}
		this._server.on("request", this._addRequest.bind(this));
	}

	_addSocket(socket) {
		this._sockets.add(socket);
		socket.once("close", () => {
			this._sockets.delete(socket);
		});
	}

	_addRequest(request, response) {
		this._responses.add(response);
		response.once("close", () => this._responses.delete(response));
		response.once("finish", () => this._responses.delete(response));
	}

	/**
	 * Gracefully close down the attached HTTP(S) server.
	 *
	 * Closes open connections that do not have a request in flight, signals
	 * connections to pending requests should close, and initiates the
	 * close operation on the attached server.
	 *
	 * If there's requests in progress that still haven't been completed
	 * after the timeout value passed they will be aborted.
	 *
	 * @param {number} timeout -
	 *     Time in ms to wait for connections to close.
	 */
	async close(timeout = 5000) {
		let activeSockets = new Set();
		for (let response of this._responses) {
			if (!response.headersSent) {
				response.setHeader("Connection", "close");
			} else {
				let socket = response.socket;
				response.once("finish", () => {
					socket.end();
				});
			}
			activeSockets.add(response.socket);
		}
		for (let socket of this._sockets) {
			if (!activeSockets.has(socket)) {
				socket.end();
			}
		}

		return new Promise((resolve, reject) => {
			let timer = setTimeout(() => {
				for (let socket of this._sockets) {
					// Ideally a RST would be sent here to indicate the the
					// transfer failed, but we can't reliably send that from
					// Node.js, see nodejs/node#27428.
					socket.destroy();
				}
			}, timeout);
			this._server.close(err => {
				clearTimeout(timer);
				if (err) {
					reject(err);
				} else {
					resolve();
				}
			});
		});
	}
};

module.exports = HttpCloser;