chore(appconfig): refactor README and integ tests #29017
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
p2
admired-contributor
aws-cdk-automation
added
the
pr/needs-community-review
kaizencc
previously requested changes
Feb 8, 2024
Comment on lines
94
to
95
| Environment monitors also support L1 CfnEnvironment.MonitorsProperty constructs. However, this is not the recommended approach | ||
| for CloudWatch alarms because a role will not be auto-generated if not provided. |
There was a problem hiding this comment.
Suggested change
| Environment monitors also support L1 CfnEnvironment.MonitorsProperty constructs. However, this is not the recommended approach | |
| for CloudWatch alarms because a role will not be auto-generated if not provided. | |
| Environment monitors also support L1 `CfnEnvironment.MonitorsProperty` constructs. However, this is not the recommended approach | |
| for CloudWatch alarms because a role will not be auto-generated if not provided. |
I actually have a few issues with this section:
- the sentence should mention how, i.e. by using the
fromCfnMonitorsPropertymethod. - however, I am not a fan of this approach at all. am I missing some context about why this method was added in the first place? CDK doesn't typically encourage this type of L1 method on L2 so I want to dig a bit deeper on why its necessary at all
- finally, looking at the code, it seems like the issue with
fromCfnMonitorsPropertyis that it will fail entirely if a role is not provided, likely in a confusing manner (because errors due to!don't tend to be very descriptive). Looking at this code below:
public static fromCfnMonitorsProperty(monitorsProperty: CfnEnvironment.MonitorsProperty): Monitor {
return {
alarmArn: monitorsProperty.alarmArn!,
alarmRoleArn: monitorsProperty.alarmRoleArn,
monitorType: MonitorType.CFN_MONITORS_PROPERTY,
};
}I think, if we have a reason to keep this method, it should be updated to (to avoid ! entirely):
public static fromCfnMonitorsProperty(monitorsProperty: CfnEnvironment.MonitorsProperty): Monitor {
if (monitorsProperty.alarmArn === undefined) { throw new Error('need this prop'); }
return {
alarmArn: monitorsProperty.alarmArn,
alarmRoleArn: monitorsProperty.alarmRoleArn,
monitorType: MonitorType.CFN_MONITORS_PROPERTY,
};
}There was a problem hiding this comment.
updated with suggested changes
aws-cdk-automation
removed
the
pr/needs-community-review
mergify
bot
dismissed
kaizencc’s stale review
Pull request has been modified.
aws-cdk-automation
added
the
pr/needs-community-review
kaizencc
reviewed
Feb 9, 2024
| @@ -348,8 +348,9 @@ export abstract class Monitor { | |||
| * @param monitorsProperty The monitors property. | |||
| */ | |||
| public static fromCfnMonitorsProperty(monitorsProperty: CfnEnvironment.MonitorsProperty): Monitor { | |||
| if (monitorsProperty.alarmArn === undefined) { throw new Error('need this prop'); } | |||
There was a problem hiding this comment.
sorry! we need a better error message than this. This was a placeholder :)
kaizencc
reviewed
Feb 9, 2024
kaizencc
approved these changes
Feb 9, 2024
aws-cdk-automation
removed
the
pr/needs-community-review
|
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
TheRealAmazonKendra
pushed a commit
that referenced
this pull request
Feb 9, 2024
### Reason for this change Making changes after API review. ### Description of changes Refactor README and integ tests. ### Description of how you validated changes ### Checklist - [ ] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reason for this change
Making changes after API review.
Description of changes
Refactor README and integ tests.
Description of how you validated changes
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license