timesource 0.1.3

Event sourcing with TimescaleDb
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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
mod common;

use chrono::Utc;
use futures::StreamExt;
use timesource::consumer::store::ConsumerStore;
use timesource::consumer::{ConsumerBuilder, RootConsumerStore};
use timesource::repository::Repository;
use timesource::store::{CommitOrder, EventStore, EventStoreBuilder};
use timesource::Aggregate;
use tokio::task::yield_now;
use uuid::Uuid;

use crate::common::data::{
    bootstrap_test, bootstrap_test_cbor, sample_cbor_commands, sample_cbor_events, sample_commands,
    sample_events, sample_events_uncommitted, TestData, DSN,
};
use crate::common::order::{OrderAggregate, OrderCommand, OrderEvent};
use crate::common::user_cbor::{UserCommand, UserEvent};

#[macro_use]
extern crate test_case;

///
/// AGGREGATE
///

#[tokio::test]
async fn consumer_should_fetch_prior_json_events_on_resume() {
    let TestData {
        aggregate_id,
        repository,
        mut root,
        consumer,
        ..
    } = bootstrap_test(false).await;

    //
    // Append event before resuming consumer
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Check it is ready for consumption
    //

    let mut stream = consumer.resume().await.expect("should resume consumer");

    let message = stream.next().await.unwrap().unwrap();

    assert_eq!(message.aggregate_id(), aggregate_id);
    assert_eq!(message.into_data(), OrderEvent::Created);
}

#[tokio::test]
async fn consumer_should_fetch_prior_cbor_events_on_resume() {
    let TestData {
        aggregate_id,
        repository,
        mut root,
        consumer,
        ..
    } = bootstrap_test_cbor(false).await;

    //
    // Append event before resuming consumer
    //
    root.handle(UserCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Check it is ready for consumption
    //

    let mut stream = consumer.resume().await.expect("should resume consumer");

    let message = stream.next().await.unwrap().unwrap();

    assert_eq!(message.aggregate_id(), aggregate_id);
    assert_eq!(message.into_data(), UserEvent::Created);
}

#[tokio::test]
async fn consumer_should_stream_json_events_after_notification() {
    let TestData {
        aggregate_id,
        repository,
        mut root,
        consumer,
        ..
    } = bootstrap_test(false).await;

    // start stream before messages are published
    let mut stream = consumer.resume().await.expect("should resume consumer");

    //
    // Append all kinds of events
    // Here we test JSON representation of different types
    //
    for command in sample_commands() {
        root.handle(command)
            .expect("Should be able to submit command");
    }

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Check message for first aggregate is ready for consumption
    //
    for event in sample_events() {
        let message = stream.next().await.unwrap().unwrap();

        assert_eq!(message.aggregate_id(), aggregate_id);
        assert_eq!(message.into_data(), event);
    }
}

#[tokio::test]
async fn consumer_should_stream_events_for_different_roots_after_notification() {
    let TestData {
        aggregate_id,
        repository,
        mut root,
        consumer,
        ..
    } = bootstrap_test(false).await;

    // start stream before messages are published
    let mut stream = consumer.resume().await.expect("should resume consumer");

    //
    // Append event
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Check message for first aggregate is ready for consumption
    //
    let message = stream.next().await.unwrap().unwrap();

    assert_eq!(message.aggregate_id(), aggregate_id);
    assert_eq!(message.into_data(), OrderEvent::Created);

    //
    // Now publish events for a new root
    //
    let mut root2 = OrderAggregate::root();
    root2
        .handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root2)
        .await
        .expect("Should be able to commit root");

    let message = stream.next().await.unwrap().unwrap();

    assert_eq!(message.aggregate_id(), root2.id());
    assert_eq!(message.into_data(), OrderEvent::Created);
}

#[tokio::test]
async fn consumer_should_stream_cbor_events_after_notification() {
    let TestData {
        aggregate_id,
        repository,
        mut root,
        consumer,
        ..
    } = bootstrap_test_cbor(false).await;

    // start stream before messages are published
    let mut stream = consumer.resume().await.expect("should resume consumer");

    //
    // Append all kinds of events
    // Here we test JSON representation of different types
    //
    for command in sample_cbor_commands() {
        root.handle(command)
            .expect("Should be able to submit command");
    }

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Check message for first aggregate is ready for consumption
    //
    for event in sample_cbor_events() {
        let message = stream.next().await.unwrap().unwrap();

        assert_eq!(message.aggregate_id(), aggregate_id);
        assert_eq!(message.into_data(), event);
    }
}

