event-store-adapter-rs 0.2.30

crate to make DynamoDB an Event Store
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
use std::fmt::Debug;
use std::sync::Arc;

use async_trait::async_trait;
use aws_sdk_dynamodb::error::SdkError;
use aws_sdk_dynamodb::operation::transact_write_items::{TransactWriteItemsError, TransactWriteItemsOutput};
use aws_sdk_dynamodb::primitives::Blob;
use aws_sdk_dynamodb::types::{AttributeValue, DeleteRequest, Put, Select, TransactWriteItem, Update, WriteRequest};
use aws_sdk_dynamodb::Client;
use chrono::{Duration, Utc};

use crate::key_resolver::{DefaultKeyResolver, KeyResolver};
use crate::serializer::{EventSerializer, SnapshotSerializer};
use crate::types::{Aggregate, AggregateId, Event, EventStore, EventStoreReadError, EventStoreWriteError};

/// Event Store for DynamoDB
#[derive(Debug, Clone)]
pub struct EventStoreForDynamoDB<AID: AggregateId, A: Aggregate, E: Event> {
  client: Client,
  journal_table_name: String,
  journal_aid_index_name: String,
  snapshot_table_name: String,
  snapshot_aid_index_name: String,
  shard_count: u64,
  keep_snapshot_count: Option<usize>,
  delete_ttl: Option<Duration>,
  key_resolver: Arc<dyn KeyResolver<ID = AID>>,
  event_serializer: Arc<dyn EventSerializer<E>>,
  snapshot_serializer: Arc<dyn SnapshotSerializer<A>>,
}

unsafe impl<AID: AggregateId, A: Aggregate, E: Event> Sync for EventStoreForDynamoDB<AID, A, E> {}
unsafe impl<AID: AggregateId, A: Aggregate, E: Event> Send for EventStoreForDynamoDB<AID, A, E> {}

#[async_trait]
impl<AID: AggregateId, A: Aggregate<ID = AID>, E: Event<AggregateID = AID>> EventStore
  for EventStoreForDynamoDB<AID, A, E>
{
  type AG = A;
  type AID = AID;
  type EV = E;

  async fn get_latest_snapshot_by_id(&self, aid: &Self::AID) -> Result<Option<Self::AG>, EventStoreReadError> {
    let response = self
      .client
      .query()
      .table_name(self.snapshot_table_name.clone())
      .index_name(self.snapshot_aid_index_name.clone())
      .key_condition_expression("#aid = :aid AND #seq_nr = :seq_nr")
      .expression_attribute_names("#aid", "aid")
      .expression_attribute_names("#seq_nr", "seq_nr")
      .expression_attribute_values(":aid", AttributeValue::S(aid.to_string()))
      .expression_attribute_values(":seq_nr", AttributeValue::N("0".to_string()))
      .limit(1)
      .send()
      .await;
    match response {
      Err(err) => Err(EventStoreReadError::IOError(err.into())),
      Ok(response) => {
        if let Some(items) = response.items {
          if items.is_empty() {
            return Ok(None);
          }
          let payload = items[0].get("payload").unwrap();
          let bytes = payload.as_b().unwrap().clone().into_inner();
          let mut aggregate = *self.snapshot_serializer.deserialize(&bytes)?;
          let version = items[0]
            .get("version")
            .unwrap()
            .as_n()
            .unwrap()
            .parse::<usize>()
            .unwrap();
          let seq_nr = aggregate.seq_nr();
          log::debug!("seq_nr: {}", seq_nr);
          aggregate.set_version(version);
          Ok(Some(aggregate))
        } else {
          Err(EventStoreReadError::OtherError(format!(
            "No snapshot found for aggregate id: {}",
            aid
          )))
        }
      }
    }
  }

  async fn get_events_by_id_since_seq_nr(
    &self,
    aid: &Self::AID,
    seq_nr: usize,
  ) -> Result<Vec<Self::EV>, EventStoreReadError> {
    let response = self
      .client
      .query()
      .table_name(self.journal_table_name.clone())
      .index_name(self.journal_aid_index_name.clone())
      .key_condition_expression("#aid = :aid AND #seq_nr >= :seq_nr")
      .expression_attribute_names("#aid", "aid")
      .expression_attribute_names("#seq_nr", "seq_nr")
      .expression_attribute_values(":aid", AttributeValue::S(aid.to_string()))
      .expression_attribute_values(":seq_nr", AttributeValue::N(seq_nr.to_string()))
      .send()
      .await;
    match response {
      Err(err) => Err(EventStoreReadError::IOError(err.into())),
      Ok(response) => {
        let mut events = Vec::new();
        if let Some(items) = response.items {
          for item in items {
            let payload = item.get("payload").unwrap();
            let bytes = payload.as_b().unwrap().clone().into_inner();
            let event = *self.event_serializer.deserialize(&bytes)?;
            events.push(event);
          }
        }
        Ok(events)
      }
    }
  }

  async fn persist_event(&mut self, event: &Self::EV, version: usize) -> Result<(), EventStoreWriteError> {
    if event.is_created() {
      panic!("Invalid event: {:?}", event);
    }
    self.update_event_and_snapshot_opt(event, version, None).await?;
    self.try_purge_excess_snapshots(event.aggregate_id()).await?;
    Ok(())
  }

  async fn persist_event_and_snapshot(
    &mut self,
    event: &Self::EV,
    aggregate: &Self::AG,
  ) -> Result<(), EventStoreWriteError> {
    if event.is_created() {
      self.create_event_and_snapshot(event, aggregate).await?;
    } else {
      self
        .update_event_and_snapshot_opt(event, aggregate.version(), Some(aggregate))
        .await?;
      self.try_purge_excess_snapshots(event.aggregate_id()).await?;
    }
    Ok(())
  }
}

