feat: allow configuring Node.js HTTP server

Author: enixsoft

src/server/main.ts

@@ -37,6 +37,8 @@ import { finalHandler } from './factories/final_handler.js'
 import { writeResponse } from './factories/write_response.js'
 import { asyncLocalStorage } from '../http_context/local_storage.js'
 import { middlewareHandler } from './factories/middleware_handler.js'
+import lodash from '@poppinss/utils/lodash'
+import { NodeConfig } from '../types/node.js'
 
 /**
  * The HTTP server implementation to handle incoming requests and respond using the
@@ -294,6 +296,18 @@ export class Server {
    * Set the HTTP server instance used to listen for requests.
    */
   setNodeServer(server: HttpServer | HttpsServer) {
+    const nodeServerOptions: (keyof NodeConfig)[] = [
+      'keepAliveTimeout',
+      'headersTimeout',
+      'requestTimeout',
+      'timeout',
+    ]
+
+    Object.assign<HttpServer | HttpsServer, Partial<NodeConfig>>(
+      server,
+      lodash.pick<NodeConfig>(this.#config, nodeServerOptions)
+    )
+
     this.#nodeHttpServer = server
   }
 

src/types/node.ts

@@ -0,0 +1,26 @@
+export type NodeConfig = {
+  /**
+   * The number of milliseconds of inactivity a server needs to wait for additional incoming data, after
+   * it has finished writing the last response, before a socket will be destroyed
+   * @default 5000
+   */
+  keepAliveTimeout?: number
+
+  /**
+   * Limit the amount of time the parser will wait to receive the complete HTTP headers
+   * @default 60000
+   */
+  headersTimeout?: number
+
+  /**
+   * Sets the timeout value in milliseconds for receiving the entire request from the client
+   * @default 300000
+   */
+  requestTimeout?: number
+
+  /**
+   * The number of milliseconds of inactivity before a socket is presumed to have timed out
+   * @default 0
+   */
+  timeout?: number
+}

src/types/server.ts

@@ -14,6 +14,7 @@ import type { QSParserConfig } from './qs.js'
 import type { RequestConfig } from './request.js'
 import type { ResponseConfig } from './response.js'
 import type { HttpContext } from '../http_context/main.js'
+import type { NodeConfig } from './node.js'
 
 /**
  * Normalized HTTP error used by the exception
@@ -83,7 +84,8 @@ export type ErrorHandlerAsAClass = Constructor<ServerErrorHandler>
  * Config accepted by the HTTP server
  */
 export type ServerConfig = RequestConfig &
-  ResponseConfig & {
+  ResponseConfig &
+  NodeConfig & {
     /**
      * Whether or not to create an async local storage store for
      * the HTTP context.

tests/server.spec.ts

@@ -64,6 +64,25 @@ test.group('Server', () => {
 
     await supertest(httpServer).get('/').expect(200)
   }).waitForDone()
+
+  test('pass config to node http server', ({ assert }) => {
+    const keepAliveTimeout = 61000
+    const app = new AppFactory().create(BASE_URL, () => {})
+    const server = new ServerFactory()
+      .merge({
+        app,
+        config: {
+          keepAliveTimeout,
+        },
+      })
+      .create()
+    server.use([])
+
+    const httpServer = createServer(() => {})
+    server.setNodeServer(httpServer)
+
+    assert.strictEqual(httpServer.keepAliveTimeout, keepAliveTimeout)
+  })
 })
 
 test.group('Server | Response handling', () => {