feat(codedeploy): ignoreAlarmConfiguration parameter to Deployment Groups by nrgeil · Pull Request #26957 · aws/aws-cdk

nrgeil · 2023-08-31T18:36:38Z

The alarms on a CodeDeploy group are configurable to be enabled or disabled through the SDK or UI. Bringing in that functionality to the CDK to have parity. The parameter name mirrors the "Ignore alarm configuration" checkbox in the alarm configuration section of the UI.

Motivation: Developers are able to disable rollback on alarm, but this leaves deployments in a stopped state should any alarms be active. Including this configuration will align with the expectation that alarms will not block a deployment in lower environments via a flag rather than logic to include/exclude alarms on the deployment group based on environment. I'm sure there are other use cases for disabling the alarm configuration on a deployment group.

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

…ment groups The alarms on a CodeDeploy group are configurable to be enabled or disabled through the SDK or UI. Bringing in that functionality to the CDK to have parity.

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.

lpizzinidev

Thanks (and sorry for the late review)! 👍
Looks good overall.
In my opinion, there are some missing unit tests and a slight adjustment in parameter ordering.

lpizzinidev · 2023-10-06T09:44:18Z

packages/aws-cdk-lib/aws-codedeploy/test/ecs/deployment-group.test.ts

    });
  });
+
+  test('can ignore alarm status when alarms are present', () => {


Test cases should be added for each deployment group to verify that the configuration is disabled when ignoreAlarmConfiguration: true, alarms is not empty, and the @aws-cdk/aws-codedeploy:removeAlarmsFromDeploymentGroup feature flag is enabled (this condition).

lpizzinidev · 2023-10-06T10:10:39Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

+  removeAlarms = true,
+  ignoreAlarmConfiguration: boolean = false,


Suggested change

removeAlarms = true,

ignoreAlarmConfiguration: boolean = false,

ignoreAlarmConfiguration = false,

removeAlarms = true,

I think it's better/clearer to keep the feature flag parameter last.

lpizzinidev · 2023-10-06T10:24:25Z

...s/@aws-cdk-testing/framework-integ/test/aws-codedeploy/test/lambda/integ.deployment-group.ts

  ],
  preHook,
  postHook,
+  ignoreAlarmConfiguration: false,


Suggested change

ignoreAlarmConfiguration: false,

Redundant

lpizzinidev · 2023-10-06T10:24:41Z

...s/@aws-cdk-testing/framework-integ/test/aws-codedeploy/test/server/integ.deployment-group.ts

    failedDeployment: false,
    deploymentInAlarm: false,
  },
+  ignoreAlarmConfiguration: false,


Suggested change

ignoreAlarmConfiguration: false,

Redundant

- Update parameter ordering - Add missing unit tests for removeAlarms feature flag - Drop redundant integration test changes

nrgeil · 2023-10-25T11:07:30Z

Thanks (and sorry for the late review)! 👍
Looks good overall.
In my opinion, there are some missing unit tests and a slight adjustment in parameter ordering.

Thanks for the review! Sorry it took me a while to address your comments, my github notifications must be disabled. I think I addressed everything, but let me know if there's anything I missed. Appreciate the call out on the unit test I missed.

lpizzinidev

Thanks for the changes!
Just some minor adjustments to be made.

packages/aws-cdk-lib/aws-codedeploy/lib/server/deployment-group.ts

packages/aws-cdk-lib/aws-codedeploy/lib/lambda/deployment-group.ts

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

packages/aws-cdk-lib/aws-codedeploy/lib/ecs/deployment-group.ts

packages/aws-cdk-lib/aws-codedeploy/lib/server/deployment-group.ts

packages/aws-cdk-lib/aws-codedeploy/lib/lambda/deployment-group.ts

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

vinayak-kukreja

Hey @nrgeil thank you for opening this PR with us. I have some comments, please let me know if I can clarify anything.

vinayak-kukreja · 2023-12-05T23:16:21Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