impl<AID: AggregateId, A: Aggregate<ID = AID>, E: Event<AggregateID = AID>> EventStoreForDynamoDB<AID, A, E> {
  pub fn new(
    client: Client,
    journal_table_name: String,
    journal_aid_index_name: String,
    snapshot_table_name: String,
    snapshot_aid_index_name: String,
    shard_count: u64,
  ) -> Self {
    Self {
      client,
      journal_table_name,
      journal_aid_index_name,
      snapshot_table_name,
      snapshot_aid_index_name,
      shard_count,
      keep_snapshot_count: None,
      delete_ttl: None,
      key_resolver: Arc::new(DefaultKeyResolver::default()),
      event_serializer: Arc::new(crate::serializer::JsonEventSerializer::default()),
      snapshot_serializer: Arc::new(crate::serializer::JsonSnapshotSerializer::default()),
    }
  }

  pub fn with_keep_snapshot_count(mut self, keep_snapshot_count: Option<usize>) -> Self {
    self.keep_snapshot_count = keep_snapshot_count;
    self
  }

  pub fn with_delete_ttl(mut self, delete_ttl: Option<Duration>) -> Self {
    self.delete_ttl = delete_ttl;
    self
  }

  pub fn with_key_resolver(mut self, key_resolver: Arc<dyn KeyResolver<ID = AID>>) -> Self {
    self.key_resolver = key_resolver;
    self
  }

  pub fn with_event_serializer(mut self, event_serializer: Arc<dyn EventSerializer<E>>) -> Self {
    self.event_serializer = event_serializer;
    self
  }

  pub fn with_snapshot_serializer(mut self, snapshot_serializer: Arc<dyn SnapshotSerializer<A>>) -> Self {
    self.snapshot_serializer = snapshot_serializer;
    self
  }

  async fn create_event_and_snapshot(&mut self, event: &E, ar: &A) -> Result<(), EventStoreWriteError> {
    let mut builder = self
      .client
      .transact_write_items()
      .transact_items(
        TransactWriteItem::builder()
          .put(self.put_snapshot(event, 0, ar)?)
          .build(),
      )
      .transact_items(TransactWriteItem::builder().put(self.put_journal(event)?).build());
    if self.keep_snapshot_count.is_some() {
      builder = builder.transact_items(
        TransactWriteItem::builder()
          .put(self.put_snapshot(event, ar.seq_nr(), ar)?)
          .build(),
      );
    }
    let result = builder.send().await;
    Self::write_error_handling(result)
  }

