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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
use chrono::Utc;
use once_cell::sync::Lazy;
use parse_display::{Display, FromStr};
use serde::{Deserialize, Serialize};
use std::collections::HashSet;

use crate::sentry::DateHour;

use super::Timeframe;

/// When adding new [`AllowedKey`] make sure to update the [`ALLOWED_KEYS`] static value.
/// When (De)Serializing we use `camelCase`,
/// however, when displaying and parsing the value, we use `snake_case`.
/// The later is particular useful when using the value as column in SQL.
#[derive(Debug, Serialize, Deserialize, Hash, PartialEq, Eq, Clone, Copy, Display, FromStr)]
#[serde(rename_all = "camelCase")]
#[display(style = "snake_case")]
pub enum AllowedKey {
    CampaignId,
    AdUnit,
    AdSlot,
    AdSlotType,
    Advertiser,
    Publisher,
    Hostname,
    Country,
    OsName,
}

impl AllowedKey {
    #[allow(non_snake_case)]
    /// Helper function to get the [`AllowedKey`] as `camelCase`.
    pub fn to_camelCase(&self) -> String {
        serde_json::to_value(self)
            .expect("AllowedKey should always be serializable!")
            .as_str()
            .expect("Serialized AllowedKey should be a string!")
            .to_string()
    }
}

/// All [`AllowedKey`]s should be present in this static variable.
pub static ALLOWED_KEYS: Lazy<HashSet<AllowedKey>> = Lazy::new(|| {
    vec![
        AllowedKey::CampaignId,
        AllowedKey::AdUnit,
        AllowedKey::AdSlot,
        AllowedKey::AdSlotType,
        AllowedKey::Advertiser,
        AllowedKey::Publisher,
        AllowedKey::Hostname,
        AllowedKey::Country,
        AllowedKey::OsName,
    ]
    .into_iter()
    .collect()
});

// fn deserialize_query_time<'de, D>(deserializer: D) -> Result<Option<DateHour<Utc>>, D::Error>
// where
//     D: Deserializer<'de>,
// {
//     // let date_as_str = match Option::<&str>::deserialize(deserializer)? {
//     //     Some(value) => value,
//     //     // return early with None
//     //     None => return Ok(None),
//     // };

//     let datehour = match ts_milliseconds_option::deserialize(deserializer) {
//         Ok(Some(datetime)) => DateHour::try_from(datetime).map_err(serde::de::Error::custom)?,
//         // return early with None
//         Ok(None) => return Ok(None),
//         // if we have an error trying to parse the value as milliseconds
//         // try to deserialize from string
//         Err(_err) => todo!(),
//         // match Option::<&str>::deserialize(deserializer)? {
//         //     Some(value) => {
//         //         let datetime = DateTime::parse_from_rfc3339(value)
//         //             .map(|fixed| DateTime::<Utc>::from(fixed))
//         //             .map_err(serde::de::Error::custom)?;

//         //         DateHour::try_from(datetime).map_err(serde::de::Error::custom)?
//         //     }
//         //     // return early with None
//         //     None => return Ok(None),
//         // },
//     };

//     Ok(Some(datehour))
// }

#[derive(Debug, Serialize, Clone, PartialEq, Eq)]
pub struct Time {
    /// Default: [`Timeframe::Day`].
    pub timeframe: Timeframe,
    /// Default value: [`DateHour::now`] - `self.timeframe`
    /// For this query parameter you can use either:
    /// - a string with RFC 3339 and ISO 8601 format (see [`chrono::DateTime::parse_from_rfc3339`])
    /// - a timestamp in milliseconds
    /// **Note:** [`DateHour`] rules should be uphold, this means that passed values should always be rounded to hours
    /// And it should not contain **minutes**, **seconds** or **nanoseconds**
    // TODO: Either Timestamp (number) or DateTime (string) de/serialization
    pub start: DateHour<Utc>,
    /// The End [`DateHour`] which will fetch `analytics_time <= end` and should be after Start [`DateHour`]!
    pub end: Option<DateHour<Utc>>,
    // we can use `chrono_tz` to support more Timezones when needed.
    // #[serde(default = "default_timezone_utc")]
    // pub timezone: Tz,//: chrono::TimeZone,
}

impl Default for Time {
    fn default() -> Self {
        let timeframe = Timeframe::Day;
        let start = DateHour::now() - &timeframe;

        Self {
            timeframe,
            start,
            end: None,
        }
    }
}

mod de {
    use crate::{analytics::Timeframe, sentry::DateHour};

    use super::Time;
    use serde::{
        de::{self, MapAccess, Visitor},
        Deserialize, Deserializer,
    };
    use std::fmt;

