-
Notifications
You must be signed in to change notification settings - Fork 4.2k
feat(ec2): implement IPeer
to PrefixList
to be usable as a connection peer
#33617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #33617 +/- ##
=======================================
Coverage 82.38% 82.38%
=======================================
Files 120 120
Lines 6938 6938
Branches 1170 1170
=======================================
Hits 5716 5716
Misses 1119 1119
Partials 103 103
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(This review is outdated)
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
@ozelalisen Added same jsdocs as |
@@ -8,7 +10,7 @@ import { propertyInjectable } from '../../core/lib/prop-injectable'; | |||
/** | |||
* A prefix list | |||
*/ | |||
export interface IPrefixList extends IResource { | |||
export interface IPrefixList extends IResource, IPeer { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I missed one major issue with this PR previously. So I have the following concern:
- Extending
IPrefixList
withIPeer
represents a backwards compatibility concern since any existing class that implementsIPrefixList
would now be required to implement additionalIPeer
interface methods, which would break existing custom implementations for clients.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops!
How about introducing a new interface inherits IPrefixList
and IPeer
?
// A new interface
export interface IPrefixListWithPeer extends IPrefixList, IPeer { };
// PrefixListBase implements the new interface
abstract class PrefixListBase extends Resource implements IPrefixListWithPeer {
/* implement IPeer */
}
// PrefixList.fromXXX() returns the new interface
export class PrefixList extends PrefixListBase {
public static fromPrefixListId(...): IPrefixListWithPeer;
public static fromLookup(...): IPrefixListWithPeer;
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
error: [awslint:from-signature:aws-cdk-lib.aws_ec2.PrefixList.fromPrefixListId] invalid method signature for fromXxx method. If the construct is using the "constructs" module, set the environment variable "AWSLINT_BASE_CONSTRUCT" and re-run (expected="aws-cdk-lib.aws_ec2.IPrefixList",actual="aws-cdk-lib.aws_ec2.IPrefixListWithPeer")
awslint failed. any solution?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Tietew Sorry about the confusion on this! We had a discussion internally, and your changes by extending IPrefixList does not count as a breaking change, since it is related to implementation upgradability. Your changes are looking good, I will approve your PR.
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). |
Comments on closed issues and PRs are hard for our team to see. |
Issue # (if applicable)
Closes #33607.
Reason for this change
When we want to add a security group rule with
PrefixList
as a connection peer,we should write redundant
prefixList
:This PR allows us to write DRY:
Description of changes
IPrefixList
interface to extendIPeer
IPeer
methods inPrefixListBase
Describe any new or updated permissions being added
Nothing
Description of how you validated changes
Added unit tests and updated an integ test.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license