[ECO-4567] Implemented msgpack support

- Updated IMPLEMENTATION_MSGPACK_FROM_NEWTONSOFT plan
- Accordingly added msgpack annotations for relevant models
- Created separate project for generating msgpack serializers pre-compile time

Author: sacOO7

IMPLEMENTATION_MSGPACK_FROM_NEWTONSOFT.md

@@ -72,4 +72,7 @@
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
   </PropertyGroup>
 
+  <!-- Import MsgPack serializer generation targets -->
+  <Import Project="..\IO.Ably.Shared.MsgPack\IO.Ably.Shared.MsgPack.targets" Condition="Exists('..\IO.Ably.Shared.MsgPack\IO.Ably.Shared.MsgPack.targets')" />
+
 </Project>

IMPL_MSGPACK.md

@@ -0,0 +1,56 @@
+using IO.Ably.Types;
+using MsgPack;
+using MsgPack.Serialization;
+using Newtonsoft.Json.Linq;
+
+namespace IO.Ably.CustomSerialisers
+{
+#pragma warning disable SA1600 // Elements should be documented
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+    public class MessageExtrasMessagePackSerializer : MessagePackSerializer<MessageExtras>
+    {
+        public MessageExtrasMessagePackSerializer(SerializationContext ownerContext)
+            : base(ownerContext)
+        {
+        }
+
+        protected override void PackToCore(Packer packer, MessageExtras objectTree)
+        {
+            if (objectTree == null)
+            {
+                packer.PackNull();
+                return;
+            }
+
+            var json = objectTree.ToJson();
+            if (json == null)
+            {
+                packer.PackNull();
+            }
+            else
+            {
+                // Serialize as JSON string for compatibility
+                packer.Pack(json.ToString(Newtonsoft.Json.Formatting.None));
+            }
+        }
+
+        protected override MessageExtras UnpackFromCore(Unpacker unpacker)
+        {
+            if (unpacker.LastReadData.IsNil)
+            {
+                return null;
+            }
+
+            var jsonString = unpacker.LastReadData.AsString();
+            if (string.IsNullOrEmpty(jsonString))
+            {
+                return null;
+            }
+
+            var jToken = JToken.Parse(jsonString);
+            return MessageExtras.From(jToken);
+        }
+    }
+#pragma warning restore SA1600 // Elements should be documented
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
+}

src/IO.Ably.NETStandard20/IO.Ably.NETStandard20.csproj

@@ -11,6 +11,7 @@
   <ItemGroup>
     <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\CapabilityMessagePackSerializer.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\DateTimeOffsetMessagePackSerializer.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\MessageExtrasMessagePackSerializer.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\GeneratedSerializers\IO_Ably_Auth_TokenDetailsSerializer.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\GeneratedSerializers\IO_Ably_CapabilitySerializer.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\GeneratedSerializers\IO_Ably_ConnectionDetailsMessageSerializer.cs" />
@@ -33,4 +34,4 @@
     <Compile Include="$(MSBuildThisFileDirectory)CustomSerialisers\TimespanMessagePackSerializer.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)MsgPackHelper.cs" />
   </ItemGroup>
-</Project>
+</Project>

