feat(cloudfront): support gRPC for distribution by go-to-k · Pull Request #32535 · aws/aws-cdk

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 82.17%. Comparing base (b06daf8) to head (43afbf2).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32535   +/-   ##
=======================================
  Coverage   82.17%   82.17%           
=======================================
  Files         119      119           
  Lines        6862     6862           
  Branches     1158     1158           
=======================================
  Hits         5639     5639           
  Misses       1120     1120           
  Partials      103      103

Flag	Coverage Δ
suite.unit	`82.17% <ø> (ø)`

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

Components	Coverage Δ
packages/aws-cdk	`∅ <ø> (∅)`
packages/aws-cdk-lib/core	`82.17% <ø> (ø)`

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

mergify · 2025-02-18T22:56:56Z

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/codecov.yml without workflows permission

go-to-k · 2025-02-19T09:04:02Z

@aaythapa

Thank you for your review! ~~Could you please take a loot at it again?~~

P.S. I will add the tests, I'll get back to you when that's done.

#32535 (comment)

aaythapa · 2025-02-19T21:17:28Z

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

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


nit

Suggested change

throw new Error(`'httpVersion' must be ${validHttpVersions.join(', ')} if 'enableGrpc' in 'defaultBehavior' or 'additionalBehaviors' is true, got ${this.httpVersion}`);

throw new Error(`'httpVersion' must be ${validHttpVersions.join('or ')} if 'enableGrpc' in 'defaultBehavior' or 'additionalBehaviors' is true, got ${this.httpVersion}`);

aaythapa · 2025-02-19T21:21:07Z

@mergify update

mergify · 2025-02-19T21:21:23Z

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/sync-from-upstream.yml without workflows permission

aaythapa · 2025-02-19T22:51:57Z

@mergify update

mergify · 2025-02-19T22:52:09Z

update

☑️ Nothing to do

Details

#commits-behind > 0 [📌 update requirement]
-closed [📌 update requirement]
-conflict [📌 update requirement]
queue-position = -1 [📌 update requirement]

go-to-k · 2025-02-20T11:07:44Z

@aaythapa

Added the tests and also made other changes (to use ValidationError instead of a default Error)!

Could you please take a look at it again?

aaythapa

Thank you as always for the contribution

aaythapa · 2025-02-20T17:58:44Z

@mergify update

mergify · 2025-02-20T17:58:52Z

update

✅ Branch has been successfully updated

mergify · 2025-02-20T17:58:53Z

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

aws-cdk-automation · 2025-02-20T18:28:40Z

AWS CodeBuild CI Report

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

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

mergify · 2025-02-20T18:28:59Z

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

github-actions · 2025-02-20T18:29:09Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

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

go-to-k added 3 commits February 19, 2025 16:50

improve error msg for validateGrpc

69482ac

call validateGrpc in addBehavior

901efa6

use singlequote quotes

9154927

go-to-k requested a review from aaythapa February 19, 2025 09:04

aaythapa reviewed Feb 19, 2025

View reviewed changes

Merge branch 'main' into cf-grpc

041e253

go-to-k added 5 commits February 20, 2025 19:01

change error message

2d896a3

add new test with cfn template

4532527

use ValidationError

38e47a5

add tests for additionalBehaviors

7ce3da9

nit

c64d888

go-to-k requested a review from aaythapa February 20, 2025 11:07

aaythapa approved these changes Feb 20, 2025

View reviewed changes

Merge branch 'main' into cf-grpc

43afbf2

mergify bot merged commit 1b116b9 into aws:main Feb 20, 2025
20 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Feb 20, 2025

go-to-k deleted the cf-grpc branch February 21, 2025 05:57

	throw new Error(`'httpVersion' must be ${validHttpVersions.join(', ')} if 'enableGrpc' in 'defaultBehavior' or 'additionalBehaviors' is true, got ${this.httpVersion}`);
	throw new Error(`'httpVersion' must be ${validHttpVersions.join('or ')} if 'enableGrpc' in 'defaultBehavior' or 'additionalBehaviors' is true, got ${this.httpVersion}`);

Conversation

go-to-k commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mergify bot commented Feb 18, 2025

❌ Mergify doesn't have permission to update

Uh oh!

go-to-k commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaythapa Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

go-to-k Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

aaythapa commented Feb 19, 2025

Uh oh!

mergify bot commented Feb 19, 2025

❌ Mergify doesn't have permission to update

Uh oh!

aaythapa commented Feb 19, 2025

Uh oh!

mergify bot commented Feb 19, 2025

☑️ Nothing to do

Uh oh!

go-to-k commented Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaythapa left a comment

Choose a reason for hiding this comment

Uh oh!

aaythapa commented Feb 20, 2025

Uh oh!

mergify bot commented Feb 20, 2025

✅ Branch has been successfully updated

Uh oh!

mergify bot commented Feb 20, 2025

Uh oh!

aws-cdk-automation commented Feb 20, 2025

AWS CodeBuild CI Report

Uh oh!

Uh oh!

mergify bot commented Feb 20, 2025

Uh oh!

github-actions bot commented Feb 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

go-to-k commented Dec 16, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading

go-to-k commented Feb 19, 2025 •

edited

Loading

go-to-k commented Feb 20, 2025 •

edited

Loading