Fix serializer settings issues (#73)

* fix: upgrade & add newtonsoft

* fix: prevent setting from being overriden

* fix: implement a raw SubscribeMessage

* fix: add missing meta files

* fix: updated ProjectSettings.asset

* PubNub SDK v6.0.5 release.

Co-authored-by: Michał Dobrzański <[email protected]>
Co-authored-by: Client Engineering Bot <[email protected]>

Author: 3 people

.pubnub.yml

@@ -1,6 +1,11 @@
 --- 
-version: v6.0.4
+version: v6.0.5
 changelog:
+  - date: 2022-09-02
+    version: v6.0.5
+    changes:
+      - type: bug
+        text: "Json.net stores its settings globally, which means any changes in the client application will affect the behaviour of the SDK. The SDK will now use the initial default settings."
   - date: 2022-07-27
     version: v6.0.4
     changes:
@@ -648,7 +653,7 @@ sdks:
             distribution-type: package
             distribution-repository: git release
             package-name: PubNub.unitypackage
-            location: https://github.com/pubnub/unity/releases/download/v6.0.4/PubNub.unitypackage
+            location: https://github.com/pubnub/unity/releases/download/v6.0.5/PubNub.unitypackage
             requires:
               -
                 name: "UnityEditor"
@@ -815,7 +820,7 @@ sdks:
             distribution-type: package
             distribution-repository: git release
             package-name: PubNub.unitypackage
-            location: https://github.com/pubnub/unity/releases/download/v6.0.4/PubNub.unitypackage
+            location: https://github.com/pubnub/unity/releases/download/v6.0.5/PubNub.unitypackage
             requires:
               -
                 name: "UnityEditor"

PubNubUnity/Assets/PubNub.meta

@@ -2,12 +2,33 @@
 
 namespace PubNubAPI
 {
-    public class SubscribeMessage
+    public class SubscribeMessage : SubscribeMessage<object> {
+        internal SubscribeMessage(string shard, string subscriptionMatch, string channel, object payload,
+            string flags, string issuingClientId, string subscribeKey, long sequenceNumber,
+            TimetokenMetadata originatingTimetoken,
+            TimetokenMetadata publishMetadata, object userMetadata, int messageType) : base(shard, subscriptionMatch,
+            channel, payload, flags, issuingClientId, subscribeKey, sequenceNumber, originatingTimetoken,
+            publishMetadata, userMetadata, messageType) {
+        }
+    }
+    
+    // Message class variant that does not deserialize the message
+    public class SubscribeVerbatimMessage : SubscribeMessage<string> {
+        internal SubscribeVerbatimMessage(string shard, string subscriptionMatch, string channel, string payload,
+            string flags, string issuingClientId, string subscribeKey, long sequenceNumber,
+            TimetokenMetadata originatingTimetoken,
+            TimetokenMetadata publishMetadata, object userMetadata, int messageType) : base(shard, subscriptionMatch,
+            channel, payload, flags, issuingClientId, subscribeKey, sequenceNumber, originatingTimetoken,
+            publishMetadata, userMetadata, messageType) {
+        }
+    }
+
+    public class SubscribeMessage<T>
     {
         private string a { get; set;} //JSON shard;
         private string b { get; set;} //JSON subscriptionMatch
         private string c { get; set;} //JSON channel
-        private object d { get; set;} //JSON payload
+        private T d { get; set;} //JSON payload
         private int e { get; set;} //JSON Message Type (1: Signal, 2: MessageObjects, 3: MessageActions)
         private string f { get; set;} //JSON flags
         private string i { get; set;} //JSON issuingClientId
@@ -17,7 +38,7 @@ public class SubscribeMessage
         private TimetokenMetadata p { get; set;} //JSON publishMetadata
         private object u { get; set;} //JSON userMetadata
 
-        internal SubscribeMessage(string shard, string subscriptionMatch, string channel, object payload,
+        internal SubscribeMessage(string shard, string subscriptionMatch, string channel, T payload,
             string flags, string issuingClientId, string subscribeKey, long sequenceNumber, TimetokenMetadata originatingTimetoken,
             TimetokenMetadata publishMetadata, object userMetadata, int messageType
         )
@@ -60,7 +81,7 @@ public int MessageType{
             }
         }
 
-        public object Payload{
+        public T Payload{
             get{
                 return d;
             }

PubNubUnity/Assets/PubNub/Models/Consumer/PubSub/SubscribeMessage.cs

@@ -7,7 +7,7 @@ namespace PubNubAPI
     public class PubNubUnityBase
     {
         protected Counter publishMessageCounter;
-        private const string build = "6.0.4";
+        private const string build = "6.0.5";
         private string pnsdkVersion = string.Format ("PubNub-CSharp-Unity/{0}", build);
 
         public string Version {

PubNubUnity/Assets/PubNub/PubNubUnity/PubNubUnityBase.cs

@@ -20,6 +20,7 @@
 using System.Reflection;
 using System.Text.RegularExpressions;
 using System.Globalization;
+using System.Runtime.Serialization;
 using System.Text;
 
 namespace PubNubAPI
@@ -220,12 +221,38 @@ public Dictionary<string, object> DeserializeToDictionaryOfObject (string jsonSt
         }
     }
     #elif (USE_NEWTONSOFT_JSON)
-    public class NewtonsoftJsonSerializer : IJsonLibrary
-    {
-
+    public class NewtonsoftJsonSerializer : IJsonLibrary {
         readonly PubNubUnityBase  pnUnityBase;
-        public NewtonsoftJsonSerializer(PubNubUnityBase pnUnityBase){
+
+        private readonly JsonSerializerSettings defaultSettings;
+        
+        public NewtonsoftJsonSerializer(PubNubUnityBase pnUnityBase) {
+
             this.pnUnityBase = pnUnityBase;
+            defaultSettings = new JsonSerializerSettings() {
+                Context = new StreamingContext(),
+                Culture = CultureInfo.InvariantCulture,
+                ReferenceLoopHandling = ReferenceLoopHandling.Error,
+                MissingMemberHandling = MissingMemberHandling.Ignore,
+                NullValueHandling = NullValueHandling.Include,
+                DefaultValueHandling = DefaultValueHandling.Include,
+                ObjectCreationHandling = ObjectCreationHandling.Auto,
+                PreserveReferencesHandling = PreserveReferencesHandling.None,
+                ConstructorHandling = ConstructorHandling.Default,
+                TypeNameHandling = TypeNameHandling.None,
+                MetadataPropertyHandling = MetadataPropertyHandling.Default,
+                Formatting = Formatting.None,
+                DateFormatHandling = DateFormatHandling.IsoDateFormat,
+                DateTimeZoneHandling = DateTimeZoneHandling.RoundtripKind,
+                DateParseHandling = DateParseHandling.DateTime,
+                FloatParseHandling = FloatParseHandling.Double,
+                FloatFormatHandling = FloatFormatHandling.String,
+                StringEscapeHandling = StringEscapeHandling.Default,
+                TypeNameAssemblyFormatHandling = TypeNameAssemblyFormatHandling.Simple,
+                CheckAdditionalContent = false,
+                DateFormatString = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK",
+                MaxDepth = 64
+            };
         }
 
         public bool IsArrayCompatible (string jsonString)
@@ -240,7 +267,7 @@ public bool IsDictionaryCompatible (string jsonString)
 
         public string SerializeToJsonString (object objectToSerialize)
         {
-            string json = JsonConvert.SerializeObject (objectToSerialize); 
+            string json = JsonConvert.SerializeObject(objectToSerialize, defaultSettings); 
             return EncodeNonAsciiCharacters(json);
         }
 
@@ -250,8 +277,8 @@ public List<object> DeserializeToListOfObject (string jsonString)
             #if (ENABLE_PUBNUB_LOGGING)
             pnUnityBase.PNLog.WriteToLog (string.Format ("DeserializeToListOfObject: jsonString: {0}", jsonString), PNLoggingMethod.LevelInfo);
             #endif
-        
-            var output = JsonConvert.DeserializeObject<List<object>> (jsonString);
+
+            var output = JsonConvert.DeserializeObject<List<object>>(jsonString, defaultSettings);
             return output;
         }
 
@@ -261,7 +288,7 @@ public object DeserializeToObject (string jsonString)
             pnUnityBase.PNLog.WriteToLog (string.Format ("DeserializeToObject: jsonString: {0}", jsonString), PNLoggingMethod.LevelInfo);
             #endif
             jsonString = DecodeEncodedNonAsciiCharacters(jsonString);
-            var output = JsonConvert.DeserializeObject<object> (jsonString);
+            var output = JsonConvert.DeserializeObject<object> (jsonString, defaultSettings);
 
             #if (ENABLE_PUBNUB_LOGGING)
             pnUnityBase.PNLog.WriteToLog (string.Format("DeserializeToObject: type {0} decoded jsonString: {1}", output.GetType(), jsonString), PNLoggingMethod.LevelInfo);
@@ -352,9 +379,9 @@ private object deserializeToDictionary(string jo, bool isArray=false)
             if (!isArray)
             {
 
-                var values = JsonConvert.DeserializeObject<Dictionary<string, object>>(jo);
+                var values = JsonConvert.DeserializeObject<Dictionary<string, object>>(jo, defaultSettings);
                 #if (ENABLE_PUBNUB_LOGGING)
-                pnUnityBase.PNLog.WriteToLog (string.Format("JsonConvert.SerializeObject(values) {0}", JsonConvert.SerializeObject(values)), PNLoggingMethod.LevelInfo);
+                pnUnityBase.PNLog.WriteToLog (string.Format("JsonConvert.SerializeObject(values) {0}", JsonConvert.SerializeObject(values, defaultSettings)), PNLoggingMethod.LevelInfo);
                 #endif
 
                 var values2 = new Dictionary<string, object>();
@@ -387,9 +414,9 @@ private object deserializeToDictionary(string jo, bool isArray=false)
             else
             {
 
-                var values = JsonConvert.DeserializeObject<List<object>>(jo);
+                var values = JsonConvert.DeserializeObject<List<object>>(jo, defaultSettings);
                 #if (ENABLE_PUBNUB_LOGGING)
-                pnUnityBase.PNLog.WriteToLog (string.Format("2: JsonConvert.SerializeObject(values) {0}", JsonConvert.SerializeObject(values)), PNLoggingMethod.LevelInfo);
+                pnUnityBase.PNLog.WriteToLog (string.Format("2: JsonConvert.SerializeObject(values) {0}", JsonConvert.SerializeObject(values, defaultSettings)), PNLoggingMethod.LevelInfo);
                 #endif
 
                 Type whatType = typeof(object);
@@ -454,16 +481,16 @@ private object deserializeToDictionary(string jo, bool isArray=false)
 
         public T Deserialize<T> (string jsonString)
         {
-            var output = JsonConvert.DeserializeObject<T> (jsonString);
+            var output = JsonConvert.DeserializeObject<T> (jsonString, defaultSettings);
             return output;
         }
 
-        public Dictionary<string, object> DeserializeToDictionaryOfObject (string jsonString)
-        {
-            var output = JsonConvert.DeserializeObject<Dictionary<string, object>>(jsonString);
-            
+        public Dictionary<string, object> DeserializeToDictionaryOfObject(string jsonString) {
+            var output =
+                JsonConvert.DeserializeObject<Dictionary<string, object>>(jsonString, defaultSettings);
+
             return output;
-        }  
+        }
     }      
     #elif (USE_SimpleJSON)
     public class SimpleJSONSerializer : IJsonLibrary

PubNubUnity/Assets/PubNub/Serialization/JSONSerializer.cs

@@ -1,12 +1,21 @@
 {
   "dependencies": {
-    "com.unity.ads": "2.0.8",
-    "com.unity.analytics": "3.2.3",
-    "com.unity.collab-proxy": "1.2.15",
-    "com.unity.package-manager-ui": "2.0.13",
-    "com.unity.purchasing": "2.0.3",
-    "com.unity.textmeshpro": "1.4.1",
+    "com.unity.2d.sprite": "1.0.0",
+    "com.unity.2d.tilemap": "1.0.0",
+    "com.unity.ads": "3.7.5",
+    "com.unity.analytics": "3.6.12",
+    "com.unity.collab-proxy": "1.15.13",
+    "com.unity.ide.rider": "2.0.7",
+    "com.unity.ide.visualstudio": "2.0.14",
+    "com.unity.ide.vscode": "1.2.5",
+    "com.unity.purchasing": "4.1.3",
+    "com.unity.test-framework": "1.1.31",
+    "com.unity.textmeshpro": "3.0.6",
+    "com.unity.timeline": "1.4.8",
+    "com.unity.ugui": "1.0.0",
+    "com.unity.xr.legacyinputhelpers": "2.1.9",
     "com.unity.modules.ai": "1.0.0",
+    "com.unity.modules.androidjni": "1.0.0",
     "com.unity.modules.animation": "1.0.0",
     "com.unity.modules.assetbundle": "1.0.0",
     "com.unity.modules.audio": "1.0.0",
@@ -35,6 +44,7 @@
     "com.unity.modules.video": "1.0.0",
     "com.unity.modules.vr": "1.0.0",
     "com.unity.modules.wind": "1.0.0",
-    "com.unity.modules.xr": "1.0.0"
+    "com.unity.modules.xr": "1.0.0",
+    "com.unity.nuget.newtonsoft-json": "3.0.2"
   }
 }