Correcting the JSON deserialization for arrays

Fixes #176 by telling JSON.net to ignore null values
Fixes #158 by changing the scope of the LogMessage field

Author: blackspherefollower

Buttplug.Client/ButtplugWSClient.cs

@@ -289,13 +289,21 @@ private async void onPingTimer(object state)
 
         public async Task RequestDeviceList()
         {
-            var deviceList = (await SendMessage(new RequestDeviceList(nextMsgId))) as DeviceList;
-            if (deviceList.Devices == null)
+            var resp = await SendMessage(new RequestDeviceList(nextMsgId));
+            if (!(resp is DeviceList) || (resp as DeviceList).Devices == null)
             {
+                if (resp is Error)
+                {
+                    _owningDispatcher.Invoke(() =>
+                    {
+                        ErrorReceived?.Invoke(this, new ErrorEventArgs(resp as Error));
+                    });
+                }
+
                 return;
             }
 
-            foreach (var d in deviceList.Devices)
+            foreach (var d in (resp as DeviceList).Devices)
             {
                 if (!_devices.ContainsKey(d.DeviceIndex))
                 {

Buttplug.Core/Messages/Messages.cs

@@ -76,11 +76,14 @@ public Error(string aErrorMessage, ErrorClass aErrorCode, uint aId)
 
     public class DeviceMessageInfo
     {
+        [JsonProperty(Required = Required.Always)]
         public string DeviceName;
 
+        [JsonProperty(Required = Required.Always)]
         public uint DeviceIndex;
 
-        public string[] DeviceMessages;
+        [JsonProperty(Required = Required.Always, NullValueHandling = NullValueHandling.Ignore)]
+        public string[] DeviceMessages = new string[0];
 
         public DeviceMessageInfo(uint aIndex, string aName, string[] aMessages)
         {
@@ -92,7 +95,8 @@ public DeviceMessageInfo(uint aIndex, string aName, string[] aMessages)
 
     public class DeviceList : ButtplugMessage, IButtplugMessageOutgoingOnly
     {
-        public readonly DeviceMessageInfo[] Devices;
+        [JsonProperty(Required = Required.Always, NullValueHandling = NullValueHandling.Ignore)]
+        public readonly DeviceMessageInfo[] Devices = new DeviceMessageInfo[0];
 
         public DeviceList(DeviceMessageInfo[] aDeviceList, uint aId)
              : base(aId)
@@ -103,9 +107,11 @@ public DeviceList(DeviceMessageInfo[] aDeviceList, uint aId)
 
     public class DeviceAdded : ButtplugDeviceMessage, IButtplugMessageOutgoingOnly
     {
+        [JsonProperty(Required = Required.Always)]
         public string DeviceName;
 
-        public string[] DeviceMessages;
+        [JsonProperty(Required = Required.Always, NullValueHandling = NullValueHandling.Ignore)]
+        public string[] DeviceMessages = new string[0];
 
         public DeviceAdded(uint aIndex, string aName, string[] aMessages)
             : base(ButtplugConsts.SystemMsgId, aIndex)
@@ -117,6 +123,7 @@ public DeviceAdded(uint aIndex, string aName, string[] aMessages)
 
     public class DeviceRemoved : ButtplugMessage, IButtplugMessageOutgoingOnly
     {
+        [JsonProperty(Required = Required.Always)]
         public uint DeviceIndex;
 
         public DeviceRemoved(uint aIndex)
@@ -187,11 +194,11 @@ public RequestLog(string aLogLevel, uint aId = ButtplugConsts.DefaultMsgId)
 
     public class Log : ButtplugMessage, IButtplugMessageOutgoingOnly
     {
+        [JsonProperty(Required = Required.Always)]
         public ButtplugLogLevel LogLevel;
 
-        // Needs to be left in for serialization
-        // ReSharper disable once UnusedAutoPropertyAccessor.Local
-        private string LogMessage;
+        [JsonProperty(Required = Required.Always)]
+        public string LogMessage;
 
         public Log(ButtplugLogLevel aLogLevel, string aLogMessage)
             : base(ButtplugConsts.SystemMsgId)