Skip to content

fix(cloudfront): fix validation for unresolved webAclId tokens #34102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 11, 2025

Conversation

pahud
Copy link
Contributor

@pahud pahud commented Apr 10, 2025

Issue # (if applicable)

Closes #34099.

Reason for this change

Fixes a bug where CloudFront Distribution validation would throw a TypeError when webAclId was a CloudFormation token or intrinsic, instead of a plain string. This prevented users from passing unresolved tokens or references as webAclId.

Description of changes

  • Updated validateWebAclId() to skip validation if webAclId is not a string or is an unresolved token.
  • This prevents .startsWith() from being called on non-string values, avoiding runtime errors.
  • Added unit tests to cover unresolved tokens and non-string values.
  • Removed the integration test that attempted to deploy dummy WebACL ARNs, which caused CloudFront deployment failures due to invalid account ownership.

This change enables users to safely pass CloudFormation references or tokens as webAclId without causing synthesis errors.

Describe any new or updated permissions being added

None.

Description of how you validated changes

  • Added and updated unit tests for validateWebAclId() to cover tokens and non-string values.
  • Removed the failing integration test that was not suitable for automated deployment.

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team April 10, 2025 15:20
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 labels Apr 10, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 10, 2025
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This review is outdated)

@pahud pahud changed the title fix(cloudfront): add validation for unresolved webAclId tokens chore(cloudfront): add validation for unresolved webAclId tokens Apr 10, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review April 10, 2025 15:31

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

Copy link

codecov bot commented Apr 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.98%. Comparing base (74cbe27) to head (abd4734).
Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #34102   +/-   ##
=======================================
  Coverage   83.98%   83.98%           
=======================================
  Files         120      120           
  Lines        6976     6976           
  Branches     1178     1178           
=======================================
  Hits         5859     5859           
  Misses       1005     1005           
  Partials      112      112           
Flag Coverage Δ
suite.unit 83.98% <ø> (ø)

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 83.98% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pahud pahud marked this pull request as ready for review April 10, 2025 15:43
@shikha372 shikha372 self-assigned this Apr 10, 2025
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 10, 2025
@shikha372 shikha372 changed the title chore(cloudfront): add validation for unresolved webAclId tokens fix(cloudfront): fix validation for unresolved webAclId tokens Apr 10, 2025
@shikha372 shikha372 added the pr-linter/exempt-test The PR linter will not require test changes label Apr 10, 2025
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This review is outdated)

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 10, 2025
@shikha372 shikha372 added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Apr 10, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review April 10, 2025 22:58

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 10, 2025
Copy link
Contributor

mergify bot commented Apr 11, 2025

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
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Apr 11, 2025

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 mergify bot merged commit f2c5f26 into aws:main Apr 11, 2025
20 checks passed
Copy link
Contributor

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/medium Medium work item – several days of effort p1 pr/needs-maintainer-review This PR needs a review from a Core Team Member pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(aws-cloudfront): WebACL validate throws error webAclId.startsWith is not a function
4 participants