#[tokio::test]
async fn it_should_recover_if_postgres_notifications_buffer_gets_full() {
    let TestData {
        aggregate_type_name,
        consumer_name,
        ..
    } = bootstrap_test(false).await;
    let store = EventStoreBuilder::new(DSN)
        .build::<OrderEvent>(&aggregate_type_name)
        .await
        .expect("store to be created");

    let events1 = sample_events_uncommitted();
    let events2 = sample_events_uncommitted();
    let events3 = sample_events_uncommitted();

    //
    // Setup consumer with very limited capacity for buffers
    //
    let consumer = ConsumerBuilder::new(DSN)
        .with_notification_buffer_capacity(1)
        .with_event_buffer_capacity(events1.len() - 1)
        .aggregate_build::<OrderEvent>(consumer_name.into(), &aggregate_type_name)
        .await
        .unwrap();

    // start stream before messages are published
    let stream = consumer.resume().await.expect("should resume consumer");

    //
    // Append events and fill buffers
    //
    let aggregate_id = Uuid::new_v4();

    // this notification should be consumed as the first one ok
    store
        .commit(aggregate_id, CommitOrder::None, &events1)
        .await
        .expect("Failed appending events");

    // this notification should make notification buffer congested
    store
        .commit(aggregate_id, CommitOrder::None, &events2)
        .await
        .expect("Failed appending events");

    // this notification should await until buffers' congestion eases
    store
        .commit(aggregate_id, CommitOrder::None, &events3)
        .await
        .expect("Failed appending events");

    // buffer backpressure should be applied
    yield_now().await;

    let received = stream.take(9).map(|x| x.unwrap()).collect::<Vec<_>>().await;

    assert_eq!(received.len(), 9, "It should receive all events");
}

///
/// AGGREGATE ROOT
///

#[tokio::test]
async fn root_store_should_return_queries() {
    let TestData {
        repository,
        mut root,
        aggregate_type_name,
        consumer_root_name,
        aggregate_type_id,
        pool,
        ..
    } = bootstrap_test(false).await;

    //
    // Append events for root 1
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Append events for root 2
    //
    let store = EventStoreBuilder::new(DSN)
        .build::<OrderEvent>(&aggregate_type_name)
        .await
        .expect("store to be created");
    let repository = Repository::new(store);
    let mut root2 = OrderAggregate::root();
    root2
        .handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root2)
        .await
        .expect("Should be able to commit root");

    let store = RootConsumerStore::<OrderEvent>::new(
        root2.id(),
        aggregate_type_id,
        consumer_root_name.into(),
        pool.clone(),
    );

    let events_after_offset = store.events_after_offset().collect::<Vec<_>>().await;
    assert_eq!(
        events_after_offset.len(),
        1,
        "should only return events after offset 2"
    );
    let event = events_after_offset[0].as_ref().unwrap();
    let offset = event.id();

    //
    // Append more events for root 1
    //
    root.handle(OrderCommand::Cancel).unwrap();
    repository.commit_orderly(&mut root).await.unwrap();

    let events_after = store.events_after(offset).collect::<Vec<_>>().await;
    assert_eq!(
        events_after.len(),
        0,
        "only one event for root2 has been stored"
    );

    //
    // Append more events for root 2
    //
    root2.handle(OrderCommand::Cancel).unwrap();
    repository.commit_orderly(&mut root2).await.unwrap();

    let events_after = store.events_after(offset).collect::<Vec<_>>().await;
    assert_eq!(events_after.len(), 1, "should return event after first one");

    let events_range = store
        .events_range(offset, Utc::now().timestamp_nanos() as u64)
        .collect::<Vec<_>>()
        .await;
    assert_eq!(
        events_range.len(),
        1,
        "should return range after first one for root only"
    );
}

