pipedash-core 0.9.0

Framework-agnostic core library for Pipedash
Documentation
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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
use chrono::{
    DateTime,
    Duration,
    SubsecRound,
    Utc,
};

use super::DatabasePool;
use crate::domain::{
    new_alert_id,
    AlertKind,
    DeviceAlert,
    DomainError,
    DomainResult,
    NewDeviceAlert,
};

type Row = (
    i64,
    String,
    String,
    String,
    String,
    String,
    Option<String>,
    Option<i64>,
    DateTime<Utc>,
);

const COLUMNS: &str = "seq, id, alert_key, kind, title, body, pipeline_id, provider_id, created_at";
const RETENTION_DAYS: i64 = 7;
const MAX_ROWS: i64 = 500;

macro_rules! insert_with_seq {
    ($sql:expr, $alert:expr, $executor:expr) => {
        sqlx::query(sqlx::AssertSqlSafe($sql.clone()))
            .bind($alert.seq)
            .bind(&$alert.id)
            .bind(&$alert.key)
            .bind($alert.kind.as_str())
            .bind(&$alert.title)
            .bind(&$alert.body)
            .bind($alert.pipeline_id.as_deref())
            .bind($alert.provider_id)
            .bind($alert.created_at)
            .execute($executor)
            .await
            .map(|_| ())
    };
}

fn db_error(error: sqlx::Error) -> DomainError {
    DomainError::DatabaseError(error.to_string())
}

fn cutoff() -> DateTime<Utc> {
    Utc::now() - Duration::days(RETENTION_DAYS)
}

fn alert(row: Row) -> DomainResult<DeviceAlert> {
    let (seq, id, key, kind, title, body, pipeline_id, provider_id, created_at) = row;
    let kind = AlertKind::parse(&kind)
        .ok_or_else(|| DomainError::DatabaseError(format!("Unknown alert kind: {kind}")))?;

    Ok(DeviceAlert {
        seq,
        id,
        key,
        kind,
        title,
        body,
        pipeline_id,
        provider_id,
        created_at,
    })
}

fn alerts(rows: Vec<Row>) -> DomainResult<Vec<DeviceAlert>> {
    rows.into_iter().map(alert).collect()
}

pub struct DeviceAlertRepository {
    pool: DatabasePool,
}

impl DeviceAlertRepository {
    pub fn new(pool: DatabasePool) -> Self {
        Self { pool }
    }

    fn placeholder(&self, index: usize) -> String {
        match &self.pool {
            DatabasePool::Sqlite(_) => "?".to_string(),
            DatabasePool::Postgres(_) => format!("${index}"),
        }
    }

    fn placeholders(&self, count: usize) -> String {
        (1..=count)
            .map(|index| self.placeholder(index))
            .collect::<Vec<_>>()
            .join(", ")
    }

    pub async fn insert(&self, input: &NewDeviceAlert) -> DomainResult<DeviceAlert> {
        let sql = format!(
            "INSERT INTO device_alerts (id, alert_key, kind, title, body, pipeline_id, provider_id, created_at)
             VALUES ({}) RETURNING {COLUMNS}",
            self.placeholders(8)
        );
        let id = new_alert_id();
        let row = on_pool!(&self.pool, p => sqlx::query_as::<_, Row>(sqlx::AssertSqlSafe(sql))
            .bind(&id)
            .bind(&input.key)
            .bind(input.kind.as_str())
            .bind(&input.title)
            .bind(&input.body)
            .bind(input.pipeline_id.as_deref())
            .bind(input.provider_id)
            .bind(Utc::now().trunc_subsecs(6))
            .fetch_one(p)
            .await)
        .map_err(db_error)?;

        if let Err(error) = self.prune().await {
            tracing::warn!(%error, "Failed to prune old device alerts");
        }

        alert(row)
    }

    pub async fn prune(&self) -> DomainResult<u64> {
        let sql = format!(
            "DELETE FROM device_alerts
             WHERE created_at < {} OR seq <= (SELECT MAX(seq) FROM device_alerts) - {MAX_ROWS}",
            self.placeholder(1)
        );
        on_pool!(&self.pool, p => sqlx::query(sqlx::AssertSqlSafe(sql))
            .bind(cutoff())
            .execute(p)
            .await
            .map(|result| result.rows_affected()))
        .map_err(db_error)
    }

