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
use crate::{
    config::{
        DYNAMIC_SESSIONS, SQL_STORE_CONN_MAX_LIFETIME, SQL_STORE_DATA_SOURCE_NAME,
        SQL_STORE_DRIVER,
    },
    session::session_id::SessionID,
    session::settings::SessionSettings,
    settings::Settings,
    store::{
        MemoryStore, MessageStoreEnum, MessageStoreFactoryEnum, MessageStoreFactoryTrait,
        MessageStoreTrait,
    },
};
use jiff::Timestamp;
use simple_error::{SimpleError, SimpleResult};
use sqlx::{any::AnyPoolOptions, AnyPool, Row};
use std::{str::FromStr, sync::{Arc, LazyLock}, time::Duration};
use tokio::sync::Mutex;

const CREATE_SESSIONS_TABLE: &str = "CREATE TABLE IF NOT EXISTS sessions (
  beginstring CHAR(8) NOT NULL,
  sendercompid VARCHAR(64) NOT NULL,
  sendersubid VARCHAR(64) NOT NULL,
  senderlocid VARCHAR(64) NOT NULL,
  targetcompid VARCHAR(64) NOT NULL,
  targetsubid VARCHAR(64) NOT NULL,
  targetlocid VARCHAR(64) NOT NULL,
  session_qualifier VARCHAR(64) NOT NULL,
  creation_time TEXT NOT NULL,
  incoming_seqnum INT NOT NULL,
  outgoing_seqnum INT NOT NULL,
  PRIMARY KEY (beginstring, sendercompid, sendersubid, senderlocid,
               targetcompid, targetsubid, targetlocid, session_qualifier)
)";

const CREATE_MESSAGES_TABLE: &str = "CREATE TABLE IF NOT EXISTS messages (
  beginstring CHAR(8) NOT NULL,
  sendercompid VARCHAR(64) NOT NULL,
  sendersubid VARCHAR(64) NOT NULL,
  senderlocid VARCHAR(64) NOT NULL,
  targetcompid VARCHAR(64) NOT NULL,
  targetsubid VARCHAR(64) NOT NULL,
  targetlocid VARCHAR(64) NOT NULL,
  session_qualifier VARCHAR(64) NOT NULL,
  msgseqnum INT NOT NULL,
  message TEXT NOT NULL,
  PRIMARY KEY (beginstring, sendercompid, sendersubid, senderlocid,
               targetcompid, targetsubid, targetlocid, session_qualifier,
               msgseqnum)
)";

// Session WHERE clause used in all session-scoped queries
const SESSION_WHERE: &str = "beginstring=? AND session_qualifier=?
AND sendercompid=? AND sendersubid=? AND senderlocid=?
AND targetcompid=? AND targetsubid=? AND targetlocid=?";

static SQLX_DRIVERS: LazyLock<()> = LazyLock::new(|| {
    sqlx::any::install_default_drivers();
});

pub struct SqlStore {
    session_id: Arc<SessionID>,
    cache: MemoryStore,
    pool: AnyPool,
}

macro_rules! bind_session_id {
    ($query:expr, $s:expr) => {
        $query
            .bind(&$s.begin_string)
            .bind(&$s.qualifier)
            .bind(&$s.sender_comp_id)
            .bind(&$s.sender_sub_id)
            .bind(&$s.sender_location_id)
            .bind(&$s.target_comp_id)
            .bind(&$s.target_sub_id)
            .bind(&$s.target_location_id)
    };
}

impl SqlStore {
    pub async fn new(
        session_id: Arc<SessionID>,
        driver: &str,
        data_source_name: &str,
        conn_max_lifetime: Duration,
    ) -> SimpleResult<Self> {
        LazyLock::force(&SQLX_DRIVERS);

        let url = build_connection_url(driver, data_source_name);

        let pool = AnyPoolOptions::new()
            .max_lifetime(if conn_max_lifetime.is_zero() {
                None
            } else {
                Some(conn_max_lifetime)
            })
            .connect(&url)
            .await
            .map_err(|e| simple_error!("failed to connect to database: {e}"))?;

        // Create tables if they don't exist
        sqlx::query(CREATE_SESSIONS_TABLE)
            .execute(&pool)
            .await
            .map_err(|e| simple_error!("failed to create sessions table: {e}"))?;

        sqlx::query(CREATE_MESSAGES_TABLE)
            .execute(&pool)
            .await
            .map_err(|e| simple_error!("failed to create messages table: {e}"))?;

        let mut store = SqlStore {
            session_id,
            cache: MemoryStore::default(),
            pool,
        };

        store.cache.reset().await?;
        store.populate_cache().await?;

        Ok(store)
    }

