persistence/
inspect_server.rs

1// Copyright 2020 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::file_handler;
6use log::*;
7use serde_json::{json, Value as JsonValue};
8
9// Make sure extremely deep-tree data doesn't overflow a stack.
10const MAX_TREE_DEPTH: u32 = 128;
11
12fn store_data(inspect_node: &fuchsia_inspect::Node, name: &str, data: &JsonValue, depth: u32) {
13    if depth > MAX_TREE_DEPTH {
14        return;
15    }
16    match data {
17        JsonValue::String(value) => inspect_node.record_string(name, value),
18        JsonValue::Number(value) => {
19            if value.is_i64() {
20                inspect_node.record_int(name, value.as_i64().unwrap());
21            } else if value.is_u64() {
22                inspect_node.record_uint(name, value.as_u64().unwrap());
23            } else if value.is_f64() {
24                inspect_node.record_double(name, value.as_f64().unwrap());
25            }
26        }
27        JsonValue::Bool(value) => inspect_node.record_bool(name, *value),
28        JsonValue::Object(object) => inspect_node.record_child(name, |node| {
29            for (name, value) in object.iter() {
30                store_data(node, name, value, depth + 1);
31            }
32        }),
33        JsonValue::Null => {}
34        // TODO(https://fxbug.dev/42150693): If the array is all numbers, publish them (and test).
35        JsonValue::Array(_) => {}
36    }
37}
38
39pub fn serve_persisted_data(persist_root: &fuchsia_inspect::Node) {
40    for file_handler::ServiceEntry { name, data } in file_handler::remembered_data() {
41        persist_root.record_child(name, |service_node| {
42            for tag in data {
43                let json_data = serde_json::from_str(&tag.data).unwrap_or_else(|err| {
44                    error!("Error {:?} parsing stored data", err);
45                    json!("<<Error parsing saved data>>")
46                });
47                store_data(service_node, &tag.name, &json_data, 0);
48            }
49        });
50    }
51}
52
53#[cfg(test)]
54mod test {
55    use super::*;
56    use anyhow::Error;
57    use diagnostics_assertions::assert_data_tree;
58    use fuchsia_inspect::Inspector;
59
60    // This tests all the types, and also the stack-safety mechanism by including data that should
61    // be clipped.
62    #[fuchsia::test]
63    fn test_json_export() -> Result<(), Error> {
64        let inspector = Inspector::default();
65        let inspect = inspector.root();
66        assert_data_tree!(
67            inspector,
68            root: contains {
69            }
70        );
71
72        let data_json = "{ negint: -5, int: 42, unsigned: 0, float: 45.6, \
73                         bool: true, obj: { child: 'child', grandchild: { hello: 'world', \
74                         great_grand: { should_be_clipped: true } } } }";
75        let mut data_parsed = serde_json5::from_str::<serde_json::Value>(data_json)?;
76        // serde_json5::from_str() won't parse a number this big, so I have to insert it afterward.
77        *data_parsed.get_mut("unsigned").unwrap() = serde_json::json!(9223372036854775808u64);
78        store_data(inspect, "types", &data_parsed, MAX_TREE_DEPTH - 3);
79
80        assert_data_tree!(
81            inspector,
82            root: {
83                types: {
84                    negint: -5i64,
85                    int: 42i64,
86                    unsigned: 9223372036854775808u64,
87                    float: 45.6f64,
88                    bool: true,
89                    obj: {
90                        child: "child",
91                        grandchild: {
92                            hello: "world",
93                            great_grand: {}
94                        }
95                    }
96                }
97            }
98        );
99        Ok(())
100    }
101}
persistence/inspect_server.rs

persistence/
inspect_server.rs
