@gravity-ui/gateway 2.1.0 → 2.3.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.
@@ -114,10 +115,12 @@ interface GatewayConfig {
   // Validation schema for parameters used when no schema is present in the action. Documentation: https://ajv.js.org/json-schema.html#json-data-type
   // You can use DEFAULT_VALIDATION_SCHEMA from lib/constants.ts.
   validationSchema?: object;
-  // Enables encoding of REST path arguments.
+  // Enables encoding of REST path arguments (default is true).
   encodePathArgs?: boolean;
   // 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?: ResponseContentType | ResponseContentType[];
 }
 ```
 

package/build/components/rest.js

@@ -39,7 +39,7 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
     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);
     /* eslint-disable complexity */
     return async function action(actionConfig) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const { args, requestId, headers: requestHeaders, ctx: parentCtx, authArgs } = actionConfig;
         const debugHeaders = {};
         const lang = requestHeaders[constants_1.DEFAULT_LANG_HEADER] || constants_1.Lang.Ru; // header might be empty string
@@ -223,6 +223,37 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             const responseHeaders = {};
             const endRequestTime = Date.now();
             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) {
+                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,
+                    });
+                }
+            }
             if (config.transformResponseData) {
                 try {
                     response.data = await config.transformResponseData(response.data, {
@@ -289,7 +320,7 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             }
             const responseStatus = lodash_1.default.get(parsedError, 'status') || lodash_1.default.get(error, 'status', 500);
             if (options === null || options === void 0 ? void 0 : options.sendStats) {
-                options.sendStats(Object.assign(Object.assign({}, requestData), { responseSize: getRestResponseSize((_f = error === null || error === void 0 ? void 0 : error.response) === null || _f === void 0 ? void 0 : _f.data, ctx, ErrorConstructor), restStatus: responseStatus }), (0, redact_sensitive_headers_1.redactSensitiveHeaders)(parentCtx, headers), parentCtx, { debugHeaders: (0, common_1.sanitizeDebugHeaders)(debugHeaders) });
+                options.sendStats(Object.assign(Object.assign({}, requestData), { responseSize: getRestResponseSize((_g = error === null || error === void 0 ? void 0 : error.response) === null || _g === void 0 ? void 0 : _g.data, ctx, ErrorConstructor), restStatus: responseStatus }), (0, redact_sensitive_headers_1.redactSensitiveHeaders)(parentCtx, headers), parentCtx, { debugHeaders: (0, common_1.sanitizeDebugHeaders)(debugHeaders) });
             }
             else {
                 ctx.stats(Object.assign(Object.assign({}, requestData), { responseStatus }));

package/build/models/common.d.ts

@@ -71,6 +71,7 @@ export type GetAuthHeadersParams<AuthArgs = Record<string, unknown>> = {
     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;
@@ -81,6 +82,7 @@ export interface GatewayApiOptions<Context extends GatewayContext> {
     proxyHeaders?: ProxyHeaders;
     validationSchema?: object;
     encodePathArgs?: boolean;
+    expectedResponseContentType?: ResponseContentType | ResponseContentType[];
     getAuthHeaders: GetAuthHeaders;
 }
 export interface ParamsOutput {
@@ -124,6 +126,7 @@ export interface ApiServiceRestActionConfig<Context extends GatewayContext, TOut
     path: (args: TParams) => string;
     paramsSerializer?: AxiosRequestConfig['paramsSerializer'];
     responseType?: AxiosRequestConfig['responseType'];
+    expectedResponseContentType?: ResponseContentType | ResponseContentType[];
     maxRedirects?: number;
 }
 export interface ApiServiceBaseGrpcActionConfig<Context extends GatewayContext, TOutput, TParams = undefined, TTransformed = TOutput> extends ApiServiceBaseActionConfig<Context, TOutput, TParams, TTransformed> {

package/package.json

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