wireframe 0.3.0

Simplify building servers and clients for custom binary protocols.
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

//! Tests for the public default fragment adapter wrapper.

use std::{num::NonZeroUsize, time::Duration};

use crate::fragment::{
    DefaultFragmentAdapter,
    FragmentHeader,
    FragmentIndex,
    FragmentParts,
    Fragmentable,
    FragmentationConfig,
    MessageId,
    encode_fragment_payload,
};

#[derive(Clone, Debug, PartialEq, Eq)]
struct TestPacket {
    id: u32,
    correlation_id: Option<u64>,
    payload: Vec<u8>,
}

impl Fragmentable for TestPacket {
    fn into_fragment_parts(self) -> FragmentParts {
        FragmentParts::new(self.id, self.correlation_id, self.payload)
    }

    fn from_fragment_parts(parts: FragmentParts) -> Self {
        Self {
            id: parts.id(),
            correlation_id: parts.correlation_id(),
            payload: parts.into_payload(),
        }
    }
}

fn adapter_config() -> FragmentationConfig {
    FragmentationConfig {
        fragment_payload_cap: NonZeroUsize::new(4).expect("non-zero"),
        max_message_size: NonZeroUsize::new(64).expect("non-zero"),
        reassembly_timeout: Duration::from_secs(30),
    }
}

fn build_test_packet() -> TestPacket {
    TestPacket {
        id: 42,
        correlation_id: Some(777),
        payload: (0_u8..10).collect(),
    }
}

fn assert_fragment_metadata(fragments: &[TestPacket], packet: &TestPacket) {
    assert!(
        fragments.len() > 1,
        "payload beyond fragment cap should produce multiple fragments"
    );
    for fragment in fragments {
        assert_eq!(fragment.id, packet.id);
        assert_eq!(fragment.correlation_id, packet.correlation_id);
    }
}

fn reassemble_fragment_sequence(
    adapter: &mut DefaultFragmentAdapter,
    fragments: &[TestPacket],
) -> Vec<TestPacket> {
    let first = fragments
        .first()
        .cloned()
        .expect("fragment list must contain at least one fragment");
    assert!(
        adapter
            .reassemble(first.clone())
            .expect("first fragment should be accepted")
            .is_none()
    );
    assert!(
        adapter
            .reassemble(first)
            .expect("duplicate fragment should be suppressed")
            .is_none()
    );

    fragments
        .iter()
        .skip(1)
        .cloned()
        .filter_map(|fragment| {
            adapter
                .reassemble(fragment)
                .expect("reassembly should not fail")
        })
        .collect()
}

#[test]
fn default_fragment_adapter_fragments_and_reassembles_test_packets() {
    let mut adapter = DefaultFragmentAdapter::new(adapter_config());
    let packet = build_test_packet();

    let fragments = adapter
        .fragment(packet.clone())
        .expect("fragmenting packet should succeed");
    assert_fragment_metadata(&fragments, &packet);

    let reconstructed = reassemble_fragment_sequence(&mut adapter, &fragments);
    assert_eq!(reconstructed.len(), 1);
    assert_eq!(
        reconstructed.first(),
        Some(&packet),
        "expected exactly one reconstructed packet matching input"
    );
}

#[test]
fn default_fragment_adapter_passes_through_non_fragment_payloads() {
    let mut adapter = DefaultFragmentAdapter::new(adapter_config());
    let packet = TestPacket {
        id: 12,
        correlation_id: Some(9),
        payload: b"not encoded as fragment payload".to_vec(),
    };

    let result = adapter
        .reassemble(packet.clone())
        .expect("non-fragment payload should pass through");

    assert_eq!(result, Some(packet));
}

#[test]
fn default_fragment_adapter_exposes_purge_api() {
    let mut config = adapter_config();
    config.reassembly_timeout = Duration::ZERO;
    let mut adapter = DefaultFragmentAdapter::new(config);
    let header = FragmentHeader::new(MessageId::new(81), FragmentIndex::zero(), false);
    let encoded_payload = encode_fragment_payload(header, &[1_u8, 2]).expect("encode fragment");
    let packet = TestPacket {
        id: 42,
        correlation_id: Some(7),
        payload: encoded_payload,
    };

    assert!(
        adapter
            .reassemble(packet)
            .expect("adapter should accept first fragment")
            .is_none()
    );
    assert_eq!(adapter.purge_expired(), vec![MessageId::new(81)]);
}