fixups

Author: matheus23

portmapper/src/lib.rs

@@ -9,9 +9,8 @@ use std::{
 use current_mapping::CurrentMapping;
 use futures_lite::StreamExt;
 use iroh_metrics::inc;
-use nested_enum_utils::common_fields;
 use netwatch::interfaces::HomeRouter;
-use snafu::{Backtrace, Snafu};
+use snafu::Snafu;
 use tokio::sync::{mpsc, oneshot, watch};
 use tokio_util::task::AbortOnDropHandle;
 use tracing::{debug, info_span, trace, Instrument};
@@ -68,24 +67,22 @@ impl ProbeOutput {
     }
 }
 
-#[common_fields({
-    backtrace: Option<Backtrace>,
-    #[snafu(implicit)]
-    span_trace: n0_snafu::SpanTrace,
-})]
+// Cannot have backtrace due to Clone bound
+// #[nested_enum_utils::common_fields({
+//     backtrace: Option<snafu::Backtrace>,
+// })]
 #[allow(missing_docs)]
 #[derive(Debug, Clone, Snafu)]
 #[non_exhaustive]
-#[snafu(visibility(pub(crate)))]
 pub enum ProbeError {
     #[snafu(display("Mapping channel is full"))]
-    ChannelFull {},
+    ChannelFull,
     #[snafu(display("Mapping channel is closed"))]
-    ChannelClosed {},
+    ChannelClosed,
     #[snafu(display("No gateway found for probe"))]
-    NoGateway {},
+    NoGateway,
     #[snafu(display("gateway found is ipv6, ignoring"))]
-    Ipv6Gateway {},
+    Ipv6Gateway,
     #[snafu(display("Probe task stopped. is_panic: {is_panic}, is_cancelled: {is_cancelled}"))]
     Join { is_panic: bool, is_cancelled: bool },
 }

portmapper/src/mapping.rs

@@ -27,13 +27,10 @@ pub enum Mapping {
 /// Mapping error.
 #[common_fields({
     backtrace: Option<Backtrace>,
-    #[snafu(implicit)]
-    span_trace: n0_snafu::SpanTrace,
 })]
 #[allow(missing_docs)]
 #[derive(Debug, Snafu)]
 #[non_exhaustive]
-#[snafu(visibility(pub(crate)))]
 pub enum Error {
     #[snafu(display("PCP mapping failed"))]
     Pcp { source: pcp::Error },

portmapper/src/nat_pmp.rs

@@ -2,6 +2,7 @@
 
 use std::{net::Ipv4Addr, num::NonZeroU16, time::Duration};
 
+use nested_enum_utils::common_fields;
 use netwatch::UdpSocket;
 use snafu::{Backtrace, Snafu};
 use tracing::{debug, trace};
@@ -32,23 +33,17 @@ pub struct Mapping {
     lifetime_seconds: u32,
 }
 
+#[common_fields({
+    backtrace: Option<Backtrace>
+})]
 #[allow(missing_docs)]
 #[derive(Debug, Snafu)]
 #[non_exhaustive]
-#[snafu(visibility(pub(crate)))]
 pub enum Error {
     #[snafu(display("server returned unexpected response for mapping request"))]
-    UnexpectedServerResponse {
-        backtrace: Option<Backtrace>,
-        #[snafu(implicit)]
-        span_trace: n0_snafu::SpanTrace,
-    },
+    UnexpectedServerResponse {},
     #[snafu(display("received 0 port from server as external port"))]
-    ZeroExternalPort {
-        backtrace: Option<Backtrace>,
-        #[snafu(implicit)]
-        span_trace: n0_snafu::SpanTrace,
-    },
+    ZeroExternalPort {},
     #[snafu(transparent)]
     Io { source: std::io::Error },
     #[snafu(transparent)]

portmapper/src/nat_pmp/protocol/response.rs

@@ -4,7 +4,7 @@ use std::net::Ipv4Addr;
 
 use nested_enum_utils::common_fields;
 use num_enum::{IntoPrimitive, TryFromPrimitive};
-use snafu::Snafu;
+use snafu::{Backtrace, Snafu};
 
 use super::{MapProtocol, Opcode, Version};
 
@@ -55,44 +55,41 @@ pub enum ResultCode {
 /// Errors that can occur when decoding a [`Response`] from a server.
 #[common_fields({
     backtrace: Option<Backtrace>,
-    #[snafu(implicit)]
-    span_trace: n0_snafu::SpanTrace,
 })]
 #[allow(missing_docs)]
-#[derive(Debug, Snafu, PartialEq, Eq)]
+#[derive(Debug, Snafu)]
 #[non_exhaustive]
