feat: rename httpResponseTimeout to gracefulTerminationTimeout

BREAKING CHANGE: renamed configuration to avoid ambiguity about the function of the configuration.
gajus · Jan 21, 2020 · 4d1722d · 4d1722d
1 parent 57d4291
commit 4d1722d
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 17 deletions.
diff --git a/.README/README.md b/.README/README.md
@@ -24,11 +24,11 @@ import {
 } from 'http-terminator';
 
 /**
- * @property httpResponseTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 1000).
+ * @property gracefulTerminationTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 5000).
  * @property server Instance of http.Server.
  */
 type HttpTerminatorConfigurationInputType = {|
-  +httpResponseTimeout?: number,
+  +gracefulTerminationTimeout?: number,
   +server: Server,
 |};
 

diff --git a/README.md b/README.md
@@ -37,11 +37,11 @@ import {
 } from 'http-terminator';
 
 /**
- * @property httpResponseTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 1000).
+ * @property gracefulTerminationTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 5000).
  * @property server Instance of http.Server.
  */
 type HttpTerminatorConfigurationInputType = {|
-  +httpResponseTimeout?: number,
+  +gracefulTerminationTimeout?: number,
   +server: Server,
 |};
 

diff --git a/src/factories/createHttpTerminator.js b/src/factories/createHttpTerminator.js
@@ -13,7 +13,7 @@ const log = Logger.child({
 });
 
 const configurationDefaults = {
-  httpResponseTimeout: 1000,
+  gracefulTerminationTimeout: 1000,
 };
 
 export default (configurationInput: HttpTerminatorConfigurationInputType): HttpTerminatorType => {
@@ -119,7 +119,7 @@ export default (configurationInput: HttpTerminatorConfigurationInputType): HttpT
     }
 
     if (sockets.size) {
-      await delay(configuration.httpResponseTimeout);
+      await delay(configuration.gracefulTerminationTimeout);
 
       for (const socket of sockets) {
         destroySocket(socket);

diff --git a/src/types.js b/src/types.js
@@ -8,11 +8,11 @@ import type {
 } from 'https';
 
 /**
- * @property httpResponseTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 1000).
+ * @property gracefulTerminationTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 5000).
  * @property server Instance of http.Server.
  */
 export type HttpTerminatorConfigurationInputType = {|
-  +httpResponseTimeout?: number,
+  +gracefulTerminationTimeout?: number,
   +server: HttpServer | HttpsServer,
 |};
 

diff --git a/test/helpers/createTests.js b/test/helpers/createTests.js
@@ -35,7 +35,7 @@ export default (createHttpServer: HttpServerFactoryType | HttpsServerFactoryType
     t.false(httpServer.server.listening);
   });
 
-  test('terminates hanging sockets after httpResponseTimeout', async (t) => {
+  test('terminates hanging sockets after gracefulTerminationTimeout', async (t) => {
     const spy = sinon.spy();
 
     const httpServer = await createHttpServer(() => {
@@ -46,7 +46,7 @@ export default (createHttpServer: HttpServerFactoryType | HttpsServerFactoryType
     t.timeout(500);
 
     const terminator = createHttpTerminator({
-      httpResponseTimeout: 150,
+      gracefulTerminationTimeout: 150,
       server: httpServer.server,
     });
 
@@ -91,7 +91,7 @@ export default (createHttpServer: HttpServerFactoryType | HttpsServerFactoryType
     t.timeout(500);
 
     const terminator = createHttpTerminator({
-      httpResponseTimeout: 150,
+      gracefulTerminationTimeout: 150,
       server: httpServer.server,
     });
 
@@ -130,7 +130,7 @@ export default (createHttpServer: HttpServerFactoryType | HttpsServerFactoryType
     t.timeout(600);
 
     const terminator = createHttpTerminator({
-      httpResponseTimeout: 150,
+      gracefulTerminationTimeout: 150,
       server: httpServer.server,
     });
 
@@ -190,7 +190,7 @@ export default (createHttpServer: HttpServerFactoryType | HttpsServerFactoryType
     t.timeout(1000);
 
     const terminator = createHttpTerminator({
-      httpResponseTimeout: 150,
+      gracefulTerminationTimeout: 150,
       server: httpServer.server,
     });
 

diff --git a/test/http-server/factories/createHttpTerminator.js b/test/http-server/factories/createHttpTerminator.js
@@ -36,7 +36,7 @@ test('terminates hanging sockets after httpResponseTimeout', async (t) => {
   });
 
   const terminator = createHttpTerminator({
-    httpResponseTimeout: 150,
+    gracefulTerminationTimeout: 150,
     server: httpServer.server,
   });
 
@@ -69,7 +69,7 @@ test('server stops accepting new connections after terminator.terminate() is cal
   });
 
   const terminator = createHttpTerminator({
-    httpResponseTimeout: 150,
+    gracefulTerminationTimeout: 150,
     server: httpServer.server,
   });
 
@@ -107,7 +107,7 @@ test('ongoing requests receive {connection: close} header', async (t) => {
   });
 
   const terminator = createHttpTerminator({
-    httpResponseTimeout: 150,
+    gracefulTerminationTimeout: 150,
     server: httpServer.server,
   });
 
@@ -158,7 +158,7 @@ test('ongoing requests receive {connection: close} header (new request reusing a
   const httpServer = await createHttpServer(stub);
 
   const terminator = createHttpTerminator({
-    httpResponseTimeout: 150,
+    gracefulTerminationTimeout: 150,
     server: httpServer.server,
   });