@tramvai/module-server 2.51.2 → 2.56.0

package/README.md

@@ -176,6 +176,12 @@ There are special headers in the module, which help to determine the exact infor
 
 For all of the headers above which are passed via environment variables to be available, you need the external infrastructure to pass them when building and deprovisioning the application image (inside tinkoff this is done automatically).
 
+#### Server-Timing
+
+Header [Server-Timing](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) provides additional information about different timings that were spent on server to handle current request. Currently, it shows timings for [CommandLineRunner's](concepts/command-line-runner.md) lines execution.
+
+To see values that related to request look for the header `Server-Timing` or check the `Timing` tab in browser DevTools for the page's main html.
+
 ### Debugging
 
 Module uses loggers with identifiers: `server`, `server:static`, `server:webapp`, `server:node-debug:request`

package/lib/modules/index.d.ts

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

package/lib/modules/serverTiming.d.ts

@@ -0,0 +1,6 @@
+export declare const ServerTimingModule: import("@tinkoff/dippy/lib/modules/module.h").ModuleClass & Partial<import("@tinkoff/dippy/lib/modules/module.h").ModuleSecretParameters> & {
+    [x: string]: (...args: any[]) => {
+        mainModule: import("@tramvai/core").ModuleType<import("@tinkoff/dippy/lib/modules/module.h").ModuleClass>;
+        providers: import("@tramvai/core").Provider<any, any>[];
+    };
+};

package/lib/server.es.js

@@ -1,7 +1,7 @@
 import { __decorate } from 'tslib';
 import { setDefaultResultOrder } from 'dns';
 import EventEmitter$1, { EventEmitter } from 'events';
-import { Scope, APP_INFO_TOKEN, Module, provide as provide$1, DI_TOKEN as DI_TOKEN$1, COMMAND_LINE_RUNNER_TOKEN, commandLineListTokens, createToken } from '@tramvai/core';
+import { Scope, APP_INFO_TOKEN, Module, provide as provide$1, DI_TOKEN as DI_TOKEN$1, COMMAND_LINE_RUNNER_TOKEN, commandLineListTokens, createToken, declareModule } from '@tramvai/core';
 import { SERVER_MODULE_PAPI_PUBLIC_ROUTE, SERVER_MODULE_PAPI_PUBLIC_URL, SERVER_MODULE_PAPI_PRIVATE_URL, SERVER_MODULE_PAPI_PRIVATE_ROUTE, SERVER_MODULE_STATICS_OPTIONS, SERVER_TOKEN, LIVENESS_PATH_TOKEN, READINESS_PATH_TOKEN, READINESS_PROBE_TOKEN, LIVENESS_PROBE_TOKEN, UTILITY_SERVER_PATHS, PROXY_CONFIG_TOKEN, DEPENDENCIES_VERSION_FILTER_TOKEN, UTILITY_SERVER_PORT_TOKEN } from '@tramvai/tokens-server';
 export * from '@tramvai/tokens-server';
 import { FASTIFY_REQUEST, FASTIFY_RESPONSE, PAPI_EXECUTOR, WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, UTILITY_WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_INIT_TOKEN, UTILITY_SERVER_TOKEN, SERVER_FACTORY_TOKEN, WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_FACTORY_TOKEN, WEB_FASTIFY_APP_AFTER_INIT_TOKEN, WEB_FASTIFY_APP_METRICS_TOKEN, WEB_FASTIFY_APP_LIMITER_TOKEN, WEB_FASTIFY_APP_BEFORE_ERROR_TOKEN, WEB_FASTIFY_APP_PROCESS_ERROR_TOKEN, WEB_FASTIFY_APP_AFTER_ERROR_TOKEN } from '@tramvai/tokens-server-private';
@@ -32,6 +32,7 @@ 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';
+import { COMMAND_LINE_EXECUTION_END_TOKEN } from '@tramvai/tokens-core-private';
 
 const serverFactory = () => {
     return http.createServer();
@@ -1008,6 +1009,31 @@ KeepAliveModule = __decorate([
     })
 ], KeepAliveModule);
 
