summaryrefslogtreecommitdiffstats
path: root/third_party/rust/glean-core/tests/datetime.rs
blob: 7e7938690f3ccc47afa7efd6e08516e409598327 (plain)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// 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/.

mod common;
use crate::common::*;

use chrono::prelude::*;
use serde_json::json;

use glean_core::metrics::*;
use glean_core::storage::StorageManager;
use glean_core::{CommonMetricData, Lifetime};

// SKIPPED from glean-ac: datetime deserializer should correctly parse integers
// This test doesn't really apply to rkv

#[test]
fn datetime_serializer_should_correctly_serialize_datetime() {
    let expected_value = "1983-04-13T12:09+00:00";
    let (mut tempdir, _) = tempdir();

    {
        // We give tempdir to the `new_glean` function...
        let (glean, dir) = new_glean(Some(tempdir));
        // And then we get it back once that function returns.
        tempdir = dir;

        let metric = DatetimeMetric::new(
            CommonMetricData {
                name: "datetime_metric".into(),
                category: "telemetry".into(),
                send_in_pings: vec!["store1".into()],
                disabled: false,
                lifetime: Lifetime::User,
                ..Default::default()
            },
            TimeUnit::Minute,
        );

        // `1983-04-13T12:09:14.274+00:00` will be truncated to Minute resolution.
        let dt = FixedOffset::east(0)
            .ymd(1983, 4, 13)
            .and_hms_milli(12, 9, 14, 274);
        metric.set_sync(&glean, Some(dt.into()));

        let snapshot = StorageManager
            .snapshot_as_json(glean.storage(), "store1", true)
            .unwrap();
        assert_eq!(
            json!({"datetime": {"telemetry.datetime_metric": expected_value}}),
            snapshot
        );
    }

    // Make a new Glean instance here, which should force reloading of the data from disk
    // so we can ensure it persisted, because it has User lifetime
    {
        let (glean, _t) = new_glean(Some(tempdir));
        let snapshot = StorageManager
            .snapshot_as_json(glean.storage(), "store1", true)
            .unwrap();
        assert_eq!(
            json!({"datetime": {"telemetry.datetime_metric": expected_value}}),
            snapshot
        );
    }
}

#[test]
fn set_value_properly_sets_the_value_in_all_stores() {
    let (glean, _t) = new_glean(None);
    let store_names: Vec<String> = vec!["store1".into(), "store2".into()];

    let metric = DatetimeMetric::new(
        CommonMetricData {
            name: "datetime_metric".into(),
            category: "telemetry".into(),
            send_in_pings: store_names.clone(),
            disabled: false,
            lifetime: Lifetime::Ping,
            ..Default::default()
        },
        TimeUnit::Nanosecond,
    );

    // `1983-04-13T12:09:14.274+00:00` will be truncated to Minute resolution.
    let dt = FixedOffset::east(0)
        .ymd(1983, 4, 13)
        .and_hms_nano(12, 9, 14, 1_560_274);
    metric.set_sync(&glean, Some(dt.into()));

    for store_name in store_names {
        assert_eq!(
            "1983-04-13T12:09:14.001560274+00:00",
            metric
                .get_value_as_string(&glean, Some(store_name))
                .unwrap()
        );
    }
}

// SKIPPED from glean-ac: getSnapshot() returns null if nothing is recorded in the store
// This test doesn't really apply to rkv

// SKIPPED from glean-ac: getSnapshot() correctly clears the stores
// This test doesn't really apply to rkv

#[test]
fn test_that_truncation_works() {
    let (glean, _t) = new_glean(None);

    // `1985-07-03T12:09:14.000560274+01:00`
    let high_res_datetime = FixedOffset::east(3600)
        .ymd(1985, 7, 3)
        .and_hms_nano(12, 9, 14, 1_560_274);
    let store_name = "store1";

    // Create an helper struct for defining the truncation cases.
    struct TestCase {
        case_name: &'static str,
        desired_resolution: TimeUnit,
        expected_result: &'static str,
    }

    // Define the single test cases.
    let test_cases = vec![
        TestCase {
            case_name: "nano",
            desired_resolution: TimeUnit::Nanosecond,
            expected_result: "1985-07-03T12:09:14.001560274+01:00",
        },
        TestCase {
            case_name: "micro",
            desired_resolution: TimeUnit::Microsecond,
            expected_result: "1985-07-03T12:09:14.001560+01:00",
        },
        TestCase {
            case_name: "milli",
            desired_resolution: TimeUnit::Millisecond,
            expected_result: "1985-07-03T12:09:14.001+01:00",
        },
        TestCase {
            case_name: "second",
            desired_resolution: TimeUnit::Second,
            expected_result: "1985-07-03T12:09:14+01:00",
        },
        TestCase {
            case_name: "minute",
            desired_resolution: TimeUnit::Minute,
            expected_result: "1985-07-03T12:09+01:00",
        },
        TestCase {
            case_name: "hour",
            desired_resolution: TimeUnit::Hour,
            expected_result: "1985-07-03T12+01:00",
        },
        TestCase {
            case_name: "day",
            desired_resolution: TimeUnit::Day,
            expected_result: "1985-07-03+01:00",
        },
    ];

    // Execute them all.
    for t in test_cases {
        let metric = DatetimeMetric::new(
            CommonMetricData {
                name: format!("datetime_metric_{}", t.case_name),
                category: "telemetry".into(),
                send_in_pings: vec![store_name.into()],
                disabled: false,
                lifetime: Lifetime::User,
                ..Default::default()
            },
            t.desired_resolution,
        );
        metric.set_sync(&glean, Some(high_res_datetime.into()));

        assert_eq!(
            t.expected_result,
            metric
                .get_value_as_string(&glean, Some(store_name.into()))
                .unwrap()
        );
    }
}