1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use std::collections::HashMap;

use serde::{Deserialize, Serialize};

/// Represents a list of metrics and an associated boolean property
/// indicating if the metric is enabled from the remote-settings
/// configuration store.
///
/// The expected format of this data is stringified JSON in the following format:
///
/// ```json
/// {
///     "category.metric_name": true
/// }
/// ```
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct RemoteSettingsConfig {
    /// This is a `HashMap` consisting of base_identifiers as keys
    /// and bool values representing an override for the `disabled`
    /// property of the metric, only inverted to reduce confusion.
    /// If a particular metric has a value of `true` here, it means
    /// the default of the metric will be overriden and set to the
    /// enabled state.
    #[serde(default)]
    pub metrics_enabled: HashMap<String, bool>,

    /// This is a `HashMap` consisting of ping names as keys and
    /// boolean values representing on override for the default
    /// enabled state of the ping of the same name.
    #[serde(default)]
    pub pings_enabled: HashMap<String, bool>,

    /// The threshold of events that will be buffered before an events ping is
    /// collected and submitted.
    /// It overrides the value configured at initialization time.
    #[serde(default)]
    pub event_threshold: Option<u32>,
}

impl RemoteSettingsConfig {
    /// Creates a new RemoteSettingsConfig
    pub fn new() -> Self {
        Default::default()
    }
}

impl TryFrom<String> for RemoteSettingsConfig {
    type Error = crate::ErrorKind;

    fn try_from(json: String) -> Result<Self, Self::Error> {
        match serde_json::from_str(json.as_str()) {
            Ok(config) => Ok(config),
            Err(e) => Err(crate::ErrorKind::Json(e)),
        }
    }
}