-#[snafu(visibility(pub(crate)))]
 pub enum Error {
     /// Request is too short or is otherwise malformed.
     #[snafu(display("Response is malformed"))]
-    Malformed,
+    Malformed {},
     /// The [`Response::RESPONSE_INDICATOR`] is not present.
     #[snafu(display("Packet does not appear to be a response"))]
-    NotAResponse,
+    NotAResponse {},
     /// The received opcode is not recognized.
     #[snafu(display("Invalid Opcode received"))]
-    InvalidOpcode,
+    InvalidOpcode {},
     /// The received version is not recognized.
     #[snafu(display("Invalid version received"))]
-    InvalidVersion,
+    InvalidVersion {},
     /// The received result code is not recognized.
     #[snafu(display("Invalid result code received"))]
-    InvalidResultCode,
+    InvalidResultCode {},
     /// Received an error code indicating the server does not support the sent version.
     #[snafu(display("Server does not support the version"))]
-    UnsupportedVersion,
+    UnsupportedVersion {},
     /// Received an error code indicating the operation is supported but not authorized.
     #[snafu(display("Operation is supported but not authorized"))]
-    NotAuthorizedOrRefused,
+    NotAuthorizedOrRefused {},
     /// Received an error code indicating the server experienced a network failure
     #[snafu(display("Server experienced a network failure"))]
-    NetworkFailure,
+    NetworkFailure {},
     /// Received an error code indicating the server cannot create more mappings at this time.
     #[snafu(display("Server is out of resources"))]
-    OutOfResources,
+    OutOfResources {},
     /// Received an error code indicating the Opcode is not supported by the server.
     #[snafu(display("Server does not support this opcode"))]
-    UnsupportedOpcode,
+    UnsupportedOpcode {},
 }
 
 impl Response {
@@ -283,7 +280,7 @@ mod tests {
 
         let response = Response::random(Opcode::DetermineExternalAddress, &mut gen);
         let encoded = response.encode();
-        assert_eq!(Ok(response), Response::decode(&encoded));
+        assert_eq!(response, Response::decode(&encoded).unwrap());
     }
 
     #[test]
@@ -292,6 +289,6 @@ mod tests {
 
         let response = Response::random(Opcode::MapUdp, &mut rng);
         let encoded = response.encode();
-        assert_eq!(Ok(response), Response::decode(&encoded));
+        assert_eq!(response, Response::decode(&encoded).unwrap());
     }
 }

portmapper/src/pcp.rs

@@ -38,13 +38,10 @@ pub struct Mapping {
 
 #[common_fields({
     backtrace: Option<Backtrace>,
-    #[snafu(implicit)]
-    span_trace: n0_snafu::SpanTrace,
 })]
 #[allow(missing_docs)]
 #[derive(Debug, Snafu)]
 #[non_exhaustive]
-#[snafu(visibility(pub(crate)))]
 pub enum Error {
     #[snafu(display("received nonce does not match sent request"))]
     NonceMissmatch {},

portmapper/src/pcp/protocol/response.rs

@@ -126,11 +126,8 @@ pub struct Response {
 #[non_exhaustive]
 #[common_fields({
     backtrace: Option<Backtrace>,
-    #[snafu(implicit)]
-    span_trace: n0_snafu::SpanTrace,
 })]
 #[derive(Debug, Snafu)]
-#[snafu(visibility(pub(crate)))]
 pub enum DecodeError {
     /// Request is too short or is otherwise malformed.
     #[snafu(display("Response is malformed"))]
@@ -152,25 +149,7 @@ pub enum DecodeError {
     InvalidOpcodeData {},
 }
 
-impl PartialEq for DecodeError {
-    #[allow(clippy::match_like_matches_macro)]
-    fn eq(&self, other: &Self) -> bool {
-        match (self, other) {
-            (DecodeError::Malformed { .. }, DecodeError::Malformed { .. }) => true,
-            (DecodeError::NotAResponse { .. }, DecodeError::NotAResponse { .. }) => true,
-            (DecodeError::InvalidOpcode { .. }, DecodeError::InvalidOpcode { .. }) => true,
-            (DecodeError::InvalidVersion { .. }, DecodeError::InvalidVersion { .. }) => true,
-            (DecodeError::InvalidResultCode { .. }, DecodeError::InvalidResultCode { .. }) => true,
-            (DecodeError::InvalidOpcodeData { .. }, DecodeError::InvalidOpcodeData { .. }) => true,
-            _ => false,
-        }
-    }
-}
-
-impl Eq for DecodeError {}
-
-#[derive(Debug, Snafu, PartialEq, Eq)]
-#[snafu(visibility(pub(crate)))]
+#[derive(Debug, Snafu)]
 pub enum Error {
     #[snafu(transparent)]
     DecodeError { source: DecodeError },
@@ -299,7 +278,7 @@ mod tests {
 
         let response = Response::random(Opcode::Announce, &mut gen);
         let encoded = response.encode();
-        assert_eq!(Ok(response), Response::decode(&encoded));
+        assert_eq!(response, Response::decode(&encoded).unwrap());
     }
 
     #[test]
@@ -320,6 +299,6 @@ mod tests {
 
         let response = Response::random(Opcode::Map, &mut rng);
         let encoded = response.encode();
-        assert_eq!(Ok(response), Response::decode(&encoded));
+        assert_eq!(response, Response::decode(&encoded).unwrap());
     }
 }

portmapper/src/upnp.rs

@@ -39,13 +39,10 @@ pub struct Mapping {
 
 #[common_fields({
     backtrace: Option<Backtrace>,
-    #[snafu(implicit)]
-    span_trace: n0_snafu::SpanTrace,
 })]
 #[allow(missing_docs)]
 #[derive(Debug, Snafu)]
 #[non_exhaustive]
-#[snafu(visibility(pub(crate)))]
 pub enum Error {
     #[snafu(display("Zero external port"))]
     ZeroExternalPort {},