    pub async fn after(&self, after: i64, limit: i64) -> DomainResult<Vec<DeviceAlert>> {
        let sql = format!(
            "SELECT {COLUMNS} FROM device_alerts
             WHERE seq > {} AND kind <> 'test' AND created_at >= {}
             ORDER BY seq ASC LIMIT {}",
            self.placeholder(1),
            self.placeholder(2),
            self.placeholder(3)
        );
        let rows = on_pool!(&self.pool, p => sqlx::query_as::<_, Row>(sqlx::AssertSqlSafe(sql))
            .bind(after)
            .bind(cutoff())
            .bind(limit)
            .fetch_all(p)
            .await)
        .map_err(db_error)?;

        alerts(rows)
    }

    pub async fn latest_seq(&self) -> DomainResult<i64> {
        let sql = format!(
            "SELECT COALESCE(MAX(seq), 0) FROM device_alerts WHERE created_at >= {}",
            self.placeholder(1)
        );
        on_pool!(&self.pool, p => sqlx::query_scalar::<_, i64>(sqlx::AssertSqlSafe(sql))
            .bind(cutoff())
            .fetch_one(p)
            .await)
        .map_err(db_error)
    }

    pub async fn get(&self, id: &str) -> DomainResult<Option<DeviceAlert>> {
        let sql = format!(
            "SELECT {COLUMNS} FROM device_alerts WHERE id = {} AND created_at >= {}",
            self.placeholder(1),
            self.placeholder(2)
        );
        let row = on_pool!(&self.pool, p => sqlx::query_as::<_, Row>(sqlx::AssertSqlSafe(sql))
            .bind(id)
            .bind(cutoff())
            .fetch_optional(p)
            .await)
        .map_err(db_error)?;

        row.map(alert).transpose()
    }

    pub async fn list(&self) -> DomainResult<Vec<DeviceAlert>> {
        let sql = format!("SELECT {COLUMNS} FROM device_alerts ORDER BY seq");
        let rows = on_pool!(&self.pool, p => sqlx::query_as::<_, Row>(sqlx::AssertSqlSafe(sql))
            .fetch_all(p)
            .await)
        .map_err(db_error)?;

        alerts(rows)
    }

    pub async fn import(&self, imported: &[DeviceAlert]) -> DomainResult<()> {
        let sql = format!(
            "INSERT INTO device_alerts ({COLUMNS}) VALUES ({}) ON CONFLICT DO NOTHING",
            self.placeholders(9)
        );
        for alert in imported {
            on_pool!(&self.pool, p => insert_with_seq!(sql, alert, p)).map_err(db_error)?;
        }

        self.sync_sequence().await
    }

    pub async fn merge(&self, incoming: &[DeviceAlert]) -> DomainResult<()> {
        if incoming.is_empty() {
            return Ok(());
        }

        let mut incoming: Vec<&DeviceAlert> = incoming.iter().collect();
        incoming.sort_by_key(|alert| alert.seq);
        let highest_incoming = incoming.iter().map(|alert| alert.seq).max().unwrap_or(0);
        let highest = "SELECT COALESCE(MAX(seq), 0) FROM device_alerts";
        let by_id = format!(
            "SELECT seq FROM device_alerts WHERE id = {}",
            self.placeholder(1)
        );
        let by_seq = format!(
            "SELECT seq FROM device_alerts WHERE seq = {}",
            self.placeholder(1)
        );
        let relocate = format!(
            "UPDATE device_alerts SET seq = {} WHERE seq = {}",
            self.placeholder(1),
            self.placeholder(2)
        );
        let insert = format!(
            "INSERT INTO device_alerts ({COLUMNS}) VALUES ({})",
            self.placeholders(9)
        );

        on_pool!(&self.pool, p => async {
            let mut tx = p.begin().await?;
            let mut spare = sqlx::query_scalar::<_, i64>(highest)
                .fetch_one(&mut *tx)
                .await?
                .max(highest_incoming);
            for alert in &incoming {
                let known = sqlx::query_scalar::<_, i64>(sqlx::AssertSqlSafe(by_id.clone()))
                    .bind(&alert.id)
                    .fetch_optional(&mut *tx)
                    .await?;
                if known.is_some() {
                    continue;
                }

                let taken = sqlx::query_scalar::<_, i64>(sqlx::AssertSqlSafe(by_seq.clone()))
                    .bind(alert.seq)
                    .fetch_optional(&mut *tx)
                    .await?;
                if taken.is_some() {
                    spare += 1;
                    sqlx::query(sqlx::AssertSqlSafe(relocate.clone()))
                        .bind(spare)
                        .bind(alert.seq)
                        .execute(&mut *tx)
                        .await?;
                }

                insert_with_seq!(insert, alert, &mut *tx)?;
            }
            tx.commit().await
        }
        .await)
        .map_err(db_error)?;

        self.sync_sequence().await
    }