  async fn update_event_and_snapshot_opt(
    &mut self,
    event: &E,
    version: usize,
    ar: Option<&A>,
  ) -> Result<(), EventStoreWriteError> {
    let mut builder = self
      .client
      .transact_write_items()
      .transact_items(
        TransactWriteItem::builder()
          .update(self.update_snapshot(event, 0, version, ar)?)
          .build(),
      )
      .transact_items(TransactWriteItem::builder().put(self.put_journal(event)?).build());
    if let (true, Some(ar)) = (self.keep_snapshot_count.is_some(), ar) {
      builder = builder.transact_items(
        TransactWriteItem::builder()
          .put(self.put_snapshot(event, ar.seq_nr(), ar)?)
          .build(),
      );
    }
    let result = builder.send().await;
    Self::write_error_handling(result)
  }

  fn write_error_handling(
    result: Result<TransactWriteItemsOutput, SdkError<TransactWriteItemsError>>,
  ) -> Result<(), EventStoreWriteError> {
    match result {
      Ok(_) => Ok(()),
      Err(e) => match e.into_service_error() {
        TransactWriteItemsError::TransactionCanceledException(e) => {
          if !e.cancellation_reasons().is_empty() {
            Err(EventStoreWriteError::OptimisticLockError(e))
          } else {
            Err(EventStoreWriteError::IOError(e.into()))
          }
        }
        error => Err(EventStoreWriteError::IOError(error.into())),
      },
    }
  }

  /// Delete excess snapshots
  async fn delete_excess_snapshots(&mut self, aggregate_id: &AID) -> Result<(), EventStoreWriteError> {
    if let Some(keep_snapshot_count) = self.keep_snapshot_count {
      let snapshot_count = self.get_snapshot_count_for_write(aggregate_id).await?;
      let excess_count = snapshot_count - keep_snapshot_count;
      if excess_count > 0 {
        log::debug!("excess_count: {}", excess_count);
        let keys = self
          .get_last_snapshot_keys_for_write(aggregate_id, excess_count)
          .await?;
        log::debug!("keys = {:?}", keys);
        if !keys.is_empty() {
          let request_items = keys
            .into_iter()
            .map(|(pkey, skey)| {
              WriteRequest::builder()
                .delete_request(
                  DeleteRequest::builder()
                    .key("pkey", AttributeValue::S(pkey))
                    .key("skey", AttributeValue::S(skey))
                    .build()
                    .unwrap(),
                )
                .build()
            })
            .collect::<Vec<_>>();
          let result = self
            .client
            .batch_write_item()
            .request_items(self.snapshot_table_name.clone(), request_items)
            .send()
            .await;
          if let Err(err) = result {
            return Err(EventStoreWriteError::IOError(Box::new(err.into_service_error())));
          } else {
            log::debug!("excess snapshots are deleted");
          }
        }
      }
    }
    Ok(())
  }

  /// Update ttl of excess snapshots
  async fn update_ttl_of_excess_snapshots(&mut self, aggregate_id: &AID) -> Result<(), EventStoreWriteError> {
    if let (Some(keep_snapshot_count), Some(delete_ttl)) = (self.keep_snapshot_count, self.delete_ttl) {
      let snapshot_count = self.get_snapshot_count_for_write(aggregate_id).await?;
      let excess_count = snapshot_count - keep_snapshot_count;
      if excess_count > 0 {
        log::debug!("excess_count: {}", excess_count);
        let keys = self
          .get_last_snapshot_keys_for_write(aggregate_id, excess_count)
          .await?;
        log::debug!("keys = {:?}", keys);
        let ttl = (Utc::now() + delete_ttl).timestamp();
        for (pkey, skey) in keys {
          let result = self
            .client
            .update_item()
            .table_name(self.snapshot_table_name.clone())
            .key("pkey", AttributeValue::S(pkey))
            .key("skey", AttributeValue::S(skey))
            .update_expression("SET #ttl=:ttl")
            .expression_attribute_names("#ttl", "ttl")
            .expression_attribute_values(":ttl", AttributeValue::N(ttl.to_string()))
            .send()
            .await;
          if let Err(err) = result {
            return Err(EventStoreWriteError::IOError(err.into()));
          }
        }
      }
    }
    Ok(())
  }

  async fn get_last_snapshot_keys_for_write(
    &mut self,
    aggregate_id: &AID,
    excess_count: usize,
  ) -> Result<Vec<(String, String)>, EventStoreWriteError> {
    match self.get_last_snapshot_keys(aggregate_id, excess_count as i32).await {
      Ok(r) => Ok(r),
      Err(err) => Err(EventStoreWriteError::IOError(err.into())),
    }
  }

