Merge pull request #12899 from jtimmons/feat/grpc-reflection

feat(microservices): add support for grpc reflection api

Author: kamilmysliwiec

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

@@ -66,6 +66,7 @@ export interface GrpcOptions {
     protoLoader?: string;
     packageDefinition?: any;
     gracefulShutdown?: boolean;
+    onLoadPackageDefinition?: (pkg: any, server: any) => void;
     loader?: {
       keepCase?: boolean;
       alternateCommentMode?: boolean;

packages/microservices/server/server-grpc.ts

@@ -498,6 +498,14 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
         this.options,
         grpcProtoLoaderPackage,
       );
+
+      if (this.options.onLoadPackageDefinition) {
+        this.options.onLoadPackageDefinition(
+          packageDefinition,
+          this.grpcClient,
+        );
+      }
+
       return grpcPackage.loadPackageDefinition(packageDefinition);
     } catch (err) {
       const invalidProtoError = new InvalidProtoDefinitionException(err.path);

sample/04-grpc/package-lock.json

@@ -20,6 +20,7 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "1.10.0",
+    "@grpc/reflection": "1.0.3",
     "@nestjs/common": "10.3.2",
     "@nestjs/core": "10.3.2",
     "@nestjs/microservices": "10.3.2",

sample/04-grpc/package.json

@@ -1,3 +1,4 @@
+import { ReflectionService } from '@grpc/reflection';
 import { ClientOptions, Transport } from '@nestjs/microservices';
 import { join } from 'path';
 
@@ -6,5 +7,8 @@ export const grpcClientOptions: ClientOptions = {
   options: {
     package: 'hero', // ['hero', 'hero2']
     protoPath: join(__dirname, './hero/hero.proto'), // ['./hero/hero.proto', './hero/hero2.proto']
+    onLoadPackageDefinition: (pkg, server) => {
+      new ReflectionService(pkg).addToServer(server);
+    },
   },
 };