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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
pub mod framing {
    #[cfg(feature = "delim-framing")]
    pub mod delim {
        use memchr::memmem;

        use crate::codec::{self, Framing};

        /// Splits a buffer into frames by byte sequence delimeter
        #[derive(Debug)]
        struct DelimeterFraming {
            finder: memmem::Finder<'static>,
            cursor: usize,
        }

        impl Framing for DelimeterFraming {
            fn try_framing(
                &mut self,
                buffer: &[u8],
            ) -> Result<Option<codec::FramingAdvanceResult>, codec::FramingError> {
                let buf = &buffer[self.cursor..];
                if let Some(pos) = self.finder.find(buf) {
                    let valid_data_end = self.cursor + pos;
                    let next_frame_start = valid_data_end + self.finder.needle().len();
                    self.cursor = next_frame_start;
                    Ok(Some(codec::FramingAdvanceResult { valid_data_end, next_frame_start }))
                } else {
                    // Remain some margin to not miss the delimeter
                    self.cursor += buffer.len().saturating_sub(self.finder.needle().len());
                    Ok(None)
                }
            }

            fn advance(&mut self) {
                self.cursor = 0;
            }

            fn next_buffer_size(&self) -> Option<std::num::NonZeroUsize> {
                None
            }
        }

        pub fn by_delim(delim: &[u8]) -> impl Framing {
            DelimeterFraming { cursor: 0, finder: memmem::Finder::new(delim).into_owned() }
        }
    }
}

#[cfg(feature = "msgpack-rpc")]
pub mod msgpack_rpc {
    use std::{borrow::Cow, num::NonZeroU64};

    use ::bytes::Buf;
    use bytes::{BufMut, BytesMut};
    use derive_setters::Setters;
    use serde::Deserialize;

    use crate::codec::{self, DecodeError::InvalidFormat, EncodeError};

    #[derive(Setters, Debug, Default)]
    #[setters(prefix = "with_")]
    pub struct Codec {
        /// If specified, the codec will wrap the provided parameter to array automatically.
        /// Otherwise, the caller should wrap the parameter within array manually.
        ///
        /// > [Reference](https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md#params)
        auto_wrapping: bool,

        /// On deseiralization, if the parameter is an array with single element, the codec will
        /// unwrap the array and use the element as the parameter. Otherwise, the parameter will be
        /// deserialized as an array.
        unwrap_mono_param: bool,
    }

    impl codec::Codec for Codec {
        fn encode_notify(
            &self,
            method: &str,
            params: &dyn erased_serde::Serialize,
            write: &mut BytesMut,
        ) -> Result<(), EncodeError> {
            use rmp::encode::*;

            let mut write = write.writer();
            write_array_len(&mut write, 3).unwrap();
            write_uint(&mut write, 2).unwrap();
            write_str(&mut write, method).unwrap();

            if self.auto_wrapping {
                write_array_len(&mut write, 1).unwrap();
            }

            params
                .erased_serialize(&mut <dyn erased_serde::Serializer>::erase(
                    &mut rmp_serde::Serializer::new(write).with_struct_map(),
                ))
                .unwrap();

            Ok(())
        }

        fn encode_request(
            &self,
            method: &str,
            req_id_hint: NonZeroU64,
            params: &dyn erased_serde::Serialize,
            write: &mut BytesMut,
        ) -> Result<std::num::NonZeroU64, EncodeError> {
            use rmp::encode::*;
            let mut write = write.writer();
            let write = &mut write;

            write_array_len(write, 4).unwrap();
            write_uint(write, 0).unwrap();

            let as_32bit = req_id_hint.get() as u32;
            write_u32(write, as_32bit).unwrap();
            write_str(write, method).unwrap();

            if self.auto_wrapping {
                write_array_len(write, 1).unwrap();
            }

            params
                .erased_serialize(&mut <dyn erased_serde::Serializer>::erase(
                    &mut rmp_serde::Serializer::new(write).with_struct_map(),
                ))
                .unwrap();

            Ok((as_32bit as u64).try_into().unwrap())
        }

