fix(core): isTaggable function can return undefined instead of false#31600
fix(core): isTaggable function can return undefined instead of false#31600mergify[bot] merged 6 commits intomainfrom
isTaggable function can return undefined instead of false#31600Conversation
Signed-off-by: Sumu <sumughan@amazon.com>
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.
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Signed-off-by: Sumu <sumughan@amazon.com>
Signed-off-by: Sumu <sumughan@amazon.com>
isTaggable function can return undefined instead of false
| public static isTaggable(construct: any): construct is ITaggable { | ||
| const tags = (construct as any).tags; | ||
| return tags && typeof tags === 'object' && (tags as any)[TAG_MANAGER_SYM]; | ||
| return typeof tags === 'object' && (tags as any)[TAG_MANAGER_SYM]; |
There was a problem hiding this comment.
But this now explodes if tags is null. It shouldn't be, but it could be.
Sillily, in JS it's:
typeof null == 'object'
So you can't really get away from the truthiness test. The only thing you have to do is make sure the truth-tested falsy value doesn't leak through.
There was a problem hiding this comment.
Good to know - just updated the return statement:
return tags !== undefined && tags !== null && ...Signed-off-by: Sumu <sumughan@amazon.com>
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). |
|
Comments on closed issues and PRs are hard for our team to see. |
Closes #26495
Reason for this change
The
isTaggablefunction of theTagManagerclass is currently broken in Python, as it can returnundefinedinstead oftrueorfalse.Description of changes
In JS/TS, the logical AND operator (
&&) returns the first falsy value it encounters, even if that value isundefinedinstead offalse- so the current implementation ofisTaggableallows forundefinedto be returned iftagsis undefined:The fix is simply changing the return line to the following to handle cases where tags is
nullorundefined:Description of how you validated changes
Added a unit test to assert that
isTaggablereturnsfalse, notundefinedfor a non-taggable Construct (and still returnstruefor a taggable construct).Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license