(jsii) --add-deprecated-warnings flag should not add warning when a non-deprecated interface extends a deprecated interface #3111
Comments
nija-at
pushed a commit
that referenced
this issue
Nov 2, 2021
… is extended It is common in the AWS CDK for non-deprecated interfaces to extend deprecated interfaces. Currently, when this occurs and the non-deprecated subclass is referenced, a warning is generated notifying the deprecation of its superclass. Modify the implementation such that the warning is produced only when a property of the deprecated interface is referenced. In the case when a deprecated interface with no required properties is used without any of its properties set, a warning will not be generated. This should occur rarely and the trade off is acceptable. fixes #3111
nija-at
pushed a commit
that referenced
this issue
Nov 2, 2021
… is extended (#3112) It is common in the AWS CDK for non-deprecated interfaces to extend deprecated interfaces. Currently, when this occurs and the non-deprecated subclass is referenced, a warning is generated notifying the deprecation of its superclass. Modify the implementation such that the warning is produced only when a property of the deprecated interface is referenced. In the case when a deprecated interface with no required properties is used without any of its properties set, a warning will not be generated. This should occur rarely and the trade off is acceptable. fixes #3111
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
🐛 Bug Report
It is acceptable for a non-deprecated interface to extend a deprecated interface.
The
--strip-deprecatedflag correctly handles this, by not exporting the symbols around the deprecated interface.However, the
--add-deprecated-warningsflag does not account for this. It produces a warning when the non-deprecated interface is referenced.Examples:
https://github.com/aws/aws-cdk/blob/db63fba358a5a8cc3d252156d14ead57d2b7560d/packages/%40aws-cdk/aws-ecr-assets/lib/image-asset.ts#L58
DockerImageAssetOptionsis not deprecated whereasFingerprintOptionsis.https://github.com/aws/aws-cdk/blob/db63fba358a5a8cc3d252156d14ead57d2b7560d/packages/%40aws-cdk/aws-s3-assets/lib/asset.ts#L17
AssetOptionsis not deprecated whileCopyOptionsis.The text was updated successfully, but these errors were encountered: