Replace uses of content_hash! with #[derive(ContentHash)]

This is a pure refactor with no behavior changes. #3054
jj-vcs · Feb 15, 2024 · 9e54a31 · 9e54a31
1 parent 8212866
commit 9e54a31
Show file tree

Hide file tree

Showing 5 changed files with 120 additions and 201 deletions.
diff --git a/lib/src/backend.rs b/lib/src/backend.rs
@@ -39,18 +39,14 @@ id_type!(pub FileId);
 id_type!(pub SymlinkId);
 id_type!(pub ConflictId);
 
-content_hash! {
-    #[derive(Debug, PartialEq, Eq, Clone, PartialOrd, Ord)]
-    pub struct MillisSinceEpoch(pub i64);
-}
-
-content_hash! {
-    #[derive(Debug, PartialEq, Eq, Clone, PartialOrd, Ord)]
-    pub struct Timestamp {
-        pub timestamp: MillisSinceEpoch,
-        // time zone offset in minutes
-        pub tz_offset: i32,
-    }
+#[derive(ContentHash, Debug, PartialEq, Eq, Clone, PartialOrd, Ord)]
+pub struct MillisSinceEpoch(pub i64);
+
+#[derive(ContentHash, Debug, PartialEq, Eq, Clone, PartialOrd, Ord)]
+pub struct Timestamp {
+    pub timestamp: MillisSinceEpoch,
+    // time zone offset in minutes
+    pub tz_offset: i32,
 }
 
 impl Timestamp {
@@ -68,21 +64,17 @@ impl Timestamp {
     }
 }
 
-content_hash! {
-    #[derive(Debug, PartialEq, Eq, Clone)]
-    pub struct Signature {
-        pub name: String,
-        pub email: String,
-        pub timestamp: Timestamp,
-    }
+#[derive(ContentHash, Debug, PartialEq, Eq, Clone)]
+pub struct Signature {
+    pub name: String,
+    pub email: String,
+    pub timestamp: Timestamp,
 }
 
-content_hash! {
-    #[derive(Debug, PartialEq, Eq, Clone)]
-    pub struct SecureSig {
-        pub data: Vec<u8>,
-        pub sig: Vec<u8>,
-    }
+#[derive(ContentHash, Debug, PartialEq, Eq, Clone)]
+pub struct SecureSig {
+    pub data: Vec<u8>,
+    pub sig: Vec<u8>,
 }
 
 pub type SigningFn<'a> = dyn FnMut(&[u8]) -> SignResult<Vec<u8>> + 'a;
@@ -140,37 +132,31 @@ impl MergedTreeId {
     }
 }
 
-content_hash! {
-    #[derive(Debug, PartialEq, Eq, Clone)]
-    pub struct Commit {
-        pub parents: Vec<CommitId>,
-        pub predecessors: Vec<CommitId>,
-        pub root_tree: MergedTreeId,
-        pub change_id: ChangeId,
-        pub description: String,
-        pub author: Signature,
-        pub committer: Signature,
-        pub secure_sig: Option<SecureSig>,
-    }
+#[derive(ContentHash, Debug, PartialEq, Eq, Clone)]
+pub struct Commit {
+    pub parents: Vec<CommitId>,
+    pub predecessors: Vec<CommitId>,
+    pub root_tree: MergedTreeId,
+    pub change_id: ChangeId,
+    pub description: String,
+    pub author: Signature,
+    pub committer: Signature,
+    pub secure_sig: Option<SecureSig>,
 }
 
-content_hash! {
-    #[derive(Debug, PartialEq, Eq, Clone)]
-    pub struct ConflictTerm {
-        pub value: TreeValue,
-    }
+#[derive(ContentHash, Debug, PartialEq, Eq, Clone)]
+pub struct ConflictTerm {
+    pub value: TreeValue,
 }
 
-content_hash! {
-    #[derive(Default, Debug, PartialEq, Eq, Clone)]
-    pub struct Conflict {
-        // A conflict is represented by a list of positive and negative states that need to be applied.
-        // In a simple 3-way merge of B and C with merge base A, the conflict will be { add: [B, C],
-        // remove: [A] }. Also note that a conflict of the form { add: [A], remove: [] } is the
-        // same as non-conflict A.
-        pub removes: Vec<ConflictTerm>,
-        pub adds: Vec<ConflictTerm>,
-    }
+#[derive(ContentHash, Default, Debug, PartialEq, Eq, Clone)]
+pub struct Conflict {
+    // A conflict is represented by a list of positive and negative states that need to be applied.
+    // In a simple 3-way merge of B and C with merge base A, the conflict will be { add: [B, C],
+    // remove: [A] }. Also note that a conflict of the form { add: [A], remove: [] } is the
+    // same as non-conflict A.
+    pub removes: Vec<ConflictTerm>,
+    pub adds: Vec<ConflictTerm>,
 }
 
 /// Error that may occur during backend initialization.
@@ -309,11 +295,9 @@ impl<'a> Iterator for TreeEntriesNonRecursiveIterator<'a> {
     }
 }
 
-content_hash! {
-    #[derive(Default, PartialEq, Eq, Debug, Clone)]
-    pub struct Tree {
-        entries: BTreeMap<RepoPathComponentBuf, TreeValue>,
-    }
+#[derive(ContentHash, Default, PartialEq, Eq, Debug, Clone)]
+pub struct Tree {
+    entries: BTreeMap<RepoPathComponentBuf, TreeValue>,
 }
 
 impl Tree {

diff --git a/lib/src/content_hash.rs b/lib/src/content_hash.rs
@@ -133,33 +133,6 @@ where
     }
 }
 
-macro_rules! content_hash {
-    ($(#[$meta:meta])* $vis:vis struct $name:ident {
-        $($(#[$field_meta:meta])* $field_vis:vis $field:ident : $ty:ty),* $(,)?
-    }) => {
-        $(#[$meta])*
-        $vis struct $name {
-            $($(#[$field_meta])* $field_vis $field : $ty),*
-        }
-
-        impl crate::content_hash::ContentHash for $name {
-            fn hash(&self, state: &mut impl digest::Update) {
-                $(<$ty as crate::content_hash::ContentHash>::hash(&self.$field, state);)*
-            }
-        }
-    };
-    ($(#[$meta:meta])* $vis:vis struct $name:ident($field_vis:vis $ty:ty);) => {
-        $(#[$meta])*
-        $vis struct $name($field_vis $ty);
-
-        impl crate::content_hash::ContentHash for $name {
-            fn hash(&self, state: &mut impl digest::Update) {
-                <$ty as crate::content_hash::ContentHash>::hash(&self.0, state);
-            }
-        }
-    };
-}
-
 #[cfg(test)]
 mod tests {
     use std::collections::{BTreeMap, HashMap};
@@ -203,8 +176,9 @@ mod tests {
 
     #[test]
     fn test_struct_sanity() {
-        content_hash! {
-            struct Foo { x: i32 }
+        #[derive(ContentHash)]
+        struct Foo {
+            x: i32,
         }
         assert_ne!(hash(&Foo { x: 42 }), hash(&Foo { x: 12 }));
     }
@@ -227,8 +201,10 @@ mod tests {
     fn test_consistent_hashing() {
         let expected_hash =
             "14e42ea3d680bc815d0cea8ac20d3e872120014fb7bba8d82c3ffa7a8e6d63c41ef9631c60b73b150e3dd72efe50e8b0248321fe2b7eea09d879f3757b879372";
-        content_hash! {
-            struct Foo { x: Vec<Option<i32>>, y: i64 }
+        #[derive(ContentHash)]
+        struct Foo {
+            x: Vec<Option<i32>>,
+            y: i64,
         }
         assert_eq!(
             hex::encode(hash(&Foo {
@@ -265,30 +241,6 @@ mod tests {
         assert_eq!(hash(&Option::<i32>::None), hash(&MyOption::<i32>::None));
         assert_eq!(hash(&Some(1)), hash(&MyOption::Some(1)));
     }
-    // This will be removed once all uses of content_hash! are replaced by the
-    // derive version.
-    #[test]
-    fn derive_is_equivalent_to_macro() {
-        content_hash! {
-            struct FooMacro { x: Vec<Option<i32>>, y: i64}
-        }
-
-        #[derive(ContentHash)]
-        struct FooDerive {
-            x: Vec<Option<i32>>,
-            y: i64,
-        }
-
-        let foo_macro = FooMacro {
-            x: vec![None, Some(42)],
-            y: 17,
-        };
-        let foo_derive = FooDerive {
-            x: vec![None, Some(42)],
-            y: 17,
-        };
-        assert_eq!(hash(&foo_macro), hash(&foo_derive));
-    }
 
     fn hash(x: &(impl ContentHash + ?Sized)) -> digest::Output<Blake2b512> {
         blake2b_hash(x)

diff --git a/lib/src/object_id.rs b/lib/src/object_id.rs
@@ -23,10 +23,8 @@ pub trait ObjectId {
 
 macro_rules! id_type {
     ($vis:vis $name:ident) => {
-        content_hash! {
-            #[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
-            $vis struct $name(Vec<u8>);
-        }
+        #[derive(ContentHash, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
+        $vis struct $name(Vec<u8>);
         $crate::object_id::impl_id_type!($name);
     };
 }