src/IO.Ably.Shared.MsgPack/CustomSerialisers/MessageExtrasMessagePackSerializer.cs

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  
+  <PropertyGroup>
+    <MsgPackGeneratorProject>$(MSBuildThisFileDirectory)..\..\tools\MsgPackSerializerGenerator\MsgPackSerializerGenerator.csproj</MsgPackGeneratorProject>
+    <MsgPackOutputDirectory>$(MSBuildThisFileDirectory)CustomSerialisers\GeneratedSerializers</MsgPackOutputDirectory>
+  </PropertyGroup>
+
+  <!-- Generate MsgPack serializers before compilation -->
+  <Target Name="GenerateMsgPackSerializers" BeforeTargets="CoreCompile" Condition="'$(DesignTimeBuild)' != 'true' AND '$(BuildingProject)' == 'true'">
+    <Message Text="Generating MsgPack serializers..." Importance="high" />
+    
+    <!-- Build the generator tool first -->
+    <MSBuild Projects="$(MsgPackGeneratorProject)" Targets="Build" Properties="Configuration=$(Configuration)" />
+    
+    <!-- Run the generator tool -->
+    <Exec Command="dotnet &quot;$(MSBuildThisFileDirectory)..\..\tools\MsgPackSerializerGenerator\bin\$(Configuration)\net6.0\MsgPackSerializerGenerator.dll&quot; &quot;$(MsgPackOutputDirectory)&quot;"
+          WorkingDirectory="$(MSBuildThisFileDirectory)" />
+    
+    <Message Text="MsgPack serializers generated successfully" Importance="high" />
+  </Target>
+
+  <!-- Clean generated files -->
+  <Target Name="CleanMsgPackSerializers" BeforeTargets="CoreClean">
+    <ItemGroup>
+      <GeneratedSerializers Include="$(MsgPackOutputDirectory)\*.cs" />
+    </ItemGroup>
+    <Delete Files="@(GeneratedSerializers)" />
+  </Target>
+
+  <!-- Include generated files in compilation -->
+  <ItemGroup>
+    <Compile Include="$(MsgPackOutputDirectory)\*.cs" />
+  </ItemGroup>
+
+</Project>

src/IO.Ably.Shared.MsgPack/IO.Ably.Shared.MsgPack.projitems

@@ -20,6 +20,7 @@ private static SerializationContext GetContext()
             var context = new SerializationContext() { SerializationMethod = SerializationMethod.Map };
             context.Serializers.Register(new DateTimeOffsetMessagePackSerializer(context));
             context.Serializers.Register(new TimespanMessagePackSerializer(context));
+            context.Serializers.Register(new MessageExtrasMessagePackSerializer(context));
             context.Serializers.Register(new IO_Ably_CapabilitySerializer(context));
             context.Serializers.Register(new IO_Ably_TokenRequestSerializer(context));
             context.Serializers.Register(new IO_Ably_Auth_TokenDetailsSerializer(context));

src/IO.Ably.Shared.MsgPack/IO.Ably.Shared.MsgPack.targets

