RUST-1992 Make serde an optional feature (#554)

Co-authored-by: Isabel Atkinson <isabelatkinson@gmail.com>

Author: abr-egn

.evergreen/run-fuzzer.sh

@@ -30,11 +30,12 @@ run_fuzzer() {
 }
 
 # Run existing targets
-run_fuzzer "deserialize"
+run_fuzzer "decode"
 run_fuzzer "raw_deserialize"
+run_fuzzer "raw_deserialize_utf8_lossy"
 run_fuzzer "iterate"
 
 # Run new security-focused targets
 run_fuzzer "type_markers"
 run_fuzzer "string_handling"
-run_fuzzer "serialization"
+run_fuzzer "encoding"

.evergreen/run-tests.sh

@@ -4,7 +4,9 @@ set -o errexit
 
 . ~/.cargo/env
 
-RUST_BACKTRACE=1 cargo test
+# Test with default features and excluding doctests (some of which require the 'serde' feature)
+RUST_BACKTRACE=1 cargo test --all-targets
+# Test with all features and including doctests
 RUST_BACKTRACE=1 cargo test --all-features
 
 cd serde-tests

Cargo.toml

@@ -47,6 +47,7 @@ serde_path_to_error = ["dep:serde_path_to_error"]
 # if enabled, include serde_with interop.
 # should be used in conjunction with chrono-0_4 or uuid-0_8.
 serde_with-3 = ["dep:serde_with"]
+serde = ["dep:serde"]
 
 [lib]
 name = "bson"
@@ -55,7 +56,7 @@ name = "bson"
 ahash = "0.8.0"
 chrono = { version = "0.4.15", features = ["std"], default-features = false, optional = true }
 rand = "0.9"
-serde = { version = "1.0", features = ["derive"] }
+serde = { version = "1.0", features = ["derive"], optional = true }
 serde_json = { version = "1.0", features = ["preserve_order"] }
 indexmap = "2.1.0"
 hex = "0.4.2"

examples/deserialize.rs

@@ -2,3 +2,4 @@
 target
 corpus
 artifacts
+Cargo.lock

examples/serialize.rs

@@ -10,6 +10,7 @@ cargo-fuzz = true
 
 [dependencies.bson]
 path = ".."
+features = ["serde"]
 
 [dependencies.libfuzzer-sys]
 version = "0.4.0"
@@ -24,8 +25,8 @@ version = "1.0"
 members = ["."]
 
 [[bin]]
-name = "deserialize"
-path = "fuzz_targets/deserialize.rs"
+name = "decode"
+path = "fuzz_targets/decode.rs"
 
 [[bin]]
 name = "iterate"
@@ -48,8 +49,8 @@ name = "string_handling"
 path = "fuzz_targets/string_handling.rs"
 
 [[bin]]
-name = "serialization"
-path = "fuzz_targets/serialization.rs"
+name = "encoding"
+path = "fuzz_targets/encoding.rs"
 
 [[bin]]
 name = "generate_corpus"

examples/test.bson

@@ -7,8 +7,8 @@ use bson::Document;
 use std::io::Cursor;
 
 fuzz_target!(|buf: &[u8]| {
-    if let Ok(doc) = Document::from_reader(&mut Cursor::new(&buf[..])) {
+    if let Ok(doc) = Document::decode_from_reader(&mut Cursor::new(&buf[..])) {
         let mut vec = Vec::with_capacity(buf.len());
-        let _ = doc.to_writer(&mut vec);
+        let _ = doc.encode_to_writer(&mut vec);
     }
 });

fuzz/.gitignore

@@ -45,20 +45,19 @@ fn compare_values(val1: &Bson, val2: &Bson) -> bool {
 }
 
 fuzz_target!(|input: &[u8]| {
-    if let Ok(rawdoc) = RawDocument::from_bytes(&input) {
+    if let Ok(rawdoc) = RawDocument::decode_from_bytes(&input) {
         if let Ok(doc) = Document::try_from(rawdoc) {
             let out = RawDocumentBuf::try_from(&doc).unwrap();
             let out_bytes = out.as_bytes();
             if input != out_bytes {
-                let reserialized = RawDocument::from_bytes(&out_bytes).unwrap();
-                let reserialized_doc = Document::try_from(reserialized).unwrap();
-                // Ensure that the reserialized document is the same as the original document, the
+                let reencoded = RawDocument::decode_from_bytes(&out_bytes).unwrap();
+                let reencoded_doc = Document::try_from(reencoded).unwrap();
+                // Ensure that the re-encoded document is the same as the original document, the
                 // bytes can differ while still resulting in the same Document.
-                if !compare_docs(&doc, &reserialized_doc) {
+                if !compare_docs(&doc, &reencoded_doc) {
                     panic!(
-                        "Reserialized document is not the same as the original document: {:?} != \
-                         {:?}",
-                        doc, reserialized_doc
+                        "Reencoded document is not the same as the original document: {:?} != {:?}",
+                        doc, reencoded_doc
                     );
                 }
             }