feat(signal): expose an option to change the signal the process listens on for shutdown

Author: vernak2539

README.md

@@ -33,7 +33,8 @@ terminus(server, {
 
   // cleanup options
   timeout: 1000,                   // [optional = 5000] number of milliseconds before forcefull exiting
-  onSigterm,                       // [optional] cleanup function, returning a promise
+  signal,                          // [optional = 'SIGTERM'] what signal to listen for relative to shutdown
+  onSignal,                        // [optional] cleanup function, returning a promise (used to be onSigterm)
   onShutdown,                      // [optional] called right before exiting
 
   // both

lib/standalone-tests/terminus.onshutdown.sigint.js

@@ -0,0 +1,21 @@
+'use strict';
+const http = require('http');
+const server = http.createServer((req, res) => res.end('hello'));
+
+const terminus = require('../terminus');
+const SIGNAL = 'SIGINT';
+
+terminus(server, {
+  signal: SIGNAL,
+  onSignal: () => {
+    console.log('on-sigint-runs');
+    return Promise.resolve();
+  },
+  onShutdown: () => {
+    console.log('on-shutdown-runs');
+  }
+});
+
+server.listen(8000, () => {
+  process.kill(process.pid, SIGNAL);
+});

…/standalone-tests/terminus.onshutdown.js …one-tests/terminus.onshutdown.sigterm.jslib/standalone-tests/terminus.onshutdown.js renamed to lib/standalone-tests/terminus.onshutdown.sigterm.js lib/standalone-tests/terminus.onshutdown.js renamed to lib/standalone-tests/terminus.onshutdown.sigterm.js

@@ -5,7 +5,7 @@ const server = http.createServer((req, res) => res.end('hello'));
 const terminus = require('../terminus');
 
 terminus(server, {
-  onSigterm: () => {
+  onSignal: () => {
     console.log('on-sigterm-runs');
     return Promise.resolve();
   },

lib/standalone-tests/terminus.onsigint.js

@@ -0,0 +1,18 @@
+'use strict';
+const http = require('http');
+const server = http.createServer((req, res) => res.end('hello'));
+
+const terminus = require('../terminus');
+const SIGNAL = 'SIGINT';
+
+terminus(server, {
+  signal: SIGNAL,
+  onSignal: () => {
+    console.log('on-sigint-runs');
+    return Promise.resolve();
+  }
+});
+
+server.listen(8000, () => {
+  process.kill(process.pid, SIGNAL);
+});

lib/standalone-tests/terminus.onsigterm.js

@@ -5,7 +5,7 @@ const server = http.createServer((req, res) => res.end('hello'));
 const terminus = require('../terminus');
 
 terminus(server, {
-  onSigterm: () => {
+  onSignal: () => {
     console.log('on-sigterm-runs');
     return Promise.resolve();
   }

lib/terminus.js

@@ -40,34 +40,35 @@ function decorateWithHealthCheck(server, options) {
   });
 }
 
-function decorateWithSigtermHandler(server, options) {
-  const { onSigterm, onShutdown, timeout, logger } = options;
+function decorateWithSignalHandler(server, options) {
+  const { signal, onSignal, onShutdown, timeout, logger } = options;
 
   stoppable(server, timeout);
 
   const asyncServerStop = promisify(server.stop).bind(server);
 
   function cleanup() {
     asyncServerStop()
-      .then(() => onSigterm())
+      .then(() => onSignal())
       .then(() => onShutdown())
       .then(() => {
-        process.removeListener('SIGTERM', cleanup);
-        process.kill(process.pid, 'SIGTERM');
+        process.removeListener(signal, cleanup);
+        process.kill(process.pid, signal);
       })
       .catch((error) => {
         logger('error happened during shutdown', error);
         process.exit(1);
       });
   }
-  process.on('SIGTERM', cleanup);
+  process.on(signal, cleanup);
 }
 
 function terminus(server, options = {}) {
   const healthChecks = options.healthChecks || {};
 
+  const signal = options.signal || 'SIGTERM';
   const timeout = options.timeout || 1000;
-  const onSigterm = options.onSigterm || noopResolves;
+  const onSignal = options.onSignal || options.onSigterm || noopResolves;
   const onShutdown = options.onShutdown || noopResolves;
 
   const logger = options.logger || noop;
@@ -77,8 +78,9 @@ function terminus(server, options = {}) {
     logger
   });
 
-  decorateWithSigtermHandler(server, {
-    onSigterm,
+  decorateWithSignalHandler(server, {
+    signal,
+    onSignal,
     onShutdown,
     timeout,
     logger

lib/terminus.spec.js

@@ -95,12 +95,34 @@ describe('Terminus', () => {
 
   it('runs onShutdown after onSigterm', () => {
     try {
-      execFileSync('node', ['lib/standalone-tests/terminus.onshutdown.js']);
+      execFileSync('node', ['lib/standalone-tests/terminus.onshutdown.sigterm.js']);
     } catch (ex) {
       expect(ex.stdout.toString().trim()).to.eql('on-sigterm-runs\non-shutdown-runs');
       return;
     }
 
     throw new Error('running the test should throw, as the exitcode is not 0');
   });
+
+  it('runs onSigint when getting SIGINT signal', () => {
+    try {
+      execFileSync('node', ['lib/standalone-tests/terminus.onsigint.js']);
+    } catch (ex) {
+      expect(ex.stdout.toString().trim()).to.eql('on-sigint-runs');
+      return;
+    }
+
+    throw new Error('running the test should throw, as the exitcode is not 0');
+  });
+
+  it('runs onShutdown after onSigint', () => {
+    try {
+      execFileSync('node', ['lib/standalone-tests/terminus.onshutdown.sigint.js']);
+    } catch (ex) {
+      expect(ex.stdout.toString().trim()).to.eql('on-sigint-runs\non-shutdown-runs');
+      return;
+    }
+
+    throw new Error('running the test should throw, as the exitcode is not 0');
+  });
 });

typings/index.d.ts

@@ -9,9 +9,13 @@ declare module "@godaddy/terminus" {
   interface TerminusOptions {
     healthChecks?: HealthCheckMap;
     timeout?: number;
-    onSigterm?: () => Promise<any>;
+    signal?: string;
+    onSignal?: () => Promise<any>;
     onShutdown?: () => Promise<any>;
     logger?: (msg: string, err: Error) => void;
+
+    /** Deprecated. */
+    onSigterm?: () => Promise<any>;
   }
 
   type Terminus = <T>(server: T, options?: TerminusOptions) => T;

typings/index.test.ts

@@ -1,7 +1,7 @@
 import * as http from "http";
 import * as terminus from "@godaddy/terminus";
 
-async function onSigterm () {
+async function onSignal () {
   console.log('server is starting cleanup');
   return Promise.all([
     // your clean logic, like closing database connections
@@ -22,7 +22,7 @@ terminus(server, {
     "/healthcheck": () => Promise.resolve()
   },
   timeout: 1000,
-  onSigterm,
+  onSignal,
   onShutdown,
   logger: console.log
 });