fix: handle more streamlabels event variations

src/Streamlabs.SocketClient/Converters/FlexibleObjectConverter.cs

@@ -0,0 +1,50 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Streamlabs.SocketClient.InternalExtensions;
+
+namespace Streamlabs.SocketClient.Converters;
+
+/// <summary>
+/// Provides a flexible JSON converter for <typeparamref name="T"/> that handles mixed input types.
+/// This converter can deserialize <typeparamref name="T"/> from a standard JSON object,
+/// an escaped JSON string (double-encoded), or gracefully handle plain non-JSON strings by returning null.
+/// </summary>
+/// <typeparam name="T">The reference type to deserialize into.</typeparam>
+public class FlexibleObjectConverter<T> : JsonConverter<T>
+    where T : class
+{
+    public override T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) =>
+        reader.TokenType switch
+        {
+            JsonTokenType.StartObject => JsonSerializer.Deserialize<T>(ref reader, options),
+            JsonTokenType.StartArray => JsonSerializer.Deserialize<T>(ref reader, options),
+            JsonTokenType.String => DeserializeString(ref reader, options),
+            _ => null,
+        };
+
+    public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options) =>
+        JsonSerializer.Serialize(writer, value, options);
+
+    private static T? DeserializeString(ref Utf8JsonReader reader, JsonSerializerOptions options)
+    {
+        string? value = reader.GetString();
+        if (value is null)
+        {
+            return null;
+        }
+
+        if (!value.IsJsonObjectOrArray())
+        {
+            return null;
+        }
+
+        try
+        {
+            return JsonSerializer.Deserialize<T>(value.Trim(), options);
+        }
+        catch (JsonException)
+        {
+            return null;
+        }
+    }
+}

src/Streamlabs.SocketClient/InternalExtensions/SerializationExtensions.cs

@@ -13,11 +13,23 @@ internal static class SerializationExtensions
         UnmappedMemberHandling = JsonUnmappedMemberHandling.Disallow,
     };
 
-    private static readonly IReadOnlyCollection<IStreamlabsEvent> Empty = Array.Empty<IStreamlabsEvent>();
+    private static readonly IReadOnlyCollection<IStreamlabsEvent> Empty = [];
 
     public static IReadOnlyCollection<IStreamlabsEvent> Deserialize(this string json)
     {
         string normalized = json.NormalizeTypeDiscriminators();
         return JsonSerializer.Deserialize<IReadOnlyCollection<IStreamlabsEvent>>(normalized, Options) ?? Empty;
     }
+
+    public static bool IsJsonObjectOrArray(this string value)
+    {
+        string trimmed = value.Trim();
+        return trimmed switch
+        {
+            "" => false,
+            ['{', .., '}'] => true,
+            ['[', .., ']'] => true,
+            _ => false,
+        };
+    }
 }

src/Streamlabs.SocketClient/Messages/DataTypes/DonationGoal.cs

@@ -0,0 +1,14 @@
+using System.Text.Json.Serialization;
+
+namespace Streamlabs.SocketClient.Messages.DataTypes;
+
+public sealed record DonationGoal {
+    [JsonPropertyName("title")]
+    public required string Title { get; init; }
+
+    [JsonPropertyName("currentAmount")]
+    public required string CurrentAmount { get; init; }
+
+    [JsonPropertyName("goalAmount")]
+    public required string GoalAmount { get; init; }
+}

src/Streamlabs.SocketClient/Messages/DataTypes/StreamlabelsMessageData.cs

@@ -138,7 +138,7 @@ public sealed record StreamlabelsMessageData : IHasMessageId, IHasPriority
     public required string SessionMostRecentMonthlyDonator { get; init; }
 
     [JsonPropertyName("cloudbot_counter_deaths")]
-    public required string CloudbotCounterDeaths { get; init; }
+    public string? CloudbotCounterDeaths { get; init; }
 
     [JsonPropertyName("monthly_subscriber_count")]
     [JsonConverter(typeof(IntStringConverter))]

src/Streamlabs.SocketClient/Messages/DataTypes/StreamlabelsUnderlyingMessageData.cs

@@ -7,16 +7,19 @@ namespace Streamlabs.SocketClient.Messages.DataTypes;
 public sealed record StreamlabelsUnderlyingMessageData : IHasMessageId, IHasPriority
 {
     [JsonPropertyName("donation_goal")]
-    public required string DonationGoal { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<DonationGoal>))]
+    public DonationGoal? DonationGoal { get; init; }
 
     [JsonPropertyName("most_recent_donator")]
     public required Donator MostRecentDonator { get; init; }
 
     [JsonPropertyName("session_most_recent_donator")]
-    public required string SessionMostRecentDonator { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<Donator>))]
+    public Donator? SessionMostRecentDonator { get; init; }
 
     [JsonPropertyName("session_donators")]
-    public required string SessionDonators { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<IReadOnlyCollection<Donator>>))]
+    public IReadOnlyCollection<Donator>? SessionDonators { get; init; }
 
     [JsonPropertyName("total_donation_amount")]
     public required DonationAmount TotalDonationAmount { get; init; }
@@ -37,31 +40,40 @@ public sealed record StreamlabelsUnderlyingMessageData : IHasMessageId, IHasPrio
     public required TopDonator AllTimeTopDonator { get; init; }
 
     [JsonPropertyName("monthly_top_donator")]
-    public required string MonthlyTopDonator { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<TopDonator>))]
+    public TopDonator? MonthlyTopDonator { get; init; }
 
     [JsonPropertyName("weekly_top_donator")]
-    public required string WeeklyTopDonator { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<TopDonator>))]
+    public TopDonator? WeeklyTopDonator { get; init; }
 
     [JsonPropertyName("30day_top_donator")]
