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
use std::{collections::HashMap, net::SocketAddr, ops::Bound::Included};

use massa_models::serialization::{IpAddrDeserializer, IpAddrSerializer};
use massa_protocol_exports::{PeerId, PeerIdDeserializer, PeerIdSerializer};
use massa_serialization::{Deserializer, Serializer, U64VarIntDeserializer, U64VarIntSerializer};
use nom::{
    error::{context, ContextError, ParseError},
    multi::length_count,
    sequence::tuple,
    IResult, Parser,
};
use num_enum::{IntoPrimitive, TryFromPrimitive};
use peernet::transports::TransportType;

#[derive(Debug, Clone)]
//TODO: Fix this clippy warning
#[allow(clippy::large_enum_variant)]
pub enum PeerManagementMessage {
    // Receive the ip addresses sent by a peer when connecting.
    NewPeerConnected((PeerId, HashMap<SocketAddr, TransportType>)),
    // Receive the ip addresses sent by a peer that is already connected.
    ListPeers(Vec<(PeerId, HashMap<SocketAddr, TransportType>)>),
}

#[derive(IntoPrimitive, Debug, Eq, PartialEq, TryFromPrimitive)]
#[repr(u64)]
pub enum MessageTypeId {
    NewPeerConnected = 0,
    ListPeers = 1,
}

impl From<&PeerManagementMessage> for MessageTypeId {
    fn from(message: &PeerManagementMessage) -> Self {
        match message {
            PeerManagementMessage::NewPeerConnected(_) => MessageTypeId::NewPeerConnected,
            PeerManagementMessage::ListPeers(_) => MessageTypeId::ListPeers,
        }
    }
}

#[derive(Default, Clone)]
pub struct PeerManagementMessageSerializer {
    id_serializer: U64VarIntSerializer,
    length_serializer: U64VarIntSerializer,
    ip_addr_serializer: IpAddrSerializer,
    peer_id_serializer: PeerIdSerializer,
}

impl PeerManagementMessageSerializer {
    pub fn new() -> Self {
        Self {
            id_serializer: U64VarIntSerializer::new(),
            length_serializer: U64VarIntSerializer::new(),
            ip_addr_serializer: IpAddrSerializer::new(),
            peer_id_serializer: PeerIdSerializer::new(),
        }
    }
}

impl Serializer<PeerManagementMessage> for PeerManagementMessageSerializer {
    fn serialize(
        &self,
        value: &PeerManagementMessage,
        buffer: &mut Vec<u8>,
    ) -> Result<(), massa_serialization::SerializeError> {
        self.id_serializer
            .serialize(&MessageTypeId::from(value).into(), buffer)?;
        match value {
            PeerManagementMessage::NewPeerConnected((peer_id, listeners)) => {
                self.peer_id_serializer.serialize(peer_id, buffer)?;
                self.length_serializer
                    .serialize(&(listeners.len() as u64), buffer)?;
                for (socket_addr, transport_type) in listeners {
                    self.ip_addr_serializer
                        .serialize(&socket_addr.ip(), buffer)?;
                    buffer.extend_from_slice(&socket_addr.port().to_be_bytes());
                    buffer.push(*transport_type as u8);
                }
            }
            PeerManagementMessage::ListPeers(peers) => {
                self.length_serializer
                    .serialize(&(peers.len() as u64), buffer)?;
                for (peer_id, listeners) in peers {
                    self.peer_id_serializer.serialize(peer_id, buffer)?;
                    self.length_serializer
                        .serialize(&(listeners.len() as u64), buffer)?;
                    for (socket_addr, transport_type) in listeners {
                        self.ip_addr_serializer
                            .serialize(&socket_addr.ip(), buffer)?;
                        buffer.extend_from_slice(&socket_addr.port().to_be_bytes());
                        buffer.push(*transport_type as u8);
                    }
                }
            }
        }
        Ok(())
    }
}

pub struct PeerManagementMessageDeserializer {
    id_deserializer: U64VarIntDeserializer,
    listeners_length_deserializer: U64VarIntDeserializer,
    peers_length_deserializer: U64VarIntDeserializer,
    ip_addr_deserializer: IpAddrDeserializer,
    peer_id_deserializer: PeerIdDeserializer,
}

/// Limits used in the deserialization of `OperationMessage`
pub struct PeerManagementMessageDeserializerArgs {
    /// Maximum number of listeners per peer
    pub max_listeners_per_peer: u64,
    /// Maximum number of peers per announcement
    pub max_peers_per_announcement: u64,
}