#[tokio::test]
async fn should_consume_prior_root_events_only() {
    let TestData {
        repository,
        mut root,
        aggregate_type_name,
        consumer_root_name,
        ..
    } = bootstrap_test(false).await;

    //
    // Append events for root 1
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Append events for root 2
    //
    let store = EventStoreBuilder::new(DSN)
        .build::<OrderEvent>(&aggregate_type_name)
        .await
        .expect("store to be created");
    let repository = Repository::new(store);
    let mut root2 = OrderAggregate::root();
    root2
        .handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root2)
        .await
        .expect("Should be able to commit root");

    //
    // Should only consume root2 events
    //

    let consumer = ConsumerBuilder::new(DSN)
        .aggregate_root_build::<OrderEvent>(
            consumer_root_name.clone().into(),
            &aggregate_type_name,
            root2.id(),
        )
        .await
        .unwrap();

    let mut stream = consumer.resume().await.expect("should resume consumer");

    let message = stream.next().await.unwrap().unwrap();

    assert_eq!(message.aggregate_id(), root2.id());
}

#[tokio::test]
async fn should_get_notified_for_root_events_only() {
    let TestData {
        repository,
        mut root,
        aggregate_type_name,
        consumer_root_name,
        ..
    } = bootstrap_test(false).await;

    let mut root2 = OrderAggregate::root();
    root2
        .handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    let consumer = ConsumerBuilder::new(DSN)
        .aggregate_root_build::<OrderEvent>(
            consumer_root_name.clone().into(),
            &aggregate_type_name,
            root2.id(),
        )
        .await
        .unwrap();

    let mut stream = consumer.resume().await.expect("should resume consumer");

    //
    // Append events for root 1
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    //
    // Append events for root 2
    //
    repository
        .commit_orderly(&mut root2)
        .await
        .expect("Should be able to commit root");

    //
    // Should only consume root2 events
    //

    let first_message = stream.next().await.unwrap().unwrap();

    assert_eq!(first_message.aggregate_id(), root2.id());
}

///
/// CHECKPOINTS
///

#[test_case(false ; "aggregate")]
#[test_case(true ; "aggregate_root")]
#[tokio::test]
async fn handles_checkpoints_ok(root_case: bool) {
    let TestData {
        repository,
        mut root,
        consumer_root,
        consumer,
        consumer_name,
        consumer_root_name,
        pool,
        aggregate_type_name,
        ..
    } = bootstrap_test(false).await;

    let mut stream = if root_case {
        consumer_root
            .resume()
            .await
            .expect("should resume consumer")
    } else {
        consumer.resume().await.expect("should resume consumer")
    };
    let consumer_name = if root_case {
        consumer_root_name
    } else {
        consumer_name
    };

    //
    // Append event
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let message = stream.next().await.unwrap().unwrap();

    if root_case {
        consumer_root.ack(message.id()).await.unwrap();
    } else {
        consumer.ack(message.id()).await.unwrap();
    }

    let saved_offset =
        sqlx::query_file_scalar!("tests/queries/consumer_offset.sql", &consumer_name)
            .fetch_one(&pool)
            .await
            .unwrap();

    assert_eq!(message.id(), saved_offset.unwrap() as u64);

    //
    // Simulate another consumer
    //

    let consumer_2 = ConsumerBuilder::new(DSN)
        .aggregate_build::<OrderEvent>(consumer_name.clone().into(), &aggregate_type_name)
        .await
        .unwrap();

    let mut stream_2 = consumer_2.resume().await.expect("should resume consumer");

    //
    // Append another event
    //
    root.handle(OrderCommand::Cancel)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let message = stream_2.next().await.unwrap().unwrap().into_data();

    assert_eq!(
        message,
        OrderEvent::Cancelled,
        "should deliver next message after offset"
    );
}

#[test_case(false ; "aggregate")]
#[test_case(true ; "aggregate_root")]
#[tokio::test]
async fn it_should_save_last_checkpoint(root_case: bool) {
    let TestData {
        repository,
        mut root,
        consumer,
        consumer_root,
        consumer_name,
        consumer_root_name,
        pool,
        ..
    } = bootstrap_test(false).await;

    let stream = if root_case {
        consumer_root
            .resume()
            .await
            .expect("should resume consumer")
    } else {
        consumer.resume().await.expect("should resume consumer")
    };

    let consumer_name = if root_case {
        consumer_root_name
    } else {
        consumer_name
    };

    //
    // Append event
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");
    root.handle(OrderCommand::Cancel)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let messages = stream.take(2).collect::<Vec<_>>().await;
    let last_message = messages.last().unwrap().as_ref().unwrap();

    if root_case {
        consumer_root.ack(last_message.id()).await.unwrap();
    } else {
        consumer.ack(last_message.id()).await.unwrap();
    }

    let saved_offset =
        sqlx::query_file_scalar!("tests/queries/consumer_offset.sql", &consumer_name)
            .fetch_one(&pool)
            .await
            .unwrap();

    assert_eq!(last_message.id(), saved_offset.unwrap() as u64);
}

