on-finished

What is on-finished?

The on-finished npm package is a utility to execute a callback when an HTTP request/response cycle is completed or finished. It is useful for logging, cleaning up resources, or performing actions after the response has been sent to the client.

What are on-finished's main functionalities?

Execute callback when response finishes

This code sample creates an HTTP server that listens on port 3000. For each request, it uses on-finished to execute a callback when the response is finished. The callback logs 'Response finished' to the console.

const onFinished = require('on-finished');
const http = require('http');

http.createServer((req, res) => {
  onFinished(res, (err, res) => {
    console.log('Response finished');
  });

  res.end('Hello World');
}).listen(3000);

Detect when request is closed by the client

This code sample demonstrates how to use on-finished to detect when an HTTP request is closed prematurely by the client, such as when the client navigates away from the page or cancels the request.

const onFinished = require('on-finished');
const http = require('http');

http.createServer((req, res) => {
  onFinished(req, (err, req) => {
    if (err && err.code === 'ECONNRESET') {
      console.log('Request closed by the client');
    }
  });

  res.end('Hello World');
}).listen(3000);

Other packages similar to on-finished

finalhandler

The finalhandler package is similar to on-finished in that it is designed to ensure that the final callback is executed once the response is completed. It differs in that it is specifically designed to be used as the final step in a middleware chain and includes additional features like error handling.

ee-first

The ee-first package is a lower-level utility for ordering multiple event emitters. While it does not directly provide the same functionality as on-finished, it can be used to achieve similar results by tracking the 'end' or 'finish' events of streams, including HTTP request and response objects.

README

on-finished

Execute a callback when a HTTP request closes, finishes, or errors.

Install

$ npm install on-finished

API

var onFinished = require('on-finished')

onFinished(res, listener)

Attach a listener to listen for the response to finish. The listener will be invoked only once when the response finished. If the response finished to an error, the first argument will contain the error. If the response has already finished, the listener will be invoked.

Listening to the end of a response would be used to close things associated with the response, like open files.

Listener is invoked as listener(err, res).

onFinished(res, function (err, res) {
  // clean up open fds, etc.
  // err contains the error is request error'd
})

onFinished(req, listener)

Attach a listener to listen for the request to finish. The listener will be invoked only once when the request finished. If the request finished to an error, the first argument will contain the error. If the request has already finished, the listener will be invoked.

Listening to the end of a request would be used to know when to continue after reading the data.

Listener is invoked as listener(err, req).

var data = ''

req.setEncoding('utf8')
res.on('data', function (str) {
  data += str
})

onFinished(req, function (err, req) {
  // data is read unless there is err
})

onFinished.isFinished(res)

Determine if res is already finished. This would be useful to check and not even start certain operations if the response has already finished.

onFinished.isFinished(req)

Determine if req is already finished. This would be useful to check and not even start certain operations if the request has already finished.

Special Node.js requests

HTTP CONNECT method

The meaning of the CONNECT method from RFC 7231, section 4.3.6:

The CONNECT method requests that the recipient establish a tunnel to the destination origin server identified by the request-target and, if successful, thereafter restrict its behavior to blind forwarding of packets, in both directions, until the tunnel is closed. Tunnels are commonly used to create an end-to-end virtual connection, through one or more proxies, which can then be secured using TLS (Transport Layer Security, [RFC5246]).

In Node.js, these request objects come from the 'connect' event on the HTTP server.

When this module is used on a HTTP CONNECT request, the request is considered "finished" immediately, due to limitations in the Node.js interface. This means if the CONNECT request contains a request entity, the request will be considered "finished" even before it has been read.

There is no such thing as a response object to a CONNECT request in Node.js, so there is no support for for one.

HTTP Upgrade request

The meaning of the Upgrade header from RFC 7230, section 6.1:

The "Upgrade" header field is intended to provide a simple mechanism for transitioning from HTTP/1.1 to some other protocol on the same connection.

In Node.js, these request objects come from the 'upgrade' event on the HTTP server.

When this module is used on a HTTP request with an Upgrade header, the request is considered "finished" immediately, due to limitations in the Node.js interface. This means if the Upgrade request contains a request entity, the request will be considered "finished" even before it has been read.

There is no such thing as a response object to a Upgrade request in Node.js, so there is no support for for one.

Example

The following code ensures that file descriptors are always closed once the response finishes.

var destroy = require('destroy')
var http = require('http')
var onFinished = require('on-finished')

http.createServer(function onRequest(req, res) {
  var stream = fs.createReadStream('package.json')
  stream.pipe(res)
  onFinished(res, function (err) {
    destroy(stream)
  })
})

License

MIT