use serde::Serialize;
use serde_json::{Map, Value};
use std::collections::BTreeMap;
#[derive(Debug, thiserror::Error)]
pub enum CanonicalError {
#[error("Serialization error")]
Serialize(#[from] serde_json::Error),
}
pub fn canonical_json<T: Serialize>(value: &T) -> Result<Vec<u8>, CanonicalError> {
let value = serde_json::to_value(value)?;
let canonical = canonicalize_value(value);
let json = serde_json::to_string(&canonical)?;
Ok(json.into_bytes())
}
fn canonicalize_value(value: Value) -> Value {
match value {
Value::Object(map) => {
let mut sorted = BTreeMap::new();
for (k, v) in map {
sorted.insert(k, canonicalize_value(v));
}
Value::Object(Map::from_iter(sorted))
}
Value::Array(arr) => {
let normalized = arr.into_iter().map(canonicalize_value).collect();
Value::Array(normalized)
}
_ => value,
}
}
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;
#[test]
fn canonical_sorts_object_keys() {
let obj = json!({ "b": 2, "a": 1 });
let bytes = canonical_json(&obj).unwrap();
assert_eq!(bytes, br#"{"a":1,"b":2}"#.as_slice());
}
#[test]
fn canonical_preserves_array_order() {
let obj = json!({ "items": [3, 1, 2] });
let bytes = canonical_json(&obj).unwrap();
assert_eq!(bytes, br#"{"items":[3,1,2]}"#.as_slice());
}
#[test]
fn canonical_nested_objects() {
let obj = json!({
"b": 2,
"a": 1,
"c": { "z": 26, "y": 25 }
});
let bytes = canonical_json(&obj).unwrap();
assert_eq!(bytes, br#"{"a":1,"b":2,"c":{"y":25,"z":26}}"#.as_slice());
}
#[test]
fn canonical_idempotent() {
let obj = json!({
"b": 2,
"a": 1,
"c": [3, 1, 2]
});
let bytes1 = canonical_json(&obj).unwrap();
let json_str = String::from_utf8(bytes1.clone()).unwrap();
let parsed: Value = serde_json::from_str(&json_str).unwrap();
let bytes2 = canonical_json(&parsed).unwrap();
assert_eq!(bytes1, bytes2);
}
#[test]
fn canonical_preserves_float_values() {
let obj = json!({ "value": 0.123456789 });
let bytes = canonical_json(&obj).unwrap();
let parsed: Value = serde_json::from_slice(&bytes).unwrap();
let value = parsed.get("value").and_then(|v| v.as_f64()).unwrap();
assert!((value - 0.123456789).abs() < 1e-12);
}
#[test]
fn canonical_preserves_scientific_notation() {
let obj = json!({ "value": 1e20 });
let bytes = canonical_json(&obj).unwrap();
let parsed: Value = serde_json::from_slice(&bytes).unwrap();
let value = parsed.get("value").and_then(|v| v.as_f64()).unwrap();
assert_eq!(value, 1e20);
}
#[test]
fn canonical_does_not_normalize_unicode() {
let composed = json!({ "café": 1 });
let decomposed = json!({ "cafe\u{0301}": 1 });
let bytes_composed = canonical_json(&composed).unwrap();
let bytes_decomposed = canonical_json(&decomposed).unwrap();
assert_ne!(bytes_composed, bytes_decomposed);
assert_eq!(canonical_json(&composed).unwrap(), bytes_composed);
assert_eq!(canonical_json(&decomposed).unwrap(), bytes_decomposed);
}
}