    #[allow(clippy::cast_possible_truncation)]
    async fn populate_cache(&mut self) -> SimpleResult<()> {
        let s = &self.session_id;

        let sql = format!(
            "SELECT creation_time, incoming_seqnum, outgoing_seqnum FROM sessions WHERE {SESSION_WHERE}"
        );
        let query = bind_session_id!(sqlx::query(sqlx::AssertSqlSafe(sql)), s);
        let row = query
            .fetch_optional(&self.pool)
            .await
            .map_err(|e| simple_error!("query sessions: {e}"))?;

        if let Some(row) = row {
            // Session record found, load it
            let creation_time_str: String = row
                .try_get("creation_time")
                .map_err(|e| simple_error!("get creation_time: {e}"))?;
            let incoming_seqnum: i32 = row
                .try_get("incoming_seqnum")
                .map_err(|e| simple_error!("get incoming_seqnum: {e}"))?;
            let outgoing_seqnum: i32 = row
                .try_get("outgoing_seqnum")
                .map_err(|e| simple_error!("get outgoing_seqnum: {e}"))?;

            self.cache.creation_time = Timestamp::from_str(&creation_time_str)
                .map_err(|e| simple_error!("parse creation_time '{creation_time_str}': {e}"))?;
            self.cache
                .set_next_target_msg_seq_num(incoming_seqnum as isize)
                .await?;
            self.cache
                .set_next_sender_msg_seq_num(outgoing_seqnum as isize)
                .await?;
        } else {
            // Session record not found, create it
            let creation_time_str = self.cache.creation_time.to_string();
            let query = sqlx::query(
                "INSERT INTO sessions (
                    creation_time, incoming_seqnum, outgoing_seqnum,
                    beginstring, session_qualifier,
                    sendercompid, sendersubid, senderlocid,
                    targetcompid, targetsubid, targetlocid)
                 VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
            )
            .bind(&creation_time_str)
            .bind(self.cache.next_target_msg_seq_num().await as i32)
            .bind(self.cache.next_sender_msg_seq_num().await as i32)
            .bind(&s.begin_string)
            .bind(&s.qualifier)
            .bind(&s.sender_comp_id)
            .bind(&s.sender_sub_id)
            .bind(&s.sender_location_id)
            .bind(&s.target_comp_id)
            .bind(&s.target_sub_id)
            .bind(&s.target_location_id);
            query
                .execute(&self.pool)
                .await
                .map_err(|e| simple_error!("insert session: {e}"))?;
        }

        Ok(())
    }
}

fn build_connection_url(driver: &str, data_source_name: &str) -> String {
    match driver {
        "sqlite" | "sqlite3" => format!("sqlite:{data_source_name}?mode=rwc"),
        "postgres" | "postgresql" => {
            if data_source_name.starts_with("postgres://")
                || data_source_name.starts_with("postgresql://")
            {
                data_source_name.to_string()
            } else {
                format!("postgres://{data_source_name}")
            }
        }
        "mysql" => {
            if data_source_name.starts_with("mysql://") {
                data_source_name.to_string()
            } else {
                format!("mysql://{data_source_name}")
            }
        }
        _ => format!("{driver}://{data_source_name}"),
    }
}

#[allow(clippy::cast_possible_truncation)]
impl MessageStoreTrait for SqlStore {
    async fn next_sender_msg_seq_num(&mut self) -> isize {
        self.cache.next_sender_msg_seq_num().await
    }

    async fn next_target_msg_seq_num(&mut self) -> isize {
        self.cache.next_target_msg_seq_num().await
    }

    async fn set_next_sender_msg_seq_num(&mut self, next_seq_num: isize) -> SimpleResult<()> {
        let s = &self.session_id;
        let sql = format!("UPDATE sessions SET outgoing_seqnum = ? WHERE {SESSION_WHERE}");
        let query = bind_session_id!(
            sqlx::query(sqlx::AssertSqlSafe(sql)).bind(next_seq_num as i32),
            s
        );
        query
            .execute(&self.pool)
            .await
            .map_err(|e| simple_error!("update outgoing_seqnum: {e}"))?;

        self.cache.set_next_sender_msg_seq_num(next_seq_num).await
    }

    async fn set_next_target_msg_seq_num(&mut self, next_seq_num: isize) -> SimpleResult<()> {
        let s = &self.session_id;
        let sql = format!("UPDATE sessions SET incoming_seqnum = ? WHERE {SESSION_WHERE}");
        let query = bind_session_id!(
            sqlx::query(sqlx::AssertSqlSafe(sql)).bind(next_seq_num as i32),
            s
        );
        query
            .execute(&self.pool)
            .await
            .map_err(|e| simple_error!("update incoming_seqnum: {e}"))?;

        self.cache.set_next_target_msg_seq_num(next_seq_num).await
    }

