@gravity-ui/gateway 2.0.0 → 2.1.0

package/build/components/grpc.js

@@ -628,13 +628,30 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                                 packageRoot: root,
                                 ErrorConstructor,
                             });
-                            Object.assign(debugHeaders, (0, common_2.getHeadersFromMetadata)(trailingMetadata));
+                            const responseHeaders = {};
+                            if (config.proxyResponseHeaders) {
+                                const proxyResponseHeaders = [];
+                                const headersFromMetadata = (0, common_2.getHeadersFromMetadata)(trailingMetadata);
+                                if (typeof config.proxyResponseHeaders === 'function') {
+                                    Object.assign(responseHeaders, config.proxyResponseHeaders(headersFromMetadata, 'grpc'));
+                                }
+                                else if (Array.isArray(config.proxyResponseHeaders)) {
+                                    proxyResponseHeaders.push(...config.proxyResponseHeaders);
+                                }
+                                for (const headerName of proxyResponseHeaders) {
+                                    if (responseHeaders[headerName] === undefined) {
+                                        responseHeaders[headerName] =
+                                            headersFromMetadata[headerName];
+                                    }
+                                }
+                            }
+                            Object.assign(debugHeaders, (0, common_2.getHeadersFromMetadata)(trailingMetadata, 'x-metadata-'));
                             sendStats(200, Object.assign(Object.assign({}, requestData), { responseSize: (0, object_sizeof_1.default)(response), grpcStatus: 0 }));
                             ctx.log('Request completed', {
                                 debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
                             });
                             ctx.end();
-                            return resolve({ responseData, debugHeaders });
+                            return resolve({ responseData, responseHeaders, debugHeaders });
                         });
                         call.on('status', (status) => {
                             trailingMetadata = status.metadata.toJSON();

package/build/components/rest.d.ts

@@ -3,5 +3,6 @@ import { GatewayContext } from '../models/context';
 import { AppErrorConstructor } from '../models/error';
 export default function createRestAction<Context extends GatewayContext>(endpoints: EndpointsConfig | undefined, config: ApiServiceRestActionConfig<Context, any, any>, serviceKey: string, actionName: string, options: GatewayApiOptions<Context>, ErrorConstructor: AppErrorConstructor): (actionConfig: ApiActionConfig<Context, any>) => Promise<{
     responseData: unknown;
+    responseHeaders?: Headers | undefined;
     debugHeaders: Headers;
 }>;

package/build/components/rest.js

@@ -220,6 +220,7 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
         }
         try {
             const response = await axiosClient.request(requestConfig);
+            const responseHeaders = {};
             const endRequestTime = Date.now();
             requestData.requestTime = endRequestTime - startRequestTime;
             if (config.transformResponseData) {
@@ -235,6 +236,20 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
                     (0, common_1.handleError)(ErrorConstructor, error, ctx, 'Transform response data failed');
                 }
             }
+            if (config.proxyResponseHeaders) {
+                const proxyResponseHeaders = [];
+                if (typeof config.proxyResponseHeaders === 'function') {
+                    Object.assign(responseHeaders, config.proxyResponseHeaders(Object.assign({}, response.headers), 'rest'));
+                }
+                else if (Array.isArray(config.proxyResponseHeaders)) {
+                    proxyResponseHeaders.push(...config.proxyResponseHeaders);
+                }
+                for (const headerName of proxyResponseHeaders) {
+                    if (responseHeaders[headerName] === undefined) {
+                        responseHeaders[headerName] = response.headers[headerName];
+                    }
+                }
+            }
             if (options === null || options === void 0 ? void 0 : options.sendStats) {
                 options.sendStats(Object.assign(Object.assign({}, requestData), { responseSize: getRestResponseSize(response === null || response === void 0 ? void 0 : response.data, ctx, ErrorConstructor), restStatus: 200 }), (0, redact_sensitive_headers_1.redactSensitiveHeaders)(parentCtx, headers), parentCtx, { debugHeaders: (0, common_1.sanitizeDebugHeaders)(debugHeaders) });
             }
@@ -243,7 +258,7 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             }
             ctx.log('Request completed', { debugHeaders: (0, common_1.sanitizeDebugHeaders)(debugHeaders) });
             ctx.end();
-            return { responseData: response.data, debugHeaders };
+            return { responseData: response.data, responseHeaders, debugHeaders };
         }
         catch (error) {
             let parsedError;

package/build/index.js

@@ -178,7 +178,7 @@ function generateGatewayApiController(schemasByScope, Api, config, controllerAct
                     throw { error, debugHeaders: {} };
                 }
             }
-            const { responseData, debugHeaders } = await apiAction({
+            const { responseData, responseHeaders, debugHeaders } = await apiAction({
                 requestId: req.id,
                 headers: req.headers,
                 ctx: req.ctx,
@@ -188,6 +188,9 @@ function generateGatewayApiController(schemasByScope, Api, config, controllerAct
             if (withDebugHeaders) {
                 res.set(debugHeaders);
             }
+            if (responseHeaders) {
+                res.set(responseHeaders);
+            }
             if (onRequestSuccess) {
                 return onRequestSuccess(req, res, responseData);
             }

package/build/models/common.d.ts

@@ -62,6 +62,8 @@ export interface GatewayError {
 }
 export type ProxyHeadersFunction = (headers: IncomingHttpHeaders, type: ControllerType) => IncomingHttpHeaders;
 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';
     serviceName: string;
@@ -114,6 +116,7 @@ export interface ApiServiceBaseActionConfig<Context extends GatewayContext, TOut
     retries?: number;
     idempotency?: boolean;
     proxyHeaders?: ProxyHeaders;
+    proxyResponseHeaders?: ProxyResponseHeaders;
     metadata?: Record<string, string | number | boolean>;
 }
 export interface ApiServiceRestActionConfig<Context extends GatewayContext, TOutput, TParams = undefined, TTransformed = TOutput> extends ApiServiceBaseActionConfig<Context, TOutput, TParams, TTransformed> {
@@ -185,6 +188,7 @@ export interface GatewayActionHeaders {
 }
 export interface GatewayActionUnaryResponse<TAction> extends GatewayActionHeaders {
     responseData: ApiActionResponseType<TAction>;
+    responseHeaders?: Headers;
 }
 export interface GatewayActionClientStreamResponse<TAction> extends GatewayActionHeaders {
     stream: ClientWritableStream<ApiActionResponseType<TAction>>;

package/build/utils/common.d.ts

@@ -11,5 +11,5 @@ export declare function getKeys<T extends object>(obj: T): (keyof T)[];
  * This function should only use to sanitize debugHeaders that are creating in our code
  */
 export declare function sanitizeDebugHeaders(debugHeaders: Headers): _.Omit<Headers, "x-api-request-body">;
-export declare function getHeadersFromMetadata(metadata: Record<string, grpc.MetadataValue[]>): Record<string, string>;
+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;

package/build/utils/common.js

@@ -30,11 +30,9 @@ function sanitizeDebugHeaders(debugHeaders) {
     return lodash_1.default.omit(debugHeaders, ['x-api-request-body']);
 }
 exports.sanitizeDebugHeaders = sanitizeDebugHeaders;
-function getHeadersFromMetadata(metadata) {
+function getHeadersFromMetadata(metadata, prefix = '') {
     return Object.entries(metadata).reduce((headers, [key, values]) => {
-        headers[`x-metadata-${key}`] = values
-            .filter((value) => typeof value === 'string')
-            .join(' ');
+        headers[`${prefix}${key}`] = values.filter((value) => typeof value === 'string').join(' ');
         return headers;
     }, {});
 }

package/package.json

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