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
use async_trait::async_trait;
use std::sync::Arc;

use mithril_common::entities::{Epoch, SignedEntityType};
use mithril_common::StdResult;
use mithril_persistence::sqlite::{ConnectionExtensions, SqliteConnection};

use crate::database::query::{
    DeleteSignedBeaconRecordQuery, GetSignedBeaconQuery, InsertSignedBeaconRecordQuery,
};
use crate::database::record::SignedBeaconRecord;
use crate::entities::BeaconToSign;
use crate::services::{EpochPruningTask, SignedBeaconStore};

/// A [SignedBeaconStore] implementation using SQLite.
pub struct SignedBeaconRepository {
    connection: Arc<SqliteConnection>,
    store_retention_limit: Option<u64>,
}

impl SignedBeaconRepository {
    /// Create a new instance of the `SignedBeaconRepository`.
    pub fn new(connection: Arc<SqliteConnection>, store_retention_limit: Option<u64>) -> Self {
        Self {
            connection,
            store_retention_limit,
        }
    }

    /// Get the last signed beacon.
    pub fn get_last(&self) -> StdResult<Option<SignedBeaconRecord>> {
        self.connection.fetch_first(GetSignedBeaconQuery::all())
    }

    /// Prune all signed beacons that have an epoch below the given threshold.
    pub fn prune_below_epoch(&self, epoch: Epoch) -> StdResult<()> {
        let _ = self
            .connection
            .fetch_first(DeleteSignedBeaconRecordQuery::below_epoch_threshold(epoch))?;
        Ok(())
    }
}

#[async_trait]
impl SignedBeaconStore for SignedBeaconRepository {
    async fn filter_out_already_signed_entities(
        &self,
        entities: Vec<SignedEntityType>,
    ) -> StdResult<Vec<SignedEntityType>> {
        let already_signed_entities: Vec<SignedEntityType> = self
            .connection
            .fetch(GetSignedBeaconQuery::by_signed_entities(&entities)?)?
            .map(|record| record.signed_entity_type)
            .collect();

        Ok(entities
            .into_iter()
            .filter(|e| !already_signed_entities.contains(e))
            .collect())
    }

    async fn mark_beacon_as_signed(&self, entity: &BeaconToSign) -> StdResult<()> {
        let record = entity.clone().into();
        let _ = self
            .connection
            .fetch_first(InsertSignedBeaconRecordQuery::one(record)?)?;

        Ok(())
    }
}

#[async_trait]
impl EpochPruningTask for SignedBeaconRepository {
    fn pruned_data(&self) -> &'static str {
        "Signed Beacon"
    }

    async fn prune(&self, current_epoch: Epoch) -> StdResult<()> {
        match self
            .store_retention_limit
            .map(|limit| current_epoch - limit)
        {
            Some(threshold) if *threshold > 0 => self.prune_below_epoch(threshold),
            _ => Ok(()),
        }
    }
}

#[cfg(test)]
mod tests {
    use chrono::Utc;

    use mithril_common::entities::{
        BlockNumber, Epoch, SignedEntityConfig, SignedEntityTypeDiscriminants, TimePoint,
    };
    use mithril_persistence::sqlite::ConnectionExtensions;

    use crate::database::query::GetSignedBeaconQuery;
    use crate::database::record::SignedBeaconRecord;
    use crate::database::test_helper::{insert_signed_beacons, main_db_connection};

    use super::*;

    fn all_signed_entity_type_for(time_point: &TimePoint) -> Vec<SignedEntityType> {
        let config = SignedEntityConfig {
            allowed_discriminants: SignedEntityTypeDiscriminants::all(),
            ..SignedEntityConfig::dummy()
        };
        config.list_allowed_signed_entity_types(time_point).unwrap()
    }

