feat(appmesh): add Connection Pools for VirtualNode and VirtualGateway #13917

alexbrjo · 2021-04-01T00:06:28Z

Adds connection pools to VirtualNodes and VirtualGateways. VirtualNodes support listeners for HTTP, HTTP2, gRPC and TPC. VirtualGateways support only HTTP, HTTP2 and gRPC (no TCP). There are connection pool configurations for each of these 7 node/protocol combinations.

HTTP connection pools need these properties: maxConnections, maxPendingRequests
HTTP2 connection pools need these properties: maxRequests
gRPC connection pools need these properties: maxRequests
TCP connection pools need these properties: maxConnections

Since connection pool properties differ by protocol so it's important to enforce the correct fields in CDK. To accomplish this I've added interfaces per protocol type and squashed API config ConnectionPool > [Protocol] > properties to the equivalent ConnectionPool > properties CDK config. This is ok because the user will never mismatch protocol types. From docs (see connection pool section):

The connectionPool and portMapping protocols must be the same. If your listener protocol is grpc or http2, specify maxRequests only. If your listener protocol is http, you can specify both maxConnections and maxPendingRequests.

new appmesh.VirtualNode(stack, 'test-node', {
  mesh,
  listeners: [
    appmesh.VirtualNodeListener.tcp({
      port: 80,
      connectionPool: {
        maxConnections: 100,
      },
    }),
  ],
});

Pre-addressing the ConnectionPoolConfig placeholder interface & lint ignore statement: I’ve added this so I can treat the connection pool types as sub-classes while taking advantage of the interface object literal pattern. Cleaner UX compared to using classes.

BREAKING CHANGE: HTTP2 VirtualNodeListeners must be now created with Http2VirtualNodeListenerOptions

appmesh: HTTP2 VirtualGatewayListeners must be now created with Http2VirtualGatewayListenerOptions

Closes #11647

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

issue aws#11647

gitpod-io · 2021-04-01T00:06:30Z

skinny85

Looks great @alexbrjo, love the fact that all of the options are type-safe, and you can't misuse the API!

A few small notes before we merge this in.

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

skinny85 · 2021-04-02T01:37:51Z

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

+  /**
+   * Timeout for HTTP protocol
+   *
+   * @default - None
+   */
+  readonly timeout?: HttpTimeout;


Same note here - let's extract a common, module-private interface that extends VirtualNodeListenerCommonOptions and contains the timeout property, which both HttpVirtualNodeListenerOptions and Http2VirtualNodeListenerOptions can extend.

They already all extend VirtualNodeListenerCommonOptions, the timeout field is one of the ones that differs by protocol. Http and Http2 are the only options out of 4 that share the same timeout so I'd like to leave this one.

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

packages/@aws-cdk/aws-appmesh/lib/shared-interfaces.ts

…on-pool

Pull request has been modified.

skinny85

This all looks great @alexbrjo. If you could just get rid of the duplication in virtual-node-listener.ts with the solution I outlined in #13917 (comment), we'll merge this in!

…pool

…irtualNodeListenerOptions and Http2VirtualNodeListenerOptions extend.

skinny85

@alexbrjo since this PR was so close, I made the changes myself, and pushed them to your branch. Let's get this merged in!

mergify · 2021-04-16T18:43:22Z

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 · 2021-04-16T19:09:11Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: 81d4bae
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2021-04-16T19:09:34Z

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).

alexbrjo · 2021-04-16T19:10:29Z

@skinny85 thanks so much for the help!

