@tramvai/module-server 7.5.3 → 7.7.0

package/README.md

@@ -236,6 +236,36 @@ HTTP/1.1 200 OK
 
 ```
 
+### ETag header
+
+Tramvai support [ETag header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/ETag) generation for application pages - it can speed up the page loading for repeated visits.
+
+:::warning
+
+ETag generation is a heavy operation for a big pages and can negatively affect the application performance.
+
+:::
+
+:::warning
+
+ETag generation is incompatible with `@tramvai/module-opentelementry`, because request trace id is injected to the page HTML content in `<meta name="traceparent" />` tag.
+
+:::
+
+To enable ETag header, provide `ETAG_OPTIONS_TOKEN` token:
+
+```ts
+const provider = provide({
+  provide: ETAG_OPTIONS_TOKEN,
+  useValue: {
+    enabled: true,
+    // by default, ETag is generated based on the content of the page, which is not the best option for performance,
+    // you can pass `weak: true` parameter to generate weak ETag based on the hash of the initial state of the page, which can be faster
+    weak: false,
+  },
+});
+```
+
 ## How to
 
 ### Setting `keepAliveTimeout` for the server

package/lib/server/etag/fnv1a.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+/**
+ * @reference https://github.com/fastify/fastify-etag/blob/main/fnv1a.js
+ * Work faster than `etag` and `fnv-plus` libraries
+ */
+export declare function fnv1a(str: string | Buffer): number;
+//# sourceMappingURL=fnv1a.d.ts.map

package/lib/server/etag/fnv1a.es.js

@@ -0,0 +1,87 @@
+/* eslint-disable no-bitwise, @typescript-eslint/no-shadow */
+// MIT License
+//
+// Copyright (c) desudesutalk (https://github.com/desudesutalk)
+// Copyright (c) Travis Webb <me@traviswebb.com>
+// Copyright (c) SukkaW <hi@skk.moe> (https://skk.moe)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the Software
+// is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// The fnv1a implementation is created by @desudesutalk (https://github.com/desudesutalk) in
+// https://github.com/tjwebb/fnv-plus/pull/9, and contributed to Travis Webb's
+// "fnv-plus" library. @SukkaW (https://github.com/SukkaW) modifies it to support Buffers w/o
+// sacrificing performance
+/**
+ * @reference https://github.com/fastify/fastify-etag/blob/main/fnv1a.js
+ * Work faster than `etag` and `fnv-plus` libraries
+ */
+// eslint-disable-next-line max-statements
+function fnv1a(str) {
+    const l = str.length - 3;
+    let i = 0;
+    let t0 = 0;
+    let v0 = 0x9dc5;
+    let t1 = 0;
+    let v1 = 0x811c;
+    let get;
+    if (str instanceof Buffer) {
+        get = (i) => str[i];
+    }
+    else if (typeof str === 'string') {
+        get = (i) => str.charCodeAt(i);
+    }
+    else {
+        throw new TypeError('input must be a string or a buffer');
+    }
+    while (i < l) {
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+    }
+    while (i < l + 3) {
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+    }
+    return ((v1 << 16) >>> 0) + v0;
+}
+
+export { fnv1a };

package/lib/server/etag/fnv1a.js

@@ -0,0 +1,91 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/* eslint-disable no-bitwise, @typescript-eslint/no-shadow */
+// MIT License
+//
+// Copyright (c) desudesutalk (https://github.com/desudesutalk)
+// Copyright (c) Travis Webb <me@traviswebb.com>
+// Copyright (c) SukkaW <hi@skk.moe> (https://skk.moe)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the Software
+// is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// The fnv1a implementation is created by @desudesutalk (https://github.com/desudesutalk) in
+// https://github.com/tjwebb/fnv-plus/pull/9, and contributed to Travis Webb's
+// "fnv-plus" library. @SukkaW (https://github.com/SukkaW) modifies it to support Buffers w/o
+// sacrificing performance
+/**
+ * @reference https://github.com/fastify/fastify-etag/blob/main/fnv1a.js
+ * Work faster than `etag` and `fnv-plus` libraries
+ */
+// eslint-disable-next-line max-statements
+function fnv1a(str) {
+    const l = str.length - 3;
+    let i = 0;
+    let t0 = 0;
+    let v0 = 0x9dc5;
+    let t1 = 0;
+    let v1 = 0x811c;
+    let get;
+    if (str instanceof Buffer) {
+        get = (i) => str[i];
+    }
+    else if (typeof str === 'string') {
+        get = (i) => str.charCodeAt(i);
+    }
+    else {
+        throw new TypeError('input must be a string or a buffer');
+    }
+    while (i < l) {
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+    }
+    while (i < l + 3) {
+        v0 ^= get(i++);
+        t0 = v0 * 403;
+        t1 = v1 * 403;
+        t1 += v0 << 8;
+        v1 = (t1 + (t0 >>> 16)) & 65535;
+        v0 = t0 & 65535;
+    }
+    return ((v1 << 16) >>> 0) + v0;
+}
+
+exports.fnv1a = fnv1a;

package/lib/server/etag/providers.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" />
+/// <reference types="node" />
+export declare const providers: (import("@tinkoff/dippy").Provider<{
+    etagOptions: {
+        enabled: boolean;
+        weak?: boolean;
+    } & {
+        __type?: "base token";
+    };
+    storage: import("async_hooks").AsyncLocalStorage<import("@tramvai/tokens-common").AsyncLocalStorageState> & {
+        __type?: "base token";
+    };
+}, (app: import("fastify").FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>) => void> | import("@tinkoff/dippy").Provider<unknown, {
+    enabled: boolean;
+    weak?: boolean;
+} & {
+    __type?: "base token";
+}>)[];
+//# sourceMappingURL=providers.d.ts.map

package/lib/server/etag/providers.es.js

@@ -0,0 +1,63 @@
+import { provide } from '@tinkoff/dippy';
+import { REQUEST_MANAGER_TOKEN, RESPONSE_MANAGER_TOKEN, CONTEXT_TOKEN, ASYNC_LOCAL_STORAGE_TOKEN } from '@tramvai/tokens-common';
+import { ETAG_OPTIONS_TOKEN } from '@tramvai/tokens-server';
+import { WEB_FASTIFY_APP_INIT_TOKEN } from '@tramvai/tokens-server-private';
+import { fnv1a } from './fnv1a.es.js';
+
+const providers = [
+    provide({
+        provide: WEB_FASTIFY_APP_INIT_TOKEN,
+        useFactory: ({ etagOptions, storage }) => {
+            return (app) => {
+                if (!etagOptions.enabled) {
+                    return;
+                }
+                app.addHook('onSend', function (req, reply, payload, done) {
+                    const di = storage.getStore()?.tramvaiRequestDi;
+                    if (di) {
+                        const requestManager = di.get(REQUEST_MANAGER_TOKEN);
+                        const responseManager = di.get(RESPONSE_MANAGER_TOKEN);
+                        const context = di.get(CONTEXT_TOKEN);
+                        const currentEtag = responseManager.getHeader('etag');
+                        if (!currentEtag) {
+                            const prefix = etagOptions.weak ? 'W/"' : '"';
+                            const etag = `${prefix +
+                                fnv1a(etagOptions.weak
+                                    ? // TODO: customize weak strategy
+                                        JSON.stringify(context.dehydrate().dispatcher)
+                                    : responseManager.getBody()).toString(36)}"`;
+                            responseManager.setHeader('etag', etag);
+                            reply.header('etag', etag);
+                        }
+                        const etag = responseManager.getHeader('etag');
+                        const ifNoneMatch = requestManager.getHeader('if-none-match');
+                        if (ifNoneMatch === etag ||
+                            ifNoneMatch === `W/${etag}` ||
+                            `W/${ifNoneMatch}` === etag) {
+                            reply.code(304);
+                            done(null, '');
+                        }
+                        else {
+                            done(null, payload);
+                        }
+                    }
+                    else {
+                        done(null, payload);
+                    }
+                });
+            };
+        },
+        deps: {
+            etagOptions: ETAG_OPTIONS_TOKEN,
+            storage: ASYNC_LOCAL_STORAGE_TOKEN,
+        },
+    }),
+    provide({
+        provide: ETAG_OPTIONS_TOKEN,
+        useValue: {
+            enabled: false,
+        },
+    }),
+];
+
+export { providers };

