@rsdk/grpc.clients 2.6.0-next.0 → 2.6.0-next.1

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.6.0-next.1](https://github.com/R-Vision/rsdk/compare/v2.6.0-next.0...v2.6.0-next.1) (2023-07-04)
+
+### Bug Fixes
+
+* gRPC error mapping into rsdk exceptions ([8c6a2b8](https://github.com/R-Vision/rsdk/commit/8c6a2b8276a7a309d26bc21e4c9ae36d7ee4210c))
+
 # [2.6.0-next.0](https://github.com/R-Vision/rsdk/compare/v2.5.0...v2.6.0-next.0) (2023-07-03)
 
 ### Bug Fixes

package/dist/middleware/exception-mapper.middleware.d.ts

@@ -0,0 +1,5 @@
+import type { ClientMiddleware } from 'nice-grpc-common';
+/**
+ * Client middleware that performs gRPC code mapping into RSDK exception
+ */
+export declare const exceptionMapperMiddleware: () => ClientMiddleware;

package/dist/middleware/exception-mapper.middleware.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exceptionMapperMiddleware = void 0;
+const core_1 = require("@rsdk/core");
+const nice_grpc_1 = require("nice-grpc");
+/**
+ * Client middleware that performs gRPC code mapping into RSDK exception
+ */
+const exceptionMapperMiddleware = () => 
+// eslint-disable-next-line unicorn/consistent-function-scoping
+async function* (call, options) {
+    try {
+        return yield* call.next(call.request, options);
+    }
+    catch (error) {
+        if (!(error instanceof nice_grpc_1.ClientError)) {
+            throw new core_1.InternalException('GRPC call failed with unknown error', {
+                cause: error,
+            });
+        }
+        const message = 'GRPC Call failed!';
+        const props = {
+            details: {
+                /*
+                 * Details - will be original message from server,
+                 * while message field will be a composite string with
+                 * status path and original message in one line
+                 */
+                message: error.details,
+                /**
+                 * GRPC-package and method
+                 */
+                path: error.path,
+                /**
+                 * TBD: Other context from original error is not yet passed
+                 * via GRPC. Will be added later.
+                 */
+            },
+        };
+        /**
+         * According to /docs/images/exceptions.mapping.png
+         */
+        switch (error.code) {
+            case nice_grpc_1.Status.DEADLINE_EXCEEDED:
+                throw new core_1.TimeoutException(message, props);
+            case nice_grpc_1.Status.INVALID_ARGUMENT:
+                throw new core_1.InputException(message, props);
+            case nice_grpc_1.Status.ALREADY_EXISTS:
+                throw new core_1.DuplicateEntityException(message, props);
+            case nice_grpc_1.Status.FAILED_PRECONDITION:
+                throw new core_1.ConflictException(message, props);
+            case nice_grpc_1.Status.UNAUTHENTICATED:
+                throw new core_1.AuthException(message, props);
+            case nice_grpc_1.Status.PERMISSION_DENIED:
+                throw new core_1.NotAllowedException(message, props);
+            case nice_grpc_1.Status.NOT_FOUND:
+                throw new core_1.NotFoundException(message, props);
+            default:
+                throw new core_1.InternalException(message, props);
+        }
+    }
+};
+exports.exceptionMapperMiddleware = exceptionMapperMiddleware;
+//# sourceMappingURL=exception-mapper.middleware.js.map

package/dist/middleware/exception-mapper.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exception-mapper.middleware.js","sourceRoot":"","sources":["../../src/middleware/exception-mapper.middleware.ts"],"names":[],"mappings":";;;AAAA,qCASoB;AACpB,yCAAgD;AAGhD;;GAEG;AACI,MAAM,yBAAyB,GAAG,GAAqB,EAAE;AAC9D,+DAA+D;AAC/D,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO;IAC5B,IAAI;QACF,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KAChD;IAAC,OAAO,KAAc,EAAE;QACvB,IAAI,CAAC,CAAC,KAAK,YAAY,uBAAW,CAAC,EAAE;YACnC,MAAM,IAAI,wBAAiB,CAAC,qCAAqC,EAAE;gBACjE,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;SACJ;QAED,MAAM,OAAO,GAAG,mBAAmB,CAAC;QACpC,MAAM,KAAK,GAAG;YACZ,OAAO,EAAE;gBACP;;;;mBAIG;gBACH,OAAO,EAAE,KAAK,CAAC,OAAO;gBAEtB;;mBAEG;gBACH,IAAI,EAAE,KAAK,CAAC,IAAI;gBAEhB;;;mBAGG;aACJ;SACF,CAAC;QAEF;;WAEG;QACH,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,kBAAM,CAAC,iBAAiB;gBAC3B,MAAM,IAAI,uBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC7C,KAAK,kBAAM,CAAC,gBAAgB;gBAC1B,MAAM,IAAI,qBAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3C,KAAK,kBAAM,CAAC,cAAc;gBACxB,MAAM,IAAI,+BAAwB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACrD,KAAK,kBAAM,CAAC,mBAAmB;gBAC7B,MAAM,IAAI,wBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9C,KAAK,kBAAM,CAAC,eAAe;gBACzB,MAAM,IAAI,oBAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC1C,KAAK,kBAAM,CAAC,iBAAiB;gBAC3B,MAAM,IAAI,0BAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAChD,KAAK,kBAAM,CAAC,SAAS;gBACnB,MAAM,IAAI,wBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9C;gBACE,MAAM,IAAI,wBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SAC/C;KACF;AACH,CAAC,CAAC;AAxDS,QAAA,yBAAyB,6BAwDlC"}

package/dist/repository/grpc-client.repository.d.ts

@@ -6,13 +6,11 @@ import type { CompatServiceDefinition } from 'nice-grpc/lib/service-definitions'
  */
 export declare class GrpcClientRepository {
     private static factory;
-    logger: import("@rsdk/logging").ILogger;
-    servers: Set<string>;
-    definitions: Set<CompatServiceDefinition>;
-    channels: Map<string, ChannelImplementation>;
-    clients: Map<string, Client<CompatServiceDefinition>>;
-    private static createChannel;
-    private static createClient;
+    readonly logger: import("@rsdk/logging").ILogger;
+    readonly servers: Set<string>;
+    readonly definitions: Set<CompatServiceDefinition>;
+    readonly channels: Map<string, ChannelImplementation>;
+    readonly clients: Map<string, Client<CompatServiceDefinition>>;
     resolveChannel(address: string, channelToken: string): ChannelImplementation;
     resolveClient(definition: CompatServiceDefinition, channel: ChannelImplementation, clientToken: string): Client<CompatServiceDefinition>;
 }

package/dist/repository/grpc-client.repository.js

@@ -4,11 +4,14 @@ exports.GrpcClientRepository = void 0;
 const logging_1 = require("@rsdk/logging");
 const nice_grpc_1 = require("nice-grpc");
 const nice_grpc_opentelemetry_1 = require("nice-grpc-opentelemetry");
+const exception_mapper_middleware_1 = require("../middleware/exception-mapper.middleware");
 /**
  * Простое кеш хранилище внутри DI для кеширования на замену статике
  */
 class GrpcClientRepository {
-    static factory = (0, nice_grpc_1.createClientFactory)().use((0, nice_grpc_opentelemetry_1.openTelemetryClientMiddleware)());
+    static factory = (0, nice_grpc_1.createClientFactory)()
+        .use((0, nice_grpc_opentelemetry_1.openTelemetryClientMiddleware)())
+        .use((0, exception_mapper_middleware_1.exceptionMapperMiddleware)());
     logger = logging_1.LoggerFactory.create(GrpcClientRepository);
     // Registration
     servers = new Set();
@@ -16,21 +19,14 @@ class GrpcClientRepository {
     // Caches
     channels = new Map();
     clients = new Map();
-    static createChannel(address) {
-        return (0, nice_grpc_1.createChannel)(address);
-    }
-    static createClient(definition, channel) {
-        return GrpcClientRepository.factory.create(definition, channel);
-    }
     resolveChannel(address, channelToken) {
-        const existed = this.channels.get(channelToken) ??
-            GrpcClientRepository.createChannel(address);
-        this.channels.set(channelToken, existed);
-        return existed;
+        const channel = this.channels.get(channelToken) ?? (0, nice_grpc_1.createChannel)(address);
+        this.channels.set(channelToken, channel);
+        return channel;
     }
     resolveClient(definition, channel, clientToken) {
         const existed = this.clients.get(clientToken) ??
-            GrpcClientRepository.createClient(definition, channel);
+            GrpcClientRepository.factory.create(definition, channel);
         this.clients.set(clientToken, existed);
         return existed;
     }

package/dist/repository/grpc-client.repository.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc-client.repository.js","sourceRoot":"","sources":["../../src/repository/grpc-client.repository.ts"],"names":[],"mappings":";;;AACA,2CAA8C;AAE9C,yCAA+D;AAE/D,qEAAwE;AAExE;;GAEG;AACH,MAAa,oBAAoB;IACvB,MAAM,CAAC,OAAO,GAAkB,IAAA,+BAAmB,GAAE,CAAC,GAAG,CAC/D,IAAA,uDAA6B,GAAE,CAChC,CAAC;IAEF,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACpD,eAAe;IACf,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5B,WAAW,GAAG,IAAI,GAAG,EAA2B,CAAC;IACjD,SAAS;IACT,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IACtC,OAAO,GAAG,IAAI,GAAG,EAA2C,CAAC;IAErD,MAAM,CAAC,aAAa,CAAC,OAAe;QAC1C,OAAO,IAAA,yBAAa,EAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,YAAY,CACzB,UAAmC,EACnC,OAA8B;QAE9B,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,YAAoB;QAClD,MAAM,OAAO,GACX,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC;YAC/B,oBAAoB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE9C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CACX,UAAmC,EACnC,OAA8B,EAC9B,WAAmB;QAEnB,MAAM,OAAO,GACX,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;YAC7B,oBAAoB,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAEzD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9CH,oDA+CC"}
+{"version":3,"file":"grpc-client.repository.js","sourceRoot":"","sources":["../../src/repository/grpc-client.repository.ts"],"names":[],"mappings":";;;AACA,2CAA8C;AAE9C,yCAA+D;AAE/D,qEAAwE;AAExE,2FAAsF;AAEtF;;GAEG;AACH,MAAa,oBAAoB;IACvB,MAAM,CAAC,OAAO,GAAG,IAAA,+BAAmB,GAAE;SAC3C,GAAG,CAAC,IAAA,uDAA6B,GAAE,CAAC;SACpC,GAAG,CAAC,IAAA,uDAAyB,GAAE,CAAC,CAAC;IAE3B,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAE7D,eAAe;IACN,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5B,WAAW,GAAG,IAAI,GAAG,EAA2B,CAAC;IAE1D,SAAS;IACA,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IACtC,OAAO,GAAG,IAAI,GAAG,EAA2C,CAAC;IAEtE,cAAc,CAAC,OAAe,EAAE,YAAoB;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,IAAA,yBAAa,EAAC,OAAO,CAAC,CAAC;QAE1E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CACX,UAAmC,EACnC,OAA8B,EAC9B,WAAmB;QAEnB,MAAM,OAAO,GACX,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;YAC7B,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAE3D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC;IACjB,CAAC;;AAnCH,oDAoCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/grpc.clients",
-  "version": "2.6.0-next.0",
+  "version": "2.6.0-next.1",
   "description": "Grpc clients infrastructure",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -19,13 +19,13 @@
     "@nestjs/microservices": "^9.0.0",
     "@rsdk/autodoc.protocol": "^2.4.2",
     "@rsdk/common": "^2.4.2",
-    "@rsdk/core": "^2.5.0",
-    "@rsdk/grpc.common": "^2.5.0",
+    "@rsdk/core": "^2.6.0-next.1",
+    "@rsdk/grpc.common": "^2.6.0-next.1",
     "@rsdk/logging": "^2.4.2",
     "@rsdk/metadata": "^2.4.2",
     "nice-grpc": "^2.1.4",
     "nice-grpc-opentelemetry": "^0.1.2",
     "rxjs": "^7.0.0"
   },
-  "gitHead": "0b5c41c482784db44ab35ef3b8990d10f9978645"
+  "gitHead": "aa325d2181ddb9438fd4596bc2c793121ad3ef6f"
 }

package/src/middleware/exception-mapper.middleware.ts

@@ -0,0 +1,73 @@
+import {
+  AuthException,
+  ConflictException,
+  DuplicateEntityException,
+  InputException,
+  InternalException,
+  NotAllowedException,
+  NotFoundException,
+  TimeoutException,
+} from '@rsdk/core';
+import { ClientError, Status } from 'nice-grpc';
+import type { ClientMiddleware } from 'nice-grpc-common';
+
+/**
+ * Client middleware that performs gRPC code mapping into RSDK exception
+ */
+export const exceptionMapperMiddleware = (): ClientMiddleware =>
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  async function* (call, options) {
+    try {
+      return yield* call.next(call.request, options);
+    } catch (error: unknown) {
+      if (!(error instanceof ClientError)) {
+        throw new InternalException('GRPC call failed with unknown error', {
+          cause: error,
+        });
+      }
+
+      const message = 'GRPC Call failed!';
+      const props = {
+        details: {
+          /*
+           * Details - will be original message from server,
+           * while message field will be a composite string with
+           * status path and original message in one line
+           */
+          message: error.details,
+
+          /**
+           * GRPC-package and method
+           */
+          path: error.path,
+
+          /**
+           * TBD: Other context from original error is not yet passed
+           * via GRPC. Will be added later.
+           */
+        },
+      };
+
+      /**
+       * According to /docs/images/exceptions.mapping.png
+       */
+      switch (error.code) {
+        case Status.DEADLINE_EXCEEDED:
+          throw new TimeoutException(message, props);
+        case Status.INVALID_ARGUMENT:
+          throw new InputException(message, props);
+        case Status.ALREADY_EXISTS:
+          throw new DuplicateEntityException(message, props);
+        case Status.FAILED_PRECONDITION:
+          throw new ConflictException(message, props);
+        case Status.UNAUTHENTICATED:
+          throw new AuthException(message, props);
+        case Status.PERMISSION_DENIED:
+          throw new NotAllowedException(message, props);
+        case Status.NOT_FOUND:
+          throw new NotFoundException(message, props);
+        default:
+          throw new InternalException(message, props);
+      }
+    }
+  };

package/src/repository/grpc-client.repository.ts

@@ -1,45 +1,36 @@
 import type { ChannelImplementation } from '@grpc/grpc-js/build/src/channel';
 import { LoggerFactory } from '@rsdk/logging';
-import type { Channel, Client, ClientFactory } from 'nice-grpc';
+import type { Channel, Client } from 'nice-grpc';
 import { createChannel, createClientFactory } from 'nice-grpc';
 import type { CompatServiceDefinition } from 'nice-grpc/lib/service-definitions';
 import { openTelemetryClientMiddleware } from 'nice-grpc-opentelemetry';
 
+import { exceptionMapperMiddleware } from '../middleware/exception-mapper.middleware';
+
 /**
  * Простое кеш хранилище внутри DI для кеширования на замену статике
  */
 export class GrpcClientRepository {
-  private static factory: ClientFactory = createClientFactory().use(
-    openTelemetryClientMiddleware(),
-  );
+  private static factory = createClientFactory()
+    .use(openTelemetryClientMiddleware())
+    .use(exceptionMapperMiddleware());
 
-  logger = LoggerFactory.create(GrpcClientRepository);
-  // Registration
-  servers = new Set<string>();
-  definitions = new Set<CompatServiceDefinition>();
-  // Caches
-  channels = new Map<string, Channel>();
-  clients = new Map<string, Client<CompatServiceDefinition>>();
+  readonly logger = LoggerFactory.create(GrpcClientRepository);
 
-  private static createChannel(address: string): Channel {
-    return createChannel(address);
-  }
+  // Registration
+  readonly servers = new Set<string>();
+  readonly definitions = new Set<CompatServiceDefinition>();
 
-  private static createClient(
-    definition: CompatServiceDefinition,
-    channel: ChannelImplementation,
-  ): Client<CompatServiceDefinition> {
-    return GrpcClientRepository.factory.create(definition, channel);
-  }
+  // Caches
+  readonly channels = new Map<string, Channel>();
+  readonly clients = new Map<string, Client<CompatServiceDefinition>>();
 
   resolveChannel(address: string, channelToken: string): ChannelImplementation {
-    const existed: Channel =
-      this.channels.get(channelToken) ??
-      GrpcClientRepository.createChannel(address);
+    const channel = this.channels.get(channelToken) ?? createChannel(address);
 
-    this.channels.set(channelToken, existed);
+    this.channels.set(channelToken, channel);
 
-    return existed;
+    return channel;
   }
 
   resolveClient(
@@ -49,7 +40,7 @@ export class GrpcClientRepository {
   ): Client<CompatServiceDefinition> {
     const existed: Client<CompatServiceDefinition> =
       this.clients.get(clientToken) ??
-      GrpcClientRepository.createClient(definition, channel);
+      GrpcClientRepository.factory.create(definition, channel);
 
     this.clients.set(clientToken, existed);