@tramvai/module-server 1.93.1 → 1.94.2

package/README.md

@@ -178,10 +178,10 @@ Module uses loggers with identifiers: `server`, `server:static`, `server:webapp`
 
 ### Specify server port
 
-By default server starts at `3000` port. You can change this value by specifying environment variable `PORT`:
+By default server starts at `3000` port. You have next options to override this value depending on your environment:
 
-- in dev environment it can be done by adding env `PORT` to file `env.development.json` e.g. `PORT: "8080"`
-- it can be specified explicitly as an environment variable `PORT` e.g. `PORT=8080`
+- **in dev environment** port in fully controlled by `@tramvai/cli` and should be specified by [`-p` option](references/cli/start.md#-p---port)
+- **in prod environment** it can be specified explicitly as an environment variable `PORT` e.g. `PORT=8080`
 
 ## Exportable tokens
 

package/lib/server/webApp.d.ts

@@ -9,15 +9,15 @@ export declare const webAppFactory: ({ server }: {
 export declare const webAppExpressFactory: ({ webApp }: {
     webApp: typeof WEB_FASTIFY_APP_TOKEN;
 }) => import("express-serve-static-core").Express;
-export declare const webAppInitCommand: ({ app, expressApp, logger, commandLineRunner, beforeInit, init, afterInit, limiterRequest, expressBeforeInit, expressInit, expressAfterInit, expressLimiterRequest, beforeError, processError, afterError, }: {
+export declare const webAppInitCommand: ({ app, expressApp, logger, commandLineRunner, beforeInit, limiterRequest, init, afterInit, expressBeforeInit, expressInit, expressAfterInit, expressLimiterRequest, beforeError, processError, afterError, }: {
     app: typeof WEB_FASTIFY_APP_TOKEN;
     expressApp: typeof WEB_APP_TOKEN;
     logger: typeof LOGGER_TOKEN;
     commandLineRunner: typeof COMMAND_LINE_RUNNER_TOKEN;
     beforeInit: typeof WEB_FASTIFY_APP_BEFORE_INIT_TOKEN;
+    limiterRequest: typeof WEB_FASTIFY_APP_LIMITER_TOKEN;
     init: typeof WEB_FASTIFY_APP_INIT_TOKEN;
     afterInit: typeof WEB_FASTIFY_APP_AFTER_INIT_TOKEN;
-    limiterRequest: typeof WEB_FASTIFY_APP_LIMITER_TOKEN;
     expressBeforeInit: typeof WEB_APP_BEFORE_INIT_TOKEN;
     expressInit: typeof WEB_APP_INIT_TOKEN;
     expressAfterInit: typeof WEB_APP_AFTER_INIT_TOKEN;

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, SERVER_TOKEN, READINESS_PROBE_TOKEN, LIVENESS_PROBE_TOKEN, SPECIAL_SERVER_PATHS, PROXY_CONFIG_TOKEN, DEPENDENCIES_VERSION_FILTER_TOKEN, WEB_APP_INIT_TOKEN, WEB_APP_AFTER_INIT_TOKEN, WEB_APP_LIMITER_TOKEN } from '@tramvai/tokens-server';
 export * from '@tramvai/tokens-server';
-import { WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, WEB_FASTIFY_APP_TOKEN, SERVER_FACTORY_TOKEN, WEB_FASTIFY_APP_FACTORY_TOKEN, WEB_FASTIFY_APP_INIT_TOKEN, WEB_FASTIFY_APP_AFTER_INIT_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';
+import { WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, SERVER_FACTORY_TOKEN, WEB_FASTIFY_APP_FACTORY_TOKEN, WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_INIT_TOKEN, WEB_FASTIFY_APP_AFTER_INIT_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';
 import { REQUEST, RESPONSE, FASTIFY_REQUEST, FASTIFY_RESPONSE, RESPONSE_MANAGER_TOKEN, LOGGER_TOKEN, ENV_MANAGER_TOKEN, ENV_USED_TOKEN } from '@tramvai/tokens-common';
 import { MetricsModule } from '@tramvai/module-metrics';
 import { CacheWarmupModule } from '@tramvai/module-cache-warmup';
@@ -116,10 +116,11 @@ const expressPlugin = (fastify, options, next) => {
         }
     }
     function onRegister(instance) {
+        var _a, _b;
         const middlewares = instance[kMiddlewares].slice();
         // eslint-disable-next-line no-param-reassign
         instance[kMiddlewares] = [];
-        instance.decorate('express', express());
+        instance.decorate('express', (_b = (_a = options.express) === null || _a === void 0 ? void 0 : _a.instance) !== null && _b !== void 0 ? _b : express());
         instance.express.disable('x-powered-by');
         instance.decorate('use', use);
         for (const middleware of middlewares) {
@@ -198,11 +199,11 @@ const webAppExpressFactory = ({ webApp }) => {
     app.disable('x-powered-by');
     return app;
 };
-const webAppInitCommand = ({ app, expressApp, logger, commandLineRunner, beforeInit, init, afterInit, limiterRequest, expressBeforeInit, expressInit, expressAfterInit, expressLimiterRequest, beforeError, processError, afterError, }) => {
+const webAppInitCommand = ({ app, expressApp, logger, commandLineRunner, beforeInit, limiterRequest, init, afterInit, expressBeforeInit, expressInit, expressAfterInit, expressLimiterRequest, beforeError, processError, afterError, }) => {
     const log = logger('server:webapp');
-    const runHandlers = (handlers, expressHandlers) => {
+    const runHandlers = (instance, handlers, expressHandlers) => {
         return Promise.all([
-            handlers && Promise.all(handlers.map((handler) => handler(app))),
+            handlers && Promise.all(handlers.map((handler) => handler(instance))),
             expressHandlers && Promise.all(expressHandlers.map((handler) => handler(expressApp))),
         ]);
     };
@@ -213,73 +214,79 @@ const webAppInitCommand = ({ app, expressApp, logger, commandLineRunner, beforeI
                 instance: expressApp,
             },
         });
-        await runHandlers(beforeInit, expressBeforeInit);
-        await runHandlers(limiterRequest, expressLimiterRequest);
-        await app.register(fastifyCookie);
-        await app.register(fastifyFormBody, { bodyLimit: 2097152 }); // 2mb
-        await runHandlers(init, expressInit);
-        // force express to execute to update server's request and response instances
-        app.use((req, res, next) => {
-            next();
+        await app.register(async (instance) => {
+            await runHandlers(instance, beforeInit, expressBeforeInit);
         });
-        app.all('*', async (request, reply) => {
-            try {
-                log.debug({
-                    event: 'start:request',
-                    message: 'Клиент зашел на страницу',
-                    url: request.url,
-                });
-                const di = await commandLineRunner.run('server', 'customer', [
-                    {
-                        provide: REQUEST,
-                        scope: Scope.REQUEST,
-                        useValue: request.raw,
-                    },
-                    {
-                        provide: RESPONSE,
-                        scope: Scope.REQUEST,
-                        useValue: reply.raw,
-                    },
-                    // TODO: перевести использование на новые
-                    // TODO: добавить для papi
-                    {
-                        provide: FASTIFY_REQUEST,
-                        scope: Scope.REQUEST,
-                        useValue: request,
-                    },
-                    {
-                        provide: FASTIFY_RESPONSE,
-                        scope: Scope.REQUEST,
-                        useValue: reply,
-                    },
-                ]);
-                const responseManager = di.get(RESPONSE_MANAGER_TOKEN);
-                if (reply.sent) {
+        await app.register(async (instance) => {
+            await runHandlers(instance, limiterRequest, expressLimiterRequest);
+            await app.register(fastifyCookie);
+            await app.register(fastifyFormBody, { bodyLimit: 2097152 }); // 2mb
+            await runHandlers(instance, init, expressInit);
+            // force express to execute to update server's request and response instances
+            instance.use((req, res, next) => {
+                next();
+            });
+            instance.all('*', async (request, reply) => {
+                try {
                     log.debug({
-                        event: 'response-ended',
-                        message: 'Response was already ended.',
+                        event: 'start:request',
+                        message: 'Клиент зашел на страницу',
                         url: request.url,
                     });
+                    const di = await commandLineRunner.run('server', 'customer', [
+                        {
+                            provide: REQUEST,
+                            scope: Scope.REQUEST,
+                            useValue: request.raw,
+                        },
+                        {
+                            provide: RESPONSE,
+                            scope: Scope.REQUEST,
+                            useValue: reply.raw,
+                        },
+                        // TODO: перевести использование на новые
+                        // TODO: добавить для papi
+                        {
+                            provide: FASTIFY_REQUEST,
+                            scope: Scope.REQUEST,
+                            useValue: request,
+                        },
+                        {
+                            provide: FASTIFY_RESPONSE,
+                            scope: Scope.REQUEST,
+                            useValue: reply,
+                        },
+                    ]);
+                    const responseManager = di.get(RESPONSE_MANAGER_TOKEN);
+                    if (reply.sent) {
+                        log.debug({
+                            event: 'response-ended',
+                            message: 'Response was already ended.',
+                            url: request.url,
+                        });
+                    }
+                    else {
+                        reply
+                            .header('content-type', 'text/html')
+                            .headers(responseManager.getHeaders())
+                            .status(responseManager.getStatus())
+                            .send(responseManager.getBody());
+                    }
                 }
-                else {
-                    reply
-                        .header('content-type', 'text/html')
-                        .headers(responseManager.getHeaders())
-                        .status(responseManager.getStatus())
-                        .send(responseManager.getBody());
-                }
-            }
-            catch (err) {
-                if (err.di) {
-                    const responseManager = err.di.get(RESPONSE_MANAGER_TOKEN);
-                    if (responseManager && !reply.sent) {
-                        reply.headers(responseManager.getHeaders());
+                catch (err) {
+                    if (err.di) {
+                        const responseManager = err.di.get(RESPONSE_MANAGER_TOKEN);
+                        if (responseManager && !reply.sent) {
+                            reply.headers(responseManager.getHeaders());
+                        }
                     }
+                    throw err;
                 }
-                throw err;
-            }
+            });
+        });
+        await app.register(async (instance) => {
+            await runHandlers(app, afterInit, expressAfterInit);
         });
-        await runHandlers(afterInit, expressAfterInit);
         await app.ready();
     };
 };
@@ -535,10 +542,10 @@ ServerStaticsModule = __decorate([
         providers: [
             provide({
                 provide: WEB_FASTIFY_APP_BEFORE_INIT_TOKEN,
-                useFactory: ({ app, options }) => {
+                useFactory: ({ options }) => {
                     const path = (options === null || options === void 0 ? void 0 : options.path) || 'public';
-                    return () => {
-                        app.register(FastifyStatic, {
+                    return (instance) => {
+                        instance.register(FastifyStatic, {
                             decorateReply: false,
                             prefix: `/${path}`,
                             root: resolve(process.cwd(), path),
@@ -551,7 +558,6 @@ ServerStaticsModule = __decorate([
                     };
                 },
                 deps: {
-                    app: WEB_FASTIFY_APP_TOKEN,
                     options: {
                         token: SERVER_MODULE_STATICS_OPTIONS,
                         optional: true,
@@ -576,10 +582,10 @@ ServerGracefulShutdownModule = __decorate([
             {
                 provide: WEB_FASTIFY_APP_BEFORE_INIT_TOKEN,
                 multi: true,
-                useFactory: ({ app, server, logger, commandLineRunner, livenessProbe, readinessProbe, }) => {
+                useFactory: ({ server, logger, commandLineRunner, livenessProbe, readinessProbe, }) => {
                     const log = logger('server');
-                    return function serverListen() {
-                        createTerminus(server, app, {
+                    return function serverListen(instance) {
+                        createTerminus(server, instance, {
                             signal: 'SIGTERM',
                             timeout: GRACEFUL_SHUTDOWN_TIMEOUT,
                             logger: (msg, error) => {
@@ -619,7 +625,6 @@ ServerGracefulShutdownModule = __decorate([
                     };
                 },
                 deps: {
-                    app: WEB_FASTIFY_APP_TOKEN,
                     server: SERVER_TOKEN,
                     logger: LOGGER_TOKEN,
                     commandLineRunner: COMMAND_LINE_RUNNER_TOKEN,

package/lib/server.js

@@ -141,10 +141,11 @@ const expressPlugin = (fastify, options, next) => {
         }
     }
     function onRegister(instance) {
+        var _a, _b;
         const middlewares = instance[kMiddlewares].slice();
         // eslint-disable-next-line no-param-reassign
         instance[kMiddlewares] = [];
-        instance.decorate('express', express__default["default"]());
+        instance.decorate('express', (_b = (_a = options.express) === null || _a === void 0 ? void 0 : _a.instance) !== null && _b !== void 0 ? _b : express__default["default"]());
         instance.express.disable('x-powered-by');
         instance.decorate('use', use);
         for (const middleware of middlewares) {
@@ -223,11 +224,11 @@ const webAppExpressFactory = ({ webApp }) => {
     app.disable('x-powered-by');
     return app;
 };
-const webAppInitCommand = ({ app, expressApp, logger, commandLineRunner, beforeInit, init, afterInit, limiterRequest, expressBeforeInit, expressInit, expressAfterInit, expressLimiterRequest, beforeError, processError, afterError, }) => {
+const webAppInitCommand = ({ app, expressApp, logger, commandLineRunner, beforeInit, limiterRequest, init, afterInit, expressBeforeInit, expressInit, expressAfterInit, expressLimiterRequest, beforeError, processError, afterError, }) => {
     const log = logger('server:webapp');
-    const runHandlers = (handlers, expressHandlers) => {
+    const runHandlers = (instance, handlers, expressHandlers) => {
         return Promise.all([
-            handlers && Promise.all(handlers.map((handler) => handler(app))),
+            handlers && Promise.all(handlers.map((handler) => handler(instance))),
             expressHandlers && Promise.all(expressHandlers.map((handler) => handler(expressApp))),
         ]);
     };
@@ -238,73 +239,79 @@ const webAppInitCommand = ({ app, expressApp, logger, commandLineRunner, beforeI
                 instance: expressApp,
             },
         });
-        await runHandlers(beforeInit, expressBeforeInit);
-        await runHandlers(limiterRequest, expressLimiterRequest);
-        await app.register(fastifyCookie.fastifyCookie);
-        await app.register(fastifyFormBody__default["default"], { bodyLimit: 2097152 }); // 2mb
-        await runHandlers(init, expressInit);
-        // force express to execute to update server's request and response instances
-        app.use((req, res, next) => {
-            next();
+        await app.register(async (instance) => {
+            await runHandlers(instance, beforeInit, expressBeforeInit);
         });
-        app.all('*', async (request, reply) => {
-            try {
-                log.debug({
-                    event: 'start:request',
-                    message: 'Клиент зашел на страницу',
-                    url: request.url,
-                });
-                const di = await commandLineRunner.run('server', 'customer', [
-                    {
-                        provide: tokensCommon.REQUEST,
-                        scope: core.Scope.REQUEST,
-                        useValue: request.raw,
-                    },
-                    {
-                        provide: tokensCommon.RESPONSE,
-                        scope: core.Scope.REQUEST,
-                        useValue: reply.raw,
-                    },
-                    // TODO: перевести использование на новые
-                    // TODO: добавить для papi
-                    {
-                        provide: tokensCommon.FASTIFY_REQUEST,
-                        scope: core.Scope.REQUEST,
-                        useValue: request,
-                    },
-                    {
-                        provide: tokensCommon.FASTIFY_RESPONSE,
-                        scope: core.Scope.REQUEST,
-                        useValue: reply,
-                    },
-                ]);
-                const responseManager = di.get(tokensCommon.RESPONSE_MANAGER_TOKEN);
-                if (reply.sent) {
+        await app.register(async (instance) => {
+            await runHandlers(instance, limiterRequest, expressLimiterRequest);
+            await app.register(fastifyCookie.fastifyCookie);
+            await app.register(fastifyFormBody__default["default"], { bodyLimit: 2097152 }); // 2mb
+            await runHandlers(instance, init, expressInit);
+            // force express to execute to update server's request and response instances
+            instance.use((req, res, next) => {
+                next();
+            });
+            instance.all('*', async (request, reply) => {
+                try {
                     log.debug({
-                        event: 'response-ended',
-                        message: 'Response was already ended.',
+                        event: 'start:request',
+                        message: 'Клиент зашел на страницу',
                         url: request.url,
                     });
+                    const di = await commandLineRunner.run('server', 'customer', [
+                        {
+                            provide: tokensCommon.REQUEST,
+                            scope: core.Scope.REQUEST,
+                            useValue: request.raw,
+                        },
+                        {
+                            provide: tokensCommon.RESPONSE,
+                            scope: core.Scope.REQUEST,
+                            useValue: reply.raw,
+                        },
+                        // TODO: перевести использование на новые
+                        // TODO: добавить для papi
+                        {
+                            provide: tokensCommon.FASTIFY_REQUEST,
+                            scope: core.Scope.REQUEST,
+                            useValue: request,
+                        },
+                        {
+                            provide: tokensCommon.FASTIFY_RESPONSE,
+                            scope: core.Scope.REQUEST,
+                            useValue: reply,
+                        },
+                    ]);
+                    const responseManager = di.get(tokensCommon.RESPONSE_MANAGER_TOKEN);
+                    if (reply.sent) {
+                        log.debug({
+                            event: 'response-ended',
+                            message: 'Response was already ended.',
+                            url: request.url,
+                        });
+                    }
+                    else {
+                        reply
+                            .header('content-type', 'text/html')
+                            .headers(responseManager.getHeaders())
+                            .status(responseManager.getStatus())
+                            .send(responseManager.getBody());
+                    }
                 }
-                else {
-                    reply
-                        .header('content-type', 'text/html')
-                        .headers(responseManager.getHeaders())
-                        .status(responseManager.getStatus())
-                        .send(responseManager.getBody());
-                }
-            }
-            catch (err) {
-                if (err.di) {
-                    const responseManager = err.di.get(tokensCommon.RESPONSE_MANAGER_TOKEN);
-                    if (responseManager && !reply.sent) {
-                        reply.headers(responseManager.getHeaders());
+                catch (err) {
+                    if (err.di) {
+                        const responseManager = err.di.get(tokensCommon.RESPONSE_MANAGER_TOKEN);
+                        if (responseManager && !reply.sent) {
+                            reply.headers(responseManager.getHeaders());
+                        }
                     }
+                    throw err;
                 }
-                throw err;
-            }
+            });
+        });
+        await app.register(async (instance) => {
+            await runHandlers(app, afterInit, expressAfterInit);
         });
-        await runHandlers(afterInit, expressAfterInit);
         await app.ready();
     };
 };
@@ -560,10 +567,10 @@ ServerStaticsModule = tslib.__decorate([
         providers: [
             core.provide({
                 provide: tokensServerPrivate.WEB_FASTIFY_APP_BEFORE_INIT_TOKEN,
-                useFactory: ({ app, options }) => {
+                useFactory: ({ options }) => {
                     const path$1 = (options === null || options === void 0 ? void 0 : options.path) || 'public';
-                    return () => {
-                        app.register(FastifyStatic__default["default"], {
+                    return (instance) => {
+                        instance.register(FastifyStatic__default["default"], {
                             decorateReply: false,
                             prefix: `/${path$1}`,
                             root: path.resolve(process.cwd(), path$1),
@@ -576,7 +583,6 @@ ServerStaticsModule = tslib.__decorate([
                     };
                 },
                 deps: {
-                    app: tokensServerPrivate.WEB_FASTIFY_APP_TOKEN,
                     options: {
                         token: tokensServer.SERVER_MODULE_STATICS_OPTIONS,
                         optional: true,
@@ -601,10 +607,10 @@ ServerGracefulShutdownModule = tslib.__decorate([
             {
                 provide: tokensServerPrivate.WEB_FASTIFY_APP_BEFORE_INIT_TOKEN,
                 multi: true,
-                useFactory: ({ app, server, logger, commandLineRunner, livenessProbe, readinessProbe, }) => {
+                useFactory: ({ server, logger, commandLineRunner, livenessProbe, readinessProbe, }) => {
                     const log = logger('server');
-                    return function serverListen() {
-                        terminus.createTerminus(server, app, {
+                    return function serverListen(instance) {
+                        terminus.createTerminus(server, instance, {
                             signal: 'SIGTERM',
                             timeout: GRACEFUL_SHUTDOWN_TIMEOUT,
                             logger: (msg, error) => {
@@ -644,7 +650,6 @@ ServerGracefulShutdownModule = tslib.__decorate([
                     };
                 },
                 deps: {
-                    app: tokensServerPrivate.WEB_FASTIFY_APP_TOKEN,
                     server: tokensServer.SERVER_TOKEN,
                     logger: tokensCommon.LOGGER_TOKEN,
                     commandLineRunner: core.COMMAND_LINE_RUNNER_TOKEN,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-server",
-  "version": "1.93.1",
+  "version": "1.94.2",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -21,13 +21,13 @@
   "dependencies": {
     "@tinkoff/errors": "0.2.20",
     "@tinkoff/monkeypatch": "1.3.3",
-    "@tinkoff/terminus": "0.0.1",
+    "@tinkoff/terminus": "0.0.2",
     "@tinkoff/url": "0.7.37",
-    "@tramvai/module-cache-warmup": "1.93.1",
-    "@tramvai/module-metrics": "1.93.1",
-    "@tramvai/papi": "1.93.1",
-    "@tramvai/tokens-server": "1.93.1",
-    "@tramvai/tokens-server-private": "1.93.1",
+    "@tramvai/module-cache-warmup": "1.94.2",
+    "@tramvai/module-metrics": "1.94.2",
+    "@tramvai/papi": "1.94.2",
+    "@tramvai/tokens-server": "1.94.2",
+    "@tramvai/tokens-server-private": "1.94.2",
     "compression": "^1.7.4",
     "express": "^4.17.1",
     "fastify": "^3.27.4",
@@ -40,11 +40,11 @@
   "peerDependencies": {
     "@tinkoff/dippy": "0.7.39",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "1.93.1",
-    "@tramvai/core": "1.93.1",
-    "@tramvai/module-common": "1.93.1",
-    "@tramvai/module-environment": "1.93.1",
-    "@tramvai/tokens-common": "1.93.1",
+    "@tramvai/cli": "1.94.2",
+    "@tramvai/core": "1.94.2",
+    "@tramvai/module-common": "1.94.2",
+    "@tramvai/module-environment": "1.94.2",
+    "@tramvai/tokens-common": "1.94.2",
     "tslib": "^2.0.3"
   },
   "devDependencies": {