@tramvai/module-server 1.7.8 → 1.8.3

package/README.md

@@ -34,7 +34,7 @@ createApp({
 
 Для включения проксирования необходимо в корне проекта создать файл `proxy.conf.js` или `proxy.conf.json` который будет экспортировать объект-маппинг запросов, либо можно использовать токен PROXY_CONFIG_TOKEN.
 
-#### Формат прокси-файла:
+#### Формат прокси-файла
 
 ##### Объект ключ-значение
 
@@ -109,8 +109,7 @@ _К примеру, мы хотим раздать sw.js файл из корн
 
 ### PAPI
 
-Papi - API роуты для `tramvai` приложения.
-Подробная информация доступна в разделе [Papi](features/papi/introduction.md)
+Papi - API роуты для `tramvai` приложения. Подробная информация доступна в разделе [Papi](features/papi/introduction.md)
 
 ### Эмуляция проблем с сетью/бэкендами в приложении
 
@@ -155,6 +154,22 @@ curl --location --request DELETE 'http://localhost:3000/tincoin/private/papi/deb
 
 В модуль сервера автоматически подключен модуль прогрева кэшей. Подробную информацию по прогреву кэшей, можете почитать [в документации cache-warmup](references/modules/cache-warmup.md)
 
+### Специальные заголовки
+
+#### Информация о сборке и деплое
+
+В модуле проставляются особые заголовки, которые помогают определить точную информацию о версии собранного приложения, коммите, ветке и т.п.:
+
+- _x-app-id_ - имя приложения указанного в `createApp`. Указывается в коде приложения.
+- _x-host_ - hostname сервера на котором запущено текущее приложение. Вычисляется в рантайме.
+- _x-app-version_ - версия запущенного приложения. Передаётся через переменную окружения `APP_VERSION` (внутри tinkoff проставляется в рамках стандартных пайплайнов gitlab ci).
+- _x-deploy-branch_ - ветка с которой был собран текущий образ приложения. Передаётся через переменную окружения `DEPLOY_BRANCH` (внутри tinkoff проставляется с помощью unic).
+- _x-deploy-commit_ - sha коммита с которого был собран текущий образ приложения. Передаётся через переменную окружения `DEPLOY_COMMIT` (внутри tinkoff проставляется с помощью unic).
+- _x-deploy-version_ - номер ревизии деплоя в k8s. Передаётся через переменную окружения `DEPLOY_VERSION` (внутри tinkoff проставляется с помощью unic).
+- _x-deploy-repository_ - ссылка на репозиторий приложения. Передаётся через переменную окружения `DEPLOY_REPOSITORY` (внутри tinkoff проставляется с помощью unic).
+
+Для всех заголовков выше, которые передаются через переменные окружения, чтобы они были доступны, необходимо чтобы внешняя инфраструктура передавала их при сборке и деплое образа приложения (внутри tinkoff это делается автоматически).
+
 ## Отладка
 
 Модуль использует логгеры с идентификаторами: `server`, `server:static`, `server:webapp`, `server:node-debug:request`

package/lib/server.es.js

@@ -2,7 +2,7 @@ import { __decorate } from 'tslib';
 import { Scope, APP_INFO_TOKEN, Module, provide, DI_TOKEN, COMMAND_LINE_RUNNER_TOKEN, commandLineListTokens } 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, WEB_APP_INIT_TOKEN, SERVER_TOKEN, SPECIAL_SERVER_PATHS, PROXY_CONFIG_TOKEN, DEPENDENCIES_VERSION_FILTER_TOKEN, WEB_APP_AFTER_INIT_TOKEN } from '@tramvai/tokens-server';
 export * from '@tramvai/tokens-server';
-import { REQUEST, RESPONSE, RESPONSE_MANAGER_TOKEN, LOGGER_TOKEN as LOGGER_TOKEN$1, ENV_MANAGER_TOKEN as ENV_MANAGER_TOKEN$1, ENV_USED_TOKEN as ENV_USED_TOKEN$1 } from '@tramvai/module-common';
+import { REQUEST, RESPONSE, RESPONSE_MANAGER_TOKEN, LOGGER_TOKEN as LOGGER_TOKEN$1, ENV_MANAGER_TOKEN as ENV_MANAGER_TOKEN$1, ENV_USED_TOKEN } from '@tramvai/module-common';
 import { MetricsModule } from '@tramvai/module-metrics';
 import { CacheWarmupModule } from '@tramvai/module-cache-warmup';
 import http from 'http';
@@ -14,9 +14,10 @@ import { isRedirectFoundError, isNotFoundError, isHttpError } from '@tinkoff/err
 import zlib from 'zlib';
 import compression from 'compression';
 import os from 'os';
+import filterObj from '@tinkoff/utils/object/filter';
 import flatten from '@tinkoff/utils/array/flatten';
 import toArray from '@tinkoff/utils/array/toArray';
-import { REQUEST as REQUEST$1, RESPONSE as RESPONSE$1, LOGGER_TOKEN, ENV_MANAGER_TOKEN, ENV_USED_TOKEN } from '@tramvai/tokens-common';
+import { REQUEST as REQUEST$1, RESPONSE as RESPONSE$1, LOGGER_TOKEN, ENV_MANAGER_TOKEN } from '@tramvai/tokens-common';
 import { create, middlewares, getPapiParameters, createPapiMethod } from '@tramvai/papi';
 import { createChildContainer } from '@tinkoff/dippy';
 import eachObj from '@tinkoff/utils/object/each';
@@ -29,7 +30,6 @@ import isArray from '@tinkoff/utils/is/array';
 import isObject from '@tinkoff/utils/is/object';
 import { resolve } from 'path';
 import { createProxyMiddleware } from 'http-proxy-middleware';
-import filterObj from '@tinkoff/utils/object/filter';
 
 const serverFactory = ({ webApp }) => {
     const server = http.createServer();
@@ -169,14 +169,18 @@ const staticAppCommand = ({ logger, envManager, appInfo, }) => {
 };
 
 const xHeadersFactory = ({ app, envManager, appInfo, }) => {
-    const appVersion = envManager.get('APP_VERSION');
+    const xHeaders = filterObj((val) => !!val, {
+        'x-app-id': appInfo.appName,
+        'x-host': encodeURIComponent(os.hostname()),
+        'x-app-version': envManager.get('APP_VERSION'),
+        'x-deploy-branch': envManager.get('DEPLOY_BRANCH'),
+        'x-deploy-commit': envManager.get('DEPLOY_COMMIT'),
+        'x-deploy-version': envManager.get('DEPLOY_VERSION'),
+        'x-deploy-repository': envManager.get('DEPLOY_REPOSITORY'),
+    });
     return async () => {
         app.use((req, res, next) => {
-            res.set({
-                'X-App-Id': appInfo.appName,
-                'X-App-Version': appVersion,
-                'X-Host': encodeURIComponent(os.hostname()),
-            });
+            res.set(xHeaders);
             next();
         });
     };
@@ -355,19 +359,6 @@ ServerPapiModule = __decorate([
                     },
                 }),
             }),
