Improve Debug output for common new types

restatedev · Jan 29, 2025 · 6ed8dae · 6ed8dae
1 parent 4761e69
commit 6ed8dae
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 10 deletions.
diff --git a/crates/types/src/identifiers.rs b/crates/types/src/identifiers.rs
@@ -35,7 +35,6 @@ use crate::time::MillisSinceEpoch;
 
 /// Identifying the leader epoch of a partition processor
 #[derive(
-    Debug,
     PartialEq,
     Eq,
     Ord,
@@ -46,10 +45,12 @@ use crate::time::MillisSinceEpoch;
     derive_more::From,
     derive_more::Into,
     derive_more::Display,
+    derive_more::Debug,
     serde::Serialize,
     serde::Deserialize,
 )]
 #[display("e{}", _0)]
+#[debug("e{}", _0)]
 pub struct LeaderEpoch(u64);
 impl LeaderEpoch {
     pub const INITIAL: Self = Self(1);
@@ -82,7 +83,6 @@ impl From<LeaderEpoch> for crate::protobuf::common::LeaderEpoch {
 #[derive(
     Copy,
     Clone,
-    Debug,
     PartialEq,
     Eq,
     Hash,
@@ -93,12 +93,14 @@ impl From<LeaderEpoch> for crate::protobuf::common::LeaderEpoch {
     derive_more::Into,
     derive_more::Add,
     derive_more::Display,
+    derive_more::Debug,
     derive_more::FromStr,
     serde::Serialize,
     serde::Deserialize,
 )]
 #[repr(transparent)]
 #[serde(transparent)]
+#[debug("{}", _0)]
 pub struct PartitionId(u16);
 
 impl From<PartitionId> for u32 {

diff --git a/crates/types/src/logs/metadata.rs b/crates/types/src/logs/metadata.rs
@@ -37,16 +37,17 @@ use crate::{flexbuffers_storage_encode_decode, Version, Versioned};
     PartialEq,
     Ord,
     PartialOrd,
-    Debug,
     Hash,
     Serialize,
     Deserialize,
     derive_more::From,
     derive_more::Into,
     derive_more::Display,
+    derive_more::Debug,
 )]
 #[repr(transparent)]
 #[serde(transparent)]
+#[debug("{}", _0)]
 pub struct SegmentIndex(pub(crate) u32);
 
 impl SegmentIndex {
@@ -218,11 +219,12 @@ pub struct LogsConfiguration {
     pub default_provider: ProviderConfiguration,
 }
 
-#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+#[derive(derive_more::Debug, Clone, serde::Serialize, serde::Deserialize)]
 #[serde(try_from = "LogsSerde", into = "LogsSerde")]
 pub struct Logs {
     pub(super) version: Version,
     pub(super) logs: HashMap<LogId, Chain>,
+    #[debug(skip)]
     pub(super) lookup_index: LookupIndex,
     pub(super) config: LogsConfiguration,
 }

diff --git a/crates/types/src/logs/mod.rs b/crates/types/src/logs/mod.rs
@@ -29,20 +29,21 @@ pub use record_cache::RecordCache;
 pub use tail::*;
 
 #[derive(
-    Debug,
     Clone,
     Copy,
     Eq,
     PartialEq,
     Hash,
     Ord,
     PartialOrd,
+    derive_more::Debug,
     derive_more::Display,
     derive_more::From,
     derive_more::Into,
     Serialize,
     Deserialize,
 )]
+#[debug("{}", _0)]
 pub struct LogId(u32);
 
 impl LogId {

diff --git a/crates/types/src/node_id.rs b/crates/types/src/node_id.rs
@@ -20,14 +20,14 @@ use bytes::{Buf, BufMut, BytesMut};
 /// must be also generational and the generations must match. If you are only interested in
 /// checking the id part, then compare using `x.id() == y.id()` instead of `x == y`.
 #[derive(
-    Debug,
     PartialEq,
     Eq,
     Clone,
     Copy,
     Hash,
     derive_more::From,
     derive_more::Display,
+    derive_more::Debug,
     derive_more::IsVariant,
     serde::Serialize,
     serde::Deserialize,
@@ -38,7 +38,6 @@ pub enum NodeId {
 }
 
 #[derive(
-    Debug,
     PartialEq,
     Eq,
     PartialOrd,
@@ -48,10 +47,12 @@ pub enum NodeId {
     Hash,
     derive_more::From,
     derive_more::Display,
+    derive_more::Debug,
     serde::Serialize,
     serde::Deserialize,
 )]
 #[display("{}:{}", _0, _1)]
+#[debug("{}:{}", _0, _1)]
 pub struct GenerationalNodeId(PlainNodeId, u32);
 
 #[derive(Debug, thiserror::Error)]
@@ -120,7 +121,6 @@ impl From<u64> for GenerationalNodeId {
 }
 
 #[derive(
-    Debug,
     Default,
     PartialEq,
     Eq,
@@ -132,12 +132,14 @@ impl From<u64> for GenerationalNodeId {
     derive_more::From,
     derive_more::Into,
     derive_more::Display,
+    derive_more::Debug,
     serde::Serialize,
     serde::Deserialize,
 )]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(feature = "schemars", schemars(transparent))]
 #[display("N{}", _0)]
+#[debug("N{}", _0)]
 pub struct PlainNodeId(u32);
 
 impl FromStr for PlainNodeId {

diff --git a/crates/types/src/replication/replication_property.rs b/crates/types/src/replication/replication_property.rs
@@ -34,7 +34,7 @@ static REPLICATION_PROPERTY_EXTRACTOR: LazyLock<Regex> = LazyLock::new(|| {
 pub struct ReplicationPropertyError(String);
 
 /// The replication policy for appends
-#[derive(serde::Serialize, serde::Deserialize, Debug, Clone, Eq, PartialEq)]
+#[derive(serde::Serialize, serde::Deserialize, Clone, Eq, PartialEq)]
 pub struct ReplicationProperty(BTreeMap<LocationScope, u8>);
 
 impl ReplicationProperty {
@@ -151,6 +151,12 @@ impl ReplicationProperty {
     }
 }
 
+impl std::fmt::Debug for ReplicationProperty {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self)
+    }
+}
+
 impl Display for ReplicationProperty {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         write!(f, "{{")?;

diff --git a/crates/types/src/version.rs b/crates/types/src/version.rs
@@ -10,7 +10,6 @@
 
 /// A type used for versioned metadata.
 #[derive(
-    Debug,
     Clone,
     Copy,
     PartialEq,
@@ -20,11 +19,13 @@
     derive_more::Display,
     derive_more::From,
     derive_more::Into,
+    derive_more::Debug,
     derive_more::AddAssign,
     serde::Serialize,
     serde::Deserialize,
 )]
 #[display("v{}", _0)]
+#[debug("v{}", _0)]
 pub struct Version(u32);
 
 impl Version {