-    public required string ThirtyDayTopDonator { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<TopDonator>))]
+    public TopDonator? ThirtyDayTopDonator { get; init; }
 
     [JsonPropertyName("session_top_donator")]
-    public required string SessionTopDonator { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<TopDonator>))]
+    public TopDonator? SessionTopDonator { get; init; }
 
     [JsonPropertyName("all_time_top_donators")]
-    public required IReadOnlyCollection<TopDonator> AllTimeTopDonators { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<IReadOnlyCollection<TopDonator>>))]
+    public IReadOnlyCollection<TopDonator>? AllTimeTopDonators { get; init; }
 
     [JsonPropertyName("monthly_top_donators")]
-    public required string MonthlyTopDonators { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<IReadOnlyCollection<TopDonator>>))]
+    public IReadOnlyCollection<TopDonator>? MonthlyTopDonators { get; init; }
 
     [JsonPropertyName("weekly_top_donators")]
-    public required string WeeklyTopDonators { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<IReadOnlyCollection<TopDonator>>))]
+    public IReadOnlyCollection<TopDonator>? WeeklyTopDonators { get; init; }
 
     [JsonPropertyName("30day_top_donators")]
-    public required string ThirtyDayTopDonators { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<IReadOnlyCollection<TopDonator>>))]
+    public IReadOnlyCollection<TopDonator>? ThirtyDayTopDonators { get; init; }
 
     [JsonPropertyName("session_top_donators")]
-    public required string SessionTopDonators { get; init; }
+    [JsonConverter(typeof(FlexibleObjectConverter<IReadOnlyCollection<TopDonator>>))]
+    public IReadOnlyCollection<TopDonator>? SessionTopDonators { get; init; }
 
     [JsonPropertyName("all_time_top_donations")]
     public required IReadOnlyCollection<TopDonationAmount> AllTimeTopDonations { get; init; }
@@ -133,7 +145,7 @@ public sealed record StreamlabelsUnderlyingMessageData : IHasMessageId, IHasPrio
     public required string SessionMostRecentMonthlyDonator { get; init; }
 
     [JsonPropertyName("cloudbot_counter_deaths")]
-    public required Counter CloudbotCounterDeaths { get; init; }
+    public Counter? CloudbotCounterDeaths { get; init; }
 
     [JsonPropertyName("monthly_subscriber_count")]
     public required Count MonthlySubscriberCount { get; init; }

test/Streamlabs.SocketClient.Tests/Converters/FlexibleObjectConverterTests.cs

@@ -0,0 +1,100 @@
+using System.Diagnostics.CodeAnalysis;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Streamlabs.SocketClient.Converters;
+
+namespace Streamlabs.SocketClient.Tests.Converters;
+
+[SuppressMessage("Style", "VSTHRD200:Use \"Async\" suffix for async methods")]
+public class FlexibleObjectConverterTests
+{
+    private sealed class SampleClass
+    {
+        [JsonConverter(typeof(FlexibleObjectConverter<SamplePayload>))]
+        public SamplePayload? Payload { get; set; }
+    }
+
+    private sealed class SamplePayload
+    {
+        public string? Name { get; set; }
+        public int Count { get; set; }
+    }
+
+    [Test]
+    public async Task Read_ObjectToken_Deserializes()
+    {
+        // Arrange
+        var json = """{"Payload":{"Name":"Alpha","Count":3}}""";
+
+        // Act
+        var result = JsonSerializer.Deserialize<SampleClass>(json);
+
+        // Assert
+        await Assert.That(result).IsNotNull();
+        await Assert.That(result!.Payload).IsNotNull();
+        await Assert.That(result.Payload!.Name).IsEqualTo("Alpha");
+        await Assert.That(result.Payload.Count).IsEqualTo(3);
+    }
+
+    [Test]
+    public async Task Read_EscapedJsonString_Deserializes()
+    {
+        // Arrange
+        var json = """{"Payload":"{\"Name\":\"Beta\",\"Count\":7}"}""";
+
+        // Act
+        var result = JsonSerializer.Deserialize<SampleClass>(json);
+
+        // Assert
+        await Assert.That(result).IsNotNull();
+        await Assert.That(result!.Payload).IsNotNull();
+        await Assert.That(result.Payload!.Name).IsEqualTo("Beta");
+        await Assert.That(result.Payload.Count).IsEqualTo(7);
+    }
+
+    [Test]
+    public async Task Read_PlainString_ReturnsNull()
+    {
+        // Arrange
+        var json = """{"Payload":"just a plain string"}""";
+
+        // Act
+        var result = JsonSerializer.Deserialize<SampleClass>(json);
+
+        // Assert
+        await Assert.That(result).IsNotNull();
+        await Assert.That(result!.Payload).IsNull();
+    }
+
+    [Test]
+    public async Task Read_MalformedJsonString_ReturnsNull()
+    {
+        // Arrange
+        var json = """{"Payload":"{not valid json}"}""";
+
+        // Act
+        var result = JsonSerializer.Deserialize<SampleClass>(json);
+
+        // Assert
+        await Assert.That(result).IsNotNull();
+        await Assert.That(result!.Payload).IsNull();
+    }
+
+    [Test]
+    public async Task Write_SerializesNormally()
+    {
+        // Arrange
+        SampleClass sample = new()
+        {
+            Payload = new SamplePayload { Name = "Gamma", Count = 42 },
+        };
+
+        // Act
+        var json = JsonSerializer.Serialize(sample);
+
+        // Assert
+        await Assert.That(json).Contains("\"Payload\"");
+        await Assert.That(json).Contains("\"Name\":\"Gamma\"");
+        await Assert.That(json).Contains("\"Count\":42");
+    }
+}