fixer 0.11.0

A full featured messaging engine for the FIX protocol implemented in Rust
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
use crate::session::session_id::SessionID;
use crate::store::file_store::{FileStore, FileStoreFactory};
#[cfg(feature = "mongo_store")]
use crate::store::mongo_store::{MongoStore, MongoStoreFactory};
#[cfg(feature = "sql_store")]
use crate::store::sql_store::{SqlStore, SqlStoreFactory};
use enum_dispatch::enum_dispatch;
use jiff::Timestamp;
use simple_error::SimpleResult;
use rustc_hash::FxHashMap;
use std::sync::Arc;

pub mod file_store;
#[cfg(feature = "mongo_store")]
pub mod mongo_store;
#[cfg(feature = "sql_store")]
pub mod sql_store;

/// Persistence backend for FIX message sequence numbers and resendable
/// messages.
///
/// Implementations track sender/target sequence numbers, store outgoing
/// messages for potential resend, and support reset/refresh operations.
///
/// Built-in implementations: [`MemoryStore`], [`FileStore`],
/// `SqlStore` (feature `sql_store`),
/// `MongoStore` (feature `mongo_store`).
#[allow(async_fn_in_trait)] // dispatched via enum_dispatch, not used as trait object
#[enum_dispatch]
pub trait MessageStoreTrait {
    async fn next_sender_msg_seq_num(&mut self) -> isize;
    async fn next_target_msg_seq_num(&mut self) -> isize;

    async fn incr_next_sender_msg_seq_num(&mut self) -> SimpleResult<()>;
    async fn incr_next_target_msg_seq_num(&mut self) -> SimpleResult<()>;

    async fn set_next_sender_msg_seq_num(&mut self, next_seq_num: isize) -> SimpleResult<()>;
    async fn set_next_target_msg_seq_num(&mut self, next_seq_num: isize) -> SimpleResult<()>;

    async fn creation_time(&self) -> Timestamp;

    async fn save_message(&mut self, seq_num: isize, msg: Vec<u8>) -> SimpleResult<()>;
    async fn save_message_and_incr_next_sender_msg_seq_num(
        &mut self,
        seq_num: isize,
        msg: Vec<u8>,
    ) -> SimpleResult<()>;
    async fn get_messages(
        &mut self,
        begin_seq_num: isize,
        end_seq_num: isize,
    ) -> SimpleResult<Vec<Vec<u8>>>;
    async fn iterate_messages(
        &mut self,
        begin_seq_num: isize,
        end_seq_num: isize,
        cb: &mut (dyn FnMut(&[u8]) -> SimpleResult<()> + Send),
    ) -> SimpleResult<()>;

    async fn refresh(&mut self) -> SimpleResult<()>;
    async fn reset(&mut self) -> SimpleResult<()>;

    async fn close(&mut self) -> SimpleResult<()>;
}

/// Creates session-specific [`MessageStoreTrait`] instances.
///
/// Pass a factory to [`Acceptor::new`](crate::acceptor::Acceptor::new) or
/// [`Initiator::new`](crate::initiator::Initiator::new) and the engine will
/// call [`create`](MessageStoreFactoryTrait::create) once per session.
#[allow(async_fn_in_trait)] // dispatched via enum_dispatch, not used as trait object
#[enum_dispatch]
pub trait MessageStoreFactoryTrait {
    async fn create(&self, session_id: Arc<SessionID>) -> SimpleResult<MessageStoreEnum>;
}

/// Enum-dispatched wrapper over all [`MessageStoreTrait`] implementations.
#[allow(clippy::large_enum_variant)]
#[enum_dispatch(MessageStoreTrait)]
pub enum MessageStoreEnum {
    MemoryStore,
    FileStore,
    #[cfg(feature = "mongo_store")]
    MongoStore,
    #[cfg(feature = "sql_store")]
    SqlStore,
    #[cfg(test)]
    MockMemoryStore(crate::fixer_test::MockStoreShared),
}

impl Default for MessageStoreEnum {
    fn default() -> Self {
        Self::MemoryStore(MemoryStore::default())
    }
}