-            provide({
-                provide: ENV_USED_TOKEN,
-                multi: true,
-                useValue: [
-                    {
-                        dehydrate: true,
-                        optional: true,
-                        key: 'APP_VERSION',
-                        // обращаемся к process.env.APP_VERSION явно, чтобы вебпак заинлайнил его при сборке и версия вшилась в билд
-                        value: process.env.APP_VERSION,
-                    },
-                ],
-            }),
         ],
     })
 ], ServerPapiModule);
@@ -781,12 +772,23 @@ ServerModule = __decorate([
                 },
             },
             {
-                provide: ENV_USED_TOKEN$1,
+                provide: ENV_USED_TOKEN,
                 multi: true,
                 useValue: [
                     { key: 'DEV_STATIC', optional: true, dehydrate: false },
                     { key: 'PORT_STATIC', optional: true, dehydrate: false, value: 4000 },
                     { key: 'PORT', optional: true, dehydrate: false, value: 3000 },
+                    {
+                        key: 'APP_VERSION',
+                        dehydrate: true,
+                        optional: true,
+                        // обращаемся к process.env.APP_VERSION явно, чтобы вебпак заинлайнил его при сборке и версия вшилась в билд
+                        value: process.env.APP_VERSION,
+                    },
+                    { key: 'DEPLOY_BRANCH', optional: true, dehydrate: false },
+                    { key: 'DEPLOY_COMMIT', optional: true, dehydrate: false },
+                    { key: 'DEPLOY_VERSION', optional: true, dehydrate: false },
+                    { key: 'DEPLOY_REPOSITORY', optional: true, dehydrate: false },
                 ],
             },
             {

package/lib/server.js

@@ -17,6 +17,7 @@ var errors = require('@tinkoff/errors');
 var zlib = require('zlib');
 var compression = require('compression');
 var os = require('os');
+var filterObj = require('@tinkoff/utils/object/filter');
 var flatten = require('@tinkoff/utils/array/flatten');
 var toArray = require('@tinkoff/utils/array/toArray');
 var tokensCommon = require('@tramvai/tokens-common');
@@ -32,7 +33,6 @@ var isArray = require('@tinkoff/utils/is/array');
 var isObject = require('@tinkoff/utils/is/object');
 var path = require('path');
 var httpProxyMiddleware = require('http-proxy-middleware');
-var filterObj = require('@tinkoff/utils/object/filter');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -44,6 +44,7 @@ var finalhandler__default = /*#__PURE__*/_interopDefaultLegacy(finalhandler);
 var zlib__default = /*#__PURE__*/_interopDefaultLegacy(zlib);
 var compression__default = /*#__PURE__*/_interopDefaultLegacy(compression);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
+var filterObj__default = /*#__PURE__*/_interopDefaultLegacy(filterObj);
 var flatten__default = /*#__PURE__*/_interopDefaultLegacy(flatten);
 var toArray__default = /*#__PURE__*/_interopDefaultLegacy(toArray);
 var eachObj__default = /*#__PURE__*/_interopDefaultLegacy(eachObj);
@@ -51,7 +52,6 @@ var monkeypatch__default = /*#__PURE__*/_interopDefaultLegacy(monkeypatch);
 var https__default = /*#__PURE__*/_interopDefaultLegacy(https);
 var isArray__default = /*#__PURE__*/_interopDefaultLegacy(isArray);
 var isObject__default = /*#__PURE__*/_interopDefaultLegacy(isObject);
-var filterObj__default = /*#__PURE__*/_interopDefaultLegacy(filterObj);
 
 const serverFactory = ({ webApp }) => {
     const server = http__default['default'].createServer();
@@ -191,14 +191,18 @@ const staticAppCommand = ({ logger, envManager, appInfo, }) => {
 };
 
 const xHeadersFactory = ({ app, envManager, appInfo, }) => {
-    const appVersion = envManager.get('APP_VERSION');
+    const xHeaders = filterObj__default['default']((val) => !!val, {
+        'x-app-id': appInfo.appName,
+        'x-host': encodeURIComponent(os__default['default'].hostname()),
+        'x-app-version': envManager.get('APP_VERSION'),
+        'x-deploy-branch': envManager.get('DEPLOY_BRANCH'),
+        'x-deploy-commit': envManager.get('DEPLOY_COMMIT'),
+        'x-deploy-version': envManager.get('DEPLOY_VERSION'),
+        'x-deploy-repository': envManager.get('DEPLOY_REPOSITORY'),
+    });
     return async () => {
         app.use((req, res, next) => {
-            res.set({
-                'X-App-Id': appInfo.appName,
-                'X-App-Version': appVersion,
-                'X-Host': encodeURIComponent(os__default['default'].hostname()),
-            });
+            res.set(xHeaders);
             next();
         });
     };
@@ -377,19 +381,6 @@ ServerPapiModule = tslib.__decorate([
                     },
                 }),
             }),
