Merge branch 'master' into make-v24

RobinTail · web-flow · commit 1ccffa046bfb · 2025-05-23T09:31:45.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -66,6 +66,12 @@ export default [
 
 ## Version 23
 
+### v23.6.0
+
+- Featuring `gracefulShutdown.beforeExit()` hook:
+  - The function to execute after the server was closed, but before terminating the process (can be asynchronous);
+  - The feature suggested by [@HeikoOsigus](https://github.com/HeikoOsigus).
+
 ### v23.5.0
 
 - Integer number `format` in generated Documentation now also depends on the `numericRange` option:
diff --git a/README.md b/README.md
@@ -84,6 +84,7 @@ Therefore, many basic tasks can be accomplished faster and easier, in particular
 
 These people contributed to the improvement of the framework by reporting bugs, making changes and suggesting ideas:
 
+[<img src="https://github.com/HeikoOsigus.png" alt="@HeikoOsigus" width="50px" />](https://github.com/HeikoOsigus)
 [<img src="https://github.com/crgeary.png" alt="@crgeary" width="50px" />](https://github.com/crgeary)
 [<img src="https://github.com/williamgcampbell.png" alt="@williamgcampbell" width="50px" />](https://github.com/williamgcampbell)
 [<img src="https://github.com/gmorgen1.png" alt="@gmorgen1" width="50px" />](https://github.com/gmorgen1)
@@ -1167,6 +1168,7 @@ createConfig({
   gracefulShutdown: {
     timeout: 1000,
     events: ["SIGINT", "SIGTERM"],
+    beforeExit: /* async */ () => {},
   },
 });
 ```
diff --git a/express-zod-api/src/config-type.ts b/express-zod-api/src/config-type.ts
@@ -121,7 +121,7 @@ type CompressionOptions = Pick<
 
 interface GracefulOptions {
   /**
-   * @desc Time given to drain ongoing requests before exit.
+   * @desc Time given to drain ongoing requests before closing the server.
    * @default 1000
    * */
   timeout?: number;
@@ -131,6 +131,8 @@ interface GracefulOptions {
    * @default [SIGINT, SIGTERM]
    * */
   events?: string[];
+  /** @desc The hook to call after the server was closed, but before terminating the process. */
+  beforeExit?: () => void | Promise<void>;
 }
 
 type BeforeRouting = (params: {
diff --git a/express-zod-api/src/server-helpers.ts b/express-zod-api/src/server-helpers.ts
@@ -153,13 +153,17 @@ export const installDeprecationListener = (logger: ActualLogger) =>
 export const installTerminationListener = ({
   servers,
   logger,
-  options: { timeout, events = ["SIGINT", "SIGTERM"] },
+  options: { timeout, beforeExit, events = ["SIGINT", "SIGTERM"] },
 }: {
   servers: Parameters<typeof monitor>[0];
   options: Extract<ServerConfig["gracefulShutdown"], object>;
   logger: ActualLogger;
 }) => {
   const graceful = monitor(servers, { logger, timeout });
-  const onTerm = () => graceful.shutdown().then(() => process.exit());
+  const onTerm = async () => {
+    await graceful.shutdown();
+    await beforeExit?.();
+    process.exit();
+  };
   for (const trigger of events) process.on(trigger, onTerm);
 };
diff --git a/express-zod-api/tests/system.spec.ts b/express-zod-api/tests/system.spec.ts
@@ -135,6 +135,7 @@ describe("App in production mode", async () => {
     "post /v1/upload": uploadEndpoint,
   };
   vi.spyOn(process.stdout, "write").mockImplementation(vi.fn()); // mutes logo output
+  const beforeExit = vi.fn();
   const config = createConfig({
     http: { listen: port },
     compression: { threshold: 1 },
@@ -165,7 +166,7 @@ describe("App in production mode", async () => {
     },
     cors: false,
     startupLogo: true,
-    gracefulShutdown: { events: ["FAKE"] },
+    gracefulShutdown: { events: ["FAKE"], beforeExit },
     logger,
     childLoggerProvider: ({ parent }) =>
       Object.defineProperty(parent, "isChild", { value: true }),
@@ -592,7 +593,7 @@ describe("App in production mode", async () => {
 
   describe("Shutdown", () => {
     test("should terminate suspended request gracefully on signal", async () => {
-      const spy = vi
+      const exitSpy = vi
         .spyOn(process, "exit")
         .mockImplementation(vi.fn<typeof process.exit>());
       fetch(`http://127.0.0.1:${port}/v1/long`).catch((err) =>
@@ -606,7 +607,8 @@ describe("App in production mode", async () => {
       });
       await setTimeout(1500);
       expect(server.listening).toBeFalsy();
-      expect(spy).toHaveBeenCalled();
+      expect(beforeExit).toHaveBeenCalledOnce();
+      expect(exitSpy).toHaveBeenCalled();
     });
   });
 });
