@tramvai/module-http-client 6.63.1 → 6.65.0

package/lib/httpClient/headers.browser.js

@@ -1,7 +1,7 @@
 import { createUserAgent } from './createUserAgent.browser.js';
 
 /**
- * `node-fetch` sends "User-Agent: node-fetch" header
+ * nodejs sends "User-Agent: node" header
  * on the server by default. For logging purpose, we are
  * replacing "User-Agent" value with custom one, containing
  * both application name and version.

package/lib/httpClient/headers.d.ts

@@ -2,7 +2,7 @@ import type { ExtractDependencyType } from '@tinkoff/dippy';
 import type { ENV_MANAGER_TOKEN } from '@tramvai/tokens-common';
 import type { APP_INFO_TOKEN } from '@tramvai/tokens-core';
 /**
- * `node-fetch` sends "User-Agent: node-fetch" header
+ * nodejs sends "User-Agent: node" header
  * on the server by default. For logging purpose, we are
  * replacing "User-Agent" value with custom one, containing
  * both application name and version.

package/lib/httpClient/headers.es.js

@@ -1,7 +1,7 @@
 import { createUserAgent } from './createUserAgent.es.js';
 
 /**
- * `node-fetch` sends "User-Agent: node-fetch" header
+ * nodejs sends "User-Agent: node" header
  * on the server by default. For logging purpose, we are
  * replacing "User-Agent" value with custom one, containing
  * both application name and version.

package/lib/httpClient/headers.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var createUserAgent = require('./createUserAgent.js');
 
 /**
- * `node-fetch` sends "User-Agent: node-fetch" header
+ * nodejs sends "User-Agent: node" header
  * on the server by default. For logging purpose, we are
  * replacing "User-Agent" value with custom one, containing
  * both application name and version.

package/lib/httpClient/httpClientFactory.browser.js

@@ -33,7 +33,6 @@ const httpClientFactory = ({ logger, envManager, appInfo, requestManager, header
                 failureThreshold: 75,
                 minimumFailureCount: 10,
             },
-            // TODO: remove any after [resolving](https://github.com/southpolesteve/node-abort-controller/issues/31)
             signal: commandLineExecutionContext?.()?.abortSignal,
             ...environmentDependentOptions,
         }, defaultOptions ? mergeOptions(defaultOptions, interceptors) : interceptors), options);

package/lib/httpClient/httpClientFactory.es.js

@@ -33,7 +33,6 @@ const httpClientFactory = ({ logger, envManager, appInfo, requestManager, header
                 failureThreshold: 75,
                 minimumFailureCount: 10,
             },
-            // TODO: remove any after [resolving](https://github.com/southpolesteve/node-abort-controller/issues/31)
             signal: commandLineExecutionContext?.()?.abortSignal,
             ...environmentDependentOptions,
         }, defaultOptions ? mergeOptions(defaultOptions, interceptors) : interceptors), options);

package/lib/httpClient/httpClientFactory.js

@@ -42,7 +42,6 @@ const httpClientFactory = ({ logger, envManager, appInfo, requestManager, header
                 failureThreshold: 75,
                 minimumFailureCount: 10,
             },
-            // TODO: remove any after [resolving](https://github.com/southpolesteve/node-abort-controller/issues/31)
             signal: commandLineExecutionContext?.()?.abortSignal,
             ...environmentDependentOptions,
         }, defaultOptions ? tinkoffRequestHttpClientAdapter.mergeOptions(defaultOptions, interceptors) : interceptors), options);

package/lib/httpClientModule.browser.d.ts

@@ -0,0 +1,4 @@
+export declare const HttpClientModule: import("@tinkoff/dippy/lib/modules/module.h").ModuleClass & Partial<import("@tinkoff/dippy/lib/modules/module.h").ModuleSecretParameters> & {
+    [x: string]: (...args: any[]) => import("@tinkoff/dippy").ModuleType;
+};
+//# sourceMappingURL=httpClientModule.browser.d.ts.map

package/lib/httpClientModule.browser.js

@@ -1,113 +1,54 @@
-import { createToken } from '@tinkoff/dippy';
-import { Module, provide, APP_INFO_TOKEN, Scope } from '@tramvai/core';
-import { HTTP_CLIENT_FACTORY, API_CLIENT_PASS_HEADERS, HTTP_CLIENT_AGENT, DISABLE_CIRCUIT_BREAKER, DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS, DEFAULT_HTTP_CLIENT_INTERCEPTORS, HTTP_CLIENT } from '@tramvai/tokens-http-client';
-import { LOGGER_TOKEN, ENV_MANAGER_TOKEN, REQUEST_MANAGER_TOKEN, COMMAND_LINE_EXECUTION_CONTEXT_TOKEN, ENV_USED_TOKEN, CREATE_CACHE_TOKEN } from '@tramvai/tokens-common';
-import { httpClientFactory } from './httpClient/httpClientFactory.browser.js';
+import { declareModule, provide, commandLineListTokens, optional } from '@tramvai/core';
+import { HTTP_CLIENT_AGENT, HTTP_CLIENT_AGENT_OPTIONS, HTTP_CLIENT_AGENT_INTERCEPTORS } from '@tramvai/tokens-http-client';
 import { PapiClientModule } from './papiClientModule.browser.browser.js';
+import { providers } from './shared.browser.js';
 
-const createCacheToken = createToken('httpClient createCache');
-const HttpClientModule = /* @__PURE__ */ Module({
+const HttpClientModule = /* @__PURE__ */ declareModule({
+    name: 'HttpClientModule',
     imports: [PapiClientModule],
     providers: [
-        provide({
-            provide: HTTP_CLIENT_FACTORY,
-            useFactory: httpClientFactory,
-            deps: {
-                logger: LOGGER_TOKEN,
-                envManager: ENV_MANAGER_TOKEN,
-                appInfo: APP_INFO_TOKEN,
-                createCache: createCacheToken,
-                makeRequestRegistry: 'makeRequestRegistry',
-                requestManager: {
-                    token: REQUEST_MANAGER_TOKEN,
-                    optional: true,
-                },
-                headersList: {
-                    token: API_CLIENT_PASS_HEADERS,
-                    optional: true,
-                },
-                agent: {
-                    token: HTTP_CLIENT_AGENT,
-                    optional: true,
-                },
-                disableCircuitBreaker: {
-                    token: DISABLE_CIRCUIT_BREAKER,
-                    optional: true,
-                },
-                defaultOptions: {
-                    token: DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS,
-                    optional: true,
-                },
-                defaultInterceptors: {
-                    token: DEFAULT_HTTP_CLIENT_INTERCEPTORS,
-                    optional: true,
-                },
-                commandLineExecutionContext: {
-                    token: COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
-                    optional: true,
-                },
-            },
-        }),
-        provide({
-            provide: HTTP_CLIENT,
-            useFactory: ({ factory }) => {
-                return factory({
-                    name: 'http-client',
-                    enableCircuitBreaker: false,
-                });
-            },
-            deps: {
-                factory: HTTP_CLIENT_FACTORY,
-            },
-        }),
-        provide({
-            provide: ENV_USED_TOKEN,
-            useValue: [
-                { key: 'HTTP_CLIENT_CACHE_DISABLED', optional: true, dehydrate: false },
-                { key: 'HTTP_CLIENT_CIRCUIT_BREAKER_DISABLED', optional: true, dehydrate: false },
-            ],
-        }),
-        /**
-         * хранилище для экземпляров @tinkoff/request
-         *
-         * требуется хранить экземпляры в единственном виде,
-         * т.к. многие плагины @tinkoff/request после инициализации имеют состояние
-         * (cache, circuit breaker), и не будут корректно работать на сервере,
-         * если создавать новые экземпляры на Scope.REQUEST
-         */
-        provide({
-            provide: 'makeRequestRegistry',
-            scope: Scope.SINGLETON,
-            useFactory: () => new Map(),
-        }),
-        /**
-         * `CREATE_CACHE_TOKEN` имеет проверку, если токен используется провайдером,
-         * который имеет Scope.SINGLETON, то инстанс кэша сохраняется в общее хранилище,
-         * и доступен для очистки через `/papi/clear-cache`.
-         * Scope.REQUEST игнорируется, т.к. это верная утечка памяти,
-         * инстансов кэши было бы неограниченное количество.
-         *
-         * HTTP клиенты создаются со Scope.REQUEST, но инстансы @tinkoff/request
-         * (и соответственно кэшей) создаются только один раз, благодаря `makeRequestRegistry`.
-         * это гарантирует отсутствие утечек памяти, поэтому мы обходим проверку
-         * на Scope.SINGLETON c помощью обертки `createCacheToken`
-         */
-        provide({
-            provide: createCacheToken,
-            scope: Scope.SINGLETON,
-            useFactory: ({ createCache }) => {
-                return createCache;
-            },
-            deps: {
-                createCache: CREATE_CACHE_TOKEN,
-            },
-        }),
-        provide({
-            provide: API_CLIENT_PASS_HEADERS,
-            useValue: ['x-request-id'],
-        }),
+        ...providers,
+        // we can't separate this module to browser and server files through "browser"
+        // package.json field, because jest not supports this field resolving out of the box
+        // and many unit tests rely on jsdom environment and fails because of resolving to server version
+        // TODO: separate jest preset for jsdom unit tests with custom resolver to support "browser" field
+        // @see https://github.com/marko-js/jest/blob/main/src/preset/browser/jest-preset.ts
+        ...(typeof window === 'undefined'
+            ? [
+                provide({
+                    provide: commandLineListTokens.init,
+                    useFactory: ({ agent }) => {
+                        return () => {
+                            const { setGlobalDispatcher } = require('undici');
+                            setGlobalDispatcher(agent.http);
+                        };
+                    },
+                    deps: {
+                        agent: HTTP_CLIENT_AGENT,
+                    },
+                }),
+                provide({
+                    provide: HTTP_CLIENT_AGENT,
+                    useFactory: ({ options, interceptors }) => {
+                        const { Agent } = require('undici');
+                        const agent = new Agent(options).compose(...(interceptors ?? []));
+                        return {
+                            http: agent,
+                            https: agent,
+                        };
+                    },
+                    deps: {
+                        options: HTTP_CLIENT_AGENT_OPTIONS,
+                        interceptors: optional(HTTP_CLIENT_AGENT_INTERCEPTORS),
+                    },
+                }),
+                provide({
+                    provide: HTTP_CLIENT_AGENT_OPTIONS,
+                    useValue: {},
+                }),
+            ]
+            : []),
     ],
-})(class HttpClientModule {
 });
 
 export { HttpClientModule };

package/lib/httpClientModule.d.ts

@@ -1,4 +1,4 @@
-export declare const HttpClientModule: import("@tinkoff/dippy").ModuleType<{
-    new (): {};
-}>;
+export declare const HttpClientModule: import("@tinkoff/dippy/lib/modules/module.h").ModuleClass & Partial<import("@tinkoff/dippy/lib/modules/module.h").ModuleSecretParameters> & {
+    [x: string]: (...args: any[]) => import("@tramvai/core").ModuleType;
+};
 //# sourceMappingURL=httpClientModule.d.ts.map

package/lib/httpClientModule.es.js

@@ -1,113 +1,54 @@
-import { createToken } from '@tinkoff/dippy';
-import { Module, provide, APP_INFO_TOKEN, Scope } from '@tramvai/core';
-import { HTTP_CLIENT_FACTORY, API_CLIENT_PASS_HEADERS, HTTP_CLIENT_AGENT, DISABLE_CIRCUIT_BREAKER, DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS, DEFAULT_HTTP_CLIENT_INTERCEPTORS, HTTP_CLIENT } from '@tramvai/tokens-http-client';
-import { LOGGER_TOKEN, ENV_MANAGER_TOKEN, REQUEST_MANAGER_TOKEN, COMMAND_LINE_EXECUTION_CONTEXT_TOKEN, ENV_USED_TOKEN, CREATE_CACHE_TOKEN } from '@tramvai/tokens-common';
-import { httpClientFactory } from './httpClient/httpClientFactory.es.js';
+import { declareModule, provide, commandLineListTokens, optional } from '@tramvai/core';
+import { HTTP_CLIENT_AGENT, HTTP_CLIENT_AGENT_OPTIONS, HTTP_CLIENT_AGENT_INTERCEPTORS } from '@tramvai/tokens-http-client';
 import { PapiClientModule } from './papiClientModule.es.js';
+import { providers } from './shared.es.js';
 
-const createCacheToken = createToken('httpClient createCache');
-const HttpClientModule = /* @__PURE__ */ Module({
+const HttpClientModule = /* @__PURE__ */ declareModule({
+    name: 'HttpClientModule',
     imports: [PapiClientModule],
     providers: [
-        provide({
-            provide: HTTP_CLIENT_FACTORY,
-            useFactory: httpClientFactory,
-            deps: {
-                logger: LOGGER_TOKEN,
-                envManager: ENV_MANAGER_TOKEN,
-                appInfo: APP_INFO_TOKEN,
-                createCache: createCacheToken,
-                makeRequestRegistry: 'makeRequestRegistry',
-                requestManager: {
-                    token: REQUEST_MANAGER_TOKEN,
-                    optional: true,
-                },
-                headersList: {
-                    token: API_CLIENT_PASS_HEADERS,
-                    optional: true,
-                },
-                agent: {
-                    token: HTTP_CLIENT_AGENT,
-                    optional: true,
-                },
-                disableCircuitBreaker: {
-                    token: DISABLE_CIRCUIT_BREAKER,
-                    optional: true,
-                },
-                defaultOptions: {
-                    token: DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS,
-                    optional: true,
-                },
-                defaultInterceptors: {
-                    token: DEFAULT_HTTP_CLIENT_INTERCEPTORS,
-                    optional: true,
-                },
-                commandLineExecutionContext: {
-                    token: COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
-                    optional: true,
-                },
-            },
-        }),
-        provide({
-            provide: HTTP_CLIENT,
-            useFactory: ({ factory }) => {
-                return factory({
-                    name: 'http-client',
-                    enableCircuitBreaker: false,
-                });
-            },
-            deps: {
-                factory: HTTP_CLIENT_FACTORY,
-            },
-        }),
-        provide({
-            provide: ENV_USED_TOKEN,
-            useValue: [
-                { key: 'HTTP_CLIENT_CACHE_DISABLED', optional: true, dehydrate: false },
-                { key: 'HTTP_CLIENT_CIRCUIT_BREAKER_DISABLED', optional: true, dehydrate: false },
-            ],
-        }),
-        /**
-         * хранилище для экземпляров @tinkoff/request
-         *
-         * требуется хранить экземпляры в единственном виде,
-         * т.к. многие плагины @tinkoff/request после инициализации имеют состояние
-         * (cache, circuit breaker), и не будут корректно работать на сервере,
-         * если создавать новые экземпляры на Scope.REQUEST
-         */
-        provide({
-            provide: 'makeRequestRegistry',
-            scope: Scope.SINGLETON,
-            useFactory: () => new Map(),
-        }),
-        /**
-         * `CREATE_CACHE_TOKEN` имеет проверку, если токен используется провайдером,
-         * который имеет Scope.SINGLETON, то инстанс кэша сохраняется в общее хранилище,
-         * и доступен для очистки через `/papi/clear-cache`.
-         * Scope.REQUEST игнорируется, т.к. это верная утечка памяти,
-         * инстансов кэши было бы неограниченное количество.
-         *
-         * HTTP клиенты создаются со Scope.REQUEST, но инстансы @tinkoff/request
-         * (и соответственно кэшей) создаются только один раз, благодаря `makeRequestRegistry`.
-         * это гарантирует отсутствие утечек памяти, поэтому мы обходим проверку
-         * на Scope.SINGLETON c помощью обертки `createCacheToken`
-         */
-        provide({
-            provide: createCacheToken,
-            scope: Scope.SINGLETON,
-            useFactory: ({ createCache }) => {
-                return createCache;
-            },
-            deps: {
-                createCache: CREATE_CACHE_TOKEN,
-            },
-        }),
-        provide({
-            provide: API_CLIENT_PASS_HEADERS,
-            useValue: ['x-request-id'],
-        }),
+        ...providers,
+        // we can't separate this module to browser and server files through "browser"
+        // package.json field, because jest not supports this field resolving out of the box
+        // and many unit tests rely on jsdom environment and fails because of resolving to server version
+        // TODO: separate jest preset for jsdom unit tests with custom resolver to support "browser" field
+        // @see https://github.com/marko-js/jest/blob/main/src/preset/browser/jest-preset.ts
+        ...(typeof window === 'undefined'
+            ? [
+                provide({
+                    provide: commandLineListTokens.init,
+                    useFactory: ({ agent }) => {
+                        return () => {
+                            const { setGlobalDispatcher } = require('undici');
+                            setGlobalDispatcher(agent.http);
+                        };
+                    },
+                    deps: {
+                        agent: HTTP_CLIENT_AGENT,
+                    },
+                }),
+                provide({
+                    provide: HTTP_CLIENT_AGENT,
+                    useFactory: ({ options, interceptors }) => {
+                        const { Agent } = require('undici');
+                        const agent = new Agent(options).compose(...(interceptors ?? []));
+                        return {
+                            http: agent,
+                            https: agent,
+                        };
+                    },
+                    deps: {
+                        options: HTTP_CLIENT_AGENT_OPTIONS,
+                        interceptors: optional(HTTP_CLIENT_AGENT_INTERCEPTORS),
+                    },
+                }),
+                provide({
+                    provide: HTTP_CLIENT_AGENT_OPTIONS,
+                    useValue: {},
+                }),
+            ]
+            : []),
     ],
-})(class HttpClientModule {
 });
 
 export { HttpClientModule };

package/lib/httpClientModule.js

@@ -2,116 +2,57 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dippy = require('@tinkoff/dippy');
 var core = require('@tramvai/core');
 var tokensHttpClient = require('@tramvai/tokens-http-client');
-var tokensCommon = require('@tramvai/tokens-common');
-var httpClientFactory = require('./httpClient/httpClientFactory.js');
 var papiClientModule = require('./papiClientModule.js');
+var shared = require('./shared.js');
 
-const createCacheToken = dippy.createToken('httpClient createCache');
-const HttpClientModule = /* @__PURE__ */ core.Module({
+const HttpClientModule = /* @__PURE__ */ core.declareModule({
+    name: 'HttpClientModule',
     imports: [papiClientModule.PapiClientModule],
     providers: [
-        core.provide({
-            provide: tokensHttpClient.HTTP_CLIENT_FACTORY,
-            useFactory: httpClientFactory.httpClientFactory,
-            deps: {
-                logger: tokensCommon.LOGGER_TOKEN,
-                envManager: tokensCommon.ENV_MANAGER_TOKEN,
-                appInfo: core.APP_INFO_TOKEN,
-                createCache: createCacheToken,
-                makeRequestRegistry: 'makeRequestRegistry',
-                requestManager: {
-                    token: tokensCommon.REQUEST_MANAGER_TOKEN,
-                    optional: true,
-                },
-                headersList: {
-                    token: tokensHttpClient.API_CLIENT_PASS_HEADERS,
-                    optional: true,
-                },
-                agent: {
-                    token: tokensHttpClient.HTTP_CLIENT_AGENT,
-                    optional: true,
-                },
-                disableCircuitBreaker: {
-                    token: tokensHttpClient.DISABLE_CIRCUIT_BREAKER,
-                    optional: true,
-                },
-                defaultOptions: {
-                    token: tokensHttpClient.DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS,
-                    optional: true,
-                },
-                defaultInterceptors: {
-                    token: tokensHttpClient.DEFAULT_HTTP_CLIENT_INTERCEPTORS,
-                    optional: true,
-                },
-                commandLineExecutionContext: {
-                    token: tokensCommon.COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
-                    optional: true,
-                },
-            },
-        }),
-        core.provide({
-            provide: tokensHttpClient.HTTP_CLIENT,
-            useFactory: ({ factory }) => {
-                return factory({
-                    name: 'http-client',
-                    enableCircuitBreaker: false,
-                });
-            },
-            deps: {
-                factory: tokensHttpClient.HTTP_CLIENT_FACTORY,
-            },
-        }),
-        core.provide({
-            provide: tokensCommon.ENV_USED_TOKEN,
-            useValue: [
-                { key: 'HTTP_CLIENT_CACHE_DISABLED', optional: true, dehydrate: false },
-                { key: 'HTTP_CLIENT_CIRCUIT_BREAKER_DISABLED', optional: true, dehydrate: false },
-            ],
-        }),
-        /**
-         * хранилище для экземпляров @tinkoff/request
-         *
-         * требуется хранить экземпляры в единственном виде,
-         * т.к. многие плагины @tinkoff/request после инициализации имеют состояние
-         * (cache, circuit breaker), и не будут корректно работать на сервере,
-         * если создавать новые экземпляры на Scope.REQUEST
-         */
-        core.provide({
-            provide: 'makeRequestRegistry',
-            scope: core.Scope.SINGLETON,
-            useFactory: () => new Map(),
-        }),
-        /**
-         * `CREATE_CACHE_TOKEN` имеет проверку, если токен используется провайдером,
-         * который имеет Scope.SINGLETON, то инстанс кэша сохраняется в общее хранилище,
-         * и доступен для очистки через `/papi/clear-cache`.
-         * Scope.REQUEST игнорируется, т.к. это верная утечка памяти,
-         * инстансов кэши было бы неограниченное количество.
-         *
-         * HTTP клиенты создаются со Scope.REQUEST, но инстансы @tinkoff/request
-         * (и соответственно кэшей) создаются только один раз, благодаря `makeRequestRegistry`.
-         * это гарантирует отсутствие утечек памяти, поэтому мы обходим проверку
-         * на Scope.SINGLETON c помощью обертки `createCacheToken`
-         */
-        core.provide({
-            provide: createCacheToken,
-            scope: core.Scope.SINGLETON,
-            useFactory: ({ createCache }) => {
-                return createCache;
-            },
-            deps: {
-                createCache: tokensCommon.CREATE_CACHE_TOKEN,
-            },
-        }),
-        core.provide({
-            provide: tokensHttpClient.API_CLIENT_PASS_HEADERS,
-            useValue: ['x-request-id'],
-        }),
+        ...shared.providers,
+        // we can't separate this module to browser and server files through "browser"
+        // package.json field, because jest not supports this field resolving out of the box
+        // and many unit tests rely on jsdom environment and fails because of resolving to server version
+        // TODO: separate jest preset for jsdom unit tests with custom resolver to support "browser" field
+        // @see https://github.com/marko-js/jest/blob/main/src/preset/browser/jest-preset.ts
+        ...(typeof window === 'undefined'
+            ? [
+                core.provide({
+                    provide: core.commandLineListTokens.init,
+                    useFactory: ({ agent }) => {
+                        return () => {
+                            const { setGlobalDispatcher } = require('undici');
+                            setGlobalDispatcher(agent.http);
+                        };
+                    },
+                    deps: {
+                        agent: tokensHttpClient.HTTP_CLIENT_AGENT,
+                    },
+                }),
+                core.provide({
+                    provide: tokensHttpClient.HTTP_CLIENT_AGENT,
+                    useFactory: ({ options, interceptors }) => {
+                        const { Agent } = require('undici');
+                        const agent = new Agent(options).compose(...(interceptors ?? []));
+                        return {
+                            http: agent,
+                            https: agent,
+                        };
+                    },
+                    deps: {
+                        options: tokensHttpClient.HTTP_CLIENT_AGENT_OPTIONS,
+                        interceptors: core.optional(tokensHttpClient.HTTP_CLIENT_AGENT_INTERCEPTORS),
+                    },
+                }),
+                core.provide({
+                    provide: tokensHttpClient.HTTP_CLIENT_AGENT_OPTIONS,
+                    useValue: {},
+                }),
+            ]
+            : []),
     ],
-})(class HttpClientModule {
 });
 
 exports.HttpClientModule = HttpClientModule;