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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
use crate::{
    sentry::EventType, targeting::Rules, AdUnit, Address, Channel, EventSubmission, UnifiedNum,
    Validator, ValidatorDesc, ValidatorId,
};

use chrono::{
    serde::{ts_milliseconds, ts_milliseconds_option},
    DateTime, Utc,
};
use serde::{Deserialize, Serialize};

#[doc(inline)]
pub use {
    campaign_id::CampaignId,
    pricing::{Pricing, PricingBounds},
    validators::Validators,
};

mod campaign_id {
    use crate::ToHex;
    use hex::{FromHex, FromHexError};
    use serde::{
        de::{self, Visitor},
        Deserialize, Deserializer, Serialize, Serializer,
    };
    use std::{fmt, str::FromStr};
    use thiserror::Error;
    use uuid::Uuid;

    #[derive(Clone, Copy, PartialEq, Eq, Hash)]
    /// an Id of 16 bytes, (de)serialized as a `0x` prefixed hex
    ///
    /// In this implementation of the `CampaignId` the value is generated from a `Uuid::new_v4().to_simple()`
    pub struct CampaignId([u8; 16]);

    impl fmt::Debug for CampaignId {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            write!(f, "CampaignId({})", self)
        }
    }

    impl CampaignId {
        /// Generates randomly a `CampaignId` using `Uuid::new_v4().to_simple()`
        pub fn new() -> Self {
            Self::default()
        }

        pub fn as_bytes(&self) -> &[u8; 16] {
            &self.0
        }

        pub fn from_bytes(bytes: &[u8; 16]) -> Self {
            Self(*bytes)
        }
    }

    impl Default for CampaignId {
        fn default() -> Self {
            Self(*Uuid::new_v4().as_bytes())
        }
    }

    impl AsRef<[u8]> for CampaignId {
        fn as_ref(&self) -> &[u8] {
            &self.0
        }
    }

    impl AsRef<[u8; 16]> for CampaignId {
        fn as_ref(&self) -> &[u8; 16] {
            &self.0
        }
    }

    #[derive(Debug, Error)]
    pub enum Error {
        /// the `0x` prefix is missing
        #[error("Expected a `0x` prefix")]
        ExpectedPrefix,
        #[error(transparent)]
        InvalidHex(#[from] FromHexError),
    }

    impl FromStr for CampaignId {
        type Err = Error;

        fn from_str(s: &str) -> Result<Self, Self::Err> {
            match s.strip_prefix("0x") {
                Some(hex) => Ok(Self(<[u8; 16]>::from_hex(hex)?)),
                None => Err(Error::ExpectedPrefix),
            }
        }
    }

    impl fmt::Display for CampaignId {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.write_str(&self.0.to_hex_prefixed())
        }
    }

    impl Serialize for CampaignId {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: Serializer,
        {
            serializer.serialize_str(&self.0.to_hex_prefixed())
        }
    }

    impl<'de> Deserialize<'de> for CampaignId {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: Deserializer<'de>,
        {
            deserializer.deserialize_str(StringIdVisitor)
        }
    }

    struct StringIdVisitor;

    impl<'de> Visitor<'de> for StringIdVisitor {
        type Value = CampaignId;

        fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
            formatter.write_str("a string of a `0x` prefixed hex with 16 bytes")
        }

        fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            value
                .parse::<CampaignId>()
                .map_err(|err| E::custom(err.to_string()))
        }

        fn visit_string<E>(self, value: String) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            self.visit_str(&value)
        }
    }

    #[cfg(test)]
    mod test {
        use serde_json::{to_value, Value};

        use super::*;

        #[test]
        fn parse_and_display_campaign_id() {
            let str_id = "0x936da01f9abd4d9d80c702af85c822a8";

            let campaign_id: CampaignId = str_id.parse().expect("Should parse");

            assert_eq!(str_id, &campaign_id.to_string())
        }

        #[test]
        fn de_serializes_campaign_id() {
            let id = CampaignId::new();

            assert_eq!(
                Value::String(id.0.to_hex_prefixed()),
                to_value(id).expect("Should serialize")
            );
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Campaign {
    pub id: CampaignId,
    pub channel: Channel,
    pub creator: Address,
    pub budget: UnifiedNum,
    pub validators: Validators,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Events pricing bounds, per 1 event
    #[serde(default, skip_serializing_if = "PricingBounds::is_empty")]
    pub pricing_bounds: PricingBounds,
    /// EventSubmission object, applied to event submission
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub event_submission: Option<EventSubmission>,
    /// An array of AdUnit (optional)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub ad_units: Vec<AdUnit>,
    #[serde(default)]
    pub targeting_rules: Rules,
    /// A millisecond timestamp of when the campaign was created
    #[serde(with = "ts_milliseconds")]
    pub created: DateTime<Utc>,
    /// Used by the AdViewManager & Targeting AIP#31
    #[serde(flatten)]
    pub active: Active,
}

impl Campaign {
    pub fn find_validator(&self, validator: &ValidatorId) -> Option<Validator<&ValidatorDesc>> {
        match (self.leader(), self.follower()) {
            (Some(leader), _) if &leader.id == validator => Some(Validator::Leader(leader)),
            (_, Some(follower)) if &follower.id == validator => Some(Validator::Follower(follower)),
            _ => None,
        }
    }

    /// Matches the Channel.leader to the Campaign.validators.leader
    /// If they match it returns `Some`, otherwise, it returns `None`
    pub fn leader(&self) -> Option<&'_ ValidatorDesc> {
        self.validators.find(&self.channel.leader)
    }

    /// Matches the Channel.follower to the Campaign.spec.follower
    /// If they match it returns `Some`, otherwise, it returns `None`
    pub fn follower(&self) -> Option<&'_ ValidatorDesc> {
        self.validators.find(&self.channel.follower)
    }

    /// Returns the pricing of a given event
    pub fn pricing(&self, event: EventType) -> Option<&Pricing> {
        self.pricing_bounds.get(&event)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct Active {
    /// Campaign active from in a milliseconds timestamp
    ///
    /// The time at which you want this campaign to become active (optional)
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        with = "ts_milliseconds_option",
        rename = "activeFrom"
    )]
    pub from: Option<DateTime<Utc>>,
    /// Campaign active to in a milliseconds timestamp
    ///
    /// The time at which you want this campaign to become inactive (mandatory)
    #[serde(with = "ts_milliseconds", rename = "activeTo")]
    pub to: DateTime<Utc>,
}

