From 77e5b509a90b3e72865fc0787a6c7673683d0313 Mon Sep 17 00:00:00 2001
From: Andrey Pechkurov <apechkurov@gmail.com>
Date: Sat, 8 Feb 2020 14:11:42 +0300
Subject: [PATCH] doc,test: add server.timeout property to http2 public API

Both http and https modules have server.timeout property
in public API. This commit adds documentation section and test
for server.timeout in http2 module, so it becomes consistent
with http and https.

Also improves description of callback argument in documentation
for server.setTimeout().

PR-URL: https://github.com/nodejs/node/pull/31693
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
---
 doc/api/http2.md                           | 42 ++++++++++++++++++++--
 test/parallel/test-http2-server-timeout.js | 34 ++++++++++--------
 2 files changed, 60 insertions(+), 16 deletions(-)

diff --git a/doc/api/http2.md b/doc/api/http2.md
index 69252121f71daf..0e7d47e14fdcec 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -1797,9 +1797,28 @@ on the `Http2Server` after `msecs` milliseconds.
 
 The given callback is registered as a listener on the `'timeout'` event.
 
-In case of no callback function were assigned, a new `ERR_INVALID_CALLBACK`
+In case if `callback` is not a function, a new `ERR_INVALID_CALLBACK`
 error will be thrown.
 
+#### `server.timeout`
+<!-- YAML
+added: v8.4.0
+changes:
+  - version: v13.0.0
+    pr-url: https://github.com/nodejs/node/pull/27558
+    description: The default timeout changed from 120s to 0 (no timeout).
+-->
+
+* {number} Timeout in milliseconds. **Default:** 0 (no timeout)
+
+The number of milliseconds of inactivity before a socket is presumed
+to have timed out.
+
+A value of `0` will disable the timeout behavior on incoming connections.
+
+The socket timeout logic is set up on connection, so changing this
+value only affects new connections to the server, not any existing connections.
+
 ### Class: `Http2SecureServer`
 <!-- YAML
 added: v8.4.0
@@ -1943,9 +1962,28 @@ on the `Http2SecureServer` after `msecs` milliseconds.
 
 The given callback is registered as a listener on the `'timeout'` event.
 
-In case of no callback function were assigned, a new `ERR_INVALID_CALLBACK`
+In case if `callback` is not a function, a new `ERR_INVALID_CALLBACK`
 error will be thrown.
 
+#### `server.timeout`
+<!-- YAML
+added: v8.4.0
+changes:
+  - version: v13.0.0
+    pr-url: https://github.com/nodejs/node/pull/27558
+    description: The default timeout changed from 120s to 0 (no timeout).
+-->
+
+* {number} Timeout in milliseconds. **Default:** 0 (no timeout)
+
+The number of milliseconds of inactivity before a socket is presumed
+to have timed out.
+
+A value of `0` will disable the timeout behavior on incoming connections.
+
+The socket timeout logic is set up on connection, so changing this
+value only affects new connections to the server, not any existing connections.
+
 ### `http2.createServer(options[, onRequestHandler])`
 <!-- YAML
 added: v8.4.0
diff --git a/test/parallel/test-http2-server-timeout.js b/test/parallel/test-http2-server-timeout.js
index 88fc4eab2e08c0..b1515e718ae519 100755
--- a/test/parallel/test-http2-server-timeout.js
+++ b/test/parallel/test-http2-server-timeout.js
@@ -5,21 +5,27 @@ if (!common.hasCrypto)
   common.skip('missing crypto');
 const http2 = require('http2');
 
-const server = http2.createServer();
-server.setTimeout(common.platformTimeout(50));
+function testServerTimeout(setTimeoutFn) {
+  const server = http2.createServer();
+  setTimeoutFn(server);
 
-const onServerTimeout = common.mustCall((session) => {
-  session.close();
-});
+  const onServerTimeout = common.mustCall((session) => {
+    session.close();
+  });
 
-server.on('stream', common.mustNotCall());
-server.once('timeout', onServerTimeout);
+  server.on('stream', common.mustNotCall());
+  server.once('timeout', onServerTimeout);
 
-server.listen(0, common.mustCall(() => {
-  const url = `http://localhost:${server.address().port}`;
-  const client = http2.connect(url);
-  client.on('close', common.mustCall(() => {
-    const client2 = http2.connect(url);
-    client2.on('close', common.mustCall(() => server.close()));
+  server.listen(0, common.mustCall(() => {
+    const url = `http://localhost:${server.address().port}`;
+    const client = http2.connect(url);
+    client.on('close', common.mustCall(() => {
+      const client2 = http2.connect(url);
+      client2.on('close', common.mustCall(() => server.close()));
+    }));
   }));
-}));
+}
+
+const timeout = common.platformTimeout(50);
+testServerTimeout((server) => server.setTimeout(timeout));
+testServerTimeout((server) => server.timeout = timeout);