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(ecs-patterns): minHealthyPercent and maxHealthyPercent props validation #26193

Merged
merged 5 commits into from
Jul 25, 2023

Conversation

lpizzinidev
Copy link
Contributor

Setting maxHealthyPercent to a non-integer value was not raising synth-time errors, but was generating invalid CFN templates.
This fix adds validation for both maxHealthyPercent and minHealthyPercent.

Closes #26158.


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

@gitpod-io
Copy link

gitpod-io bot commented Jul 1, 2023

@github-actions github-actions bot added admired-contributor [Pilot] contributed between 13-24 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Jul 1, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team July 1, 2023 13:33
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.

@@ -96,6 +96,9 @@ export class ApplicationLoadBalancedFargateService extends ApplicationLoadBalanc
throw new Error('You must specify one of: taskDefinition or image');
}

this.validateHealthyPercentage('minHealthyPercent', props.minHealthyPercent);
this.validateHealthyPercentage('maxHealthyPercent', props.maxHealthyPercent);
Copy link
Contributor

Choose a reason for hiding this comment

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

While we're here, please also validate that min < max.

@lpizzinidev
Copy link
Contributor Author

Exemption request.
Let me know if an integration test is needed.

@aws-cdk-automation 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 Jul 1, 2023
@aws-cdk-automation
Copy link
Collaborator

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

@lpizzinidev
Copy link
Contributor Author

lpizzinidev commented Jul 23, 2023

Exemption request.
This fix implements validation, it shouldn't require an integration test.

@lpizzinidev
Copy link
Contributor Author

@otaviomacedo
This should be ready to merge

Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

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

Still a couple of issues. Assuming I understand correctly how this works and min should indeed by lower than max.
My bad.

this.validateHealthyPercentage('minHealthyPercent', props.minHealthyPercent);
this.validateHealthyPercentage('maxHealthyPercent', props.maxHealthyPercent);

if (props.minHealthyPercent && props.maxHealthyPercent && props.minHealthyPercent >= props.maxHealthyPercent) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if (props.minHealthyPercent && props.maxHealthyPercent && props.minHealthyPercent >= props.maxHealthyPercent) {
if (props.minHealthyPercent && !Token.isUnresolved(props.minHealthyPercent) && props.maxHealthyPercent && !Token.isUnresolved(props.maxHealthyPercent) && props.minHealthyPercent < props.maxHealthyPercent) {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, in fact, I throw an exception if min >= max.
My code should be correct (unless I'm missing something).
I can add the token resolution check if you think that's necessary.

Copy link
Contributor

@mrgrain mrgrain Jul 24, 2023

Choose a reason for hiding this comment

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

Ah yes of course 🤦🏻 Just need to add the checks for unresolved tokens than please!

Suggested change
if (props.minHealthyPercent && props.maxHealthyPercent && props.minHealthyPercent >= props.maxHealthyPercent) {
if (props.minHealthyPercent && !Token.isUnresolved(props.minHealthyPercent) && props.maxHealthyPercent && !Token.isUnresolved(props.maxHealthyPercent) props.minHealthyPercent >= props.maxHealthyPercent) {

Comment on lines 135 to 142
if (value === undefined) { return; }
if (!Number.isInteger(value) || value < 0) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if (value === undefined) { return; }
if (!Number.isInteger(value) || value < 0) {
if (value === undefined || Token.isUnresolved(value)) {
return;
}

@mrgrain
Copy link
Contributor

mrgrain commented Jul 24, 2023

@lpizzinidev Sorry for that! We still need the checks for unresolved Tokens. Otherwise this is good to go.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@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 Jul 25, 2023
@mrgrain mrgrain added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Jul 25, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review July 25, 2023 10:37

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

@mergify
Copy link
Contributor

mergify bot commented Jul 25, 2023

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 bdfdc91 into aws:main Jul 25, 2023
7 of 9 checks passed
bmoffatt pushed a commit to bmoffatt/aws-cdk that referenced this pull request Jul 29, 2023
…validation (aws#26193)

Setting `maxHealthyPercent` to a non-integer value was not raising synth-time errors, but was generating invalid CFN templates.
This fix adds validation for both `maxHealthyPercent` and `minHealthyPercent`.

Closes aws#26158.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admired-contributor [Pilot] contributed between 13-24 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-cdk-lib/aws-ecs-patterns: setting maxHealthyPercent incorrectly causes stack to fail to deploy
4 participants