    impl<'de> Deserialize<'de> for Time {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: Deserializer<'de>,
        {
            #[derive(Deserialize)]
            #[serde(field_identifier, rename_all = "lowercase")]
            enum Field {
                Timeframe,
                Start,
                End,
            }

            struct TimeVisitor;

            impl<'de> Visitor<'de> for TimeVisitor {
                type Value = Time;

                fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
                    formatter.write_str("struct Time")
                }

                fn visit_map<V>(self, mut map: V) -> Result<Time, V::Error>
                where
                    V: MapAccess<'de>,
                {
                    let mut timeframe = None;
                    let mut start = None;
                    let mut end = None;
                    while let Some(key) = map.next_key()? {
                        match key {
                            Field::Timeframe => {
                                if timeframe.is_some() {
                                    return Err(de::Error::duplicate_field("timeframe"));
                                }
                                timeframe = Some(map.next_value()?);
                            }
                            Field::Start => {
                                if start.is_some() {
                                    return Err(de::Error::duplicate_field("start"));
                                }
                                start = Some(map.next_value()?);
                            }
                            Field::End => {
                                if end.is_some() {
                                    return Err(de::Error::duplicate_field("end"));
                                }
                                end = Some(map.next_value()?);
                            }
                        }
                    }

                    let timeframe = timeframe.unwrap_or(Timeframe::Day);
                    let start = start.unwrap_or_else(|| DateHour::now() - &timeframe);

                    // if there is an End DateHour passed, check if End is > Start
                    match end {
                        Some(end) if start >= end => {
                            return Err(de::Error::custom(
                                "End time should be larger than the Start time",
                            ));
                        }
                        _ => {}
                    }

                    Ok(Time {
                        timeframe,
                        start,
                        end,
                    })
                }
            }

            const FIELDS: &[&str] = &["timeframe", "start", "end"];
            deserializer.deserialize_struct("Time", FIELDS, TimeVisitor)
        }
    }
}

#[cfg(test)]
mod test {
    use serde_json::{from_value, json};

    use crate::{analytics::Timeframe, sentry::DateHour};

    use super::Time;

    #[test]
    fn deserialize_time() {
        // default values for empty JSON object
        {
            let empty = json!({});

            let time = from_value::<Time>(empty).expect("Should use defaults on empty JSON");
            let default = Time::default();
            pretty_assertions::assert_eq!(
                time,
                default,
                "Default should generate the same as the default deserialization values!"
            );
            pretty_assertions::assert_eq!(
                time,
                Time {
                    timeframe: Timeframe::Day,
                    start: DateHour::now() - &Timeframe::Day,
                    end: None
                }
            );
        }

        // `Start` default value and no `End`
        {
            let timeframe_only = json!({
                "timeframe": "week",
            });

            let time = from_value::<Time>(timeframe_only).expect("Should use default for start");
            pretty_assertions::assert_eq!(
                time,
                Time {
                    timeframe: Timeframe::Week,
                    start: DateHour::now() - &Timeframe::Week,
                    end: None
                }
            );
        }

        // all fields with same timezone
        {
            let full = json!({
                "timeframe": "day",
                "start": "2021-12-1T16:00:00+02:00",
                "end": "2021-12-31T16:00:00+02:00"
            });

            let time = from_value::<Time>(full).expect("Should use default for start");
            pretty_assertions::assert_eq!(
                time,
                Time {
                    timeframe: Timeframe::Day,
                    start: DateHour::from_ymdh(2021, 12, 1, 14),
                    end: Some(DateHour::from_ymdh(2021, 12, 31, 14)),
                }
            );
        }

        // All fields with different timezones
        {
            let full = json!({
                "timeframe": "day",
                "start": "2021-12-1T16:00:00+00:00",
                "end": "2021-12-31T16:00:00+02:00"
            });

            let time = from_value::<Time>(full).expect("Should deserialize");
            pretty_assertions::assert_eq!(
                time,
                Time {
                    timeframe: Timeframe::Day,
                    start: DateHour::from_ymdh(2021, 12, 1, 16),
                    end: Some(DateHour::from_ymdh(2021, 12, 31, 14)),
                }
            );
        }

        // Start > End
        {
            let full = json!({
                "timeframe": "day",
                "start": "2021-12-16T16:00:00+00:00",
                "end": "2021-12-15T16:00:00+02:00"
            });

            let err = from_value::<Time>(full).expect_err("Should error because Start > End");

            assert_eq!(
                "End time should be larger than the Start time",
                err.to_string()
            );
        }

        // Start = End with different timezones
        {
            let full = json!({
                "timeframe": "day",
                "start": "2021-12-16T14:00:00+00:00",
                "end": "2021-12-16T16:00:00+02:00"
            });

            let err = from_value::<Time>(full).expect_err("Should error because Start = End");

            assert_eq!(
                "End time should be larger than the Start time",
                err.to_string()
            );
        }
    }
}