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
use serde::{Serialize, de::DeserializeOwned};
use tokio_util::codec::LengthDelimitedCodec;
use std::{marker::PhantomData, fmt::Debug};

mod encoder;
mod decoder;

/// Codec for any struct that implements `Serialize` and `DeserializeOwned` traits.
/// 
/// ### Examples
/// 
/// ```
/// use cs_utils::{random_number, random_str, random_bool, asyn::GenericCodec};
/// use futures::{StreamExt, SinkExt};
/// use serde::{Serialize, Deserialize};
/// use tokio::{io::duplex, try_join};
/// use tokio_util::codec::Framed;
/// 
/// #[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
/// struct TestStruct {
///     id: u16,
///     name: String,
///     is_flag: bool,
/// }
/// 
/// println!("\n🏷️  Generic codec example:");
/// println!("\n⚠️ Note: the \"asyn\" feature must be enabled!\n");
///
/// let (stream, _) = duplex(4096);
///
/// let message = TestStruct {
///     id: random_number(0..=u16::MAX),
///     name: random_str(8),
///     is_flag: random_bool(),
/// };
/// 
/// let framed_stream = Framed::new(
///     stream,
///     GenericCodec::<TestStruct>::new(),
///  );
/// 
/// let (mut sink, mut source) = framed_stream.split();
/// 
/// // send/receive the framed data using the sink/source
/// // see "generic_codec" example for more details
/// ```
#[derive(Debug, Clone)]
pub struct GenericCodec<T: Serialize + DeserializeOwned> {
    length_delimited_codec: LengthDelimitedCodec,
    _phantom: PhantomData<T>,
}

impl<T: Serialize + DeserializeOwned> GenericCodec<T> {
    pub fn new() -> Self {
        return GenericCodec {
            length_delimited_codec: LengthDelimitedCodec::new(),
            _phantom: PhantomData,
        };
    }
}

impl<T: Serialize + DeserializeOwned> Default for GenericCodec<T> {
    fn default() -> Self {
        return GenericCodec::new();
    }
}

#[cfg(test)]
mod tests {
    use futures::{StreamExt, SinkExt};
    use rstest::rstest;
    use tokio::io::duplex;
    use tokio_util::codec::Framed;
    use tokio::try_join;
    use serde::{Serialize, Deserialize};

    use crate::{random_number, random_str, random_bool};
    use crate::traits::Random;
    use crate::asyn::wait_random;

    use super::GenericCodec;

    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
    pub struct TestStruct {
        pub id: u64,
        pub name: String,
        pub is_flag: bool,
    }

    impl Random for TestStruct {
        fn random() -> Self {
            return TestStruct {
                id: random_number(0..=u64::MAX),
                name: random_str(32),
                is_flag: random_bool(),
            };
        }
    }

    #[rstest]
    #[case(true)]
    #[case(false)]
    #[tokio::test]
    async fn can_send_receive_messages_bidirectional(
        #[case] is_forward_direction: bool,
    ) {
        use crate::test::random_vector;
        use crate::swap;

        let (stream1, stream2) = duplex(4096);
        
        let stream1_messages = random_vector(random_number(4..8));
        let stream1_messages1 = stream1_messages.clone();
        let stream1_messages2 = stream1_messages.clone();

        let stream2_messages = random_vector(random_number(4..8));
        let stream2_messages1 = stream2_messages.clone();
        let stream2_messages2 = stream2_messages.clone();

        // maybe swap the direction
        let (stream1, stream2) = if !is_forward_direction {
            swap(stream1, stream2)
        } else {
            (stream1, stream2)
        };

        try_join!(
            tokio::spawn(async move {
                let framed_stream = Framed::new(
                    stream1,
                    GenericCodec::<TestStruct>::new(),
                );
                let (
                    mut sink,
                    mut source,
                ) = framed_stream.split();

                try_join!(
                    tokio::spawn(async move {
                        for message in stream1_messages1 {
                            sink
                                .send(message).await
                                .expect("Cannot send message.");
        
                            wait_random(5..25).await;
                        }
                    }),
                    tokio::spawn(async move {
                        let mut received_messages = vec![];
        
                        while let Some(maybe_message) = source.next().await {
                            let message = maybe_message
                                .expect("Failed to unwrap the message.");
        
                            received_messages.push(message);
                            
                            wait_random(5..25).await;

                            // otherwise the test never completes
                            if received_messages.len() == stream2_messages2.len() {
                                break;
                            }
                        }
        
                        assert_eq!(
                            received_messages,
                            stream2_messages2,
                            "Sent and received messages must match.",
                        );
                    }),
                ).unwrap();
            }),
            tokio::spawn(async move {
                let framed_stream = Framed::new(
                    stream2,
                    GenericCodec::<TestStruct>::new(),
                );
                let (
                    mut sink,
                    mut source,
                ) = framed_stream.split();

                try_join!(
                    tokio::spawn(async move {
                        for message in stream2_messages1 {
                            sink
                                .send(message).await
                                .expect("Cannot send message.");
        
                            wait_random(5..25).await;
                        }
                    }),
                    tokio::spawn(async move {
                        let mut received_messages = vec![];
        
                        while let Some(maybe_message) = source.next().await {
                            let message = maybe_message
                                .expect("Failed to unwrap the message.");
        
                            received_messages.push(message);
                            
                            wait_random(5..25).await;

                            // otherwise the test never completes
                            if received_messages.len() == stream1_messages2.len() {
                                break;
                            }
                        }
        
                        assert_eq!(
                            received_messages,
                            stream1_messages2,
                            "Sent and received messages must match.",
                        );
                    }),
                ).unwrap();
            }),
        ).unwrap();
    }
}