@tramvai/module-http-client 2.70.0 → 2.72.0

package/lib/index.browser.js

@@ -1,237 +1,8 @@
-import { createToken } from '@tinkoff/dippy';
-import { Module, provide, Scope, APP_INFO_TOKEN } from '@tramvai/core';
-import { PAPI_SERVICE, HTTP_CLIENT_FACTORY, API_CLIENT_PASS_HEADERS, HTTP_CLIENT_AGENT, DISABLE_CIRCUIT_BREAKER, DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS, HTTP_CLIENT } from '@tramvai/tokens-http-client';
+export { HttpClientModule } from './httpClientModule.browser.js';
+export { httpClientFactory } from './httpClient/httpClientFactory.browser.js';
+import '@tramvai/core';
+import '@tramvai/tokens-server';
 export * 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 isNil from '@tinkoff/utils/is/nil';
-import compose from '@tinkoff/utils/function/compose';
-import { mergeOptions, createTinkoffRequest, HttpClientAdapter } from '@tramvai/tinkoff-request-http-client-adapter';
-import { SERVER_MODULE_PAPI_PUBLIC_URL } from '@tramvai/tokens-server';
-import prop from '@tinkoff/utils/object/prop';
-import { ApiService } from '@tramvai/http-client';
+export { PapiService } from './papi/papiService.browser.browser.js';
+export { fillHeaderIp, fillHeaders } from './utils/fillHeaders.browser.browser.js';
 export * from '@tramvai/http-client';
-
-const fillHeaders = (deps) => (params) => {
-    return params;
-};
-const fillHeaderIp = fillHeaders;
-
-const createUserAgent = ({ appInfo, envManager, }) => {
-    const { appName } = appInfo;
-    const appVersion = envManager.get('APP_VERSION');
-    const appRelease = envManager.get('APP_RELEASE');
-    const userAgent = [
-        'tramvai',
-        appName,
-        appVersion && `version ${appVersion}`,
-        appRelease && `release ${appRelease}`,
-    ]
-        .filter(Boolean)
-        .join(' ');
-    return userAgent;
-};
-
-const environmentDependentOptions = typeof window === 'undefined'
-    ? {
-        defaultTimeout: 2000,
-    }
-    : {
-        defaultTimeout: 30000,
-    };
-const httpClientFactory = ({ logger, envManager, appInfo, requestManager, headersList, createCache, makeRequestRegistry, agent, querySerializer, disableCircuitBreaker = false, defaultOptions, commandLineExecutionContext, }) => {
-    return (options) => {
-        var _a;
-        if (!options.name) {
-            throw Error(`You need to pass a unique field "name" for the HTTP client instance`);
-        }
-        const forceDisableCache = envManager.get('HTTP_CLIENT_CACHE_DISABLED');
-        const forceDisabledCircuitBreaker = envManager.get('HTTP_CLIENT_CIRCUIT_BREAKER_DISABLED');
-        const adapterOptions = mergeOptions(mergeOptions({
-            logger,
-            agent,
-            querySerializer,
-            method: 'GET',
-            createCache: createCache
-                ? (cacheOptions) => createCache('memory', cacheOptions)
-                : undefined,
-            modifyRequest: compose(fillHeaderIp(), fillHeaders()),
-            circuitBreakerOptions: {
-                failureThreshold: 75,
-                minimumFailureCount: 10,
-            },
-            // TODO: remove any after [resolving](https://github.com/southpolesteve/node-abort-controller/issues/31)
-            signal: (_a = commandLineExecutionContext === null || commandLineExecutionContext === void 0 ? void 0 : commandLineExecutionContext()) === null || _a === void 0 ? void 0 : _a.abortSignal,
-            ...environmentDependentOptions,
-        }, defaultOptions !== null && defaultOptions !== void 0 ? defaultOptions : {}), options);
-        // по умолчанию, на сервере, библиотека https://github.com/node-fetch/node-fetch
-        // отправляет заголовок "User-Agent" вида "node-fetch".
-        // для улучшения логов сервисов, в которые делают запросы tramvai приложения,
-        // заменяем "User-Agent" на кастомный, содержащий название и версию приложения
-        if (typeof window === 'undefined') {
-            adapterOptions.headers = {
-                'User-Agent': createUserAgent({ appInfo, envManager }),
-                ...adapterOptions.headers,
-            };
-        }
-        if (!isNil(forceDisableCache)) {
-            adapterOptions.disableCache = !!forceDisableCache;
-        }
-        if (disableCircuitBreaker) {
-            adapterOptions.enableCircuitBreaker = false;
-        }
-        // environment variable in priority over disableCircuitBreaker
-        if (!isNil(forceDisabledCircuitBreaker)) {
-            adapterOptions.enableCircuitBreaker = !forceDisabledCircuitBreaker;
-        }
-        // кэшируем инстанс @tinkoff/request
-        if (!makeRequestRegistry.has(adapterOptions.name)) {
-            makeRequestRegistry.set(adapterOptions.name, createTinkoffRequest(adapterOptions));
-        }
-        const makeRequest = makeRequestRegistry.get(adapterOptions.name);
-        const httpClientAdapter = new HttpClientAdapter({
-            options: adapterOptions,
-            makeRequest,
-        });
-        return httpClientAdapter;
-    };
-};
-
-class PapiService extends ApiService {
-    constructor({ httpClientFactory, baseUrl }) {
-        const httpClient = httpClientFactory({
-            name: 'papi',
-            baseUrl,
-            validator: ({ response }) => {
-                if (response.resultCode && response.payload) {
-                    return;
-                }
-                return response.error || new Error(JSON.stringify(response));
-            },
-            modifyResponse(response) {
-                return {
-                    ...response,
-                    payload: prop('payload', response.payload),
-                };
-            },
-        });
-        super(httpClient);
-    }
-}
-
-const PapiClientModule = /* @__PURE__ */ Module({
-    providers: [
-        provide({
-            provide: PAPI_SERVICE,
-            scope: Scope.SINGLETON,
-            useClass: PapiService,
-            deps: {
-                httpClientFactory: HTTP_CLIENT_FACTORY,
-                baseUrl: SERVER_MODULE_PAPI_PUBLIC_URL,
-            },
-        }),
-    ],
-})(class PapiClientModule {
-});
-
-const createCacheToken = createToken('httpClient createCache');
-const HttpClientModule = /* @__PURE__ */ Module({
-    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,
-                },
-                commandLineExecutionContext: {
-                    token: COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
-                    optional: true,
-                },
-            },
-        }),
-        provide({
-            provide: HTTP_CLIENT,
-            useFactory: ({ factory }) => {
-                return factory({
-                    name: 'http-client',
-                    disableCache: true,
-                });
-            },
-            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'],
-        }),
-    ],
-})(class HttpClientModule {
-});
-
-export { HttpClientModule, PapiService, fillHeaderIp, fillHeaders, httpClientFactory };

