feat(cloudfront): support gRPC for distribution #32535

go-to-k · 2024-12-16T08:47:13Z

Issue # (if applicable)

Reason for this change

CloudFormation supports GrpcConfig property to enable gRPC in CacheBehavior and DefaultCacheBehavior.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-grpcconfig.html

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html

So it would be good to enable gRPC for CloudFront Distribution using L2.

Description of changes

Add enableGrpc property in BehaviorOptions.

Description of how you validated changes

Both unit and integ tests.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

codecov · 2024-12-17T06:48:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.85%. Comparing base (e8d8237) to head (83893e0).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32535      +/-   ##
==========================================
+ Coverage   78.80%   78.85%   +0.04%     
==========================================
  Files         108      108              
  Lines        7159     7165       +6     
  Branches     1319     1319              
==========================================
+ Hits         5642     5650       +8     
+ Misses       1332     1330       -2     
  Partials      185      185

Flag	Coverage Δ
suite.unit	`78.85% <ø> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`78.85% <ø> (+0.04%)`	⬆️

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

go-to-k · 2024-12-18T04:40:17Z

packages/aws-cdk-lib/aws-cloudfront/lib/distribution.ts

+    if (![HttpVersion.HTTP2, HttpVersion.HTTP2_AND_3].includes(this.httpVersion)) {
+      throw new Error(`'httpVersion' must be HttpVersion.HTTP2 or HttpVersion.HTTP2_AND_3 if 'enableGrpc' in 'defaultBehavior' or 'additionalBehaviors' is true, got ${this.httpVersion}`);
+    }


Otherwise CFn will fail:

Resource handler returned message: "Invalid request provided: AWS::CloudFront::Distribution: The parameter gRPC only supports HTTP/2. (Service: CloudFront, Status Code: 400, Request ID:...

go-to-k · 2024-12-18T04:42:12Z

packages/aws-cdk-lib/aws-cloudfront/lib/distribution.ts

  private renderCacheBehaviors(): CfnDistribution.CacheBehaviorProperty[] | undefined {
    if (this.additionalBehaviors.length === 0) { return undefined; }
-    return this.additionalBehaviors.map(behavior => behavior._renderBehavior());
+    return this.additionalBehaviors.map(behavior => {
+      this.validateGrpc(behavior);
+      return behavior._renderBehavior();
+    });


If even one behavior has gRpc with invalid settings such as httpVersion: cloudfront.HttpVersion.HTTP3, an error will occur, so check each behavior.

The example is the case for gRPC with a httpVersion not including HTTP2:

new cloudfront.Distribution(stack, 'TestDistribution', { httpVersion: cloudfront.HttpVersion.HTTP3, defaultBehavior: { origin, allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL, // enableGrpc: true, }, additionalBehaviors: { '/second': { origin, allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL, // enableGrpc: true, }, '/third': { origin, allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL, enableGrpc: true, }, }, });

go-to-k · 2024-12-18T04:46:03Z

packages/aws-cdk-lib/aws-cloudfront/lib/private/cache-behavior.ts

+      if (props.edgeLambdas !== undefined && props.edgeLambdas.length > 0) {
+        throw new Error('\'edgeLambdas\' cannot be specified if \'enableGrpc\' is true');
+      }


Otherwise CFn will fail

Resource handler returned message: "Invalid request provided: AWS::CloudFront::Distribution: The parameter gRPC doesn't support Lambda@Edge. (Service: CloudFront, Status Code: 400, Request ID:...

go-to-k · 2024-12-18T04:47:06Z

packages/aws-cdk-lib/aws-cloudfront/lib/private/cache-behavior.ts

+      if (props.allowedMethods !== AllowedMethods.ALLOW_ALL) {
+        throw new Error('\'allowedMethods\' can only be AllowedMethods.ALLOW_ALL if \'enableGrpc\' is true');
+      }


Otherwise CFn will fail:

Resource handler returned message: "Invalid request provided: AWS::CloudFront::Distribution: The parameter gRPC only supports the POST method. (Service: CloudFront, Status Code: 400, Request ID: ...

I don't write like the following:

throw new Error(`'allowedMethods' can only be AllowedMethods.ALLOW_ALL if 'enableGrpc' is true, got: ${props.allowedMethods?.methods.join(', ')}`);

Because the AllowedMethods.methods is an array type and the message will not be intuitive.

export class AllowedMethods { /** HEAD and GET */ public static readonly ALLOW_GET_HEAD = new AllowedMethods(['GET', 'HEAD']); /** HEAD, GET, and OPTIONS */ public static readonly ALLOW_GET_HEAD_OPTIONS = new AllowedMethods(['GET', 'HEAD', 'OPTIONS']); /** All supported HTTP methods */ public static readonly ALLOW_ALL = new AllowedMethods(['GET', 'HEAD', 'OPTIONS', 'PUT', 'PATCH', 'POST', 'DELETE']); /** HTTP methods supported */ public readonly methods: string[]; private constructor(methods: string[]) { this.methods = methods; } }

Otherwise, if the user specifies AllowedMethods.ALLOW_GET_HEAD_OPTIONS, the following message will be displayed:

'allowedMethods' can only be AllowedMethods.ALLOW_ALL if 'enableGrpc' is true, got: 'GET', 'HEAD', 'OPTIONS'

go-to-k · 2024-12-18T08:20:50Z

packages/aws-cdk-lib/aws-cloudfront/lib/private/cache-behavior.ts

+    this.grpcEnabled = props.enableGrpc;
+
+    if (this.grpcEnabled) {
+      if (props.allowedMethods !== AllowedMethods.ALLOW_ALL) {


undefined for allowedMethods is also be bad because the default value is AllowedMethods.ALLOW_GET_HEAD.

go-to-k · 2024-12-18T11:22:23Z

packages/aws-cdk-lib/aws-cloudfront/lib/private/cache-behavior.ts

@@ -22,10 +22,21 @@ export interface CacheBehaviorProps extends AddBehaviorOptions {
 * CloudFrontWebDistribution implementation.
 */
 export class CacheBehavior {
+  public readonly grpcEnabled?: boolean;


Exposed to validate settings with gRPC in Distribution construct.

aws-cdk-automation · 2024-12-18T11:32:22Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 9d2391b
Result: SUCCEEDED
Build Logs (available for 30 days)

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

feat(cloudfront): support gRPC for distribution

9d8e92f

aws-cdk-automation requested a review from a team December 16, 2024 08:47

github-actions bot added distinguished-contributor [Pilot] contributed 50+ PRs to the CDK feature-request A feature should be added or improved. p2 labels Dec 16, 2024

aws-cdk-automation previously requested changes Dec 16, 2024

View reviewed changes

go-to-k added 4 commits December 16, 2024 18:01

unit test

00a2003

README

633ac50

integ without snapshots

e736d8f

Merge branch 'main' of https://github.com/go-to-k/aws-cdk into cf-grpc

cdd1500

go-to-k marked this pull request as ready for review December 17, 2024 06:04

github-actions bot added the effort/small Small work item – less than a day of effort label Dec 17, 2024

go-to-k added 2 commits December 17, 2024 15:33

fix code and add tests

dca03fe

default label

e2288f7

go-to-k marked this pull request as draft December 17, 2024 07:04

snapshots

a018a4f

add validation

05a803f

go-to-k marked this pull request as ready for review December 17, 2024 07:33

go-to-k added 5 commits December 17, 2024 16:35

typo in tests

b29265c

improve

1321702

change README

c965edd

fix doc

85bb175

change error msg

adc904b

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 17, 2024

change default label

0d61b26

go-to-k marked this pull request as draft December 17, 2024 08:53

go-to-k marked this pull request as ready for review December 17, 2024 08:54

go-to-k marked this pull request as draft December 17, 2024 09:21

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 17, 2024

go-to-k added 5 commits December 17, 2024 19:24

validation for http2

7b78244

validation for edgeLambdas

0d703a9

validation for errorResponses and change method name to validateGrpc

3b4c1f5

rm errorResponse validation

60d00d5

semi-colon in distribution

e8be128

go-to-k commented Dec 18, 2024

View reviewed changes

go-to-k added 3 commits December 18, 2024 16:34

jsdoc for validations

a67b2af

unit test for edgeLambda

4bfe1cc

unit tests for httpVersion

83893e0

go-to-k marked this pull request as ready for review December 18, 2024 08:03

go-to-k marked this pull request as draft December 18, 2024 08:04

go-to-k commented Dec 18, 2024

View reviewed changes

unit tests for additionalBehaviors

9d2391b

go-to-k marked this pull request as ready for review December 18, 2024 10:58

go-to-k commented Dec 18, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cloudfront): support gRPC for distribution #32535

feat(cloudfront): support gRPC for distribution #32535

go-to-k commented Dec 16, 2024 •

edited

Loading

aws-cdk-automation left a comment

codecov bot commented Dec 17, 2024 •

edited

Loading

go-to-k Dec 18, 2024

go-to-k Dec 18, 2024 •

edited

Loading

go-to-k Dec 18, 2024

go-to-k Dec 18, 2024

go-to-k Dec 18, 2024

go-to-k Dec 18, 2024 •

edited

Loading

go-to-k Dec 18, 2024

aws-cdk-automation commented Dec 18, 2024

feat(cloudfront): support gRPC for distribution #32535

Are you sure you want to change the base?

feat(cloudfront): support gRPC for distribution #32535

Conversation

go-to-k commented Dec 16, 2024 • edited Loading

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Dec 17, 2024 • edited Loading

Codecov Report

go-to-k Dec 18, 2024

Choose a reason for hiding this comment

go-to-k Dec 18, 2024 • edited Loading

Choose a reason for hiding this comment

go-to-k Dec 18, 2024

Choose a reason for hiding this comment

go-to-k Dec 18, 2024

Choose a reason for hiding this comment

go-to-k Dec 18, 2024

Choose a reason for hiding this comment

go-to-k Dec 18, 2024 • edited Loading

Choose a reason for hiding this comment

go-to-k Dec 18, 2024

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 18, 2024

AWS CodeBuild CI Report

go-to-k commented Dec 16, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading

go-to-k Dec 18, 2024 •

edited

Loading

go-to-k Dec 18, 2024 •

edited

Loading