Update rkyv and add strict feature for safer transport (#50)

Author: ChillFish8

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datacake"
-version = "0.7.0"
+version = "0.7.1"
 edition = "2021"
 description = "A batteries included framework for building fault-tolerance distributed data systems."
 license = "MIT"

datacake-crdt/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datacake-crdt"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2021"
 description = "A conflict free replicated datatype based on a hybrid logical clock implementation for building eventually consistent data stores."
 license = "MIT"
@@ -14,9 +14,8 @@ readme = "README.md"
 [dependencies]
 thiserror = "1.0.33"
 
-bytecheck = { version = "0.6.9", optional = true }
-rkyv = { version = "0.7.39", features = ["validation"], optional = true }
+rkyv = { version = "0.7.42", features = ["validation"], optional = true }
 
 [features]
 # Enables (de)serialization support for all data types.
-rkyv-support = ["rkyv", "bytecheck"]
+rkyv-support = ["rkyv"]

datacake-crdt/src/orswot.rs

@@ -4,8 +4,6 @@ use std::fmt::Debug;
 use std::time::Duration;
 use std::{cmp, mem};
 
-#[cfg(feature = "rkyv-support")]
-use bytecheck::CheckBytes;
 #[cfg(feature = "rkyv-support")]
 use rkyv::{Archive, Deserialize, Serialize};
 
@@ -26,17 +24,16 @@ pub const FORGIVENESS_PERIOD: Duration = if cfg!(test) {
     Duration::from_secs(3_600)
 };
 
-#[cfg(feature = "rkyv-support")]
+#[cfg(feature = "rkyv")]
 #[derive(Debug, thiserror::Error)]
 #[error("The set cannot be (de)serialized from the provided set of bytes.")]
 /// The set cannot be (de)serialized to or from the byte buffer.
 pub struct BadState;
 
 #[derive(Debug, Clone)]
 #[repr(C)]
-#[cfg_attr(feature = "rkyv-support", derive(Serialize, Deserialize, Archive))]
-#[cfg_attr(feature = "rkyv-support", archive(compare(PartialEq)))]
-#[cfg_attr(feature = "rkyv-support", archive_attr(derive(CheckBytes)))]
+#[cfg_attr(feature = "rkyv", derive(Serialize, Deserialize, Archive))]
+#[cfg_attr(feature = "rkyv", archive(compare(PartialEq), check_bytes))]
 pub struct NodeVersions<const N: usize> {
     nodes_max_stamps: [BTreeMap<u8, HLCTimestamp>; N],
     safe_last_stamps: BTreeMap<u8, HLCTimestamp>,
@@ -140,8 +137,7 @@ impl<const N: usize> NodeVersions<N> {
 #[derive(Debug, Default, Clone)]
 #[repr(C)]
 #[cfg_attr(feature = "rkyv", derive(Serialize, Deserialize, Archive))]
-#[cfg_attr(feature = "rkyv", archive(compare(PartialEq)))]
-#[cfg_attr(feature = "rkyv", archive_attr(derive(CheckBytes)))]
+#[cfg_attr(feature = "rkyv", archive(compare(PartialEq), check_bytes))]
 /// A CRDT which supports purging of deleted entry tombstones.
 ///
 /// This implementation is largely based on the Riak DB implementations

datacake-crdt/src/timestamp.rs

@@ -3,8 +3,6 @@ use std::fmt::{Display, Formatter};
 use std::str::FromStr;
 use std::time::{Duration, SystemTime, UNIX_EPOCH};
 
-#[cfg(feature = "rkyv-support")]
-use bytecheck::CheckBytes;
 #[cfg(feature = "rkyv-support")]
 use rkyv::{Archive, Deserialize, Serialize};
 
@@ -19,12 +17,9 @@ pub const DATACAKE_EPOCH: Duration = Duration::from_secs(1672534861);
 
 #[derive(Debug, Hash, Copy, Clone, Eq, PartialEq, PartialOrd, Ord)]
 #[repr(C)]
-#[cfg_attr(feature = "rkyv-support", derive(Serialize, Deserialize, Archive))]
-#[cfg_attr(feature = "rkyv-support", archive(compare(PartialEq)))]
-#[cfg_attr(
-    feature = "rkyv-support",
-    archive_attr(repr(C), derive(CheckBytes, Debug))
-)]
+#[cfg_attr(feature = "rkyv", derive(Serialize, Deserialize, Archive))]
+#[cfg_attr(feature = "rkyv", archive(compare(PartialEq), check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(C), derive(Debug)))]
 /// A HLC (Hybrid Logical Clock) timestamp implementation.
 ///
 /// This implementation is largely a port of the JavaScript implementation

datacake-eventual-consistency/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datacake-eventual-consistency"
-version = "0.5.0"
+version = "0.5.1"
 edition = "2021"
 description = "Eventually consistent state replication as a library (consensus, RPC and conflict resolution) for building your own eventually consistent databases."
 license = "MIT"
@@ -25,13 +25,12 @@ crossbeam-utils = "0.8.14"
 async-trait = "0.1.58"
 anyhow = "1"
 rand = "0.8.5"
-bytecheck = "0.6.9"
 puppet = "0.4.0"
 smallvec = "1"
 
 chitchat = { version = "0.5.1", package  = "datacake-chitchat-fork" }
 tokio = { version = "1", default-features = false, features = ["sync", "time"] }
-rkyv = { version = "0.7.9", features = ["validation", "smallvec"] }
+rkyv = { version = "0.7.42", features = ["strict", "validation", "smallvec"] }
 
 datacake-rpc = { path = "../datacake-rpc", version = "0.5" }
 datacake-node = { path = "../datacake-node", version = "0.4" }

datacake-eventual-consistency/src/core.rs

@@ -2,7 +2,6 @@ use std::fmt::{Debug, Formatter};
 use std::hash::{Hash, Hasher};
 use std::sync::Arc;
 
-use bytecheck::CheckBytes;
 use datacake_crdt::{HLCTimestamp, Key};
 use rkyv::with::CopyOptimize;
 use rkyv::{Archive, Deserialize, Serialize};
@@ -12,7 +11,8 @@ pub(crate) type DocVec<T> = SmallVec<[T; 4]>;
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Copy, Clone, Debug, PartialEq)]
-#[archive_attr(repr(C), derive(CheckBytes))]
+#[archive(check_bytes)]
+#[archive_attr(repr(C))]
 /// The metadata attached to each document.
 pub struct DocumentMetadata {
     /// The unique id of the document.
@@ -32,7 +32,8 @@ impl DocumentMetadata {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Clone)]
-#[archive_attr(repr(C), derive(CheckBytes))]
+#[archive(check_bytes)]
+#[archive_attr(repr(C))]
 /// A single document managed by the store.
 pub struct Document {
     /// The metadata associated with the document.
@@ -105,7 +106,8 @@ impl Debug for Document {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, PartialEq, Clone)]
-#[archive_attr(repr(C), derive(CheckBytes))]
+#[archive(check_bytes)]
+#[archive_attr(repr(C))]
 /// A new type wrapper around a `Vec<u8>` to implement the
 /// [CopyOptimize] optimisations from [rkyv].
 pub struct Bytes {

datacake-eventual-consistency/src/keyspace/group.rs

@@ -5,7 +5,6 @@ use std::ops::{Deref, DerefMut};
 use std::sync::Arc;
 use std::time::{Duration, Instant};
 
-use bytecheck::CheckBytes;
 use crossbeam_utils::atomic::AtomicCell;
 use datacake_crdt::{HLCTimestamp, Key, OrSWotSet};
 use datacake_node::Clock;
@@ -261,7 +260,7 @@ where
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct KeyspaceInfo {
     pub timestamp: HLCTimestamp,
     pub keyspace_timestamps: BTreeMap<String, HLCTimestamp>,

datacake-eventual-consistency/src/rpc/services/consistency_impl.rs

@@ -1,7 +1,6 @@
 use std::marker::PhantomData;
 use std::net::SocketAddr;
 
-use bytecheck::CheckBytes;
 use datacake_crdt::HLCTimestamp;
 use datacake_node::{NodeId, RpcNetwork};
 use datacake_rpc::{Handler, Request, RpcService, ServiceRegistry, Status};
@@ -228,7 +227,7 @@ where
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct PutPayload {
     pub keyspace: String,
     pub ctx: Option<Context>,
@@ -238,7 +237,7 @@ pub struct PutPayload {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Debug)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct MultiPutPayload {
     pub keyspace: String,
     pub ctx: Option<Context>,
@@ -248,7 +247,7 @@ pub struct MultiPutPayload {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Debug)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct RemovePayload {
     pub keyspace: String,
     pub document: DocumentMetadata,
@@ -257,7 +256,7 @@ pub struct RemovePayload {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Debug)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct MultiRemovePayload {
     pub keyspace: String,
     pub documents: DocVec<DocumentMetadata>,
@@ -266,7 +265,7 @@ pub struct MultiRemovePayload {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Debug)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct BatchPayload {
     pub timestamp: HLCTimestamp,
     pub modified: DocVec<MultiPutPayload>,
@@ -275,7 +274,7 @@ pub struct BatchPayload {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive, Debug)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct Context {
     pub node_id: NodeId,
     pub node_addr: SocketAddr,

datacake-eventual-consistency/src/rpc/services/replication_impl.rs

@@ -1,4 +1,3 @@
-use bytecheck::CheckBytes;
 use datacake_crdt::{HLCTimestamp, Key};
 use datacake_rpc::{Handler, Request, RpcService, ServiceRegistry, Status};
 use rkyv::{Archive, Deserialize, Serialize};
@@ -127,20 +126,20 @@ where
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct PollKeyspace(pub HLCTimestamp);
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct GetState {
     pub keyspace: String,
     pub timestamp: HLCTimestamp,
 }
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct KeyspaceOrSwotSet {
     pub timestamp: HLCTimestamp,
     pub last_updated: HLCTimestamp,
@@ -150,7 +149,7 @@ pub struct KeyspaceOrSwotSet {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct FetchDocs {
     pub keyspace: String,
     #[with(rkyv::with::CopyOptimize)]
@@ -160,7 +159,7 @@ pub struct FetchDocs {
 
 #[repr(C)]
 #[derive(Serialize, Deserialize, Archive)]
-#[archive_attr(derive(CheckBytes))]
+#[archive(check_bytes)]
 pub struct FetchedDocs {
     pub documents: Vec<Document>,
     pub timestamp: HLCTimestamp,

datacake-node/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datacake-node"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2021"
 description = "The core cluster membership system built ontop of Quickwit's chitchat."
 license = "MIT"
@@ -22,14 +22,13 @@ parking_lot = "0.12.1"
 rand = "0.8.5"
 futures = "0.3"
 crc32fast = "1.3.2"
-bytecheck = "0.6.9"
 smallvec = "1"
 
 datacake-rpc = { version = "0.5", path = "../datacake-rpc" }
 datacake-crdt = { version = "0.4", path = "../datacake-crdt", features = ["rkyv-support"] }
 chitchat = { version = "0.5.1", package  = "datacake-chitchat-fork" }
 tokio = { version = "1", default-features = false, features = ["sync", "time"] }
-rkyv = { version = "0.7.39", features = ["validation"] }
+rkyv = { version = "0.7.42", features = ["strict", "validation"] }
 
 [dev-dependencies]
 tracing-subscriber = "0.3.16"