@tramvai/module-page-render-mode 2.70.0 → 2.72.0

package/lib/staticPages.js

@@ -0,0 +1,238 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var isEmpty = require('@tinkoff/utils/is/empty');
+var core = require('@tramvai/core');
+var tokensCommon = require('@tramvai/tokens-common');
+var tokensServerPrivate = require('@tramvai/tokens-server-private');
+var tokensRender = require('@tramvai/tokens-render');
+var tokensRouter = require('@tramvai/tokens-router');
+var moduleClientHints = require('@tramvai/module-client-hints');
+var tokensServer = require('@tramvai/tokens-server');
+var tokensMetrics = require('@tramvai/tokens-metrics');
+var papi = require('@tramvai/papi');
+var error = require('./error.js');
+var tokens = require('./tokens.js');
+var getPageRenderMode = require('./utils/getPageRenderMode.js');
+var cacheKey = require('./utils/cacheKey.js');
+var backgroundFetchService = require('./staticPages/backgroundFetchService.js');
+var staticPagesService = require('./staticPages/staticPagesService.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var isEmpty__default = /*#__PURE__*/_interopDefaultLegacy(isEmpty);
+
+const STATIC_PAGES_BACKGROUND_FETCH_SERVICE = core.createToken();
+const STATIC_PAGES_GET_CACHE_KEY_TOKEN = core.createToken();
+const STATIC_PAGES_CACHE_HIT_METRIC_TOKEN = core.createToken();
+const STATIC_PAGES_SERVICE = core.createToken();
+const staticPagesProviders = [
+    core.provide({
+        provide: STATIC_PAGES_CACHE_HIT_METRIC_TOKEN,
+        scope: core.Scope.SINGLETON,
+        useFactory: ({ metrics }) => {
+            return metrics.counter({
+                name: 'static_pages_cache_hit',
+                help: 'Total static pages returned from cache',
+                labelNames: [],
+            });
+        },
+        deps: {
+            metrics: tokensMetrics.METRICS_MODULE_TOKEN,
+        },
+    }),
+    core.provide({
+        provide: tokens.STATIC_PAGES_CACHE_TOKEN,
+        scope: core.Scope.SINGLETON,
+        useFactory: ({ createCache, staticPagesOptions }) => {
+            return createCache('memory', {
+                max: staticPagesOptions.maxSize,
+            });
+        },
+        deps: {
+            createCache: tokensCommon.CREATE_CACHE_TOKEN,
+            staticPagesOptions: tokens.STATIC_PAGES_OPTIONS_TOKEN,
+        },
+    }),
+    core.provide({
+        provide: tokens.STATIC_PAGES_OPTIONS_TOKEN,
+        useValue: {
+            // @TODO: свой ttl для отдельных страниц
+            ttl: 60 * 1000,
+            maxSize: 1000,
+        },
+    }),
+    core.provide({
+        provide: STATIC_PAGES_GET_CACHE_KEY_TOKEN,
+        useFactory: ({ requestManager, userAgent, modern }) => {
+            return () => {
+                const deviceType = userAgent.mobileOS ? 'mobile' : 'desktop';
+                return cacheKey.getCacheKey({
+                    method: requestManager.getMethod(),
+                    host: requestManager.getHost(),
+                    path: requestManager.getParsedUrl().pathname,
+                    deviceType,
+                    modern,
+                });
+            };
+        },
+        deps: {
+            requestManager: tokensCommon.REQUEST_MANAGER_TOKEN,
+            userAgent: moduleClientHints.USER_AGENT_TOKEN,
+            modern: tokensRender.MODERN_SATISFIES_TOKEN,
+        },
+    }),
+    core.provide({
+        provide: tokens.STATIC_PAGES_SHOULD_SET_TO_CACHE,
+        useFactory: ({ requestManager }) => {
+            return () => {
+                return isEmpty__default["default"](requestManager.getCookies());
+            };
+        },
+        deps: {
+            requestManager: tokensCommon.REQUEST_MANAGER_TOKEN,
+        },
+    }),
+    core.provide({
+        provide: tokens.STATIC_PAGES_SHOULD_USE_CACHE,
+        useFactory: ({ requestManager }) => {
+            return () => {
+                return !requestManager.getHeader('x-tramvai-static-page-revalidate');
+            };
+        },
+        deps: {
+            requestManager: tokensCommon.REQUEST_MANAGER_TOKEN,
+        },
+    }),
+    core.provide({
+        provide: tokens.STATIC_PAGES_BACKGROUND_FETCH_ENABLED,
+        useValue: () => {
+            return true;
+        },
+    }),
+    core.provide({
+        provide: tokens.STATIC_PAGES_CACHE_5xx_RESPONSE,
+        useValue: () => {
+            return false;
+        },
+    }),
+    core.provide({
+        provide: STATIC_PAGES_BACKGROUND_FETCH_SERVICE,
+        scope: core.Scope.REQUEST,
+        useClass: backgroundFetchService.BackgroundFetchService,
+        deps: {
+            logger: tokensCommon.LOGGER_TOKEN,
+            backgroundFetchEnabled: tokens.STATIC_PAGES_BACKGROUND_FETCH_ENABLED,
+        },
+    }),
+    core.provide({
+        provide: STATIC_PAGES_SERVICE,
+        scope: core.Scope.REQUEST,
+        useClass: staticPagesService.StaticPagesService,
+        deps: {
+            getCacheKey: STATIC_PAGES_GET_CACHE_KEY_TOKEN,
+            requestManager: tokensCommon.REQUEST_MANAGER_TOKEN,
+            responseManager: tokensCommon.RESPONSE_MANAGER_TOKEN,
+            response: tokensServerPrivate.FASTIFY_RESPONSE,
+            environmentManager: tokensCommon.ENV_MANAGER_TOKEN,
+            userAgent: moduleClientHints.USER_AGENT_TOKEN,
+            modern: tokensRender.MODERN_SATISFIES_TOKEN,
+            logger: tokensCommon.LOGGER_TOKEN,
+            cache: tokens.STATIC_PAGES_CACHE_TOKEN,
+            modifyCache: { token: tokens.STATIC_PAGES_MODIFY_CACHE, optional: true },
+            shouldUseCache: tokens.STATIC_PAGES_SHOULD_USE_CACHE,
+            shouldSetToCache: tokens.STATIC_PAGES_SHOULD_SET_TO_CACHE,
+            backgroundFetchService: STATIC_PAGES_BACKGROUND_FETCH_SERVICE,
+            options: tokens.STATIC_PAGES_OPTIONS_TOKEN,
+            cache5xxResponse: tokens.STATIC_PAGES_CACHE_5xx_RESPONSE,
+        },
+    }),
+    core.provide({
+        provide: core.commandLineListTokens.init,
+        multi: true,
+        scope: core.Scope.SINGLETON,
+        useFactory: ({ di, staticPagesCommandLine }) => {
+            return function registerResponseCacheHandler() {
+                di.register({
+                    provide: staticPagesCommandLine
+                        ? core.commandLineListTokens[staticPagesCommandLine]
+                        : core.commandLineListTokens.customerStart,
+                    useFactory: ({ staticPagesService, staticPagesCacheHitMetric, logger }) => {
+                        logger('static-pages');
+                        return function staticPagesFromCache() {
+                            if (staticPagesService.shouldUseCache()) {
+                                staticPagesService.respond(() => {
+                                    // @TODO: маска урла на этом этапе?
+                                    staticPagesCacheHitMetric.inc();
+                                    throw new error.StopCommandLineRunnerError();
+                                });
+                            }
+                        };
+                    },
+                    deps: {
+                        staticPagesService: STATIC_PAGES_SERVICE,
+                        staticPagesCacheHitMetric: STATIC_PAGES_CACHE_HIT_METRIC_TOKEN,
+                        logger: tokensCommon.LOGGER_TOKEN,
+                    },
+                });
+            };
+        },
+        deps: {
+            di: core.DI_TOKEN,
+            staticPagesCommandLine: { token: tokens.STATIC_PAGES_COMMAND_LINE, optional: true },
+        },
+    }),
+    core.provide({
+        provide: core.commandLineListTokens.clear,
+        useFactory: ({ staticPagesService, pageService, defaultRenderMode }) => {
+            return function cacheStaticPages() {
+                const isStaticPage = getPageRenderMode.getPageRenderMode({ pageService, defaultRenderMode }) === 'static';
+                if (!isStaticPage) {
+                    return;
+                }
+                if (staticPagesService.shouldSetToCache()) {
+                    staticPagesService.saveResponse();
+                }
+                else {
+                    staticPagesService.revalidate();
+                }
+            };
+        },
+        deps: {
+            staticPagesService: STATIC_PAGES_SERVICE,
+            pageService: tokensRouter.PAGE_SERVICE_TOKEN,
+            defaultRenderMode: tokens.PAGE_RENDER_DEFAULT_MODE,
+        },
+    }),
+    core.provide({
+        provide: tokensServer.SERVER_MODULE_PAPI_PRIVATE_ROUTE,
+        useFactory: ({ staticPagesCache }) => {
+            return papi.createPapiMethod({
+                path: '/revalidate/',
+                method: 'post',
+                async handler({ body = {} }) {
+                    const { path } = body;
+                    const pathKey = `/${path}/`;
+                    if (!path) {
+                        staticPagesCache.clear();
+                    }
+                    else if (staticPagesCache.has(pathKey)) {
+                        staticPagesCache.set(pathKey, new Map());
+                        // @TODO: revalidate request with background fetch?
+                    }
+                    return 'Success';
+                },
+            });
+        },
+        deps: {
+            staticPagesCache: tokens.STATIC_PAGES_CACHE_TOKEN,
+        },
+    }),
+];
+
+exports.STATIC_PAGES_BACKGROUND_FETCH_SERVICE = STATIC_PAGES_BACKGROUND_FETCH_SERVICE;
+exports.STATIC_PAGES_CACHE_HIT_METRIC_TOKEN = STATIC_PAGES_CACHE_HIT_METRIC_TOKEN;
+exports.STATIC_PAGES_GET_CACHE_KEY_TOKEN = STATIC_PAGES_GET_CACHE_KEY_TOKEN;
+exports.STATIC_PAGES_SERVICE = STATIC_PAGES_SERVICE;
+exports.staticPagesProviders = staticPagesProviders;

package/lib/tokens.browser.js

@@ -0,0 +1,19 @@
+import { createToken } from '@tinkoff/dippy';
+
+const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = createToken('pageRenderFallbackComponentName');
+/**
+ * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
+ */
+const PAGE_RENDER_DEFAULT_MODE = createToken('pageRenderDefaultMode');
+const PAGE_RENDER_WRAPPER_TYPE = createToken('pageRenderWrapperType');
+const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = createToken('pageRenderDefaultFallbackComponent');
+const STATIC_PAGES_CACHE_TOKEN = createToken('static pages cache');
+const STATIC_PAGES_SHOULD_USE_CACHE = createToken('static pages should use cache');
+const STATIC_PAGES_SHOULD_SET_TO_CACHE = createToken('static pages should set to cache');
+const STATIC_PAGES_BACKGROUND_FETCH_ENABLED = createToken('static pages can fetch page');
+const STATIC_PAGES_OPTIONS_TOKEN = createToken('static pages options');
+const STATIC_PAGES_COMMAND_LINE = createToken('static pages command line');
+const STATIC_PAGES_MODIFY_CACHE = createToken('static pages modify cache', { multi: true });
+const STATIC_PAGES_CACHE_5xx_RESPONSE = createToken('static pages cache 5xx response');
+
+export { PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT, PAGE_RENDER_DEFAULT_MODE, PAGE_RENDER_FALLBACK_COMPONENT_PREFIX, PAGE_RENDER_WRAPPER_TYPE, STATIC_PAGES_BACKGROUND_FETCH_ENABLED, STATIC_PAGES_CACHE_5xx_RESPONSE, STATIC_PAGES_CACHE_TOKEN, STATIC_PAGES_COMMAND_LINE, STATIC_PAGES_MODIFY_CACHE, STATIC_PAGES_OPTIONS_TOKEN, STATIC_PAGES_SHOULD_SET_TO_CACHE, STATIC_PAGES_SHOULD_USE_CACHE };

package/lib/tokens.es.js

@@ -0,0 +1,19 @@
+import { createToken } from '@tinkoff/dippy';
+
+const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = createToken('pageRenderFallbackComponentName');
+/**
+ * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
+ */
+const PAGE_RENDER_DEFAULT_MODE = createToken('pageRenderDefaultMode');
+const PAGE_RENDER_WRAPPER_TYPE = createToken('pageRenderWrapperType');
+const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = createToken('pageRenderDefaultFallbackComponent');
+const STATIC_PAGES_CACHE_TOKEN = createToken('static pages cache');
+const STATIC_PAGES_SHOULD_USE_CACHE = createToken('static pages should use cache');
+const STATIC_PAGES_SHOULD_SET_TO_CACHE = createToken('static pages should set to cache');
+const STATIC_PAGES_BACKGROUND_FETCH_ENABLED = createToken('static pages can fetch page');
+const STATIC_PAGES_OPTIONS_TOKEN = createToken('static pages options');
+const STATIC_PAGES_COMMAND_LINE = createToken('static pages command line');
+const STATIC_PAGES_MODIFY_CACHE = createToken('static pages modify cache', { multi: true });
+const STATIC_PAGES_CACHE_5xx_RESPONSE = createToken('static pages cache 5xx response');
+
+export { PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT, PAGE_RENDER_DEFAULT_MODE, PAGE_RENDER_FALLBACK_COMPONENT_PREFIX, PAGE_RENDER_WRAPPER_TYPE, STATIC_PAGES_BACKGROUND_FETCH_ENABLED, STATIC_PAGES_CACHE_5xx_RESPONSE, STATIC_PAGES_CACHE_TOKEN, STATIC_PAGES_COMMAND_LINE, STATIC_PAGES_MODIFY_CACHE, STATIC_PAGES_OPTIONS_TOKEN, STATIC_PAGES_SHOULD_SET_TO_CACHE, STATIC_PAGES_SHOULD_USE_CACHE };

package/lib/tokens.js

@@ -0,0 +1,34 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dippy = require('@tinkoff/dippy');
+
+const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = dippy.createToken('pageRenderFallbackComponentName');
+/**
+ * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
+ */
+const PAGE_RENDER_DEFAULT_MODE = dippy.createToken('pageRenderDefaultMode');
+const PAGE_RENDER_WRAPPER_TYPE = dippy.createToken('pageRenderWrapperType');
+const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = dippy.createToken('pageRenderDefaultFallbackComponent');
+const STATIC_PAGES_CACHE_TOKEN = dippy.createToken('static pages cache');
+const STATIC_PAGES_SHOULD_USE_CACHE = dippy.createToken('static pages should use cache');
+const STATIC_PAGES_SHOULD_SET_TO_CACHE = dippy.createToken('static pages should set to cache');
+const STATIC_PAGES_BACKGROUND_FETCH_ENABLED = dippy.createToken('static pages can fetch page');
+const STATIC_PAGES_OPTIONS_TOKEN = dippy.createToken('static pages options');
+const STATIC_PAGES_COMMAND_LINE = dippy.createToken('static pages command line');
+const STATIC_PAGES_MODIFY_CACHE = dippy.createToken('static pages modify cache', { multi: true });
+const STATIC_PAGES_CACHE_5xx_RESPONSE = dippy.createToken('static pages cache 5xx response');
+
+exports.PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT;
+exports.PAGE_RENDER_DEFAULT_MODE = PAGE_RENDER_DEFAULT_MODE;
+exports.PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = PAGE_RENDER_FALLBACK_COMPONENT_PREFIX;
+exports.PAGE_RENDER_WRAPPER_TYPE = PAGE_RENDER_WRAPPER_TYPE;
+exports.STATIC_PAGES_BACKGROUND_FETCH_ENABLED = STATIC_PAGES_BACKGROUND_FETCH_ENABLED;
+exports.STATIC_PAGES_CACHE_5xx_RESPONSE = STATIC_PAGES_CACHE_5xx_RESPONSE;
+exports.STATIC_PAGES_CACHE_TOKEN = STATIC_PAGES_CACHE_TOKEN;
+exports.STATIC_PAGES_COMMAND_LINE = STATIC_PAGES_COMMAND_LINE;
+exports.STATIC_PAGES_MODIFY_CACHE = STATIC_PAGES_MODIFY_CACHE;
+exports.STATIC_PAGES_OPTIONS_TOKEN = STATIC_PAGES_OPTIONS_TOKEN;
+exports.STATIC_PAGES_SHOULD_SET_TO_CACHE = STATIC_PAGES_SHOULD_SET_TO_CACHE;
+exports.STATIC_PAGES_SHOULD_USE_CACHE = STATIC_PAGES_SHOULD_USE_CACHE;

package/lib/utils/cacheKey.es.js

@@ -0,0 +1,5 @@
+const getCacheKey = ({ method, host, path, deviceType, modern, }) => {
+    return `${method}=${host}=${path}=${deviceType}=${modern ? 'modern' : 'default'}`;
+};
+
+export { getCacheKey };

package/lib/utils/cacheKey.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const getCacheKey = ({ method, host, path, deviceType, modern, }) => {
+    return `${method}=${host}=${path}=${deviceType}=${modern ? 'modern' : 'default'}`;
+};
+
+exports.getCacheKey = getCacheKey;

package/lib/utils/getPageRenderMode.browser.js

@@ -0,0 +1,9 @@
+const getPageRenderMode = ({ pageService, defaultRenderMode, }) => {
+    var _a;
+    const { pageComponent, pageRenderMode } = pageService.getConfig();
+    const { renderMode } = (_a = pageService.getComponent(pageComponent)) !== null && _a !== void 0 ? _a : {};
+    const mode = pageRenderMode || renderMode || defaultRenderMode;
+    return mode;
+};
+
+export { getPageRenderMode };

package/lib/utils/getPageRenderMode.es.js

@@ -0,0 +1,9 @@
+const getPageRenderMode = ({ pageService, defaultRenderMode, }) => {
+    var _a;
+    const { pageComponent, pageRenderMode } = pageService.getConfig();
+    const { renderMode } = (_a = pageService.getComponent(pageComponent)) !== null && _a !== void 0 ? _a : {};
+    const mode = pageRenderMode || renderMode || defaultRenderMode;
+    return mode;
+};
+
+export { getPageRenderMode };

package/lib/utils/getPageRenderMode.js

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const getPageRenderMode = ({ pageService, defaultRenderMode, }) => {
+    var _a;
+    const { pageComponent, pageRenderMode } = pageService.getConfig();
+    const { renderMode } = (_a = pageService.getComponent(pageComponent)) !== null && _a !== void 0 ? _a : {};
+    const mode = pageRenderMode || renderMode || defaultRenderMode;
+    return mode;
+};
+
+exports.getPageRenderMode = getPageRenderMode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-page-render-mode",
-  "version": "2.70.0",
+  "version": "2.72.0",
   "description": "Enable different rendering modes for pages",
   "main": "./lib/server.js",
   "module": "./lib/server.es.js",
@@ -16,33 +16,32 @@
   },
   "license": "Apache-2.0",
   "scripts": {
-    "build": "tramvai-build --for-publish",
-    "watch": "tsc -w",
-    "build-for-publish": "true"
+    "build": "tramvai-build --forPublish --preserveModules",
+    "watch": "tsc -w"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
     "node-fetch": "^2.6.1",
-    "@tinkoff/errors": "0.3.5",
-    "@tinkoff/url": "0.8.4"
+    "@tinkoff/errors": "0.3.6",
+    "@tinkoff/url": "0.8.5"
   },
   "peerDependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tinkoff/dippy": "0.8.12",
