fix(cfg): make sure we use correct relays #2778

Arqu · 2024-10-02T20:29:32Z

Description

This takes us back to only relying on the env var for forcing staging relays. However for tests it should still remain active with the test/feature combo by default.

Breaking Changes

Notes & open questions

Change checklist

Self-review.
Documentation updates following the style guide, if relevant.
Tests if relevant.
All breaking changes documented.

github-actions · 2024-10-02T21:09:57Z

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: e0b63d5

flub · 2024-10-03T07:47:43Z

iroh-net/src/discovery/dns.rs

@@ -14,10 +14,14 @@ pub const N0_DNS_NODE_ORIGIN_PROD: &str = "dns.iroh.link";
 /// The n0 testing DNS node origin, for testing.
 pub const N0_DNS_NODE_ORIGIN_STAGING: &str = "staging-dns.iroh.link";
 /// Testing DNS node origin, must run server from [`crate::test_utils::DnsPkarrServer`].
-#[cfg(any(test, feature = "test-utils"))]
-#[cfg_attr(iroh_docsrs, doc(cfg(any(test, feature = "test-utils"))))]
+#[cfg(test)]


Please don't take away the cfg_attr on (public) items that have a cfg!

Suggested change

#[cfg(test)]

#[cfg(test)]

#[cfg_attr(iroh_docsrs, doc(cfg(test)))]

I know it's annoying you have to repeat the cfg inside the cfg_attr... Unfortunately that's the only way I could get this thing to work currently.

flub · 2024-10-03T07:49:45Z

iroh-net/src/discovery/dns.rs

 pub const TEST_DNS_NODE_ORIGIN: &str = "dns.iroh.test";

+/// Environment variable to force the use of staging relays.
+#[cfg(not(test))]
+#[cfg_attr(iroh_docsrs, doc(cfg(not(any(test, feature = "test-utils")))))]


The cfg needs to be repeated inside the cfg_attr. The cfg is what the compiler sees. And because things are still sad, we need to repeat this inside the cfg_attr for the docs to work:

Suggested change

#[cfg_attr(iroh_docsrs, doc(cfg(not(any(test, feature = "test-utils")))))]

#[cfg_attr(iroh_docsrs, doc(cfg(not(test)))]

flub · 2024-10-03T07:52:52Z

