chore(core): isCfnResource allows any type as input #28001
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
star-contributor
aws-cdk-automation
added
the
pr/needs-community-review
go-to-k
reviewed
Nov 15, 2023
| public static isCfnResource(construct: IConstruct): construct is CfnResource { | ||
| return (construct as any).cfnResourceType !== undefined; | ||
| public static isCfnResource(x: any): x is CfnResource { | ||
| return x !== null && typeof(x) === 'object' && x.cfnResourceType !== undefined; |
There was a problem hiding this comment.
Other similar isXxx methods check by Symbol, is there any reason not to do the following? I thought it would work as it is more safe and also keeps the consistent signatures.
Because the cfnResourceType can be considered unique property?
const CFN_RESOURCE_SYMBOL = Symbol.for('@aws-cdk/core.CfnResource');
// ...
public static isCfnResource(x: any): x is CfnResource {
return x !== null && typeof(x) === 'object' && CFN_RESOURCE_SYMBOL in x;
}
// ...
constructor(scope: Construct, id: string, props: CfnResourceProps) {
// ...
Object.defineProperty(this, CFN_RESOURCE_SYMBOL, { value: true });There was a problem hiding this comment.
Thanks. I'd like to keep this as it is to prevent from possible breaking change unless there is a strong reason to do so.
go-to-k
approved these changes
Nov 15, 2023
| public static isCfnResource(construct: IConstruct): construct is CfnResource { | ||
| return (construct as any).cfnResourceType !== undefined; | ||
| public static isCfnResource(x: any): x is CfnResource { | ||
| return x !== null && typeof(x) === 'object' && x.cfnResourceType !== undefined; |
aws-cdk-automation
added
pr/needs-maintainer-review
vinayak-kukreja
added
the
pr/do-not-merge
vinayak-kukreja
previously approved these changes
Nov 28, 2023
aws-cdk-automation
removed
the
pr/needs-maintainer-review
vinayak-kukreja
removed
the
pr/do-not-merge
|
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). |
mergify
bot
dismissed
vinayak-kukreja’s stale review
Pull request has been modified.
vinayak-kukreja
approved these changes
Nov 29, 2023
|
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). |
chenjane-dev
pushed a commit
to chenjane-dev/aws-cdk
that referenced
this pull request
Dec 5, 2023
It is more or less frustrating that we have to check if a variable is undefined or not before calling the `CfnResource.isCfnResource` method. For example,
```ts
const bucket1 = new Bucket(stack, 'Bucket1');
const bucket1Resource = bucket1.node.defaultChild;
if (bucket1Resource !== undefined && // Currently we need this!
cdk.CfnResource.isCfnResource(bucket1Resource)
) {
bucket1Resource.addDependency(...);
}
```
With this PR, `isCfnResource` now accepts `any` type as input and performs the necessary validations inside.
```ts
const bucket1 = new Bucket(stack, 'Bucket1');
const bucket1Resource = bucket1.node.defaultChild;
if (cdk.CfnResource.isCfnResource(bucket1Resource)) { // much smoother
bucket1Resource.addDependency(...);
}
```
Actually, other `isXxx` methods have consistent signatures like the one below:
```ts
public static isStack(x: any): x is Stack
public static isReference(x: any): x is Reference
public static isCfnElement(x: any): x is CfnElement
// and more...
```
This change also makes the `isCfnResource` consistent with these signatures.
Note that this is not a breaking change, because the input constraint is relaxed, not tightened, so all the old code will work without change.
----
*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.
It is more or less frustrating that we have to check if a variable is undefined or not before calling the
CfnResource.isCfnResourcemethod. For example,With this PR,
isCfnResourcenow acceptsanytype as input and performs the necessary validations inside.Actually, other
isXxxmethods have consistent signatures like the one below:This change also makes the
isCfnResourceconsistent with these signatures.Note that this is not a breaking change, because the input constraint is relaxed, not tightened, so all the old code will work without change.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license