fix(custom-resources): logApiResponseData is added to custom resource event properties by default
#30418
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
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
aws-cdk-automation
previously requested changes
Jun 1, 2024
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.
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
colifran
changed the title
logApiResponseData is triggers onUpdate by defaultlogApiResponseData triggers onUpdate by default
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
colifran
changed the title
logApiResponseData triggers onUpdate by defaultlogApiResponseData is added to custom resource properties by default
Signed-off-by: Francis <[email protected]>
aws-cdk-automation
added
the
pr/needs-maintainer-review
Signed-off-by: Francis <[email protected]>
colifran
changed the title
logApiResponseData is added to custom resource properties by defaultlogApiResponseData is added to custom resource event properties by default
Signed-off-by: Francis <[email protected]>
Signed-off-by: Francis <[email protected]>
|
Any thoughts if this makes to 2.145 version? |
Signed-off-by: Francis <[email protected]>
colifran
force-pushed
the
colifran/logging
branch
from
7893881
to
238c815
Compare
Signed-off-by: Francis <[email protected]>
comcalvi
approved these changes
Jun 5, 2024
|
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). |
Leo10Gama
pushed a commit
to Leo10Gama/aws-cdk
that referenced
this pull request
Jun 11, 2024
…ce event properties by default (aws#30418) Closes aws#30121, aws#29949 ### Reason for this change PR aws#29648 introduced a new resource property `logApiResponseData`. This resource property is `true` by default which forces an update for `AwsCustomResource`. For users without `onUpdate` configured an empty data object is returned if no SDK call is configured. This can cause an attribute error if the user is depending on a data from a specific SDK call. ### Description of changes Made `logApiResponseData` undefined by default which will not trigger `onUpdate`. To maintain backwards compatibility with the original PR introducing `logApiResponseData` as true by default, I've also introduced a feature flag that will allow users to keep the current behavior so they aren't now forced into another `onUpdate` event. ### Description of how you validated changes Updated unit tests where `logApiResponseData` was added as a resource property. Added new unit test to verify that `logApiResponseData` could be added to the event. Updated unit tests that test `_render()` to ensure that the default case will result in an empty object. Updated integ tests. ### 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*
1 task
mazyu36
pushed a commit
to mazyu36/aws-cdk
that referenced
this pull request
Jun 22, 2024
…ce event properties by default (aws#30418) Closes aws#30121, aws#29949 ### Reason for this change PR aws#29648 introduced a new resource property `logApiResponseData`. This resource property is `true` by default which forces an update for `AwsCustomResource`. For users without `onUpdate` configured an empty data object is returned if no SDK call is configured. This can cause an attribute error if the user is depending on a data from a specific SDK call. ### Description of changes Made `logApiResponseData` undefined by default which will not trigger `onUpdate`. To maintain backwards compatibility with the original PR introducing `logApiResponseData` as true by default, I've also introduced a feature flag that will allow users to keep the current behavior so they aren't now forced into another `onUpdate` event. ### Description of how you validated changes Updated unit tests where `logApiResponseData` was added as a resource property. Added new unit test to verify that `logApiResponseData` could be added to the event. Updated unit tests that test `_render()` to ensure that the default case will result in an empty object. Updated integ tests. ### 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*
This was referenced Jul 5, 2024
This was referenced Jul 16, 2024
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #30121, #29949
Reason for this change
PR #29648 introduced a new resource property
logApiResponseData. This resource property istrueby default which forces an update forAwsCustomResource. For users withoutonUpdateconfigured an empty data object is returned if no SDK call is configured. This can cause an attribute error if the user is depending on a data from a specific SDK call.Description of changes
Made
logApiResponseDataundefined by default which will not triggeronUpdate. To maintain backwards compatibility with the original PR introducinglogApiResponseDataas true by default, I've also introduced a feature flag that will allow users to keep the current behavior so they aren't now forced into anotheronUpdateevent.Description of how you validated changes
Updated unit tests where
logApiResponseDatawas added as a resource property. Added new unit test to verify thatlogApiResponseDatacould be added to the event. Updated unit tests that test_render()to ensure that the default case will result in an empty object. Updated integ tests.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license