fix(cloudwatch): render region and accountId when directly set on metrics#29935
fix(cloudwatch): render region and accountId when directly set on metrics#29935TrevorBurnham wants to merge 1 commit intoaws:mainfrom
Conversation
aws-cdk-automation
left a comment
There was a problem hiding this comment.
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.
|
The PR linter says "Fixes must contain a change to an integration test file and the resulting snapshot." Is there an existing integration test that's relevant to this functionality? I'm happy to add one, but I could use some direction. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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. |
|
Clarification Request: How can I address the linter failure? |
|
This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error. |
|
The pull request linter fails with the following errors: PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing |
…rics (#32325) ### Issue # Closes #28731 ### Reason for this change Currently, if a user creates a metric that includes `region` and `accountId`, those fields are omitted when the metric renders in a stack with those same values. The intended behavior is to omit those fields when they're implicitly set via `metric.attachTo(stack)`, not to omit them when set directly by the user. ### Description of changes This is a second attempt at #29935, which was auto-closed after the pull request linter complained that there were no integration test changes. This time around I've tried to satisfy the linter. Otherwise, the changes are the same as before: The key changes here are on the `Metric` class. Previously, `region` and `account` were public properties that were set by `metric.attachTo(stack)`, making it impossible to differentiate whether they were set directly or via `attachTo`. To differentiate them while maintaining backward compatibility, I took this approach: 1. `attachTo` sets internal properties called `stackRegion` and `stackAccount`. Setting `region` and `account` directly sets internal properties called `regionOverride` and `accountOverride`. 2. The public `region` and `account` properties are now getters that return the override (if set) and fall back on the stack properties. 3. The `toMetricConfig()` method returns the `region` and `account` from the getters, but also includes the `regionOverride` and `accountOverride`. That way, everything that looks at `region` and `account` works the same way it did before, except in `metricGraphJson`, which skips the "if different from stack" tokenization if the overrides are set. ### Description of how you validated changes 1. Confirmed that all existing unit tests pass. 2. Added a new unit test to show that `region` and `account` are now preserved when set directly on a metric. 3. Modified an integration test to show how setting `region` and `account` on a metric affects the snapshot. ### Checklist - [x] 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*
…rics (#32325) ### Issue # Closes #28731 ### Reason for this change Currently, if a user creates a metric that includes `region` and `accountId`, those fields are omitted when the metric renders in a stack with those same values. The intended behavior is to omit those fields when they're implicitly set via `metric.attachTo(stack)`, not to omit them when set directly by the user. ### Description of changes This is a second attempt at #29935, which was auto-closed after the pull request linter complained that there were no integration test changes. This time around I've tried to satisfy the linter. Otherwise, the changes are the same as before: The key changes here are on the `Metric` class. Previously, `region` and `account` were public properties that were set by `metric.attachTo(stack)`, making it impossible to differentiate whether they were set directly or via `attachTo`. To differentiate them while maintaining backward compatibility, I took this approach: 1. `attachTo` sets internal properties called `stackRegion` and `stackAccount`. Setting `region` and `account` directly sets internal properties called `regionOverride` and `accountOverride`. 2. The public `region` and `account` properties are now getters that return the override (if set) and fall back on the stack properties. 3. The `toMetricConfig()` method returns the `region` and `account` from the getters, but also includes the `regionOverride` and `accountOverride`. That way, everything that looks at `region` and `account` works the same way it did before, except in `metricGraphJson`, which skips the "if different from stack" tokenization if the overrides are set. ### Description of how you validated changes 1. Confirmed that all existing unit tests pass. 2. Added a new unit test to show that `region` and `account` are now preserved when set directly on a metric. 3. Modified an integration test to show how setting `region` and `account` on a metric affects the snapshot. ### Checklist - [x] 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*
Issue
Closes #28731
Reason for this change
Currently, if a user creates a metric that includes
regionandaccountId, those fields are omitted when the metric renders in a stack with those same values. The intended behavior is to omit those fields when they're implicitly set viametric.attachTo(stack), not to omit them when set directly by the user.This change differentiates those behaviors and adds a test case.
Description of changes
The key changes here are on the
Metricclass. Previously,regionandaccountwere public properties that were set bymetric.attachTo(stack), making it impossible to differentiate whether they were set directly or viaattachTo. To differentiate them while maintaining backward compatibility, I took this approach:attachTosets internal properties calledstackRegionandstackAccount. Settingregionandaccountdirectly sets internal properties calledregionOverrideandaccountOverride.regionandaccountproperties are now getters that return the override (if set) and fall back on the stack properties.toMetricConfig()method returns theregionandaccountfrom the getters, but also includes theregionOverrideandaccountOverride.That way, everything that looks at
regionandaccountworks the same way it did before, except inmetricGraphJson, which skips the "if different from stack" tokenization if the overrides are set.Description of how you validated changes
All existing unit tests are satisfied by these changes.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license