-            core.provide({
-                provide: tokensCommon.ENV_USED_TOKEN,
-                multi: true,
-                useValue: [
-                    {
-                        dehydrate: true,
-                        optional: true,
-                        key: 'APP_VERSION',
-                        // обращаемся к process.env.APP_VERSION явно, чтобы вебпак заинлайнил его при сборке и версия вшилась в билд
-                        value: process.env.APP_VERSION,
-                    },
-                ],
-            }),
         ],
     })
 ], ServerPapiModule);
@@ -809,6 +800,17 @@ exports.ServerModule = tslib.__decorate([
                     { key: 'DEV_STATIC', optional: true, dehydrate: false },
                     { key: 'PORT_STATIC', optional: true, dehydrate: false, value: 4000 },
                     { key: 'PORT', optional: true, dehydrate: false, value: 3000 },
+                    {
+                        key: 'APP_VERSION',
+                        dehydrate: true,
+                        optional: true,
+                        // обращаемся к process.env.APP_VERSION явно, чтобы вебпак заинлайнил его при сборке и версия вшилась в билд
+                        value: process.env.APP_VERSION,
+                    },
+                    { key: 'DEPLOY_BRANCH', optional: true, dehydrate: false },
+                    { key: 'DEPLOY_COMMIT', optional: true, dehydrate: false },
+                    { key: 'DEPLOY_VERSION', optional: true, dehydrate: false },
+                    { key: 'DEPLOY_REPOSITORY', optional: true, dehydrate: false },
                 ],
             },
             {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-server",
-  "version": "1.7.8",
+  "version": "1.8.3",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -23,10 +23,10 @@
     "@tinkoff/express-terminus": "0.1.11",
     "@tinkoff/monkeypatch": "1.3.3",
     "@tinkoff/url": "0.7.36",
-    "@tramvai/module-cache-warmup": "1.7.8",
-    "@tramvai/module-metrics": "1.7.8",
-    "@tramvai/papi": "1.7.8",
-    "@tramvai/tokens-server": "1.7.8",
+    "@tramvai/module-cache-warmup": "1.8.3",
+    "@tramvai/module-metrics": "1.8.3",
+    "@tramvai/papi": "1.8.3",
+    "@tramvai/tokens-server": "1.8.3",
     "body-parser": "^1.19.0",
     "compression": "^1.7.4",
     "cookie-parser": "^1.4.3",
@@ -36,11 +36,11 @@
   },
   "peerDependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "1.7.8",
-    "@tramvai/core": "1.7.8",
-    "@tramvai/module-common": "1.7.8",
-    "@tramvai/module-environment": "1.7.8",
-    "@tramvai/tokens-common": "1.7.8",
+    "@tramvai/cli": "1.8.3",
+    "@tramvai/core": "1.8.3",
+    "@tramvai/module-common": "1.8.3",
+    "@tramvai/module-environment": "1.8.3",
+    "@tramvai/tokens-common": "1.8.3",
     "@tinkoff/dippy": "0.7.35",
     "tslib": "^2.0.3"
   },