mod pricing {
    use std::{
        collections::HashMap,
        ops::{Deref, DerefMut},
    };

    use crate::{sentry::EventType, UnifiedNum};
    use serde::{Deserialize, Serialize};

    #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
    pub struct Pricing {
        /// The minimum payable amount for a single event
        pub min: UnifiedNum,
        /// The maximum payable amount for a single event
        pub max: UnifiedNum,
    }

    /// The pricing bounds (minimum and maximum payable amount) per event type for 1 event.
    #[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, Clone)]
    #[serde(transparent)]
    pub struct PricingBounds(HashMap<EventType, Pricing>);

    impl PricingBounds {
        pub fn is_empty(&self) -> bool {
            self.0.is_empty()
        }
    }

    impl FromIterator<(EventType, Pricing)> for PricingBounds {
        fn from_iter<T: IntoIterator<Item = (EventType, Pricing)>>(iter: T) -> Self {
            Self(iter.into_iter().collect())
        }
    }

    impl Deref for PricingBounds {
        type Target = HashMap<EventType, Pricing>;

        fn deref(&self) -> &Self::Target {
            &self.0
        }
    }

    impl DerefMut for PricingBounds {
        fn deref_mut(&mut self) -> &mut Self::Target {
            &mut self.0
        }
    }
}

/// Campaign Validators
pub mod validators {
    use std::ops::Index;

    use crate::{ValidatorDesc, ValidatorId};
    use serde::{Deserialize, Serialize};

    /// Unordered list of the validators representing the leader & follower
    #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
    pub struct Validators(ValidatorDesc, ValidatorDesc);

    impl Validators {
        pub fn new(validators: (ValidatorDesc, ValidatorDesc)) -> Self {
            Self(validators.0, validators.1)
        }

        pub fn find(&self, validator_id: &ValidatorId) -> Option<&ValidatorDesc> {
            if &self.0.id == validator_id {
                Some(&self.0)
            } else if &self.1.id == validator_id {
                Some(&self.1)
            } else {
                None
            }
        }

