/src/MassTransit.Tests/Serialization/JsonSerialization_Specs.cs

// Copyright 2007-2011 Chris Patterson, Dru Sellers, Travis Smith, et. al.

//  

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use 

// this file except in compliance with the License. You may obtain a copy of the 

// License at 

// 

//     http://www.apache.org/licenses/LICENSE-2.0 

// 

// Unless required by applicable law or agreed to in writing, software distributed 

// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 

// CONDITIONS OF ANY KIND, either express or implied. See the License for the 

// specific language governing permissions and limitations under the License.

namespace MassTransit.Tests.Serialization

{

	using System;

	using System.Collections.Generic;

	using System.Diagnostics;

	using System.IO;

	using System.Linq;

	using System.Text;

	using System.Xml.Linq;

	using Magnum.Reflection;

	using Magnum.TestFramework;

	using MassTransit.Serialization;

	using Newtonsoft.Json;

	using Newtonsoft.Json.Converters;

	using Newtonsoft.Json.Linq;

	using Newtonsoft.Json.Serialization;

	using NUnit.Framework;



	[Scenario]

	public class When_serializing_messages_with_json_dot_net

	{

		string _body;

		Envelope _envelope;

		TestMessage _message;

		JsonSerializer _serializer;

		XDocument _xml;

		static Type _proxyType = InterfaceImplementationBuilder.GetProxyFor(typeof(MessageA));

		JsonSerializer _deserializer;





		[When]

		public void Serializing_messages_with_json_dot_net()

		{

			_message = new TestMessage

				{

					Name = "Joe",

					Details = new List<TestMessageDetail>

						{

							new TestMessageDetail {Item = "A", Value = 27.5d},

							new TestMessageDetail {Item = "B", Value = 13.5d},

						},

                    DateTimeProperty = new DateTime(2014,03,05,01,53,04,193),

                    DateTimeStringProperty = "2014-03-05T01:53:04.193",

                    Dictionary = new Dictionary<string, string>()

                    {

                        {"string-datetime-property","2014-03-05T01:53:04.193"}

                    }

				};



			_envelope = new Envelope

				{

					Message = _message,

				};



			_envelope.MessageType.Add(_message.GetType().ToMessageName());

			_envelope.MessageType.Add(typeof (MessageA).ToMessageName());

			_envelope.MessageType.Add(typeof (MessageB).ToMessageName());



		    _serializer = JsonMessageSerializer.Serializer;

            _deserializer = JsonMessageSerializer.Deserializer;



			using (var memoryStream = new MemoryStream())

			using (var writer = new StreamWriter(memoryStream))

			using (var jsonWriter = new JsonTextWriter(writer))

			{

				jsonWriter.Formatting = Formatting.Indented;

				_serializer.Serialize(jsonWriter, _envelope);



				writer.Flush();

				_body = Encoding.UTF8.GetString(memoryStream.ToArray());

			}

			

			_xml = JsonConvert.DeserializeXNode(_body, "envelope");

		}



		[Then, Explicit]

		public void Show_me_the_message()

		{

			Trace.WriteLine(_body);

			Trace.WriteLine(_xml.ToString());

		}



		[Then]

		public void Should_be_able_to_ressurect_the_message()

		{

			Envelope result;

			using (var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(_body), false))

			using (var reader = new StreamReader(memoryStream))

			using (var jsonReader = new JsonTextReader(reader))

			{

				result = _deserializer.Deserialize<Envelope>(jsonReader);

			}



			result.MessageType.Count.ShouldEqual(3);

			result.MessageType[0].ShouldEqual(typeof (TestMessage).ToMessageName());

			result.MessageType[1].ShouldEqual(typeof (MessageA).ToMessageName());

			result.MessageType[2].ShouldEqual(typeof (MessageB).ToMessageName());

			result.Headers.Count.ShouldEqual(0);

		}



		[Then]

		public void Should_be_able_to_suck_out_an_interface()

		{

			Envelope result;

			using (var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(_body), false))

			using (var reader = new StreamReader(memoryStream))

			using (var jsonReader = new JsonTextReader(reader))

			{

				result = _deserializer.Deserialize<Envelope>(jsonReader);

			}



			using(var jsonReader = new JTokenReader(result.Message as JToken))

