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

//! Tests for Wireframe inbound connection handling.

use bytes::{Bytes, BytesMut};
use tokio_util::codec::{Decoder, Encoder};
use wireframe_testing::logger;

use super::*;
use crate::serializer::BincodeSerializer;

#[derive(Clone, Debug)]
struct BadFrame {
    correlation_id: u64,
    payload: Vec<u8>,
}

#[derive(Clone, Debug)]
struct BadCodec;

#[derive(Clone, Debug)]
struct BadDecoder;

#[derive(Clone, Debug)]
struct BadEncoder;

impl Decoder for BadDecoder {
    type Item = BadFrame;
    type Error = io::Error;

    fn decode(&mut self, _src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
        Ok(None)
    }
}

impl Encoder<BadFrame> for BadEncoder {
    type Error = io::Error;

    fn encode(&mut self, _item: BadFrame, _dst: &mut BytesMut) -> Result<(), Self::Error> { Ok(()) }
}

impl FrameCodec for BadCodec {
    type Frame = BadFrame;
    type Decoder = BadDecoder;
    type Encoder = BadEncoder;

    fn decoder(&self) -> Self::Decoder { BadDecoder }

    fn encoder(&self) -> Self::Encoder { BadEncoder }

    fn frame_payload(frame: &Self::Frame) -> &[u8] { frame.payload.as_slice() }

    fn wrap_payload(&self, payload: Bytes) -> Self::Frame {
        BadFrame {
            correlation_id: 0,
            payload: payload.to_vec(),
        }
    }

    fn correlation_id(frame: &Self::Frame) -> Option<u64> { Some(frame.correlation_id) }

    fn max_frame_length(&self) -> usize { 64 }
}

#[test]
fn decode_envelope_tracks_failures_and_logs_correlation_id() {
    let app = WireframeApp::<BincodeSerializer, (), Envelope>::new()
        .expect("build app")
        .with_codec(BadCodec);
    let frame = BadFrame {
        correlation_id: 42,
        payload: vec![0xff],
    };

    let mut log = logger();
    log.clear();
    let mut deser_failures = 0_u32;

    for _ in 1..MAX_DESER_FAILURES {
        let result = frame_handling::decode_envelope::<BadCodec>(
            app.parse_envelope(BadCodec::frame_payload(&frame)),
            &frame,
            &mut deser_failures,
            MAX_DESER_FAILURES,
        );
        assert!(result.is_ok(), "expected recoverable decode failure");
        assert!(result.expect("decode result").is_none());
    }

    let err = frame_handling::decode_envelope::<BadCodec>(
        app.parse_envelope(BadCodec::frame_payload(&frame)),
        &frame,
        &mut deser_failures,
        MAX_DESER_FAILURES,
    )
    .expect_err("expected decode failure to close connection");
    assert_eq!(err.kind(), io::ErrorKind::InvalidData);

    let mut found = false;
    while let Some(record) = log.pop() {
        let message = record.args().to_string();
        if message.contains("failed to decode message")
            && message.contains("correlation_id=Some(42)")
        {
            found = true;
            break;
        }
    }
    assert!(found, "expected correlation_id in decode failure log");
}