aws#13917) Adds connection pools to VirtualNodes and VirtualGateways. VirtualNodes support listeners for HTTP, HTTP2, gRPC and TPC. VirtualGateways support only HTTP, HTTP2 and gRPC (no TCP). There are connection pool configurations for each of these 7 node/protocol combinations. * HTTP connection pools need these properties: maxConnections, maxPendingRequests * HTTP2 connection pools need these properties: maxRequests * gRPC connection pools need these properties: maxRequests * TCP connection pools need these properties: maxConnections Since connection pool properties differ by protocol so it's important to enforce the correct fields in CDK. To accomplish this I've added interfaces per protocol type and squashed API config `ConnectionPool > [Protocol] > properties` to the equivalent `ConnectionPool > properties` CDK config. This is ok because the user will never mismatch protocol types. From [docs (see connection pool section)](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html): > The connectionPool and portMapping protocols must be the same. If your listener protocol is grpc or http2, specify maxRequests only. If your listener protocol is http, you can specify both maxConnections and maxPendingRequests. ```ts new appmesh.VirtualNode(stack, 'test-node', { mesh, listeners: [ appmesh.VirtualNodeListener.tcp({ port: 80, connectionPool: { maxConnections: 100, }, }), ], }); ``` Pre-addressing the `ConnectionPoolConfig` placeholder interface & lint ignore statement: I’ve added this so I can treat the connection pool types as sub-classes while taking advantage of the interface object literal pattern. Cleaner UX compared to using classes. BREAKING CHANGE: HTTP2 `VirtualNodeListener`s must be now created with `Http2VirtualNodeListenerOptions` * **appmesh**: HTTP2 `VirtualGatewayListener`s must be now created with `Http2VirtualGatewayListenerOptions` Closes aws#11647 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Alexander Johnson added 2 commits March 31, 2021 16:22

Add Connection Pools for VirtualNode and VirtualGateway

96c62fa

issue aws#11647

Add README for connection pool

73d1b28

github-actions bot added the @aws-cdk/aws-appmesh Related to AWS App Mesh label Apr 1, 2021

github-actions bot assigned skinny85 Apr 1, 2021

skinny85 previously requested changes Apr 2, 2021

View reviewed changes

Alexander Johnson added 2 commits April 2, 2021 13:36

Move shape to private. Extract super class for VG listener options

c0f9615

Merge branch 'master' of https://github.com/aws/aws-cdk into connecti…

2dd0a3c

…on-pool

skinny85 changed the title ~~feat(appmesh): Add Connection Pools for VirtualNode and VirtualGateway~~ feat(appmesh): add Connection Pools for VirtualNode and VirtualGateway Apr 5, 2021

skinny85 reviewed Apr 5, 2021

View reviewed changes

skinny85 added 2 commits April 16, 2021 11:13

Merge remote-tracking branch 'origin/master' into appmesh/connection-…

2ee6ed8

…pool

Introduce a CommonHttpVirtualNodeListenerOptions interface that HttpV…

4dcb7e8

…irtualNodeListenerOptions and Http2VirtualNodeListenerOptions extend.

skinny85 approved these changes Apr 16, 2021

View reviewed changes

Merge branch 'master' into connection-pool

81d4bae

mergify bot merged commit 8a949dc into aws:master Apr 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(appmesh): add Connection Pools for VirtualNode and VirtualGateway #13917

feat(appmesh): add Connection Pools for VirtualNode and VirtualGateway #13917

alexbrjo commented Apr 1, 2021 •

edited by skinny85

gitpod-io bot commented Apr 1, 2021 •

edited

skinny85 left a comment

skinny85 Apr 2, 2021

alexbrjo Apr 2, 2021

skinny85 Apr 5, 2021

skinny85 left a comment

skinny85 left a comment

mergify bot commented Apr 16, 2021

aws-cdk-automation commented Apr 16, 2021

mergify bot commented Apr 16, 2021

alexbrjo commented Apr 16, 2021

feat(appmesh): add Connection Pools for VirtualNode and VirtualGateway #13917

feat(appmesh): add Connection Pools for VirtualNode and VirtualGateway #13917

Conversation

alexbrjo commented Apr 1, 2021 • edited by skinny85

gitpod-io bot commented Apr 1, 2021 • edited

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 Apr 2, 2021

Choose a reason for hiding this comment

alexbrjo Apr 2, 2021

Choose a reason for hiding this comment

skinny85 Apr 5, 2021

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

mergify bot commented Apr 16, 2021

aws-cdk-automation commented Apr 16, 2021

AWS CodeBuild CI Report

mergify bot commented Apr 16, 2021

alexbrjo commented Apr 16, 2021

alexbrjo commented Apr 1, 2021 •

edited by skinny85

gitpod-io bot commented Apr 1, 2021 •

edited