        fn encode_response(
            &self,
            req_id: codec::ReqIdRef,
            encode_as_error: bool,
            response: &dyn erased_serde::Serialize,
            write: &mut BytesMut,
        ) -> Result<(), EncodeError> {
            use rmp::encode::*;
            let mut write = write.writer();
            let write = &mut write;
            write_array_len(write, 4).unwrap();

            write_uint(write, 1).unwrap();
            write_uint(
                write,
                *req_id
                    .as_u64()
                    .ok_or(EncodeError::UnsupportedDataFormat("unsupported non-integer".into()))?
                    as u32 as _,
            )
            .unwrap();

            let serialize = |v: &mut dyn std::io::Write| {
                response
                    .erased_serialize(&mut <dyn erased_serde::Serializer>::erase(
                        &mut rmp_serde::Serializer::new(v).with_struct_map(),
                    ))
                    .unwrap();
            };

            if encode_as_error {
                serialize(write);
                write_nil(write).unwrap();
            } else {
                write_nil(write).unwrap();
                serialize(write);
            }

            Ok(())
        }

        fn decode_inbound(
            &self,
            data: &[u8],
        ) -> Result<(codec::InboundFrameType, std::ops::Range<usize>), codec::DecodeError> {
            use rmp::decode::*;
            let mut rd = data;

            fn efmt<T>(e: impl Into<Cow<'static, str>>) -> impl FnOnce(T) -> codec::DecodeError {
                |_| InvalidFormat(e.into())
            }

            let arr_len = read_array_len(&mut rd).map_err(efmt("Non-msgpack array format"))?;
            if arr_len < 2 || arr_len > 4 {
                return Err(InvalidFormat(format!("Invalid array length {arr_len}").into()));
            }

            let offset_of = |s: &[u8]| s.as_ptr() as usize - data.as_ptr() as usize;
            let skip_single_value = |rd: &mut &[u8]| {
                serde::de::IgnoredAny::deserialize(&mut rmp_serde::Deserializer::new(rd))
                    .map_err(efmt("parameter read failed"))
            };

            let msg_type: u32 = read_int(&mut rd).map_err(efmt("Non-msgpack integer format"))?;
            match (arr_len, msg_type) {
                // Request
                (4, 0) | (3, 2) => {
                    let mut req_id = None;
                    if msg_type == 0 {
                        req_id = Some(read_int::<u32, _>(&mut rd).map_err(efmt("rd: not req_id"))?);
                    };

                    let method_len = read_str_len(&mut rd).map_err(efmt("rd: not method"))?;
                    let method_offset = offset_of(rd);
                    rd.advance(method_len as _);

                    // Now we're reading the payload ..
                    if self.unwrap_mono_param {
                        if 1 == read_array_len(&mut rd.clone())
                            .map_err(efmt("rd: non-array param"))?
                        {
                            // Advance the cursor by array marker, to unwrap payload.
                            read_array_len(&mut rd).ok();
                        }
                    }

                    let (obj_begin, _, obj_end) =
                        (offset_of(rd), skip_single_value(&mut rd)?, offset_of(rd));

                    Ok((
                        if let Some(req_id) = req_id {
                            codec::InboundFrameType::Request {
                                method: method_offset..method_offset + method_len as usize,
                                req_id: codec::ReqId::U64(req_id as _),
                            }
                        } else {
                            codec::InboundFrameType::Notify {
                                method: method_offset..method_offset + method_len as usize,
                            }
                        },
                        obj_begin..obj_end,
                    ))
                }

                // Response
                (4, 1) => {
                    let req_id = read_int::<u32, _>(&mut rd).map_err(efmt("req_id error"))?;
                    let is_error = if read_nil(&mut (rd.clone())).is_ok() {
                        // Error was nil, so it's a success response.
                        rd = &rd[1..];
                        false
                    } else {
                        true
                    };

                    let (obj_begin, _, obj_end) =
                        (offset_of(rd), skip_single_value(&mut rd)?, offset_of(rd));

                    Ok((
                        codec::InboundFrameType::Response {
                            req_id: codec::ReqId::U64(req_id as _),
                            req_id_hash: req_id as _,
                            is_error,
                        },
                        obj_begin..obj_end,
                    ))
                }

                (al, msg) => {
                    return Err(InvalidFormat(
                        format!("Invalid message type {msg}, with {al} args").into(),
                    ));
                }
            }
        }

        fn decode_payload<'a>(
            &self,
            payload: &'a [u8],
            decode: &mut dyn FnMut(
                &mut dyn erased_serde::Deserializer<'a>,
            ) -> Result<(), erased_serde::Error>,
        ) -> Result<(), codec::DecodeError> {
            decode(&mut <dyn erased_serde::Deserializer>::erase(
                &mut rmp_serde::Deserializer::new(payload),
            ))?;
            Ok(())
        }
    }
}

