Added additional error handling for parse errors

Author: Scordo

Deployment/Changelog.txt

@@ -3,6 +3,7 @@ Version 2.0.0.0
 - Added AwaitableQueryDispatcher
 - Dropped support for Silverligt and Windows Phone 7
 - Changed minimum .Net Framework Version to 4.5
+- Added more detailed exception in cases when there is a response parsing error
 
 Version 1.2.2.0
 ==========================================

Deployment/Deploy.target

@@ -5,7 +5,7 @@
   <PropertyGroup>
     <RootDirectory>..</RootDirectory>
     <Config>Release</Config>
-    <ReleaseVersion>1.2.2.0</ReleaseVersion>
+    <ReleaseVersion>2.0.0.0</ReleaseVersion>
     <ReleaseVersionEscaped>$(ReleaseVersion.Replace(".", "_"))</ReleaseVersionEscaped>
     <ReleaseName>TS3QueryLib.Net.V$(ReleaseVersionEscaped)</ReleaseName>
     <ReleaseDirectory>Releases\$(ReleaseVersionEscaped)</ReleaseDirectory>

TS3QueryLib.Core.Framework/AwaitableQueryDispatcher.cs

@@ -4,6 +4,7 @@
 using System.IO;
 using System.Linq;
 using System.Net.Sockets;
+using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
 using TS3QueryLib.Core.Common;
@@ -146,8 +147,14 @@ public async Task<string> SendAsync(string messageToSend)
 
         protected static async Task SendAsync(StreamWriter writer, string messageToSend)
         {
-            await writer.WriteLineAsync(messageToSend).ConfigureAwait(false);
-            await writer.FlushAsync().ConfigureAwait(false);
+            ConfiguredTaskAwaitable? writeLineAwaitable = writer?.WriteLineAsync(messageToSend).ConfigureAwait(false);
+
+            if (writeLineAwaitable.HasValue)
+                await writeLineAwaitable.Value;
+
+            ConfiguredTaskAwaitable? flushAwaitable = writer?.FlushAsync().ConfigureAwait(false);
+            if (flushAwaitable.HasValue)
+                await flushAwaitable.Value;
         }
 
         public void Disconnect()
@@ -197,7 +204,7 @@ protected async void ReadLoop()
                         ReceivedLines.Clear();
                     }
 
-                    string responseText = string.Join("\r\n", ReceivedLines.Concat(new[] { message }));
+                    string responseText = string.Join("\n\r", ReceivedLines.Concat(new[] { message }));
                     MessageResponses.Enqueue(responseText);
                     ReceivedLines.Clear();
 
@@ -231,7 +238,8 @@ protected async void ReadLoop()
 
         protected async Task<string> ReadLineAsync(bool throwOnEmptyMessage = true)
         {
-            string message = await ClientReader.ReadLineAsync().ConfigureAwait(false);
+            ConfiguredTaskAwaitable<string>? readLineAwaitable = ClientReader?.ReadLineAsync().ConfigureAwait(false);
+            string message = readLineAwaitable.HasValue ? await readLineAwaitable.Value : null;
 
             if (message != null)
                 return message;

TS3QueryLib.Core.Framework/Common/Exceptions/ParseException.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Runtime.Serialization;
+
+namespace TS3QueryLib.Core.Common.Exceptions
+{
+    public class ParseException : Exception
+    {
+        public ParseException()
+        {
+        }
+
+        public ParseException(string message) : base(message)
+        {
+        }
+
+        public ParseException(string message, Exception innerException) : base(message, innerException)
+        {
+        }
+
+        protected ParseException(SerializationInfo info, StreamingContext context) : base(info, context)
+        {
+        }
+    }
+}

TS3QueryLib.Core.Framework/Common/Responses/ResponseBase.cs

@@ -1,5 +1,6 @@
 using System;
 using TS3QueryLib.Core.CommandHandling;
+using TS3QueryLib.Core.Common.Exceptions;
 
 namespace TS3QueryLib.Core.Common.Responses
 {
@@ -23,21 +24,28 @@ public abstract class ResponseBase<T> : IDump, IResponse where T : ResponseBase<
 
         public static T Parse(string response, params object[] additionalStates)
         {
-            T instance = (T) Activator.CreateInstance(typeof(T));
-            instance.ResponseText = response;
-
-            if (response != null)
+            try
             {
-                string body, statusLine;
-                SplitResponse(response, out body, out statusLine);
-                instance.BodyText = body;
-                instance.StatusText = statusLine;
+                T instance = (T)Activator.CreateInstance(typeof(T));
+                instance.ResponseText = response;
+
+                if (response != null)
+                {
+                    SplitResponse(response, out var body, out var statusLine);
+                    instance.BodyText = body;
+                    instance.StatusText = statusLine;
+
+                    instance.DetermineErrorDetails(statusLine);
+                    instance.FillFrom(response, additionalStates);
+                }
 
-                instance.DetermineErrorDetails(statusLine);
-                instance.FillFrom(response, additionalStates);
+                return instance;
+            }
+            catch (Exception e)
+            {
+                throw new ParseException($"Error while trying to parse the response.\n\nRaw-Response:"+response, e);
             }
 
-            return instance;
         }
 
         #endregion

TS3QueryLib.Core.Framework/TS3QueryLib.Core.Framework.csproj

@@ -83,6 +83,7 @@
     <Compile Include="CommandHandling\Command.cs" />
     <Compile Include="Common\Entities\ChannelListEntryBase.cs" />
     <Compile Include="Common\Entities\ClientModificationBase.cs" />
+    <Compile Include="Common\Exceptions\ParseException.cs" />
     <Compile Include="Common\Notification\NotificationsBase.cs" />
     <Compile Include="Common\SharedCommandName.cs" />
     <Compile Include="Server\CommandName.cs" />