@gravity-ui/gateway 4.4.0 → 4.6.0

package/build/components/grpc.js

@@ -385,7 +385,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
     }
     return async function action(actionConfig) {
         var _a;
-        const { args, requestId, headers, ctx: parentCtx, userId } = actionConfig;
+        const { args, requestId, headers, ctx: parentCtx, userId, abortSignal } = 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]`, {
@@ -461,6 +461,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
             (0, common_2.handleError)(ErrorConstructor, error, ctx, 'getService failed');
             throw error;
         }
+        let stopListeningForAbort = null;
         // eslint-disable-next-line complexity
         return new Promise((resolve, reject) => {
             var _a, _b, _c, _d;
@@ -522,6 +523,12 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                     });
                     const actionCall = service[action].bind(service);
                     const stream = actionCall(body, serviceMetadata, serviceOptions);
+                    stopListeningForAbort = (0, grpc_1.listenForAbort)({
+                        signal: abortSignal,
+                        config,
+                        call: stream,
+                        reject,
+                    });
                     stream.on('error', (error) => {
                         ctx.log('ServerStream error', {
                             debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
@@ -532,6 +539,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                         ctx.log('ServerStream status changed', status);
                     });
                     stream.on('end', () => {
+                        stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
                         ctx.log('ServerStream request completed', {
                             debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
                         });
@@ -553,6 +561,15 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                     }
                     const actionCall = service[action].bind(service);
                     const stream = actionCall(serviceMetadata, serviceOptions, actionConfig.callback);
+                    stopListeningForAbort = (0, grpc_1.listenForAbort)({
+                        signal: abortSignal,
+                        config,
+                        call: stream,
+                        reject,
+                    });
+                    stream.once('end', () => {
+                        stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
+                    });
                     resolve({ debugHeaders, stream });
                     return;
                 }
@@ -562,6 +579,12 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                     });
                     const actionCall = service[action].bind(service);
                     const stream = actionCall(serviceMetadata, serviceOptions);
+                    stopListeningForAbort = (0, grpc_1.listenForAbort)({
+                        signal: abortSignal,
+                        config,
+                        call: stream,
+                        reject,
+                    });
                     stream.on('error', (error) => {
                         ctx.log('BidiStream error', {
                             debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
@@ -572,6 +595,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                         ctx.log('BidiStream status changed', status);
                     });
                     stream.on('end', () => {
+                        stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
                         ctx.log('BidiStream request completed', {
                             debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
                         });
@@ -619,12 +643,14 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                                     (0, common_2.handleError)(ErrorConstructor, error, ctx, 'getService failed');
                                     throw error;
                                 }
+                                stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
                                 // Update service
                                 actionCall = service[action].bind(service);
                                 callAction();
                                 return;
                             }
                             if (error) {
+                                stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
                                 reject(new parse_error_1.GrpcError('gRPC request error', (0, parse_error_1.parseGrpcError)(error, root, lang, config.decodeAnyMessageProtoLoaderOptions), error));
                                 return;
                             }
@@ -660,11 +686,18 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                                 debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
                             });
                             ctx.end();
+                            stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
                             return resolve({ responseData, responseHeaders, debugHeaders });
                         });
                         call.on('status', (status) => {
                             trailingMetadata = status.metadata.toJSON();
                         });
+                        stopListeningForAbort = (0, grpc_1.listenForAbort)({
+                            signal: abortSignal,
+                            config,
+                            call,
+                            reject,
+                        });
                     };
                     callAction();
                 }
@@ -672,6 +705,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
         }).catch((error) => {
             const grpcError = (0, parse_error_1.isGrpcError)(error) ? error : (0, parse_error_1.grpcErrorFactory)(error);
             processError(grpcError);
+            stopListeningForAbort === null || stopListeningForAbort === void 0 ? void 0 : stopListeningForAbort();
             return Promise.reject({ error: grpcError.getGatewayError(), debugHeaders });
         });
     };

package/build/components/mixed.js

@@ -28,7 +28,7 @@ function createMixedAction(config, api, serviceName, actionName, extra, ErrorCon
         });
         const contextApi = (0, create_context_api_1.generateContextApi)(api, Object.assign(Object.assign({}, context), { ctx }));
         try {
-            const responseData = await config(contextApi, args, Object.assign({ headers: actionConfig.headers, lang: actionConfig.headers[constants_1.DEFAULT_LANG_HEADER] || constants_1.Lang.Ru, ctx }, extra));
+            const responseData = await config(contextApi, args, Object.assign(Object.assign({ headers: actionConfig.headers, lang: actionConfig.headers[constants_1.DEFAULT_LANG_HEADER] || constants_1.Lang.Ru, ctx }, extra), { abortSignal: actionConfig.abortSignal }));
             ctx.log('Request completed');
             return {
                 responseData,

package/build/components/rest.js

@@ -34,13 +34,13 @@ function getConfigSerializerFunction(config) {
     return undefined;
 }
 function createRestAction(endpoints, config, serviceKey, actionName, options, ErrorConstructor) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const timeout = (_c = (_a = config === null || config === void 0 ? void 0 : config.timeout) !== null && _a !== void 0 ? _a : (_b = options === null || options === void 0 ? void 0 : options.axiosConfig) === null || _b === void 0 ? void 0 : _b.timeout) !== null && _c !== void 0 ? _c : options === null || options === void 0 ? void 0 : options.timeout;
-    const defaultAxiosClient = (0, axios_1.getAxiosClient)(timeout, config === null || config === void 0 ? void 0 : config.retries, options === null || options === void 0 ? void 0 : options.axiosRetryCondition, options === null || options === void 0 ? void 0 : options.axiosConfig, options === null || options === void 0 ? void 0 : options.axiosInterceptors);
+    const defaultAxiosClient = (0, axios_1.getAxiosClient)(timeout, config === null || config === void 0 ? void 0 : config.retries, (_d = config === null || config === void 0 ? void 0 : config.axiosRetryCondition) !== null && _d !== void 0 ? _d : options === null || options === void 0 ? void 0 : options.axiosRetryCondition, options === null || options === void 0 ? void 0 : options.axiosConfig, options === null || options === void 0 ? void 0 : options.axiosInterceptors);
     /* eslint-disable complexity */
     return async function action(actionConfig) {
         var _a, _b, _c, _d, _e, _f, _g, _h;
-        const { args, requestId, headers: requestHeaders, ctx: parentCtx, authArgs, userId, } = actionConfig;
+        const { args, requestId, headers: requestHeaders, ctx: parentCtx, authArgs, userId, abortSignal, } = 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;
@@ -220,6 +220,7 @@ function createRestAction(endpoints, config, serviceKey, actionName, options, Er
             params: query,
             headers: ctx ? Object.assign(Object.assign({}, ctx.getMetadata()), headers) : headers,
             maxRedirects: config.maxRedirects,
+            signal: config.abortOnClientDisconnect ? abortSignal : undefined,
         };
         if (config.paramsSerializer) {
             Object.assign(requestConfig, {

package/build/index.js

@@ -176,6 +176,11 @@ function generateGatewayApiController(schemasByScope, Api, config, controllerAct
         }
         const args = req.method === 'GET' ? req.query : req.body;
         try {
+            const abortController = new AbortController();
+            const handleCloseConnection = () => {
+                abortController.abort();
+            };
+            req.connection.once('close', handleCloseConnection);
             const apiAction = Api[scope][service][action];
             if (onBeforeAction) {
                 const actionConfig = (_c = (_b = (_a = schemasByScope[scope]) === null || _a === void 0 ? void 0 : _a[service]) === null || _b === void 0 ? void 0 : _b.actions) === null || _c === void 0 ? void 0 : _c[action];
@@ -194,7 +199,9 @@ function generateGatewayApiController(schemasByScope, Api, config, controllerAct
                 args,
                 authArgs: config.getAuthArgs(req, res),
                 userId,
+                abortSignal: abortController.signal,
             });
+            req.connection.removeListener('close', handleCloseConnection);
             if (withDebugHeaders) {
                 res.set(debugHeaders);
             }

package/build/models/common.d.ts

@@ -32,6 +32,7 @@ export interface ApiActionConfig<Context extends GatewayContext, TRequestData, T
     callback?: (response: TResponseData) => void;
     authArgs?: Record<string, unknown>;
     userId?: string;
+    abortSignal?: AbortSignal;
 }
 export interface GRPCActionData {
     [key: string]: unknown;
@@ -131,6 +132,7 @@ export interface ApiServiceBaseActionConfig<Context extends GatewayContext, TOut
     proxyHeaders?: ProxyHeaders;
     proxyResponseHeaders?: ProxyResponseHeaders;
     metadata?: Record<string, string | number | boolean>;
+    abortOnClientDisconnect?: boolean;
 }
 export interface ApiServiceRestActionConfig<Context extends GatewayContext, TOutput, TParams = undefined, TTransformed = TOutput> extends ApiServiceBaseActionConfig<Context, TOutput, TParams, TTransformed> {
     method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
@@ -139,6 +141,7 @@ export interface ApiServiceRestActionConfig<Context extends GatewayContext, TOut
     responseType?: AxiosRequestConfig['responseType'];
     expectedResponseContentType?: ResponseContentType | ResponseContentType[];
     maxRedirects?: number;
+    axiosRetryCondition?: AxiosRetryCondition;
 }
 export interface ApiServiceBaseGrpcActionConfig<Context extends GatewayContext, TOutput, TParams = undefined, TTransformed = TOutput> extends ApiServiceBaseActionConfig<Context, TOutput, TParams, TTransformed> {
     action: string;
@@ -167,6 +170,7 @@ export interface ApiServiceMixedExtra<Context extends GatewayContext, Req extend
     ctx: Context;
     config: GatewayConfig<Context, Req, Res>;
     grpcContext: GrpcContext;
+    abortSignal?: AbortSignal;
 }
 export type ApiServiceMixedActionConfig<Context extends GatewayContext, Req extends GatewayRequest<Context>, Res extends GatewayResponse, TOutput, TParams = undefined, TTransformed = TOutput> = (api: unknown, args: TParams, extra: ApiServiceMixedExtra<Context, Req, Res>) => Promise<TTransformed>;
 export type ApiServiceActionConfig<Context extends GatewayContext, Req extends GatewayRequest<Context>, Res extends GatewayResponse, TOutput, TParams = undefined, TTransformed = TOutput> = ApiServiceRestActionConfig<Context, TOutput, TParams, TTransformed> | ApiServiceGrpcActionConfig<Context, TOutput, TParams, TTransformed> | ApiServiceMixedActionConfig<Context, Req, Res, TOutput, TParams, TTransformed>;

package/build/utils/grpc.d.ts

@@ -1,5 +1,15 @@
 import * as grpc from '@grpc/grpc-js';
+import { ClientDuplexStream, ClientReadableStream, ClientUnaryCall, ClientWritableStream } from '@grpc/grpc-js';
 import * as protobufjs from 'protobufjs';
 export declare function decodeAnyMessageRecursively(root: protobufjs.Root, message?: unknown, decodeAnyMessageProtoLoaderOptions?: protobufjs.IConversionOptions): unknown;
 export declare function isRetryableGrpcError(error?: grpc.ServiceError): boolean;
 export declare function isRecreateServiceError(error?: grpc.ServiceError): boolean;
+export type ListenForAbortArgs = {
+    signal?: AbortSignal;
+    config: {
+        abortOnClientDisconnect?: boolean;
+    };
+    call: ClientUnaryCall | ClientReadableStream<unknown> | ClientWritableStream<unknown> | ClientDuplexStream<unknown, unknown>;
+    reject: (err: Error) => void;
+};
+export declare function listenForAbort({ signal, config, call, reject }: ListenForAbortArgs): () => void;

package/build/utils/grpc.js

@@ -1,8 +1,9 @@
 "use strict";
 /* eslint-disable camelcase */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRecreateServiceError = exports.isRetryableGrpcError = exports.decodeAnyMessageRecursively = void 0;
+exports.listenForAbort = exports.isRecreateServiceError = exports.isRetryableGrpcError = exports.decodeAnyMessageRecursively = void 0;
 const constants_1 = require("../constants");
+const parse_error_1 = require("./parse-error");
 function isEncodedMessage(message) {
     return Boolean(message.type_url && message.value);
 }
@@ -54,3 +55,25 @@ function isRecreateServiceError(error) {
     return constants_1.RECREATE_SERVICE_CODES.includes(error.code);
 }
 exports.isRecreateServiceError = isRecreateServiceError;
+function listenForAbort({ signal, config, call, reject }) {
+    if (!signal || !config.abortOnClientDisconnect) {
+        return () => null;
+    }
+    const handleAbortSignal = () => {
+        call.cancel();
+        reject(new parse_error_1.GrpcError('Request was cancelled.', {
+            status: 499,
+            code: 'REQUEST_WAS_CANCELLED',
+            message: 'Request was cancelled because the original connection was disconnected.',
+        }));
+    };
+    if (signal.aborted) {
+        handleAbortSignal();
+        return () => null;
+    }
+    signal.addEventListener('abort', handleAbortSignal);
+    return () => {
+        signal.removeEventListener('abort', handleAbortSignal);
+    };
+}
+exports.listenForAbort = listenForAbort;

package/build/utils/parse-error.js

@@ -116,6 +116,10 @@ function parseRestError(error, lang) {
             status = 504;
             description = lang === constants_1.Lang.Ru ? 'Превышено время ожидания ответа' : 'Timeout exceeded';
         }
+        else if (code === 'ERR_CANCELED') {
+            status = 499;
+            description = lang === constants_1.Lang.Ru ? 'Запрос был отменен.' : 'Request was cancelled.';
+        }
         else {
             status = 500;
             description =

package/package.json

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