chore: duplicate enum values not usable #17731
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
|
|
There is an outstanding bug with `jsii` (aws/jsii#2782) where duplicate enum values are not available to the non-JS/TS languages. In these cases, only the first enum value defined is present in the assembly. For these cases, the first value was the deprecated one. This meant that only the deprecated values were present, and once we stripped the deprecated elements, we were left without values. For *v2 only*, we can reorder these enums so the non-deprecated values appear in the assembly. Note that we *cannot* backport this to `master` (v1), because it would introduce breaking changes to our Java/Go/Dotnet/Python customers.
njlynch
force-pushed
the
njlynch/fix-enum-order
branch
from
a152228
to
0a94ad5
Compare
rix0rrr
approved these changes
Nov 26, 2021
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). |
njlynch
added a commit
that referenced
this pull request
Nov 26, 2021
* chore: fix build break caused by exported deprecated functions (#17719) Functions (not member methods) aren't acknowledged by jsii, so they are not stripped out of the compiled source, even when deprecated. These two functions are deprecated and reference deprecated interfaces. When running the init template tests against JS/TS, the tests fail with: ``` node_modules/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/application-listener-rule.d.ts(110,62): error TS2304: Cannot find name 'FixedResponse'. node_modules/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/application-listener-rule.d.ts(116,68): error TS2304: Cannot find name 'RedirectResponse'. ``` By -- on v2 only -- un-exporting the functions and inlining them in their secondary usages, we can effectively "strip" these functions from the JS/TS. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* * chore: duplicate enum values not usable (#17731) There is an outstanding bug with `jsii` (aws/jsii#2782) where duplicate enum values are not available to the non-JS/TS languages. In these cases, only the first enum value defined is present in the assembly. For these cases, the first value was the deprecated one. This meant that only the deprecated values were present, and once we stripped the deprecated elements, we were left without values. For *v2 only*, we can reorder these enums so the non-deprecated values appear in the assembly. Note that we *cannot* backport this to `master` (v1), because it would introduce breaking changes to our Java/Go/Dotnet/Python customers. * chore(release): 2.0.0-rc.33 Co-authored-by: Nick Lynch <nlynch@amazon.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: AWS CDK Team <aws-cdk@amazon.com>
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.
There is an outstanding bug with
jsii(aws/jsii#2782) where duplicate enum values are not
available to the non-JS/TS languages. In these cases, only the first enum value
defined is present in the assembly.
For these cases, the first value was the deprecated one. This meant that only
the deprecated values were present, and once we stripped the deprecated
elements, we were left without values. For v2 only, we can reorder these enums
so the non-deprecated values appear in the assembly. Note that we cannot
backport this to
master(v1), because it would introduce breaking changes toour Java/Go/Dotnet/Python customers.
Methodology:
I modified
list-deprecated-apis.jsto only output deprecated enum membersand deprecation reasons, and ran it against
2.0.0-rc.31, which is the latest CDK v2release candidate that didn't actually strip the deprecated elements. There were only
42 results, which combined with the deprecation messages made it reasonable to
manually verify all of the results.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license