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
526
527
528
529
530
531
pub(crate) mod f_cancel;
pub(crate) mod f_error;
pub(crate) mod f_payload;
pub(crate) mod f_request_channel;
pub(crate) mod f_request_fnf;
pub(crate) mod f_request_n;
pub(crate) mod f_request_response;
pub(crate) mod f_request_stream;
pub(crate) mod header;
pub(crate) mod metadata;
pub(crate) mod request_payload;

use bytes::Bytes;

use self::f_cancel::Cancel;
use self::f_error::ErrorFrame;
use self::f_payload::PayloadFrame;
use self::f_request_channel::RequestChannel;
use self::f_request_fnf::RequestFnF;
use self::f_request_n::RequestN;
use self::f_request_response::RequestResponse;
use self::f_request_stream::RequestStream;
use crate::{Error, PayloadError};

/// The type that holds the bitmask for Frame flags.
pub type FrameFlags = u16;

/// Six (6) bytes reserved for FrameHeader information.
#[derive()]
#[cfg_attr(not(target = "wasm32-unknown-unknown"), derive(Debug))]
#[must_use]
pub struct FrameHeader {
  /// The header bytes.
  pub header: Bytes,
}

#[derive(Clone, Default)]
#[cfg_attr(not(target = "wasm32-unknown-unknown"), derive(Debug))]
#[must_use]
/// A complete [Payload] object that includes metadata and data bytes.
pub struct RawPayload {
  /// Metadata bytes if they exist.
  pub metadata: Option<Bytes>,
  /// The core payload data bytes if it exists.
  pub data: Option<Bytes>,
}

/// Metadata associated with the frame.
#[derive(Clone)]
#[cfg_attr(not(target = "wasm32-unknown-unknown"), derive(Debug))]
#[cfg_attr(feature = "derive_serde", derive(serde::Serialize, serde::Deserialize))]
#[must_use]
pub struct Metadata {
  /// The operation index.
  pub index: u32,
  /// The stream name.
  pub extra: Option<Bytes>,
}

#[derive(Copy, Clone, Eq, PartialEq, Debug)]
#[cfg_attr(feature = "derive_serde", derive(serde::Serialize, serde::Deserialize))]
/// Frame types from https://rsocket.io/about/protocol
#[allow(missing_docs)]
pub enum FrameType {
  Reserved,
  Setup,
  Lease,
  Keepalive,
  RequestResponse,
  RequestFnf,
  RequestStream,
  RequestChannel,
  RequestN,
  Cancel,
  Payload,
  Err,
  MetadataPush,
  Resume,
  ResumeOk,
  Ext,
}
impl std::fmt::Display for FrameType {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    let name = match self {
      Self::Reserved => "RESERVED",
      Self::Setup => "SETUP",
      Self::Lease => "LEASE",
      Self::Keepalive => "KEEPALIVE",
      Self::RequestResponse => "REQUEST_RESPONSE",
      Self::RequestFnf => "REQUEST_FNF",
      Self::RequestStream => "REQUEST_STREAM",
      Self::RequestChannel => "REQUEST_CHANNEL",
      Self::RequestN => "REQUEST_N",
      Self::Cancel => "CANCEL",
      Self::Payload => "PAYLOAD",
      Self::Err => "ERROR",
      Self::MetadataPush => "METADATA_PUSH",
      Self::Resume => "RESUME",
      Self::ResumeOk => "RESUME_OK",
      Self::Ext => "EXT",
    };
    f.write_str(name)
  }
}
impl TryFrom<u8> for FrameType {
  type Error = String;
  fn try_from(index: u8) -> Result<Self, Self::Error> {
    match index {
      0 => Ok(Self::Reserved),
      1 => Ok(Self::Setup),
      2 => Ok(Self::Lease),
      3 => Ok(Self::Keepalive),
      4 => Ok(Self::RequestResponse),
      5 => Ok(Self::RequestFnf),
      6 => Ok(Self::RequestStream),
      7 => Ok(Self::RequestChannel),
      8 => Ok(Self::RequestN),
      9 => Ok(Self::Cancel),
      10 => Ok(Self::Payload),
      11 => Ok(Self::Err),
      12 => Ok(Self::MetadataPush),
      13 => Ok(Self::Resume),
      14 => Ok(Self::ResumeOk),
      63 => Ok(Self::Ext),
      _ => Err(format!("{} is not a valid index for FrameType", index)),
    }
  }
}