/// Enum-dispatched wrapper over all [`MessageStoreFactoryTrait`]
/// implementations.
#[enum_dispatch(MessageStoreFactoryTrait)]
#[derive(Clone)]
pub enum MessageStoreFactoryEnum {
    MemoryStoreFactory,
    FileStoreFactory,
    #[cfg(feature = "mongo_store")]
    MongoStoreFactory,
    #[cfg(feature = "sql_store")]
    SqlStoreFactory,
}

impl Default for MessageStoreFactoryEnum {
    fn default() -> Self {
        MemoryStoreFactory::new()
    }
}

/// In-memory message store. Fast but does not survive restarts.
#[derive(Default)]
pub struct MemoryStore {
    pub sender_msg_seq_num: isize,
    pub target_msg_seq_num: isize,
    pub creation_time: Timestamp,
    pub message_map: FxHashMap<isize, Vec<u8>>,
}

impl MessageStoreTrait for MemoryStore {
    async fn next_sender_msg_seq_num(&mut self) -> isize {
        self.sender_msg_seq_num + 1
    }

    async fn next_target_msg_seq_num(&mut self) -> isize {
        self.target_msg_seq_num + 1
    }

    async fn incr_next_sender_msg_seq_num(&mut self) -> SimpleResult<()> {
        self.sender_msg_seq_num += 1;
        Ok(())
    }

    async fn incr_next_target_msg_seq_num(&mut self) -> SimpleResult<()> {
        self.target_msg_seq_num += 1;
        Ok(())
    }

    async fn set_next_sender_msg_seq_num(&mut self, next_seq_num: isize) -> SimpleResult<()> {
        self.sender_msg_seq_num = next_seq_num - 1;
        Ok(())
    }

    async fn set_next_target_msg_seq_num(&mut self, next_seq_num: isize) -> SimpleResult<()> {
        self.target_msg_seq_num = next_seq_num - 1;
        Ok(())
    }

    async fn creation_time(&self) -> Timestamp {
        self.creation_time
    }

    async fn reset(&mut self) -> SimpleResult<()> {
        self.sender_msg_seq_num = 0;
        self.target_msg_seq_num = 0;
        self.creation_time = Timestamp::now();
        self.message_map.clear();
        Ok(())
    }

    async fn refresh(&mut self) -> SimpleResult<()> {
        // nop, nothing to refresh
        Ok(())
    }

    async fn close(&mut self) -> SimpleResult<()> {
        // nop, nothing to close
        Ok(())
    }

    async fn save_message(&mut self, seq_num: isize, msg: Vec<u8>) -> SimpleResult<()> {
        self.message_map.insert(seq_num, msg);
        Ok(())
    }

    async fn save_message_and_incr_next_sender_msg_seq_num(
        &mut self,
        seq_num: isize,
        msg: Vec<u8>,
    ) -> SimpleResult<()> {
        self.save_message(seq_num, msg).await?;
        self.incr_next_sender_msg_seq_num().await
    }

    async fn iterate_messages(
        &mut self,
        begin_seq_num: isize,
        end_seq_num: isize,
        cb: &mut (dyn FnMut(&[u8]) -> SimpleResult<()> + Send),
    ) -> SimpleResult<()> {
        for seq_num in begin_seq_num..=end_seq_num {
            if let Some(m) = self.message_map.get(&seq_num) {
                cb(m)?;
            }
        }
        Ok(())
    }

    async fn get_messages(
        &mut self,
        begin_seq_num: isize,
        end_seq_num: isize,
    ) -> SimpleResult<Vec<Vec<u8>>> {
        let mut msgs: Vec<Vec<u8>> = vec![];
        self.iterate_messages(begin_seq_num, end_seq_num, &mut |m| {
            msgs.push(m.to_vec());
            Ok(())
        })
        .await?;
        Ok(msgs)
    }
}

#[derive(Clone)]
pub struct MemoryStoreFactory;

impl MessageStoreFactoryTrait for MemoryStoreFactory {
    async fn create(&self, _session_id: Arc<SessionID>) -> SimpleResult<MessageStoreEnum> {
        let mut m = MemoryStore::default();
        if let Err(err) = m.reset().await {
            return Err(simple_error!("reset: {}", err));
        }
        Ok(MessageStoreEnum::MemoryStore(m))
    }
}

impl MemoryStoreFactory {
    /// Creates a factory that produces in-memory message stores.
    #[allow(clippy::new_ret_no_self)]
    pub fn new() -> MessageStoreFactoryEnum {
        MessageStoreFactoryEnum::MemoryStoreFactory(MemoryStoreFactory)
    }
}

