@gravity-ui/gateway 3.1.4-alpha.0 → 4.0.0

package/README.md

@@ -13,7 +13,7 @@ npm install --save-dev @gravity-ui/gateway
 First of all, you need to create a controller where you will import Gateway and Schema, and then return the initialized gateway controller:
 
 ```javascript
-import getGatewayControllers from '@gravity-ui/gateway';
+import {getGatewayControllers} from '@gravity-ui/gateway';
 import Schema from '<schemas package>';
 
 const config = {
@@ -134,7 +134,7 @@ If the parameter value does not pass validation, the `GATEWAY_INVALID_PARAM_VALU
 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.
 
 ```javascript
-import getGatewayControllers from '@gravity-ui/gateway';
+import {getGatewayControllers} from '@gravity-ui/gateway';
 import Schema from '<schemas package>';
 
 const config = {
@@ -180,7 +180,7 @@ const schemasByScopes = {scope1: schema1, scope2: schema2};
 Example with two scope namespaces: `root` and `anotherScope`.
 
 ```javascript
-import getGatewayControllers from '@gravity-ui/gateway';
+import {getGatewayControllers} from '@gravity-ui/gateway';
 
 const {
     controller, // Controller
@@ -215,7 +215,7 @@ If the scope parameter is not specified, the default scope is assumed to be `roo
 When initializing the `gateway`, there is an option to explicitly specify the actions that need to be connected from the schemas. To do this, provide a list of available client-side actions in the `actions` field in the config. If `actions` are not provided, all actions from the schemas are connected by default.
 
 ```typescript
-import getGatewayControllers from '@gravity-ui/gateway';
+import {getGatewayControllers} from '@gravity-ui/gateway';
 import rootSchema from '<schemas package>';
 import localSchema from '../shared/schemas';
 

package/build/components/grpc.js

@@ -71,14 +71,14 @@ function getCredentialsMap(caCertificatePath) {
     };
 }
 exports.getCredentialsMap = getCredentialsMap;
