@gravity-ui/gateway 4.6.0 → 4.7.0

package/README.md

@@ -7,7 +7,6 @@ A flexible and powerful Express controller for working with REST and gRPC APIs i
 - [Installation](#installation)
 - [Basic Usage](#basic-usage)
 - [Configuration](#configuration)
-  - [Config Structure](#config-structure)
   - [Validation Schema](#validation-schema)
   - [Using the API in Node.js](#using-the-api-in-nodejs)
   - [Schema Scopes](#schema-scopes)
@@ -92,9 +91,18 @@ type AxiosRetryCondition = IAxiosRetryConfig['retryCondition'];
 
 type ControllerType = 'rest' | 'grpc';
 
+type ProxyHeadersFunctionExtra = {
+  service: string;
+  action: string;
+
+  protopath?: string;
+  protokey?: string;
+};
+
 type ProxyHeadersFunction = (
   headers: IncomingHttpHeaders,
   type: ControllerType,
+  extra: ProxyHeadersFunctionExtra,
 ) => IncomingHttpHeaders;
 type ProxyHeaders = string[] | ProxyHeadersFunction;
 type ResponseContentType = AxiosResponse['headers']['Content-Type'];
@@ -205,6 +213,49 @@ interface GatewayConfig {
 }
 ```
 
+### `proxyHeaders`
+
+`GatewayConfig.proxyHeaders` is an optional method that allows setting headers for requests at the entire `gateway` level:
+
+```javascript
+const proxyHeaders = (headers, actionType, {service, action}) => {
+  const normalizedHeaders = {...headers};
+
+  if (actionType === 'rest' && service === 'mail') {
+    normalizedHeaders['x-mail-service-action'] = action;
+  }
+
+  return normalizedHeaders;
+};
+
+const {controller: gatewayController} = getGatewayControllers(
+  {root: Schema},
+  {...config, proxyHeaders},
+);
+```
+
+You can set headers for a specific action using `ApiServiceBaseActionConfig.proxyHeaders`:
+
+```javascript
+const schema = {
+  userService: {
+    serviceName: 'users',
+    endpoints: {...},
+    actions: {
+      getProfile: {
+        path: () => '/profile',
+        method: 'GET',
+        proxyHeaders: (headers) => ({...headers, ['x-users-service-action']: 'get-profile'}),
+      },
+    },
+  },
+};
+```
+
+The `GatewayConfig.proxyHeaders` and `ApiServiceBaseActionConfig.proxyHeaders` are merged when the action is called. The strategy for merging headers is not guaranteed.
+
+It is recommended to use `GatewayConfig.proxyHeaders` for assigning headers that are common to the entire application or a large number of actions. Otherwise, it is preferable to use `ApiServiceBaseActionConfig.proxyHeaders`.
+
 ### Validation Schema
 
 By default, for path params in REST actions, the following regexp is used: `/^((?!(\.\.|\?|#|\\|\/)).)*$/i`.

package/build/components/grpc.js

@@ -86,7 +86,7 @@ function decodeResponse(response, packageRoot, ctx, encodedFields = [], ErrorCon
         }
     });
 }
-function createMetadata({ options, actionConfig, config, params, serviceName, ctx, }) {
+function createMetadata({ options, actionConfig, config, params, serviceName, proxyHeadersCaller, ctx, }) {
     var _a;
     const { headers, requestId, authArgs } = actionConfig;
     const proxyHeaders = [...constants_1.DEFAULT_PROXY_HEADERS];
@@ -95,13 +95,13 @@ function createMetadata({ options, actionConfig, config, params, serviceName, ct
         'accept-language': headers[constants_1.DEFAULT_LANG_HEADER] || constants_1.Lang.Ru,
     };
     if (typeof options.proxyHeaders === 'function') {
-        Object.assign(metadata, options.proxyHeaders(Object.assign({}, headers), 'grpc'));
+        Object.assign(metadata, proxyHeadersCaller(options.proxyHeaders));
     }
     else if (Array.isArray(options.proxyHeaders)) {
         proxyHeaders.push(...options.proxyHeaders);
     }
     if (typeof config.proxyHeaders === 'function') {
-        Object.assign(metadata, config.proxyHeaders(Object.assign({}, headers), 'grpc'));
+        Object.assign(metadata, proxyHeadersCaller(config.proxyHeaders));
     }
     else if (Array.isArray(config.proxyHeaders)) {
         proxyHeaders.push(...config.proxyHeaders);
@@ -401,7 +401,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
             service: serviceName,
             action: actionName,
             requestTime: 0,
-            requestId: actionConfig.requestId,
+            requestId,
             requestMethod: action,
             requestUrl: config.protoKey,
             traceId: ((_a = ctx.getTraceId) === null || _a === void 0 ? void 0 : _a.call(ctx)) || '',
@@ -414,11 +414,19 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
             'x-request-id': requestId,
             'x-gateway-version': constants_1.VERSION,
         };
-        if ('protoPath' in config) {
-            debugHeaders['x-api-request-protopath'] = config.protoPath;
+        const protopath = 'protoPath' in config ? config.protoPath : undefined;
+        if (protopath) {
+            debugHeaders['x-api-request-protopath'] = protopath;
         }
+        let proxyHeadersExtra;
+        const proxyHeadersCaller = (proxyHeadersFunc) => {
+            if (proxyHeadersExtra === undefined) {
+                proxyHeadersExtra = (0, common_2.getProxyHeadersArgs)(serviceName, actionName, config);
+            }
+            return proxyHeadersFunc(Object.assign({}, headers), 'rest', proxyHeadersExtra);
+        };
         if (typeof options.proxyDebugHeaders === 'function') {
-            Object.assign(debugHeaders, options.proxyDebugHeaders(Object.assign({}, headers), 'grpc'));
+            Object.assign(debugHeaders, proxyHeadersCaller(options.proxyDebugHeaders));
         }
         else if (Array.isArray(options.proxyDebugHeaders)) {
             for (const headerName of options.proxyDebugHeaders) {
@@ -506,6 +514,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                 config,
                 params,
                 serviceName,
+                proxyHeadersCaller,
                 ctx,
             });
             if (!service[action]) {

package/build/components/rest.js

@@ -113,14 +113,21 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             'accept-language': lang,
             'x-gateway-version': constants_1.VERSION,
         };
+        let proxyHeadersExtra;
+        const proxyHeadersCaller = (proxyHeadersFunc) => {
+            if (proxyHeadersExtra === undefined) {
+                proxyHeadersExtra = (0, common_1.getProxyHeadersArgs)(serviceName, actionName);
+            }
+            return proxyHeadersFunc(Object.assign({}, requestHeaders), 'rest', proxyHeadersExtra);
+        };
         if (typeof options.proxyHeaders === 'function') {
-            Object.assign(actionHeaders, options.proxyHeaders(Object.assign({}, requestHeaders), 'rest'));
+            Object.assign(actionHeaders, proxyHeadersCaller(options.proxyHeaders));
         }
         else if (Array.isArray(options.proxyHeaders)) {
             proxyHeaders.push(...options.proxyHeaders);
         }
         if (typeof config.proxyHeaders === 'function') {
-            Object.assign(actionHeaders, config.proxyHeaders(Object.assign({}, requestHeaders), 'rest'));
+            Object.assign(actionHeaders, proxyHeadersCaller(config.proxyHeaders));
         }
         else if (Array.isArray(config.proxyHeaders)) {
             proxyHeaders.push(...config.proxyHeaders);
@@ -185,7 +192,7 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             debugHeaders['x-api-content-type'] = headers['content-type'];
         }
         if (typeof options.proxyDebugHeaders === 'function') {
-            Object.assign(debugHeaders, options.proxyDebugHeaders(Object.assign({}, requestHeaders), 'rest'));
+            Object.assign(debugHeaders, proxyHeadersCaller(options.proxyDebugHeaders));
         }
         else if (Array.isArray(options.proxyDebugHeaders)) {
             for (const headerName of options.proxyDebugHeaders) {

package/build/models/common.d.ts

@@ -68,7 +68,13 @@ export interface GatewayError {
 }
 export type GrpcRetryCondition = (error: ServiceError) => boolean;
 export type AxiosRetryCondition = IAxiosRetryConfig['retryCondition'];
-export type ProxyHeadersFunction = (headers: IncomingHttpHeaders, type: ControllerType) => IncomingHttpHeaders;
+export type ProxyHeadersFunctionExtra = {
+    service: string;
+    action: string;
+    protopath?: string;
+    protokey?: string;
+};
+export type ProxyHeadersFunction = (headers: IncomingHttpHeaders, type: ControllerType, extra: ProxyHeadersFunctionExtra) => IncomingHttpHeaders;
 export type ProxyHeaders = string[] | ProxyHeadersFunction;
 export type ProxyResponseHeadersFunction = (headers: Headers, type: ControllerType) => Headers;
 export type ProxyResponseHeaders = string[] | ProxyResponseHeadersFunction;

package/build/utils/common.d.ts

@@ -1,6 +1,6 @@
 import * as grpc from '@grpc/grpc-js';
 import _ from 'lodash';
-import { ActionEndpoint, ExtendedActionEndpoint, ExtendedGrpcActionEndpoint, ExtendedRestActionEndpoint, Headers } from '../models/common';
+import { ActionEndpoint, ApiServiceGrpcActionConfig, ExtendedActionEndpoint, ExtendedGrpcActionEndpoint, ExtendedRestActionEndpoint, Headers, ProxyHeadersFunctionExtra } from '../models/common';
 import { Dict, GatewayContext } from '../models/context';
 import { AppErrorConstructor } from '../models/error';
 export declare function isExtendedActionEndpoint(endpoint: ActionEndpoint): endpoint is ExtendedActionEndpoint;
@@ -13,3 +13,4 @@ export declare function getKeys<T extends object>(obj: T): (keyof T)[];
 export declare function sanitizeDebugHeaders(debugHeaders: Headers): _.Omit<Headers, "x-api-request-body">;
 export declare function getHeadersFromMetadata(metadata: Record<string, grpc.MetadataValue[]>, prefix?: string): Record<string, string>;
 export declare function handleError<Context extends GatewayContext>(ErrorConstructor: AppErrorConstructor, error: unknown, ctx: Context, message: string, extra?: Dict): void;
+export declare const getProxyHeadersArgs: <Context extends GatewayContext>(serviceName: string, actionName: string, grpcConfig?: ApiServiceGrpcActionConfig<Context, any, any> | undefined) => ProxyHeadersFunctionExtra;

package/build/utils/common.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleError = exports.getHeadersFromMetadata = exports.sanitizeDebugHeaders = exports.getKeys = exports.isExtendedRestActionEndpoint = exports.isExtendedGrpcActionEndpoint = exports.isExtendedActionEndpoint = void 0;
+exports.getProxyHeadersArgs = exports.handleError = exports.getHeadersFromMetadata = exports.sanitizeDebugHeaders = exports.getKeys = exports.isExtendedRestActionEndpoint = exports.isExtendedGrpcActionEndpoint = exports.isExtendedActionEndpoint = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 function isExtendedActionEndpoint(endpoint) {
     return (endpoint === null || endpoint === void 0 ? void 0 : endpoint.path) !== undefined;
@@ -49,3 +49,14 @@ function handleError(ErrorConstructor, error, ctx, message, extra) {
     }
 }
 exports.handleError = handleError;
+const getProxyHeadersArgs = (serviceName, actionName, grpcConfig) => {
+    const protopath = grpcConfig && 'protoPath' in grpcConfig ? grpcConfig.protoPath : undefined;
+    const protokey = grpcConfig === null || grpcConfig === void 0 ? void 0 : grpcConfig.protoKey;
+    return {
+        service: serviceName,
+        action: actionName,
+        protopath,
+        protokey,
+    };
+};
+exports.getProxyHeadersArgs = getProxyHeadersArgs;

package/package.json

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