refactor: switch from ciborium to minicbor-serde

TODO: check compatibility between the two
yral-dapp · Nov 29, 2024 · d5c6035 · d5c6035
1 parent 97003fc
commit d5c6035
Show file tree

Hide file tree

Showing 17 changed files with 62 additions and 52 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,7 +13,7 @@ members = [
 
 [workspace.dependencies]
 candid = "0.10.2"
-ciborium = "0.2.1"
+minicbor-serde = { version = "0.3.2", features = ["std"] }
 pocket-ic = "6.0.0"
 ic-cdk = "0.15.1"
 ic-cdk-timers = "0.7.0"

diff --git a/src/canister/individual_user_template/Cargo.toml b/src/canister/individual_user_template/Cargo.toml
@@ -10,7 +10,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 candid = { workspace = true }
-ciborium = { workspace = true }
+minicbor-serde = { workspace = true }
 ic-stable-structures = { workspace = true }
 ic-cdk = { workspace = true }
 ic-cdk-timers = { workspace = true }

diff --git a/src/canister/individual_user_template/src/api/canister_lifecycle/post_upgrade.rs b/src/canister/individual_user_template/src/api/canister_lifecycle/post_upgrade.rs
@@ -1,4 +1,3 @@
-use ciborium::de;
 use ic_cdk::api::call::ArgDecoderConfig;
 use ic_cdk_macros::post_upgrade;
 use ic_stable_structures::Memory;
@@ -31,7 +30,7 @@ fn restore_data_from_stable_memory() {
     heap_data.read(4, &mut canister_data_bytes);
 
     let canister_data =
-        de::from_reader(&*canister_data_bytes).expect("Failed to deserialize heap data");
+        minicbor_serde::from_slice(&canister_data_bytes).expect("Failed to deserialize heap data");
     CANISTER_DATA.with(|canister_data_ref_cell| {
         *canister_data_ref_cell.borrow_mut() = canister_data;
     });

diff --git a/src/canister/individual_user_template/src/api/canister_lifecycle/pre_upgrade.rs b/src/canister/individual_user_template/src/api/canister_lifecycle/pre_upgrade.rs
@@ -1,4 +1,3 @@
-use ciborium::ser;
 use ic_cdk::api::stable;
 use ic_cdk_macros::pre_upgrade;
 use ic_stable_structures::writer::Writer;
@@ -9,9 +8,8 @@ use crate::CANISTER_DATA;
 
 #[pre_upgrade]
 fn pre_upgrade() {
-    let mut state_bytes = vec![];
-    CANISTER_DATA.with(|canister_data_ref_cell| {
-        ser::into_writer(&*canister_data_ref_cell.borrow(), &mut state_bytes)
+    let state_bytes = CANISTER_DATA.with(|canister_data_ref_cell| {
+        minicbor_serde::to_vec(&*canister_data_ref_cell.borrow())
     })
     .expect("failed to encode state");
 

diff --git a/src/canister/individual_user_template/src/data_model/kv_storage.rs b/src/canister/individual_user_template/src/data_model/kv_storage.rs
@@ -37,13 +37,12 @@ impl From<Namespace> for NamespaceForFrontend {
 
 impl Storable for Namespace {
     fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
-        let mut bytes = vec![];
-        ciborium::ser::into_writer(self, &mut bytes).unwrap();
+        let bytes = minicbor_serde::to_vec(self).unwrap();
         Cow::Owned(bytes)
     }
 
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
-        let namespace: Self = ciborium::de::from_reader(bytes.as_ref()).unwrap();
+        let namespace: Self = minicbor_serde::from_slice(bytes.as_ref()).unwrap();
         namespace
     }
 
@@ -188,13 +187,12 @@ pub struct NameSpaceKey {
 
 impl Storable for NameSpaceKey {
     fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
-        let mut bytes = vec![];
-        ciborium::ser::into_writer(self, &mut bytes).unwrap();
+        let bytes = minicbor_serde::to_vec(self).unwrap();
         Cow::Owned(bytes)
     }
 
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
-        let namespace: Self = ciborium::de::from_reader(bytes.as_ref()).unwrap();
+        let namespace: Self = minicbor_serde::from_slice(bytes.as_ref()).unwrap();
         namespace
     }
 

diff --git a/src/canister/platform_orchestrator/Cargo.toml b/src/canister/platform_orchestrator/Cargo.toml
@@ -15,7 +15,7 @@ ic-cdk = { workspace = true }
 serde = { workspace = true }
 ic-cdk-macros = { workspace = true }
 ic-stable-structures = { workspace = true }
-ciborium = { workspace = true }
+minicbor-serde = { workspace = true }
 shared_utils = { workspace = true }
 
 [dev-dependencies]

diff --git a/src/canister/platform_orchestrator/src/api/canister_lifecycle/post_upgrade.rs b/src/canister/platform_orchestrator/src/api/canister_lifecycle/post_upgrade.rs
@@ -1,4 +1,3 @@
-use ciborium::de;
 use ic_cdk::api::call::ArgDecoderConfig;
 use ic_cdk_macros::post_upgrade;
 use ic_stable_structures::Memory;
@@ -25,7 +24,7 @@ fn restore_data_from_stable_memory() {
     let mut canister_data_bytes = vec![0; heap_data_len];
     heap_data.read(4, &mut canister_data_bytes);
     let canister_data =
-        de::from_reader(&*canister_data_bytes).expect("Failed to deserialize heap data");
+        minicbor_serde::from_slice(&canister_data_bytes).expect("Failed to deserialize heap data");
     CANISTER_DATA.with_borrow_mut(|cd| {
         *cd = canister_data;
     })

diff --git a/src/canister/platform_orchestrator/src/api/canister_lifecycle/pre_upgrade.rs b/src/canister/platform_orchestrator/src/api/canister_lifecycle/pre_upgrade.rs
@@ -1,15 +1,13 @@
 
 use ic_cdk_macros::pre_upgrade;
 use ic_stable_structures::writer::Writer;
-use ciborium::ser;
 use crate::{data_model::memory, CANISTER_DATA};
 
 
 #[pre_upgrade]
 fn pre_upgrade() {
-    let mut state_bytes = vec![];
-    CANISTER_DATA.with_borrow(|canister_data| 
-        ser::into_writer(&*canister_data, &mut state_bytes)
+    let state_bytes = CANISTER_DATA.with_borrow(|canister_data| 
+        minicbor_serde::to_vec(canister_data)
     )
     .expect("failed to encode state");
     let len = state_bytes.len() as u32;

diff --git a/src/canister/platform_orchestrator/src/data_model/mod.rs b/src/canister/platform_orchestrator/src/data_model/mod.rs
@@ -1,4 +1,3 @@
-use ciborium::de;
 use ic_stable_structures::{storable::Bound, StableBTreeMap, StableLog, Storable};
 use std::{
     borrow::Cow,
@@ -161,13 +160,12 @@ pub struct CanisterUpgradeStatus {
 
 impl Storable for CanisterUpgradeStatus {
     fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
-        let mut bytes = vec![];
-        ciborium::ser::into_writer(self, &mut bytes).unwrap();
+        let bytes = minicbor_serde::to_vec(self).unwrap();
         Cow::Owned(bytes)
     }
 
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
-        let canister_upgrade_log: CanisterUpgradeStatus = de::from_reader(bytes.as_ref()).unwrap();
+        let canister_upgrade_log: CanisterUpgradeStatus = minicbor_serde::from_slice(bytes.as_ref()).unwrap();
         canister_upgrade_log
     }
 

diff --git a/src/canister/user_index/Cargo.toml b/src/canister/user_index/Cargo.toml
@@ -17,7 +17,7 @@ shared_utils = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 ic-stable-structures = { workspace = true }
-ciborium = { workspace = true }
+minicbor-serde = { workspace = true }
 futures = { workspace = true }
 
 [dev-dependencies]

diff --git a/src/canister/user_index/src/api/canister_lifecycle/post_upgrade.rs b/src/canister/user_index/src/api/canister_lifecycle/post_upgrade.rs
@@ -1,5 +1,3 @@
-use ciborium::de;
-
 use ic_cdk::api::call::ArgDecoderConfig;
 use ic_cdk_macros::post_upgrade;
 use ic_stable_structures::Memory;
@@ -44,7 +42,7 @@ fn restore_data_from_stable_memory() {
     let mut canister_data_bytes = vec![0; heap_data_len];
     heap_data.read(4, &mut canister_data_bytes);
     let canister_data =
-        de::from_reader(&*canister_data_bytes).expect("Failed to deserialize heap data");
+        minicbor_serde::from_slice(&canister_data_bytes).expect("Failed to deserialize heap data");
     CANISTER_DATA.with_borrow_mut(|cd| {
         *cd = canister_data;
     })

diff --git a/src/canister/user_index/src/api/canister_lifecycle/pre_upgrade.rs b/src/canister/user_index/src/api/canister_lifecycle/pre_upgrade.rs
@@ -1,14 +1,12 @@
 use ic_cdk_macros::pre_upgrade;
 use ic_stable_structures::writer::Writer;
-use ciborium::ser;
 use crate::{data_model::memory, CANISTER_DATA};
 
 
 #[pre_upgrade]
 fn pre_upgrade() {
-    let mut state_bytes = vec![];
-    CANISTER_DATA.with_borrow(|canister_data| 
-        ser::into_writer(&*canister_data, &mut state_bytes)
+    let state_bytes = CANISTER_DATA.with_borrow(|canister_data| 
+        minicbor_serde::to_vec(canister_data)
     )
     .expect("failed to encode state");
     let len = state_bytes.len() as u32;

diff --git a/src/canister/user_index/src/api/canister_management/create_pool_of_available_canisters.rs b/src/canister/user_index/src/api/canister_management/create_pool_of_available_canisters.rs
@@ -47,7 +47,7 @@ pub async fn impl_create_pool_of_individual_user_available_canisters(version: St
         let version = version.clone();
         let individual_user_wasm = individual_user_wasm.clone();
         async move {
-            recharge_canister_for_installing_wasm(canister_id).await.map_err(|e| (canister_id, e))?;
+            recharge_canister_for_installing_wasm(canister_id).await.map_err(|e| (canister_id, format!("recharge error {e}")))?;
             install_canister_wasm(
                 canister_id,
                 None,
@@ -65,7 +65,7 @@ pub async fn impl_create_pool_of_individual_user_available_canisters(version: St
                 })
             }
             Err((canister_id, e)) => {
-                ic_cdk::println!("Failed to install wasm on canister: {:?}, error: {:?}", canister_id, e);
+                ic_cdk::println!("Failed to install wasm on canister: {}, error: {:?}", canister_id, e);
                 CANISTER_DATA.with_borrow_mut(|cdata| {
                     cdata.insert_backup_canister(canister_id);
                 })

diff --git a/src/lib/shared_utils/Cargo.toml b/src/lib/shared_utils/Cargo.toml
@@ -13,7 +13,7 @@ ic-stable-structures = { workspace = true }
 rmp-serde = { workspace = true }
 futures = { workspace = true }
 serde = { workspace = true }
-ciborium = { workspace = true }
+minicbor-serde = { workspace = true }
 serde_json_any_key = "2.0.0"
 serde_bytes = "0.11.14"
 icrc-ledger-types = { workspace = true }

diff --git a/src/lib/shared_utils/src/common/participant_crypto/mod.rs b/src/lib/shared_utils/src/common/participant_crypto/mod.rs
@@ -87,11 +87,8 @@ impl ProofOfAuthorityMsg {
     }
 
     pub fn serialize_cbor(&self) -> Vec<u8> {
-        let mut bytes = vec![];
-        ciborium::into_writer(self, &mut bytes)
-            .expect("PoaMessage should serialize succesfully");
-
-        bytes
+        minicbor_serde::to_vec(self)
+            .expect("PoaMessage should serialize succesfully")
     }
 }
 

diff --git a/src/lib/shared_utils/src/common/types/wasm.rs b/src/lib/shared_utils/src/common/types/wasm.rs
@@ -1,7 +1,6 @@
 use std::borrow::Cow;
 
 use candid::CandidType;
-use ciborium::de;
 use serde::{Deserialize, Serialize};
 use ic_stable_structures::{storable::Bound, Storable};
 
@@ -15,13 +14,12 @@ pub enum WasmType {
 
 impl Storable for WasmType {
     fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
-        let mut bytes = vec![];
-        ciborium::ser::into_writer(self, &mut bytes).unwrap();
+        let bytes = minicbor_serde::to_vec(self).unwrap();
         Cow::Owned(bytes)
     }
 
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
-        let wasm_type: WasmType = de::from_reader(bytes.as_ref()).unwrap();
+        let wasm_type: WasmType = minicbor_serde::from_slice(bytes.as_ref()).unwrap();
         wasm_type
     }
 
@@ -37,13 +35,12 @@ pub struct CanisterWasm {
 
 impl Storable for CanisterWasm {
     fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
-        let mut bytes = vec![];
-        ciborium::ser::into_writer(self, &mut bytes).unwrap();
+        let bytes = minicbor_serde::to_vec(self).unwrap();
         Cow::Owned(bytes)
     }
 
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
-        let canister_wasm: CanisterWasm = de::from_reader(bytes.as_ref()).unwrap();
+        let canister_wasm: CanisterWasm = minicbor_serde::from_slice(bytes.as_ref()).unwrap();
         canister_wasm
     }