        pub fn iter(&self) -> Iter<'_> {
            Iter::new(self)
        }
    }

    impl From<(ValidatorDesc, ValidatorDesc)> for Validators {
        fn from(validators: (ValidatorDesc, ValidatorDesc)) -> Self {
            Self(validators.0, validators.1)
        }
    }

    impl Index<usize> for Validators {
        type Output = ValidatorDesc;
        fn index(&self, index: usize) -> &Self::Output {
            match index {
                0 => &self.0,
                1 => &self.1,
                _ => panic!("Validators index is out of bound"),
            }
        }
    }

    /// Fixed size iterator of 2, as we need an iterator in couple of occasions
    impl<'a> IntoIterator for &'a Validators {
        type Item = &'a ValidatorDesc;
        type IntoIter = Iter<'a>;

        fn into_iter(self) -> Self::IntoIter {
            self.iter()
        }
    }

    pub struct Iter<'a> {
        validators: &'a Validators,
        index: u8,
    }

    impl<'a> Iter<'a> {
        fn new(validators: &'a Validators) -> Self {
            Self {
                validators,
                index: 0,
            }
        }
    }

    impl<'a> Iterator for Iter<'a> {
        type Item = &'a ValidatorDesc;

        fn next(&mut self) -> Option<Self::Item> {
            match self.index {
                0 => {
                    self.index += 1;

                    Some(&self.validators.0)
                }
                1 => {
                    self.index += 1;

                    Some(&self.validators.1)
                }
                _ => None,
            }
        }
    }
}

#[cfg(feature = "postgres")]
mod postgres {
    use crate::Channel;

    use super::{Active, Campaign, CampaignId, PricingBounds, Validators};
    use bytes::BytesMut;
    use std::error::Error;
    use tokio_postgres::types::{accepts, to_sql_checked, FromSql, IsNull, Json, ToSql, Type};
    use tokio_postgres::Row;

    impl From<&Row> for Campaign {
        fn from(row: &Row) -> Self {
            Self {
                id: row.get("id"),
                channel: Channel::from(row),
                creator: row.get("creator"),
                budget: row.get("budget"),
                validators: row.get("validators"),
                title: row.get("title"),
                pricing_bounds: row.get("pricing_bounds"),
                event_submission: row.get("event_submission"),
                ad_units: row.get::<_, Json<_>>("ad_units").0,
                targeting_rules: row.get("targeting_rules"),
                created: row.get("created"),
                active: Active {
                    from: row.get("active_from"),
                    to: row.get("active_to"),
                },
            }
        }
    }

    impl<'a> FromSql<'a> for CampaignId {
        fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Self, Box<dyn Error + Sync + Send>> {
            let str_slice = <&str as FromSql>::from_sql(ty, raw)?;

            Ok(str_slice.parse()?)
        }

        accepts!(TEXT, VARCHAR);
    }

    impl From<&Row> for CampaignId {
        fn from(row: &Row) -> Self {
            row.get("id")
        }
    }

    impl ToSql for CampaignId {
        fn to_sql(
            &self,
            ty: &Type,
            w: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            self.to_string().to_sql(ty, w)
        }

        accepts!(TEXT, VARCHAR);
        to_sql_checked!();
    }

    impl<'a> FromSql<'a> for Validators {
        fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Self, Box<dyn Error + Sync + Send>> {
            let json = <Json<Self> as FromSql>::from_sql(ty, raw)?;

            Ok(json.0)
        }

        accepts!(JSONB);
    }

    impl ToSql for Validators {
        fn to_sql(
            &self,
            ty: &Type,
            w: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            Json(self).to_sql(ty, w)
        }

        accepts!(JSONB);
        to_sql_checked!();
    }

    impl<'a> FromSql<'a> for PricingBounds {
        fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Self, Box<dyn Error + Sync + Send>> {
            let json = <Json<Self> as FromSql>::from_sql(ty, raw)?;

            Ok(json.0)
        }

        accepts!(JSONB);
    }

    impl ToSql for PricingBounds {
        fn to_sql(
            &self,
            ty: &Type,
            w: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            Json(self).to_sql(ty, w)
        }

        accepts!(JSONB);
        to_sql_checked!();
    }
}