  async fn get_snapshot_count_for_write(&mut self, aggregate_id: &AID) -> Result<usize, EventStoreWriteError> {
    match self.get_snapshot_count(aggregate_id).await {
      Ok(r) => Ok(r - 1),
      Err(err) => Err(EventStoreWriteError::IOError(err.into())),
    }
  }

  async fn get_snapshot_count(&mut self, aid: &AID) -> Result<usize, EventStoreReadError> {
    let response = self
      .client
      .query()
      .table_name(self.snapshot_table_name.clone())
      .index_name(self.snapshot_aid_index_name.clone())
      .key_condition_expression("#aid = :aid")
      .expression_attribute_names("#aid", "aid")
      .expression_attribute_values(":aid", AttributeValue::S(aid.to_string()))
      .select(Select::Count)
      .send()
      .await;
    match response {
      Err(err) => Err(EventStoreReadError::IOError(Box::new(err.into_service_error()))),
      Ok(response) => Ok(response.count as usize),
    }
  }

  async fn get_last_snapshot_keys(
    &mut self,
    aid: &AID,
    limit: i32,
  ) -> Result<Vec<(String, String)>, EventStoreReadError> {
    let mut query_builder = self
      .client
      .query()
      .table_name(self.snapshot_table_name.clone())
      .index_name(self.snapshot_aid_index_name.clone())
      .key_condition_expression("#aid = :aid AND #seq_nr > :seq_nr")
      .expression_attribute_names("#aid", "aid")
      .expression_attribute_names("#seq_nr", "seq_nr")
      .expression_attribute_values(":aid", AttributeValue::S(aid.to_string()))
      .expression_attribute_values(":seq_nr", AttributeValue::N(0.to_string()))
      .scan_index_forward(false)
      .limit(limit);
    if self.delete_ttl.is_some() {
      query_builder = query_builder
        .expression_attribute_names("#ttl", "ttl")
        .expression_attribute_values(":ttl", AttributeValue::N(0.to_string()))
        .filter_expression("#ttl = :ttl");
    }
    let response = query_builder.send().await;
    match response {
      Err(err) => Err(EventStoreReadError::IOError(err.into())),
      Ok(response) => {
        if let Some(items) = response.items {
          let mut result = Vec::new();
          for item in items {
            log::debug!("aid: {}", item.get("aid").unwrap().as_s().unwrap());
            log::debug!("seq_nr: {}", item.get("seq_nr").unwrap().as_n().unwrap());
            let pkey = item.get("pkey").unwrap().as_s().unwrap().clone();
            let skey = item.get("skey").unwrap().as_s().unwrap().clone();
            result.push((pkey, skey));
          }
          Ok(result)
        } else {
          Err(EventStoreReadError::OtherError(format!(
            "No snapshot found for aggregate id: {}",
            aid
          )))
        }
      }
    }
  }

  fn put_snapshot(&mut self, event: &E, seq_nr: usize, ar: &A) -> Result<Put, EventStoreWriteError> {
    let pkey = self.resolve_pkey(event.aggregate_id(), self.shard_count);
    let skey = self.resolve_skey(event.aggregate_id(), seq_nr);
    let payload = self.snapshot_serializer.serialize(ar)?;
    log::debug!(">--- put_snapshot ---");
    log::debug!("pkey: {}", pkey);
    log::debug!("skey: {}", skey);
    log::debug!("aid: {}", event.aggregate_id().to_string());
    log::debug!("seq_nr: {}", seq_nr);
    log::debug!("<--- put_snapshot ---");
    let put_snapshot = Put::builder()
      .table_name(self.snapshot_table_name.clone())
      .item("pkey", AttributeValue::S(pkey))
      .item("skey", AttributeValue::S(skey))
      .item("payload", AttributeValue::B(Blob::new(payload)))
      .item("aid", AttributeValue::S(event.aggregate_id().to_string()))
      .item("seq_nr", AttributeValue::N(seq_nr.to_string()))
      .item("version", AttributeValue::N("1".to_string()))
      .item("ttl", AttributeValue::N("0".to_string()))
      .item(
        "last_updated_at",
        AttributeValue::N(event.occurred_at().timestamp_millis().to_string()),
      )
      .condition_expression("attribute_not_exists(pkey) AND attribute_not_exists(skey)");
    let result = put_snapshot.build();
    match result {
      Ok(r) => Ok(r),
      Err(err) => Err(EventStoreWriteError::IOError(err.into())),
    }
  }

