@znight/http 0.2.2 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@znight/http",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Znight HTTP plugin: controllers, routing, guards, interceptors, validation with Fastify, Express or Hono",
   "license": "MIT",
   "author": "Ugho STEPHAN",
@@ -79,7 +79,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@znight/core": "0.2.2"
+    "@znight/core": "0.3.0"
   },
   "peerDependencies": {
     "@hono/node-server": "^2.1.5",
@@ -87,7 +87,7 @@
     "fastify": "^5.12.7",
     "hono": "^4.13.14",
     "light-my-request": "^6.8.0",
-    "@znight/compiler": "^0.2.2"
+    "@znight/compiler": "^0.3.0"
   },
   "peerDependenciesMeta": {
     "@hono/node-server": {
@@ -118,7 +118,7 @@
     "valibot": "1.5.0",
     "zod": "4.6.7",
     "light-my-request": "6.8.0",
-    "@znight/compiler": "0.2.2"
+    "@znight/compiler": "0.3.0"
   },
   "znight": {
     "apiVersion": 1,

package/src/plugin-routes.ts

@@ -3,7 +3,7 @@
  * health or metrics endpoints), registered on every adapter in the same pipeline as the compiled
  * controllers.
  */
-import type { Container, Plugin } from '@znight/core'
+import type { Container, CoreLogger, Plugin } from '@znight/core'
 import type { HttpContext } from './context.ts'
 import type { RouteMetaEntry } from './decorators.ts'
 import type { HttpMethod } from './metadata.ts'
@@ -71,6 +71,14 @@ export interface PluginHttpRoutesContext {
  */
 export interface PluginHttpRoutes {
   httpRoutes(context: PluginHttpRoutesContext): readonly PluginRoute[]
+  /**
+   * Called once when `HttpPlugin` starts draining (its `onStop`, whatever the plugin order), after
+   * it stopped accepting connections and started closing its event streams: end the long-lived
+   * responses `HttpPlugin` does not know of (a stream another server produced), so that the drain
+   * does not wait for them until `drainTimeoutMs`. Requests still in flight are served. The drain
+   * waits for a returned promise too (within `drainTimeoutMs`); a failure is logged.
+   */
+  onHttpDrain?(): void | Promise<void>
 }
 
 /** A validated plugin route (internal). */
@@ -122,6 +130,31 @@ export function collectPluginRoutes(
   return collected
 }
 
+/**
+ * Calls `onHttpDrain()` on every other plugin implementing it, in plugin order: the promises the
+ * drain waits for (they never reject: a failure is logged).
+ */
+export function drainPlugins(plugins: readonly Plugin[], self: Plugin, logger: CoreLogger): Promise<void>[] {
+  const pending: Promise<void>[] = []
+  for (const plugin of plugins) {
+    if (plugin === self) continue
+    const drain = (plugin as Plugin & Partial<PluginHttpRoutes>).onHttpDrain
+    if (typeof drain !== 'function') continue
+    const failed = (error: unknown): void => {
+      logger.error(`HttpPlugin: onHttpDrain() of the plugin "${String(plugin.name)}" failed`, { err: error })
+    }
+    try {
+      const result: unknown = drain.call(plugin)
+      if (typeof (result as PromiseLike<void> | undefined)?.then === 'function') {
+        pending.push(Promise.resolve(result as PromiseLike<void>).then(undefined, failed))
+      }
+    } catch (error) {
+      failed(error)
+    }
+  }
+  return pending
+}
+
 function validateRoute(instance: object, plugin: string, value: unknown, prefix: string): CollectedPluginRoute {
   if (value === null || typeof value !== 'object') throw invalid(plugin, `invalid route ${describe(value)}`)
   const route = value as Partial<PluginRoute>

package/src/plugin.ts

@@ -56,7 +56,7 @@ import {
   randomRequestId,
   type SseSettings,
 } from './pipeline.ts'
-import { collectPluginRoutes } from './plugin-routes.ts'
+import { collectPluginRoutes, drainPlugins } from './plugin-routes.ts'
 import { resolveTrustProxy } from './proxy.ts'
 import { RouteTable } from './router.ts'
 import { resolveSecurityHeaders } from './security-headers.ts'
@@ -552,6 +552,8 @@ export class HttpPlugin implements Plugin {
     runtime.pipeline.draining = true
     // event streams never end by themselves: let their sources finish, then send them a jittered retry
     runtime.pipeline.closeStreams('shutdown')
+    // the streams other plugins serve on their routes (a GraphQL driver's subscriptions)
+    const drains = drainPlugins(ctx.app.plugins, this, ctx.logger)
     const timeoutMs = runtime.options.drainTimeoutMs
     let timer: ReturnType<typeof setTimeout> | undefined
     // no timer for Infinity; larger delays than setTimeout supports are clamped (they would fire at once)
@@ -561,7 +563,9 @@ export class HttpPlugin implements Plugin {
       }
     })
     try {
-      const drained = Promise.all([runtime.adapter.close(), runtime.pipeline.whenIdle()]).then(() => 'drained' as const)
+      const drained = Promise.all([runtime.adapter.close(), runtime.pipeline.whenIdle(), ...drains]).then(
+        () => 'drained' as const,
+      )
       if ((await Promise.race([drained, timeout])) === 'timeout') {
         ctx.logger.warn(`HTTP server: closing ${runtime.pipeline.inflight} in-flight request(s) after ${timeoutMs} ms`)
         await runtime.adapter.close({ force: true })