feat(apigatewayv2): support for setting `routeSelectionExpression` for an HTTP API #31373

badmintoncryer · 2024-09-09T12:38:49Z

Issue # (if applicable)

Reason for this change

Cloudformation supports for configuring routeSelectionExpression but AWS CDK doesn't support this.

Description of changes

Added routeSelectionExpression prop to HttpApiProps.

For HTTP API, routeSelectionExpression must be ${request.method} ${request.path}. Therefore, I defined routeSelectionExpression as boolean and set it to ${request.method} ${request.path}.

Description of how you validated changes

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

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

go-to-k

Thanks for this PR! I left some minor comments.

packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts

go-to-k · 2024-09-12T12:24:12Z

packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts

@@ -434,6 +443,7 @@ export class HttpApi extends HttpApiBase {
      corsConfiguration,
      description: props?.description,
      disableExecuteApiEndpoint: this.disableExecuteApiEndpoint,
+      routeSelectionExpression: props?.routeSelectionExpression === true ? '$request.method $request.path' : undefined,


Why $request.method $request.path and not ${request.method} ${request.path}?

It is probably correct as the deployment has not failed. However, the CFn documentation also says it in brackets, and the selection expression guide says the following.

To use multiple variables in a selection expression, enclose the variable in brackets. For example, ${request.path.name} ${request.path.id}.

https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

This is my mistakes! Thank you for your confirmation!!

go-to-k · 2024-09-12T12:25:27Z

packages/aws-cdk-lib/aws-apigatewayv2/README.md

+The `routeSelectionExpression` option can be configured.
+In the HTTP API, only the value `$request.method $request.path` is allowed, and it can be configured by enabling `routeSelectionExpression`.


There is a bit of redundancy in the first and second halves, could you simplify it a bit?

go-to-k · 2024-09-12T12:49:27Z

packages/aws-cdk-lib/aws-apigatewayv2/test/http/api.test.ts

@@ -234,6 +234,19 @@ describe('HttpApi', () => {
    });
  });

+  test('routeSelectionExpression is enabled', () => {


Additionally, it might be good to write a test for RouteSelectionExpression: Match.absent() when routeSelectionExpression is undefined (or false too?), as a test for the ternary operator, just in case.

Co-authored-by: Kenta Goto (k.goto) <[email protected]>

badmintoncryer · 2024-09-12T23:03:37Z

@go-to-k Thank you for your review! I've addressed your comments.

go-to-k · 2024-09-13T05:44:16Z

@badmintoncryer Could you update snapshots?

badmintoncryer · 2024-09-13T10:09:49Z

@go-to-k Thanks to your notification. I've updated a snapshot.

go-to-k

LGTM!

mergify · 2024-09-13T21:51:06Z

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

mergify · 2024-09-13T21:55:28Z

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 · 2024-09-13T22:51:39Z

AWS CodeBuild CI Report

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

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

mergify · 2024-09-13T22:52:08Z

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 · 2024-09-13T22:52:22Z

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.

aws-cdk-automation requested a review from a team September 9, 2024 12:39

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Sep 9, 2024

badmintoncryer changed the title ~~feat(apigatewayv2): support for setting routeSelectionExpression~~ feat(apigatewayv2): support for setting routeSelectionExpression for an HTTP API Sep 9, 2024

aws-cdk-automation previously requested changes Sep 9, 2024

View reviewed changes

badmintoncryer added 3 commits September 10, 2024 12:53

add routeSelectionExpression

1462826

update integ

eb1f1be

add unit test

9fd9bad

badmintoncryer force-pushed the 31104-routeSelectionExpression branch from dba7fc4 to 9fd9bad Compare September 10, 2024 03:53

update readme

eab94f8

badmintoncryer marked this pull request as ready for review September 10, 2024 13:10

Merge branch 'main' into 31104-routeSelectionExpression

4d62019

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

go-to-k suggested changes Sep 12, 2024

View reviewed changes

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

go-to-k reviewed Sep 12, 2024

View reviewed changes

badmintoncryer and others added 3 commits September 13, 2024 07:51

Update packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts

f9c9457

Co-authored-by: Kenta Goto (k.goto) <[email protected]>

review

f3634b2

Merge branch 'main' into 31104-routeSelectionExpression

ee38932

update integ

4eae08d

badmintoncryer added 2 commits September 13, 2024 20:52

Merge branch 'main' into 31104-routeSelectionExpression

dcbe42a

Merge branch 'main' into 31104-routeSelectionExpression

623e5fe

go-to-k approved these changes Sep 13, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 13, 2024

Merge branch 'main' into 31104-routeSelectionExpression

e699505

GavinZZ approved these changes Sep 13, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 13, 2024

Merge branch 'main' into 31104-routeSelectionExpression

16684fd

mergify bot merged commit 36baf51 into aws:main Sep 13, 2024
9 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Sep 13, 2024

badmintoncryer deleted the 31104-routeSelectionExpression branch September 13, 2024 23:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigatewayv2): support for setting `routeSelectionExpression` for an HTTP API #31373

feat(apigatewayv2): support for setting `routeSelectionExpression` for an HTTP API #31373

badmintoncryer commented Sep 9, 2024 •

edited

Loading

aws-cdk-automation left a comment

go-to-k left a comment

go-to-k Sep 12, 2024

badmintoncryer Sep 12, 2024

go-to-k Sep 12, 2024

go-to-k Sep 12, 2024 •

edited

Loading

badmintoncryer commented Sep 12, 2024

go-to-k commented Sep 13, 2024

badmintoncryer commented Sep 13, 2024 •

edited

Loading

go-to-k left a comment

mergify bot commented Sep 13, 2024

mergify bot commented Sep 13, 2024

aws-cdk-automation commented Sep 13, 2024

mergify bot commented Sep 13, 2024

github-actions bot commented Sep 13, 2024

		The `routeSelectionExpression` option can be configured.
		In the HTTP API, only the value `$request.method $request.path` is allowed, and it can be configured by enabling `routeSelectionExpression`.

feat(apigatewayv2): support for setting routeSelectionExpression for an HTTP API #31373

feat(apigatewayv2): support for setting routeSelectionExpression for an HTTP API #31373

Conversation

badmintoncryer commented Sep 9, 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

go-to-k left a comment

Choose a reason for hiding this comment

go-to-k Sep 12, 2024

Choose a reason for hiding this comment

badmintoncryer Sep 12, 2024

Choose a reason for hiding this comment

go-to-k Sep 12, 2024

Choose a reason for hiding this comment

go-to-k Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

badmintoncryer commented Sep 12, 2024

go-to-k commented Sep 13, 2024

badmintoncryer commented Sep 13, 2024 • edited Loading

go-to-k left a comment

Choose a reason for hiding this comment

mergify bot commented Sep 13, 2024

mergify bot commented Sep 13, 2024

aws-cdk-automation commented Sep 13, 2024

AWS CodeBuild CI Report

mergify bot commented Sep 13, 2024

github-actions bot commented Sep 13, 2024

feat(apigatewayv2): support for setting `routeSelectionExpression` for an HTTP API #31373

feat(apigatewayv2): support for setting `routeSelectionExpression` for an HTTP API #31373

badmintoncryer commented Sep 9, 2024 •

edited

Loading

go-to-k Sep 12, 2024 •

edited

Loading

badmintoncryer commented Sep 13, 2024 •

edited

Loading