@gravity-ui/gateway 2.5.4 → 2.6.0

package/build/components/grpc.js

@@ -45,7 +45,13 @@ const parse_error_1 = require("../utils/parse-error");
 const proto_path_resolver_1 = require("../utils/proto-path-resolver");
 const redact_sensitive_headers_1 = require("../utils/redact-sensitive-headers");
 const validate_1 = require("../utils/validate");
-const grpcLoaderOptions = Object.assign(Object.assign({}, constants_1.DEFAULT_PROTO_LOADER_OPTIONS), { includeDirs: [path_1.default.join(__dirname, '../../proto')] });
+const reflectLoaderOptions = {
+    longs: String,
+    enums: String,
+    defaults: true,
+    oneofs: true,
+};
+const grpcLoaderOptions = Object.assign(Object.assign({}, reflectLoaderOptions), { includeDirs: [path_1.default.join(__dirname, '../../proto')] });
 function createRoot(includeGrpcPaths) {
     const root = new protobufjs.Root();
     root.loadSync(path_1.default.resolve(__dirname, '../../proto/google/rpc/code.proto'));
@@ -75,10 +81,16 @@ function decodeResponse(response, packageRoot, ctx, encodedFields = [], ErrorCon
     const systemFields = ['metadata', 'response', 'error.details'];
     [...systemFields, ...encodedFields].forEach((fieldName) => {
         try {
-            const parsedFieldName = fieldName.replace(/\.\*$/, '');
+            const traverseRegExp = /\.\*$/;
+            const needTraverse = traverseRegExp.test(fieldName);
+            const parsedFieldName = needTraverse
+                ? fieldName.replace(traverseRegExp, '')
+                : fieldName;
             const fieldValue = lodash_1.default.get(response, parsedFieldName);
             if (fieldValue) {
-                lodash_1.default.set(response, parsedFieldName, (0, grpc_1.decodeAnyMessageRecursively)(packageRoot, fieldValue));
+                lodash_1.default.set(response, parsedFieldName, needTraverse
+                    ? (0, grpc_1.traverseAnyMessage)(packageRoot, fieldValue)
+                    : (0, grpc_1.decodeAnyMessageRecursively)(packageRoot, fieldValue));
             }
         }
         catch (error) {
@@ -258,7 +270,7 @@ async function getServiceInstanceReflect(config, endpointData, grpcOptions, cred
         loadedRoot = await (0, grpc_reflection_1.getCachedReflectionRoot)(actionEndpoint, config.protoKey, creds, combinedGrpcOptions);
     }
     const descriptor = loadedRoot.toDescriptor('proto3');
-    const definition = protoLoader.loadFileDescriptorSetFromObject(descriptor, constants_1.DEFAULT_PROTO_LOADER_OPTIONS);
+    const definition = protoLoader.loadFileDescriptorSetFromObject(descriptor, reflectLoaderOptions);
     const packageObject = grpc.loadPackageDefinition(definition);
     const Service = lodash_1.default.get(packageObject, config.protoKey);
     const serviceInstance = new Service(actionEndpoint, creds, combinedGrpcOptions);
@@ -384,7 +396,8 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
         }
     }
     return async function action(actionConfig) {
-        const { args, requestId, headers, ctx: parentCtx } = actionConfig;
+        var _a;
+        const { args, requestId, headers, ctx: parentCtx, userId } = actionConfig;
         const { action } = config;
         const lang = headers[constants_1.DEFAULT_LANG_HEADER] || constants_1.Lang.Ru; // header might be empty string
         const ctx = parentCtx.create(`Gateway ${serviceName} ${actionName} [grpc]`, {
@@ -403,6 +416,8 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
             requestId: actionConfig.requestId,
             requestMethod: action,
             requestUrl: config.protoKey,
+            traceId: ((_a = ctx.getTraceId) === null || _a === void 0 ? void 0 : _a.call(ctx)) || '',
+            userId: userId || '',
         };
         const debugHeaders = {
             'x-api-request-action': action,

package/build/components/rest.js

@@ -39,8 +39,8 @@ 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, _g;
-        const { args, requestId, headers: requestHeaders, ctx: parentCtx, authArgs } = actionConfig;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const { args, requestId, headers: requestHeaders, ctx: parentCtx, authArgs, userId, } = actionConfig;
         const debugHeaders = {};
         const lang = requestHeaders[constants_1.DEFAULT_LANG_HEADER] || constants_1.Lang.Ru; // header might be empty string
         const serviceName = (options === null || options === void 0 ? void 0 : options.serviceName) || serviceKey;
@@ -210,6 +210,8 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             requestId,
             requestMethod: config.method,
             requestUrl: actionURL,
+            traceId: ((_f = ctx.getTraceId) === null || _f === void 0 ? void 0 : _f.call(ctx)) || '',
+            userId: userId || '',
         };
         const requestConfig = {
             url: actionURL,
@@ -245,7 +247,7 @@ 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 actualResponseContentType = (_g = response.headers) === null || _g === void 0 ? void 0 : _g['Content-Type'];
             const expectedResponseContentType = config.expectedResponseContentType || options.expectedResponseContentType;
             if (actualResponseContentType && expectedResponseContentType) {
                 let isInvalidResponseContentType;
@@ -342,7 +344,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((_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) });
+                options.sendStats(Object.assign(Object.assign({}, requestData), { responseSize: getRestResponseSize((_h = error === null || error === void 0 ? void 0 : error.response) === null || _h === void 0 ? void 0 : _h.data, ctx, ErrorConstructor), restStatus: responseStatus, userId }), (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/constants.d.ts

@@ -20,12 +20,6 @@ export declare const DEFAULT_GRPC_OPTIONS: {
     'grpc.keepalive_timeout_ms': number;
     'grpc.keepalive_permit_without_calls': number;
 };
-export declare const DEFAULT_PROTO_LOADER_OPTIONS: {
-    longs: StringConstructor;
-    enums: StringConstructor;
-    defaults: boolean;
-    oneofs: boolean;
-};
 /**
  * Byte sizes are taken from ECMAScript Language Specification
  * http://www.ecma-international.org/ecma-262/5.1/

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.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_PROTO_LOADER_OPTIONS = 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"));
@@ -63,12 +63,6 @@ exports.DEFAULT_GRPC_OPTIONS = {
     'grpc.keepalive_timeout_ms': 1000,
     'grpc.keepalive_permit_without_calls': 1,
 };
-exports.DEFAULT_PROTO_LOADER_OPTIONS = {
-    longs: String,
-    enums: String,
-    defaults: true,
-    oneofs: true,
-};
 /**
  * Byte sizes are taken from ECMAScript Language Specification
  * http://www.ecma-international.org/ecma-262/5.1/

package/build/index.js

@@ -112,6 +112,7 @@ function generateGatewayApiController(schemasByScope, Api, config, controllerAct
     // eslint-disable-next-line complexity
     return async function gateway(req, res) {
         var _a, _b, _c;
+        const { userId } = res.locals || {};
         const { service, action, scope = 'root' } = req.params;
         const withDebugHeaders = typeof config.withDebugHeaders === 'function'
             ? config.withDebugHeaders(req, res)
@@ -186,6 +187,7 @@ function generateGatewayApiController(schemasByScope, Api, config, controllerAct
                 ctx: req.ctx,
                 args,
                 authArgs: config.getAuthArgs(req, res),
+                userId,
             });
             if (withDebugHeaders) {
                 res.set(debugHeaders);

package/build/models/common.d.ts

@@ -29,6 +29,7 @@ export interface ApiActionConfig<Context extends GatewayContext, TRequestData, T
     timeout?: number;
     callback?: (response: TResponseData) => void;
     authArgs?: Record<string, unknown>;
+    userId?: string;
 }
 export interface GRPCActionData {
     [key: string]: unknown;
@@ -47,6 +48,8 @@ export interface Stats {
     requestMethod: string;
     requestUrl: string;
     timestamp: number;
+    userId?: string;
+    traceId: string;
 }
 export type ControllerType = 'rest' | 'grpc';
 export interface GatewayError {

package/build/models/context.d.ts

@@ -19,4 +19,5 @@ export interface GatewayContext {
         redactSensitiveKeys?: (headers: Dict) => Dict;
     };
     getMetadata: () => IncomingHttpHeaders;
+    getTraceId?: () => string;
 }

package/build/utils/grpc.d.ts

@@ -1,5 +1,15 @@
+/// <reference types="node" />
 import * as grpc from '@grpc/grpc-js';
 import * as protobufjs from 'protobufjs';
-export declare function decodeAnyMessageRecursively(root: protobufjs.Root, message?: unknown): unknown;
+export declare function decodeAnyMessageRecursively(root: protobufjs.Root, message?: {
+    type_url?: string;
+    value?: Buffer;
+}): {
+    type_url?: string | undefined;
+    value?: Buffer | undefined;
+} | {
+    [k: string]: any;
+} | undefined;
+export declare function traverseAnyMessage(root: protobufjs.Root, message?: any): any;
 export declare function isRetryableError(error?: grpc.ServiceError): boolean;
 export declare function isRecreateServiceError(error?: grpc.ServiceError): boolean;

package/build/utils/grpc.js

@@ -1,34 +1,44 @@
 "use strict";
 /* eslint-disable camelcase */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRecreateServiceError = exports.isRetryableError = exports.decodeAnyMessageRecursively = void 0;
+exports.isRecreateServiceError = exports.isRetryableError = exports.traverseAnyMessage = exports.decodeAnyMessageRecursively = void 0;
 const constants_1 = require("../constants");
-function isEncodedMessage(message) {
-    return Boolean(message.type_url && message.value);
-}
 function decodeAnyMessageRecursively(root, message) {
-    if (!message || typeof message !== 'object') {
+    if (!message || !message.type_url || !message.value) {
         return message;
     }
-    if (Array.isArray(message)) {
-        return message.map((innerMessage) => decodeAnyMessageRecursively(root, innerMessage));
-    }
-    if (typeof message === 'object' && !isEncodedMessage(message)) {
-        return Object.entries(message).reduce((res, [key, value]) => {
-            res[key] = decodeAnyMessageRecursively(root, value);
-            return res;
-        }, {});
-    }
     const lastSlashIndex = message.type_url.lastIndexOf('/');
     if (lastSlashIndex < 0) {
         return message;
     }
     const typeName = message.type_url.substring(lastSlashIndex + 1);
     const type = root.lookupType(typeName);
-    const decodedMessage = type.toObject(type.decode(message.value), constants_1.DEFAULT_PROTO_LOADER_OPTIONS);
-    return decodeAnyMessageRecursively(root, decodedMessage);
+    const data = type.decode(message.value).toJSON();
+    Object.keys(data).forEach((key) => {
+        data[key] = decodeAnyMessageRecursively(root, data[key]);
+    });
+    return data;
 }
 exports.decodeAnyMessageRecursively = decodeAnyMessageRecursively;
+function traverseAnyMessage(root, message) {
+    if (!message) {
+        return message;
+    }
+    if (Array.isArray(message)) {
+        return message.map((item) => {
+            return traverseAnyMessage(root, item);
+        });
+    }
+    if (typeof message === 'object') {
+        Object.keys(message).forEach((key) => {
+            if (message[key]) {
+                message[key] = traverseAnyMessage(root, message[key]);
+            }
+        });
+    }
+    return decodeAnyMessageRecursively(root, message);
+}
+exports.traverseAnyMessage = traverseAnyMessage;
 function isRetryableError(error) {
     if (!error) {
         return false;

package/build/utils/parse-error.js

@@ -182,7 +182,7 @@ function parseGrpcError(error, packageRoot, lang = constants_1.Lang.Ru) {
         message: String(description || DEFAULT_GATEWAY_MESSAGE),
         code: DEFAULT_GATEWAY_CODE,
         details: Object.assign({ title,
-            description, grpcCode: code }, (typeof details === 'object' && !Array.isArray(details) ? details : { details })),
+            description, grpcCode: code }, details),
     };
 }
 exports.parseGrpcError = parseGrpcError;

package/package.json

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