-function decodeResponse(response, packageRoot, ctx, encodedFields = [], ErrorConstructor, decodeAnyMessageProtoLoaderOptions) {
+function decodeResponse(response, packageRoot, ctx, encodedFields = [], ErrorConstructor) {
     const systemFields = ['metadata', 'response', 'error.details'];
     [...systemFields, ...encodedFields].forEach((fieldName) => {
         try {
             const parsedFieldName = fieldName.replace(/\.\*$/, '');
             const fieldValue = lodash_1.default.get(response, parsedFieldName);
             if (fieldValue) {
-                lodash_1.default.set(response, parsedFieldName, (0, grpc_1.decodeAnyMessageRecursively)(packageRoot, fieldValue, decodeAnyMessageProtoLoaderOptions));
+                lodash_1.default.set(response, parsedFieldName, (0, grpc_1.decodeAnyMessageRecursively)(packageRoot, fieldValue));
             }
         }
         catch (error) {
@@ -301,15 +301,15 @@ async function getServiceInstance(root, config, endpointData, grpcOptions, crede
     }
     return serviceInstance;
 }
-async function getResponseData({ config, response, ctx, packageRoot, args, ErrorConstructor, decodeAnyMessageProtoLoaderOptions, }) {
+async function getResponseData({ config, response, ctx, packageRoot, args, ErrorConstructor, }) {
     // Handle operation's runtime protocol buffers
     if (response) {
         const encodedFields = config.encodedFields;
         if (Array.isArray(response)) {
-            response.forEach((responseItem) => decodeResponse(responseItem, packageRoot, ctx, encodedFields, ErrorConstructor, decodeAnyMessageProtoLoaderOptions));
+            response.forEach((responseItem) => decodeResponse(responseItem, packageRoot, ctx, encodedFields, ErrorConstructor));
         }
         else if (typeof response === 'object') {
-            decodeResponse(response, packageRoot, ctx, encodedFields, ErrorConstructor, decodeAnyMessageProtoLoaderOptions);
+            decodeResponse(response, packageRoot, ctx, encodedFields, ErrorConstructor);
         }
     }
     let responseData = response;
@@ -526,7 +526,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                         ctx.log('ServerStream error', {
                             debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
                         });
-                        processError(new parse_error_1.GrpcError('ClientReadableStream error', (0, parse_error_1.parseGrpcError)(error, root, lang, config.decodeAnyMessageProtoLoaderOptions), error));
+                        processError(new parse_error_1.GrpcError('ClientReadableStream error', (0, parse_error_1.parseGrpcError)(error, root, lang), error));
                     });
                     stream.on('status', (status) => {
                         ctx.log('ServerStream status changed', status);
@@ -566,7 +566,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                         ctx.log('BidiStream error', {
                             debugHeaders: (0, common_2.sanitizeDebugHeaders)(debugHeaders),
                         });
-                        processError(new parse_error_1.GrpcError('BidiStream error', (0, parse_error_1.parseGrpcError)(error, root, lang, config.decodeAnyMessageProtoLoaderOptions), error));
+                        processError(new parse_error_1.GrpcError('BidiStream error', (0, parse_error_1.parseGrpcError)(error, root, lang), error));
                     });
                     stream.on('status', (status) => {
                         ctx.log('BidiStream status changed', status);
@@ -618,7 +618,7 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                                 return;
                             }
                             if (error) {
-                                reject(new parse_error_1.GrpcError('gRPC request error', (0, parse_error_1.parseGrpcError)(error, root, lang, config.decodeAnyMessageProtoLoaderOptions), error));
+                                reject(new parse_error_1.GrpcError('gRPC request error', (0, parse_error_1.parseGrpcError)(error, root, lang), error));
                                 return;
                             }
                             const responseData = await getResponseData({
@@ -628,7 +628,6 @@ function createGrpcAction({ root, credentials }, endpoints, config, serviceKey,
                                 args,
                                 packageRoot: root,
                                 ErrorConstructor,
-                                decodeAnyMessageProtoLoaderOptions: config.decodeAnyMessageProtoLoaderOptions,
                             });
                             const responseHeaders = {};
                             if (config.proxyResponseHeaders) {

package/build/index.d.ts

@@ -5,7 +5,7 @@ export * from './utils/grpc-reflection';
 export * from './models/common';
 export * from './models/context';
 export * from './models/error';
-export default function getGatewayControllers<TSchema extends SchemasByScope, Context extends GatewayContext, Req extends GatewayRequest<Context>, Res extends GatewayResponse>(schemasByScope: TSchema, config: GatewayConfig<Context, Req, Res>): {
+export declare function getGatewayControllers<TSchema extends SchemasByScope, Context extends GatewayContext, Req extends GatewayRequest<Context>, Res extends GatewayResponse>(schemasByScope: TSchema, config: GatewayConfig<Context, Req, Res>): {
     controller: (req: Req, res: Res) => Promise<any>;
     api: ApiWithRoot<TSchema, Context, Req, Res>;
 };

package/build/index.js

@@ -29,6 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGatewayControllers = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const grpc_1 = __importStar(require("./components/grpc"));
 const mixed_1 = require("./components/mixed");
@@ -292,4 +293,4 @@ function getGatewayControllers(schemasByScope, config) {
         api,
     };
 }
-exports.default = getGatewayControllers;
+exports.getGatewayControllers = getGatewayControllers;

package/build/models/common.d.ts

@@ -4,7 +4,6 @@ import { ClientDuplexStream, ClientReadableStream, ClientWritableStream } from '
 import { HandlerType } from '@grpc/grpc-js/build/src/server-call';
 import { AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
 import type { Request, Response } from 'express';
-import * as protobufjs from 'protobufjs';
 import type { GrpcContext } from '../components/grpc';
 import { Lang } from '../constants';
 import { GatewayContext } from './context';
@@ -142,7 +141,6 @@ export interface ApiServiceBaseGrpcActionConfig<Context extends GatewayContext,
     secureWithoutRootCert?: boolean;
     encodedFields?: string[];
     type?: HandlerType;
-    decodeAnyMessageProtoLoaderOptions?: protobufjs.IConversionOptions;
 }
 export interface ApiServiceFileGrpcActionConfig<Context extends GatewayContext, TOutput, TParams, TTransformed> extends ApiServiceBaseGrpcActionConfig<Context, TOutput, TParams, TTransformed> {
     protoPath: string;

package/build/utils/grpc.d.ts

@@ -1,5 +1,5 @@
 import * as grpc 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 decodeAnyMessageRecursively(root: protobufjs.Root, message?: unknown): unknown;
 export declare function isRetryableError(error?: grpc.ServiceError): boolean;
 export declare function isRecreateServiceError(error?: grpc.ServiceError): boolean;

package/build/utils/grpc.js

@@ -6,16 +6,16 @@ const constants_1 = require("../constants");
 function isEncodedMessage(message) {
     return Boolean(message.type_url && message.value);
 }
-function decodeAnyMessageRecursively(root, message, decodeAnyMessageProtoLoaderOptions) {
+function decodeAnyMessageRecursively(root, message) {
     if (!message || typeof message !== 'object') {
         return message;
     }
     if (Array.isArray(message)) {
-        return message.map((innerMessage) => decodeAnyMessageRecursively(root, innerMessage, decodeAnyMessageProtoLoaderOptions));
+        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, decodeAnyMessageProtoLoaderOptions);
+            res[key] = decodeAnyMessageRecursively(root, value);
             return res;
         }, {});
     }
@@ -25,8 +25,8 @@ function decodeAnyMessageRecursively(root, message, decodeAnyMessageProtoLoaderO
     }
     const typeName = message.type_url.substring(lastSlashIndex + 1);
     const type = root.lookupType(typeName);
-    const decodedMessage = type.toObject(type.decode(message.value), Object.assign(Object.assign({}, constants_1.DEFAULT_PROTO_LOADER_OPTIONS), decodeAnyMessageProtoLoaderOptions));
-    return decodeAnyMessageRecursively(root, decodedMessage, decodeAnyMessageProtoLoaderOptions);
+    const decodedMessage = type.toObject(type.decode(message.value), constants_1.DEFAULT_PROTO_LOADER_OPTIONS);
+    return decodeAnyMessageRecursively(root, decodedMessage);
 }
 exports.decodeAnyMessageRecursively = decodeAnyMessageRecursively;
 function isRetryableError(error) {

package/build/utils/parse-error.d.ts

@@ -17,7 +17,7 @@ export declare function parseMixedError(e: Error & {
     };
 };
 export declare function parseRestError(error: any, lang?: string): GatewayError;
-export declare function parseGrpcError(error: grpc.ServiceError, packageRoot: protobufjs.Root, lang?: Lang, decodeAnyMessageProtoLoaderOptions?: protobufjs.IConversionOptions): GatewayError;
+export declare function parseGrpcError(error: grpc.ServiceError, packageRoot: protobufjs.Root, lang?: Lang): GatewayError;
 export declare class GrpcError extends Error {
     private parsedError;
     private rawError;

package/build/utils/parse-error.js

@@ -135,7 +135,7 @@ function parseRestError(error, lang) {
     };
 }
 exports.parseRestError = parseRestError;
-function decodeGrpcStatusMessage(metadata, packageRoot, decodeAnyMessageProtoLoaderOptions) {
+function decodeGrpcStatusMessage(metadata, packageRoot) {
     const statusMessageBin = metadata.get('grpc-status-details-bin')[0];
     if (!statusMessageBin) {
         return undefined;
@@ -143,9 +143,9 @@ function decodeGrpcStatusMessage(metadata, packageRoot, decodeAnyMessageProtoLoa
     return (0, grpc_1.decodeAnyMessageRecursively)(packageRoot, {
         type_url: 'type.googleapis.com/google.rpc.Status',
         value: statusMessageBin,
-    }, decodeAnyMessageProtoLoaderOptions);
+    });
 }
-function parseGrpcError(error, packageRoot, lang = constants_1.Lang.Ru, decodeAnyMessageProtoLoaderOptions) {
+function parseGrpcError(error, packageRoot, lang = constants_1.Lang.Ru) {
     let title = lang === constants_1.Lang.Ru ? 'Ошибка' : 'Error';
     if (error.code === 7) {
         // Always redefine title for Access denied errors
@@ -156,7 +156,7 @@ function parseGrpcError(error, packageRoot, lang = constants_1.Lang.Ru, decodeAn
     let details;
     if (error.metadata) {
         try {
-            const statusMessage = decodeGrpcStatusMessage(error.metadata, packageRoot, decodeAnyMessageProtoLoaderOptions);
+            const statusMessage = decodeGrpcStatusMessage(error.metadata, packageRoot);
             if (statusMessage) {
                 code = statusMessage.code;
                 description = statusMessage.message;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/gateway",
-  "version": "3.1.4-alpha.0",
+  "version": "4.0.0",
   "description": "",
   "license": "MIT",
   "main": "build/index.js",
@@ -29,7 +29,9 @@
     "start-integration-server": "node build-integration/integration-test/server",
     "build-and-run-integration": "npm run build-integration && npm run start-integration-server",
     "clean": "rm -rf build && rm -rf build-integration",
-    "lint": "eslint \"lib/**/*.{js,ts}\" --quiet",
+    "lint": "npm run lint:code && npm run lint:exports",
+    "lint:code": "eslint \"lib/**/*.{js,ts}\" --quiet",
+    "lint:exports": "npm run build && attw --pack .",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build",
     "test": "jest --colors",
@@ -48,6 +50,7 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.3",
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
     "@gravity-ui/eslint-config": "^2.0.0",