hotfix 0.12.0

Buy-side FIX engine written in pure 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
use crate::message::heartbeat::Heartbeat;
use crate::message::logout::Logout;
use crate::message::reject::Reject;
use crate::message::verification::{VerificationFlags, verify_message};
use crate::message::verification_issue::{CompIdType, MessageError, VerificationIssue};
use crate::session::ctx::{SessionCtx, TransitionResult};
use crate::session::error::{InternalSendResultExt, SessionOperationError};
use crate::session::get_msg_seq_num;
use crate::session::outbound;
use crate::session::state::SessionState;
use crate::transport::writer::WriterRef;
use hotfix_message::Part;
use hotfix_message::message::Message;
use hotfix_message::session_fields::{
    BEGIN_SEQ_NO, END_SEQ_NO, MSG_SEQ_NUM, NEW_SEQ_NO, SessionRejectReason, TEST_REQ_ID,
};
use hotfix_store::MessageStore;
use tracing::error;
use tracing::warn;

fn verify_message_with_ctx<A, S: MessageStore>(
    ctx: &SessionCtx<A, S>,
    message: &Message,
    flags: VerificationFlags,
) -> Result<(), VerificationIssue> {
    let expected_seq_number = if flags.requires_sequence_number() {
        Some(ctx.store.next_target_seq_number())
    } else {
        None
    };
    verify_message(message, &ctx.config, expected_seq_number, flags)
}

/// The result of verifying an inbound message after handling message errors.
///
/// This is the return type of [`verify_and_handle_errors`] which handles the
/// common verification pattern: verify the message, handle any [`MessageError`]
/// internally, and only surface sequence gaps back to the caller for
/// state-specific handling.
pub(crate) enum VerificationOutcome {
    /// The message passed verification.
    Ok,
    /// The counterparty is ahead — the caller must handle this per-state.
    SequenceGap { expected: u64, actual: u64 },
    /// A message error was handled (reject/logout sent). The caller should
    /// apply the returned transition.
    Handled(TransitionResult),
}

/// Verifies an inbound message and handles any [`MessageError`] by sending
/// the appropriate reject/logout. Only [`VerificationIssue::SequenceGap`] is
/// surfaced back as [`VerificationOutcome::SequenceGap`] for the caller to
/// handle per-state.
pub(crate) async fn verify_and_handle_errors<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    message: &Message,
    flags: VerificationFlags,
) -> VerificationOutcome {
    match verify_message_with_ctx(ctx, message, flags) {
        Ok(()) => VerificationOutcome::Ok,
        Err(VerificationIssue::SequenceGap { expected, actual }) => {
            VerificationOutcome::SequenceGap { expected, actual }
        }
        Err(VerificationIssue::InvalidMessage(err)) => {
            let result = handle_verification_error(ctx, writer, err).await;
            VerificationOutcome::Handled(result)
        }
    }
}

async fn handle_sending_time_accuracy_problem<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    msg_seq_num: u64,
    text: &str,
) {
    let reject = Reject::new(msg_seq_num)
        .session_reject_reason(SessionRejectReason::SendingtimeAccuracyProblem)
        .text(text);
    if let Err(err) = outbound::send_message(ctx, writer, reject).await {
        error!("failed to send reject for time accuracy problem: {err}");
    }
    if let Err(err) = ctx.store.increment_target_seq_number().await {
        error!("failed to increment target seq number: {:?}", err);
    }
}

async fn handle_incorrect_begin_string<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    received_begin_string: String,
) -> TransitionResult {
    let logout = Logout::with_reason(format!(
        "beginString={received_begin_string} is not supported"
    ));
    match ctx.prepare_message(logout).await {
        Ok(prepared) => writer.send_raw_message(prepared.raw).await,
        Err(err) => warn!("failed to send logout for incorrect begin string: {err}"),
    }
    writer.disconnect().await;
    TransitionResult::TransitionTo(SessionState::new_disconnected(
        true,
        "incorrect begin string",
    ))
}

async fn handle_incorrect_comp_id<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    received_comp_id: String,
    comp_id_type: CompIdType,
    msg_seq_num: u64,
) -> TransitionResult {
    error!("rejecting message with incorrect comp ID: {received_comp_id} (type: {comp_id_type:?})");
    let reject = Reject::new(msg_seq_num)
        .session_reject_reason(SessionRejectReason::ValueIsIncorrect)
        .text(&format!("invalid comp ID {received_comp_id}"));
    if let Err(err) = outbound::send_message(ctx, writer, reject).await {
        error!("failed to send reject message with invalid comp ID: {err}");
    }
    let logout = Logout::with_reason("incorrect comp ID received".to_string());
    match ctx.prepare_message(logout).await {
        Ok(prepared) => writer.send_raw_message(prepared.raw).await,
        Err(err) => warn!("failed to send logout for incorrect comp ID: {err}"),
    }
    writer.disconnect().await;
    TransitionResult::TransitionTo(SessionState::new_disconnected(true, "incorrect comp ID"))
}