-    "@tramvai/core": "2.70.0",
-    "@tramvai/react": "2.70.0",
-    "@tramvai/papi": "2.70.0",
-    "@tramvai/module-router": "2.70.0",
-    "@tramvai/module-client-hints": "2.70.0",
-    "@tramvai/tokens-common": "2.70.0",
-    "@tramvai/tokens-core": "2.70.0",
-    "@tramvai/tokens-render": "2.70.0",
-    "@tramvai/tokens-router": "2.70.0",
-    "@tramvai/tokens-server": "2.70.0",
-    "@tramvai/tokens-server-private": "2.70.0",
-    "@tramvai/tokens-metrics": "2.70.0",
+    "@tinkoff/dippy": "0.8.13",
+    "@tramvai/core": "2.72.0",
+    "@tramvai/react": "2.72.0",
+    "@tramvai/papi": "2.72.0",
+    "@tramvai/module-router": "2.72.0",
+    "@tramvai/module-client-hints": "2.72.0",
+    "@tramvai/tokens-common": "2.72.0",
+    "@tramvai/tokens-core": "2.72.0",
+    "@tramvai/tokens-render": "2.72.0",
+    "@tramvai/tokens-router": "2.72.0",
+    "@tramvai/tokens-server": "2.72.0",
+    "@tramvai/tokens-server-private": "2.72.0",
+    "@tramvai/tokens-metrics": "2.72.0",
     "prom-client": "^12.0.0",
     "react": ">=16.14.0",
     "tslib": "^2.4.0"