#[cfg(test)]
#[allow(clippy::items_after_statements)]
mod tests {
    use crate::{
        session::session_id::SessionID,
        store::{
            MemoryStoreFactory, MessageStoreEnum, MessageStoreFactoryTrait, MessageStoreTrait,
        },
    };
    use jiff::Timestamp;
    use rustc_hash::FxHashMap;
    use std::sync::Arc;

    // MessageStoreTestSuite is the suite of all tests that should be run against all MessageStore implementations.
    pub struct MessageStoreTestSuite<S: MessageStoreTrait> {
        pub msg_store: S,
    }

    impl<S: MessageStoreTrait> MessageStoreTestSuite<S> {
        pub async fn test_message_store_set_next_msg_seq_num_refresh_incr_next_msg_seq_num(
            &mut self,
        ) {
            // Given a MessageStore with the following sender and target seqnums
            assert!(
                self.msg_store
                    .set_next_sender_msg_seq_num(867)
                    .await
                    .is_ok()
            );
            assert!(
                self.msg_store
                    .set_next_target_msg_seq_num(5309)
                    .await
                    .is_ok()
            );

            // When the store is refreshed from its backing store
            assert!(self.msg_store.refresh().await.is_ok());

            // Then the sender and target seqnums should still be
            assert_eq!(867, self.msg_store.next_sender_msg_seq_num().await);
            assert_eq!(5309, self.msg_store.next_target_msg_seq_num().await);

            // When the sender and target seqnums are incremented
            assert!(self.msg_store.incr_next_sender_msg_seq_num().await.is_ok());
            assert!(self.msg_store.incr_next_target_msg_seq_num().await.is_ok());

            // Then the sender and target seqnums should be
            assert_eq!(868, self.msg_store.next_sender_msg_seq_num().await);
            assert_eq!(5310, self.msg_store.next_target_msg_seq_num().await);

            // When the store is refreshed from its backing store
            assert!(self.msg_store.refresh().await.is_ok());

            // Then the sender and target seqnums should still be
            assert_eq!(868, self.msg_store.next_sender_msg_seq_num().await);
            assert_eq!(5310, self.msg_store.next_target_msg_seq_num().await);
        }

        pub async fn test_message_store_reset(&mut self) {
            // Given a MessageStore with the following sender and target seqnums
            assert!(
                self.msg_store
                    .set_next_sender_msg_seq_num(1234)
                    .await
                    .is_ok()
            );
            assert!(
                self.msg_store
                    .set_next_target_msg_seq_num(5678)
                    .await
                    .is_ok()
            );

            // When the store is reset
            assert!(self.msg_store.reset().await.is_ok());

            // Then the sender and target seqnums should be
            assert_eq!(1, self.msg_store.next_sender_msg_seq_num().await);
            assert_eq!(1, self.msg_store.next_target_msg_seq_num().await);

            // When the store is refreshed from its backing store
            assert!(self.msg_store.refresh().await.is_ok());

            // Then the sender and target seqnums should still be
            assert_eq!(1, self.msg_store.next_sender_msg_seq_num().await);
            assert_eq!(1, self.msg_store.next_target_msg_seq_num().await);
        }

        pub async fn test_message_store_save_message_get_message(&mut self) {
            // Given the following saved messages
            let expected_msgs_by_seq_num: FxHashMap<isize, String> = hashmap! {
                1 => String::from("In the frozen land of Nador"),
                2 => String::from("they were forced to eat Robin's minstrels"),
                3 => String::from("and there was much rejoicing"),
            };

            for (seq_num, msg) in &expected_msgs_by_seq_num {
                assert!(
                    self.msg_store
                        .save_message(*seq_num, msg.clone().into_bytes())
                        .await
                        .is_ok()
                );
            }

            // When the messages are retrieved from the MessageStore
            let actual_msgs_result = self.msg_store.get_messages(1, 3).await;
            assert!(actual_msgs_result.is_ok());
            let actual_msgs = actual_msgs_result.unwrap();

            // Then the messages should be
            assert_eq!(actual_msgs.len(), 3);
            assert_eq!(
                expected_msgs_by_seq_num.get(&1).unwrap().as_bytes(),
                actual_msgs[0],
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&2).unwrap().as_bytes(),
                actual_msgs[1],
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&3).unwrap().as_bytes(),
                actual_msgs[2],
            );

