lukks/like-server

server.close() and keep-alive done right at socket level

like-server

server.close() and keep-alive done right at socket level.

require('like-server');
const app = require('express')();

app.get('/', (req, res) => res.send('ok'));

const server = app.listen(3000, () => {
  setTimeout(() => server.close(), 100);
});

// simulate browser request
const http = require('http');
http.get('http://127.0.0.1:3000', {
  agent: new http.Agent({ keepAlive: true })
});

The previous code will long 0s. Try without like-server: 5s!

Install

npm i like-server

Features

Handles keep-alive connections as it should be:

• Idle connections will be ended when server want to close.
• Active connections will be ended when request end.

Optional handle for long requests (long-polling, etc):

• 'terminate' event for server and socket.
• server.terminated and socket.terminated states.

Compatible with everything:

• net, http, https and cluster modules.
• Any framework that use them (express, etc).
• WebSocket with socket.requests.

Description

Combines great with like-process.
Built in the most efficient way based on research.
Don't need change any code, works as expected.
Useful when have deployment with docker, pm2, k8s, etc.
Provides instant close without destroying everything.

How it works?

Normally can listen on SIGTERM to close the server:

process.on('SIGTERM', () => server.close());

I recommend use like-process for better resource management.

The server.close() is called then:

• server.terminated state is setted and server 'terminate' event is emitted
• all socket.terminated state are setted
• sockets with pending requests are emitted with 'terminate' event
• sockets without pending requests are ended then destroyed
• Here we have the event loop empty so it really gracefully close

Example keep-alive

require('like-server');
const app = require('express')();

app.get('/', (req, res) => res.send('ok'));

const server = app.listen(3000, () => {
  console.log('listening');

  setTimeout(() => {
    console.log('closing');
    server.close();
  }, 100);
});

process.on('exit', () => console.log('exit'));

// simulate browser request
const http = require('http');
http.get('http://127.0.0.1:3000', {
  agent: new http.Agent({ keepAlive: true })
}, res => {
  res.on('data', chunk => console.log(chunk.toString()));
});

In 0s:

listening
ok
closing
exit

In 5s without like-server:

listening
ok
closing
exit +5s

Why the exit wait 5s? In real world would be more due doesn't actually close,
it keep accepting requests from sockets already connected due keep-alive.
It normally cause a timeout by Docker, pm2, etc to forcely kill the process.
You, Docker, etc should not destroy requests in the middle of something.

Example events

require('like-server');
const app = require('express')();

app.get('/', (req, res) => {
  let timeout = setTimeout(() => {
    res.send('ok');
  }, 3000);

  req.connection.once('terminate', () => {
    clearTimeout(timeout);
    res.send('term ok');
  });
});

const server = app.listen(3000, () => {
  console.log('listening');

  setTimeout(() => {
    console.log('closing');
    server.close();
  }, 100);
});

server.on('terminate', () => console.log('want to terminate'));
process.on('exit', () => console.log('exit'));

// simulate browser request
const http = require('http');
http.get('http://127.0.0.1:3000', {
  agent: new http.Agent({ keepAlive: true })
}, res => {
  res.on('data', chunk => console.log(chunk.toString()));
});

In 0s:

listening
closing
want to terminate
term ok
exit

In 8s without like-server:

listening
closing
ok +3s
exit +5s

Example states

require('like-server');
const app = require('express')();

app.get('/', (req, res) => {
  let count = 0;
  let interval = setInterval(() => {
    if (req.connection.terminated) {
      clearInterval(interval);
      res.end('term ok');
      return;
    }

    if(++count >= 3000) {
      clearInterval(interval);
      res.end('ok');
    }
  }, 1);
});

const server = app.listen(3000, () => {
  console.log('listening');

  setTimeout(() => {
    console.log('closing', server.terminated);
    server.close();
    console.log('closing', server.terminated);
  }, 100);
});

process.on('exit', () => console.log('exit'));

// simulate browser request
const http = require('http');
http.get('http://127.0.0.1:3000', {
  agent: new http.Agent({ keepAlive: true })
}, res => {
  res.on('data', chunk => console.log(chunk.toString()));
});

In 0s:

listening
closing false
closing true
term ok
exit

In 8s without like-server:

listening
closing undefined
closing undefined
ok +3s
exit +5s

Example for WebSocket

// https://github.com/websockets/ws#external-https-server
require('like-server');
const WebSocket = require('ws');
const server = require('http').createServer();
const wss = new WebSocket.Server({ server });

wss.on('connection', (ws) => {
  ws._socket.requests = 1;

  let interval = setInterval(() => {
    ws.send('ok');
  }, 30);

  ws._socket.once('terminate', () => {
    clearInterval(interval);
    ws.close(1000, 'term ok');
  });
});

server.listen(3000, () => {
  console.log('server listening');

  setTimeout(() => {
    console.log('server closing');
    server.close();
  }, 100);
});

process.on('exit', () => console.log('exit'));

// simulate client
new WebSocket('ws://localhost:3000')
.on('open', () => console.log('client opened'))
.on('close', (code, reason) => console.log('client closed', reason))
.on('message', data => console.log('client recv', data));

In 0s:

server listening
client opened
client recv ok
client recv ok
client recv ok
server closing
client closed term ok
exit

In infinite seconds without like-server because never ends:

server listening
client opened
client recv ok
client recv ok
server closing
client recv ok
client recv ok
... continues sending ok

Can use wss.close() to abruptly close but the interval never ends,
it becomes difficult to handle resources like timers so better use like-server.

Tests

npm test

License

Code released under the MIT License.

like-server's Issues

Cannot read property '_readableState' of undefined

Greetings.

I'm using node v14.17.5. My code uses ES6 imports with @babel/register required at app start to transpile.

My server file:

import Koa from 'koa'
import 'like-server'

...

const server = app.listen(SERVICE_PORT)
process.on('SIGTERM', () => {
  console.log(
    'SIGTERM signal received. Server will stop accepting requests.'
  )
  server.close(() => {
    console.log('HTTP server closed')
  })
})

When I kill the process, I get the following:

SIGTERM signal received. Server will stop accepting requests.
internal/streams/destroy.js:6
  const r = this._readableState;
                 ^

TypeError: Cannot read property '_readableState' of undefined
    at destroy (internal/streams/destroy.js:6:18)
    at Socket.onfinish (internal/streams/writable.js:689:5)
    at Socket.emit (events.js:400:28)
    at Socket.emit (domain.js:470:12)
    at finish (internal/streams/writable.js:657:10)
    at finishMaybe (internal/streams/writable.js:644:9)
    at ShutdownWrap.callback (internal/streams/writable.js:617:7)
    at ShutdownWrap.afterShutdown [as oncomplete] (net.js:435:8)