Skip to content
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

added wrapper type and todos #348

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

AnkurRathore
Copy link

@GlenDC I have attempted to add some wrapper types, and I have some doubts implementing them which I have put as TODO in the comments. I would need your guidance on this.

Copy link
Member

@GlenDC GlenDC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if my comments in this review are sufficient guidance or in case you need more detailed guidance. If the latter try to be more specific on where exactly you want my guidance with.

DualPreferIpV4
}

impl Default for IPModes {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can easier define this by using Default in the #[derive(..)] above and set #[default] above Dual,.

rama-tcp/src/client/connect.rs Outdated Show resolved Hide resolved
@@ -23,6 +23,49 @@ use tokio::{
},
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum IPModes {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Originally I wanted to go for a single IP Mode indeed, and work with wrapper types. However I think it makes more sense to define 2 enums:

enum DnsResolveIpMode
    dual (default)
    singleIpV4
    singleIpV6
    dualPreferIpv4

enum ConnectIpMode
    dual (default)
    ipv4
    ipv6

Don't think these belong in rama-tcp though. Probably more like in rama-net or so.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I need to put these in rama-net?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes as these are not specific to tcp. E.g. in a future version we'll also support udp. And other packages such as Dns might also make use of it for w/e. The common denominator is that it's all related to network protocols, as such rama-net.

You can put it in a file created as rama-net/src/mode.rs and just pub mod mode in the lib.rs file of that crate.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still to move to rama-net and ConnectIpMode is still to be used as well in the tcp connection part itself (unrelated from DnsResolveIpMode)


/*
TODO - Using the wrapper types
in the tcp_connect fn, update the dns type to use the DnsResolveIpMode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's in async fn tcp_connect_inner<State, Dns, Connector>( that you'll want to check for DnsResolveIpMode.

And it's in the location where we actually establish a tcp stream that you'll check for ConnectIpMode.

Originally I was thinking to also automatically let one influence the other, but I think it makes more sense to just let the user worry about that. E.g. if user selects Ipv6-only for DNS and ipv4-only for Connect, then that obviously will fail, but that is up to the user to then fix. No point in trying to do anything about that, as the only reasonable thing to do would be to return some kind of error, so let's not bother with that as the current error will already be fine enough.

@GlenDC
Copy link
Member

GlenDC commented Dec 10, 2024

Hi @AnkurRathore , not that it's a blocker or urgent. But given this is already a month stale. I do want to at least check in.

  • Are you stuck?
  • Need guidance, mentoring, or help of any kind?
  • Or did you move one and want to hand this over to someone else?

EIther and everything is fine. And hope you're in good health and condition. Take care!

@AnkurRathore
Copy link
Author

Hi @GlenDC ,
Apologies for the delay and thank you for checking in. I truly appreciate your patience.
There are two main reasons for the delay:

  1. I’ve been dealing with some personal matters, which took up most of my time. I’m now getting back on track and regaining focus.
  2. When I started reviewing the Rust codebase, I felt a bit overwhelmed and struggled with some of the language intricacies. To address this, I’ve been dedicating time to deepening my understanding of Rust.

I would still love to work on this, but I want to ensure I’m not impacting the release schedule. If you need this prioritized or handed over, I completely understand.
Thank you again for your understanding and support. I hope this clarifies my situation. Please let me know how you’d like me to proceed.

@GlenDC
Copy link
Member

GlenDC commented Dec 18, 2024

Understood. Do take care. For now I'll leave it with you then. It's not blocking any release schedule, as I still have plenty of other and much bigger fish to fry.

Should it still be left open in some weeks, I might re-assign it in case nothing changed by than. Either way good though, this is all voluntary. If you do feel ready by than to continue work on it, also good, I'll gladly support you with that. But otherwise also ok. Take care either way!

@AnkurRathore
Copy link
Author

@GlenDC please review the latest changes. Let me know if I am on the correct path.

ipv4_sem,
));
match dns.mode {
DnsResolveIpMode::SingleIpV4 | DnsResolveIpMode::DualPreferIpV4 | DnsResovleIpMode::Dual =>{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You probably want to provide utility methods to DnsResolveIpMode, such as:

fn ipv4_supported(&self) -> bool;
fn ipv6_supported(&self) -> bool;

Is same-same, but easier to have to update such statements only in a single loc.

let ip_it = match ip_kind {
IpKind::Ipv4 => match dns.ipv4_lookup(domain).await {
IpKind::Ipv4 if matches!(dns.mode, DnsResolveIpMode::Dual |DnsResolveIpMode::SingleIpV4 |DnsResolveIpMode::DualPreferIpV4 ) =>{
Copy link
Member

@GlenDC GlenDC Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to do:

match ip_kind => {
     IpKind::Ipv4 => if dns.mode.ipv4_supported() {
           // ... logic
     } else {
          trace::debug ipv4 not supported by DnsMode: no connection can be established
     }

     IpKind::Ipv6 => if dns.mode.ipv6_supported() {
           // ... logic
     } else {
          trace::debug ipv6 not supported by DnsMode: no connection can be established
     }

This way we have a clear trace in our logs / spans

@GlenDC
Copy link
Member

GlenDC commented Dec 26, 2024

@GlenDC please review the latest changes. Let me know if I am on the correct path.

Hi @AnkurRathore great to see you back in action!!! Hope you're doing alright.

Yes, direction-wise this looks good. The DnsMode btw not only is about which IP version is supported, but also which one is prefered. Dual mode is the current only mode, where Ipv6 is preferred, but in case the Ipv4Preferred option is chosen you need to make sure that it is ipv4 which is prefered instead of the now only way ipv6, by swapping the delays.

Other than that, this is shaping up nicely, thx a lot!

@AnkurRathore
Copy link
Author

@GlenDC I am doing good. Hope the same from your end.
I will go through the review comments.
Thanks.

@AnkurRathore
Copy link
Author

@GlenDC I have made the changes as per the comments. Please review them.

@@ -0,0 +1,43 @@
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
/// Enum representing the IP modes that can be used by the DNS resolver.
pub enum IPModes {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are 2 enums required:

enum DnsResolveIpMode
    dual (default)
    singleIpV4
    singleIpV6
    dualPreferIpv4

enum ConnectIpMode
    dual (default)
    ipv4
    ipv6

The struct DnsResolveIpMode can be removed as there should be no need to wrap the resolver, this would be bad for ergonomics and doesn't really solve anything.

The difference between the 2 enums is that:

  • ConnectIpMode is used only for establishing a connection
  • DnsResolveIpMode is used only for resolving a domain
  • these two are separate and do not influence each other.
  • if they are not present in the Context<S> of the incoming request we would resort to the default
  • DnsResolveIpMode has one more variant as there we also need to choose which one we are biased against, Ipv4 or Ipv6, where the latter is the default to help progress the adoption of ipv6.

Sorry for not catching this earlier. Seens I missed it in my initial scans of your code.

Do let me know here or on Discord if something is not clear in that set of requirements.

@@ -19,4 +19,4 @@

pub mod client;
pub mod server;
pub mod utils;
pub mod utils;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You removed a whiteline here

@GlenDC
Copy link
Member

GlenDC commented Dec 27, 2024

@GlenDC I have made the changes as per the comments. Please review them.

Added the requested review, some comments that already existed are still unresolved as well. Do let me know if you have more questions, need more guidance or anything else. Here, in the original github ticket (#331) or on Discord.

@AnkurRathore
Copy link
Author

@GlenDC addressed the required changes in enum. Please review

@GlenDC
Copy link
Member

GlenDC commented Dec 28, 2024

@GlenDC addressed the required changes in enum. Please review

Those changes look excellent. Do you need guidance for the remaining TODOs:

  • respect ip version preference when resolving dns
  • respect ipConnectMode when establishing a transport connection

@AnkurRathore
Copy link
Author

@GlenDC addressed the required changes in enum. Please review

Those changes look excellent. Do you need guidance for the remaining TODOs:

  • respect ip version preference when resolving dns
  • respect ipConnectMode when establishing a transport connection

@GlenDC need your guidance on the remaining TODOs. Can you elaborate more on this.

@GlenDC
Copy link
Member

GlenDC commented Dec 30, 2024

@GlenDC need your guidance on the remaining TODOs. Can you elaborate more on this.

Sure thing

  1. respect ip version preference when resolving dns

These sleep intervals would need to be swapped in case Ipv4 is prefered over ipv6

IpKind::Ipv4 => Duration::from_micros((21 * 2 * index) as u64),
IpKind::Ipv6 => Duration::from_micros((15 * 2 * index) as u64),

  1. respect ipConnectMode when establishing a transport connection

In these locations you would need to block connections with an error in case of an Ipv4 address but ipv4 not allowed, and same for ipv6:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants