@tramvai/module-server 2.2.2 → 2.4.0

package/README.md

@@ -182,6 +182,10 @@ Module uses loggers with identifiers: `server`, `server:static`, `server:webapp`
 
 ## How to
 
+### Setting `keepAliveTimeout` for the server
+
+The default value for server's `keepAliveTimeout` is 5000. However, in case you want to set it manually just pass the environment variable `NODE_KEEPALIVE_TIMEOUT=[your_value]`. For further reading go to [NodeJs server.keepAliveTimeout page](https://nodejs.org/api/http.html#serverkeepalivetimeout).
+
 ### Specify server port
 
 By default server starts at `3000` port. You have next options to override this value depending on your environment:

package/lib/modules/index.d.ts

@@ -5,3 +5,4 @@ export * from './debugRequests';
 export * from './proxy';
 export * from './dependenciesVersion';
 export * from './utilityServer';
+export * from './keepAlive';

package/lib/modules/keepAlive.d.ts

@@ -0,0 +1,2 @@
+export declare class KeepAliveModule {
+}

package/lib/server.es.js

@@ -1,4 +1,5 @@
 import { __decorate } from 'tslib';
+import { setDefaultResultOrder } from 'dns';
 import { Scope, APP_INFO_TOKEN, Module, provide, DI_TOKEN, COMMAND_LINE_RUNNER_TOKEN, commandLineListTokens, createToken } from '@tramvai/core';
 import { SERVER_MODULE_PAPI_PUBLIC_ROUTE, SERVER_MODULE_PAPI_PUBLIC_URL, SERVER_MODULE_PAPI_PRIVATE_URL, WEB_APP_BEFORE_INIT_TOKEN, WEB_APP_TOKEN, SERVER_MODULE_PAPI_PRIVATE_ROUTE, SERVER_MODULE_STATICS_OPTIONS, SERVER_TOKEN, READINESS_PROBE_TOKEN, LIVENESS_PROBE_TOKEN, UTILITY_SERVER_PATHS, PROXY_CONFIG_TOKEN, DEPENDENCIES_VERSION_FILTER_TOKEN, UTILITY_SERVER_PORT_TOKEN, WEB_APP_INIT_TOKEN, WEB_APP_AFTER_INIT_TOKEN, WEB_APP_LIMITER_TOKEN } from '@tramvai/tokens-server';
 export * from '@tramvai/tokens-server';
@@ -34,6 +35,7 @@ import https from 'https';
 import isArray from '@tinkoff/utils/is/array';
 import isObject from '@tinkoff/utils/is/object';
 import { createProxyMiddleware } from 'http-proxy-middleware';
+import { ENV_MANAGER_TOKEN as ENV_MANAGER_TOKEN$1 } from '@tramvai/module-common';
 
 const serverFactory = () => {
     return http.createServer();
@@ -977,6 +979,49 @@ UtilityServerModule = __decorate([
     })
 ], UtilityServerModule);
 