impl PeerManagementMessageDeserializer {
    pub fn new(limits: PeerManagementMessageDeserializerArgs) -> Self {
        Self {
            id_deserializer: U64VarIntDeserializer::new(Included(0), Included(u64::MAX)),
            listeners_length_deserializer: U64VarIntDeserializer::new(
                Included(0),
                Included(limits.max_listeners_per_peer),
            ),
            peers_length_deserializer: U64VarIntDeserializer::new(
                Included(0),
                Included(limits.max_peers_per_announcement),
            ),
            ip_addr_deserializer: IpAddrDeserializer::new(),
            peer_id_deserializer: PeerIdDeserializer::new(),
        }
    }
}

impl Deserializer<PeerManagementMessage> for PeerManagementMessageDeserializer {
    fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
        &self,
        buffer: &'a [u8],
    ) -> IResult<&'a [u8], PeerManagementMessage, E> {
        context("Failed PeerManagementMessage deserialization", |buffer| {
            let (buffer, raw_id) = self.id_deserializer.deserialize(buffer)?;
            let id = MessageTypeId::try_from(raw_id).map_err(|_| {
                nom::Err::Error(ParseError::from_error_kind(
                    buffer,
                    nom::error::ErrorKind::Eof,
                ))
            })?;
            match id {
                MessageTypeId::NewPeerConnected => context(
                    "Failed NewPeerConnected deserialization",
                    tuple((
                        context("Failed PeerId deserialization", |buffer: &'a [u8]| {
                            self.peer_id_deserializer.deserialize(buffer)
                        }),
                        length_count(
                            context("Failed length listeners deserialization", |buffer| {
                                self.listeners_length_deserializer.deserialize(buffer)
                            }),
                            context("Failed listener deserialization", |buffer| {
                                listener_deserializer(buffer, &self.ip_addr_deserializer)
                            }),
                        ),
                    )),
                )
                .map(
                    |(peer_id, listeners): (PeerId, Vec<(SocketAddr, TransportType)>)| {
                        let listeners = listeners.into_iter().collect();
                        PeerManagementMessage::NewPeerConnected((peer_id, listeners))
                    },
                )
                .parse(buffer),
                MessageTypeId::ListPeers => context(
                    "Failed ListPeers deserialization",
                    length_count(
                        context(
                            "Failed length peers deserialization",
                            |buffer: &'a [u8]| self.peers_length_deserializer.deserialize(buffer),
                        ),
                        context(
                            "Failed peer deserialization",
                            tuple((
                                context("Failed PeerId deserialization", |buffer: &'a [u8]| {
                                    self.peer_id_deserializer.deserialize(buffer)
                                }),
                                length_count(
                                    context("Failed length listeners deserialization", |buffer| {
                                        self.listeners_length_deserializer.deserialize(buffer)
                                    }),
                                    context("Failed listener deserialization", |buffer| {
                                        listener_deserializer(buffer, &self.ip_addr_deserializer)
                                    }),
                                )
                                .map::<_, HashMap<SocketAddr, TransportType>>(
                                    |listeners: Vec<(SocketAddr, TransportType)>| {
                                        listeners.into_iter().collect()
                                    },
                                ),
                            )),
                        ),
                    ),
                )
                .map(|data: Vec<(PeerId, HashMap<SocketAddr, TransportType>)>| {
                    PeerManagementMessage::ListPeers(data)
                })
                .parse(buffer),
            }
        })
        .parse(buffer)
    }
}