  fn update_snapshot(
    &mut self,
    event: &E,
    seq_nr: usize,
    version: usize,
    ar_opt: Option<&A>,
  ) -> Result<Update, EventStoreWriteError> {
    let pkey = self.resolve_pkey(event.aggregate_id(), self.shard_count);
    let skey = self.resolve_skey(event.aggregate_id(), seq_nr);
    log::debug!(">--- update_snapshot ---");
    log::debug!("pkey: {}", pkey);
    log::debug!("skey: {}", skey);
    log::debug!("aid: {}", event.aggregate_id().to_string());
    log::debug!("seq_nr: {}", seq_nr);
    log::debug!("<--- update_snapshot ---");
    let mut update_snapshot = Update::builder()
      .table_name(self.snapshot_table_name.clone())
      .update_expression("SET #version=:after_version, #last_updated_at=:last_updated_at")
      .key("pkey", AttributeValue::S(pkey))
      .key("skey", AttributeValue::S(skey))
      .expression_attribute_names("#version", "version")
      .expression_attribute_names("#last_updated_at", "last_updated_at")
      .expression_attribute_values(":before_version", AttributeValue::N(version.to_string()))
      .expression_attribute_values(":after_version", AttributeValue::N((version + 1).to_string()))
      .expression_attribute_values(
        ":last_updated_at",
        AttributeValue::N(event.occurred_at().timestamp_millis().to_string()),
      )
      .condition_expression("#version=:before_version");
    if let Some(ar) = ar_opt {
      let payload = self.snapshot_serializer.serialize(ar)?;
      update_snapshot = update_snapshot
        .update_expression(
          "SET #payload=:payload, #seq_nr=:seq_nr, #version=:after_version, #last_updated_at=:last_updated_at",
        )
        .expression_attribute_names("#seq_nr", "seq_nr")
        .expression_attribute_names("#payload", "payload")
        .expression_attribute_values(":seq_nr", AttributeValue::N(seq_nr.to_string()))
        .expression_attribute_values(":payload", AttributeValue::B(Blob::new(payload)));
    }
    let result = update_snapshot.build();
    match result {
      Ok(r) => Ok(r),
      Err(err) => Err(EventStoreWriteError::IOError(err.into())),
    }
  }

  fn resolve_pkey(&self, id: &AID, shard_count: u64) -> String {
    self.key_resolver.resolve_partition_key(id, shard_count)
  }

  fn resolve_skey(&self, id: &AID, seq_nr: usize) -> String {
    self.key_resolver.resolve_sort_key(id, seq_nr)
  }

  fn put_journal(&mut self, event: &E) -> Result<Put, EventStoreWriteError> {
    let pkey = self.resolve_pkey(event.aggregate_id(), self.shard_count);
    let skey = self.resolve_skey(event.aggregate_id(), event.seq_nr());
    let aid = event.aggregate_id().to_string();
    let seq_nr = event.seq_nr().to_string();
    let payload = self.event_serializer.serialize(event)?;
    let occurred_at = event.occurred_at().timestamp_millis().to_string();

    let put_journal = Put::builder()
      .table_name(self.journal_table_name.clone())
      .item("pkey", AttributeValue::S(pkey))
      .item("skey", AttributeValue::S(skey))
      .item("aid", AttributeValue::S(aid))
      .item("seq_nr", AttributeValue::N(seq_nr))
      .item("payload", AttributeValue::B(Blob::new(payload)))
      .item("occurred_at", AttributeValue::N(occurred_at))
      .build();
    match put_journal {
      Ok(r) => Ok(r),
      Err(err) => Err(EventStoreWriteError::IOError(err.into())),
    }
  }

  async fn try_purge_excess_snapshots(&mut self, aggregate_id: &AID) -> Result<(), EventStoreWriteError> {
    if self.keep_snapshot_count.is_some() {
      if self.delete_ttl.is_some() {
        self.update_ttl_of_excess_snapshots(aggregate_id).await?;
      } else {
        self.delete_excess_snapshots(aggregate_id).await?;
      }
    }
    Ok(())
  }
}