#[cfg(feature = "jsonrpc")]
pub mod jsonrpc {
    use std::num::NonZeroU64;

    use bytes::{BufMut, BytesMut};
    use serde_json::value::RawValue;

    use crate::codec::{self, InboundFrameType, ReqId, ReqIdRef};

    #[derive(Debug, Default)]
    pub struct Codec {}

    #[derive(serde::Serialize, serde::Deserialize)]
    #[serde(untagged)]
    enum MsgId<'a> {
        Int(u64),
        Str(&'a str),
        Null,
    }

    #[derive(serde::Serialize)]
    struct SerMsg<'a, T: serde::Serialize + ?Sized> {
        jsonrpc: JsonRpcTag,

        #[serde(skip_serializing_if = "Option::is_none")]
        method: Option<&'a str>,

        #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
        id: Option<MsgId<'a>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        params: Option<&'a T>,

        #[serde(skip_serializing_if = "Option::is_none")]
        error: Option<SerErrObj<'a, T>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        result: Option<&'a T>,
    }

    #[derive(serde::Serialize)]
    struct SerErrObj<'a, T: serde::Serialize + ?Sized> {
        code: i64,
        message: &'a str,
        data: &'a T,
    }

    impl<'a, T: serde::Serialize + ?Sized> Default for SerMsg<'a, T> {
        fn default() -> Self {
            Self {
                jsonrpc: Default::default(),
                method: Default::default(),
                id: Default::default(),
                params: Default::default(),
                error: Default::default(),
                result: Default::default(),
            }
        }
    }

    #[derive(Default)]
    struct JsonRpcTag;

    impl serde::Serialize for JsonRpcTag {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: serde::Serializer,
        {
            serializer.serialize_str("2.0")
        }
    }

    impl<'de> serde::Deserialize<'de> for JsonRpcTag {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: serde::Deserializer<'de>,
        {
            <&str>::deserialize(deserializer).and_then(|x| {
                if x == "2.0" {
                    Ok(JsonRpcTag)
                } else {
                    Err(serde::de::Error::custom("Invalid JSON-RPC version"))
                }
            })
        }
    }

    #[derive(Default, serde::Deserialize)]
    struct DeMsgFrame<'a> {
        #[serde(rename = "jsonrpc")]
        _jsonrpc: JsonRpcTag,

        #[serde(borrow, default)]
        method: Option<&'a str>,

        #[serde(borrow, default)]
        id: Option<MsgId<'a>>,

        #[serde(borrow, default)]
        params: Option<&'a RawValue>,

        #[serde(borrow, default)]
        error: Option<&'a RawValue>,

        #[serde(borrow, default)]
        result: Option<&'a RawValue>,
    }

    impl codec::Codec for Codec {
        fn encode_notify(
            &self,
            method: &str,
            params: &dyn erased_serde::Serialize,
            write: &mut BytesMut,
        ) -> Result<(), codec::EncodeError> {
            serde_json::to_writer(
                write.writer(),
                &SerMsg { method: Some(method), params: Some(params), ..Default::default() },
            )
            .map_err(|e| codec::EncodeError::SerializeError(e.into()))?;
            Ok(())
        }

        fn encode_request(
            &self,
            method: &str,
            req_id_hint: NonZeroU64,
            params: &dyn erased_serde::Serialize,
            write: &mut BytesMut,
        ) -> Result<std::num::NonZeroU64, codec::EncodeError> {
            // Make sure the request ID rotate within 53 bits. (JS's max safe integer)
            let req_id = req_id_hint.get() & ((1 << 53) - 1);

            serde_json::to_writer(
                write.writer(),
                &SerMsg {
                    method: Some(method),
                    id: Some(MsgId::Int(req_id)),
                    params: Some(params),
                    ..Default::default()
                },
            )
            .map_err(|e| codec::EncodeError::SerializeError(e.into()))?;
            Ok(req_id.try_into().unwrap())
        }

        fn encode_response(
            &self,
            req_id: ReqIdRef,
            encode_as_error: bool,
            response: &dyn erased_serde::Serialize,
            write: &mut BytesMut,
        ) -> Result<(), codec::EncodeError> {
            serde_json::to_writer(
                write.writer(),
                &SerMsg {
                    id: Some(match req_id {
                        ReqIdRef::U64(value) => MsgId::Int(value),
                        ReqIdRef::Bytes(value) => {
                            std::str::from_utf8(value).map_or(MsgId::Null, MsgId::Str)
                        }
                    }),
                    error: {
                        (encode_as_error == true).then_some(SerErrObj {
                            code: -1,
                            message: "Error from 'rpc_it::codecs::jsonrpc'",
                            data: response,
                        })
                    },
                    result: (encode_as_error == false).then_some(response),
                    ..Default::default()
                },
            )
            .map_err(|e| codec::EncodeError::SerializeError(e.into()))?;
            Ok(())
        }

        fn encode_response_predefined(
            &self,
            req_id: ReqIdRef,
            response: &codec::PredefinedResponseError,
            write: &mut BytesMut,
        ) -> Result<(), codec::EncodeError> {
            // XXX: New type for predefined response error?
            self.encode_response(req_id, true, response, write)
        }

        fn try_decode_predef_error<'a>(
            &self,
            payload: &'a [u8],
        ) -> Option<codec::PredefinedResponseError> {
            // TODO: Support predefined error decoding
            let _ = payload;
            None
        }

        fn decode_inbound(
            &self,
            data: &[u8],
        ) -> Result<(InboundFrameType, std::ops::Range<usize>), codec::DecodeError> {
            let f = serde_json::from_slice::<DeMsgFrame>(data)
                .map_err(|e| codec::DecodeError::Other(e.into()))?;

            let data_range_of = |x: &[u8]| {
                let offset = x.as_ptr() as usize - data.as_ptr() as usize;
                offset..offset + x.len()
            };

            let method_range = f.method.map(|x| data_range_of(x.as_bytes()));
            let req_id = match &f.id {
                Some(MsgId::Int(x)) => Some(ReqId::U64(*x)),
                Some(MsgId::Str(x)) => Some(ReqId::Bytes(data_range_of(x.as_bytes()))),
                Some(MsgId::Null) => {
                    return Err(codec::DecodeError::InvalidFormat(
                        "Null request ID returned".into(),
                    ))
                }
                None => None,
            };

            Ok(match (&f.id, f.method, f.params, f.error, f.result) {
                // ID, Method, (Params) => Request
                (Some(_id), Some(_), payload, None, None) => (
                    InboundFrameType::Request {
                        method: method_range.unwrap(),
                        req_id: req_id.unwrap(),
                    },
                    payload.map(|value| data_range_of(value.get().as_bytes())).unwrap_or(0..0),
                ),

                // Method, (Params) => Notify
                (None, Some(_), payload, None, None) => (
                    InboundFrameType::Notify { method: method_range.unwrap() },
                    payload.map(|value| data_range_of(value.get().as_bytes())).unwrap_or(0..0),
                ),

                // ID, (Error | Result) => Response
                (Some(_id), None, None, e, r) if e.is_some() ^ r.is_some() => {
                    let MsgId::Int(req_id) = f.id.unwrap() else {
                        return Err(codec::DecodeError::InvalidFormat(
                            "We don't use string request ID types.".into(),
                        ));
                    };

                    (
                        InboundFrameType::Response {
                            req_id: ReqId::U64(req_id),
                            req_id_hash: req_id,
                            is_error: e.is_some(),
                        },
                        data_range_of(e.or(r).unwrap().get().as_bytes()),
                    )
                }

                _ => {
                    return Err(codec::DecodeError::InvalidFormat(
                        format!(
                            "Invalid json-rpc with fields: \
							 [id?={},method?={},params?={},error?={},result?={}]",
                            f.id.is_some(),
                            f.method.is_some(),
                            f.params.is_some(),
                            f.error.is_some(),
                            f.result.is_some()
                        )
                        .into(),
                    ))
                }
            })
        }

        fn decode_payload<'a>(
            &self,
            payload: &'a [u8],
            decode: &mut dyn FnMut(
                &mut dyn erased_serde::Deserializer<'a>,
            ) -> Result<(), erased_serde::Error>,
        ) -> Result<(), codec::DecodeError> {
            decode(&mut <dyn erased_serde::Deserializer>::erase(
                &mut serde_json::Deserializer::from_slice(payload),
            ))?;
            Ok(())
        }
    }
}