async fn handle_sequence_number_too_low<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    expected: u64,
    actual: u64,
    possible_duplicate: bool,
) -> TransitionResult {
    if possible_duplicate {
        warn!(
            "sequence number too low (expected {expected}, actual {actual}, but counterparty indicated it's poss duplicate, ignoring"
        );
        return TransitionResult::Stay;
    }
    error!(
        "we expected {expected} sequence number, but target sent lower ({actual}), terminating..."
    );
    let reason = format!("sequence number too low (actual {actual}, expected {expected})");
    let logout = Logout::with_reason(reason.clone());
    match ctx.prepare_message(logout).await {
        Ok(prepared) => writer.send_raw_message(prepared.raw).await,
        Err(err) => warn!("failed to send logout for sequence number too low: {err}"),
    }
    writer.disconnect().await;
    TransitionResult::TransitionTo(SessionState::new_disconnected(false, &reason))
}

pub(crate) async fn handle_invalid_msg_type<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    message: &Message,
    msg_type: &str,
) {
    match message.header().get(MSG_SEQ_NUM) {
        Ok(msg_seq_num) => {
            let reject = Reject::new(msg_seq_num)
                .session_reject_reason(SessionRejectReason::InvalidMsgtype)
                .text(&format!("invalid message type {msg_type}"));
            if let Err(err) = outbound::send_message(ctx, writer, reject).await {
                error!("failed to send reject message for invalid msgtype: {err}");
            }

            #[allow(clippy::collapsible_if)]
            if let Ok(seq_num) = message.header().get::<u64>(MSG_SEQ_NUM)
                && ctx.store.next_target_seq_number() == seq_num
            {
                if let Err(err) = ctx.store.increment_target_seq_number().await {
                    error!("failed to increment target seq number: {:?}", err);
                }
            }
        }
        Err(err) => {
            error!("failed to get message seq num: {:?}", err);
        }
    }
}

async fn handle_original_sending_time_missing<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    msg_seq_num: u64,
) {
    let reject = Reject::new(msg_seq_num)
        .session_reject_reason(SessionRejectReason::RequiredTagMissing)
        .text("original sending time is required");
    if let Err(err) = outbound::send_message(ctx, writer, reject).await {
        error!("failed to send reject for time missing tag: {err}");
    }
    if let Err(err) = ctx.store.increment_target_seq_number().await {
        error!("failed to increment target seq number: {:?}", err);
    }
}

async fn handle_verification_error<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    error: MessageError,
) -> TransitionResult {
    match error {
        MessageError::SeqNumberTooLow {
            expected,
            actual,
            possible_duplicate,
        } => {
            handle_sequence_number_too_low(ctx, writer, expected, actual, possible_duplicate).await
        }
        MessageError::IncorrectBeginString(begin_string) => {
            handle_incorrect_begin_string(ctx, writer, begin_string).await
        }
        MessageError::IncorrectCompId {
            comp_id,
            comp_id_type,
            msg_seq_num,
        } => handle_incorrect_comp_id(ctx, writer, comp_id, comp_id_type, msg_seq_num).await,
        MessageError::SendingTimeAccuracyIssue { msg_seq_num } => {
            handle_sending_time_accuracy_problem(
                ctx,
                writer,
                msg_seq_num,
                "unexpected sending time",
            )
            .await;
            TransitionResult::Stay
        }
        MessageError::SendingTimeMissing { msg_seq_num } => {
            handle_sending_time_accuracy_problem(ctx, writer, msg_seq_num, "sending time missing")
                .await;
            TransitionResult::Stay
        }
        MessageError::OriginalSendingTimeMissing { msg_seq_num } => {
            handle_original_sending_time_missing(ctx, writer, msg_seq_num).await;
            TransitionResult::Stay
        }
        MessageError::OriginalSendingTimeAfterSendingTime { msg_seq_num, .. } => {
            handle_sending_time_accuracy_problem(
                ctx,
                writer,
                msg_seq_num,
                "original sending time is after sending time",
            )
            .await;
            TransitionResult::Stay
        }
    }
}

pub(crate) async fn on_test_request<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    message: &Message,
) -> Result<(), SessionOperationError> {
    let req_id: &str = message.get(TEST_REQ_ID).unwrap_or_else(|_| {
        // TODO: send reject?
        todo!()
    });

    ctx.store.increment_target_seq_number().await?;

    outbound::send_message(ctx, writer, Heartbeat::for_request(req_id.to_string()))
        .await
        .with_send_context("heartbeat response")?;

    Ok(())
}

