@gravity-ui/gateway 3.0.4-alpha.0 → 3.1.0

package/build/components/rest.js

@@ -36,7 +36,7 @@ function getConfigSerializerFunction(config) {
 function createRestAction(endpoints, config, serviceKey, actionName, options, ErrorConstructor) {
     var _a, _b, _c;
     const timeout = (_c = (_a = config === null || config === void 0 ? void 0 : config.timeout) !== null && _a !== void 0 ? _a : (_b = options === null || options === void 0 ? void 0 : options.axiosConfig) === null || _b === void 0 ? void 0 : _b.timeout) !== null && _c !== void 0 ? _c : options === null || options === void 0 ? void 0 : options.timeout;
-    const defaultAxiosClient = (0, axios_1.getAxiosClient)(timeout, config === null || config === void 0 ? void 0 : config.retries, options === null || options === void 0 ? void 0 : options.axiosConfig);
+    const defaultAxiosClient = (0, axios_1.getAxiosClient)(timeout, config === null || config === void 0 ? void 0 : config.retries, options === null || options === void 0 ? void 0 : options.axiosConfig, options === null || options === void 0 ? void 0 : options.axiosInterceptors);
     /* eslint-disable complexity */
     return async function action(actionConfig) {
         var _a, _b, _c, _d, _e, _f, _g, _h;
@@ -96,8 +96,8 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             ? endpointData.path
             : endpointData;
         const endpointAxiosConfig = (0, common_1.isExtendedRestActionEndpoint)(endpointData)
-            ? endpointData.axiosConfig || {}
-            : {};
+            ? endpointData.axiosConfig
+            : undefined;
         const pathArgs = config.validationSchema
             ? (0, validate_1.encodePathParams)(args)
             : (0, validate_1.getPathArgsProxy)(args, options.encodePathArgs);
@@ -196,10 +196,10 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
         }
         const startRequestTime = Date.now();
         let axiosClient = defaultAxiosClient;
-        const customActionTimeout = (_e = (_d = (_c = actionConfig.timeout) !== null && _c !== void 0 ? _c : config.timeout) !== null && _d !== void 0 ? _d : endpointAxiosConfig.timeout) !== null && _e !== void 0 ? _e : timeout;
+        const customActionTimeout = (_e = (_d = (_c = actionConfig.timeout) !== null && _c !== void 0 ? _c : config.timeout) !== null && _d !== void 0 ? _d : endpointAxiosConfig === null || endpointAxiosConfig === void 0 ? void 0 : endpointAxiosConfig.timeout) !== null && _e !== void 0 ? _e : timeout;
         if (actionConfig.timeout || endpointAxiosConfig) {
             const customActionAxiosConfig = Object.assign(Object.assign({}, ((options === null || options === void 0 ? void 0 : options.axiosConfig) || {})), (endpointAxiosConfig || {}));
-            axiosClient = (0, axios_1.getAxiosClient)(customActionTimeout, config === null || config === void 0 ? void 0 : config.retries, customActionAxiosConfig);
+            axiosClient = (0, axios_1.getAxiosClient)(customActionTimeout, config === null || config === void 0 ? void 0 : config.retries, customActionAxiosConfig, options === null || options === void 0 ? void 0 : options.axiosInterceptors);
         }
         headers['x-request-timeout'] = customActionTimeout !== null && customActionTimeout !== void 0 ? customActionTimeout : constants_1.DEFAULT_TIMEOUT;
         ctx.log('Starting request', { debugHeaders: (0, common_1.sanitizeDebugHeaders)(debugHeaders) });
@@ -231,17 +231,6 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
                 responseType: config.responseType,
             });
         }
