@tramvai/module-server 2.74.0 → 2.75.0

package/README.md

@@ -188,7 +188,32 @@ Module uses loggers with identifiers: `server`, `server:static`, `server:webapp`
 
 ### Early Hints
 
-Module send the [103 Early Hints](https://developer.chrome.com/blog/early-hints) response to provide better performance, though there are several limitations (look [here](https://chromium.googlesource.com/chromium/src/+/master/docs/early-hints.md#what_s-not-supported) and [here](https://developer.chrome.com/blog/early-hints/#current-limitations)). Currently, module provides hints for next resources:
+Module can send the [103 Early Hints](https://developer.chrome.com/blog/early-hints) response to provide better performance, though there are several limitations (look [here](https://chromium.googlesource.com/chromium/src/+/master/docs/early-hints.md#what_s-not-supported) and [here](https://developer.chrome.com/blog/early-hints/#current-limitations)).
+
+If you want to enable Early Hints, provide `EARLY_HINTS_ENABLED` env variable:
+
+```
+EARLY_HINTS_ENABLED: 'true'
+```
+
+Or provide custom `EARLY_HINTS_ENABLED_TOKEN` token (`EARLY_HINTS_ENABLED` will be ignored):
+
+```ts
+import { EARLY_HINTS_ENABLED_TOKEN } from '@tramvai/tokens-server';
+
+const provider = {
+  provide: EARLY_HINTS_ENABLED_TOKEN,
+  useValue: () => true,
+};
+```
+
+:::info
+
+You must check that the balancers and proxies in front of your application support Early Hints
+
+:::
+
+Currently, module provides hints for next resources:
 
 - Resources with `preconnectLink` type;
 - General resources, which have the `preloadLink` type;

package/lib/modules/earlyHints/index.es.js

@@ -2,6 +2,8 @@ import { __decorate } from 'tslib';
 import { Module, provide, commandLineListTokens } from '@tramvai/core';
 import { EARLY_HINTS_MANAGER_TOKEN, FASTIFY_RESPONSE } from '@tramvai/tokens-server-private';
 import { RESOURCES_REGISTRY, RENDER_FLOW_AFTER_TOKEN } from '@tramvai/tokens-render';
+import { ENV_USED_TOKEN, ENV_MANAGER_TOKEN } from '@tramvai/tokens-common';
+import { EARLY_HINTS_ENABLED_TOKEN } from '@tramvai/tokens-server';
 import { EarlyHintsManager } from './service.es.js';
 
 let EarlyHintsModule = class EarlyHintsModule {
@@ -9,12 +11,32 @@ let EarlyHintsModule = class EarlyHintsModule {
 EarlyHintsModule = __decorate([
     Module({
         providers: [
+            provide({
+                provide: ENV_USED_TOKEN,
+                useValue: [
+                    {
+                        key: 'EARLY_HINTS_ENABLED',
+                        optional: true,
+                        dehydrate: false,
+                    },
+                ],
+            }),
+            provide({
+                provide: EARLY_HINTS_ENABLED_TOKEN,
+                useFactory: ({ envManager }) => {
+                    return () => envManager.get('EARLY_HINTS_ENABLED') === 'true';
+                },
+                deps: {
+                    envManager: ENV_MANAGER_TOKEN,
+                },
+            }),
             provide({
                 provide: EARLY_HINTS_MANAGER_TOKEN,
                 useClass: EarlyHintsManager,
                 deps: {
                     response: FASTIFY_RESPONSE,
                     resourcesRegistry: RESOURCES_REGISTRY,
+                    earlyHintsEnabled: EARLY_HINTS_ENABLED_TOKEN,
                 },
             }),
             provide({

package/lib/modules/earlyHints/index.js

@@ -6,6 +6,8 @@ var tslib = require('tslib');
 var core = require('@tramvai/core');
 var tokensServerPrivate = require('@tramvai/tokens-server-private');
 var tokensRender = require('@tramvai/tokens-render');
+var tokensCommon = require('@tramvai/tokens-common');
+var tokensServer = require('@tramvai/tokens-server');
 var service = require('./service.js');
 
 exports.EarlyHintsModule = class EarlyHintsModule {
@@ -13,12 +15,32 @@ exports.EarlyHintsModule = class EarlyHintsModule {
 exports.EarlyHintsModule = tslib.__decorate([
     core.Module({
         providers: [
+            core.provide({
+                provide: tokensCommon.ENV_USED_TOKEN,
+                useValue: [
+                    {
+                        key: 'EARLY_HINTS_ENABLED',
+                        optional: true,
+                        dehydrate: false,
+                    },
+                ],
+            }),
+            core.provide({
+                provide: tokensServer.EARLY_HINTS_ENABLED_TOKEN,
+                useFactory: ({ envManager }) => {
+                    return () => envManager.get('EARLY_HINTS_ENABLED') === 'true';
+                },
+                deps: {
+                    envManager: tokensCommon.ENV_MANAGER_TOKEN,
+                },
+            }),
             core.provide({
                 provide: tokensServerPrivate.EARLY_HINTS_MANAGER_TOKEN,
                 useClass: service.EarlyHintsManager,
                 deps: {
                     response: tokensServerPrivate.FASTIFY_RESPONSE,
                     resourcesRegistry: tokensRender.RESOURCES_REGISTRY,
+                    earlyHintsEnabled: tokensServer.EARLY_HINTS_ENABLED_TOKEN,
                 },
             }),
             core.provide({

package/lib/modules/earlyHints/service.d.ts

@@ -1,16 +1,21 @@
 import type { FASTIFY_RESPONSE, EARLY_HINTS_MANAGER_TOKEN } from '@tramvai/tokens-server-private';
 import type { RESOURCES_REGISTRY } from '@tramvai/tokens-render';
+import type { ExtractDependencyType } from '@tinkoff/dippy';
+import type { EARLY_HINTS_ENABLED_TOKEN } from '@tramvai/tokens-server';
 type EarlyHintsInterface = typeof EARLY_HINTS_MANAGER_TOKEN;
 type Response = typeof FASTIFY_RESPONSE;
 type ResourcesRegistry = typeof RESOURCES_REGISTRY;
+type EarlyHintsEnabled = ExtractDependencyType<typeof EARLY_HINTS_ENABLED_TOKEN>;
 interface ConstructorPayload {
     response: Response;
     resourcesRegistry: ResourcesRegistry;
+    earlyHintsEnabled: EarlyHintsEnabled;
 }
 export declare class EarlyHintsManager implements EarlyHintsInterface {
     private sentHints;
     private readonly response;
     private readonly resourcesRegistry;
+    private readonly earlyHintsEnabled;
     constructor(payload: ConstructorPayload);
     flushHints(): Promise<void>;
     private getHints;

package/lib/modules/earlyHints/service.es.js

@@ -3,8 +3,12 @@ class EarlyHintsManager {
         this.sentHints = new Set();
         this.response = payload.response;
         this.resourcesRegistry = payload.resourcesRegistry;
+        this.earlyHintsEnabled = payload.earlyHintsEnabled;
     }
     async flushHints() {
+        if (!this.earlyHintsEnabled()) {
+            return;
+        }
         const hints = this.getHints();
         await this.writeToSocket(hints);
     }

package/lib/modules/earlyHints/service.js

@@ -7,8 +7,12 @@ class EarlyHintsManager {
         this.sentHints = new Set();
         this.response = payload.response;
         this.resourcesRegistry = payload.resourcesRegistry;
+        this.earlyHintsEnabled = payload.earlyHintsEnabled;
     }
     async flushHints() {
+        if (!this.earlyHintsEnabled()) {
+            return;
+        }
         const hints = this.getHints();
         await this.writeToSocket(hints);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-server",
-  "version": "2.74.0",
+  "version": "2.75.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -21,15 +21,15 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@tinkoff/errors": "0.3.6",
+    "@tinkoff/errors": "0.3.7",
     "@tinkoff/monkeypatch": "2.0.4",
     "@tinkoff/terminus": "0.1.7",
     "@tinkoff/url": "0.8.5",
-    "@tramvai/module-cache-warmup": "2.74.0",
-    "@tramvai/module-metrics": "2.74.0",
-    "@tramvai/papi": "2.74.0",
-    "@tramvai/tokens-server": "2.74.0",
-    "@tramvai/tokens-server-private": "2.74.0",
+    "@tramvai/module-cache-warmup": "2.75.0",
+    "@tramvai/module-metrics": "2.75.0",
+    "@tramvai/papi": "2.75.0",
+    "@tramvai/tokens-server": "2.75.0",
+    "@tramvai/tokens-server-private": "2.75.0",
     "fastify": "^4.6.0",
     "@fastify/cookie": "^8.1.0",
     "@fastify/compress": "^6.1.1",
@@ -40,13 +40,13 @@
   "peerDependencies": {
     "@tinkoff/dippy": "0.8.13",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "2.74.0",
-    "@tramvai/core": "2.74.0",
-    "@tramvai/module-common": "2.74.0",
-    "@tramvai/module-environment": "2.74.0",
-    "@tramvai/tokens-common": "2.74.0",
-    "@tramvai/tokens-core-private": "2.74.0",
-    "@tramvai/tokens-render": "2.74.0",
+    "@tramvai/cli": "2.75.0",
+    "@tramvai/core": "2.75.0",
+    "@tramvai/module-common": "2.75.0",
+    "@tramvai/module-environment": "2.75.0",
+    "@tramvai/tokens-common": "2.75.0",
+    "@tramvai/tokens-core-private": "2.75.0",
+    "@tramvai/tokens-render": "2.75.0",
     "tslib": "^2.4.0"
   },
   "devDependencies": {