impl From<FrameType> for u32 {
  fn from(value: FrameType) -> Self {
    match value {
      FrameType::Reserved => unreachable!(),
      FrameType::Setup => 1,
      FrameType::Lease => 2,
      FrameType::Keepalive => 3,
      FrameType::RequestResponse => 4,
      FrameType::RequestFnf => 5,
      FrameType::RequestStream => 6,
      FrameType::RequestChannel => 7,
      FrameType::RequestN => 8,
      FrameType::Cancel => 9,
      FrameType::Payload => 10,
      FrameType::Err => 11,
      FrameType::MetadataPush => 12,
      FrameType::Resume => 13,
      FrameType::ResumeOk => 14,
      FrameType::Ext => 63,
    }
  }
}

#[derive(Clone, Copy)]
#[cfg_attr(not(target = "wasm32-unknown-unknown"), derive(Debug))]
#[must_use]
/// Frame flags come from https://rsocket.io/about/protocol
#[allow(missing_docs)]
pub enum FrameFlag {
  Metadata,
  Follows,
  Complete,
  Next,
  Ignore,
}
impl std::fmt::Display for FrameFlag {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    let flag = match self {
      Self::Metadata => "M",
      Self::Follows => "FRS",
      Self::Complete => "CL",
      Self::Next => "N",
      Self::Ignore => "I",
    };
    f.write_str(flag)
  }
}
impl TryFrom<u32> for FrameFlag {
  type Error = String;
  fn try_from(index: u32) -> Result<Self, Self::Error> {
    match index {
      0 => Ok(Self::Metadata),
      1 => Ok(Self::Follows),
      2 => Ok(Self::Complete),
      3 => Ok(Self::Next),
      4 => Ok(Self::Ignore),
      _ => Err(format!("{} is not a valid index for FrameFlag", index)),
    }
  }
}

impl From<FrameFlag> for u32 {
  fn from(value: FrameFlag) -> Self {
    match value {
      FrameFlag::Metadata => 0,
      FrameFlag::Follows => 1,
      FrameFlag::Complete => 2,
      FrameFlag::Next => 3,
      FrameFlag::Ignore => 4,
    }
  }
}

/// RSocket Error Codes
#[derive(Copy, Clone)]
#[cfg_attr(not(target = "wasm32-unknown-unknown"), derive(Debug))]
#[must_use]
/// Error codes come from https://rsocket.io/about/protocol
#[allow(missing_docs)]
pub enum ErrorCode {
  InvalidSetup,
  UnsupportedSetup,
  RejectedSetup,
  RejectedResume,
  ConnectionError,
  ConnectionClose,
  ApplicationError,
  Rejected,
  Canceled,
  Invalid,
  Reserved,
}
impl TryFrom<u32> for ErrorCode {
  type Error = String;
  fn try_from(index: u32) -> Result<Self, Self::Error> {
    match index {
      1 => Ok(Self::InvalidSetup),
      2 => Ok(Self::UnsupportedSetup),
      3 => Ok(Self::RejectedSetup),
      4 => Ok(Self::RejectedResume),
      257 => Ok(Self::ConnectionError),
      258 => Ok(Self::ConnectionClose),
      513 => Ok(Self::ApplicationError),
      514 => Ok(Self::Rejected),
      515 => Ok(Self::Canceled),
      516 => Ok(Self::Invalid),
      4294967295 => Ok(Self::Reserved),
      _ => Err(format!("{} is not a valid index for ErrorCode", index)),
    }
  }
}

