fix: possible json deserializer exception

Log if DiscordJson fails

Author: Lulalaby

DisCatSharp.Common/Types/MemoryBuffer.cs

@@ -139,7 +139,7 @@ private void WriteStreamSeekable(Stream stream)
 
 			var lsl = this._lastSegmentLength;
 			var slen = dmem.Span.Length - lsl;
-			stream.Read(buff, 0, slen);
+			_ = stream.Read(buff, 0, slen);
 			buff.AsSpan(0, slen).CopyTo(dmem.Span);
 			len -= dmem.Span.Length;
 

DisCatSharp.VoiceNext/VoiceNextConnection.cs

@@ -1165,7 +1165,7 @@ private async Task Stage2(VoiceSessionDescriptionPayload voiceSessionDescription
 	/// <returns>A Task.</returns>
 	private async Task HandleDispatch(JObject jo)
 	{
-		var opc = (int)jo["op"];
+		var opc = (int?)jo["op"];
 		ArgumentNullException.ThrowIfNull(opc);
 		var opp = jo["d"] as JObject;
 

DisCatSharp/DiscordConfiguration.cs

@@ -312,7 +312,7 @@ internal List<Type> TrackExceptions
 	/// <summary>
 	/// The exception we track with sentry.
 	/// </summary>
-	private List<Type> _exceptions = [typeof(ServerErrorException), typeof(BadRequestException)];
+	private List<Type> _exceptions = [typeof(ServerErrorException), typeof(BadRequestException), typeof(DiscordJsonException)];
 
 	/// <summary>
 	/// <para>Whether to enable the library developer mode.</para>

DisCatSharp/Entities/Message/DiscordMessage.cs

@@ -361,14 +361,14 @@ public DiscordMessageReference Reference
 	/// <summary>
 	/// Gets whether this message has a message reference (reply, announcement, etc.).
 	/// </summary>
-	[Experimental("We provide that temporary, as we figure out things.")]
+	[Experimental("We provide that temporary, as we figure out things."), JsonIgnore]
 	public bool HasMessageReference
 		=> this.InternalReference is { Type: ReferenceType.Default };
 
 	/// <summary>
 	/// Gets whether this message has forwarded messages.
 	/// </summary>
-	[Experimental("We provide that temporary, as we figure out things.")]
+	[Experimental("We provide that temporary, as we figure out things."), JsonIgnore]
 	public bool HasMessageSnapshots
 		=> this.InternalReference is { Type: ReferenceType.Forward };
 

DisCatSharp/Exceptions/DisCatSharpException.cs

@@ -11,7 +11,16 @@ public class DisCatSharpException : Exception
 	/// Initializes a new instance of the <see cref="DisCatSharpException"/> class.
 	/// </summary>
 	/// <param name="message">The error message.</param>
-	internal DisCatSharpException(string message)
+	internal DisCatSharpException(string? message)
 		: base(message)
 	{ }
+
+	/// <summary>
+	/// Initializes a new instance of the <see cref="DisCatSharpException"/> class.
+	/// </summary>
+	/// <param name="message">The error message.</param>
+	/// <param name="innerException">The inner exception.</param>
+	internal DisCatSharpException(string? message, Exception? innerException)
+		: base(message, innerException)
+	{ }
 }

DisCatSharp/Exceptions/DiscordJsonException.cs

@@ -0,0 +1,41 @@
+using Newtonsoft.Json;
+
+namespace DisCatSharp.Exceptions;
+
+/// <summary>
+/// Represents a <see cref="DiscordJsonException"/>.
+/// </summary>
+public sealed class DiscordJsonException : DisCatSharpException
+{
+	/// <summary>
+	/// Gets the line number indicating where the error occurred.
+	/// </summary>
+	/// <value>The line number indicating where the error occurred.</value>
+	public int LineNumber { get; }
+
+	/// <summary>
+	/// Gets the line position indicating where the error occurred.
+	/// </summary>
+	/// <value>The line position indicating where the error occurred.</value>
+	public int LinePosition { get; }
+
+	/// <summary>
+	/// Gets the path to the JSON where the error occurred.
+	/// </summary>
+	/// <value>The path to the JSON where the error occurred.</value>
+	public string? Path { get; }
+
+	/// <summary>
+	/// Initializes a new instance of the <see cref="DiscordJsonException"/> class.
+	/// </summary>
+	/// <param name="jre">The JSON reader exception.</param>
+	public DiscordJsonException(JsonReaderException jre)
+		: base(jre.Message, jre.InnerException)
+	{
+		this.Path = jre.Path;
+		this.LineNumber = jre.LineNumber;
+		this.LinePosition = jre.LinePosition;
+		this.HResult = jre.HResult;
+		this.HelpLink = jre.HelpLink;
+	}
+}

DisCatSharp/Net/Serialization/DiscordJson.cs

@@ -6,13 +6,17 @@
 using System.Threading.Tasks;
 
 using DisCatSharp.Entities;
+using DisCatSharp.Exceptions;
 
 using Microsoft.Extensions.Logging;
 
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
 using Sentry;
+using Sentry.Protocol;
+
+using ErrorEventArgs = Newtonsoft.Json.Serialization.ErrorEventArgs;
 
 namespace DisCatSharp.Net.Serialization;
 
@@ -89,6 +93,43 @@ private static string SerializeObjectInternal(object value, Type type, JsonSeria
 		return stringWriter.ToString();
 	}
 
+	/// <summary>
+	/// Handles <see cref="DiscordJson"/> errors.
+	/// </summary>
+	/// <param name="sender">The sender.</param>
+	/// <param name="e">The error event args.</param>
+	/// <param name="discord">The discord client.</param>
+	private static void DiscordJsonErrorHandler(object? sender, ErrorEventArgs e, BaseDiscordClient? discord)
+	{
+		if (discord is null || e.ErrorContext.Error is not JsonReaderException jre)
+			return;
+
+		var sentryMessage = "DiscordJson error on deserialization (" + (sender?.GetType().Name ?? "x") + ")\n\n" +
+		                    "Path: " + e.ErrorContext.Path + "\n" +
+		                    "Original Object" + e.ErrorContext.OriginalObject + "\n" +
+		                    "Current Object" + e.CurrentObject;
+		SentryEvent sentryEvent = new(new DiscordJsonException(jre))
+		{
+			Level = SentryLevel.Error,
+			Logger = nameof(DiscordJson),
+			Message = sentryMessage
+		};
+		sentryEvent.SetFingerprint(BaseDiscordClient.GenerateSentryFingerPrint(sentryEvent));
+		if (discord.Configuration.AttachUserInfo && discord.CurrentUser is not null)
+			sentryEvent.User = new()
+			{
+				Id = discord.CurrentUser.Id.ToString(),
+				Username = discord.CurrentUser.UsernameWithDiscriminator,
+				Other = new Dictionary<string, string>()
+				{
+					{ "developer", discord.Configuration.DeveloperUserId?.ToString() ?? "not_given" },
+					{ "email", discord.Configuration.FeedbackEmail ?? "not_given" }
+				}
+			};
+		var sid = discord.Sentry.CaptureEvent(sentryEvent);
+		_ = Task.Run(discord.Sentry.FlushAsync);
+	}
+
 	/// <summary>
 	/// Deserializes the specified JSON string to an object.
 	/// </summary>
@@ -101,8 +142,10 @@ private static T DeserializeObjectInternal<T>(string? json, BaseDiscordClient? d
 
 		var obj = JsonConvert.DeserializeObject<T>(json, new JsonSerializerSettings()
 		{
-			ContractResolver = new OptionalJsonContractResolver()
+			ContractResolver = new OptionalJsonContractResolver(),
+			Error = (s, e) => DiscordJsonErrorHandler(s, e, discord)
 		})!;
+
 		if (discord is null)
 			return obj;
 
@@ -176,7 +219,8 @@ private static T DeserializeIEnumerableObjectInternal<T>(string? json, BaseDisco
 
 		var obj = JsonConvert.DeserializeObject<T>(json, new JsonSerializerSettings()
 		{
-			ContractResolver = new OptionalJsonContractResolver()
+			ContractResolver = new OptionalJsonContractResolver(),
+			Error = (s, e) => DiscordJsonErrorHandler(s, e, discord)
 		})!;
 		if (discord is null)
 			return obj;