package/lib/index.es.js

@@ -1,275 +1,8 @@
-import { createChildContainer, createToken } from '@tinkoff/dippy';
-import { Module, provide, Scope, DI_TOKEN, APP_INFO_TOKEN } from '@tramvai/core';
-import { PAPI_SERVICE, HTTP_CLIENT_FACTORY, API_CLIENT_PASS_HEADERS, HTTP_CLIENT_AGENT, DISABLE_CIRCUIT_BREAKER, DEFAULT_HTTP_CLIENT_FACTORY_OPTIONS, HTTP_CLIENT } from '@tramvai/tokens-http-client';
+export { HttpClientModule } from './httpClientModule.es.js';
+export { httpClientFactory } from './httpClient/httpClientFactory.es.js';
+import '@tramvai/core';
+import '@tramvai/tokens-server';
 export * 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 isNil from '@tinkoff/utils/is/nil';
-import compose from '@tinkoff/utils/function/compose';
-import { mergeOptions, createTinkoffRequest, HttpClientAdapter } from '@tramvai/tinkoff-request-http-client-adapter';
-import identity from '@tinkoff/utils/function/identity';
-import flatten from '@tinkoff/utils/array/flatten';
-import pick from '@tinkoff/utils/object/pick';
-import { SERVER_MODULE_PAPI_PUBLIC_ROUTE } from '@tramvai/tokens-server';
-import find from '@tinkoff/utils/array/find';
-import { BaseHttpClient } from '@tramvai/http-client';
+export { PapiService } from './papi/papiService.es.js';
+export { fillHeaderIp, fillHeaders } from './utils/fillHeaders.es.js';
 export * from '@tramvai/http-client';
