@gravity-ui/gateway 2.5.0 → 2.5.2-alpha.0

package/README.md

@@ -124,6 +124,11 @@ interface GatewayConfig {
 }
 ```
 
+#### validationSchema
+
+By default, for path params in rest actions used the following regexp: `/^((?!(\.\.|\?|#|\\|\/)).)*$/i`.
+If the parameter value does not pass validation, the `GATEWAY_INVALID_PARAM_VALUE` value is returned.
+
 ### Usage in Node.js
 
 Upon gateway initialization, in addition to exporting the controller, it also exports an `api` object, which represents the core for executing requests to the backend.

package/build/components/grpc.js

@@ -396,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]`, {
@@ -415,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,10 +344,10 @@ 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 }));
+                ctx.stats(Object.assign(Object.assign({}, requestData), { responseStatus: 200 }));
             }
             ctx.logError('Request failed', error, {
                 actionURL,

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/validate.js

@@ -29,7 +29,7 @@ function encodePathParams(params) {
 }
 exports.encodePathParams = encodePathParams;
 function getPathParam(value) {
-    return /^((?!(\.\.|\?|#|\\|\/)).)*$/i.test(value) ? value : '';
+    return /^((?!(\.\.|\?|#|\\|\/)).)*$/i.test(value) ? value : 'GATEWAY_INVALID_PARAM_VALUE';
 }
 exports.getPathParam = getPathParam;
 function getPathArgsProxy(args, encodePathArgs) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/gateway",
-  "version": "2.5.0",
+  "version": "2.5.2-alpha.0",
   "description": "",
   "license": "MIT",
   "main": "build/index.js",