iroh-net/src/discovery/dns.rs

        {
-            Self::new(TEST_DNS_NODE_ORIGIN.to_string())
+            let force_staging_relays = match std::env::var(ENV_FORCE_STAGING_RELAYS) {
+                Ok(value) => value == "1",


Requiring a specific value here is a bit weird. UNIX has the custom of accepting any non-nil value for this kind of env var. Often people will use t, sometimes on.

Suggested change

Ok(value) => value == "1",

Ok(value) => !value.is_empty(),

flub · 2024-10-03T07:55:43Z

iroh-net/src/discovery/dns.rs

+            let force_staging_relays = match std::env::var(ENV_FORCE_STAGING_RELAYS) {
+                Ok(value) => value == "1",
+                Err(_) => false,
+            };
+            match force_staging_relays {
+                true => Self::new(N0_DNS_NODE_ORIGIN_STAGING.to_string()),
+                false => Self::new(N0_DNS_NODE_ORIGIN_PROD.to_string()),
+            }


Suggested change

let force_staging_relays = match std::env::var(ENV_FORCE_STAGING_RELAYS) {

Ok(value) => value == "1",

Err(_) => false,

};

match force_staging_relays {

true => Self::new(N0_DNS_NODE_ORIGIN_STAGING.to_string()),

false => Self::new(N0_DNS_NODE_ORIGIN_PROD.to_string()),

}

match std::env::var(ENV_FORCE_STAGING_RELAYS) {

Ok(value) if !value.is_empty() => Self::new(N0_DNS_NODE_ORIGIN_STAGING.to_string()),

_ => Self::new(N0_DNS_NODE_ORIGIN_PROD.to_string()),

}

flub · 2024-10-03T08:06:01Z

iroh-net/src/discovery/dns.rs

+/// Environment variable to force the use of staging relays.
+#[cfg(not(test))]
+#[cfg_attr(iroh_docsrs, doc(cfg(not(any(test, feature = "test-utils")))))]
+const ENV_FORCE_STAGING_RELAYS: &str = "IROH_FORCE_STAGING_RELAYS";


You're adding this to more than one file. Let's add it to src/relays.rs and make it pub so we can document this as well.

flub · 2024-10-03T08:08:53Z

iroh-net/src/discovery/pkarr.rs

@@ -321,9 +329,9 @@ impl PkarrResolver {
    ///
    /// [number 0]: https://n0.computer
    pub fn n0_dns() -> Self {
-        #[cfg(not(any(test, feature = "test-utils")))]
+        #[cfg(not(all(test, feature = "test-utils")))]


didn't @matheus23 say this doesn't work for something?

flub · 2024-10-03T08:09:52Z

iroh-net/src/endpoint.rs

@@ -58,8 +58,6 @@ pub use iroh_base::node_addr::{AddrInfo, NodeAddr};
 const DISCOVERY_WAIT_PERIOD: Duration = Duration::from_millis(500);

 /// Environment variable to force the use of staging relays.
-#[cfg(not(any(test, feature = "test-utils")))]
-#[cfg_attr(iroh_docsrs, doc(cfg(not(any(test, feature = "test-utils")))))]
 const ENV_FORCE_STAGING_RELAYS: &str = "IROH_FORCE_STAGING_RELAYS";


let's move this to one place as discussed.

flub · 2024-10-03T08:10:54Z

iroh-net/src/endpoint.rs

@@ -1247,14 +1245,10 @@ fn proxy_url_from_env() -> Option<Url> {
 /// Otherwise, it will return `RelayMode::Default`.
 pub fn default_relay_mode() -> RelayMode {
    // Use staging in testing
-    #[cfg(not(any(test, feature = "test-utils")))]
    let force_staging_relays = match std::env::var(ENV_FORCE_STAGING_RELAYS) {
        Ok(value) => value == "1",


should be any non-nil value. Maybe we can add a pub(crate) function to read this variable and also put it in src/relay.rs. Otherwise this behaviour gets to easily different between different call sites.

flub · 2024-10-03T08:11:48Z

iroh-net/src/endpoint.rs

@@ -1247,14 +1245,10 @@ fn proxy_url_from_env() -> Option<Url> {
 /// Otherwise, it will return `RelayMode::Default`.
 pub fn default_relay_mode() -> RelayMode {
    // Use staging in testing
-    #[cfg(not(any(test, feature = "test-utils")))]


this one does not have to stay at cfg(not(test))?

flub · 2024-10-03T08:21:01Z

iroh/src/node/builder.rs

@@ -231,9 +231,9 @@ fn mk_external_rpc() -> IrohServerEndpoint {
 impl Default for Builder<iroh_blobs::store::mem::Store> {
    fn default() -> Self {
        // Use staging in testing
-        #[cfg(not(any(test, feature = "test-utils")))]
+        #[cfg(not(all(test, feature = "test-utils")))]


This should probably be just cfg(not(test))? If someone is requesting test-utils they can still enable test themselves. Unless this breaks one of the benchmarks again...

fix(cfg): make sure we use correct relays

230546e

Arqu requested review from flub and dignifiedquire October 2, 2024 20:30

Arqu self-assigned this Oct 2, 2024

Arqu requested a review from matheus23 October 2, 2024 20:30

Arqu added 2 commits October 2, 2024 22:52

cleanup

3e154ff

cleanup

6a7cfcd

flub reviewed Oct 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(cfg): make sure we use correct relays #2778

fix(cfg): make sure we use correct relays #2778

Arqu commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

flub Oct 3, 2024 •

edited

Loading

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

flub Oct 3, 2024

	#[cfg(test)]
	#[cfg(test)]
	#[cfg_attr(iroh_docsrs, doc(cfg(test)))]

	#[cfg_attr(iroh_docsrs, doc(cfg(not(any(test, feature = "test-utils")))))]
	#[cfg_attr(iroh_docsrs, doc(cfg(not(test)))]

fix(cfg): make sure we use correct relays #2778

Are you sure you want to change the base?

fix(cfg): make sure we use correct relays #2778

Conversation

Arqu commented Oct 2, 2024

Description

Breaking Changes

Notes & open questions

Change checklist

github-actions bot commented Oct 2, 2024

flub Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flub Oct 3, 2024 •

edited

Loading