+let KeepAliveModule = class KeepAliveModule {
+};
+KeepAliveModule = __decorate([
+    Module({
+        providers: [
+            provide({
+                provide: ENV_USED_TOKEN,
+                useValue: [
+                    {
+                        key: 'NODE_KEEPALIVE_TIMEOUT',
+                        optional: true,
+                        validator(keepAliveTimeout) {
+                            const value = Number(keepAliveTimeout);
+                            if (Number.isNaN(value)) {
+                                return 'Env variable NODE_KEEPALIVE_TIMEOUT should be a number';
+                            }
+                            if (value < 0) {
+                                return 'Env variable NODE_KEEPALIVE_TIMEOUT should be greater or equal than 0';
+                            }
+                            return true;
+                        },
+                    },
+                ],
+            }),
+            provide({
+                provide: commandLineListTokens.init,
+                useFactory: ({ server, envManager, }) => () => {
+                    const externalKeepAliveTimeout = envManager.get('NODE_KEEPALIVE_TIMEOUT');
+                    if (externalKeepAliveTimeout !== 'undefined') {
+                        // eslint-disable-next-line no-param-reassign
+                        server.keepAliveTimeout = Number(externalKeepAliveTimeout);
+                    }
+                },
+                multi: true,
+                deps: { server: SERVER_TOKEN, envManager: ENV_MANAGER_TOKEN$1 },
+            }),
+        ],
+    })
+], KeepAliveModule);
+
+if (typeof setDefaultResultOrder === 'function') {
+    setDefaultResultOrder('ipv4first');
+}
 let ServerModule = class ServerModule {
 };
 ServerModule = __decorate([
@@ -990,6 +1035,7 @@ ServerModule = __decorate([
             ServerProxyModule,
             DependenciesVersionModule,
             UtilityServerModule,
+            KeepAliveModule,
             process.env.NODE_ENV !== 'production' && DebugHttpRequestsModule,
         ].filter(Boolean),
         providers: [

package/lib/server.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var tslib = require('tslib');
+var dns = require('dns');
 var core = require('@tramvai/core');
 var tokensServer = require('@tramvai/tokens-server');
 var tokensServerPrivate = require('@tramvai/tokens-server-private');
@@ -37,6 +38,7 @@ var https = require('https');
 var isArray = require('@tinkoff/utils/is/array');
 var isObject = require('@tinkoff/utils/is/object');
 var httpProxyMiddleware = require('http-proxy-middleware');
+var moduleCommon = require('@tramvai/module-common');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1002,6 +1004,49 @@ UtilityServerModule = tslib.__decorate([
     })
 ], UtilityServerModule);
 
+let KeepAliveModule = class KeepAliveModule {
+};
+KeepAliveModule = tslib.__decorate([
+    core.Module({
+        providers: [
+            core.provide({
+                provide: tokensCommon.ENV_USED_TOKEN,
+                useValue: [
+                    {
+                        key: 'NODE_KEEPALIVE_TIMEOUT',
+                        optional: true,
+                        validator(keepAliveTimeout) {
+                            const value = Number(keepAliveTimeout);
+                            if (Number.isNaN(value)) {
+                                return 'Env variable NODE_KEEPALIVE_TIMEOUT should be a number';
+                            }
+                            if (value < 0) {
+                                return 'Env variable NODE_KEEPALIVE_TIMEOUT should be greater or equal than 0';
+                            }
+                            return true;
+                        },
+                    },
+                ],
+            }),
+            core.provide({
+                provide: core.commandLineListTokens.init,
+                useFactory: ({ server, envManager, }) => () => {
+                    const externalKeepAliveTimeout = envManager.get('NODE_KEEPALIVE_TIMEOUT');
+                    if (externalKeepAliveTimeout !== 'undefined') {
+                        // eslint-disable-next-line no-param-reassign
+                        server.keepAliveTimeout = Number(externalKeepAliveTimeout);
+                    }
+                },
+                multi: true,
+                deps: { server: tokensServer.SERVER_TOKEN, envManager: moduleCommon.ENV_MANAGER_TOKEN },
+            }),
+        ],
+    })
+], KeepAliveModule);
+
+if (typeof dns.setDefaultResultOrder === 'function') {
+    dns.setDefaultResultOrder('ipv4first');
+}
 exports.ServerModule = class ServerModule {
 };
 exports.ServerModule = tslib.__decorate([
@@ -1015,6 +1060,7 @@ exports.ServerModule = tslib.__decorate([
             ServerProxyModule,
             DependenciesVersionModule,
             UtilityServerModule,
+            KeepAliveModule,
             process.env.NODE_ENV !== 'production' && DebugHttpRequestsModule,
         ].filter(Boolean),
         providers: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-server",
-  "version": "2.2.2",
+  "version": "2.4.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -8,7 +8,10 @@
   "files": [
     "lib"
   ],
-  "sideEffects": false,
+  "sideEffects": [
+    "lib/server.js",
+    "lib/server.es.js"
+  ],
   "repository": {
     "type": "git",
     "url": "git@github.com:Tinkoff/tramvai.git"
@@ -23,11 +26,11 @@
     "@tinkoff/monkeypatch": "1.3.5",
     "@tinkoff/terminus": "0.0.5",
     "@tinkoff/url": "0.7.39",
-    "@tramvai/module-cache-warmup": "2.2.2",
-    "@tramvai/module-metrics": "2.2.2",
-    "@tramvai/papi": "2.2.2",
-    "@tramvai/tokens-server": "2.2.2",
-    "@tramvai/tokens-server-private": "2.2.2",
+    "@tramvai/module-cache-warmup": "2.4.0",
+    "@tramvai/module-metrics": "2.4.0",
+    "@tramvai/papi": "2.4.0",
+    "@tramvai/tokens-server": "2.4.0",
+    "@tramvai/tokens-server-private": "2.4.0",
     "compression": "^1.7.4",
     "express": "^4.17.1",
     "fastify": "^3.29.0",
@@ -40,11 +43,11 @@
   "peerDependencies": {
     "@tinkoff/dippy": "0.7.43",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "2.2.2",
-    "@tramvai/core": "2.2.2",
-    "@tramvai/module-common": "2.2.2",
-    "@tramvai/module-environment": "2.2.2",
-    "@tramvai/tokens-common": "2.2.2",
+    "@tramvai/cli": "2.4.0",
+    "@tramvai/core": "2.4.0",
+    "@tramvai/module-common": "2.4.0",
+    "@tramvai/module-environment": "2.4.0",
+    "@tramvai/tokens-common": "2.4.0",
     "tslib": "^2.0.3"
   },
   "devDependencies": {