impl From<ErrorCode> for u32 {
  fn from(value: ErrorCode) -> Self {
    match value {
      ErrorCode::InvalidSetup => 1,
      ErrorCode::UnsupportedSetup => 2,
      ErrorCode::RejectedSetup => 3,
      ErrorCode::RejectedResume => 4,
      ErrorCode::ConnectionError => 257,
      ErrorCode::ConnectionClose => 258,
      ErrorCode::ApplicationError => 513,
      ErrorCode::Rejected => 514,
      ErrorCode::Canceled => 515,
      ErrorCode::Invalid => 516,
      ErrorCode::Reserved => 4294967295,
    }
  }
}

#[derive(Clone)]
#[cfg_attr(not(target = "wasm32-unknown-unknown"), derive(Debug))]
#[must_use]
/// An enum that can hold any time of wasmrs frame.
#[allow(missing_docs)]
pub enum Frame {
  PayloadFrame(PayloadFrame),
  Cancel(Cancel),
  ErrorFrame(ErrorFrame),
  RequestN(RequestN),
  RequestResponse(RequestResponse),
  RequestFnF(RequestFnF),
  RequestStream(RequestStream),
  RequestChannel(RequestChannel),
}

impl RawPayload {
  /// Create a new payload with the passed metadata and data bytes.
  pub fn new(metadata: Bytes, data: Bytes) -> Self {
    Self {
      metadata: Some(metadata),
      data: Some(data),
    }
  }

  /// Create new payload with just data and no metadata set yet.
  pub fn new_data(metadata: Option<Bytes>, data: Option<Bytes>) -> Self {
    Self { metadata, data }
  }

  /// Create an empty payload.
  pub fn empty() -> Self {
    Self {
      metadata: None,
      data: None,
    }
  }

  /// Parse the metadata bytes into a [Metadata] object.
  pub fn parse_metadata(&mut self) -> Result<Metadata, Error> {
    if self.metadata.is_none() {
      return Err(crate::Error::MetadataNotFound);
    }
    let bytes = self.metadata.as_mut().unwrap();
    Metadata::decode(bytes)
  }
}

impl From<Frame> for Result<Option<RawPayload>, PayloadError> {
  fn from(frame: Frame) -> Self {
    match frame {
      Frame::PayloadFrame(frame) => Ok(Some(RawPayload::new(frame.metadata, frame.data))),
      Frame::Cancel(_frame) => todo!(),
      Frame::ErrorFrame(frame) => Err(crate::PayloadError::new(frame.code, frame.data, frame.metadata)),
      Frame::RequestN(_frame) => todo!(),
      Frame::RequestResponse(frame) => Ok(Some(RawPayload::new(frame.0.metadata, frame.0.data))),
      Frame::RequestFnF(frame) => Ok(Some(RawPayload::new(frame.0.metadata, frame.0.data))),
      Frame::RequestStream(frame) => Ok(Some(RawPayload::new(frame.0.metadata, frame.0.data))),
      Frame::RequestChannel(frame) => Ok(Some(RawPayload::new(frame.0.metadata, frame.0.data))),
    }
  }
}

impl Frame {
  pub(crate) const LEN_HEADER: usize = 6;
  /// The IGNORE bit
  pub const FLAG_IGNORE: FrameFlags = 1 << 4;
  /// The NEXT bit
  pub const FLAG_NEXT: FrameFlags = 1 << 5;
  /// The COMPLETE bit
  pub const FLAG_COMPLETE: FrameFlags = 1 << 6;
  /// The FOLLOW bit
  pub const FLAG_FOLLOW: FrameFlags = 1 << 7;
  /// The METADATA bit
  pub const FLAG_METADATA: FrameFlags = 1 << 8;
  /// The maximum number of N for RequestN
  pub const REQUEST_MAX: u32 = 0x7FFF_FFFF; // 2147483647

