Merge branch '5.6.0' into grpc-server-max-received-and-send-message-length

Author: kamilmysliwiec

Readme.md

@@ -16,6 +16,7 @@
 <a href="https://travis-ci.org/nestjs/nest"><img src="https://img.shields.io/travis/nestjs/nest/master.svg?label=linux" alt="Linux" /></a>
 <a href="https://coveralls.io/github/nestjs/nest?branch=master"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#8" alt="Coverage" /></a>
 <a href="https://gitter.im/nestjs/nestjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge"><img src="https://badges.gitter.im/nestjs/nestjs.svg" alt="Gitter" /></a>
+<a href="https://discord.gg/G7Qnnhy"><img src="https://img.shields.io/discord/520622812742811698.svg?logo=discord" alt="Discord"/></a>
 <a href="https://opencollective.com/nest#backer"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
 <a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
   <a href="https://paypal.me/kamilmysliwiec"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
@@ -48,13 +49,10 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 
 <a href="https://valor-software.com/"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="320" /></a>
 
-#### Gold Sponsors
-
-<a href="http://xtremis.com/"><img src="https://nestjs.com/img/logo-xtremis.svg" width="220" /></a> 
-
 #### Silver Sponsors
 <a href="https://neoteric.eu/"><img src="https://nestjs.com/img/neoteric-cut.png" width="120" /></a> &nbsp;
-  <a href="http://gojob.com"><img src="http://nestjs.com/img/gojob-logo.png" valign="bottom" height="95" /></a> &nbsp; <a href="https://www.swingdev.io"><img src="https://nestjs.com/img/swingdev-logo.svg#1" width="150" /> </a>
+  <a href="http://gojob.com"><img src="http://nestjs.com/img/gojob-logo.png" valign="bottom" height="95" /></a> &nbsp; <a href="https://www.swingdev.io"><img src="https://nestjs.com/img/swingdev-logo.svg#1" width="150" /> </a> &nbsp;
+  <a href="http://xtremis.com/"><img src="https://nestjs.com/img/logo-xtremis.svg" width="150" /></a> 
 
 #### Sponsors
 

packages/common/http/http.module.ts

@@ -47,6 +47,11 @@ export class HttpModule {
       imports: options.imports,
       providers: [
         ...this.createAsyncProviders(options),
+        {
+          provide: AXIOS_INSTANCE_TOKEN,
+          useFactory: (config: HttpModuleOptions) => Axios.create(config),
+          inject: [HTTP_MODULE_OPTIONS],
+        },
         {
           provide: HTTP_MODULE_ID,
           useValue: randomStringGenerator(),

packages/core/errors/messages.ts

@@ -53,7 +53,7 @@ export const INVALID_MIDDLEWARE_MESSAGE = (text, name: string) =>
   `The middleware doesn't provide the 'resolve' method (${name})`;
 
 export const INVALID_MODULE_MESSAGE = (text, scope: string) =>
-  `Nest cannot create the module instance. Often, this is because of a circular dependency between modules. Use forwardRef() to avoid it. (Read more https://docs.nestjs.com/advanced/circular-dependency.) Scope [${scope}]`;
+  `Nest cannot create the module instance. Often, this is because of a circular dependency between modules. Use forwardRef() to avoid it. (Read more https://docs.nestjs.com/fundamentals/circular-dependency.) Scope [${scope}]`;
 
 export const UNKNOWN_EXPORT_MESSAGE = (text, module: string) =>
   `Nest cannot export a component/module that is not a part of the currently processed module (${module}). Please verify whether each exported unit is available in this particular context.`;

packages/microservices/server/server-grpc.ts

@@ -1,3 +1,4 @@
+import { isObject, isUndefined } from '@nestjs/common/utils/shared.utils';
 import { fromEvent } from 'rxjs';
 import { takeUntil } from 'rxjs/operators';
 import {
@@ -29,13 +30,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) {
@@ -61,16 +60,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) {
@@ -186,4 +199,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');
+    });
+  });
 });

scripts/prepare.sh

@@ -1,5 +1,5 @@
 # 1. Install all dependencies
-for D in integration/*; do [ -d "${D}" ] && npm i; done
+for D in integration/*/; do sh -c "cd ${D} && npm i"; done
 
 # 2. Build fresh packages and move them to sample and integration directories
 npm run build:dev &>/dev/null