Merge branch 'anton-alation-feature/grpc-method-with-namespaces' into 5.6.0

Author: kamilmysliwiec

packages/microservices/server/server-grpc.ts

@@ -1,6 +1,11 @@
+import { isObject, isUndefined } from '@nestjs/common/utils/shared.utils';
 import { fromEvent } from 'rxjs';
 import { takeUntil } from 'rxjs/operators';
-import { CANCEL_EVENT, GRPC_DEFAULT_PROTO_LOADER, GRPC_DEFAULT_URL } from '../constants';
+import {
+  CANCEL_EVENT,
+  GRPC_DEFAULT_PROTO_LOADER,
+  GRPC_DEFAULT_URL,
+} from '../constants';
 import { InvalidGrpcPackageException } from '../exceptions/errors/invalid-grpc-package.exception';
 import { InvalidProtoDefinitionException } from '../exceptions/errors/invalid-proto-definition.exception';
 import { CustomTransportStrategy } from '../interfaces';
@@ -23,13 +28,11 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
       this.getOptionsProp<GrpcOptions>(options, 'url') || GRPC_DEFAULT_URL;
 
     const protoLoader =
-      this.getOptionsProp<GrpcOptions>(options, 'protoLoader') || GRPC_DEFAULT_PROTO_LOADER;
+      this.getOptionsProp<GrpcOptions>(options, 'protoLoader') ||
+      GRPC_DEFAULT_PROTO_LOADER;
 
     grpcPackage = this.loadPackage('grpc', ServerGrpc.name);
-    grpcProtoLoaderPackage = this.loadPackage(
-      protoLoader,
-      ServerGrpc.name,
-    );
+    grpcProtoLoaderPackage = this.loadPackage(protoLoader, ServerGrpc.name);
   }
 
   public async listen(callback: () => void) {
@@ -55,16 +58,30 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
       this.logger.error(invalidPackageError.message, invalidPackageError.stack);
       throw invalidPackageError;
     }
-    for (const name of this.getServiceNames(grpcPkg)) {
+
+    // Take all of the services defined in grpcPkg and assign them to
+    // method handlers defined in Controllers
+    for (const definition of this.getServiceNames(grpcPkg)) {
       this.grpcClient.addService(
-        grpcPkg[name].service,
-        await this.createService(grpcPkg[name], name),
+        // First parameter requires exact service definition from proto
+        definition.service.service,
+        // Here full proto definition required along with namespaced pattern name
+        await this.createService(definition.service, definition.name),
       );
     }
   }
 
-  public getServiceNames(grpcPkg: any) {
-    return Object.keys(grpcPkg).filter(name => grpcPkg[name].service);
+  /**
+   * Will return all of the services along with their fully namespaced
+   * names as an array of objects.
+   * This method initiates recursive scan of grpcPkg object
+   */
+  public getServiceNames(grpcPkg: any): { name: string; service: any }[] {
+    // Define accumulator to collect all of the services available to load
+    const services: { name: string; service: any }[] = [];
+    // Initiate recursive services collector starting with empty name
+    this.collectDeepServices('', grpcPkg, services);
+    return services;
   }
 
   public async createService(grpcService: any, name: string) {
@@ -177,4 +194,58 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
       throw invalidProtoError;
     }
   }
+
+  /**
+   * Recursively fetch all of the service methods available on loaded
+   * protobuf descriptor object, and collect those as an objects with
+   * dot-syntax full-path names.
+   *
+   * Example:
+   *  for proto package Bundle.FirstService with service Events { rpc...
+   *  will be resolved to object of (while loaded for Bundle package):
+   *    {
+   *      name: "FirstService.Events",
+   *      service: {Object}
+   *    }
+   */
+  private collectDeepServices(
+    name: string,
+    grpcDefinition: any,
+    accumulator: { name: string; service: any }[],
+  ) {
+    if (!isObject(grpcDefinition)) {
+      return;
+    }
+    const keysToTraverse = Object.keys(grpcDefinition);
+    // Traverse definitions or namespace extensions
+    for (const key of keysToTraverse) {
+      const nameExtended = this.parseDeepServiceName(name, key);
+      const deepDefinition = grpcDefinition[key];
+
+      const isServiceDefined = !isUndefined(deepDefinition.service);
+      const isServiceBoolean = isServiceDefined
+        ? deepDefinition.service !== false
+        : false;
+
+      if (isServiceDefined && isServiceBoolean) {
+        accumulator.push({
+          name: nameExtended,
+          service: deepDefinition,
+        });
+      }
+      // Continue recursion until objects end or service definition found
+      else {
+        this.collectDeepServices(nameExtended, deepDefinition, accumulator);
+      }
+    }
+  }
+
+  private parseDeepServiceName(name: string, key: string): string {
+    // If depth is zero then just return key
+    if (name.length === 0) {
+      return key;
+    }
+    // Otherwise add next through dot syntax
+    return name + '.' + key;
+  }
 }

packages/microservices/test/server/server-grpc.spec.ts

@@ -51,10 +51,16 @@ describe('ServerGrpc', () => {
     });
     describe('when package exist', () => {
       it('should call "addService"', async () => {
-        const serviceNames = ['test', 'test2'];
+        const serviceNames = [{
+          name: 'test',
+          service: true
+        }, {
+          name: 'test2',
+          service: true
+        }];
         sinon.stub(server, 'lookupPackage').callsFake(() => ({
-          test: true,
-          test2: true,
+          test: {service: true},
+          test2: {service: true}
         }));
         sinon.stub(server, 'getServiceNames').callsFake(() => serviceNames);
 
@@ -73,7 +79,16 @@ describe('ServerGrpc', () => {
         key2: { service: true },
         key3: { service: false },
       };
-      const expected = ['key', 'key2'];
+      const expected = [
+        {
+          name: 'key',
+          service: {service: true}
+        },
+        {
+          name: 'key2',
+          service: {service: true}
+        }
+      ];
       expect(server.getServiceNames(obj)).to.be.eql(expected);
     });
   });
@@ -225,4 +240,57 @@ describe('ServerGrpc', () => {
       expect(server.deserialize(content)).to.equal(content);
     });
   });
+
+  describe('proto interfaces parser should account for package namespaces', () => {
+    it('should parse multi-level proto package tree"', () => {
+      const grpcPkg = {
+        A: {
+          C: {
+            E: {
+              service: {
+                serviceName: {}
+              }
+            }
+          }
+        },
+        B: {
+          D: {
+            service: {
+              serviceName: {}
+            }
+          }
+        }
+      };
+      const svcs = server.getServiceNames(grpcPkg);
+      expect(svcs.length).to
+        .be.equal(
+          2,
+        'Amount of services collected from namespace should be equal 2'
+      );
+      expect(svcs[0].name).to.be.equal('A.C.E');
+      expect(svcs[1].name).to.be.equal('B.D');
+    });
+    it('should parse single level proto package tree"', () => {
+      const grpcPkg = {
+        A: {
+          service: {
+            serviceName: {}
+          }
+        },
+        B: {
+          service: {
+            serviceName: {}
+          }
+        }
+      };
+      const services = server.getServiceNames(grpcPkg);
+      expect(services.length).to
+        .be.equal(
+        2,
+        'Amount of services collected from namespace should be equal 2'
+      );
+      expect(services[0].name).to.be.equal('A');
+      expect(services[1].name).to.be.equal('B');
+    });
+  });
 });