+const ServerTimingModule = declareModule({
+    name: 'ServerTiming',
+    providers: [
+        provide$1({
+            provide: COMMAND_LINE_EXECUTION_END_TOKEN,
+            multi: true,
+            useValue: (di, type, status, timingInfo) => {
+                var _a;
+                if (type === 'server' && status === 'customer') {
+                    const responseManager = di.get(RESPONSE_MANAGER_TOKEN);
+                    const initialHeader = (_a = responseManager.getHeader('Server-Timing')) !== null && _a !== void 0 ? _a : '';
+                    const entries = [];
+                    // index for custom sort
+                    let index = 0;
+                    for (const line in timingInfo) {
+                        const info = timingInfo[line];
+                        entries.push(`line_${index++}_${line};dur=${info.end - info.start}`);
+                    }
+                    responseManager.setHeader('Server-Timing', `${initialHeader ? `${initialHeader}, ` : ''}${entries.join(', ')}`);
+                }
+            },
+        }),
+    ],
+});
+
 if (typeof setDefaultResultOrder === 'function') {
     setDefaultResultOrder('ipv4first');
 }
@@ -1028,6 +1054,7 @@ ServerModule = __decorate([
             DependenciesVersionModule,
             UtilityServerModule,
             KeepAliveModule,
+            ServerTimingModule,
             process.env.NODE_ENV !== 'production' && DebugHttpRequestsModule,
         ].filter(Boolean),
         providers: [

package/lib/server.js

@@ -35,6 +35,7 @@ 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');
+var tokensCorePrivate = require('@tramvai/tokens-core-private');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1030,6 +1031,31 @@ KeepAliveModule = tslib.__decorate([
     })
 ], KeepAliveModule);
 
+const ServerTimingModule = core.declareModule({
+    name: 'ServerTiming',
+    providers: [
+        core.provide({
+            provide: tokensCorePrivate.COMMAND_LINE_EXECUTION_END_TOKEN,
+            multi: true,
+            useValue: (di, type, status, timingInfo) => {
+                var _a;
+                if (type === 'server' && status === 'customer') {
+                    const responseManager = di.get(tokensCommon.RESPONSE_MANAGER_TOKEN);
+                    const initialHeader = (_a = responseManager.getHeader('Server-Timing')) !== null && _a !== void 0 ? _a : '';
+                    const entries = [];
+                    // index for custom sort
+                    let index = 0;
+                    for (const line in timingInfo) {
+                        const info = timingInfo[line];
+                        entries.push(`line_${index++}_${line};dur=${info.end - info.start}`);
+                    }
+                    responseManager.setHeader('Server-Timing', `${initialHeader ? `${initialHeader}, ` : ''}${entries.join(', ')}`);
+                }
+            },
+        }),
+    ],
+});
+
 if (typeof dns.setDefaultResultOrder === 'function') {
     dns.setDefaultResultOrder('ipv4first');
 }
@@ -1050,6 +1076,7 @@ exports.ServerModule = tslib.__decorate([
             DependenciesVersionModule,
             UtilityServerModule,
             KeepAliveModule,
+            ServerTimingModule,
             process.env.NODE_ENV !== 'production' && DebugHttpRequestsModule,
         ].filter(Boolean),
         providers: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-server",
-  "version": "2.51.2",
+  "version": "2.56.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -26,11 +26,11 @@
     "@tinkoff/monkeypatch": "2.0.3",
     "@tinkoff/terminus": "0.1.5",
     "@tinkoff/url": "0.8.4",
-    "@tramvai/module-cache-warmup": "2.51.2",
-    "@tramvai/module-metrics": "2.51.2",
-    "@tramvai/papi": "2.51.2",
-    "@tramvai/tokens-server": "2.51.2",
-    "@tramvai/tokens-server-private": "2.51.2",
+    "@tramvai/module-cache-warmup": "2.56.0",
+    "@tramvai/module-metrics": "2.56.0",
+    "@tramvai/papi": "2.56.0",
+    "@tramvai/tokens-server": "2.56.0",
+    "@tramvai/tokens-server-private": "2.56.0",
     "fastify": "^4.6.0",
     "@fastify/cookie": "^8.1.0",
     "@fastify/compress": "^6.1.1",
@@ -39,13 +39,14 @@
     "http-proxy-middleware": "^2.0.2"
   },
   "peerDependencies": {
-    "@tinkoff/dippy": "0.8.9",
+    "@tinkoff/dippy": "0.8.10",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "2.51.2",
-    "@tramvai/core": "2.51.2",
-    "@tramvai/module-common": "2.51.2",
-    "@tramvai/module-environment": "2.51.2",
-    "@tramvai/tokens-common": "2.51.2",
+    "@tramvai/cli": "2.56.0",
+    "@tramvai/core": "2.56.0",
+    "@tramvai/module-common": "2.56.0",
+    "@tramvai/module-environment": "2.56.0",
+    "@tramvai/tokens-common": "2.56.0",
+    "@tramvai/tokens-core-private": "2.56.0",
     "tslib": "^2.4.0"
   },
   "devDependencies": {