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
use byteorder::{ByteOrder, NetworkEndian};
use memberlist_types::{bytes::Bytes, CheapClone, OneOrMore};
use smol_str::SmolStr;
use transformable::{BytesTransformError, StringTransformError, Transformable};

use super::{LamportTime, LamportTimeTransformError};

/// Used to buffer events to prevent re-delivery
#[viewit::viewit(setters(prefix = "with"))]
#[derive(Debug, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UserEvents {
  /// The lamport time
  #[viewit(
    getter(const, attrs(doc = "Returns the lamport time for this message")),
    setter(
      const,
      attrs(doc = "Sets the lamport time for this message (Builder pattern)")
    )
  )]
  ltime: LamportTime,

  /// The user events
  #[viewit(
    getter(const, style = "ref", attrs(doc = "Returns the user events")),
    setter(attrs(doc = "Sets the user events (Builder pattern)"))
  )]
  events: OneOrMore<UserEvent>,
}

/// Error that can occur when transforming a [`UserEvents`]
#[derive(Debug, thiserror::Error)]
pub enum UserEventsTransformError {
  /// Encode buffer too small
  #[error("encode buffer too small")]
  BufferTooSmall,
  /// Not enough bytes to decode [`UserEvents`]
  #[error("not enough bytes to decode `UserEvents`")]
  NotEnoughBytes,
  /// Error transforming [`UserEvent`]
  #[error(transparent)]
  Event(#[from] UserEventTransformError),
  /// Error transforming [`LamportTime`]
  #[error(transparent)]
  LamportTime(#[from] LamportTimeTransformError),
}

impl Transformable for UserEvents {
  type Error = UserEventsTransformError;

  fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error> {
    let encoded_len = self.encoded_len();

    if dst.len() < encoded_len {
      return Err(Self::Error::BufferTooSmall);
    }

    let mut offset = 0;
    NetworkEndian::write_u32(&mut dst[offset..], encoded_len as u32);
    offset += 4;

    offset += self.ltime.encode(&mut dst[offset..])?;
    NetworkEndian::write_u32(&mut dst[offset..], self.events.len() as u32);
    offset += 4;

    for event in self.events.iter() {
      offset += event.encode(&mut dst[offset..])?;
    }

    debug_assert_eq!(
      offset, encoded_len,
      "expect write {} bytes, actual read {} bytes",
      encoded_len, offset
    );

    Ok(offset)
  }

  fn encoded_len(&self) -> usize {
    4 + self.ltime.encoded_len()
      + 4
      + self
        .events
        .iter()
        .map(UserEvent::encoded_len)
        .sum::<usize>()
  }

  fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>
  where
    Self: Sized,
  {
    let src_len = src.len();
    if src_len < 4 {
      return Err(Self::Error::NotEnoughBytes);
    }

    let len = NetworkEndian::read_u32(&src[0..4]) as usize;
    if src_len < len {
      return Err(Self::Error::NotEnoughBytes);
    }

    let mut offset = 4;
    let (ltime_offset, ltime) = LamportTime::decode(&src[offset..])?;
    offset += ltime_offset;

    let event_len = NetworkEndian::read_u32(&src[offset..]) as usize;
    offset += 4;

    let mut events = OneOrMore::with_capacity(event_len);
    for _ in 0..event_len {
      let (event_offset, event) = UserEvent::decode(&src[offset..])?;
      offset += event_offset;
      events.push(event);
    }

    debug_assert_eq!(
      offset, len,
      "expect read {} bytes, actual read {} bytes",
      len, offset
    );

    Ok((len, Self { ltime, events }))
  }
}

/// Stores all the user events at a specific time
#[viewit::viewit(getters(style = "ref"), setters(prefix = "with"))]
#[derive(Debug, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UserEvent {
  /// The name of the event
  #[viewit(
    getter(const, attrs(doc = "Returns the name of the event")),
    setter(attrs(doc = "Sets the name of the event (Builder pattern)"))
  )]
  name: SmolStr,
  /// The payload of the event
  #[viewit(
    getter(const, attrs(doc = "Returns the payload of the event")),
    setter(attrs(doc = "Sets the payload of the event (Builder pattern)"))
  )]
  payload: Bytes,
}

/// Error that can occur when transforming a [`UserEvent`]
#[derive(Debug, thiserror::Error)]
pub enum UserEventTransformError {
  /// Not enough bytes to decode UserEvent
  #[error("not enough bytes to decode `UserEvent`")]
  NotEnoughBytes,
  /// Encode buffer too small
  #[error("encode buffer too small")]
  BufferTooSmall,

