@gravity-ui/gateway 2.2.0 → 2.4.0

package/README.md

@@ -72,6 +72,7 @@ type ProxyHeadersFunction = (
   type: ControllerType,
 ) => IncomingHttpHeaders;
 type ProxyHeaders = string[] | ProxyHeadersFunction;
+type ResponseContentType = AxiosResponse['headers']['Content-Type'];
 
 interface GatewayConfig {
   // Gateway Installation (external/internal/...). If the configuration is not provided, it is determined from process.env.APP_INSTALLATION.
@@ -119,7 +120,7 @@ interface GatewayConfig {
   // Configuration for automatic connection re-establishment upon connection error through L3 load balancer (default is true).
   grpcRecreateService?: boolean;
   // Enable verification of response contentType header. Actual only for REST actions. This value can be set / redefined the in action confg.
-  expectedResponseContentType?: AxiosResponse['headers']['Content-Type'];
+  expectedResponseContentType?: ResponseContentType | ResponseContentType[];
 }
 ```
 

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,6 +184,16 @@ 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;
         if (actionConfig.timeout || endpointAxiosConfig) {
@@ -225,26 +235,34 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             requestData.requestTime = endRequestTime - startRequestTime;
             const actualResponseContentType = (_f = response.headers) === null || _f === void 0 ? void 0 : _f['Content-Type'];
             const expectedResponseContentType = config.expectedResponseContentType || options.expectedResponseContentType;
-            if (actualResponseContentType &&
-                expectedResponseContentType &&
-                actualResponseContentType !== expectedResponseContentType) {
-                ctx.log('Invalid response content type', {
-                    expectedResponseContentType,
-                    actualResponseContentType,
-                });
-                ctx.end();
-                return Promise.reject({
-                    error: {
-                        status: 415,
-                        message: 'Response content type validation failed',
-                        code: 'INVALID_RESPONSE_CONTENT_TYPE',
-                        details: {
-                            title: 'Invalid response content type',
-                            description: `Expected to get ${expectedResponseContentType} but got ${actualResponseContentType}`,
+            if (actualResponseContentType && expectedResponseContentType) {
+                let isInvalidResponseContentType;
+                if (Array.isArray(expectedResponseContentType)) {
+                    isInvalidResponseContentType = !expectedResponseContentType.includes(String(actualResponseContentType));
+                }
+                else {
+                    isInvalidResponseContentType =
+                        expectedResponseContentType !== actualResponseContentType;
+                }
+                if (isInvalidResponseContentType) {
+                    ctx.log('Invalid response content type', {
+                        expectedResponseContentType,
+                        actualResponseContentType,
+                    });
+                    ctx.end();
+                    return Promise.reject({
+                        error: {
+                            status: 415,
+                            message: 'Response content type validation failed',
+                            code: 'INVALID_RESPONSE_CONTENT_TYPE',
+                            details: {
+                                title: 'Invalid response content type',
+                                description: `Expected to get ${expectedResponseContentType} but got ${actualResponseContentType}`,
+                            },
                         },
-                    },
-                    debugHeaders,
-                });
+                        debugHeaders,
+                    });
+                }
             }
             if (config.transformResponseData) {
                 try {

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,12 +65,13 @@ 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;
 };
 export type GetAuthHeaders<AuthArgs = Record<string, unknown>> = (params: GetAuthHeadersParams<AuthArgs>) => Record<string, string> | undefined;
+export type ResponseContentType = AxiosResponse['headers']['Content-Type'];
 export interface GatewayApiOptions<Context extends GatewayContext> {
     serviceName: string;
     timeout?: number;
@@ -79,9 +80,10 @@ export interface GatewayApiOptions<Context extends GatewayContext> {
     grpcRecreateService?: boolean;
     axiosConfig?: AxiosRequestConfig;
     proxyHeaders?: ProxyHeaders;
+    proxyDebugHeaders?: ProxyHeaders;
     validationSchema?: object;
     encodePathArgs?: boolean;
-    expectedResponseContentType?: AxiosResponse['headers']['Content-Type'];
+    expectedResponseContentType?: ResponseContentType | ResponseContentType[];
     getAuthHeaders: GetAuthHeaders;
 }
 export interface ParamsOutput {
@@ -125,7 +127,7 @@ export interface ApiServiceRestActionConfig<Context extends GatewayContext, TOut
     path: (args: TParams) => string;
     paramsSerializer?: AxiosRequestConfig['paramsSerializer'];
     responseType?: AxiosRequestConfig['responseType'];
-    expectedResponseContentType?: AxiosResponse['headers']['Content-Type'];
+    expectedResponseContentType?: ResponseContentType | ResponseContentType[];
     maxRedirects?: number;
 }
 export interface ApiServiceBaseGrpcActionConfig<Context extends GatewayContext, TOutput, TParams = undefined, TTransformed = TOutput> extends ApiServiceBaseActionConfig<Context, TOutput, TParams, TTransformed> {
@@ -238,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.2.0",
+  "version": "2.4.0",
   "description": "",
   "license": "MIT",
   "main": "build/index.js",