    #[test]
    fn get_last_stored_signed_beacon() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);

        let last_signed_beacon = repository.get_last().unwrap();
        assert_eq!(None, last_signed_beacon);

        insert_signed_beacons(
            &connection,
            vec![SignedBeaconRecord::fake(
                Epoch(1941),
                SignedEntityType::MithrilStakeDistribution(Epoch(1941)),
            )],
        );

        let last_signed_beacon = repository.get_last().unwrap();
        assert_eq!(
            Some(SignedBeaconRecord::fake(
                Epoch(1941),
                SignedEntityType::MithrilStakeDistribution(Epoch(1941)),
            )),
            last_signed_beacon
        );

        insert_signed_beacons(
            &connection,
            SignedBeaconRecord::fakes(&[
                (
                    Epoch(1942),
                    vec![SignedEntityType::MithrilStakeDistribution(Epoch(1942))],
                ),
                (
                    Epoch(1943),
                    vec![SignedEntityType::MithrilStakeDistribution(Epoch(1943))],
                ),
            ]),
        );

        let last_signed_beacon = repository.get_last().unwrap();
        assert_eq!(
            Some(SignedBeaconRecord::fake(
                Epoch(1943),
                SignedEntityType::MithrilStakeDistribution(Epoch(1943)),
            )),
            last_signed_beacon
        );
    }

    #[tokio::test]
    async fn filter_out_nothing_if_nothing_was_previously_signed() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);

        let to_filter = all_signed_entity_type_for(&TimePoint::dummy());
        let available_entities = repository
            .filter_out_already_signed_entities(to_filter.clone())
            .await
            .unwrap();

        assert_eq!(to_filter, available_entities);
    }

    #[tokio::test]
    async fn filter_out_nothing_if_previously_signed_entities_doesnt_match_passed_entities() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);

        let time_point = TimePoint::dummy();
        insert_signed_beacons(
            &connection,
            SignedBeaconRecord::fakes(&[(
                Epoch(1941),
                vec![SignedEntityType::MithrilStakeDistribution(
                    time_point.epoch - 2,
                )],
            )]),
        );
        let to_filter = all_signed_entity_type_for(&time_point);

        let available_entities = repository
            .filter_out_already_signed_entities(to_filter.clone())
            .await
            .unwrap();
        assert_eq!(to_filter, available_entities);
    }

    #[tokio::test]
    async fn filter_out_everything_if_previously_signed_entities_match_all_passed_entities() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);

        let to_filter = all_signed_entity_type_for(&TimePoint::dummy());
        insert_signed_beacons(
            &connection,
            to_filter
                .iter()
                .map(|entity| SignedBeaconRecord::fake(Epoch(4872), entity.clone()))
                .collect(),
        );

        let available_entities = repository
            .filter_out_already_signed_entities(to_filter.clone())
            .await
            .unwrap();
        assert_eq!(Vec::<SignedEntityType>::new(), available_entities);
    }

    #[tokio::test]
    async fn filter_out_partially_if_some_previously_signed_entities_match_passed_entities() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);

        let time_point = TimePoint::dummy();
        let signed_beacons = [
            SignedEntityType::MithrilStakeDistribution(time_point.epoch),
            SignedEntityType::CardanoTransactions(
                time_point.epoch,
                time_point.chain_point.block_number,
            ),
        ];
        insert_signed_beacons(
            &connection,
            signed_beacons
                .iter()
                .map(|entity| SignedBeaconRecord::fake(Epoch(4872), entity.clone()))
                .collect(),
        );

        let available_entities = repository
            .filter_out_already_signed_entities(vec![
                SignedEntityType::MithrilStakeDistribution(time_point.epoch),
                SignedEntityType::CardanoStakeDistribution(time_point.epoch),
                SignedEntityType::CardanoTransactions(
                    time_point.epoch,
                    time_point.chain_point.block_number,
                ),
                SignedEntityType::CardanoStakeDistribution(time_point.epoch + 10),
            ])
            .await
            .unwrap();

        assert_eq!(
            vec![
                SignedEntityType::CardanoStakeDistribution(time_point.epoch),
                SignedEntityType::CardanoStakeDistribution(time_point.epoch + 10),
            ],
            available_entities
        );
    }

    #[tokio::test]
    async fn mark_beacon_as_signed() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);

        let beacon_to_sign = BeaconToSign {
            epoch: Epoch(13),
            signed_entity_type: SignedEntityType::MithrilStakeDistribution(Epoch(13)),
            initiated_at: Utc::now(),
        };

        let signed_beacons: Vec<SignedBeaconRecord> = connection
            .fetch_collect(GetSignedBeaconQuery::all())
            .unwrap();
        assert_eq!(Vec::<SignedBeaconRecord>::new(), signed_beacons);

        repository
            .mark_beacon_as_signed(&beacon_to_sign)
            .await
            .unwrap();

        let signed_beacon = connection
            .fetch_first(GetSignedBeaconQuery::all())
            .unwrap()
            .expect("A signed beacon should have been inserted");
        assert_eq!(beacon_to_sign, signed_beacon);
    }

    #[tokio::test]
    async fn test_dont_execute_pruning_tasks_if_no_retention_limit_set() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), None);
        insert_signed_beacons(
            &connection,
            SignedBeaconRecord::fakes(&[(
                Epoch(8),
                vec![SignedEntityType::MithrilStakeDistribution(Epoch(8))],
            )]),
        );

        EpochPruningTask::prune(&repository, Epoch(1000))
            .await
            .unwrap();

        let cursor = connection.fetch(GetSignedBeaconQuery::all()).unwrap();
        assert_eq!(1, cursor.count(),);
    }

    #[tokio::test]
    async fn test_dont_execute_pruning_tasks_if_current_epoch_minus_retention_limit_is_0() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), Some(10));
        insert_signed_beacons(
            &connection,
            SignedBeaconRecord::fakes(&[(
                Epoch(8),
                vec![SignedEntityType::MithrilStakeDistribution(Epoch(8))],
            )]),
        );

        EpochPruningTask::prune(&repository, Epoch(9))
            .await
            .unwrap();

        let cursor = connection.fetch(GetSignedBeaconQuery::all()).unwrap();
        assert_eq!(1, cursor.count(),);
    }

    #[tokio::test]
    async fn test_prune_task_substract_set_retention_limit_to_given_epoch() {
        let connection = Arc::new(main_db_connection().unwrap());
        let repository = SignedBeaconRepository::new(connection.clone(), Some(10));
        insert_signed_beacons(
            &connection,
            SignedBeaconRecord::fakes(&[
                (
                    Epoch(7),
                    vec![
                        SignedEntityType::MithrilStakeDistribution(Epoch(7)),
                        SignedEntityType::CardanoTransactions(Epoch(7), BlockNumber(12)),
                    ],
                ),
                (
                    Epoch(8),
                    vec![SignedEntityType::MithrilStakeDistribution(Epoch(8))],
                ),
            ]),
        );

        EpochPruningTask::prune(&repository, Epoch(18))
            .await
            .unwrap();

        let signed_beacons: Vec<SignedBeaconRecord> = connection
            .fetch_collect(GetSignedBeaconQuery::all())
            .unwrap();
        assert_eq!(
            vec![SignedBeaconRecord::fake(
                Epoch(8),
                SignedEntityType::MithrilStakeDistribution(Epoch(8))
            )],
            signed_beacons
        );
    }
}