			{

				Type proxyType = InterfaceImplementationBuilder.GetProxyFor(typeof (MessageA));

				var message = (MessageA) FastActivator.Create(proxyType);



				_serializer.Populate(jsonReader, message);



				message.Name.ShouldEqual("Joe");

			}

		}



		[Then]

		public void Should_be_able_to_suck_out_an_object()

		{

			Envelope result;

			using (var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(_body), false))

			using (var reader = new StreamReader(memoryStream))

			using (var jsonReader = new JsonTextReader(reader))

			{

				result = _deserializer.Deserialize<Envelope>(jsonReader);

			}



			using(var jsonReader = new JTokenReader(result.Message as JToken))

			{

				var message = (TestMessage) _serializer.Deserialize(jsonReader, typeof (TestMessage));



				message.Name.ShouldEqual("Joe");

				message.Details.Count.ShouldEqual(2);

			}

		}



        [Then]

        public void Should_roundtrip_dates_as_string_or_datetime()

        {

            Envelope result;

            using (var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(_body), false))

            using (var reader = new StreamReader(memoryStream))

            using (var jsonReader = new JsonTextReader(reader))

            {

                result = _deserializer.Deserialize<Envelope>(jsonReader);

            }



            using (var jsonReader = new JTokenReader(result.Message as JToken))

            {

                var message = (TestMessage)_serializer.Deserialize(jsonReader, typeof(TestMessage));



                // DateTimes are properly serialized / deserialized

                // however, string properties containing a date-string are somehow

                // converted to a Datetime somewhere in deserialization

                // fixed by adding DateParseHandling = DateParseHandling.None to serializer settings

                message.DateTimeProperty.ShouldEqual(new DateTime(2014, 03, 05, 01, 53, 04, 193),"Round ripping DateTimeProperty failed");

                message.DateTimeStringProperty.ShouldEqual("2014-03-05T01:53:04.193","Roundtripping DateTimeStringProperty failed");

                message.Dictionary["string-datetime-property"].ShouldEqual("2014-03-05T01:53:04.193","Roundtripping datetimestring in dictionary failed");

            }

        }



		[Then]

		public void Should_be_able_to_ressurect_the_message_from_xml()

		{

			XDocument document = XDocument.Parse(_xml.ToString());

			Trace.WriteLine(_xml.ToString());

			string body = JsonConvert.SerializeXNode(document, Formatting.None, true);

			Trace.WriteLine(body);

			var result = JsonConvert.DeserializeObject<Envelope>(body, new JsonSerializerSettings

				{

					Converters = new List<JsonConverter>(new JsonConverter[]{new ListJsonConverter()}),

					NullValueHandling = NullValueHandling.Ignore,

					DefaultValueHandling = DefaultValueHandling.Ignore,

					MissingMemberHandling = MissingMemberHandling.Ignore,

					ObjectCreationHandling = ObjectCreationHandling.Auto,

					ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor,

					ContractResolver = new CamelCasePropertyNamesContractResolver(),

				});



			result.MessageType.Count.ShouldEqual(3);

			result.MessageType[0].ShouldEqual(typeof (TestMessage).ToMessageName());

			result.MessageType[1].ShouldEqual(typeof (MessageA).ToMessageName());

			result.MessageType[2].ShouldEqual(typeof (MessageB).ToMessageName());

			result.Headers.Count.ShouldEqual(0);

		}



		[Then]

		public void Serialization_speed()

		{

			//warm it up

			for (int i = 0; i < 10; i++)

			{

				DoSerialize();

				DoDeserialize();

			}



			Stopwatch timer = Stopwatch.StartNew();



			const int iterations = 50000;



			for (int i = 0; i < iterations; i++)

			{

				DoSerialize();

			}



			timer.Stop();



			long perSecond = iterations*1000/timer.ElapsedMilliseconds;



			string msg = string.Format("Serialize: {0}ms, Rate: {1} m/s", timer.ElapsedMilliseconds, perSecond);

			Trace.WriteLine(msg);



			timer = Stopwatch.StartNew();



			for (int i = 0; i < 50000; i++)

			{

				DoDeserialize();

			}



			timer.Stop();



			perSecond = iterations*1000/timer.ElapsedMilliseconds;



			msg = string.Format("Deserialize: {0}ms, Rate: {1} m/s", timer.ElapsedMilliseconds, perSecond);

			Trace.WriteLine(msg);

		}



		void DoSerialize()

		{

			using (var memoryStream = new MemoryStream())

			using (var writer = new StreamWriter(memoryStream))

			using (var jsonWriter = new JsonTextWriter(writer))

			{

				jsonWriter.Formatting = Formatting.Indented;

				_serializer.Serialize(jsonWriter, _envelope);



				writer.Flush();

				_body = Encoding.UTF8.GetString(memoryStream.ToArray());

			}

		}



		void DoDeserialize()

		{

			Envelope result;

			using (var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(_body), false))

			using (var reader = new StreamReader(memoryStream))

			using (var jsonReader = new JsonTextReader(reader))

			{

				result = _deserializer.Deserialize<Envelope>(jsonReader);

			}



			using (var jsonReader = new JTokenReader(result.Message as JToken))

			{

				var message = (MessageA)FastActivator.Create(_proxyType);



				_serializer.Populate(jsonReader, message);



			}

		}



		class Envelope

		{

			public Envelope()

			{

				Headers = new Dictionary<string, string>();

				MessageType = new List<string>();

			}



			public IDictionary<string, string> Headers { get; set; }

			public object Message { get; set; }

			public IList<string> MessageType { get; set; }

		}



		class TestMessageDetail

		{

			public string Item { get; set; }

			public double Value { get; set; }

		}



		class TestMessage :

			MessageA

		{

			public string Address { get; set; }

			public IList<TestMessageDetail> Details { get; set; }

			public int Level { get; set; }

			public string Name { get; set; }

            public DateTime DateTimeProperty { get; set; }

            public string DateTimeStringProperty { get; set; }

            public Dictionary<string,string> Dictionary { get; set; } 

		}





		public static object Convert(string s)

		{

			object obj = JsonConvert.DeserializeObject(s);

			if (obj is string)

			{

				return obj as string;

			}



			return ConvertJson((JToken) obj);

		}



		public interface MessageA

		{

			string Name { get; }

		}



		public interface MessageB

		{

			string Address { get; }

			string Name { get; }

		}



		static object ConvertJson(JToken token)

		{

			if (token is JValue)

			{

				return ((JValue) token).Value;

			}



			if (token is JObject)

			{

				IDictionary<string, object> expando = new Dictionary<string, object>();



				(from childToken in (token) where childToken is JProperty select childToken as JProperty).ToList().ForEach(

					property => { expando.Add(property.Name, ConvertJson(property.Value)); });

				return expando;

			}



			if (token is JArray)

			{

				return (token).Select(ConvertJson).ToList();

			}



			throw new ArgumentException(string.Format("Unknown token type '{0}'", token.GetType()), "token");

		}

	}



    [TestFixture]

  public class Using_JsonConverterAttribute_on_a_class :

    SerializationTest<JsonMessageSerializer>

  {

    public class ModifyWhenSerializingConverter : JsonConverter

    {

      public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

      {

        writer.WriteStartObject();



        writer.WritePropertyName("value");

        writer.WriteValue("Monster");



        writer.WriteEndObject();

      }



      public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

      {

        reader.Read();

        reader.Value.ShouldEqual("value");

        reader.Read();

        var value = (string)reader.Value;

        return new MessageA { Value = value };

      }



      public override bool CanConvert(Type objectType)

      {

        return typeof(MessageA).IsAssignableFrom(objectType);

      }

    }



    public class ModifyWhenDeserializingConverter : JsonConverter

    {

      public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

      {

        var testMessage = (MessageB)value;

        writer.WriteStartObject();



        writer.WritePropertyName("value");

        writer.WriteValue(testMessage.Value);



        writer.WriteEndObject();

      }



      public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

      {

        return new MessageB { Value = "Monster" };

      }



      public override bool CanConvert(Type objectType)

      {

        return typeof(MessageB).IsAssignableFrom(objectType);

      }

    }



    [JsonConverter(typeof(ModifyWhenSerializingConverter))]

    public class MessageA

    {

      public string Value { get; set; }

    }



    [JsonConverter(typeof(ModifyWhenDeserializingConverter))]

    public class MessageB

    {

      public string Value { get; set; }

    }



    [Test]

    public void Should_use_converter_for_serialization()

    {

      var obj = new MessageA { Value = "Joe" };



      MessageA result = SerializeAndReturn(obj);



      result.Value.ShouldEqual("Monster");

    }



    [Test]

    public void Should_use_converter_for_deserialization()

    {

      var obj = new MessageB { Value = "Joe" };



      MessageB result = SerializeAndReturn(obj);



      result.Value.ShouldEqual("Monster");

    }

  }



  [TestFixture]

  public class Using_JsonConverterAttribute_on_a_property :

    SerializationTest<JsonMessageSerializer>

  {

    public class ModifyWhenSerializingConverter : JsonConverter

    {

      public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

      {

        writer.WriteValue("Monster");

      }



      public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

      {

        return reader.Value;

      }



      public override bool CanConvert(Type objectType)

      {

        return typeof(string).IsAssignableFrom(objectType);

      }

    }



    public class ModifyWhenDeserializingConverter : JsonConverter

    {

      public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

      {

        writer.WriteValue((string)value);

      }



      public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

      {

        return "Monster";

      }



      public override bool CanConvert(Type objectType)

      {

        return typeof(string).IsAssignableFrom(objectType);

      }

    }



    public class SimpleMessage

    {

      [JsonConverter(typeof(ModifyWhenSerializingConverter))]

      public string ValueA { get; set; }



      [JsonConverter(typeof(ModifyWhenDeserializingConverter))]

      public string ValueB { get; set; }

    }



    [Test]

    public void Should_use_converter_for_serialization()

    {

      var obj = new SimpleMessage { ValueA = "Joe" };



      SimpleMessage result = SerializeAndReturn(obj);



      result.ValueA.ShouldEqual("Monster");

    }



    [Test]

    public void Should_use_converter_for_deserialization()

    {

      var obj = new SimpleMessage { ValueB = "Joe" };



      SimpleMessage result = SerializeAndReturn(obj);



      result.ValueB.ShouldEqual("Monster");

    }

  }

}