  #[must_use]
  /// Get the stream id for the frame.
  pub fn stream_id(&self) -> u32 {
    match self {
      Frame::PayloadFrame(frame) => frame.stream_id,
      Frame::Cancel(frame) => frame.stream_id,
      Frame::ErrorFrame(frame) => frame.stream_id,
      Frame::RequestN(frame) => frame.stream_id,
      Frame::RequestResponse(frame) => frame.0.stream_id,
      Frame::RequestFnF(frame) => frame.0.stream_id,
      Frame::RequestStream(frame) => frame.0.stream_id,
      Frame::RequestChannel(frame) => frame.0.stream_id,
    }
  }

  #[must_use]
  /// Get the set flags for the frame.
  pub fn get_flag(&self) -> FrameFlags {
    match self {
      Frame::PayloadFrame(frame) => frame.get_flag(),
      Frame::Cancel(frame) => frame.get_flag(),
      Frame::ErrorFrame(frame) => frame.get_flag(),
      Frame::RequestN(frame) => frame.get_flag(),
      Frame::RequestResponse(frame) => frame.get_flag(),
      Frame::RequestFnF(frame) => frame.get_flag(),
      Frame::RequestStream(frame) => frame.get_flag(),
      Frame::RequestChannel(frame) => frame.get_flag(),
    }
  }

  #[must_use]
  /// Get the [FrameType].
  pub fn frame_type(&self) -> FrameType {
    match self {
      Frame::PayloadFrame(_) => FrameType::Payload,
      Frame::Cancel(_) => FrameType::Cancel,
      Frame::ErrorFrame(_) => FrameType::Err,
      Frame::RequestN(_) => FrameType::RequestN,
      Frame::RequestResponse(_) => FrameType::RequestResponse,
      Frame::RequestFnF(_) => FrameType::RequestFnf,
      Frame::RequestStream(_) => FrameType::RequestStream,
      Frame::RequestChannel(_) => FrameType::RequestChannel,
    }
  }

  /// Decode [Bytes] into a [Frame].
  pub fn decode(mut bytes: Bytes) -> Result<Frame, (u32, Error)> {
    let header = FrameHeader::from_bytes(bytes.split_to(Frame::LEN_HEADER));
    let stream_id = header.stream_id();
    Self::_decode(header, bytes).map_err(|e| (stream_id, e))
  }

  pub(crate) fn _decode(header: FrameHeader, buffer: Bytes) -> Result<Frame, Error> {
    let frame = match header.frame_type() {
      FrameType::Reserved => todo!(),
      FrameType::Setup => todo!(),
      FrameType::RequestResponse => {
        Frame::RequestResponse(f_request_response::RequestResponse::decode_frame(&header, buffer)?)
      }
      FrameType::RequestFnf => Frame::RequestFnF(f_request_fnf::RequestFnF::decode_frame(&header, buffer)?),
      FrameType::RequestStream => Frame::RequestStream(f_request_stream::RequestStream::decode_frame(&header, buffer)?),
      FrameType::RequestChannel => {
        Frame::RequestChannel(f_request_channel::RequestChannel::decode_frame(&header, buffer)?)
      }
      FrameType::RequestN => Frame::RequestN(f_request_n::RequestN::decode_frame(&header, buffer)?),
      FrameType::Cancel => Frame::Cancel(Cancel {
        stream_id: header.stream_id(),
      }),
      FrameType::Payload => Frame::PayloadFrame(f_payload::PayloadFrame::decode_frame(&header, buffer)?),
      FrameType::Err => Frame::ErrorFrame(f_error::ErrorFrame::decode_frame(&header, buffer)?),
      FrameType::Ext => todo!(),
      _ => unreachable!(),
    };
    Ok(frame)
  }

  #[must_use]
  /// Encode the [Frame] into a byte buffer.
  pub fn encode(self) -> Bytes {
    match self {
      Frame::PayloadFrame(f) => f.encode(),
      Frame::Cancel(f) => f.encode(),
      Frame::ErrorFrame(f) => f.encode(),
      Frame::RequestN(f) => f.encode(),
      Frame::RequestResponse(f) => f.encode(),
      Frame::RequestFnF(f) => f.encode(),
      Frame::RequestStream(f) => f.encode(),
      Frame::RequestChannel(f) => f.encode(),
    }
  }