pub(crate) async fn on_sequence_reset<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    message: &Message,
) -> Result<(), SessionOperationError> {
    let msg_seq_num = get_msg_seq_num(message);

    let end: u64 = match message.get(NEW_SEQ_NO) {
        Ok(new_seq_no) => new_seq_no,
        Err(err) => {
            error!(
                "received sequence reset message without new sequence number: {:?}",
                err
            );
            let reject = Reject::new(msg_seq_num)
                .session_reject_reason(SessionRejectReason::RequiredTagMissing)
                .text("missing NewSeqNo tag in sequence reset message");
            outbound::send_message(ctx, writer, reject)
                .await
                .with_send_context("reject for missing NEW_SEQ_NO")?;

            // note: we don't increment the target seq number here
            // this is an ambiguous case in the specification, but leaving the
            // sequence number as is feels the safest
            return Ok(());
        }
    };

    // sequence resets cannot move the target seq number backwards
    // regardless of whether the message is a gap fill or not
    if end <= ctx.store.next_target_seq_number() {
        error!(
            "received sequence reset message which would move target seq number backwards: {end}",
        );
        let text = format!("attempt to lower sequence number, invalid value NewSeqNo(36)={end}");
        let reject = Reject::new(msg_seq_num)
            .session_reject_reason(SessionRejectReason::ValueIsIncorrect)
            .text(&text);
        outbound::send_message(ctx, writer, reject)
            .await
            .with_send_context("reject for invalid sequence reset")?;
        return Ok(());
    }

    ctx.store.set_target_seq_number(end - 1).await?;
    Ok(())
}