fn listener_deserializer<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
    buffer: &'a [u8],
    ip_addr_deserializer: &IpAddrDeserializer,
) -> IResult<&'a [u8], (SocketAddr, TransportType), E> {
    context("Failed listener deserialization", |buffer| {
        tuple((
            |buffer| {
                context("Failed SocketAddr deserialization", |buffer| {
                    let (buffer, ip) = ip_addr_deserializer.deserialize(buffer)?;
                    let (buffer, port) = nom::number::complete::be_u16(buffer)?;
                    Ok((buffer, SocketAddr::new(ip, port)))
                })
                .parse(buffer)
            },
            |buffer| {
                context(
                    "Failed TransportType deserialization",
                    |buffer: &'a [u8]| {
                        if buffer.is_empty() {
                            return Err(nom::Err::Error(ParseError::from_error_kind(
                                buffer,
                                nom::error::ErrorKind::Eof,
                            )));
                        }
                        let transport_type = match buffer[0] {
                            0 => TransportType::Tcp,
                            1 => TransportType::Quic,
                            _ => {
                                return Err(nom::Err::Error(ParseError::from_error_kind(
                                    buffer,
                                    nom::error::ErrorKind::Eof,
                                )))
                            }
                        };

                        Ok((
                            buffer
                                .get(1..)
                                .ok_or(nom::Err::Error(ParseError::from_error_kind(
                                    buffer,
                                    nom::error::ErrorKind::LengthValue,
                                )))?,
                            transport_type,
                        ))
                    },
                )
                .parse(buffer)
            },
        ))
        .map(|(socket_addr, transport_type)| (socket_addr, transport_type))
        .parse(buffer)
    })
    .parse(buffer)
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::{
        PeerManagementMessage, PeerManagementMessageDeserializer,
        PeerManagementMessageDeserializerArgs, PeerManagementMessageSerializer,
    };
    use massa_protocol_exports::PeerId;
    use massa_serialization::{DeserializeError, Deserializer, Serializer};
    use massa_signature::KeyPair;
    use peernet::transports::TransportType;

    #[test]
    fn test_peer_connected() {
        let keypair = KeyPair::generate(0).unwrap();
        let mut listeners = HashMap::new();
        listeners.insert("127.0.0.1:33036".parse().unwrap(), TransportType::Tcp);
        listeners.insert("127.0.0.1:33035".parse().unwrap(), TransportType::Quic);

        let serializer = PeerManagementMessageSerializer::new();
        let mut buffer = vec![];
        let msg = PeerManagementMessage::NewPeerConnected((
            PeerId::from_public_key(keypair.get_public_key()),
            listeners.clone(),
        ));

        serializer.serialize(&msg, &mut buffer).unwrap();

        let deserializer =
            PeerManagementMessageDeserializer::new(PeerManagementMessageDeserializerArgs {
                max_listeners_per_peer: 1000,
                max_peers_per_announcement: 1000,
            });
        let (rest, message) = deserializer
            .deserialize::<DeserializeError>(&buffer)
            .unwrap();
        assert!(rest.is_empty());
        match message {
            PeerManagementMessage::NewPeerConnected((peer_id, message_listeners)) => {
                assert_eq!(peer_id, PeerId::from_public_key(keypair.get_public_key()));
                assert_eq!(message_listeners.len(), 2);

                for (addr, transport) in listeners.iter() {
                    assert!(message_listeners.contains_key(addr));
                    assert_eq!(message_listeners.get(addr).unwrap(), transport);
                }
            }
            _ => panic!("Bad message deserialized"),
        }
    }

    #[test]
    fn test_list_peers() {
        let keypair1 = KeyPair::generate(0).unwrap();
        let mut listeners = HashMap::new();
        listeners.insert("127.0.0.1:33036".parse().unwrap(), TransportType::Tcp);
        let keypair2 = KeyPair::generate(0).unwrap();
        let message = PeerManagementMessage::ListPeers(vec![
            (
                PeerId::from_public_key(keypair1.get_public_key()),
                listeners.clone(),
            ),
            (
                PeerId::from_public_key(keypair2.get_public_key()),
                listeners.clone(),
            ),
        ]);

        let serializer = PeerManagementMessageSerializer::new();
        let mut buffer = vec![];
        serializer.serialize(&message, &mut buffer).unwrap();
        let deserializer =
            PeerManagementMessageDeserializer::new(PeerManagementMessageDeserializerArgs {
                max_listeners_per_peer: 1000,
                max_peers_per_announcement: 1000,
            });
        let (rest, message) = deserializer
            .deserialize::<DeserializeError>(&buffer)
            .unwrap();
        assert!(rest.is_empty());
        match message {
            PeerManagementMessage::ListPeers(peers) => {
                assert_eq!(peers.len(), 2);
                let ids_vec = vec![keypair1.get_public_key(), keypair2.get_public_key()];
                let iter = peers.iter().zip(ids_vec.iter());
                for ((peer_id, message_listeners), public_key) in iter {
                    assert_eq!(peer_id, &PeerId::from_public_key(*public_key));
                    assert_eq!(message_listeners.len(), 1);
                    for (addr, transport) in listeners.iter() {
                        assert!(message_listeners.contains_key(addr));
                        assert_eq!(message_listeners.get(addr).unwrap(), transport);
                    }
                }
            }
            _ => panic!("Bad message deserialized"),
        }
    }
}