fix(cfn2ts): some property times have behavioral-interface names #18275
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
Some CloudFormation library generated types, such as `@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetProperty` are meant to be jsii structs, but have names that cause them to be handled as jsii behavioral interfaces (`I` followed by a capital letter). Mangling the names (i.e: changing `IPSet` to `IpSet`) would also work, but is tedious to maintain and has been proven to lead to inadeverten releasing of stable code that does not have the intended "shape" in other languages. Instead - this uses the jsii type system hints feature introduced a few months ago in the compiler to force those interfaces to be considered as structs regardless of their name. Fixes aws/jsii#2929 (and probably more)
|
|
rix0rrr
approved these changes
Jan 5, 2022
rix0rrr
added
the
pr-linter/exempt-test
|
Thank you for contributing! Your pull request will be updated from master 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 master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
…#18275) Some CloudFormation library generated types, such as `@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetProperty` are meant to be jsii structs, but have names that cause them to be handled as jsii behavioral interfaces (`I` followed by a capital letter). Mangling the names (i.e: changing `IPSet` to `IpSet`) would also work, but is tedious to maintain and has been proven to lead to inadeverten releasing of stable code that does not have the intended "shape" in other languages. Instead - this uses the jsii type system hints feature introduced a few months ago in the compiler to force those interfaces to be considered as structs regardless of their name. Fixes aws/jsii#2929 (and probably more) BREAKING CHANGE: some "complex" property types within the generated CloudFormation interfaces (i.e: properties of `Cfn*` constructs) with names starting with a capital letter `I` followed by another capital letter are no longer incorrectly treated as behavioral interfaces, and might hence have different usage patterns in non-TypeScript languages. Such interfaces were previously very difficult to use in non-TypeScript languages, and required convoluted workarounds, which can now be removed. ---- *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.
Some CloudFormation library generated types, such as
@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetPropertyare meant tobe jsii structs, but have names that cause them to be handled as jsii
behavioral interfaces (
Ifollowed by a capital letter).Mangling the names (i.e: changing
IPSettoIpSet) would also work,but is tedious to maintain and has been proven to lead to inadeverten
releasing of stable code that does not have the intended "shape" in
other languages.
Instead - this uses the jsii type system hints feature introduced a few
months ago in the compiler to force those interfaces to be considered as
structs regardless of their name.
Fixes aws/jsii#2929 (and probably more)
BREAKING CHANGE: some "complex" property types within the generated
CloudFormation interfaces (i.e: properties of
Cfn*constructs) withnames starting with a capital letter
Ifollowed by another capitalletter are no longer incorrectly treated as behavioral interfaces, and
might hence have different usage patterns in non-TypeScript languages.
Such interfaces were previously very difficult to use in non-TypeScript
languages, and required convoluted workarounds, which can now be removed.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license