@@ -1,76 +1,89 @@
-using Newtonsoft.Json;
+using MsgPack.Serialization;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
 namespace IO.Ably.Push
 {
     /// <summary>
     /// Class representing a Device registered for Ably push notifications.
     /// </summary>
+    [MessagePackObject]
     public class DeviceDetails
     {
         /// <summary>
         /// Device Id.
         /// </summary>
+        [Key(0)]
         [JsonProperty("id")]
         public string Id { get; set; }
 
         /// <summary>
         /// Device platform. One of 'android', 'ios' or 'browser').
         /// </summary>
+        [Key(1)]
         [JsonProperty("platform")]
         public string Platform { get; set; }
 
         /// <summary>
         /// Device form factor. One of 'phone', 'tablet', 'desktop', 'tv', 'watch', 'car' or 'embedded'.
         /// </summary>
+        [Key(2)]
         [JsonProperty("formFactor")]
         public string FormFactor { get; set; }
 
         /// <summary>
         /// Device ClientId which is associated with the push registration.
         /// </summary>
+        [Key(3)]
         [JsonProperty("clientId")]
         public string ClientId { get; set; }
 
         /// <summary>
         /// Device Metadata. It's a flexible key value pair. Usually used to tag devices.
         /// </summary>
+        [Key(4)]
         [JsonProperty("metadata")]
         public JObject Metadata { get; set; }
 
         /// <summary>
         /// Push registration data.
         /// </summary>
+        [Key(5)]
         [JsonProperty("push")]
         public PushData Push { get; set; } = new PushData();
 
         /// <summary>
         /// Random string which is automatically generated when a new LocalDevice is created and can be used to authenticate PushAdmin Rest requests.
         /// </summary>
+        [Key(6)]
         [JsonProperty("deviceSecret")]
         public string DeviceSecret { get; set; }
 
         /// <summary>
         /// Class describing Push data.
         /// </summary>
+        [MessagePackObject]
         public class PushData
         {
             /// <summary>
             /// Push Recipient. Currently supporter recipients are Apple (apns), Google (fcm) and Browser (web).
             /// For more information - https://ably.com/docs/rest-api#post-device-registration.
             /// </summary>
+            [Key(0)]
             [JsonProperty("recipient")]
             public JObject Recipient { get; set; }
 
             /// <summary>
             /// State of the push integration.
             /// </summary>
+            [Key(1)]
             [JsonProperty("state")]
             public string State { get; set; }
 
             /// <summary>
             /// Error registering device as a PushTarget.
             /// </summary>
+            [Key(2)]
             [JsonProperty("errorReason")]
             public ErrorInfo ErrorReason { get; set; }
         }

src/IO.Ably.Shared.MsgPack/MsgPackHelper.cs

@@ -1,27 +1,32 @@
-using Newtonsoft.Json;
+using MsgPack.Serialization;
+using Newtonsoft.Json;
 
 namespace IO.Ably.Push
 {
     /// <summary>
     /// Represents a push channel subscription.
     /// </summary>
+    [MessagePackObject]
     public class PushChannelSubscription
     {
         /// <summary>
         /// Name of the channel.
         /// </summary>
+        [Key(0)]
         [JsonProperty("channel")]
         public string Channel { get; set; }
 
         /// <summary>
         /// Device id attached to the subscription.
         /// </summary>
+        [Key(1)]
         [JsonProperty("deviceId")]
         public string DeviceId { get; set; }
 
         /// <summary>
         /// Client id attached to the channel.
         /// </summary>
+        [Key(2)]
         [JsonProperty("clientId")]
         public string ClientId { get; set; }
 

src/IO.Ably.Shared/Push/DeviceDetails.cs

@@ -1,84 +1,100 @@
-using Newtonsoft.Json;
+using MsgPack.Serialization;
+using Newtonsoft.Json;
 
 namespace IO.Ably.Rest
 {
 #pragma warning disable SA1307
 #pragma warning disable SA1600
 
+    [MessagePackObject]
     public class ChannelDetails
     {
         /// <summary>
         /// The required name of the channel including any qualifier, if any.
         /// </summary>
+        [Key(0)]
         [JsonProperty("channelId")]
         public string ChannelId { get; set; }
 
         /// <summary>
         /// The status and occupancy stats for the channel.
         /// </summary>
+        [Key(1)]
         [JsonProperty("status")]
         public ChannelStatus Status { get; set; }
     }
 
+    [MessagePackObject]
     public class ChannelStatus
     {
         /// <summary>
         /// Indicates whether the channel that is the subject of the event is active.
         /// </summary>
+        [Key(0)]
         [JsonProperty("isActive")]
         public bool IsActive { get; set; }
 
         /// <summary>
         /// Metadata relating to the occupants of the channel.
         /// </summary>
+        [Key(1)]
         [JsonProperty("occupancy")]
         public ChannelOccupancy Occupancy { get; set; }
     }
 
     /// <summary>
     /// Metadata relating to the occupants of the channel.
     /// </summary>
+    [MessagePackObject]
     public class ChannelOccupancy
     {
+        [Key(0)]
         [JsonProperty("metrics")]
         public ChannelMetrics Metrics { get; set; }
     }
 
+    [MessagePackObject]
     public class ChannelMetrics
     {
         /// <summary>
         /// The number of connections.
         /// </summary>
+        [Key(0)]
         [JsonProperty("connections")]
         public int Connections { get; set; }
 
         /// <summary>
         /// The number of connections attached to the channel that are authorised to publish.
         /// </summary>
+        [Key(1)]
         [JsonProperty("publishers")]
         public int Publishers { get; set; }
 
         /// <summary>
         /// The number of connections attached that are authorised to subscribe to messages.
         /// </summary>
+        [Key(2)]
         [JsonProperty("subscribers")]
         public int Subscribers { get; set; }
 
         /// <summary>
         /// The number of connections that are authorised to enter members into the presence channel.
         /// </summary>
+        [Key(3)]
         [JsonProperty("presenceConnections")]
         public int PresenceConnections { get; set; }
 
         /// <summary>
         /// The number of members currently entered into the presence channel.
         /// </summary>
+        [Key(4)]
         [JsonProperty("presenceMembers")]
         public int PresenceMembers { get; set; }
 
         /// <summary>
         /// The number of connections that are authorised to subscribe to presence messages.
         /// </summary>
+        [Key(5)]
         [JsonProperty("presenceSubscribers")]
         public int PresenceSubscribers { get; set; }
     }