chore(elasticloadbalancingv2): add validation for `RedirectOptions.path` by badmintoncryer · Pull Request #31202 · aws/aws-cdk

badmintoncryer · 2024-08-23T14:00:37Z

Issue # (if applicable)

Closes #31201 .

Reason for this change

If we set a string without a leading / for the path property, deployment will fail as shown below.

Given:

httpListener.addAction('RedirectAction', {
        conditions: [elbv2.ListenerCondition.pathPatterns(['/*'])],
        action: elbv2.ListenerAction.redirect({
          protocol: elbv2.ApplicationProtocol.HTTPS,
          path: 'example/path? ',
          permanent: true
        }),
      })

Result:

Failed resources:
MainStack-develop | 1:34:02 AM | CREATE_FAILED | AWS::ElasticLoadBalancingV2::ListenerRule | Alb/HttpListener/RedirectActionRule (AlbHttpListenerRedirectActionRule1D930694) Internal error reported from downstream service during operation 'The Path parameter must be a valid path, should start with a '/', and may contain up to one of each of these placeholders: '#{path}', '#{host}', '#{port}'. (Service: ElasticLoadBalancingV2, Status Code: 400, Request ID: fd4c7f01-9c97-44c1-a177-30ac04b2db26)'.

Related docs: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-path

Description of changes

Add validation for path prop like below.

    if (options.path && !options.path.startsWith('/')) {
      throw new Error('Redirect path must start with a \'/\'');
    }

Description of how you validated changes

Add unit test.

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.

badmintoncryer · 2024-08-23T14:04:45Z

Exemption request:
Since it's only for adding validation, I believe there is no need to add integration test files.

go-to-k

Thanks for this PR. I made a few comments.

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/application-listener-action.ts

badmintoncryer · 2024-08-29T22:49:02Z

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

go-to-k

LGTM.

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

mergify · 2024-09-11T23:00:27Z

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

badmintoncryer · 2024-09-11T23:46:09Z

@mergify update

mergify · 2024-09-11T23:46:18Z

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/github-merit-badger.yml without workflows permission

badmintoncryer · 2024-09-11T23:53:39Z

@GavinZZ Thank you for your approval. Could you please resolve CI failure?

badmintoncryer · 2024-09-13T11:39:35Z

@mergify update

mergify · 2024-09-13T11:39:44Z

update

✅ Branch has been successfully updated

aws-cdk-automation · 2024-09-13T12:13:07Z

AWS CodeBuild CI Report

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

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

mergify · 2024-09-13T12:13:32Z

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-13T12:14:04Z

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.

add path validation

7243c9b

aws-cdk-automation requested a review from a team August 23, 2024 14:00

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

update readme

b288291

aws-cdk-automation previously requested changes Aug 23, 2024

View reviewed changes

update docs

888a1ff

aws-cdk-automation added pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Aug 23, 2024

badmintoncryer added 2 commits August 24, 2024 07:02

Merge branch 'main' into pathValidation

ff957b6

Merge branch 'main' into pathValidation

bb81bf3

github-actions bot mentioned this pull request Aug 26, 2024

Weekly PR metrics report #31217

Closed

go-to-k suggested changes Aug 29, 2024

View reviewed changes

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/application-listener-action.ts Outdated Show resolved Hide resolved

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/application-listener-action.ts Outdated Show resolved Hide resolved

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

address for review

e8f7ab6

go-to-k approved these changes Aug 30, 2024

View reviewed changes

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

github-actions bot mentioned this pull request Sep 1, 2024

Monthly PR metrics report #31279

Closed

GavinZZ approved these changes Sep 11, 2024

View reviewed changes

GavinZZ changed the title ~~feat(elasticloadbalancingv2): add validation for RedirectOptions.path~~ chore(elasticloadbalancingv2): add validation for RedirectOptions.path Sep 11, 2024

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

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

Merge branch 'main' into pathValidation

0f09417

mergify bot merged commit bf3764f into aws:main Sep 13, 2024

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

badmintoncryer deleted the pathValidation branch September 13, 2024 12:24

Conversation

badmintoncryer commented Aug 23, 2024

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!

badmintoncryer commented Aug 23, 2024

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

badmintoncryer commented Aug 29, 2024

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Sep 11, 2024

Uh oh!

badmintoncryer commented Sep 11, 2024

Uh oh!

mergify bot commented Sep 11, 2024

❌ Mergify doesn't have permission to update

Uh oh!

badmintoncryer commented Sep 11, 2024

Uh oh!

badmintoncryer commented Sep 13, 2024

Uh oh!

mergify bot commented Sep 13, 2024

✅ Branch has been successfully updated

Uh oh!

aws-cdk-automation commented Sep 13, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Sep 13, 2024

Uh oh!

github-actions bot commented Sep 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants