Skip to content
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

fix(msk): clusterName validation in Cluster class is incorrect #32792

Merged
merged 4 commits into from
Jan 13, 2025

Conversation

mazyu36
Copy link
Contributor

@mazyu36 mazyu36 commented Jan 8, 2025

Issue # (if applicable)

N/A

Reason for this change

The validation for clusterName is incorrect. There are two issues:

  1. The AND (&&) operators should be OR (||) operators. Currently, the validation throws an error only when both the pattern check AND length check fail.
    However, it should throw an error when EITHER check fails.
    if (
      !core.Token.isUnresolved(props.clusterName) &&
      !/^[a-zA-Z0-9]+$/.test(props.clusterName) &&
      props.clusterName.length > 64
    ) 
  1. The pattern check is too restrictive. The current validation only allows alphanumeric characters, but hyphens (-) should also be allowed.
image

Additionally, the error message in the AWS Management Console appears to be inconsistent with the actual validation requirements.
image

Description of changes

Removed cluster name validation due to the following reasons:

  • The current validation is incorrect and not functioning as intended.
  • While the correct pattern is not documented in CFn docs. So updating the validation might introduce regressions.
  • As suggested by maintainers' comments, there is an opinion that pattern validation should not be implemented in CDK. Ref

Since the correct pattern is not documented clearly, I think removing the validation would be the preferable approach.

Describe any new or updated permissions being added

Nothing.

Description of how you validated changes

Nothing because only remove validation.

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 January 8, 2025 06:45
@github-actions github-actions bot added p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Jan 8, 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.

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.

Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.41%. Comparing base (e33ebb4) to head (015a985).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32792   +/-   ##
=======================================
  Coverage   81.41%   81.41%           
=======================================
  Files         223      223           
  Lines       13721    13721           
  Branches     2416     2416           
=======================================
  Hits        11171    11171           
  Misses       2271     2271           
  Partials      279      279           
Flag Coverage Δ
suite.unit 81.41% <ø> (ø)

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

Components Coverage Δ
packages/aws-cdk 80.75% <ø> (ø)
packages/aws-cdk-lib/core 82.10% <ø> (ø)

@mazyu36
Copy link
Contributor Author

mazyu36 commented Jan 8, 2025

Exemption Request: I think adding tests is unnecessary because this change only involves removing existing validation logic.

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Jan 8, 2025
@mazyu36 mazyu36 force-pushed the fix/cluster-name-validation branch from d0cc55c to 47e1654 Compare January 8, 2025 07:27
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 8, 2025
@gracelu0 gracelu0 added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes and removed pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. labels Jan 13, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review January 13, 2025 19:13

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025
Copy link
Contributor

mergify bot commented Jan 13, 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: 015a985
  • 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 Jan 13, 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 41ddd46 into aws:main Jan 13, 2025
19 checks passed
Copy link

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 Jan 13, 2025
@mazyu36 mazyu36 deleted the fix/cluster-name-validation branch January 14, 2025 04:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2 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.

3 participants