-CfnDeploymentGroup.AlarmConfigurationProperty | undefined {
+export function renderAlarmConfiguration(
+  alarms: cloudwatch.IAlarm[],
+  ignorePollAlarmFailure?: boolean,


Hey, why is this optional now?

It was possible to be undefined before. Correct me if I'm wrong, but isn't this equivalent? It got called out in community review to simplify, but I'd be happy to revert.

It is equivalent. Ideally this would have been part of a property bag to begin with, but now doing so is a breaking change. So no update needed here.

vinayak-kukreja · 2023-12-05T23:17:54Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

+  ignoreAlarmConfiguration = false,
+  removeAlarms = true,


I believe the new property should be at the end. Since this is an exported function, someone could be using it and now their third parameter would be referencing another argument.

Funny enough, that's what I had originally. There was a request to flip it here for readability, but to your point usability should probably supersede.

@vinayak-kukreja is right, we cannot flip it because it would be a breaking change to flip. However, I have an alternate solution: we deprecate renderAlarmConfiguration entirely and build renderAlarmConfigurationV2.

It would look like this:

export function renderAlarmConfiguration(alarms: cloudwatch.IAlarm[], ignorePollAlarmFailure: boolean | undefined, removeAlarms = true) { return renderAlarmConfigurationV2({ alarms, ignorePollAlarmFailure, removeAlarms }); } export interface renderAlarmConfigProps { readonly alarms: cloudwatch.IAlarm[], readonly ignorePollAlarmFailure?: boolean, /** default true */ readonly removeAlarms?: boolean, // your new prop } export function renderAlarmConfigurationV2(props: renderAlarmConfigProps) { // the original implementation plus your new prop }

This would mean updating all the places we use renderAlarmConfiguration to renderAlarmConfigurationV2, but I think this is the correct path to go down.

kaizencc · 2023-12-18T18:22:18Z

Nudging you again @nrgeil. Let us know if you are willing to continue work on this PR!

nrgeil

Sorry about the delayed response, missed the github notifications.

Thanks for the review! The comments conflict a little with the previous community review, so let me know how you'd like me to proceed. I'll hold off on pushing a new commit until I have clarification.

nrgeil · 2023-12-18T18:27:09Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

-CfnDeploymentGroup.AlarmConfigurationProperty | undefined {
+export function renderAlarmConfiguration(
+  alarms: cloudwatch.IAlarm[],
+  ignorePollAlarmFailure?: boolean,


It was possible to be undefined before. Correct me if I'm wrong, but isn't this equivalent? It got called out in community review to simplify, but I'd be happy to revert.

nrgeil · 2023-12-18T18:30:32Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

+  ignoreAlarmConfiguration = false,
+  removeAlarms = true,


Funny enough, that's what I had originally. There was a request to flip it here for readability, but to your point usability should probably supersede.

kaizencc

Hi @nrgeil, thanks for responding. I looked through the outstanding comments a bit more and have just the one thing for you. The rest of the code looks good, I'm happy to approve once the comment is addressed. Thanks for your contributions!

kaizencc · 2023-12-18T22:47:01Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

+  ignoreAlarmConfiguration = false,
+  removeAlarms = true,


@vinayak-kukreja is right, we cannot flip it because it would be a breaking change to flip. However, I have an alternate solution: we deprecate renderAlarmConfiguration entirely and build renderAlarmConfigurationV2.

It would look like this:

export function renderAlarmConfiguration(alarms: cloudwatch.IAlarm[], ignorePollAlarmFailure: boolean | undefined, removeAlarms = true) { return renderAlarmConfigurationV2({ alarms, ignorePollAlarmFailure, removeAlarms }); } export interface renderAlarmConfigProps { readonly alarms: cloudwatch.IAlarm[], readonly ignorePollAlarmFailure?: boolean, /** default true */ readonly removeAlarms?: boolean, // your new prop } export function renderAlarmConfigurationV2(props: renderAlarmConfigProps) { // the original implementation plus your new prop }

This would mean updating all the places we use renderAlarmConfiguration to renderAlarmConfigurationV2, but I think this is the correct path to go down.

aws-cdk-automation · 2024-01-09T00:08:45Z

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.

kaizencc · 2024-01-09T17:36:40Z

@nrgeil pinging you again on this; this PR will soon be closed without any action

Pull request has been modified.

…urationV2 - Create props class - Documentation updates - Update implementation to handle defaults

nrgeil · 2024-01-10T12:42:35Z

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

+   */
+  readonly ignorePollAlarmFailure?: boolean,
+  /**
+   * When no alarms are provided on an update, removes previously existing alarms from the construct.


Please correct me if I'm wrong, but I believe this is what's happening. It was pretty unclear to me what exactly this did so I wanted to make sure it got documented.

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.

kaizencc

Thanks @nrgeil I will work to get this one in. Thanks for your patience :)

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

packages/aws-cdk-lib/aws-codedeploy/lib/ecs/deployment-group.ts

packages/aws-cdk-lib/aws-codedeploy/lib/lambda/deployment-group.ts

packages/aws-cdk-lib/aws-codedeploy/lib/server/deployment-group.ts

kaizencc

Hopefully my changes pass the build :)

aws-cdk-automation · 2024-02-12T23:06:40Z

AWS CodeBuild CI Report

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

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

mergify · 2024-02-12T23:07:00Z

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

…oups (#26957) The alarms on a CodeDeploy group are configurable to be enabled or disabled through the SDK or UI. Bringing in that functionality to the CDK to have parity. The parameter name mirrors the "Ignore alarm configuration" checkbox in the alarm configuration section of the UI. Motivation: Developers are able to disable _rollback_ on alarm, but this leaves deployments in a stopped state should any alarms be active. Including this configuration will align with the expectation that alarms will not block a deployment in lower environments via a flag rather than logic to include/exclude alarms on the deployment group based on environment. I'm sure there are other use cases for disabling the alarm configuration on a deployment group. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Introduce ignoreAlarmConfiguration parameter to aws-codedeploy deploy…

35c2a15

…ment groups The alarms on a CodeDeploy group are configurable to be enabled or disabled through the SDK or UI. Bringing in that functionality to the CDK to have parity.

github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Aug 31, 2023

aws-cdk-automation requested a review from a team August 31, 2023 18:36

github-actions bot added the p2 label Aug 31, 2023

aws-cdk-automation previously requested changes Aug 31, 2023

View reviewed changes

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

Monthly PRs metrics report - Aug 2023 #26965

Closed

nrgeil changed the title ~~feat(aws-codedeploy): Introduce ignoreAlarmConfiguration parameter to aws-codedeploy~~ feat(codedeploy): Introduce ignoreAlarmConfiguration parameter to aws-codedeploy Sep 13, 2023

nrgeil and others added 2 commits September 13, 2023 06:24

Merge branch 'aws:main' into codedeploy_ignore_alarms

233a123

Update integration tests

583afc6

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 13, 2023

Merge branch 'main' into codedeploy_ignore_alarms

99a93e9

indrora added the pr/needs-review label Sep 21, 2023

lpizzinidev suggested changes Oct 6, 2023

View reviewed changes

nrgeil and others added 2 commits October 25, 2023 06:13

Merge branch 'main' into codedeploy_ignore_alarms

4354432

Address PR comments

834c11b

- Update parameter ordering - Add missing unit tests for removeAlarms feature flag - Drop redundant integration test changes

nrgeil requested a review from lpizzinidev October 25, 2023 11:05

lpizzinidev suggested changes Oct 25, 2023

View reviewed changes

nrgeil and others added 3 commits October 27, 2023 10:50

Apply suggestions from code review

0abaa82

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Merge branch 'main' into codedeploy_ignore_alarms

ea1a7e5

fix mistake

8d11743

lpizzinidev approved these changes Oct 28, 2023

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Oct 28, 2023

Merge branch 'main' into codedeploy_ignore_alarms

8d4f8d1

vinayak-kukreja reviewed Dec 5, 2023

View reviewed changes

scanlonp assigned vinayak-kukreja Dec 6, 2023

nrgeil commented Dec 18, 2023

View reviewed changes

kaizencc previously requested changes Dec 18, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 18, 2023

kaizencc removed the pr/needs-review label Dec 29, 2023

Merge branch 'main' into codedeploy_ignore_alarms

ab9db0e

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

nrgeil added 2 commits January 10, 2024 07:39

Deprecate renderAlarmConfiguration and replace with renderAlarmConfig…

59ffe2e

…urationV2 - Create props class - Documentation updates - Update implementation to handle defaults

Fix @see doc notation for external link

32a8a27

nrgeil commented Jan 10, 2024

View reviewed changes

vinayak-kukreja removed their assignment Jan 23, 2024

Merge branch 'main' into codedeploy_ignore_alarms

dbac7ef

aws-cdk-automation previously requested changes Feb 12, 2024

View reviewed changes

kaizencc changed the title ~~feat(codedeploy): Introduce ignoreAlarmConfiguration parameter to aws-codedeploy~~ feat(codedeploy): ignoreAlarmConfiguration parameter to CodeDeploy Groups Feb 12, 2024

kaizencc changed the title ~~feat(codedeploy): ignoreAlarmConfiguration parameter to CodeDeploy Groups~~ feat(codedeploy): ignoreAlarmConfiguration parameter to Deployment Groups Feb 12, 2024

kaizencc reviewed Feb 12, 2024

View reviewed changes

Apply suggestions from code review

9b3be1d

kaizencc approved these changes Feb 12, 2024

View reviewed changes

mergify bot merged commit e890e89 into aws:main Feb 12, 2024

		removeAlarms = true,
		ignoreAlarmConfiguration: boolean = false,

Conversation

nrgeil commented Aug 31, 2023

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

lpizzinidev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nrgeil commented Oct 25, 2023

Uh oh!

lpizzinidev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vinayak-kukreja left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaizencc commented Dec 18, 2023

Uh oh!

nrgeil left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaizencc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation commented Jan 9, 2024

Uh oh!

kaizencc commented Jan 9, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

kaizencc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaizencc left a comment