feat(cli): allow configuration of http-server's timeout configuration (…

…#35827)

* feat: add keep-alive timeout params for next-start

* feat: add keep-alive timeout args to next-cli's start

* docs: add docs for keep-alive timeouts

* docs: fix grammar & typos

* refactor: handle NaN for args

* test: add tests for timeout args

* revert: remove headersTimeout option

* fix: remove input validation for keepAliveTimeout arg

* feat: add input-range validation for keepAliveTimeout arg

* Error and tests for range validation

* Make sure timeout actually changes

* Fix error messsage

* Apply suggestions from code review

Co-authored-by: Steven <steven@ceriously.com>

Co-authored-by: Hannes Bornö <hannes.borno@vercel.com>
Co-authored-by: Balázs Orbán <info@balazsorban.com>
Co-authored-by: Steven <steven@ceriously.com>

docs/api-reference/cli.md

@@ -108,6 +108,16 @@ PORT=4000 npx next start
 
 > Note: `PORT` can not be set in `.env` as booting up the HTTP server happens before any other code is initialized.
 
+### Keep Alive Timeout
+
+When deploying Next.js behind a downstream proxy (e.g. a load-balancer like AWS ELB/ALB) it's important to configure Next's underlying HTTP server with [keep-alive timeouts](https://nodejs.org/api/http.html#http_server_keepalivetimeout) that are _larger_ than the downstream proxy's timeouts. Otherwise, once a keep-alive timeout is reached for a given TCP connection, Node.js will immediately terminate that connection without notifying the downstream proxy. This results in a proxy error whenever it attempts to reuse a connection that Node.js has already terminated.
+
+To configure the timeout values for the production Next.js server, pass `--keepAliveTimeout` (in milliseconds) to `next start`, like so:
+
+```bash
+npx next start --keepAliveTimeout 70000
+```
+
 ## Lint
 
 `next lint` runs ESLint for all files in the `pages`, `components`, and `lib` directories. It also

packages/next/cli/next-start.ts

@@ -14,6 +14,7 @@ const nextStart: cliCommand = (argv) => {
     '--help': Boolean,
     '--port': Number,
     '--hostname': String,
+    '--keepAliveTimeout': Number,
 
     // Aliases
     '-h': '--help',
@@ -44,6 +45,7 @@ const nextStart: cliCommand = (argv) => {
       Options
         --port, -p      A port number on which to start the application
         --hostname, -H  Hostname on which to start the application (default: 0.0.0.0)
+        --keepAliveTimeout  Max milliseconds to wait before closing inactive connections
         --help, -h      Displays this message
     `)
     process.exit(0)
@@ -58,10 +60,28 @@ const nextStart: cliCommand = (argv) => {
     port = parseInt(process.env.__NEXT_FORCED_PORT, 10) || 0
   }
 
+  const keepAliveTimeoutArg: number | undefined = args['--keepAliveTimeout']
+  if (
+    typeof keepAliveTimeoutArg !== 'undefined' &&
+    (Number.isNaN(keepAliveTimeoutArg) ||
+      !Number.isFinite(keepAliveTimeoutArg) ||
+      keepAliveTimeoutArg < 0)
+  ) {
+    printAndExit(
+      `Invalid --keepAliveTimeout, expected a non negative number but received "${keepAliveTimeoutArg}"`,
+      1
+    )
+  }
+
+  const keepAliveTimeout = keepAliveTimeoutArg
+    ? Math.ceil(keepAliveTimeoutArg)
+    : undefined
+
   startServer({
     dir,
     hostname: host,
     port,
+    keepAliveTimeout,
   })
     .then(async (app) => {
       const appUrl = `http://${app.hostname}:${app.port}`

packages/next/server/lib/start-server.ts

@@ -5,6 +5,7 @@ import next from '../next'
 
 interface StartServerOptions extends NextServerOptions {
   allowRetry?: boolean
+  keepAliveTimeout?: number
 }
 
 export function startServer(opts: StartServerOptions) {
@@ -14,6 +15,10 @@ export function startServer(opts: StartServerOptions) {
     return requestHandler(req, res)
   })
 
+  if (opts.keepAliveTimeout) {
+    server.keepAliveTimeout = opts.keepAliveTimeout
+  }
+
   return new Promise<NextServer>((resolve, reject) => {
     let port = opts.port
     let retryCount = 0

test/integration/cli/test/index.test.js

@@ -394,6 +394,54 @@ describe('CLI Usage', () => {
         'Invalid project directory provided, no such directory'
       )
     })
+
+    test('--keepAliveTimeout string arg', async () => {
+      const { stderr } = await runNextCommand(
+        ['start', '--keepAliveTimeout', 'string'],
+        {
+          stderr: true,
+        }
+      )
+      expect(stderr).toContain(
+        'Invalid --keepAliveTimeout, expected a non negative number but received "NaN"'
+      )
+    })
+
+    test('--keepAliveTimeout negative number', async () => {
+      const { stderr } = await runNextCommand(
+        ['start', '--keepAliveTimeout=-100'],
+        {
+          stderr: true,
+        }
+      )
+      expect(stderr).toContain(
+        'Invalid --keepAliveTimeout, expected a non negative number but received "-100"'
+      )
+    })
+
+    test('--keepAliveTimeout Infinity', async () => {
+      const { stderr } = await runNextCommand(
+        ['start', '--keepAliveTimeout', 'Infinity'],
+        {
+          stderr: true,
+        }
+      )
+      expect(stderr).toContain(
+        'Invalid --keepAliveTimeout, expected a non negative number but received "Infinity"'
+      )
+    })
+
+    test('--keepAliveTimeout happy path', async () => {
+      const { stderr } = await runNextCommand(
+        ['start', '--keepAliveTimeout', '100'],
+        {
+          stderr: true,
+        }
+      )
+      expect(stderr).not.toContain(
+        'Invalid keep alive timeout provided, expected a non negative number'
+      )
+    })
   })
 
   describe('export', () => {

test/unit/cli.test.ts

@@ -0,0 +1,34 @@
+import { nextStart } from 'next/dist/cli/next-start'
+import httpMock, { Server } from 'http'
+
+// Prevents bin from running
+jest.mock('next/dist/bin/next', () => ({}))
+jest.mock('next/dist/lib/get-project-dir', () => ({ getProjectDir: () => '' }))
+
+jest.mock('http')
+
+describe('start', () => {
+  test('--keepAliveTimeout changes server.keepAliveTimeout when passed', () => {
+    const server = {
+      on: () => {},
+      listen: () => {},
+    } as any as Server
+    ;(httpMock as any).createServer.mockReturnValue(server)
+
+    expect(server.keepAliveTimeout).toBe(undefined)
+    nextStart(['--keepAliveTimeout', '1234'])
+    expect(server.keepAliveTimeout).toBe(1234)
+  })
+
+  test("--keepAliveTimeout doesn't change server.keepAliveTimeout when not passed", () => {
+    const server = {
+      on: () => {},
+      listen: () => {},
+    } as any as Server
+    ;(httpMock as any).createServer.mockReturnValue(server)
+
+    expect(server.keepAliveTimeout).toBe(undefined)
+    nextStart([])
+    expect(server.keepAliveTimeout).toBe(undefined)
+  })
+})