dyn-encoding 0.0.1

Wire-format codec abstraction (protobuf, JSON, CBOR; flatbuffers/capnp/bebop/BSON to follow) for the Riak protocol layer
Documentation
//! `application/json` codec backed by `serde_json`.

use std::collections::HashMap;

use serde::de::DeserializeOwned;
use serde::Serialize;

use crate::error::CodecError;
use crate::value::{ErasedWireValue, WireCodec, WireTypeId, WireValue};

type EncodeFn =
    Box<dyn Fn(&dyn ErasedWireValue) -> Result<Vec<u8>, CodecError> + Send + Sync + 'static>;
type DecodeFn =
    Box<dyn Fn(&[u8]) -> Result<Box<dyn ErasedWireValue>, CodecError> + Send + Sync + 'static>;

/// Codec that serialises [`WireValue`] types as JSON.
///
/// Types must be registered through [`Self::register`] before they
/// can be encoded or decoded. Registration installs the
/// `serde_json::to_vec` / `serde_json::from_slice` paths under the
/// type's [`WireTypeId`].
#[derive(Default)]
pub struct JsonCodec {
    encoders: HashMap<WireTypeId, EncodeFn>,
    decoders: HashMap<WireTypeId, DecodeFn>,
}

impl JsonCodec {
    /// Construct an empty JSON codec with no registered types.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Register a [`WireValue`] type with the codec. Once registered,
    /// values of `T` can be encoded through this codec and bytes can
    /// be decoded back into `T` via [`WireCodec::decode`].
    pub fn register<T>(&mut self) -> &mut Self
    where
        T: WireValue + Serialize + DeserializeOwned,
    {
        let id = T::wire_type_id();
        self.encoders.insert(
            id,
            Box::new(
                move |v: &dyn ErasedWireValue| -> Result<Vec<u8>, CodecError> {
                    let concrete = v
                        .as_any()
                        .downcast_ref::<T>()
                        .ok_or(CodecError::TypeMismatch { expected: id })?;
                    serde_json::to_vec(concrete).map_err(CodecError::encode_failure)
                },
            ),
        );
        self.decoders.insert(
            id,
            Box::new(
                move |bytes: &[u8]| -> Result<Box<dyn ErasedWireValue>, CodecError> {
                    let value: T =
                        serde_json::from_slice(bytes).map_err(CodecError::decode_failure)?;
                    Ok(Box::new(value))
                },
            ),
        );
        self
    }

    /// Number of message types registered with this codec.
    #[must_use]
    pub fn registered_type_count(&self) -> usize {
        self.encoders.len()
    }
}

impl WireCodec for JsonCodec {
    fn content_type(&self) -> &'static str {
        "application/json"
    }

    fn encode(&self, value: &dyn ErasedWireValue) -> Result<Vec<u8>, CodecError> {
        let id = value.type_id();
        let encoder = self
            .encoders
            .get(&id)
            .ok_or(CodecError::UnknownTypeId(id))?;
        encoder(value)
    }

    fn decode(
        &self,
        type_id: WireTypeId,
        bytes: &[u8],
    ) -> Result<Box<dyn ErasedWireValue>, CodecError> {
        let decoder = self
            .decoders
            .get(&type_id)
            .ok_or(CodecError::UnknownTypeId(type_id))?;
        decoder(bytes)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde::{Deserialize, Serialize};

    #[derive(Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
    struct Sample {
        name: String,
        seq: u32,
        payload: Vec<u8>,
    }

    impl WireValue for Sample {
        fn wire_type_id() -> WireTypeId {
            WireTypeId::new("test.json.Sample")
        }
    }

    #[derive(Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
    struct Other {
        x: i32,
    }

    impl WireValue for Other {
        fn wire_type_id() -> WireTypeId {
            WireTypeId::new("test.json.Other")
        }
    }

    fn fixture() -> Sample {
        Sample {
            name: "alpha".into(),
            seq: 42,
            payload: vec![0, 1, 2, 0xfe, 0xff],
        }
    }

    #[test]
    fn round_trip_recovers_value() {
        let mut codec = JsonCodec::new();
        codec.register::<Sample>();
        let v = fixture();
        let bytes = codec.encode(&v).expect("encode");
        let back = codec
            .decode(Sample::wire_type_id(), &bytes)
            .expect("decode");
        let back = back.as_any().downcast_ref::<Sample>().expect("downcast");
        assert_eq!(back, &v);
    }

    #[test]
    fn idempotent_encode_is_byte_equal() {
        let mut codec = JsonCodec::new();
        codec.register::<Sample>();
        let v = fixture();
        let a = codec.encode(&v).expect("encode 1");
        let b = codec.encode(&v).expect("encode 2");
        assert_eq!(a, b);
        // Round-trip then re-encode is also byte-equal.
        let back = codec.decode(Sample::wire_type_id(), &a).expect("decode");
        let c = codec.encode(back.as_ref()).expect("encode 3");
        assert_eq!(a, c);
    }

    #[test]
    fn unregistered_type_returns_unknown_type_id_on_encode() {
        let codec = JsonCodec::new();
        let v = fixture();
        let err = codec.encode(&v).expect_err("expected unknown type");
        assert!(matches!(err, CodecError::UnknownTypeId(id) if id == Sample::wire_type_id()));
    }

    #[test]
    fn unregistered_type_returns_unknown_type_id_on_decode() {
        let codec = JsonCodec::new();
        let err = codec
            .decode(Sample::wire_type_id(), b"{}")
            .expect_err("expected unknown type");
        assert!(matches!(err, CodecError::UnknownTypeId(id) if id == Sample::wire_type_id()));
    }

    #[test]
    fn malformed_bytes_yield_decode_failure() {
        let mut codec = JsonCodec::new();
        codec.register::<Sample>();
        let err = codec
            .decode(Sample::wire_type_id(), b"{not valid json")
            .expect_err("expected decode failure");
        assert!(matches!(err, CodecError::Decode(_)));
    }

    #[test]
    fn registered_type_count_tracks_registrations() {
        let mut codec = JsonCodec::new();
        assert_eq!(codec.registered_type_count(), 0);
        codec.register::<Sample>();
        assert_eq!(codec.registered_type_count(), 1);
        codec.register::<Other>();
        assert_eq!(codec.registered_type_count(), 2);
    }
}