#[test_case(false ; "aggregate")]
#[test_case(true ; "aggregate_root")]
#[tokio::test]
async fn it_should_handle_first_try_ack(root_case: bool) {
    let TestData {
        repository,
        mut root,
        consumer,
        consumer_root,
        consumer_name,
        consumer_root_name,
        pool,
        ..
    } = bootstrap_test(false).await;

    let mut stream = if root_case {
        consumer_root
            .resume()
            .await
            .expect("should resume consumer")
    } else {
        consumer.resume().await.expect("should resume consumer")
    };

    let consumer_name = if root_case {
        consumer_root_name
    } else {
        consumer_name
    };

    //
    // Append event
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let message = stream.next().await.unwrap().unwrap();

    if root_case {
        consumer_root.ack(message.id()).await.unwrap();
    } else {
        consumer.ack(message.id()).await.unwrap();
    }

    let saved_offset =
        sqlx::query_file_scalar!("tests/queries/consumer_offset.sql", &consumer_name)
            .fetch_one(&pool)
            .await
            .unwrap();

    assert_eq!(message.id(), saved_offset.unwrap() as u64);
}

#[test_case(false ; "aggregate")]
#[test_case(true ; "aggregate_root")]
#[tokio::test]
#[should_panic(expected = "checkpoint out of order")]
async fn it_should_return_err_for_out_of_order_try_ack(root_case: bool) {
    let TestData {
        repository,
        mut root,
        consumer,
        consumer_root,
        ..
    } = bootstrap_test(false).await;

    let stream = if root_case {
        consumer_root
            .resume()
            .await
            .expect("should resume consumer")
    } else {
        consumer.resume().await.expect("should resume consumer")
    };

    //
    // Append event
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");
    root.handle(OrderCommand::Cancel)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let messages = stream.take(2).collect::<Vec<_>>().await;
    let last_message = messages.last().unwrap().as_ref().unwrap();

    consumer.try_ack(last_message.id()).await.unwrap();
}

#[test_case(false ; "aggregate")]
#[test_case(true ; "aggregate_root")]
#[tokio::test]
#[should_panic(expected = "checkpoint behind current offset")]
async fn it_should_return_err_for_already_submitted_checkpoint(root_case: bool) {
    let TestData {
        repository,
        mut root,
        consumer,
        consumer_root,
        ..
    } = bootstrap_test(false).await;

    let mut stream = if root_case {
        consumer_root
            .resume()
            .await
            .expect("should resume consumer")
    } else {
        consumer.resume().await.expect("should resume consumer")
    };

    //
    // Append event
    //
    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");
    root.handle(OrderCommand::Cancel)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let first = stream.next().await.unwrap().unwrap();
    let last = stream.next().await.unwrap().unwrap();

    consumer.try_ack(first.id()).await.unwrap();

    consumer.try_ack(last.id()).await.unwrap();

    consumer.try_ack(first.id()).await.unwrap();
}

#[test_case(false ; "aggregate")]
#[test_case(true ; "aggregate_root")]
#[tokio::test]
#[should_panic(
    expected = "update or delete on table aggregate_consumer violates foreign key constraint"
)]
async fn it_should_return_err_for_non_existent_offset_when_trying_checkpoint(root_case: bool) {
    let TestData {
        repository,
        mut root,
        consumer,
        consumer_root,
        ..
    } = bootstrap_test(false).await;

    let mut stream = if root_case {
        consumer_root
            .resume()
            .await
            .expect("should resume consumer")
    } else {
        consumer.resume().await.expect("should resume consumer")
    };

    root.handle(OrderCommand::Create)
        .expect("Should be able to submit command");

    repository
        .commit_orderly(&mut root)
        .await
        .expect("Should be able to commit root");

    let event = stream.next().await.unwrap().unwrap();

    consumer.try_ack(event.id() + 1).await.unwrap();
}