  /// Create a new [ErrorFrame].
  pub fn new_error(stream_id: u32, e: PayloadError) -> Frame {
    Frame::ErrorFrame(ErrorFrame {
      stream_id,
      metadata: e.metadata,
      code: e.code,
      data: e.msg,
    })
  }

  /// Create a new [Cancel] frame.
  pub fn new_cancel(stream_id: u32) -> Frame {
    Frame::Cancel(Cancel { stream_id })
  }

  /// Create a new [RequestN] frame.
  pub fn new_request_n(stream_id: u32, n: u32, _flags: FrameFlags) -> Frame {
    Frame::RequestN(RequestN { stream_id, n })
  }

  /// Create a new [RequestResponse] frame.
  pub fn new_request_response(stream_id: u32, payload: RawPayload, flags: FrameFlags) -> Frame {
    Frame::RequestResponse(RequestResponse::from_payload(stream_id, payload, flags, 0))
  }

  /// Create a new [RequestStream] frame.
  pub fn new_request_stream(stream_id: u32, payload: RawPayload, flags: FrameFlags) -> Frame {
    Frame::RequestStream(RequestStream::from_payload(stream_id, payload, flags, 0))
  }

  /// Create a new [RequestChannel] frame.
  pub fn new_request_channel(stream_id: u32, payload: RawPayload, flags: FrameFlags, initial_n: u32) -> Frame {
    Frame::RequestChannel(RequestChannel::from_payload(stream_id, payload, flags, initial_n))
  }

  /// Create a new [RequestFnF] (Fire & Forget) frame
  pub fn new_request_fnf(stream_id: u32, payload: RawPayload, flags: FrameFlags) -> Frame {
    Frame::RequestFnF(RequestFnF::from_payload(stream_id, payload, flags, 0))
  }

  /// Create a new [PayloadFrame].
  pub fn new_payload(stream_id: u32, payload: RawPayload, flags: FrameFlags) -> Frame {
    Frame::PayloadFrame(PayloadFrame::from_payload(stream_id, payload, flags))
  }
}

trait RSocketFrame<T> {
  const FRAME_TYPE: FrameType;
  fn check_type(header: &FrameHeader) -> Result<(), Error> {
    if header.frame_type() == Self::FRAME_TYPE {
      Ok(())
    } else {
      Err(crate::Error::WrongType)
    }
  }
  fn kind(&self) -> FrameType {
    Self::FRAME_TYPE
  }
  fn stream_id(&self) -> u32;
  fn decode_all(buffer: Bytes) -> Result<T, Error>;
  fn decode_frame(header: &FrameHeader, buffer: Bytes) -> Result<T, Error>;
  fn encode(self) -> Bytes;
  fn gen_header(&self) -> FrameHeader;
  fn get_flag(&self) -> FrameFlags {
    0
  }
}

/// Utility trait to check the flags of a frame.
pub trait RSocketFlags {
  /// Check if the next flag is set.
  fn flag_next(&self) -> bool;
  /// Check if the metadata flag is set.
  fn flag_metadata(&self) -> bool;
  /// Check if the complete flag is set.
  fn flag_complete(&self) -> bool;
  /// Check if the follow flag is set.
  fn flag_follows(&self) -> bool;
  /// Check if the ignore flag is set.
  fn flag_ignore(&self) -> bool;
}

impl RSocketFlags for FrameFlags {
  fn flag_next(&self) -> bool {
    self & Frame::FLAG_NEXT == Frame::FLAG_NEXT
  }

  fn flag_metadata(&self) -> bool {
    self & Frame::FLAG_METADATA == Frame::FLAG_METADATA
  }

  fn flag_complete(&self) -> bool {
    self & Frame::FLAG_COMPLETE == Frame::FLAG_COMPLETE
  }

  fn flag_follows(&self) -> bool {
    self & Frame::FLAG_FOLLOW == Frame::FLAG_FOLLOW
  }

  fn flag_ignore(&self) -> bool {
    self & Frame::FLAG_IGNORE == Frame::FLAG_IGNORE
  }
}