            // When the store is refreshed from its backing store
            assert!(self.msg_store.refresh().await.is_ok());

            // And the messages are retrieved from the MessageStore
            let actual_msgs_result = self.msg_store.get_messages(1, 3).await;
            assert!(actual_msgs_result.is_ok());
            let actual_msgs = actual_msgs_result.unwrap();

            // Then the messages should still be
            assert_eq!(actual_msgs.len(), 3);
            assert_eq!(
                expected_msgs_by_seq_num.get(&1).unwrap().as_bytes(),
                actual_msgs[0]
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&2).unwrap().as_bytes(),
                actual_msgs[1]
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&3).unwrap().as_bytes(),
                actual_msgs[2]
            );
        }

        pub async fn test_message_store_save_message_and_increment_get_message(&mut self) {
            assert!(
                self.msg_store
                    .set_next_sender_msg_seq_num(420)
                    .await
                    .is_ok()
            );

            // Given the following saved messages
            let expected_msgs_by_seq_num: FxHashMap<isize, String> = hashmap! {
                1 => String::from("In the frozen land of Nador"),
                2 => String::from("they were forced to eat Robin's minstrels"),
                3 => String::from("and there was much rejoicing"),
            };

            for (seq_num, msg) in &expected_msgs_by_seq_num {
                assert!(
                    self.msg_store
                        .save_message_and_incr_next_sender_msg_seq_num(
                            *seq_num,
                            msg.clone().into_bytes()
                        )
                        .await
                        .is_ok()
                );
            }

            assert_eq!(423, self.msg_store.next_sender_msg_seq_num().await);

            // When the messages are retrieved from the MessageStore
            let actual_msgs_result = self.msg_store.get_messages(1, 3).await;
            assert!(actual_msgs_result.is_ok());
            let actual_msgs = actual_msgs_result.unwrap();

            // Then the messages should be
            assert_eq!(actual_msgs.len(), 3);
            assert_eq!(
                expected_msgs_by_seq_num.get(&1).unwrap().as_bytes(),
                actual_msgs[0]
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&2).unwrap().as_bytes(),
                actual_msgs[1]
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&3).unwrap().as_bytes(),
                actual_msgs[2]
            );

            // When the store is refreshed from its backing store
            assert!(self.msg_store.refresh().await.is_ok());

            // And the messages are retrieved from the MessageStore
            let actual_msgs_result = self.msg_store.get_messages(1, 3).await;
            assert!(actual_msgs_result.is_ok());
            let actual_msgs = actual_msgs_result.unwrap();

            assert_eq!(423, self.msg_store.next_sender_msg_seq_num().await);

            // Then the messages should still be
            assert_eq!(actual_msgs.len(), 3);
            assert_eq!(
                expected_msgs_by_seq_num.get(&1).unwrap().as_bytes(),
                actual_msgs[0]
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&2).unwrap().as_bytes(),
                actual_msgs[1]
            );
            assert_eq!(
                expected_msgs_by_seq_num.get(&3).unwrap().as_bytes(),
                actual_msgs[2]
            );
        }

        pub async fn test_message_store_get_messages_empty_store(&mut self) {
            // When messages are retrieved from an empty store
            let actual_msgs_result = self.msg_store.get_messages(1, 2).await;
            assert!(actual_msgs_result.is_ok());
            let messages = actual_msgs_result.unwrap();

            // Then no messages should be returned
            assert!(
                messages.is_empty(),
                "Did not expect messages from empty store"
            );
        }

        pub async fn test_message_store_get_messages_various_ranges(&mut self) {
            // Given the following saved messages
            assert!(
                self.msg_store
                    .save_message(1, "hello".as_bytes().to_vec())
                    .await
                    .is_ok()
            );
            assert!(
                self.msg_store
                    .save_message(2, "cruel".as_bytes().to_vec())
                    .await
                    .is_ok()
            );
            assert!(
                self.msg_store
                    .save_message(3, "world".as_bytes().to_vec())
                    .await
                    .is_ok()
            );

            // When the following requests are made to the store
            struct TestCase {
                begin_seq_no: isize,
                end_seq_no: isize,
                expected_bytes: Vec<Vec<u8>>,
            }

            let tests = vec![
                TestCase {
                    begin_seq_no: 1,
                    end_seq_no: 1,
                    expected_bytes: vec!["hello".as_bytes().to_vec()],
                },
                TestCase {
                    begin_seq_no: 1,
                    end_seq_no: 2,
                    expected_bytes: vec!["hello".as_bytes().to_vec(), "cruel".as_bytes().to_vec()],
                },
                TestCase {
                    begin_seq_no: 1,
                    end_seq_no: 3,
                    expected_bytes: vec![
                        "hello".as_bytes().to_vec(),
                        "cruel".as_bytes().to_vec(),
                        "world".as_bytes().to_vec(),
                    ],
                },
                TestCase {
                    begin_seq_no: 1,
                    end_seq_no: 4,
                    expected_bytes: vec![
                        "hello".as_bytes().to_vec(),
                        "cruel".as_bytes().to_vec(),
                        "world".as_bytes().to_vec(),
                    ],
                },
                TestCase {
                    begin_seq_no: 2,
                    end_seq_no: 3,
                    expected_bytes: vec!["cruel".as_bytes().to_vec(), "world".as_bytes().to_vec()],
                },
                TestCase {
                    begin_seq_no: 3,
                    end_seq_no: 3,
                    expected_bytes: vec!["world".as_bytes().to_vec()],
                },
                TestCase {
                    begin_seq_no: 3,
                    end_seq_no: 4,
                    expected_bytes: vec!["world".as_bytes().to_vec()],
                },
                TestCase {
                    begin_seq_no: 4,
                    end_seq_no: 4,
                    expected_bytes: vec![],
                },
                TestCase {
                    begin_seq_no: 4,
                    end_seq_no: 10,
                    expected_bytes: vec![],
                },
            ];

            // Then the returned messages should be
            for test in &tests {
                let actual_msgs_result = self
                    .msg_store
                    .get_messages(test.begin_seq_no, test.end_seq_no)
                    .await;
                assert!(actual_msgs_result.is_ok());
                let actual_msgs = actual_msgs_result.unwrap();
                assert_eq!(actual_msgs.len(), test.expected_bytes.len());
                for (i, expected_msg) in test.expected_bytes.iter().enumerate() {
                    assert_eq!(
                        std::str::from_utf8(expected_msg).unwrap().to_string(),
                        std::str::from_utf8(&actual_msgs[i]).unwrap().to_string()
                    );
                }
            }
        }

        pub async fn test_message_store_creation_time(&mut self) {
            let t0 = Timestamp::now();
            assert!(self.msg_store.reset().await.is_ok());
            let t1 = Timestamp::now();
            assert!(self.msg_store.creation_time().await >= t0);
            assert!(self.msg_store.creation_time().await <= t1);
        }
    }

    // MemoryStoreTestSuite runs all tests in the MessageStoreTestSuite against the MemoryStore implementation.
    pub struct MemoryStoreTestSuite<S: MessageStoreTrait> {
        pub suite: MessageStoreTestSuite<S>,
    }

    async fn setup_test() -> MemoryStoreTestSuite<MessageStoreEnum> {
        let factory = MemoryStoreFactory::new();
        let store_result = factory.create(Arc::new(SessionID::default())).await;
        assert!(store_result.is_ok());
        let store = store_result.unwrap();

        MemoryStoreTestSuite {
            suite: MessageStoreTestSuite { msg_store: store },
        }
    }

    #[tokio::test]
    async fn test_memory_store_test_suite() {
        let mut s = setup_test().await;
        s.suite
            .test_message_store_set_next_msg_seq_num_refresh_incr_next_msg_seq_num()
            .await;
        let mut s = setup_test().await;
        s.suite.test_message_store_reset().await;
        let mut s = setup_test().await;
        s.suite.test_message_store_save_message_get_message().await;
        let mut s = setup_test().await;
        s.suite
            .test_message_store_save_message_and_increment_get_message()
            .await;
        let mut s = setup_test().await;
        s.suite.test_message_store_get_messages_empty_store().await;
        let mut s = setup_test().await;
        s.suite
            .test_message_store_get_messages_various_ranges()
            .await;
        let mut s = setup_test().await;
        s.suite.test_message_store_creation_time().await;
    }
}