-import { getPapiParameters } from '@tramvai/papi';
-import { FASTIFY_REQUEST, FASTIFY_RESPONSE, PAPI_EXECUTOR } from '@tramvai/tokens-server-private';
-
-const fillHeaderIp = ({ requestManager, }) => {
-    if (!requestManager) {
-        return identity;
-    }
-    return (params) => {
-        return {
-            ...params,
-            headers: {
-                ...params.headers,
-                'X-real-ip': requestManager.getClientIp(),
-            },
-        };
-    };
-};
-const fillHeaders = ({ requestManager, headersList, }) => {
-    if (!requestManager) {
-        return identity;
-    }
-    const headerNames = flatten(headersList !== null && headersList !== void 0 ? headersList : []);
-    return (params) => {
-        return {
-            ...params,
-            headers: {
-                ...params.headers,
-                ...pick(headerNames, requestManager.getHeaders()),
-            },
-        };
-    };
-};
-
-const createUserAgent = ({ appInfo, envManager, }) => {
-    const { appName } = appInfo;
-    const appVersion = envManager.get('APP_VERSION');
-    const appRelease = envManager.get('APP_RELEASE');
-    const userAgent = [
-        'tramvai',
-        appName,
-        appVersion && `version ${appVersion}`,
-        appRelease && `release ${appRelease}`,
-    ]
-        .filter(Boolean)
-        .join(' ');
-    return userAgent;
-};
-
-const environmentDependentOptions = typeof window === 'undefined'
-    ? {
-        defaultTimeout: 2000,
-    }
-    : {
-        defaultTimeout: 30000,
-    };
-const httpClientFactory = ({ logger, envManager, appInfo, requestManager, headersList, createCache, makeRequestRegistry, agent, querySerializer, disableCircuitBreaker = false, defaultOptions, commandLineExecutionContext, }) => {
-    return (options) => {
-        var _a;
-        if (!options.name) {
-            throw Error(`You need to pass a unique field "name" for the HTTP client instance`);
-        }
-        const forceDisableCache = envManager.get('HTTP_CLIENT_CACHE_DISABLED');
-        const forceDisabledCircuitBreaker = envManager.get('HTTP_CLIENT_CIRCUIT_BREAKER_DISABLED');
-        const adapterOptions = mergeOptions(mergeOptions({
-            logger,
-            agent,
-            querySerializer,
-            method: 'GET',
-            createCache: createCache
-                ? (cacheOptions) => createCache('memory', cacheOptions)
-                : undefined,
-            modifyRequest: compose(fillHeaderIp({ requestManager }), fillHeaders({ requestManager, headersList })),
-            circuitBreakerOptions: {
-                failureThreshold: 75,
-                minimumFailureCount: 10,
-            },
-            // TODO: remove any after [resolving](https://github.com/southpolesteve/node-abort-controller/issues/31)
-            signal: (_a = commandLineExecutionContext === null || commandLineExecutionContext === void 0 ? void 0 : commandLineExecutionContext()) === null || _a === void 0 ? void 0 : _a.abortSignal,
-            ...environmentDependentOptions,
-        }, defaultOptions !== null && defaultOptions !== void 0 ? defaultOptions : {}), options);
-        // по умолчанию, на сервере, библиотека https://github.com/node-fetch/node-fetch
-        // отправляет заголовок "User-Agent" вида "node-fetch".
-        // для улучшения логов сервисов, в которые делают запросы tramvai приложения,
-        // заменяем "User-Agent" на кастомный, содержащий название и версию приложения
-        if (typeof window === 'undefined') {
-            adapterOptions.headers = {
-                'User-Agent': createUserAgent({ appInfo, envManager }),
-                ...adapterOptions.headers,
-            };
-        }
-        if (!isNil(forceDisableCache)) {
-            adapterOptions.disableCache = !!forceDisableCache;
-        }
-        if (disableCircuitBreaker) {
-            adapterOptions.enableCircuitBreaker = false;
-        }
-        // environment variable in priority over disableCircuitBreaker
-        if (!isNil(forceDisabledCircuitBreaker)) {
-            adapterOptions.enableCircuitBreaker = !forceDisabledCircuitBreaker;
-        }
-        // кэшируем инстанс @tinkoff/request
-        if (!makeRequestRegistry.has(adapterOptions.name)) {
-            makeRequestRegistry.set(adapterOptions.name, createTinkoffRequest(adapterOptions));
-        }
-        const makeRequest = makeRequestRegistry.get(adapterOptions.name);
-        const httpClientAdapter = new HttpClientAdapter({
-            options: adapterOptions,
-            makeRequest,
-        });
-        return httpClientAdapter;
-    };
-};
-
-class PapiService extends BaseHttpClient {
-    constructor({ papi, di }) {
-        super();
-        this.papi = flatten(papi || []);
-        this.di = di;
-    }
-    async request({ path, query, body }) {
-        var _a;
-        const papiRoute = find((papi) => getPapiParameters(papi).path === `/${path}`, (_a = this.papi) !== null && _a !== void 0 ? _a : []);
-        if (!papiRoute) {
-            throw new Error(`papi handler '${path}' not found`);
-        }
-        const req = { headers: { host: 'localhost' }, cookies: {}, query, body };
-        const res = {};
-        const childDi = createChildContainer(this.di, [
-            {
-                provide: FASTIFY_REQUEST,
-                useValue: req,
-            },
-            {
-                provide: FASTIFY_RESPONSE,
-                useValue: res,
-            },
-        ]);
-        const papiExecutor = childDi.get(PAPI_EXECUTOR);
-        const payload = await papiExecutor(papiRoute);
-        return { payload, status: 200, headers: {} };
-    }
-}
-
-const PapiClientModule = /* @__PURE__ */ Module({
-    providers: [
-        provide({
-            provide: PAPI_SERVICE,
-            scope: Scope.SINGLETON,
-            useClass: PapiService,
-            deps: {
-                di: DI_TOKEN,
-                papi: { token: SERVER_MODULE_PAPI_PUBLIC_ROUTE, optional: true },
-            },
-        }),
-    ],
-})(class PapiClientModule {
-});
-
-const createCacheToken = createToken('httpClient createCache');
-const HttpClientModule = /* @__PURE__ */ Module({
-    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,
-                },
-                commandLineExecutionContext: {
-                    token: COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
-                    optional: true,
-                },
-            },
-        }),
-        provide({
-            provide: HTTP_CLIENT,
-            useFactory: ({ factory }) => {
-                return factory({
-                    name: 'http-client',
-                    disableCache: true,
-                });
-            },
-            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'],
-        }),
-    ],
-})(class HttpClientModule {
-});
-
-export { HttpClientModule, PapiService, fillHeaderIp, fillHeaders, httpClientFactory };