package/lib/server/etag/providers.js

@@ -0,0 +1,67 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dippy = require('@tinkoff/dippy');
+var tokensCommon = require('@tramvai/tokens-common');
+var tokensServer = require('@tramvai/tokens-server');
+var tokensServerPrivate = require('@tramvai/tokens-server-private');
+var fnv1a = require('./fnv1a.js');
+
+const providers = [
+    dippy.provide({
+        provide: tokensServerPrivate.WEB_FASTIFY_APP_INIT_TOKEN,
+        useFactory: ({ etagOptions, storage }) => {
+            return (app) => {
+                if (!etagOptions.enabled) {
+                    return;
+                }
+                app.addHook('onSend', function (req, reply, payload, done) {
+                    const di = storage.getStore()?.tramvaiRequestDi;
+                    if (di) {
+                        const requestManager = di.get(tokensCommon.REQUEST_MANAGER_TOKEN);
+                        const responseManager = di.get(tokensCommon.RESPONSE_MANAGER_TOKEN);
+                        const context = di.get(tokensCommon.CONTEXT_TOKEN);
+                        const currentEtag = responseManager.getHeader('etag');
+                        if (!currentEtag) {
+                            const prefix = etagOptions.weak ? 'W/"' : '"';
+                            const etag = `${prefix +
+                                fnv1a.fnv1a(etagOptions.weak
+                                    ? // TODO: customize weak strategy
+                                        JSON.stringify(context.dehydrate().dispatcher)
+                                    : responseManager.getBody()).toString(36)}"`;
+                            responseManager.setHeader('etag', etag);
+                            reply.header('etag', etag);
+                        }
+                        const etag = responseManager.getHeader('etag');
+                        const ifNoneMatch = requestManager.getHeader('if-none-match');
+                        if (ifNoneMatch === etag ||
+                            ifNoneMatch === `W/${etag}` ||
+                            `W/${ifNoneMatch}` === etag) {
+                            reply.code(304);
+                            done(null, '');
+                        }
+                        else {
+                            done(null, payload);
+                        }
+                    }
+                    else {
+                        done(null, payload);
+                    }
+                });
+            };
+        },
+        deps: {
+            etagOptions: tokensServer.ETAG_OPTIONS_TOKEN,
+            storage: tokensCommon.ASYNC_LOCAL_STORAGE_TOKEN,
+        },
+    }),
+    dippy.provide({
+        provide: tokensServer.ETAG_OPTIONS_TOKEN,
+        useValue: {
+            enabled: false,
+        },
+    }),
+];
+
+exports.providers = providers;