    async fn incr_next_sender_msg_seq_num(&mut self) -> SimpleResult<()> {
        let next = self.cache.next_sender_msg_seq_num().await + 1;
        self.set_next_sender_msg_seq_num(next).await
    }

    async fn incr_next_target_msg_seq_num(&mut self) -> SimpleResult<()> {
        let next = self.cache.next_target_msg_seq_num().await + 1;
        self.set_next_target_msg_seq_num(next).await
    }

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

    async fn save_message(&mut self, seq_num: isize, msg: Vec<u8>) -> SimpleResult<()> {
        let s = &self.session_id;
        let msg_str =
            String::from_utf8(msg).map_err(|e| simple_error!("message not valid utf8: {e}"))?;

        let query = sqlx::query(
            "INSERT INTO messages (
                msgseqnum, message,
                beginstring, session_qualifier,
                sendercompid, sendersubid, senderlocid,
                targetcompid, targetsubid, targetlocid)
             VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
        )
        .bind(seq_num as i32)
        .bind(&msg_str)
        .bind(&s.begin_string)
        .bind(&s.qualifier)
        .bind(&s.sender_comp_id)
        .bind(&s.sender_sub_id)
        .bind(&s.sender_location_id)
        .bind(&s.target_comp_id)
        .bind(&s.target_sub_id)
        .bind(&s.target_location_id);
        query
            .execute(&self.pool)
            .await
            .map_err(|e| simple_error!("insert message: {e}"))?;

        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<()> {
        let s = &self.session_id;

        let sql = format!(
            "SELECT message FROM messages WHERE {SESSION_WHERE} AND msgseqnum>=? AND msgseqnum<=? ORDER BY msgseqnum"
        );
        let query = bind_session_id!(sqlx::query(sqlx::AssertSqlSafe(sql)), s)
            .bind(begin_seq_num as i32)
            .bind(end_seq_num as i32);
        let rows = query
            .fetch_all(&self.pool)
            .await
            .map_err(|e| simple_error!("query messages: {e}"))?;

        for row in &rows {
            let message: String = row
                .try_get("message")
                .map_err(|e| simple_error!("get message column: {e}"))?;
            cb(message.as_bytes())?;
        }

        Ok(())
    }

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

    async fn refresh(&mut self) -> SimpleResult<()> {
        self.cache.reset().await?;
        self.populate_cache().await
    }

    async fn reset(&mut self) -> SimpleResult<()> {
        let s = &self.session_id;

        // Delete messages for this session
        let sql = format!("DELETE FROM messages WHERE {SESSION_WHERE}");
        let query = bind_session_id!(sqlx::query(sqlx::AssertSqlSafe(sql)), s);
        query
            .execute(&self.pool)
            .await
            .map_err(|e| simple_error!("delete messages: {e}"))?;

        // Reset cache
        self.cache.reset().await?;

        // Update session record with reset values
        let creation_time_str = self.cache.creation_time.to_string();
        let sql = format!(
            "UPDATE sessions SET creation_time=?, incoming_seqnum=?, outgoing_seqnum=? WHERE {SESSION_WHERE}"
        );
        let query = bind_session_id!(
            sqlx::query(sqlx::AssertSqlSafe(sql))
                .bind(&creation_time_str)
                .bind(self.cache.next_target_msg_seq_num().await as i32)
                .bind(self.cache.next_sender_msg_seq_num().await as i32),
            s
        );
        query
            .execute(&self.pool)
            .await
            .map_err(|e| simple_error!("update session after reset: {e}"))?;

        Ok(())
    }

    async fn close(&mut self) -> SimpleResult<()> {
        self.pool.close().await;
        Ok(())
    }
}

#[derive(Clone)]
pub struct SqlStoreFactory {
    settings: Arc<Mutex<Settings>>,
}

impl MessageStoreFactoryTrait for SqlStoreFactory {
    async fn create(&self, session_id: Arc<SessionID>) -> SimpleResult<MessageStoreEnum> {
        let (global_settings, session_settings) = {
            let mut lock = self.settings.lock().await;
            let gs = lock.global_settings().await.unwrap();
            let ss = lock.session_settings_for(&session_id);
            (gs, ss)
        };

        let dynamic_sessions = global_settings
            .bool_setting(DYNAMIC_SESSIONS)
            .unwrap_or(false);

        if let Some(session_settings) = session_settings.as_ref() {
            return create_sql_store(session_id, session_settings).await;
        }
        if dynamic_sessions {
            return create_sql_store(session_id, &global_settings).await;
        }
        Err(simple_error!(
            "unknown session: {}",
            &session_id.to_string()
        ))
    }
}