    async fn sync_sequence(&self) -> DomainResult<()> {
        if let DatabasePool::Postgres(p) = &self.pool {
            sqlx::query(
                "SELECT setval(pg_get_serial_sequence('device_alerts', 'seq'),
                               (SELECT COALESCE(MAX(seq), 1) FROM device_alerts))",
            )
            .execute(p)
            .await
            .map_err(db_error)?;
        }

        Ok(())
    }

    pub async fn delete_all(&self) -> DomainResult<u64> {
        let sql = "DELETE FROM device_alerts";
        on_pool!(&self.pool, p => sqlx::query(sql)
            .execute(p)
            .await
            .map(|result| result.rows_affected()))
        .map_err(db_error)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::infrastructure::database::init_database;

    fn new_alert(key: &str, kind: AlertKind) -> NewDeviceAlert {
        NewDeviceAlert {
            key: key.to_string(),
            kind,
            title: format!("{key} title"),
            body: "body".to_string(),
            pipeline_id: Some(key.to_string()),
            provider_id: Some(7),
        }
    }

    async fn repository(dir: &std::path::Path, name: &str) -> DeviceAlertRepository {
        DeviceAlertRepository::new(DatabasePool::Sqlite(
            init_database(dir.join(name)).await.unwrap(),
        ))
    }

    #[tokio::test]
    async fn sqlite_alerts_page_by_sequence_and_hide_test_alerts() {
        let dir = tempfile::tempdir().unwrap();
        let repository = repository(dir.path(), "alerts.db").await;
        assert_eq!(repository.latest_seq().await.unwrap(), 0);

        let first = repository
            .insert(&new_alert("a", AlertKind::Failed))
            .await
            .unwrap();
        let test = repository
            .insert(&new_alert("t", AlertKind::Test))
            .await
            .unwrap();
        let last = repository
            .insert(&new_alert("b", AlertKind::LongRun))
            .await
            .unwrap();

        assert_eq!((first.seq, test.seq, last.seq), (1, 2, 3));
        assert_eq!(first.id.len(), 32);
        assert_eq!(repository.latest_seq().await.unwrap(), 3);
        assert_eq!(
            repository.after(0, 10).await.unwrap(),
            vec![first.clone(), last.clone()]
        );
        assert_eq!(repository.after(1, 10).await.unwrap(), vec![last.clone()]);
        assert_eq!(repository.after(0, 1).await.unwrap(), vec![first.clone()]);
        assert_eq!(repository.get(&test.id).await.unwrap(), Some(test));
        assert_eq!(repository.get("missing").await.unwrap(), None);
    }

    #[tokio::test]
    async fn sqlite_expired_alerts_are_invisible_before_they_are_pruned() {
        let dir = tempfile::tempdir().unwrap();
        let repository = repository(dir.path(), "expired.db").await;
        let old = repository
            .insert(&new_alert("old", AlertKind::Failed))
            .await
            .unwrap();
        let fresh = repository
            .insert(&new_alert("fresh", AlertKind::Failed))
            .await
            .unwrap();
        let pool = match &repository.pool {
            DatabasePool::Sqlite(pool) => pool,
            DatabasePool::Postgres(_) => unreachable!(),
        };
        sqlx::query("UPDATE device_alerts SET created_at = ? WHERE seq = ?")
            .bind((Utc::now() - Duration::days(8)).to_rfc3339())
            .bind(old.seq)
            .execute(pool)
            .await
            .unwrap();

        assert_eq!(repository.after(0, 10).await.unwrap(), vec![fresh.clone()]);
        assert_eq!(repository.get(&old.id).await.unwrap(), None);
        assert_eq!(
            repository.get(&fresh.id).await.unwrap(),
            Some(fresh.clone())
        );
        assert_eq!(repository.latest_seq().await.unwrap(), fresh.seq);
        assert_eq!(repository.list().await.unwrap().len(), 2);

        assert_eq!(repository.prune().await.unwrap(), 1);
        assert_eq!(repository.list().await.unwrap(), vec![fresh]);

        sqlx::query("UPDATE device_alerts SET created_at = ?")
            .bind((Utc::now() - Duration::days(8)).to_rfc3339())
            .execute(pool)
            .await
            .unwrap();
        assert_eq!(repository.latest_seq().await.unwrap(), 0);
    }

    #[tokio::test]
    async fn sqlite_alerts_keep_at_most_500_rows_and_drop_week_old_ones() {
        let dir = tempfile::tempdir().unwrap();
        let repository = repository(dir.path(), "prune.db").await;
        for index in 0..505 {
            repository
                .insert(&new_alert(&format!("p{index}"), AlertKind::Failed))
                .await
                .unwrap();
        }

        let kept = repository.list().await.unwrap();
        assert_eq!(kept.len(), 500);
        assert_eq!(kept[0].seq, 6);
        assert_eq!(kept[499].seq, 505);

        let pool = match &repository.pool {
            DatabasePool::Sqlite(pool) => pool,
            DatabasePool::Postgres(_) => unreachable!(),
        };
        let old = (Utc::now() - Duration::days(8)).to_rfc3339();
        sqlx::query("UPDATE device_alerts SET created_at = ? WHERE seq <= 10")
            .bind(old)
            .execute(pool)
            .await
            .unwrap();
        repository
            .insert(&new_alert("fresh", AlertKind::Failed))
            .await
            .unwrap();

        let kept = repository.list().await.unwrap();
        assert_eq!(kept.len(), 496);
        assert_eq!(kept[0].seq, 11);
    }

    async fn assert_import_keeps_sequence(
        source: &DeviceAlertRepository, target: &DeviceAlertRepository,
    ) {
        source.delete_all().await.unwrap();
        target.delete_all().await.unwrap();
        for key in ["a", "b", "c"] {
            source
                .insert(&new_alert(key, AlertKind::Failed))
                .await
                .unwrap();
        }
        let exported = source.list().await.unwrap();

        target.import(&exported).await.unwrap();
        target.import(&exported).await.unwrap();

        assert_eq!(target.list().await.unwrap(), exported);
        let next = target
            .insert(&new_alert("d", AlertKind::Failed))
            .await
            .unwrap();
        assert_eq!(next.seq, exported.last().unwrap().seq + 1);
    }

    #[tokio::test]
    async fn sqlite_imported_alerts_keep_their_sequence_and_the_next_insert_follows() {
        let dir = tempfile::tempdir().unwrap();
        let source = repository(dir.path(), "source.db").await;
        let target = repository(dir.path(), "target.db").await;
        for key in ["x", "y"] {
            source
                .insert(&new_alert(key, AlertKind::Failed))
                .await
                .unwrap();
        }
        source.delete_all().await.unwrap();

        assert_import_keeps_sequence(&source, &target).await;
        let kept = source.list().await.unwrap();
        assert_eq!(kept.first().map(|alert| alert.seq), Some(3));
        assert_eq!(target.delete_all().await.unwrap(), 4);
    }

    fn stored(seq: i64, id: &str) -> DeviceAlert {
        DeviceAlert {
            seq,
            id: id.to_string(),
            key: id.to_string(),
            kind: AlertKind::Failed,
            title: format!("{id} title"),
            body: "body".to_string(),
            pipeline_id: None,
            provider_id: None,
            created_at: chrono::SubsecRound::trunc_subsecs(Utc::now(), 0),
        }
    }

    fn seqs(alerts: &[DeviceAlert]) -> Vec<(i64, &str)> {
        alerts
            .iter()
            .map(|alert| (alert.seq, alert.id.as_str()))
            .collect()
    }

    async fn assert_merge_keeps_target_alerts_for_an_empty_source(target: &DeviceAlertRepository) {
        target.delete_all().await.unwrap();
        target
            .import(&[stored(1, "a"), stored(2, "b")])
            .await
            .unwrap();
        let before = target.list().await.unwrap();

        target.merge(&[]).await.unwrap();

        assert_eq!(target.list().await.unwrap(), before);
    }

    async fn assert_merge_skips_alerts_the_target_already_has(target: &DeviceAlertRepository) {
        target.delete_all().await.unwrap();
        let source = [stored(1, "a"), stored(2, "b")];
        target.import(&source).await.unwrap();
        target.import(&[stored(3, "c")]).await.unwrap();
        let before = target.list().await.unwrap();

        target.merge(&source).await.unwrap();
        target.merge(&[stored(9, "b")]).await.unwrap();

        assert_eq!(target.list().await.unwrap(), before);
    }

    async fn assert_merge_moves_colliding_target_alerts(target: &DeviceAlertRepository) {
        target.delete_all().await.unwrap();
        target
            .import(&[stored(1, "t1"), stored(2, "t2"), stored(3, "t3")])
            .await
            .unwrap();

        target
            .merge(&[stored(5, "s5"), stored(2, "s2"), stored(3, "s3")])
            .await
            .unwrap();

        let merged = target.list().await.unwrap();
        let expected = vec![
            (1, "t1"),
            (2, "s2"),
            (3, "s3"),
            (5, "s5"),
            (6, "t2"),
            (7, "t3"),
        ];
        assert_eq!(seqs(&merged), expected);
        for (seq, id) in expected {
            assert_eq!(target.get(id).await.unwrap().map(|a| a.seq), Some(seq));
        }

        let next = target
            .insert(&new_alert("next", AlertKind::Failed))
            .await
            .unwrap();
        assert_eq!(next.seq, 8);
    }

    #[tokio::test]
    async fn sqlite_merge_keeps_target_alerts_for_an_empty_source() {
        let dir = tempfile::tempdir().unwrap();
        let target = repository(dir.path(), "empty.db").await;

        assert_merge_keeps_target_alerts_for_an_empty_source(&target).await;
    }

    #[tokio::test]
    async fn sqlite_merge_skips_alerts_the_target_already_has() {
        let dir = tempfile::tempdir().unwrap();
        let target = repository(dir.path(), "known.db").await;

        assert_merge_skips_alerts_the_target_already_has(&target).await;
    }

    #[tokio::test]
    async fn sqlite_merge_moves_colliding_target_alerts_above_both_sets() {
        let dir = tempfile::tempdir().unwrap();
        let target = repository(dir.path(), "collide.db").await;

        assert_merge_moves_colliding_target_alerts(&target).await;
    }

    #[cfg(feature = "postgres")]
    #[tokio::test]
    #[ignore = "requires TEST_DATABASE_URL"]
    async fn postgres_imports_and_merges_keep_sequences_and_the_next_insert_follows() {
        let url = std::env::var("TEST_DATABASE_URL")
            .expect("TEST_DATABASE_URL must be set to run the PostgreSQL tests");
        let pool = crate::infrastructure::database::init_postgres_database(&url)
            .await
            .unwrap();
        let dir = tempfile::tempdir().unwrap();
        let source = repository(dir.path(), "source.db").await;
        let target = DeviceAlertRepository::new(DatabasePool::Postgres(pool));

        assert_import_keeps_sequence(&source, &target).await;
        assert_merge_keeps_target_alerts_for_an_empty_source(&target).await;
        assert_merge_skips_alerts_the_target_already_has(&target).await;
        assert_merge_moves_colliding_target_alerts(&target).await;
    }
}