package/lib/server.es.js

@@ -28,6 +28,7 @@ import { KeepAliveModule } from './modules/keepAlive.es.js';
 import { ServerTimingModule } from './modules/serverTiming.es.js';
 import { EarlyHintsModule } from './modules/earlyHints/index.es.js';
 import { ServerResponseTaskManager } from './server/taskManager.es.js';
+import { providers } from './server/etag/providers.es.js';
 
 if (typeof setDefaultResultOrder === 'function') {
     setDefaultResultOrder('ipv4first');
@@ -57,6 +58,7 @@ ServerModule = __decorate([
             process.env.NODE_ENV !== 'production' && DebugHttpRequestsModule,
         ].filter(Boolean),
         providers: [
+            ...providers,
             provide({
                 provide: SERVER_FACTORY_TOKEN,
                 scope: Scope.SINGLETON,

package/lib/server.js

@@ -31,6 +31,7 @@ var keepAlive = require('./modules/keepAlive.js');
 var serverTiming = require('./modules/serverTiming.js');
 var index = require('./modules/earlyHints/index.js');
 var taskManager = require('./server/taskManager.js');
+var providers = require('./server/etag/providers.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -64,6 +65,7 @@ exports.ServerModule = tslib.__decorate([
             process.env.NODE_ENV !== 'production' && debugRequests.DebugHttpRequestsModule,
         ].filter(Boolean),
         providers: [
+            ...providers.providers,
             core.provide({
                 provide: tokensServerPrivate.SERVER_FACTORY_TOKEN,
                 scope: core.Scope.SINGLETON,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-server",
-  "version": "7.5.3",
+  "version": "7.7.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -30,13 +30,13 @@
     "@tinkoff/monkeypatch": "7.0.1",
     "@tinkoff/terminus": "0.6.1",
     "@tinkoff/url": "0.13.1",
-    "@tramvai/module-cache-warmup": "7.5.3",
-    "@tramvai/module-metrics": "7.5.3",
-    "@tramvai/papi": "7.5.3",
+    "@tramvai/module-cache-warmup": "7.7.0",
+    "@tramvai/module-metrics": "7.7.0",
+    "@tramvai/papi": "7.7.0",
     "@tramvai/safe-strings": "0.10.1",
-    "@tramvai/tokens-router": "7.5.3",
-    "@tramvai/tokens-server": "7.5.3",
-    "@tramvai/tokens-server-private": "7.5.3",
+    "@tramvai/tokens-router": "7.7.0",
+    "@tramvai/tokens-server": "7.7.0",
+    "@tramvai/tokens-server-private": "7.7.0",
     "afterframe": "^1.0.2",
     "fastify": "^5.6.2",
     "http-proxy-middleware": "^2.0.2",
@@ -45,14 +45,14 @@
   "peerDependencies": {
     "@tinkoff/dippy": "0.13.2",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "7.5.3",
-    "@tramvai/core": "7.5.3",
-    "@tramvai/module-common": "7.5.3",
-    "@tramvai/module-environment": "7.5.3",
-    "@tramvai/react": "7.5.3",
-    "@tramvai/tokens-common": "7.5.3",
-    "@tramvai/tokens-core-private": "7.5.3",
-    "@tramvai/tokens-render": "7.5.3",
+    "@tramvai/cli": "7.7.0",
+    "@tramvai/core": "7.7.0",
+    "@tramvai/module-common": "7.7.0",
+    "@tramvai/module-environment": "7.7.0",
+    "@tramvai/react": "7.7.0",
+    "@tramvai/tokens-common": "7.7.0",
+    "@tramvai/tokens-core-private": "7.7.0",
+    "@tramvai/tokens-render": "7.7.0",
     "react": ">=16.14.0",
     "react-dom": ">=16.14.0",
     "tslib": "^2.4.0"