microship 0.1.1 → 1.0.1

package/README.md

@@ -4,8 +4,6 @@ Readiness, liveness, and graceful shutdown for a Node process on Kubernetes.
 
 `/ready` and `/live` run on a [worker thread](https://nodejs.org/api/worker_threads.html). A busy event loop stays ready. `/live` returns 500 after the loop has not run for 15 seconds. Shutdown marks the process not ready, waits `shutdownDelay` so the kubelet observes it, runs the shutdown handler, then exits.
 
-Outside Kubernetes the probe binds a random port, so a local process does not take 3001.
-
 ```js
 const { createMicroship } = require('microship')
 
@@ -23,4 +21,4 @@ ship.registerShutdownHandler(async () => {
 ship.signalReady()
 ```
 
-`shutdownHandlerTimeout` forces `terminate` when the handler does not finish. Signals are `SIGTERM`, `SIGHUP`, and `SIGINT`.
+`shutdownHandlerTimeout` forces `terminate` when the handler does not finish. Signals are `SIGTERM` and `SIGINT`.

package/package.json

@@ -2,7 +2,7 @@
   "name": "microship",
   "description": "Readiness, liveness, and graceful shutdown for a Node process on Kubernetes.",
   "homepage": "https://github.com/Kikobeats/microship",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "main": "src/index.js",
   "author": {
     "email": "josefrancisco.verdu@gmail.com",

package/src/index.js

@@ -3,28 +3,17 @@
 const { Worker } = require('worker_threads')
 const path = require('path')
 
-const { STALE_MS } = require('./status')
-
-const SIGNALS = ['SIGTERM', 'SIGHUP', 'SIGINT']
+const SIGNALS = ['SIGTERM', 'SIGINT']
 const EXIT_DELAY = 1000
 
 const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
 
-const inKubernetes = () => Boolean(process.env.KUBERNETES_SERVICE_HOST)
-
 const createMicroship = async ({
-  detectKubernetes = true,
   port = 3001,
-  shutdownDelay,
+  shutdownDelay = 1000,
   shutdownHandlerTimeout = 5000,
-  signals = SIGNALS,
-  staleMs = STALE_MS,
   terminate = () => process.exit(0)
 } = {}) => {
-  const local = detectKubernetes && !inKubernetes()
-  const probePort = local ? 0 : port
-  const delay = shutdownDelay === undefined ? (local ? 0 : 5000) : shutdownDelay
-
   let ready = false
   let shuttingDown = false
   const handlers = []
@@ -36,7 +25,7 @@ const createMicroship = async ({
   }
 
   const worker = new Worker(path.join(__dirname, 'worker.js'), {
-    workerData: { port: probePort, sab: view.buffer, staleMs }
+    workerData: { port, sab: view.buffer }
   })
   worker.unref()
 
@@ -60,17 +49,12 @@ const createMicroship = async ({
     publish()
   }
 
-  const signalNotReady = () => {
-    ready = false
-    publish()
-  }
-
   const shutdown = async () => {
     if (shuttingDown) return
     ready = false
     shuttingDown = true
     publish()
-    if (delay) await sleep(delay)
+    if (shutdownDelay) await sleep(shutdownDelay)
 
     let forced = false
     const timer = setTimeout(() => {
@@ -90,24 +74,21 @@ const createMicroship = async ({
   const onSignal = () => {
     shutdown().catch(() => {})
   }
-  for (const signal of signals) process.on(signal, onSignal)
+  for (const signal of SIGNALS) process.on(signal, onSignal)
 
   return {
     port: bound,
-    isServerReady: () => ready && !shuttingDown,
-    isServerShuttingDown: () => shuttingDown,
     registerShutdownHandler: handler => {
       handlers.push(handler)
     },
     shutdown,
-    signalNotReady,
     signalReady,
     stop: async () => {
       clearInterval(beat)
-      for (const signal of signals) process.off(signal, onSignal)
+      for (const signal of SIGNALS) process.off(signal, onSignal)
       await worker.terminate()
     }
   }
 }
 
-module.exports = { createMicroship, STALE_MS }
+module.exports = { createMicroship }

package/src/status.js

@@ -13,10 +13,10 @@ const beatAge = (view, state, now) => {
   return now - state.lastBeatAt
 }
 
-const statusFor = (view, state, url, now, staleMs = STALE_MS) => {
+const statusFor = (view, state, url, now) => {
   const shuttingDown = Atomics.load(view, 1) === 1
   const ready = Atomics.load(view, 0) === 1 && !shuttingDown
-  const live = !shuttingDown && beatAge(view, state, now) < staleMs
+  const live = !shuttingDown && beatAge(view, state, now) < STALE_MS
   if (url === '/live') return live ? 200 : 500
   if (url === '/ready') return ready ? 200 : 500
   return 404

package/src/worker.js

@@ -10,7 +10,7 @@ const state = createState()
 
 const server = http.createServer((req, res) => {
   const url = (req.url || '/').split('?')[0]
-  const code = statusFor(view, state, url, Date.now(), workerData.staleMs)
+  const code = statusFor(view, state, url, Date.now())
   res.writeHead(code, { 'content-type': 'text/plain' })
   res.end()
 })