async fn create_sql_store(
    session_id: Arc<SessionID>,
    session_settings: &SessionSettings,
) -> SimpleResult<MessageStoreEnum> {
    let driver = session_settings
        .setting(SQL_STORE_DRIVER)
        .map_err(SimpleError::from)?;

    let data_source_name = session_settings
        .setting(SQL_STORE_DATA_SOURCE_NAME)
        .map_err(SimpleError::from)?;

    let conn_max_lifetime = if session_settings.has_setting(SQL_STORE_CONN_MAX_LIFETIME) {
        let duration_str = session_settings
            .setting(SQL_STORE_CONN_MAX_LIFETIME)
            .map_err(SimpleError::from)?;
        parse_duration::parse(&duration_str)
            .map_err(|e| simple_error!("invalid SQLStoreConnMaxLifetime: {e}"))?
    } else {
        Duration::from_secs(0)
    };

    Ok(MessageStoreEnum::SqlStore(
        SqlStore::new(session_id, &driver, &data_source_name, conn_max_lifetime).await?,
    ))
}

impl SqlStoreFactory {
    #[allow(clippy::new_ret_no_self)]
    pub fn new(settings: Arc<Mutex<Settings>>) -> MessageStoreFactoryEnum {
        MessageStoreFactoryEnum::SqlStoreFactory(SqlStoreFactory { settings })
    }
}

#[cfg(test)]
#[allow(clippy::items_after_statements)]
mod tests {
    use crate::{
        session::session_id::SessionID,
        settings::Settings,
        store::{
            MessageStoreEnum, MessageStoreFactoryTrait, MessageStoreTrait,
            sql_store::SqlStoreFactory, tests::MessageStoreTestSuite,
        },
    };
    use jiff::Timestamp;
    use std::sync::Arc;
    use tokio::sync::Mutex;

    struct SqlStoreTestSuite<S: MessageStoreTrait> {
        suite: MessageStoreTestSuite<S>,
    }

    async fn setup_test() -> SqlStoreTestSuite<MessageStoreEnum> {
        let dir = std::env::temp_dir().join(format!(
            "SqlStoreTestSuite-{}-{}",
            std::process::id(),
            Timestamp::now().as_nanosecond()
        ));
        std::fs::create_dir_all(&dir).unwrap();
        let db_path = dir.join("test.db");
        let db_path_str = db_path.to_str().unwrap();

        let session_id = SessionID {
            begin_string: String::from("FIX.4.4"),
            sender_comp_id: String::from("SENDER"),
            target_comp_id: String::from("TARGET"),
            ..Default::default()
        };

        let cfg_str = format!(
            r"
[DEFAULT]
SQLStoreDriver=sqlite3
SQLStoreDataSourceName={db_path_str}

[SESSION]
BeginString={}
SenderCompID={}
TargetCompID={}",
            session_id.begin_string, session_id.sender_comp_id, session_id.target_comp_id
        );

        let cfg = cfg_str.as_bytes();
        let s_result = Settings::parse(cfg).await;
        assert!(s_result.is_ok());
        let settings = s_result.unwrap();

        let factory = SqlStoreFactory::new(Arc::new(Mutex::new(settings)));
        let store_result = factory.create(Arc::new(session_id)).await;
        assert!(
            store_result.is_ok(),
            "create store: {:?}",
            store_result.err()
        );
        let store = store_result.unwrap();

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

    #[tokio::test]
    async fn test_sql_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 _ = s.suite.msg_store.close().await;
        let mut s = setup_test().await;
        s.suite.test_message_store_reset().await;
        let _ = s.suite.msg_store.close().await;
        let mut s = setup_test().await;
        s.suite.test_message_store_save_message_get_message().await;
        let _ = s.suite.msg_store.close().await;
        let mut s = setup_test().await;
        s.suite
            .test_message_store_save_message_and_increment_get_message()
            .await;
        let _ = s.suite.msg_store.close().await;
        let mut s = setup_test().await;
        s.suite.test_message_store_get_messages_empty_store().await;
        let _ = s.suite.msg_store.close().await;
        let mut s = setup_test().await;
        s.suite
            .test_message_store_get_messages_various_ranges()
            .await;
        let _ = s.suite.msg_store.close().await;
        let mut s = setup_test().await;
        s.suite.test_message_store_creation_time().await;
        let _ = s.suite.msg_store.close().await;
    }
}