use serde::Serialize;
use serde_json::Value;
use crate::error::Result;
pub fn unmapped_fields<T: Serialize>(raw: &Value, model: &T) -> Result<Vec<String>> {
let mapped = serde_json::to_value(model)?;
let mut found = Vec::new();
diff(raw, &mapped, "", &mut found);
found.sort();
Ok(found)
}
fn diff(raw: &Value, mapped: &Value, path: &str, found: &mut Vec<String>) {
match (raw, mapped) {
(Value::Object(raw_map), Value::Object(mapped_map)) => {
for (key, raw_child) in raw_map {
let child_path = if path.is_empty() {
key.clone()
} else {
format!("{path}.{key}")
};
match mapped_map.get(key) {
Some(mapped_child) => diff(raw_child, mapped_child, &child_path, found),
None => found.push(child_path),
}
}
},
(Value::Array(raw_items), Value::Array(mapped_items)) => {
for (index, (raw_item, mapped_item)) in
raw_items.iter().zip(mapped_items.iter()).enumerate()
{
diff(raw_item, mapped_item, &format!("{path}[{index}]"), found);
}
},
_ => {},
}
}
pub fn is_fully_mapped<T: Serialize>(raw: &Value, model: &T) -> Result<bool> {
Ok(unmapped_fields(raw, model)?.is_empty())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::models::{Album, Landing, Track};
#[test]
fn a_fully_mapped_payload_reports_nothing() {
let raw: Value = serde_json::from_str(r#"{"id":42,"title":"t","available":true}"#).unwrap();
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert!(unmapped_fields(&raw, &track).unwrap().is_empty());
assert!(is_fully_mapped(&raw, &track).unwrap());
}
#[test]
fn a_new_top_level_field_is_reported() {
let raw: Value =
serde_json::from_str(r#"{"id":42,"somethingNew":1,"alsoNew":"x"}"#).unwrap();
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert_eq!(
unmapped_fields(&raw, &track).unwrap(),
vec!["alsoNew", "somethingNew"]
);
assert!(!is_fully_mapped(&raw, &track).unwrap());
}
#[test]
fn a_new_field_inside_a_nested_object_is_reported_with_its_path() {
let raw: Value =
serde_json::from_str(r#"{"id":1,"major":{"id":2,"name":"m","newInner":true}}"#)
.unwrap();
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert_eq!(
unmapped_fields(&raw, &track).unwrap(),
vec!["major.newInner"]
);
}
#[test]
fn a_new_field_inside_a_list_element_carries_its_index() {
let raw: Value =
serde_json::from_str(r#"{"id":1,"artists":[{"id":10},{"id":11,"unexpected":"here"}]}"#)
.unwrap();
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert_eq!(
unmapped_fields(&raw, &track).unwrap(),
vec!["artists[1].unexpected"]
);
}
#[test]
fn drift_is_found_several_levels_deep() {
let raw: Value = serde_json::from_str(
r#"{"blocks":[{"id":"b","entities":[{"type":"album","futureKey":42}]}]}"#,
)
.unwrap();
let landing: Landing = serde_json::from_value(raw.clone()).unwrap();
assert_eq!(
unmapped_fields(&raw, &landing).unwrap(),
vec!["blocks[0].entities[0].futureKey"]
);
}
#[test]
fn an_absent_optional_field_is_not_mistaken_for_drift() {
let raw: Value = serde_json::from_str(r#"{"id":42}"#).unwrap();
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert!(unmapped_fields(&raw, &track).unwrap().is_empty());
}
#[test]
fn free_form_values_swallow_their_contents_rather_than_reporting_them() {
let raw: Value =
serde_json::from_str(r#"{"id":1,"trailer":{"anything":{"nested":true}}}"#).unwrap();
let album: Album = serde_json::from_value(raw.clone()).unwrap();
assert!(unmapped_fields(&raw, &album).unwrap().is_empty());
}
#[test]
fn an_empty_payload_reports_nothing() {
let raw: Value = serde_json::json!({});
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert!(unmapped_fields(&raw, &track).unwrap().is_empty());
}
#[test]
fn the_same_new_key_in_several_list_elements_is_reported_once_per_element() {
let raw: Value =
serde_json::from_str(r#"{"id":1,"artists":[{"id":1,"nw":1},{"id":2,"nw":2}]}"#)
.unwrap();
let track: Track = serde_json::from_value(raw.clone()).unwrap();
assert_eq!(
unmapped_fields(&raw, &track).unwrap(),
vec!["artists[0].nw", "artists[1].nw"]
);
}
}