@rsdk/grpc.clients 2.6.0-next.12 → 2.6.0-next.14

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 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.14](https://github.com/R-Vision/rsdk/compare/v2.6.0-next.13...v2.6.0-next.14) (2023-08-03)
+
+### Features
+
+* **grpc.clients:** grpc rich error ([#85](https://github.com/R-Vision/rsdk/issues/85)) ([be99f40](https://github.com/R-Vision/rsdk/commit/be99f408295bf1750f6f0c39e067cca971d973e3))
+
+# [2.6.0-next.13](https://github.com/R-Vision/rsdk/compare/v2.6.0-next.12...v2.6.0-next.13) (2023-08-01)
+
+**Note:** Version bump only for package @rsdk/grpc.clients
+
 # [2.6.0-next.12](https://github.com/R-Vision/rsdk/compare/v2.6.0-next.11...v2.6.0-next.12) (2023-07-28)
 
 **Note:** Version bump only for package @rsdk/grpc.clients

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exceptionMapperMiddleware = void 0;
+const error_1 = require("@rsdk/builtin-contract/dist/grpc/error/v1/error");
 const core_1 = require("@rsdk/core");
 const nice_grpc_1 = require("nice-grpc");
 /**
@@ -9,8 +10,22 @@ const nice_grpc_1 = require("nice-grpc");
 const exceptionMapperMiddleware = () => 
 // eslint-disable-next-line unicorn/consistent-function-scoping
 async function* (call, options) {
+    let status;
     try {
-        return yield* call.next(call.request, options);
+        return yield* call.next(call.request, {
+            ...options,
+            /**
+             * @link https://github.com/deeplay-io/nice-grpc/blob/2d781a477911b1d8a4a7b2faae27c7374ade8076/packages/nice-grpc-error-details/src/client/errorDetailsClientMiddleware.ts#L13
+             * @param trailer
+             */
+            onTrailer(trailer) {
+                const detailsBuffer = trailer.get('grpc-status-details-bin');
+                if (detailsBuffer != null) {
+                    status = error_1.Status.decode(detailsBuffer);
+                }
+                options.onTrailer?.(trailer);
+            },
+        });
     }
     catch (error) {
         if (!(error instanceof nice_grpc_1.ClientError)) {
@@ -32,14 +47,23 @@ async function* (call, options) {
                  */
                 path: error.path,
                 /**
-                 * TBD: Other context from original error is not yet passed
-                 * via GRPC. Will be added later.
+                 * A developer-facing error message, which should be in English. Any
+                 * user-facing error message should be localized and sent in the
+                 * [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
+                 *
+                 * https://github.com/deeplay-io/nice-grpc/blob/f0db4d130e1243db1cecb6586dca679e5d9b8fd5/packages/nice-grpc-error-details/proto/google/rpc/status.proto#L39
+                 */
+                statusMessage: status?.message,
+                /**
+                 * any context from call
                  */
+                details: status?.details,
             },
         };
         /**
          * According to /docs/images/exceptions.mapping.png
          */
+        // TODO: maybe replace to map and `Reflect.construct`
         switch (error.code) {
             case nice_grpc_1.Status.DEADLINE_EXCEEDED:
                 throw new core_1.TimeoutException(message, props);

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

@@ -1 +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"}
+{"version":3,"file":"exception-mapper.middleware.js","sourceRoot":"","sources":["../../src/middleware/exception-mapper.middleware.ts"],"names":[],"mappings":";;;AAAA,2EAAyE;AACzE,qCASoB;AACpB,yCAAkE;AAGlE;;GAEG;AACI,MAAM,yBAAyB,GAAG,GAAqB,EAAE;AAC9D,+DAA+D;AAC/D,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO;IAC5B,IAAI,MAA0B,CAAC;IAE/B,IAAI;QACF,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACpC,GAAG,OAAO;YACV;;;eAGG;YACH,SAAS,CAAC,OAAO;gBACf,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;gBAE7D,IAAI,aAAa,IAAI,IAAI,EAAE;oBACzB,MAAM,GAAG,cAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;iBACvC;gBAED,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;KACJ;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;;;;;;mBAMG;gBACH,aAAa,EAAE,MAAM,EAAE,OAAO;gBAE9B;;mBAEG;gBACH,OAAO,EAAE,MAAM,EAAE,OAAO;aACzB;SACF,CAAC;QAEF;;WAEG;QAEH,qDAAqD;QACrD,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,kBAAc,CAAC,iBAAiB;gBACnC,MAAM,IAAI,uBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC7C,KAAK,kBAAc,CAAC,gBAAgB;gBAClC,MAAM,IAAI,qBAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3C,KAAK,kBAAc,CAAC,cAAc;gBAChC,MAAM,IAAI,+BAAwB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACrD,KAAK,kBAAc,CAAC,mBAAmB;gBACrC,MAAM,IAAI,wBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9C,KAAK,kBAAc,CAAC,eAAe;gBACjC,MAAM,IAAI,oBAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC1C,KAAK,kBAAc,CAAC,iBAAiB;gBACnC,MAAM,IAAI,0BAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAChD,KAAK,kBAAc,CAAC,SAAS;gBAC3B,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;AApFS,QAAA,yBAAyB,6BAoFlC"}

package/dist/servers/grpc.servers.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc.servers.js","sourceRoot":"","sources":["../../src/servers/grpc.servers.ts"],"names":[],"mappings":";;;AAQA,MAAa,WAAW;IACtB,MAAM,CAAC,MAAM,CACX,WAAmC;QAEnC,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CACnD,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE;YAC3B,OAAO;gBACL,UAAU;gBACV,WAAW,CAAC,eAAe,CAAC,UAAU,EAAE,UAAU,CAAC;aACpD,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,OAAO,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,eAAe,CAIpB,UAAuB,EACvB,WAAoC;QAEpC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CACpD,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE;YAC5B,OAAO;gBACL,WAAW;gBACX;oBACE,UAAU;oBACV,WAAW;oBACX,UAAU;iBACX;aACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,OAAO,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,iBAAiB,CAGtB,MAAe;QACf,MAAM,WAAW,GAA2B,EAAE,CAAC;QAE/C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;gBAC7C,WAAW,CAAC,IAAI,CAAC,KAA6B,CAAC,CAAC;aACjD;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AApDD,kCAoDC"}
+{"version":3,"file":"grpc.servers.js","sourceRoot":"","sources":["../../src/servers/grpc.servers.ts"],"names":[],"mappings":";;;AAQA,MAAa,WAAW;IACtB,MAAM,CAAC,MAAM,CACX,WAAmC;QAEnC,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CACnD,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE;YAC3B,OAAO;gBACL,UAAU;gBACV,WAAW,CAAC,eAAe,CAAC,UAAU,EAAE,UAAU,CAAC;aACpD,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,OAAO,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,eAAe,CAIpB,UAAuB,EACvB,WAAoC;QAEpC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CACpD,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE;YAC5B,OAAO;gBACL,WAAW;gBACX;oBACE,UAAU;oBACV,WAAW;oBACX,UAAU;iBACX;aACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,OAAO,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,iBAAiB,CAItB,MAAe;QACf,MAAM,WAAW,GAA2B,EAAE,CAAC;QAE/C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;gBAC7C,WAAW,CAAC,IAAI,CAAC,KAA6B,CAAC,CAAC;aACjD;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AArDD,kCAqDC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/grpc.clients",
-  "version": "2.6.0-next.12",
+  "version": "2.6.0-next.14",
   "description": "Grpc clients infrastructure",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -17,15 +17,16 @@
     "@grpc/grpc-js": "^1.8.7",
     "@nestjs/common": "^9.0.0",
     "@nestjs/microservices": "^9.0.0",
-    "@rsdk/autodoc.protocol": "^2.6.0-next.12",
-    "@rsdk/common": "^2.6.0-next.12",
-    "@rsdk/core": "^2.6.0-next.12",
-    "@rsdk/grpc.common": "^2.6.0-next.12",
-    "@rsdk/logging": "^2.6.0-next.12",
-    "@rsdk/metadata": "^2.6.0-next.12",
+    "@rsdk/autodoc.protocol": "^2.6.0-next.13",
+    "@rsdk/builtin-contract": "*",
+    "@rsdk/common": "^2.6.0-next.13",
+    "@rsdk/core": "^2.6.0-next.13",
+    "@rsdk/grpc.common": "^2.6.0-next.13",
+    "@rsdk/logging": "^2.6.0-next.13",
+    "@rsdk/metadata": "^2.6.0-next.13",
     "nice-grpc": "^2.1.4",
     "nice-grpc-opentelemetry": "^0.1.2",
     "rxjs": "^7.0.0"
   },
-  "gitHead": "aab7d53b4eb7873285c36c927c71b0d45d007554"
+  "gitHead": "d233dca2ccb88a31a2bb23990fe78553122e6166"
 }

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

@@ -1,3 +1,4 @@
+import { Status } from '@rsdk/builtin-contract/dist/grpc/error/v1/error';
 import {
   AuthException,
   ConflictException,
@@ -8,7 +9,7 @@ import {
   NotFoundException,
   TimeoutException,
 } from '@rsdk/core';
-import { ClientError, Status } from 'nice-grpc';
+import { ClientError, Status as NiceGrpcStatus } from 'nice-grpc';
 import type { ClientMiddleware } from 'nice-grpc-common';
 
 /**
@@ -17,8 +18,25 @@ import type { ClientMiddleware } from 'nice-grpc-common';
 export const exceptionMapperMiddleware = (): ClientMiddleware =>
   // eslint-disable-next-line unicorn/consistent-function-scoping
   async function* (call, options) {
+    let status: Status | undefined;
+
     try {
-      return yield* call.next(call.request, options);
+      return yield* call.next(call.request, {
+        ...options,
+        /**
+         * @link https://github.com/deeplay-io/nice-grpc/blob/2d781a477911b1d8a4a7b2faae27c7374ade8076/packages/nice-grpc-error-details/src/client/errorDetailsClientMiddleware.ts#L13
+         * @param trailer
+         */
+        onTrailer(trailer) {
+          const detailsBuffer = trailer.get('grpc-status-details-bin');
+
+          if (detailsBuffer != null) {
+            status = Status.decode(detailsBuffer);
+          }
+
+          options.onTrailer?.(trailer);
+        },
+      });
     } catch (error: unknown) {
       if (!(error instanceof ClientError)) {
         throw new InternalException('GRPC call failed with unknown error', {
@@ -42,29 +60,40 @@ export const exceptionMapperMiddleware = (): ClientMiddleware =>
           path: error.path,
 
           /**
-           * TBD: Other context from original error is not yet passed
-           * via GRPC. Will be added later.
+           * A developer-facing error message, which should be in English. Any
+           * user-facing error message should be localized and sent in the
+           * [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
+           *
+           * https://github.com/deeplay-io/nice-grpc/blob/f0db4d130e1243db1cecb6586dca679e5d9b8fd5/packages/nice-grpc-error-details/proto/google/rpc/status.proto#L39
            */
+          statusMessage: status?.message,
+
+          /**
+           * any context from call
+           */
+          details: status?.details,
         },
       };
 
       /**
        * According to /docs/images/exceptions.mapping.png
        */
+
+      // TODO: maybe replace to map and `Reflect.construct`
       switch (error.code) {
-        case Status.DEADLINE_EXCEEDED:
+        case NiceGrpcStatus.DEADLINE_EXCEEDED:
           throw new TimeoutException(message, props);
-        case Status.INVALID_ARGUMENT:
+        case NiceGrpcStatus.INVALID_ARGUMENT:
           throw new InputException(message, props);
-        case Status.ALREADY_EXISTS:
+        case NiceGrpcStatus.ALREADY_EXISTS:
           throw new DuplicateEntityException(message, props);
-        case Status.FAILED_PRECONDITION:
+        case NiceGrpcStatus.FAILED_PRECONDITION:
           throw new ConflictException(message, props);
-        case Status.UNAUTHENTICATED:
+        case NiceGrpcStatus.UNAUTHENTICATED:
           throw new AuthException(message, props);
-        case Status.PERMISSION_DENIED:
+        case NiceGrpcStatus.PERMISSION_DENIED:
           throw new NotAllowedException(message, props);
-        case Status.NOT_FOUND:
+        case NiceGrpcStatus.NOT_FOUND:
           throw new NotFoundException(message, props);
         default:
           throw new InternalException(message, props);

package/src/servers/grpc.servers.ts

@@ -47,7 +47,8 @@ export class GrpcServers {
 
   static extractDefinition<
     TKeyDeclaration extends GrpcServerDeclaration,
-    TKeyMap extends GrpcServerMap<TKeyDeclaration> = GrpcServerMap<TKeyDeclaration>,
+    TKeyMap extends
+      GrpcServerMap<TKeyDeclaration> = GrpcServerMap<TKeyDeclaration>,
   >(keyMap: TKeyMap): GrpcServerDefinition[] {
     const definitions: GrpcServerDefinition[] = [];