-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(core): isTaggable
function can return undefined instead of false
#31600
Conversation
Signed-off-by: Sumu <sumughan@amazon.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
@@ -303,7 +303,7 @@ export class TagManager { | |||
*/ | |||
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
isTaggable
function of theTagManager
class is currently broken in Python, as it can returnundefined
instead oftrue
orfalse
.Description of changes
In JS/TS, the logical AND operator (
&&
) returns the first falsy value it encounters, even if that value isundefined
instead offalse
- so the current implementation ofisTaggable
allows forundefined
to be returned iftags
is undefined:The fix is simply changing the return line to the following to handle cases where tags is
null
orundefined
:Description of how you validated changes
Added a unit test to assert that
isTaggable
returnsfalse
, notundefined
for a non-taggable Construct (and still returnstrue
for 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