Merge pull request #122 from ArchipelagoMW/part_type_conversion_attempt

Part type conversion attempt

Author: Jarno458

Archipelago.MultiClient.Net.Tests/MessageParsingFixture.cs

@@ -1,4 +1,6 @@
 using Archipelago.MultiClient.Net.Converters;
+using Archipelago.MultiClient.Net.Enums;
+using Archipelago.MultiClient.Net.Models;
 using Archipelago.MultiClient.Net.Packets;
 using Newtonsoft.Json;
 using NUnit.Framework;
@@ -74,21 +76,79 @@ public void Should_handle_multiple_packets_in_same_message()
 			Assert.That(packets.OfType<LocationInfoPacket>().Count(), Is.EqualTo(1));
 		}
 
-		[Test, Ignore("The lib currently not future compatible as it does not handle new types it does not know")]
-		public void Should_not_throw_on_unknown_message_part_type()
+		[Test]
+		public void Should_correctly_parse_unknown_enum_for_print_json()
 		{
+			// message part type "region_id"
+			// print json type "NewType"
+			// hintstatus 9
 			const string message =
-				@"[{""cmd"":""PrintJSON"",""data"":[{""text"":""[Hint]: ""},{""text"":""(some new type of element)"",""new_value"":1337,""type"":""other_type""}],""type"":""Hint"",""receiving"":1,""item"":{""item"":1337116,""location"":1337109,""player"":2,""flags"":1,""class"":""NetworkItem""},""found"":false}]";
+				@"[{""cmd"":""PrintJSON"",""data"":[{""text"":""[Hint]: ""},{""text"":""86"",""type"":""region_id""},{""text"":""'s ""},{""text"":""1337049"",""player"":2,""flags"":0,""type"":""item_id""},{""text"":"" is at ""},{""text"":""1337010"",""player"":2,""type"":""location_id""},{""text"":"" in ""},{""text"":""2"",""type"":""player_id""},{""text"":""'s World""},{""text"":"". ""},{""text"":""NEW FUTURE STATUS"",""hint_status"":9,""type"":""hint_status""}],""type"":""NewType"",""receiving"":2,""item"":{""item"":1337049,""location"":1337010,""player"":2,""flags"":0,""class"":""NetworkItem""},""found"":false}]";
 
-			List<ArchipelagoPacketBase> packets = null;
-			Assert.DoesNotThrow(() =>
-			{
-				packets = JsonConvert.DeserializeObject<List<ArchipelagoPacketBase>>(message, Converter);
-			});
+			var packets = JsonConvert.DeserializeObject<List<ArchipelagoPacketBase>>(message, Converter);
+
+			Assert.That(packets, Is.Not.Null);
+			Assert.That(packets.Count, Is.EqualTo(1));
+
+			var printJson = packets[0] as PrintJsonPacket;
+
+			Assert.That(printJson, Is.Not.Null);
+			Assert.That(printJson.MessageType, Is.Null); // "NewType" cannot be parsed
+
+			Assert.That(printJson.Data[0].Type , Is.Null);
+			Assert.That(printJson.Data[1].Type , Is.Null); //region_id cannot be parsed
+			Assert.That(printJson.Data[2].Type , Is.Null);
+			Assert.That(printJson.Data[3].Type , Is.EqualTo(JsonMessagePartType.ItemId));
+			Assert.That(printJson.Data[4].Type , Is.Null);
+			Assert.That(printJson.Data[5].Type , Is.EqualTo(JsonMessagePartType.LocationId));
+			Assert.That(printJson.Data[6].Type , Is.Null);
+			Assert.That(printJson.Data[7].Type , Is.EqualTo(JsonMessagePartType.PlayerId));
+			Assert.That(printJson.Data[8].Type , Is.Null);
+			Assert.That(printJson.Data[9].Type , Is.Null);
+			Assert.That(printJson.Data[10].HintStatus, Is.EqualTo((HintStatus)9)); // 9 is not a valid hint status
+		}
+
+		[Test]
+		public void Should_correctly_parse_unknown_connection_refused()
+		{
+			// errors "NewErrorType"
+			const string message = @"[{""cmd"":""ConnectionRefused"",""errors"":[""InvalidSlot"", ""NewErrorType""]}]";
+
+			var packets = JsonConvert.DeserializeObject<List<ArchipelagoPacketBase>>(message, Converter);
 
 			Assert.That(packets, Is.Not.Null);
 			Assert.That(packets.Count, Is.EqualTo(1));
-			Assert.That(packets.OfType<HintPrintJsonPacket>().Count(), Is.EqualTo(1));
+
+			var connectionRefusedPacket = packets[0] as ConnectionRefusedPacket;
+
+			Assert.That(connectionRefusedPacket, Is.Not.Null);
+
+			Assert.That(connectionRefusedPacket.Errors.Length, Is.EqualTo(2));
+
+			Assert.That(connectionRefusedPacket.Errors[0], Is.EqualTo(ConnectionRefusedError.InvalidSlot));
+			Assert.That(connectionRefusedPacket.Errors[1], Is.EqualTo(ConnectionRefusedError.UnknownError));
+		}
+
+		[Test]
+		public void Should_correctly_parse_unknown_data_storage_opperations()
+		{
+			// opperation type "something_specail"
+			const string message = @"[{""cmd"":""SetReply"",""key"":""GiftBox;0;2"",""default"":{},""operations"":[{""operation"":""default"",""value"":null},{""operation"":""something_specail"",""value"":null},{""operation"":""left_shift"",""value"":1}],""want_reply"":false,""original_value"":{},""slot"":2,""value"":{}}]";
+
+			var packets = JsonConvert.DeserializeObject<List<ArchipelagoPacketBase>>(message, Converter);
+
+			Assert.That(packets, Is.Not.Null);
+			Assert.That(packets.Count, Is.EqualTo(1));
+
+			var connectionRefusedPacket = packets[0] as SetReplyPacket;
+
+			Assert.That(connectionRefusedPacket, Is.Not.Null);
+
+			Assert.That(connectionRefusedPacket.Operations.Length, Is.EqualTo(3));
+
+			Assert.That(connectionRefusedPacket.Operations[0].OperationType, Is.EqualTo(OperationType.Default));
+			Assert.That(connectionRefusedPacket.Operations[1].OperationType, Is.EqualTo(OperationType.Unknown));
+			Assert.That(connectionRefusedPacket.Operations[2].OperationType, Is.EqualTo(OperationType.LeftShift));
 		}
 	}
 }

