feat(appmesh): change VirtualRouter's Listener to a union-like class #11277

dfezzie · 2020-11-03T22:31:46Z

Follows the pattern set in #10879 and transitions the VirtualRouter listener to use protocol specific listeners.

BREAKING CHANGE: VirtualRouter's Listeners are no longer a struct; use the static factory methods of the VirtualNodeListener class to obtain instances of them

appmesh: VirtualRouter accepts a list of listeners instead of a single listener

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

gitpod-io · 2020-11-03T22:31:49Z

dfezzie · 2020-11-03T22:55:40Z

Noticed a failure with the ECS patterns library. Will get a fix for this soon

skinny85

Gotta say, I don't see the point of this abstraction currently. Unless it's in preparation for more listener properties in the future? But if that's the case, we should have a separate interface per static factory method right now (it's fine if they're empty and just extend RouterListenerProps today).

Also, you've missed updating the ReadMe, and noting the breaking change to VirtualRouter (going from listener to listeners).

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

skinny85 · 2020-11-03T22:49:49Z

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

+  /**
+   * Returns a TCP Listener for a VirtualRouter
+   */
+  public static tcpGatewayListener(props: RouterListenerProps = {}): VirtualRouterListener {


Is there any chance any of these will have protocol-specific properties later? Because frankly, in its current form, I don't think this abstraction is buying us anything...

Virtual Routers specifically do not currently have any protocol specific properties. The main reason I think we should do this change is for consistency. If we have listeners on Virtual Nodes and Virtual Gateways, having listeners for your virtual routers that are defined in a different way seems like poor UX. If you don't think it is worth the change, we can scrap this PR.

Consistency is not a bad argument.

How about this. Let's make port?: number an optional positional argument to each of the static factory methods in this class, and get rid of RouterListenerProps completely. Then, creating a Listener will be as simple as calling VirtualRouterListener.http(8081). I think that's a reasonable compromise between consistency and ease of use.

Thoughts on this idea?

Sounds good to me. Simpler for sure. Made the update

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

skinny85 · 2020-11-03T22:51:18Z

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

+  /**
+   * Protocol the listener implements
+   */
+  protected protocol: Protocol = Protocol.HTTP;


Can you instead make the base class abstract with a public abstract readonly protocol: Protocol property, and then each of the subclasses will implement protocol?

Yeah, we can further simplify this by only having one subclass for all 4 protocols.

packages/@aws-cdk/aws-appmesh/lib/virtual-router.ts

packages/@aws-cdk/aws-appmesh/test/test.mesh.ts

skinny85

My replies to the questions. I think it makes sense to do this PR, just with some slight tweaks.

skinny85 · 2020-11-04T22:32:46Z

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

+/**
+ * Represents the properties needed to define Listeners for a VirtualRouter
+ */
+export interface RouterListenerProps {


These should be *Options, so RouterListenerOptions. *Props are reserved for construction properties of Constructs. Apologies I did not notice this before (we'll probably have to go back and change a few of these in other places in the AppMesh module).

No problem. Should updating other places be done in this in this PR or separate?

Let's keep it separate.

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

skinny85 · 2020-11-04T22:40:47Z

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

+  /**
+   * Returns a TCP Listener for a VirtualRouter
+   */
+  public static tcpGatewayListener(props: RouterListenerProps = {}): VirtualRouterListener {


Consistency is not a bad argument.

How about this. Let's make port?: number an optional positional argument to each of the static factory methods in this class, and get rid of RouterListenerProps completely. Then, creating a Listener will be as simple as calling VirtualRouterListener.http(8081). I think that's a reasonable compromise between consistency and ease of use.

Thoughts on this idea?

Pull request has been modified.

skinny85

Looks great! We're almost there, a few comments.

Also, missing ReadMe changes.

packages/@aws-cdk/aws-appmesh/lib/virtual-router-listener.ts

packages/@aws-cdk/aws-appmesh/lib/virtual-router.ts

packages/@aws-cdk/aws-appmesh/test/test.mesh.ts

packages/@aws-cdk/aws-appmesh/test/test.virtual-router.ts

Pull request has been modified.

skinny85

LGTM!

Pull request has been modified.

skinny85

One small nitpick.

packages/@aws-cdk-containers/ecs-service-extensions/lib/extensions/appmesh.ts

Pull request has been modified.

skinny85

Can the PortMapping interface be removed with this change?

skinny85 · 2020-11-07T00:20:16Z

Can the PortMapping interface be removed with this change?

I guess no, because it's still used in the current version of VirtualNodeListener.

mergify · 2020-11-07T00:39:31Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2020-11-07T01:18:48Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 004e4bf
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-11-07T01:19:10Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Dominic Fezzie added 2 commits November 3, 2020 11:09

refactor(appmesh): changes VirtualRouter to have static listener methods

c0aed38

remove comment and check length on listener props

53d5122

Merge branch 'master' into refactor/virtualRouterListener

0ee787c

skinny85 previously requested changes Nov 3, 2020

View reviewed changes

skinny85 mentioned this pull request Nov 3, 2020

feat(appmesh): add listener timeout to Virtual Nodes #10793

Merged

skinny85 reviewed Nov 4, 2020

View reviewed changes

Dominic Fezzie added 4 commits November 4, 2020 21:40

renames virtual router listener static methods

ed0474e

refactors the static methods to accept port instead of props

6ac1fe9

adds addRoute method back to IVirtualRouter

526035f

add a test for default configuration

c50357c

dfezzie requested a review from skinny85 November 5, 2020 17:30

SomayaB assigned skinny85 Nov 5, 2020

Merge branch 'master' into refactor/virtualRouterListener

507f625

skinny85 previously requested changes Nov 5, 2020

View reviewed changes

addresses pr feedback

060a86d

fixes whitespace issue in tests

c170649

dfezzie requested a review from skinny85 November 5, 2020 21:46

skinny85 changed the title ~~refactor(appmesh): changes VirtualRouter to have static listener methods~~ feat(appmesh): changes VirtualRouter to have static listener methods Nov 5, 2020

skinny85 changed the title ~~feat(appmesh): changes VirtualRouter to have static listener methods~~ feat(appmesh): change VirtualRouter's Listener to a union-like class Nov 5, 2020

skinny85 previously approved these changes Nov 5, 2020

View reviewed changes

Merge branch 'master' into refactor/virtualRouterListener

b299390

Dominic Fezzie added 2 commits November 6, 2020 15:23

fixes ecs service extension to use new listener class

cc00cb4

rename variable

4aede95

skinny85 previously requested changes Nov 6, 2020

View reviewed changes

packages/@aws-cdk-containers/ecs-service-extensions/lib/extensions/appmesh.ts Outdated Show resolved Hide resolved

move switch to a private method

ddbdc9d

dfezzie requested a review from skinny85 November 7, 2020 00:04

Remove unnecessary public fields from VirtualRouterListener

41a525e

skinny85 reviewed Nov 7, 2020

View reviewed changes

skinny85 approved these changes Nov 7, 2020

View reviewed changes

mergify bot added 2 commits November 7, 2020 00:39

Merge branch 'master' into refactor/virtualRouterListener

1121c44

Merge branch 'master' into refactor/virtualRouterListener

004e4bf

mergify bot merged commit 0a3e980 into aws:master Nov 7, 2020

dfezzie deleted the refactor/virtualRouterListener branch November 7, 2020 02:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(appmesh): change VirtualRouter's Listener to a union-like class #11277

feat(appmesh): change VirtualRouter's Listener to a union-like class #11277

dfezzie commented Nov 3, 2020 •

edited by skinny85

gitpod-io bot commented Nov 3, 2020 •

edited

dfezzie commented Nov 3, 2020

skinny85 left a comment

skinny85 Nov 3, 2020

dfezzie Nov 4, 2020

skinny85 Nov 4, 2020

dfezzie Nov 5, 2020

skinny85 Nov 3, 2020

dfezzie Nov 5, 2020

skinny85 left a comment

skinny85 Nov 4, 2020

dfezzie Nov 5, 2020

skinny85 Nov 5, 2020

skinny85 Nov 4, 2020

skinny85 left a comment

skinny85 left a comment

skinny85 left a comment

skinny85 left a comment

skinny85 commented Nov 7, 2020

mergify bot commented Nov 7, 2020

aws-cdk-automation commented Nov 7, 2020

mergify bot commented Nov 7, 2020

feat(appmesh): change VirtualRouter's Listener to a union-like class #11277

feat(appmesh): change VirtualRouter's Listener to a union-like class #11277

Conversation

dfezzie commented Nov 3, 2020 • edited by skinny85

gitpod-io bot commented Nov 3, 2020 • edited

dfezzie commented Nov 3, 2020

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 commented Nov 7, 2020

mergify bot commented Nov 7, 2020

aws-cdk-automation commented Nov 7, 2020

AWS CodeBuild CI Report

mergify bot commented Nov 7, 2020

dfezzie commented Nov 3, 2020 •

edited by skinny85

gitpod-io bot commented Nov 3, 2020 •

edited