fix(jsii): incorrectly allowed unexported type in constructor params #3147
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
The compiler incorrectly allowed un-epxorted types to be used in a constructor parameter, resulting in invalid assemblies (where a reference to the un-exported type exists, but the type itself does not). Added a test that validates this is now checked against, and improved the error experience by providing source anchors for where the problematic type is being used.
rix0rrr
approved these changes
Nov 9, 2021
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
|
Merging (with squash)... |
This was referenced Nov 11, 2021
mergify bot
pushed a commit
to cdklabs/jsii-docgen
that referenced
this pull request
Nov 16, 2021
Based on our experience from construct hub, adding a few surgical error handling: ### Uninstallable Packages Some packages cannot be installed. We've observed the following: - No spec declared in a `package.json` dependency. For example: https://github.com/markusl/cdk-codepipeline-bitbucket-build-result-reporter/blob/v0.0.7/package.json#L35. - Dependency conflict caused by a fixed peerDependency. For example: https://github.com/opencdk8s/cdk8s-mongo-sts/blob/v0.0.7/package.json#L60 ### Corrupt Assembly Some packages have a corrupt assembly. We've observed the following: - Packages suspcestable to aws/jsii#3147. For example: `@epilot/cdk-constructs@1.0.7` - Packages who's peerDependency underwent a breaking change in a minor version. For example `@pahud/cdktf-aws-eks@0.0.14` ### Unsupported Language Added this detection here to further alleviate burden from callers.
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.
The compiler incorrectly allowed un-epxorted types to be used in a
constructor parameter, resulting in invalid assemblies (where a
reference to the un-exported type exists, but the type itself does not).
Added a test that validates this is now checked against, and improved
the error experience by providing source anchors for where the
problematic type is being used.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.