refactor: hide tracing logs behind 'logging' feature (#728)

* refactor: hide tracing logs behind 'logging' feature

* fix: grammar err

Author: zxch3n

Cargo.lock

@@ -10,7 +10,7 @@ release = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-loro = { path = "../loro", features = ["counter"], package = "loro" }
+loro = { path = "../loro", features = ["counter", "logging"], package = "loro" }
 loro-without-counter = { git = "https://github.com/loro-dev/loro.git", rev = "90470658435ec4c62b5af59ebb82fe9e1f5aa761", package = "loro", default-features = false }
 loro-016 = { git = "https://github.com/loro-dev/loro.git", tag = "loro-crdt@0.16.7", package = "loro" }
 fxhash = { workspace = true }

crates/fuzz/Cargo.toml

@@ -14,7 +14,7 @@ use loro::{
 };
 use pretty_assertions::assert_eq;
 use rand::{rngs::StdRng, Rng, SeedableRng};
-use tracing::info_span;
+use tracing::{info, info_span};
 
 use crate::{
     container::{CounterActor, ListActor, MovableListActor, TextActor, TreeActor},
@@ -373,7 +373,7 @@ impl Actor {
             .loro
             .export_json_updates(&Default::default(), &self.loro.oplog_vv());
         let string = serde_json::to_string_pretty(&json).unwrap();
-        tracing::info!("vv={:?} json = {}", self.loro.oplog_vv(), string);
+        info!("vv={:?} json = {}", self.loro.oplog_vv(), string);
     }
 }
 

crates/fuzz/src/actor.rs

@@ -9,7 +9,6 @@ use loro::{
     event::Diff, Container, ContainerID, ContainerType, LoroDoc, LoroError, LoroTree, LoroValue,
     TreeExternalDiff, TreeID,
 };
-use tracing::trace;
 
 use crate::{
     actions::{Actionable, FromGenericAction, GenericAction},
@@ -399,7 +398,6 @@ impl TreeTracker {
     ) {
         let node = TreeNode::new(target, *parent, position);
         if let Some(parent) = parent {
-            trace!("Parent {:?} target {:?}", parent, target);
             let parent = self.find_node_by_id_mut(*parent).unwrap();
             parent.children.insert(*index, node);
         } else {
@@ -440,7 +438,6 @@ impl ApplyDiff for TreeTracker {
                     self.create_node(target, &parent.tree_id(), position.to_string(), index);
                 }
                 TreeExternalDiff::Delete { .. } => {
-                    trace!("To delete {:?}", &target);
                     let node = self.find_node_by_id(target).unwrap();
                     if let Some(parent) = node.parent {
                         let parent = self.find_node_by_id_mut(parent).unwrap();

crates/fuzz/src/container/tree.rs

@@ -10,7 +10,7 @@ use arbitrary::Arbitrary;
 use fxhash::FxHashSet;
 use loro::{ContainerType, Frontiers, ImportStatus, LoroError, LoroResult};
 use tabled::TableIteratorExt;
-use tracing::{info, info_span, trace};
+use tracing::{info, info_span};
 
 use crate::{actions::ActionWrapper, array_mut_ref};
 
@@ -409,11 +409,9 @@ pub fn test_multi_sites_with_gc(
                 match (i + j) % 4 {
                     0 => {
                         info_span!("Updates", from = j, to = i).in_scope(|| {
-                            trace!("a.vv = {:?}", a_doc.oplog_vv());
                             a_doc.import(&b_doc.export_from(&a_doc.oplog_vv())).unwrap();
                         });
                         info_span!("Updates", from = i, to = j).in_scope(|| {
-                            trace!("b.vv = {:?}", b_doc.oplog_vv());
                             b_doc.import(&a_doc.export_from(&b_doc.oplog_vv())).unwrap();
                         });
                     }
@@ -456,11 +454,9 @@ pub fn test_multi_sites_with_gc(
                     let a_doc = &mut a.loro;
                     let b_doc = &mut b.loro;
                     info_span!("Updates", from = j, to = i).in_scope(|| {
-                        trace!("a.vv = {:?}", a_doc.oplog_vv());
                         a_doc.import(&b_doc.export_from(&a_doc.oplog_vv())).unwrap();
                     });
                     info_span!("Updates", from = i, to = j).in_scope(|| {
-                        trace!("b.vv = {:?}", b_doc.oplog_vv());
                         b_doc.import(&a_doc.export_from(&b_doc.oplog_vv())).unwrap();
                     });
                 }
@@ -480,10 +476,6 @@ pub fn test_multi_sites_with_gc(
                     .import(&a.loro.export_from(&b.loro.oplog_vv()))
                     .unwrap();
             });
-            let json = b
-                .loro
-                .export_json_updates(&Default::default(), &b.loro.oplog_vv());
-            trace!("Changes on 1 = {:#?}", json);
             let result = info_span!("1 => 0")
                 .in_scope(|| a.loro.import(&b.loro.export_from(&a.loro.oplog_vv())));
             match result {

crates/fuzz/src/crdt_fuzzer.rs

@@ -1,6 +1,6 @@
 use loro::{ContainerType, Frontiers, LoroDoc, LoroError, TreeID};
 use tabled::TableIteratorExt;
-use tracing::{info, info_span, trace};
+use tracing::{info, info_span};
 
 use crate::{actions::ActionWrapper, crdt_fuzzer::FuzzValue, Action};
 
@@ -365,7 +365,6 @@ impl OneDocFuzzer {
                 }
             }
             Action::Sync { from, to } => {
-                trace!("vv={:?}", self.doc.oplog_vv());
                 let mut f = self.branches[*from as usize].frontiers.clone();
                 f.merge_with_greater(&self.branches[*to as usize].frontiers);
                 self.branches[*to as usize].frontiers = self.doc.minimize_frontiers(&f).unwrap();

crates/fuzz/src/one_doc_fuzzer.rs

@@ -16,7 +16,7 @@ keywords = ["crdt", "local-first"]
 [dependencies]
 rle = { path = "../rle", version = "1.2.7", package = "loro-rle" }
 serde = { workspace = true }
-serde_json = { workspace = true, optional=true }
+serde_json = { workspace = true, optional = true }
 thiserror = "1.0.43"
 wasm-bindgen = { version = "=0.2.100", optional = true }
 fxhash = "0.2.1"
@@ -26,7 +26,9 @@ js-sys = { version = "0.3.60", optional = true }
 serde_columnar = { workspace = true }
 nonmax = "0.5.5"
 leb128 = "0.2.5"
+tracing = { workspace = true, optional =  true}
 
 [features]
 wasm = ["wasm-bindgen", "js-sys"]
+logging = ["tracing"]
 counter = []

crates/loro-common/Cargo.toml

@@ -9,6 +9,7 @@ use serde::{Deserialize, Serialize};
 mod error;
 mod id;
 mod internal_string;
+mod logging;
 mod macros;
 mod span;
 mod value;
@@ -17,6 +18,7 @@ pub use error::{LoroEncodeError, LoroError, LoroResult, LoroTreeError};
 #[doc(hidden)]
 pub use fxhash::FxHashMap;
 pub use internal_string::InternalString;
+pub use logging::log::*;
 pub use span::*;
 pub use value::{
     to_value, LoroBinaryValue, LoroListValue, LoroMapValue, LoroStringValue, LoroValue,

crates/loro-common/src/lib.rs

@@ -0,0 +1,28 @@
+#[cfg(not(feature = "logging"))]
+pub mod log {
+    #[macro_export]
+    macro_rules! info {
+        ($($t:tt)*) => {};
+    }
+    #[macro_export]
+    macro_rules! trace {
+        ($($t:tt)*) => {};
+    }
+    #[macro_export]
+    macro_rules! debug {
+        ($($t:tt)*) => {};
+    }
+    #[macro_export]
+    macro_rules! error {
+        ($($t:tt)*) => {};
+    }
+    #[macro_export]
+    macro_rules! warn {
+        ($($t:tt)*) => {};
+    }
+}
+
+#[cfg(feature = "logging")]
+pub mod log {
+    pub use tracing::{debug, error, info, trace, warn};
+}

crates/loro-common/src/logging.rs

@@ -97,6 +97,7 @@ wasm = ["wasm-bindgen", "js-sys", "loro-common/wasm"]
 test_utils = ["arbitrary", "tabled"]
 # whether enable the counter container
 counter = ["loro-common/counter"]
+logging = ["loro-common/logging"]
 jsonpath = []
 
 [[bench]]