feat(node, deno, bun): graceful shutdown (#136)

Author: pi0

src/_plugins.ts

@@ -1,3 +1,4 @@
+import { Colors } from "./_utils.cli.ts";
 import type { ServerPlugin } from "./types.ts";
 
 export const errorPlugin: ServerPlugin = (server) => {
@@ -14,3 +15,61 @@ export const errorPlugin: ServerPlugin = (server) => {
     }
   });
 };
+
+export const gracefulShutdownPlugin: ServerPlugin = (server) => {
+  const config = server.options?.gracefulShutdown;
+  if (
+    !globalThis.process?.on ||
+    config === false ||
+    (config === undefined && (process.env.CI || process.env.TEST))
+  ) {
+    return;
+  }
+  const gracefulShutdown =
+    config === true || !config?.gracefulTimeout ? 3 : config.gracefulTimeout;
+  const forceShutdown =
+    config === true || !config?.forceTimeout ? 3 : config.forceTimeout;
+  let isShuttingDown = false;
+  const shutdown = async () => {
+    if (isShuttingDown) return;
+    isShuttingDown = true;
+    console.log(
+      Colors.gray(
+        `\nShutting down server... (timeout in ${gracefulShutdown}+${forceShutdown}s)`,
+      ),
+    );
+    let timeout: any;
+    await Promise.race([
+      // Graceful shutdown
+      server.close().finally(() => {
+        clearTimeout(timeout);
+        console.log(Colors.green("Server closed all connections."));
+      }),
+      new Promise<void>((resolve) => {
+        timeout = setTimeout(() => {
+          // Graceful shutdown timeout
+          console.warn(
+            Colors.yellow(
+              `Forcing closing connections to exit... (timeout in ${forceShutdown}s)`,
+            ),
+          );
+          timeout = setTimeout(() => {
+            // Force shutdown timeout
+            console.error(
+              Colors.red("Could not close connections in time, force exiting."),
+            );
+            resolve();
+          }, 1000);
+          return server.close(true).finally(() => {
+            clearTimeout(timeout);
+            resolve();
+          });
+        }, 1000);
+      }),
+    ]);
+    globalThis.process.exit(0);
+  };
+  for (const sig of ["SIGINT", "SIGTERM"] as const) {
+    globalThis.process.on(sig, shutdown);
+  }
+};

src/adapters/bun.ts

@@ -8,6 +8,7 @@ import {
   createWaitUntil,
 } from "../_utils.ts";
 import { wrapFetch } from "../_middleware.ts";
+import { gracefulShutdownPlugin } from "../_plugins.ts";
 
 export { FastURL } from "../_url.ts";
 export const FastResponse: typeof globalThis.Response = Response;
@@ -32,6 +33,8 @@ class BunServer implements Server<BunFetchHandler> {
 
     for (const plugin of options.plugins || []) plugin(this);
 
+    gracefulShutdownPlugin(this);
+
     const fetchHandler = wrapFetch(this);
 
     this.#wait = createWaitUntil();

src/adapters/deno.ts

@@ -7,6 +7,7 @@ import {
   resolveTLSOptions,
 } from "../_utils.ts";
 import { wrapFetch } from "../_middleware.ts";
+import { gracefulShutdownPlugin } from "../_plugins.ts";
 
 export { FastURL } from "../_url.ts";
 export const FastResponse: typeof globalThis.Response = Response;
@@ -36,6 +37,8 @@ class DenoServer implements Server<DenoFetchHandler> {
 
     for (const plugin of options.plugins || []) plugin(this);
 
+    gracefulShutdownPlugin(this);
+
     const fetchHandler = wrapFetch(this);
 
     this.#wait = createWaitUntil();

src/adapters/node.ts

@@ -8,7 +8,7 @@ import {
   createWaitUntil,
 } from "../_utils.ts";
 import { wrapFetch } from "../_middleware.ts";
-import { errorPlugin } from "../_plugins.ts";
+import { errorPlugin, gracefulShutdownPlugin } from "../_plugins.ts";
 
 import nodeHTTP from "node:http";
 import nodeHTTPS from "node:https";
@@ -58,6 +58,8 @@ class NodeServer implements Server {
     for (const plugin of options.plugins || []) plugin(this);
     errorPlugin(this);
 
+    gracefulShutdownPlugin(this);
+
     const fetchHandler = (this.fetch = wrapFetch(this));
 
     this.#wait = createWaitUntil();

src/types.ts

@@ -114,6 +114,17 @@ export interface ServerOptions {
    */
   silent?: boolean;
 
+  /**
+   * Graceful shutdown on SIGINT and SIGTERM signals.
+   *
+   * Supported for Node.js, Deno and Bun runtimes.
+   *
+   * @default true (disabled in test and ci environments)
+   */
+  gracefulShutdown?:
+    | boolean
+    | { gracefulTimeout?: number; forceTimeout?: number };
+
   /**
    * TLS server options.
    */