feature(microservice): decorator MessagePattern get new attribute 'transport' #4768

barbarosh · 2020-05-09T22:54:05Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[x] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #4769
Docs changes: nestjs/docs.nestjs.com#1246

What is the new behavior?

Decorator MessagePattern get new attribute 'transport' for pass transport id and avoid bind patterns to wrong microservices in multiple microservices architecture

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

coveralls · 2020-05-09T23:21:15Z

Pull Request Test Coverage Report for Build 148a1380-0645-4cd5-95e8-98ad88b42fcc

33 of 33 (100.0%) changed or added relevant lines in 12 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.02%) to 94.653%

Totals
Change from base Build d22e62a5-436d-439a-995e-5cc0c88277ea:	0.02%
Covered Lines:	4709
Relevant Lines:	4975

💛 - Coveralls

kamilmysliwiec · 2020-05-12T10:05:03Z

Thanks @barbarosh. I'll review asap

kamilmysliwiec · 2020-05-12T10:21:11Z

packages/microservices/decorators/message-pattern.decorator.ts

@@ -14,6 +19,7 @@ export enum GrpcMethodStreamingType {
 */
 export const MessagePattern = <T = PatternMetadata | string>(
  metadata?: T,
+  transport?: number,


Can we use Transport enum here instead?

kamilmysliwiec · 2020-05-12T10:21:16Z

packages/microservices/decorators/event-pattern.decorator.ts

-export const EventPattern = <T = string>(metadata?: T): MethodDecorator => {
+export const EventPattern = <T = string>(
+  metadata?: T,
+  transport?: number,


Can we use Transport enum here instead?

kamilmysliwiec · 2020-05-12T10:22:26Z

packages/microservices/interfaces/custom-transport-strategy.interface.ts

@@ -1,4 +1,5 @@
 export interface CustomTransportStrategy {
  listen(callback: () => void): any;
+  getTransport(): number;


Can we add an abstract, optional method in the Server class instead?

Also, can we name it "getTransportId" instead? getTransport sounds slightly ambiguous

@kamilmysliwiec

Can we add an abstract, optional method in the Server class instead?

I not sure about optional method it is good idea, in my vision we need know which Transport using each server. If new servers not implement this method for this server we need bind all message patterns for all transports or only without transport?

Making this method required will introduce a breaking change.

If new servers not implement this method for this server

If one creates a new "custom strategy", we should allow him/her to decide whether it should be bound to all methods by default, or not.

Understood, will make abstract optional method and bind all message patterns to server without getTransportId

kamilmysliwiec · 2020-05-12T10:22:47Z

packages/microservices/listener-metadata-explorer.ts

@@ -18,6 +19,7 @@ export interface ClientProperties {

 export interface PatternProperties {
  pattern: PatternMetadata;
+  transport: number;


Can we use Transport enum here instead? + transport?

kamilmysliwiec · 2020-05-12T10:23:41Z

packages/microservices/server/server-grpc.ts

@@ -48,6 +49,10 @@ export class ServerGrpc extends Server implements CustomTransportStrategy {
    grpcProtoLoaderPackage = this.loadPackage(protoLoader, ServerGrpc.name);
  }

+  public getTransport(): number {


Can we use Transport enum here instead?

… transportId and make it optional

barbarosh · 2020-05-16T13:40:33Z

@kamilmysliwiec Please review again, I made changes move getTransport() function to variable transportId and updates in docs nestjs/docs.nestjs.com#1246

barbarosh · 2020-05-16T22:28:17Z

Added test

kamilmysliwiec · 2020-05-24T11:19:45Z

Thank you!

barbarosh changed the title ~~Add ability for pass transport to MessagePattern~~ Decorator MessagePattern get new attribute 'transport' for pass transport id and avoid bind patterns to wrong microservices in multiple microservices architecture May 9, 2020

barbarosh changed the title ~~feature(microservice): Decorator MessagePattern get new attribute 'transport'~~ feature(microservice): decorator MessagePattern get new attribute 'transport' May 9, 2020

feat(microservices): Add ability for pass transport to MessagePattern

0845dab

barbarosh force-pushed the feature/message-pattern-bind-to-transport branch 2 times, most recently from c244aa3 to 0845dab Compare May 10, 2020 18:07

kamilmysliwiec added scope: microservices type: enhancement 🐺 labels May 12, 2020

kamilmysliwiec reviewed May 12, 2020

View reviewed changes

alex added 2 commits May 16, 2020 15:22

feat(microservices): move getTransportId functions to public variable…

e2c8f74

… transportId and make it optional

feat(sample): add hybrid app microservices sample

0432284

test(microservices): add tests for new feature

07237f5

kamilmysliwiec merged commit 3e4f8bc into nestjs:master May 24, 2020

xavierchow mentioned this pull request Mar 16, 2022

MessagePattern and EventPattern enhancement to support multiple custom microservices transporters #9341

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature(microservice): decorator MessagePattern get new attribute 'transport' #4768

feature(microservice): decorator MessagePattern get new attribute 'transport' #4768

barbarosh commented May 9, 2020 •

edited

Loading

coveralls commented May 9, 2020 •

edited

Loading

kamilmysliwiec commented May 12, 2020

kamilmysliwiec May 12, 2020

kamilmysliwiec May 12, 2020

kamilmysliwiec May 12, 2020

kamilmysliwiec May 12, 2020

barbarosh May 12, 2020 •

edited

Loading

kamilmysliwiec May 12, 2020

barbarosh May 12, 2020 •

edited

Loading

kamilmysliwiec May 12, 2020

kamilmysliwiec May 12, 2020

barbarosh commented May 16, 2020 •

edited

Loading

barbarosh commented May 16, 2020

kamilmysliwiec commented May 24, 2020

feature(microservice): decorator MessagePattern get new attribute 'transport' #4768

feature(microservice): decorator MessagePattern get new attribute 'transport' #4768

Conversation

barbarosh commented May 9, 2020 • edited Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

coveralls commented May 9, 2020 • edited Loading

Pull Request Test Coverage Report for Build 148a1380-0645-4cd5-95e8-98ad88b42fcc

💛 - Coveralls

kamilmysliwiec commented May 12, 2020

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

barbarosh May 12, 2020 • edited Loading

Choose a reason for hiding this comment

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

barbarosh May 12, 2020 • edited Loading

Choose a reason for hiding this comment

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

kamilmysliwiec May 12, 2020

Choose a reason for hiding this comment

barbarosh commented May 16, 2020 • edited Loading

barbarosh commented May 16, 2020

kamilmysliwiec commented May 24, 2020

barbarosh commented May 9, 2020 •

edited

Loading

coveralls commented May 9, 2020 •

edited

Loading

barbarosh May 12, 2020 •

edited

Loading

barbarosh May 12, 2020 •

edited

Loading

barbarosh commented May 16, 2020 •

edited

Loading