From a8641b42a7963666eedb9846b6aa69481a3f92ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Lecrenier?= <loic@meilisearch.com>
Date: Tue, 14 Jun 2022 15:05:49 +0200
Subject: [PATCH] Modify flatten_serde_json to keep dummy value for all object
 keys

Example:
```json
{
    "id": 0,
    "colour" : { "green": 1 }
}
```
becomes:
```json
{
    "id": 0,
    "colour" : [],
    "colour.green": 1
}
```
to retain the information the key "colour" exists in the original
json value.
---
 flatten-serde-json/src/lib.rs | 53 ++++++++++++++++++++++++++++++-----
 1 file changed, 46 insertions(+), 7 deletions(-)

diff --git a/flatten-serde-json/src/lib.rs b/flatten-serde-json/src/lib.rs
index 8312f5bd6..e1b2b20c7 100644
--- a/flatten-serde-json/src/lib.rs
+++ b/flatten-serde-json/src/lib.rs
@@ -4,7 +4,11 @@ use serde_json::{Map, Value};
 
 pub fn flatten(json: &Map<String, Value>) -> Map<String, Value> {
     let mut obj = Map::new();
-    insert_object(&mut obj, None, json);
+    let mut all_keys = vec![];
+    insert_object(&mut obj, None, json, &mut all_keys);
+    for key in all_keys {
+        obj.entry(key).or_insert(Value::Array(vec![]));
+    }
     obj
 }
 
@@ -12,26 +16,32 @@ fn insert_object(
     base_json: &mut Map<String, Value>,
     base_key: Option<&str>,
     object: &Map<String, Value>,
+    all_keys: &mut Vec<String>,
 ) {
     for (key, value) in object {
         let new_key = base_key.map_or_else(|| key.clone(), |base_key| format!("{base_key}.{key}"));
-
+        all_keys.push(new_key.clone());
         if let Some(array) = value.as_array() {
-            insert_array(base_json, &new_key, array);
+            insert_array(base_json, &new_key, array, all_keys);
         } else if let Some(object) = value.as_object() {
-            insert_object(base_json, Some(&new_key), object);
+            insert_object(base_json, Some(&new_key), object, all_keys);
         } else {
             insert_value(base_json, &new_key, value.clone());
         }
     }
 }
 
-fn insert_array(base_json: &mut Map<String, Value>, base_key: &str, array: &Vec<Value>) {
+fn insert_array(
+    base_json: &mut Map<String, Value>,
+    base_key: &str,
+    array: &Vec<Value>,
+    all_keys: &mut Vec<String>,
+) {
     for value in array {
         if let Some(object) = value.as_object() {
-            insert_object(base_json, Some(base_key), object);
+            insert_object(base_json, Some(base_key), object, all_keys);
         } else if let Some(sub_array) = value.as_array() {
-            insert_array(base_json, base_key, sub_array);
+            insert_array(base_json, base_key, sub_array, all_keys);
         } else {
             insert_value(base_json, base_key, value.clone());
         }
@@ -103,6 +113,7 @@ mod tests {
         assert_eq!(
             &flat,
             json!({
+                "a": [],
                 "a.b": "c",
                 "a.d": "e",
                 "a.f": "g"
@@ -116,6 +127,10 @@ mod tests {
     fn flatten_array() {
         let mut base: Value = json!({
           "a": [
+            1,
+            "b",
+            [],
+            [{}],
             { "b": "c" },
             { "b": "d" },
             { "b": "e" },
@@ -127,6 +142,7 @@ mod tests {
         assert_eq!(
             &flat,
             json!({
+                "a": [1, "b"],
                 "a.b": ["c", "d", "e"],
             })
             .as_object()
@@ -154,6 +170,28 @@ mod tests {
             .as_object()
             .unwrap()
         );
+
+        // here we must keep 42 in "a"
+        let mut base: Value = json!({
+          "a": [
+            { "b": "c" },
+            { "b": "d" },
+            { "b": "e" },
+            null,
+          ]
+        });
+        let json = std::mem::take(base.as_object_mut().unwrap());
+        let flat = flatten(&json);
+
+        assert_eq!(
+            &flat,
+            json!({
+                "a": null,
+                "a.b": ["c", "d", "e"],
+            })
+            .as_object()
+            .unwrap()
+        );
     }
 
     #[test]
@@ -170,6 +208,7 @@ mod tests {
         assert_eq!(
             &flat,
             json!({
+                "a": [],
                 "a.b": ["c", "d"],
             })
             .as_object()