  /// Error transforming SmolStr
  #[error(transparent)]
  Name(#[from] StringTransformError),

  /// Error transforming Bytes
  #[error(transparent)]
  Payload(#[from] BytesTransformError),
}

impl Transformable for UserEvent {
  type Error = UserEventTransformError;

  fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error> {
    let encoded_len = self.encoded_len();
    if dst.len() < encoded_len {
      return Err(Self::Error::BufferTooSmall);
    }

    let mut offset = 0;
    NetworkEndian::write_u32(&mut dst[offset..], encoded_len as u32);
    offset += 4;

    offset += self.name.encode(&mut dst[offset..])?;
    offset += self.payload.encode(&mut dst[offset..])?;

    debug_assert_eq!(
      offset, encoded_len,
      "expect write {} bytes, actual read {} bytes",
      encoded_len, offset
    );

    Ok(offset)
  }

  fn encoded_len(&self) -> usize {
    4 + self.name.encoded_len() + self.payload.encoded_len()
  }

  fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>
  where
    Self: Sized,
  {
    let src_len = src.len();
    if src_len < 4 {
      return Err(Self::Error::NotEnoughBytes);
    }

    let len = NetworkEndian::read_u32(&src[0..4]) as usize;
    if src_len < len {
      return Err(Self::Error::NotEnoughBytes);
    }

    let mut offset = 4;
    let (name_offset, name) = SmolStr::decode(&src[offset..])?;
    offset += name_offset;
    let (payload_offset, payload) = Bytes::decode(&src[offset..])?;
    offset += payload_offset;

    debug_assert_eq!(
      offset, len,
      "expect read {} bytes, actual read {} bytes",
      len, offset
    );

    Ok((len, Self { name, payload }))
  }
}

/// Used for user-generated events
#[viewit::viewit(setters(prefix = "with"))]
#[derive(Debug, Default, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UserEventMessage {
  /// The lamport time
  #[viewit(
    getter(
      const,
      style = "move",
      attrs(doc = "Returns the lamport time for this message")
    ),
    setter(
      const,
      attrs(doc = "Sets the lamport time for this message (Builder pattern)")
    )
  )]
  ltime: LamportTime,
  /// The name of the event
  #[viewit(
    getter(const, attrs(doc = "Returns the name of the event")),
    setter(attrs(doc = "Sets the name of the event (Builder pattern)"))
  )]
  name: SmolStr,
  /// The payload of the event
  #[viewit(
    getter(const, attrs(doc = "Returns the payload of the event")),
    setter(attrs(doc = "Sets the payload of the event (Builder pattern)"))
  )]
  payload: Bytes,
  /// "Can Coalesce".
  #[viewit(
    getter(
      const,
      style = "move",
      attrs(doc = "Returns if this message can be coalesced")
    ),
    setter(
      const,
      attrs(doc = "Sets if this message can be coalesced (Builder pattern)")
    )
  )]
  cc: bool,
}

impl CheapClone for UserEventMessage {
  fn cheap_clone(&self) -> Self {
    Self {
      ltime: self.ltime,
      name: self.name.cheap_clone(),
      payload: self.payload.clone(),
      cc: self.cc,
    }
  }
}

/// Error that can occur when transforming a [`UserEventMessage`]
#[derive(Debug, thiserror::Error)]
pub enum UserEventMessageTransformError {
  /// Not enough bytes to decode UserEventMessage
  #[error("not enough bytes to decode `UserEventMessage`")]
  NotEnoughBytes,
  /// Encode buffer too small
  #[error("encode buffer too small")]
  BufferTooSmall,