Archipelago.MultiClient.Net/Archipelago.MultiClient.Net.csproj

@@ -10,9 +10,9 @@
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<RepositoryUrl>https://github.com/ArchipelagoMW/Archipelago.MultiClient.Net</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
-		<AssemblyVersion>6.6.0.0</AssemblyVersion>
-		<FileVersion>6.6.0.0</FileVersion>
-		<Version>6.6.0</Version>
+		<AssemblyVersion>6.6.1.0</AssemblyVersion>
+		<FileVersion>6.6.1.0</FileVersion>
+		<Version>6.6.1</Version>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
 		<PackageIcon>blue-icon.png</PackageIcon>

Archipelago.MultiClient.Net/Converters/AttemptingStringEnumConverter.cs

@@ -0,0 +1,22 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+using System;
+
+public class AttemptingStringEnumConverter : StringEnumConverter
+{
+	public AttemptingStringEnumConverter() : base() { }
+
+	public AttemptingStringEnumConverter(Type namingStrategyType) : base(namingStrategyType) { }
+
+	public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+    {
+        try
+        {
+            return base.ReadJson(reader, objectType, existingValue, serializer);
+        }
+        catch (JsonSerializationException)
+        {
+	        return objectType.IsValueType ? Activator.CreateInstance(objectType) : null;
+        }
+    }
+}

Archipelago.MultiClient.Net/Enums/ConnectionRefusedError.cs

@@ -5,6 +5,11 @@
 	/// </summary>
     public enum ConnectionRefusedError
     {
+	    /// <summary>
+	    /// Indicates that server the server send en error code not known to this library.
+	    /// </summary>
+		UnknownError = 0,
+
         /// <summary>
         /// Indicates that the sent 'name' field did not match any auth entry on the server.
         /// </summary>

Archipelago.MultiClient.Net/Enums/OperationType.cs

@@ -6,6 +6,7 @@
     public enum OperationType
     {
 #pragma warning disable CS1591
+	    Unknown = 0,
 		Add,
         Mul,
         Max,

Archipelago.MultiClient.Net/Models/JsonMessagePart.cs

@@ -1,18 +1,17 @@
 using Archipelago.MultiClient.Net.Enums;
 using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 using Newtonsoft.Json.Serialization;
 
 namespace Archipelago.MultiClient.Net.Models
 {
     public class JsonMessagePart
     {
         [JsonProperty("type")]
-        [JsonConverter(typeof(StringEnumConverter), typeof(SnakeCaseNamingStrategy))]
+        [JsonConverter(typeof(AttemptingStringEnumConverter), typeof(SnakeCaseNamingStrategy))]
         public JsonMessagePartType? Type { get; set; }
 
         [JsonProperty("color")]
-        [JsonConverter(typeof(StringEnumConverter), typeof(SnakeCaseNamingStrategy))]
+        [JsonConverter(typeof(AttemptingStringEnumConverter), typeof(SnakeCaseNamingStrategy))]
         public JsonMessagePartColor? Color { get; set; }
 
         [JsonProperty("text")]

Archipelago.MultiClient.Net/Models/OperationSpecification.cs

@@ -20,7 +20,7 @@ public class OperationSpecification
     {
 		/// <inheritdoc cref="T:Archipelago.MultiClient.Net.Models.OperationType"/>
 		[JsonProperty("operation")]
-        [JsonConverter(typeof(StringEnumConverter), typeof(SnakeCaseNamingStrategy))]
+        [JsonConverter(typeof(AttemptingStringEnumConverter), typeof(SnakeCaseNamingStrategy))]
         public OperationType OperationType;
 
 		/// <summary>

Archipelago.MultiClient.Net/Packets/ConnectionRefusedPacket.cs

@@ -1,14 +1,13 @@
 using Archipelago.MultiClient.Net.Enums;
 using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 
 namespace Archipelago.MultiClient.Net.Packets
 {
     public class ConnectionRefusedPacket : ArchipelagoPacketBase
     {
         public override ArchipelagoPacketType PacketType => ArchipelagoPacketType.ConnectionRefused;
 
-        [JsonProperty("errors", ItemConverterType = typeof(StringEnumConverter))]
+        [JsonProperty("errors", ItemConverterType = typeof(AttemptingStringEnumConverter))]
         public ConnectionRefusedError[] Errors { get; set; }
     }
 }