-        axiosClient.interceptors.request.use((requestConfig) => {
-            var _a;
-            requestConfig.headers.set('x-request-attempt', 
-            // according this issue https://github.com/softonic/axios-retry/issues/167
-            // 'axios-retry' doesn`t define retryCount field in exported type
-            // however in this issue https://github.com/softonic/axios-retry/issues/75#issuecomment-502151719
-            // people use it
-            // @ts-ignore
-            ((_a = requestConfig[constants_1.AXIOS_RETRY_NAMESPACE]) === null || _a === void 0 ? void 0 : _a.retryCount) || 0);
-            return requestConfig;
-        });
         try {
             const response = await axiosClient.request(requestConfig);
             const responseHeaders = {};

package/build/index.js

@@ -77,6 +77,7 @@ function createApiAction(schema, config, serviceKey, actionName, api, grpcContex
             proxyHeaders: config.proxyHeaders,
             proxyDebugHeaders: config.proxyDebugHeaders,
             axiosConfig: config.axiosConfig,
+            axiosInterceptors: config.axiosInterceptors,
             validationSchema: config.validationSchema,
             encodePathArgs: config.encodePathArgs,
             getAuthHeaders: config.getAuthHeaders,

package/build/models/common.d.ts

@@ -2,7 +2,7 @@
 import { IncomingHttpHeaders } from 'http';
 import { ClientDuplexStream, ClientReadableStream, ClientWritableStream } from '@grpc/grpc-js';
 import { HandlerType } from '@grpc/grpc-js/build/src/server-call';
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
 import type { Request, Response } from 'express';
 import type { GrpcContext } from '../components/grpc';
 import { Lang } from '../constants';
@@ -82,6 +82,7 @@ export interface GatewayApiOptions<Context extends GatewayContext> {
     grpcOptions?: object;
     grpcRecreateService?: boolean;
     axiosConfig?: AxiosRequestConfig;
+    axiosInterceptors?: AxiosInterceptorsConfig;
     proxyHeaders?: ProxyHeaders;
     proxyDebugHeaders?: ProxyHeaders;
     validationSchema?: object;
@@ -227,6 +228,15 @@ interface OnUnknownActionData {
     service?: string;
     action?: string;
 }
+type AxiosInterceptorUseParams<T> = Parameters<AxiosInterceptorManager<T>['use']>;
+interface AxiosInterceptorConfig<T> {
+    callback: AxiosInterceptorUseParams<T>[0];
+    errorCallback?: AxiosInterceptorUseParams<T>[1];
+}
+export interface AxiosInterceptorsConfig {
+    request?: AxiosInterceptorConfig<InternalAxiosRequestConfig<any>>[];
+    response?: AxiosInterceptorConfig<AxiosResponse<any>>[];
+}
 export interface GatewayConfig<Context extends GatewayContext, Req extends GatewayRequest<Context>, Res extends GatewayResponse> {
     installation?: string;
     env?: string;
@@ -235,6 +245,7 @@ export interface GatewayConfig<Context extends GatewayContext, Req extends Gatew
     grpcOptions?: object;
     grpcRecreateService?: boolean;
     axiosConfig?: AxiosRequestConfig;
+    axiosInterceptors?: AxiosInterceptorsConfig;
     onUnknownAction?: (req: Req, res: Res, data: OnUnknownActionData) => any;
     onBeforeAction?: (req: Req, res: Res, scope: string, service: string, action: string, config?: ApiServiceActionConfig<Context, Req, Res, unknown>) => any;
     onRequestSuccess?: (req: Req, res: Res, data: any) => any;

package/build/utils/axios.d.ts

@@ -1,2 +1,3 @@
 import { AxiosRequestConfig } from 'axios';
-export declare function getAxiosClient(timeout?: number, retries?: number, axiosConfig?: AxiosRequestConfig): import("axios").AxiosInstance;
+import { AxiosInterceptorsConfig } from '../models/common';
+export declare function getAxiosClient(timeout?: number, retries?: number, axiosConfig?: AxiosRequestConfig, { request: reqInterceptors, response: resInterceptors }?: AxiosInterceptorsConfig): import("axios").AxiosInstance;

package/build/utils/axios.js

@@ -6,9 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAxiosClient = void 0;
 const axios_1 = __importDefault(require("axios"));
 const axios_retry_1 = __importDefault(require("axios-retry"));
+const lodash_1 = __importDefault(require("lodash"));
 const constants_1 = require("../constants");
-function getAxiosClient(timeout = constants_1.DEFAULT_TIMEOUT, retries = 0, axiosConfig = constants_1.DEFAULT_AXIOS_OPTIONS) {
+function getAxiosClient(timeout = constants_1.DEFAULT_TIMEOUT, retries = 0, axiosConfig = constants_1.DEFAULT_AXIOS_OPTIONS, { request: reqInterceptors, response: resInterceptors } = {}) {
     const client = axios_1.default.create(Object.assign(Object.assign({}, axiosConfig), { timeout }));
+    reqInterceptors === null || reqInterceptors === void 0 ? void 0 : reqInterceptors.forEach(({ callback, errorCallback }) => client.interceptors.request.use(callback, errorCallback));
+    resInterceptors === null || resInterceptors === void 0 ? void 0 : resInterceptors.forEach(({ callback, errorCallback }) => client.interceptors.response.use(callback, errorCallback));
     (0, axios_retry_1.default)(client, {
         retries,
         retryDelay: axios_retry_1.default.exponentialDelay,
@@ -18,6 +21,9 @@ function getAxiosClient(timeout = constants_1.DEFAULT_TIMEOUT, retries = 0, axio
             }
             return axios_retry_1.default.isNetworkError(error) || axios_retry_1.default.isRetryableError(error);
         },
+        onRetry: (retryCount, _error, requestConfig) => {
+            lodash_1.default.set(requestConfig, ['headers', 'x-request-attempt'], retryCount);
+        },
     });
     return client;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/gateway",
-  "version": "3.0.4-alpha.0",
+  "version": "3.1.0",
   "description": "",
   "license": "MIT",
   "main": "build/index.js",