@gravity-ui/gateway 1.5.0 → 1.6.0

package/README.md

@@ -116,7 +116,7 @@ interface GatewayConfig {
   validationSchema?: object;
   // Enables encoding of REST path arguments.
   encodePathArgs?: boolean;
-  // Configuration for automatic connection re-establishment upon connection error through L3 load balancer (default is false).
+  // Configuration for automatic connection re-establishment upon connection error through L3 load balancer (default is true).
   grpcRecreateService?: boolean;
 }
 ```

package/build/components/grpc.js

@@ -218,12 +218,17 @@ async function refreshCache(actionEndpoint, config, endpointData, grpcOptions, c
         return;
     }
     lodash_1.default.set(reflectionCacheStatusMap, [config.protoKey, actionEndpoint], Object.assign(Object.assign({}, cacheStatus), { isRefresh: true }));
-    const res = await getServiceInstanceReflect(config, endpointData, grpcOptions, credentials, true);
-    lodash_1.default.set(reflectionServiceInstancesMap, [config.protoKey, actionEndpoint], Promise.resolve(res));
-    lodash_1.default.set(reflectionCacheStatusMap, [config.protoKey, actionEndpoint], {
-        time: Date.now() / 1000,
-        isRefresh: false,
-    });
+    try {
+        const res = await getServiceInstanceReflect(config, endpointData, grpcOptions, credentials, true);
+        lodash_1.default.set(reflectionServiceInstancesMap, [config.protoKey, actionEndpoint], Promise.resolve(res));
+        lodash_1.default.set(reflectionCacheStatusMap, [config.protoKey, actionEndpoint], {
+            time: Date.now() / 1000,
+            isRefresh: false,
+        });
+    }
+    catch (e) {
+        lodash_1.default.set(reflectionCacheStatusMap, [config.protoKey, actionEndpoint], Object.assign(Object.assign({}, cacheStatus), { isRefresh: false }));
+    }
 }
 function getServiceInstanceReflectCached(config, endpointData, grpcOptions, credentials) {
     if (config.reflection === common_1.GrpcReflection.OnEveryRequest) {
@@ -241,6 +246,9 @@ function getServiceInstanceReflectCached(config, endpointData, grpcOptions, cred
     }
     const service = getServiceInstanceReflect(config, endpointData, grpcOptions, credentials);
     lodash_1.default.set(reflectionServiceInstancesMap, cacheKey, service);
+    service.catch(() => {
+        lodash_1.default.set(reflectionServiceInstancesMap, cacheKey, undefined);
+    });
     return service;
 }
 async function getServiceInstanceReflect(config, endpointData, grpcOptions, credentials, isRefreshCache) {
@@ -250,21 +258,22 @@ async function getServiceInstanceReflect(config, endpointData, grpcOptions, cred
         : undefined;
     const isInsecure = config.insecure || endpointInsecure;
     const creds = isInsecure ? credentials.insecure : credentials.secure;
+    const endpointGrpcOptions = (0, common_2.isExtendedGrpcActionEndpoint)(endpointData)
+        ? endpointData.grpcOptions || {}
+        : {};
+    const combinedGrpcOptions = Object.assign(Object.assign(Object.assign({}, constants_1.DEFAULT_GRPC_OPTIONS), grpcOptions), endpointGrpcOptions);
     let loadedRoot;
     if (config.reflection === common_1.GrpcReflection.OnEveryRequest || isRefreshCache) {
-        loadedRoot = await (0, grpc_reflection_1.getReflectionRoot)(actionEndpoint, config.protoKey, creds, isRefreshCache);
+        loadedRoot = await (0, grpc_reflection_1.getReflectionRoot)(actionEndpoint, config.protoKey, creds, combinedGrpcOptions, isRefreshCache);
     }
     else {
-        loadedRoot = await (0, grpc_reflection_1.getCachedReflectionRoot)(actionEndpoint, config.protoKey, creds);
+        loadedRoot = await (0, grpc_reflection_1.getCachedReflectionRoot)(actionEndpoint, config.protoKey, creds, combinedGrpcOptions);
     }
     const descriptor = loadedRoot.toDescriptor('proto3');
     const definition = protoLoader.loadFileDescriptorSetFromObject(descriptor, reflectLoaderOptions);
     const packageObject = grpc.loadPackageDefinition(definition);
     const Service = lodash_1.default.get(packageObject, config.protoKey);
-    const endpointGrpcOptions = (0, common_2.isExtendedGrpcActionEndpoint)(endpointData)
-        ? endpointData.grpcOptions || {}
-        : {};
-    const serviceInstance = new Service(actionEndpoint, creds, Object.assign(Object.assign(Object.assign({}, constants_1.DEFAULT_GRPC_OPTIONS), grpcOptions), endpointGrpcOptions));
+    const serviceInstance = new Service(actionEndpoint, creds, combinedGrpcOptions);
     return serviceInstance;
 }
 function loadAndCachePackageObject(root, protoPath) {

package/build/index.js

@@ -48,6 +48,7 @@ function isRestActionConfig(actionConfig) {
     return Boolean(actionConfig.method);
 }
 function createApiAction(schema, config, serviceKey, actionName, api, grpcContext) {
+    var _a;
     const serviceSchema = schema[serviceKey];
     if (!serviceSchema) {
         throw new config.ErrorConstructor(`Gateway config error. Service "${serviceKey}" have been not found.`, {
@@ -80,13 +81,14 @@ function createApiAction(schema, config, serviceKey, actionName, api, grpcContex
             getAuthHeaders: config.getAuthHeaders,
         }, config.ErrorConstructor);
     }
+    const grpcRecreateService = (_a = config.grpcRecreateService) !== null && _a !== void 0 ? _a : true;
     return (0, grpc_1.default)(grpcContext, endpointsConfig, action, serviceKey, actionName, {
         serviceName,
         timeout: config.timeout,
         sendStats: config.sendStats,
         proxyHeaders: config.proxyHeaders,
         grpcOptions: config.grpcOptions,
-        grpcRecreateService: config.grpcRecreateService,
+        grpcRecreateService,
         getAuthHeaders: config.getAuthHeaders,
     }, config.ErrorConstructor);
 }

package/build/utils/grpc-reflection.d.ts

@@ -1,5 +1,4 @@
 import type { ChannelCredentials } from '@grpc/grpc-js';
-import * as protobufjs from 'protobufjs';
 type DescriptorExtensionProto = string[] | {
     includeProtoRoots: string[];
     filenames: string[];
@@ -8,20 +7,22 @@ type DescriptorExtensionProto = string[] | {
  * @param actionEndpoint
  * @param protoKey
  * @param credentials
+ * @param grpcOptions
  * @param descriptorExtensionProto
  * @returns Promise<protobufjs.Root>.
  * use toDescriptor for use with protoLoader.
  * use toJSON for get a JSON descriptor.
  */
-export declare function getCachedReflectionRoot(actionEndpoint: string, protoKey: string, credentials: ChannelCredentials, descriptorExtensionProto?: DescriptorExtensionProto): Promise<protobufjs.Root>;
+export declare function getCachedReflectionRoot(actionEndpoint: string, protoKey: string, credentials: ChannelCredentials, grpcOptions?: object, descriptorExtensionProto?: DescriptorExtensionProto): Promise<any>;
 /**
  * @param actionEndpoint
  * @param protoKey
  * @param credentials
+ * @param grpcOptions
  * @param addToCache
  * @returns Promise<protobufjs.Root>.
  * use toDescriptor for use with protoLoader.
  * use toJSON for get a JSON descriptor.
  */
-export declare function getReflectionRoot(actionEndpoint: string, protoKey: string, credentials: ChannelCredentials, addToCache?: boolean): Promise<protobufjs.Root>;
+export declare function getReflectionRoot(actionEndpoint: string, protoKey: string, credentials: ChannelCredentials, grpcOptions?: object, addToCache?: boolean): Promise<any>;
 export {};

package/build/utils/grpc-reflection.js

@@ -31,10 +31,10 @@ const lodash_1 = __importDefault(require("lodash"));
 const protobufjs = __importStar(require("protobufjs"));
 const proto_path_resolver_1 = require("./proto-path-resolver");
 const reflectionClientsMap = {};
-const reflectionRootPromiseMap = {};
-function getCachedClient(actionEndpoint, credentials, descriptorExtensionProto) {
-    let client = reflectionClientsMap[actionEndpoint];
-    if (!client) {
+function getCachedClient(actionEndpoint, credentials, grpcOptions, descriptorExtensionProto) {
+    const cacheKey = [actionEndpoint, JSON.stringify([grpcOptions, descriptorExtensionProto])];
+    let clientWithCache = lodash_1.default.get(reflectionClientsMap, cacheKey);
+    if (!clientWithCache) {
         const grpcReflection = require('grpc-reflection-js');
         let descriptorRoot;
         if (descriptorExtensionProto) {
@@ -47,26 +47,32 @@ function getCachedClient(actionEndpoint, credentials, descriptorExtensionProto)
                 descriptorRoot.loadSync(descriptorExtensionProto.filenames);
             }
         }
-        client = new grpcReflection.Client(actionEndpoint, credentials, undefined, undefined, descriptorRoot);
-        reflectionClientsMap[actionEndpoint] = client;
+        const client = new grpcReflection.Client(actionEndpoint, credentials, grpcOptions, undefined, descriptorRoot);
+        clientWithCache = { client, reflectionRootPromiseMap: {} };
+        lodash_1.default.set(reflectionClientsMap, cacheKey, clientWithCache);
     }
-    return client;
+    return clientWithCache;
 }
 /**
  * @param actionEndpoint
  * @param protoKey
  * @param credentials
+ * @param grpcOptions
  * @param descriptorExtensionProto
  * @returns Promise<protobufjs.Root>.
  * use toDescriptor for use with protoLoader.
  * use toJSON for get a JSON descriptor.
  */
-async function getCachedReflectionRoot(actionEndpoint, protoKey, credentials, descriptorExtensionProto) {
-    const client = getCachedClient(actionEndpoint, credentials, descriptorExtensionProto);
-    let cachedRootPromise = lodash_1.default.get(reflectionRootPromiseMap, [actionEndpoint, protoKey]);
+async function getCachedReflectionRoot(actionEndpoint, protoKey, credentials, grpcOptions, descriptorExtensionProto) {
+    const { client, reflectionRootPromiseMap } = getCachedClient(actionEndpoint, credentials, grpcOptions, descriptorExtensionProto);
+    const cacheKey = [actionEndpoint, protoKey];
+    let cachedRootPromise = lodash_1.default.get(reflectionRootPromiseMap, cacheKey);
     if (!cachedRootPromise) {
         cachedRootPromise = client.fileContainingSymbol(protoKey);
-        lodash_1.default.set(reflectionRootPromiseMap, [actionEndpoint, protoKey], cachedRootPromise);
+        lodash_1.default.set(reflectionRootPromiseMap, cacheKey, cachedRootPromise);
+        cachedRootPromise.catch(() => {
+            lodash_1.default.set(reflectionRootPromiseMap, cacheKey, undefined);
+        });
     }
     const loadedRoot = await cachedRootPromise;
     return loadedRoot;
@@ -76,13 +82,14 @@ exports.getCachedReflectionRoot = getCachedReflectionRoot;
  * @param actionEndpoint
  * @param protoKey
  * @param credentials
+ * @param grpcOptions
  * @param addToCache
  * @returns Promise<protobufjs.Root>.
  * use toDescriptor for use with protoLoader.
  * use toJSON for get a JSON descriptor.
  */
-async function getReflectionRoot(actionEndpoint, protoKey, credentials, addToCache) {
-    const client = getCachedClient(actionEndpoint, credentials);
+async function getReflectionRoot(actionEndpoint, protoKey, credentials, grpcOptions, addToCache) {
+    const { client, reflectionRootPromiseMap } = getCachedClient(actionEndpoint, credentials, grpcOptions);
     const loadedRoot = await client.fileContainingSymbol(protoKey);
     if (addToCache) {
         lodash_1.default.set(reflectionRootPromiseMap, [actionEndpoint, protoKey], Promise.resolve(loadedRoot));

package/package.json

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