Merge pull request nestjs#895 from jbpionnier/feature/grpc-loader

feature(@nestjs/microservices) load proto with proto-loader

Author: kamilmysliwiec

package-lock.json

@@ -31,6 +31,7 @@
   "author": "Kamil Mysliwiec",
   "license": "MIT",
   "dependencies": {
+    "@grpc/proto-loader": "^0.3.0",
     "@nestjs/common": "5.1.0",
     "@nestjs/core": "5.1.0",
     "@nestjs/microservices": "5.1.0",

package.json

@@ -11,6 +11,7 @@ import { ClientProxy } from './client-proxy';
 import { GRPC_CANCELLED } from './constants';
 
 let grpcPackage: any = {};
+let grpcProtoLoaderPackage: any = {};
 
 export class ClientGrpcProxy extends ClientProxy implements ClientGrpc {
   private readonly logger = new Logger(ClientProxy.name);
@@ -23,6 +24,7 @@ export class ClientGrpcProxy extends ClientProxy implements ClientGrpc {
       this.getOptionsProp<GrpcOptions>(options, 'url') || GRPC_DEFAULT_URL;
 
     grpcPackage = loadPackage('grpc', ClientGrpcProxy.name);
+    grpcProtoLoaderPackage = loadPackage('@grpc/proto-loader', ClientGrpcProxy.name);
     this.grpcClient = this.createClient();
   }
 
@@ -122,12 +124,12 @@ export class ClientGrpcProxy extends ClientProxy implements ClientGrpc {
 
   public loadProto(): any {
     try {
-      const root = this.getOptionsProp<GrpcOptions>(this.options, 'root');
       const file = this.getOptionsProp<GrpcOptions>(this.options, 'protoPath');
-      const options = root ? { root, file } : file;
+      const loader = this.getOptionsProp<GrpcOptions>(this.options, 'loader');
 
-      const context = grpcPackage.load(options);
-      return context;
+      const packageDefinition = grpcProtoLoaderPackage.loadSync(file, loader);
+      const packageObject = grpcPackage.loadPackageDefinition(packageDefinition);
+      return packageObject;
     } catch (err) {
       const invalidProtoError = new InvalidProtoDefinitionException();
       const message =

packages/microservices/client/client-grpc.ts

@@ -22,8 +22,20 @@ export interface GrpcOptions {
     url?: string;
     credentials?: any;
     protoPath: string;
-    root?: string;
     package: string;
+    loader?: {
+      keepCase?: boolean;
+      alternateCommentMode?: boolean;
+      longs?: Function;
+      enums?: Function;
+      bytes?: Function;
+      defaults?: boolean;
+      arrays?: boolean;
+      objects?: boolean;
+      oneofs?: boolean;
+      json?: boolean;
+      includeDirs?: string[];
+    }
   };
 }
 

packages/microservices/interfaces/microservice-configuration.interface.ts

@@ -8,6 +8,7 @@ import { GrpcOptions, MicroserviceOptions } from '../interfaces/microservice-con
 import { Server } from './server';
 
 let grpcPackage: any = {};
+let grpcProtoLoaderPackage: any = {};
 
 export class ServerGrpc extends Server implements CustomTransportStrategy {
   private readonly url: string;
@@ -19,6 +20,7 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
       this.getOptionsProp<GrpcOptions>(options, 'url') || GRPC_DEFAULT_URL;
 
     grpcPackage = this.loadPackage('grpc', ServerGrpc.name);
+    grpcProtoLoaderPackage = this.loadPackage('@grpc/proto-loader', ServerGrpc.name);
   }
 
   public async listen(callback: () => void) {
@@ -149,12 +151,12 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
 
   public loadProto(): any {
     try {
-      const root = this.getOptionsProp<GrpcOptions>(this.options, 'root');
       const file = this.getOptionsProp<GrpcOptions>(this.options, 'protoPath');
-      const options = root ? { root, file } : file;
+      const loader = this.getOptionsProp<GrpcOptions>(this.options, 'loader');
 
-      const context = grpcPackage.load(options);
-      return context;
+      const packageDefinition = grpcProtoLoaderPackage.loadSync(file, loader);
+      const packageObject = grpcPackage.loadPackageDefinition(packageDefinition);
+      return packageObject;
     } catch (err) {
       const invalidProtoError = new InvalidProtoDefinitionException();
       const message = err && err.message ? err.message : invalidProtoError.message;

packages/microservices/server/server-grpc.ts

@@ -1,3 +1,7 @@
 syntax = "proto3";
 
-package test;
+package test;
+
+service TestService {
+
+}

packages/microservices/test/client/test.proto

@@ -9,6 +9,7 @@
     "start:prod": "node dist/main.js"
   },
   "dependencies": {
+    "@grpc/proto-loader": "^0.3.0",
     "@nestjs/common": "^5.1.0",
     "@nestjs/core": "^5.1.0",
     "@nestjs/microservices": "^5.1.0",