  /// Error transforming LamportTime
  #[error(transparent)]
  LamportTime(#[from] LamportTimeTransformError),

  /// Error transforming SmolStr
  #[error(transparent)]
  Name(#[from] StringTransformError),

  /// Error transforming Bytes
  #[error(transparent)]
  Payload(#[from] BytesTransformError),
}

impl Transformable for UserEventMessage {
  type Error = UserEventMessageTransformError;

  fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error> {
    let encoded_len = self.encoded_len();
    if dst.len() < encoded_len {
      return Err(Self::Error::BufferTooSmall);
    }

    let mut offset = 0;
    NetworkEndian::write_u32(&mut dst[offset..], encoded_len as u32);
    offset += 4;
    dst[offset] = self.cc as u8;
    offset += 1;
    offset += self.ltime.encode(&mut dst[offset..])?;
    offset += self.name.encode(&mut dst[offset..])?;
    offset += self.payload.encode(&mut dst[offset..])?;

    debug_assert_eq!(
      offset, encoded_len,
      "expect write {} bytes, actual read {} bytes",
      encoded_len, offset
    );

    Ok(offset)
  }

  fn encoded_len(&self) -> usize {
    4 + self.ltime.encoded_len() + self.name.encoded_len() + self.payload.encoded_len() + 1
  }

  fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>
  where
    Self: Sized,
  {
    let src_len = src.len();
    if src_len < 4 {
      return Err(Self::Error::NotEnoughBytes);
    }

    let len = NetworkEndian::read_u32(&src[0..4]) as usize;
    if src_len < len {
      return Err(Self::Error::NotEnoughBytes);
    }

    let mut offset = 4;
    let cc = src[offset] != 0;
    offset += 1;
    let (ltime_offset, ltime) = LamportTime::decode(&src[offset..])?;
    offset += ltime_offset;
    let (name_offset, name) = SmolStr::decode(&src[offset..])?;
    offset += name_offset;
    let (payload_offset, payload) = Bytes::decode(&src[offset..])?;
    offset += payload_offset;

    debug_assert_eq!(
      offset, len,
      "expect read {} bytes, actual read {} bytes",
      len, offset
    );

    Ok((
      len,
      Self {
        ltime,
        name,
        payload,
        cc,
      },
    ))
  }
}

#[cfg(test)]
mod tests {
  use rand::{distributions::Alphanumeric, random, Rng};

  use super::*;

  impl UserEvent {
    fn random(size: usize) -> Self {
      let rng = rand::thread_rng();
      let name = rng
        .sample_iter(&Alphanumeric)
        .take(size)
        .collect::<Vec<u8>>();
      let name = String::from_utf8(name).unwrap();

      let rng = rand::thread_rng();
      let payload = rng
        .sample_iter(&Alphanumeric)
        .take(size)
        .collect::<Vec<u8>>();

      Self {
        name: name.into(),
        payload: payload.into(),
      }
    }
  }

  impl UserEvents {
    pub(crate) fn random(size: usize, num_events: usize) -> Self {
      let mut events = OneOrMore::with_capacity(num_events);
      for _ in 0..num_events {
        events.push(UserEvent::random(size));
      }

      Self {
        ltime: LamportTime::random(),
        events,
      }
    }
  }

  impl UserEventMessage {
    fn random(size: usize) -> Self {
      let rng = rand::thread_rng();
      let name = rng
        .sample_iter(&Alphanumeric)
        .take(size)
        .collect::<Vec<u8>>();
      let name = String::from_utf8(name).unwrap();

      let rng = rand::thread_rng();
      let payload = rng
        .sample_iter(&Alphanumeric)
        .take(size)
        .collect::<Vec<u8>>();

      Self {
        ltime: LamportTime::random(),
        name: name.into(),
        payload: payload.into(),
        cc: random(),
      }
    }
  }

  #[test]
  fn test_user_event_transform() {
    futures::executor::block_on(async {
      for i in 0..100 {
        let event = UserEvent::random(i);
        let mut buf = vec![0; event.encoded_len()];
        let encoded_len = event.encode(&mut buf).unwrap();
        assert_eq!(encoded_len, event.encoded_len());

        let (decoded_len, decoded) = UserEvent::decode(&buf).unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, event);

        let (decoded_len, decoded) =
          UserEvent::decode_from_reader(&mut std::io::Cursor::new(&buf)).unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, event);

        let (decoded_len, decoded) =
          UserEvent::decode_from_async_reader(&mut futures::io::Cursor::new(&buf))
            .await
            .unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, event);
      }
    })
  }

  #[test]
  fn test_user_events_transform() {
    futures::executor::block_on(async {
      for i in 0..100 {
        let events = UserEvents::random(i, i % 10);
        let mut buf = vec![0; events.encoded_len()];
        let encoded_len = events.encode(&mut buf).unwrap();
        assert_eq!(encoded_len, events.encoded_len());

        let (decoded_len, decoded) = UserEvents::decode(&buf).unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, events);

        let (decoded_len, decoded) =
          UserEvents::decode_from_reader(&mut std::io::Cursor::new(&buf)).unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, events);

        let (decoded_len, decoded) =
          UserEvents::decode_from_async_reader(&mut futures::io::Cursor::new(&buf))
            .await
            .unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, events);
      }
    })
  }

  #[test]
  fn test_user_event_message_transform() {
    futures::executor::block_on(async {
      for i in 0..100 {
        let event = UserEventMessage::random(i);
        let mut buf = vec![0; event.encoded_len()];
        let encoded_len = event.encode(&mut buf).unwrap();
        assert_eq!(encoded_len, event.encoded_len());

        let (decoded_len, decoded) = UserEventMessage::decode(&buf).unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, event);

        let (decoded_len, decoded) =
          UserEventMessage::decode_from_reader(&mut std::io::Cursor::new(&buf)).unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, event);

        let (decoded_len, decoded) =
          UserEventMessage::decode_from_async_reader(&mut futures::io::Cursor::new(&buf))
            .await
            .unwrap();
        assert_eq!(decoded_len, encoded_len);
        assert_eq!(decoded, event);
      }
    })
  }
}