@nxtedition/lib 23.5.14 → 23.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/lib",
-  "version": "23.5.14",
+  "version": "23.6.0",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "type": "module",
@@ -43,7 +43,8 @@
     "timeline.js",
     "transcript.js",
     "docker-secrets.js",
-    "wordwrap.js"
+    "wordwrap.js",
+    "under-pressure.js"
   ],
   "scripts": {
     "prepublishOnly": "pinst --disable",

package/under-pressure.js

@@ -0,0 +1,105 @@
+// Based on: https://github.com/fastify/under-pressure/blob/main/index.js
+import { monitorEventLoopDelay } from 'node:perf_hooks'
+
+function getSampleInterval(value, eventLoopResolution) {
+  const sampleInterval = value || 1000
+
+  return Math.max(eventLoopResolution, sampleInterval)
+}
+
+export default function (opts = {}) {
+  const resolution = 10
+  const sampleInterval = getSampleInterval(opts.sampleInterval, resolution)
+  const maxEventLoopDelay = opts.maxEventLoopDelay || 0
+  const maxHeapUsedBytes = opts.maxHeapUsedBytes || 0
+  const maxRssBytes = opts.maxRssBytes || 0
+  const healthCheck = opts.healthCheck || false
+  const maxEventLoopUtilization = opts.maxEventLoopUtilization || 0
+
+  const checkMaxEventLoopDelay = maxEventLoopDelay > 0
+  const checkMaxHeapUsedBytes = maxHeapUsedBytes > 0
+  const checkMaxRssBytes = maxRssBytes > 0
+  const checkMaxEventLoopUtilization = maxEventLoopUtilization > 0
+
+  let heapUsed = 0
+  let rssBytes = 0
+  let eventLoopDelay = 0
+  let elu
+  let eventLoopUtilized = 0
+
+  const histogram = monitorEventLoopDelay({ resolution })
+  histogram.enable()
+
+  if (performance.eventLoopUtilization) {
+    elu = performance.eventLoopUtilization()
+  }
+
+  const timer = setTimeout(beginMemoryUsageUpdate, sampleInterval)
+  timer.unref()
+
+  if (
+    checkMaxEventLoopUtilization === false &&
+    checkMaxEventLoopDelay === false &&
+    checkMaxHeapUsedBytes === false &&
+    checkMaxRssBytes === false &&
+    healthCheck === false
+  ) {
+    return
+  }
+
+  function updateEventLoopDelay() {
+    eventLoopDelay = Math.max(0, histogram.mean / 1e6 - resolution)
+    if (Number.isNaN(eventLoopDelay)) eventLoopDelay = Infinity
+    histogram.reset()
+  }
+
+  function updateEventLoopUtilization() {
+    if (elu) {
+      eventLoopUtilized = performance.eventLoopUtilization(elu).utilization
+    } else {
+      eventLoopUtilized = 0
+    }
+  }
+
+  function beginMemoryUsageUpdate() {
+    updateMemoryUsage()
+    timer.refresh()
+  }
+
+  function updateMemoryUsage() {
+    const mem = process.memoryUsage()
+    heapUsed = mem.heapUsed
+    rssBytes = mem.rss
+    updateEventLoopDelay()
+    updateEventLoopUtilization()
+  }
+
+  return {
+    isUnderPressure() {
+      if (checkMaxEventLoopDelay && eventLoopDelay > maxEventLoopDelay) {
+        return true
+      }
+
+      if (checkMaxHeapUsedBytes && heapUsed > maxHeapUsedBytes) {
+        return true
+      }
+
+      if (checkMaxRssBytes && rssBytes > maxRssBytes) {
+        return true
+      }
+
+      return checkMaxEventLoopUtilization && eventLoopUtilized > maxEventLoopUtilization
+    },
+    memoryUsage() {
+      return {
+        eventLoopDelay,
+        rssBytes,
+        heapUsed,
+        eventLoopUtilized,
+      }
+    },
+    [Symbol.dispose]() {
+      clearTimeout(timer)
+    },
+  }
+}