-
Notifications
You must be signed in to change notification settings - Fork 4k
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
fix(ec2-alpha): do not use string comparison in rangesOverlap
#32269
base: main
Are you sure you want to change the base?
Conversation
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.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
rangesOverlap
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
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.
Given how little ip-num
is being used, I would advise against adding it as a dependency
@@ -1,6 +1,7 @@ | |||
/*eslint no-bitwise: ["error", { "allow": ["~", "|", "<<", "&"] }] */ | |||
|
|||
import { ISubnet } from 'aws-cdk-lib/aws-ec2'; | |||
import { IPv4 } from 'ip-num/IPNumber'; |
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.
Adding a dependency to convert an IP address to a sortable numeric value seems a bit excessive, you could implement something similar to what's being done with CidrBlockIpv6.getIPv6Range
:
private ipv4ToNumber(ipv4Address: string): number {
return parseInt(ipv4Address.split('.').map(part => parseInt(part).toString(2).padStart(8, '0')).join(''), 2);
}
A BigInt shouldn't be necessary for IPv4s, Number.MAX_SAFE_INTEGER
should always be greater than 255.255.255.255
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.
Thanks for the feedback. I agree, adding a dependency just to compare IPv4 addresses is a bit too much. I will add a private method to convert the IP addresses to comparable numbers, like you suggested.
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.
Could you add a few more test cases here, such as:
- Test that
range1
being fully contained withinrange2
is evaluated to be an overlap - Test that given end1 = start2 + 1, they are not overlapping. Same with end1 = start2 are considered to be overlapping
- Not sure if that's allowed later on by the CDK or CloudFormation, but test that having a reversed start and end (start1 > end1) does not mess up the overlapping evaluation
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.
Everywhere rangesOverlap
is called, the range is calculated like cidrBlock.minIp(), cidrBlock.maxIp()
, so it's always "in order". The implicit assumption with checking for overlap using start1 <= end2 && start2 <= end1
is that start1 <= end1
and start2 <= end2
.
const start1 = IPv4.fromString(range1[0]); | ||
const end1 = IPv4.fromString(range1[1]); | ||
const start2 = IPv4.fromString(range2[0]); | ||
const end2 = IPv4.fromString(range2[1]); | ||
// Check if ranges overlap | ||
return start1 <= end2 && start2 <= end1; | ||
return start1.isLessThanOrEquals(end2) && start2.isLessThanOrEquals(end1); |
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 would go back to being:
const [start1, end1] = range1.map(this.ipv4ToNumber);
const [start2, end2] = range2.map(this.ipv4ToNumber);
// Check if ranges overlap
return start1 <= end2 && start2 <= end1;
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.
LGTM. And I didn't see there was already a ipToNum
method. Gave it a look, kind of funny to see the "hardcore" maths vs my naive proposed implementation 😆
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Issue #32145
Closes #32145.
Reason for this change
The rangesOverlap method was using string comparison to check if IP ranges overlapped.
Description of changes
The rangesOverlap method was updated to compare IP ranges using the ip-num library
Description of how you validated changes
Added two unit tests to verify correct behavior
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license