pub(crate) async fn on_resend_request<A, S: MessageStore>(
    ctx: &mut SessionCtx<A, S>,
    writer: &WriterRef,
    message: &Message,
) -> Result<(), SessionOperationError> {
    let msg_seq_num = get_msg_seq_num(message);
    let expected = ctx.store.next_target_seq_number();

    let begin_seq_number: u64 = match message.get(BEGIN_SEQ_NO) {
        Ok(seq_number) => seq_number,
        Err(_) => {
            let reject = Reject::new(msg_seq_num)
                .session_reject_reason(SessionRejectReason::RequiredTagMissing)
                .text("missing begin sequence number for resend request");
            outbound::send_message(ctx, writer, reject)
                .await
                .with_send_context("reject for missing BEGIN_SEQ_NO")?;
            return Ok(());
        }
    };

    let end_seq_number: u64 = match message.get(END_SEQ_NO) {
        Ok(seq_number) => {
            let last_seq_number = ctx.store.next_sender_seq_number() - 1;
            if seq_number == 0 {
                last_seq_number
            } else {
                std::cmp::min(seq_number, last_seq_number)
            }
        }
        Err(_) => {
            let reject = Reject::new(msg_seq_num)
                .session_reject_reason(SessionRejectReason::RequiredTagMissing)
                .text("missing end sequence number for resend request");
            outbound::send_message(ctx, writer, reject)
                .await
                .with_send_context("reject for missing END_SEQ_NO")?;
            return Ok(());
        }
    };

    // Only increment target seq if seq matches expected
    if msg_seq_num == expected {
        ctx.store.increment_target_seq_number().await?;
    }

    outbound::resend_messages(ctx, writer, begin_seq_number, end_seq_number).await?;

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::session::test_utils::{
        FakeMessageStore, create_test_ctx, create_writer, extract_field, extract_msg_type,
    };
    use crate::transport::writer::WriterMessage;

    #[tokio::test]
    async fn handle_incorrect_begin_string_returns_transition_to_disconnected() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        let result = handle_incorrect_begin_string(&mut ctx, &writer, "FIX.4.0".to_string()).await;

        assert!(matches!(
            result,
            TransitionResult::TransitionTo(SessionState::Disconnected(_))
        ));

        // Should send a Logout containing the bad begin string, then disconnect
        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("5"));
                let text = extract_field(raw.as_bytes(), 58).expect("expected Text(58) field");
                assert!(
                    text.contains("FIX.4.0"),
                    "logout text should mention the bad begin string, got: {text}"
                );
            }
            _ => panic!("expected SendMessage, got {msg:?}"),
        }
        assert!(matches!(
            rx.recv().await.unwrap(),
            WriterMessage::Disconnect
        ));

        // Sender seq number should have been incremented for the logout
        assert_eq!(ctx.store.next_sender_seq, 2);
    }

    #[tokio::test]
    async fn handle_incorrect_comp_id_returns_transition_to_disconnected() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        let result = handle_incorrect_comp_id(
            &mut ctx,
            &writer,
            "BAD_COMP".to_string(),
            CompIdType::Sender,
            1,
        )
        .await;

        assert!(matches!(
            result,
            TransitionResult::TransitionTo(SessionState::Disconnected(_))
        ));

        // First message: Reject (35=3) mentioning the bad comp ID
        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("3"));
                let text = extract_field(raw.as_bytes(), 58).expect("expected Text(58) field");
                assert!(
                    text.contains("BAD_COMP"),
                    "reject text should mention the bad comp ID, got: {text}"
                );
            }
            _ => panic!("expected SendMessage(Reject), got {msg:?}"),
        }

        // Second message: Logout (35=5)
        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("5"));
            }
            _ => panic!("expected SendMessage(Logout), got {msg:?}"),
        }

        // Third: Disconnect
        assert!(matches!(
            rx.recv().await.unwrap(),
            WriterMessage::Disconnect
        ));

        // Sender seq incremented twice (reject + logout)
        assert_eq!(ctx.store.next_sender_seq, 3);
    }

    #[tokio::test]
    async fn handle_sequence_number_too_low_possible_duplicate_returns_stay() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        let result = handle_sequence_number_too_low(&mut ctx, &writer, 5, 1, true).await;

        assert!(matches!(result, TransitionResult::Stay));

        // No messages should have been sent
        assert!(rx.try_recv().is_err());

        // Store should be untouched
        assert_eq!(ctx.store.next_sender_seq, 1);
        assert_eq!(ctx.store.next_target_seq, 1);
    }

    #[tokio::test]
    async fn handle_sequence_number_too_low_returns_transition_to_disconnected_without_reconnect() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        let result = handle_sequence_number_too_low(&mut ctx, &writer, 5, 1, false).await;

        match result {
            TransitionResult::TransitionTo(state) => {
                assert!(!state.should_reconnect());
            }
            TransitionResult::Stay => panic!("expected TransitionTo(Disconnected)"),
        }

        // Should send a Logout mentioning the sequence mismatch, then disconnect
        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("5"));
                let text = extract_field(raw.as_bytes(), 58).expect("expected Text(58) field");
                assert!(
                    text.contains("5") && text.contains("1"),
                    "logout text should mention expected/actual seq nums, got: {text}"
                );
            }
            _ => panic!("expected SendMessage(Logout), got {msg:?}"),
        }
        assert!(matches!(
            rx.recv().await.unwrap(),
            WriterMessage::Disconnect
        ));

        assert_eq!(ctx.store.next_sender_seq, 2);
    }

    #[tokio::test]
    async fn handle_sending_time_accuracy_problem_sends_reject() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        handle_sending_time_accuracy_problem(&mut ctx, &writer, 42, "bad time").await;

        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("3"));
                let text = extract_field(raw.as_bytes(), 58).expect("expected Text(58) field");
                assert!(
                    text.contains("bad time"),
                    "reject text should contain the provided text, got: {text}"
                );
            }
            _ => panic!("expected SendMessage(Reject), got {msg:?}"),
        }

        // Target seq number should have been incremented
        assert_eq!(ctx.store.next_target_seq, 2);
        // Sender seq number should have been incremented for the outbound reject
        assert_eq!(ctx.store.next_sender_seq, 2);
    }

    #[tokio::test]
    async fn handle_original_sending_time_missing_sends_reject() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        handle_original_sending_time_missing(&mut ctx, &writer, 7).await;

        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("3"));
                let text = extract_field(raw.as_bytes(), 58).expect("expected Text(58) field");
                assert!(
                    text.contains("original sending time"),
                    "reject text should mention original sending time, got: {text}"
                );
            }
            _ => panic!("expected SendMessage(Reject), got {msg:?}"),
        }

        // Both sender and target seq numbers should have been incremented
        assert_eq!(ctx.store.next_sender_seq, 2);
        assert_eq!(ctx.store.next_target_seq, 2);
    }

    #[tokio::test]
    async fn handle_invalid_msg_type_sends_reject_for_message_with_seq_num() {
        let mut ctx = create_test_ctx(FakeMessageStore::new());
        let (writer, mut rx) = create_writer();

        let mut message = Message::new("FIX.4.4", "ZZ");
        message.header_mut().set(MSG_SEQ_NUM, 1u64);

        handle_invalid_msg_type(&mut ctx, &writer, &message, "ZZ").await;

        let msg = rx.recv().await.unwrap();
        match &msg {
            WriterMessage::SendMessage(raw) => {
                assert_eq!(extract_msg_type(raw.as_bytes()).as_deref(), Some("3"));
                let text = extract_field(raw.as_bytes(), 58).expect("expected Text(58) field");
                assert!(
                    text.contains("ZZ"),
                    "reject text should mention the invalid msg type, got: {text}"
                );
            }
            _ => panic!("expected SendMessage(Reject), got {msg:?}"),
        }

        // Sender seq incremented for the reject, target seq incremented because msg seq matched
        assert_eq!(ctx.store.next_sender_seq, 2);
        assert_eq!(ctx.store.next_target_seq, 2);
    }
}