@gravity-ui/gateway 2.3.0 → 2.5.0

package/build/components/grpc.js

@@ -426,6 +426,16 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
         if ('protoPath' in config) {
             debugHeaders['x-api-request-protopath'] = config.protoPath;
         }
+        if (typeof options.proxyDebugHeaders === 'function') {
+            Object.assign(debugHeaders, options.proxyDebugHeaders(Object.assign({}, headers), 'grpc'));
+        }
+        else if (Array.isArray(options.proxyDebugHeaders)) {
+            for (const headerName of options.proxyDebugHeaders) {
+                if (headers[headerName] !== undefined) {
+                    debugHeaders[`x-gateway-${headerName}`] = headers[headerName];
+                }
+            }
+        }
         ctx.log('Initiating request', { debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders) });
         const sendStats = (status, data) => {
             if (options === null || options === void 0 ? void 0 : options.sendStats) {

package/build/components/rest.js

@@ -184,13 +184,24 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
         if (headers['content-type']) {
             debugHeaders['x-api-content-type'] = headers['content-type'];
         }
+        if (typeof options.proxyDebugHeaders === 'function') {
+            Object.assign(debugHeaders, options.proxyDebugHeaders(Object.assign({}, requestHeaders), 'rest'));
+        }
+        else if (Array.isArray(options.proxyDebugHeaders)) {
+            for (const headerName of options.proxyDebugHeaders) {
+                if (headers[headerName] !== undefined) {
+                    debugHeaders[`x-gateway-${headerName}`] = headers[headerName];
+                }
+            }
+        }
         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;
         if (actionConfig.timeout || endpointAxiosConfig) {
-            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 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);
         }
+        headers['x-request-timeout'] = customActionTimeout !== null && customActionTimeout !== void 0 ? customActionTimeout : constants_1.DEFAULT_TIMEOUT;
         ctx.log('Starting request', { debugHeaders: (0, common_1.sanitizeDebugHeaders)(debugHeaders) });
         const requestData = {
             timestamp: startRequestTime,
@@ -218,6 +229,17 @@ 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/constants.d.ts

@@ -44,3 +44,4 @@ export declare const DEFAULT_VALIDATION_SCHEMA: {
         })[];
     };
 };
+export declare const AXIOS_RETRY_NAMESPACE = "axios-retry";

package/build/constants.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_VALIDATION_SCHEMA = exports.RECREATE_SERVICE_CODES = exports.RETRYABLE_STATUS_CODES = exports.ANY_ACTION_SYMBOL = exports.ECMA_STRING_SIZE = exports.DEFAULT_GRPC_OPTIONS = exports.DEFAULT_AXIOS_OPTIONS = exports.DEFAULT_PROXY_HEADERS = exports.DEFAULT_LANG_HEADER = exports.DEFAULT_TIMEOUT = exports.Lang = exports.VERSION = void 0;
+exports.AXIOS_RETRY_NAMESPACE = exports.DEFAULT_VALIDATION_SCHEMA = exports.RECREATE_SERVICE_CODES = exports.RETRYABLE_STATUS_CODES = exports.ANY_ACTION_SYMBOL = exports.ECMA_STRING_SIZE = exports.DEFAULT_GRPC_OPTIONS = exports.DEFAULT_AXIOS_OPTIONS = exports.DEFAULT_PROXY_HEADERS = exports.DEFAULT_LANG_HEADER = exports.DEFAULT_TIMEOUT = exports.Lang = exports.VERSION = void 0;
 const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
 const grpc = __importStar(require("@grpc/grpc-js"));
@@ -99,3 +99,4 @@ exports.DEFAULT_VALIDATION_SCHEMA = {
         ],
     },
 };
+exports.AXIOS_RETRY_NAMESPACE = 'axios-retry';

package/build/index.js

@@ -75,6 +75,7 @@ function createApiAction(schema, config, serviceKey, actionName, api, grpcContex
             timeout: config.timeout,
             sendStats: config.sendStats,
             proxyHeaders: config.proxyHeaders,
+            proxyDebugHeaders: config.proxyDebugHeaders,
             axiosConfig: config.axiosConfig,
             validationSchema: config.validationSchema,
             encodePathArgs: config.encodePathArgs,
@@ -87,6 +88,7 @@ function createApiAction(schema, config, serviceKey, actionName, api, grpcContex
         timeout: config.timeout,
         sendStats: config.sendStats,
         proxyHeaders: config.proxyHeaders,
+        proxyDebugHeaders: config.proxyDebugHeaders,
         grpcOptions: config.grpcOptions,
         grpcRecreateService,
         getAuthHeaders: config.getAuthHeaders,

package/build/models/common.d.ts

@@ -65,7 +65,7 @@ export type ProxyHeaders = string[] | ProxyHeadersFunction;
 export type ProxyResponseHeadersFunction = (headers: Headers, type: ControllerType) => Headers;
 export type ProxyResponseHeaders = string[] | ProxyResponseHeadersFunction;
 export type GetAuthHeadersParams<AuthArgs = Record<string, unknown>> = {
-    actionType: 'rest' | 'grpc';
+    actionType: ControllerType;
     serviceName: string;
     requestHeaders: Headers;
     authArgs: AuthArgs | undefined;
@@ -80,6 +80,7 @@ export interface GatewayApiOptions<Context extends GatewayContext> {
     grpcRecreateService?: boolean;
     axiosConfig?: AxiosRequestConfig;
     proxyHeaders?: ProxyHeaders;
+    proxyDebugHeaders?: ProxyHeaders;
     validationSchema?: object;
     encodePathArgs?: boolean;
     expectedResponseContentType?: ResponseContentType | ResponseContentType[];
@@ -239,7 +240,8 @@ export interface GatewayConfig<Context extends GatewayContext, Req extends Gatew
     includeProtoRoots?: string[];
     caCertificatePath: string | null;
     proxyHeaders: ProxyHeaders;
-    withDebugHeaders: boolean | ((req: Req, res: Res) => boolean);
+    proxyDebugHeaders?: ProxyHeaders;
+    withDebugHeaders?: boolean | ((req: Req, res: Res) => boolean);
     validationSchema?: object;
     encodePathArgs?: boolean;
     getAuthArgs: (req: Req, res: Res) => Record<string, unknown> | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/gateway",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "description": "",
   "license": "MIT",
   "main": "build/index.js",