Merge pull request #62 from AoshiW/HypeTrainV2

Add HypeTrainV2 events

Author: AoshiW

TwitchLib.EventSub.Websockets/Core/EventArgs/Channel/ChannelHypeTrainBeginV2Args.cs

@@ -0,0 +1,7 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+
+public class ChannelHypeTrainBeginV2Args : TwitchLibEventSubEventArgs<EventSubNotification<HypeTrainBeginV2>>
+{ }

TwitchLib.EventSub.Websockets/Core/EventArgs/Channel/ChannelHypeTrainEndV2Args.cs

@@ -0,0 +1,7 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+
+public class ChannelHypeTrainEndV2Args : TwitchLibEventSubEventArgs<EventSubNotification<HypeTrainEndV2>>
+{ }

TwitchLib.EventSub.Websockets/Core/EventArgs/Channel/ChannelHypeTrainProgressV2Args.cs

@@ -0,0 +1,7 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+
+public class ChannelHypeTrainProgressV2Args : TwitchLibEventSubEventArgs<EventSubNotification<HypeTrainProgressV2>>
+{ }

TwitchLib.EventSub.Websockets/EventSubWebsocketClient.cs

@@ -140,15 +140,30 @@ public class EventSubWebsocketClient
         /// <summary>
         /// Event that triggers on "channel.hype_train.begin" notifications
         /// </summary>
+        [Obsolete("This event is deprecated, please use: ChannelHypeTrainBeginV2")]
         public event AsyncEventHandler<ChannelHypeTrainBeginArgs>? ChannelHypeTrainBegin;
         /// <summary>
+        /// Event that triggers on "channel.hype_train.begin" notifications
+        /// </summary>
+        public event AsyncEventHandler<ChannelHypeTrainBeginV2Args>? ChannelHypeTrainBeginV2;
+        /// <summary>
         /// Event that triggers on "channel.hype_train.end" notifications
         /// </summary>
+        [Obsolete("This event is deprecated, please use: ChannelHypeTrainEndV2")]
         public event AsyncEventHandler<ChannelHypeTrainEndArgs>? ChannelHypeTrainEnd;
         /// <summary>
+        /// Event that triggers on "channel.hype_train.end" notifications
+        /// </summary>
+        public event AsyncEventHandler<ChannelHypeTrainEndV2Args>? ChannelHypeTrainEndV2;
+        /// <summary>
         /// Event that triggers on "channel.hype_train.progress" notifications
         /// </summary>
+        [Obsolete("This event is deprecated, please use: ChannelHypeTrainProgressV2")]
         public event AsyncEventHandler<ChannelHypeTrainProgressArgs>? ChannelHypeTrainProgress;
+        /// <summary>
+        /// Event that triggers on "channel.hype_train.progress" notifications
+        /// </summary>
+        public event AsyncEventHandler<ChannelHypeTrainProgressV2Args>? ChannelHypeTrainProgressV2;
 
         /// <summary>
         /// Event that triggers on "channel.moderator.add" notifications

TwitchLib.EventSub.Websockets/Handler/Channel/HypeTrains/ChannelHypeTrainBeginHandlerV2.cs

@@ -0,0 +1,14 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Handler.Channel.HypeTrains;
+
+internal class ChannelHypeTrainBeginHandlerV2 : NotificationHandler<ChannelHypeTrainBeginV2Args, EventSubNotification<HypeTrainBeginV2>>
+{
+    public override string SubscriptionType => "channel.hype_train.begin";
+
+    public override string SubscriptionVersion => "2";
+
+    public override string EventName => nameof(EventSubWebsocketClient.ChannelHypeTrainBeginV2);
+}

TwitchLib.EventSub.Websockets/Handler/Channel/HypeTrains/ChannelHypeTrainEndHandlerV2.cs

@@ -0,0 +1,14 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Handler.Channel.HypeTrains;
+
+internal class ChannelHypeTrainEndHandlerV2 : NotificationHandler<ChannelHypeTrainEndV2Args, EventSubNotification<HypeTrainEndV2>>
+{
+    public override string SubscriptionType => "channel.hype_train.end";
+
+    public override string SubscriptionVersion => "2";
+
+    public override string EventName => nameof(EventSubWebsocketClient.ChannelHypeTrainEndV2);
+}

TwitchLib.EventSub.Websockets/Handler/Channel/HypeTrains/ChannelHypeTrainProgressHandlerV2.cs

@@ -0,0 +1,14 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Handler.Channel.HypeTrains;
+
+internal class ChannelHypeTrainProgressHandlerV2 : NotificationHandler<ChannelHypeTrainProgressV2Args, EventSubNotification<HypeTrainProgressV2>>
+{
+    public override string SubscriptionType => "channel.hype_train.progress";
+
+    public override string SubscriptionVersion => "2";
+
+    public override string EventName => nameof(EventSubWebsocketClient.ChannelHypeTrainProgressV2);
+}

TwitchLib.EventSub.Websockets/Handler/NotificationHandler.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Text.Json;
+using TwitchLib.EventSub.Websockets.Core.EventArgs;
+using TwitchLib.EventSub.Websockets.Core.Handler;
+
+namespace TwitchLib.EventSub.Websockets.Handler;
+
+
+// internal so we can change it without breaking changes in the future
+internal abstract class NotificationHandler<TEvent, TModel> : INotificationHandler
+    where TEvent : TwitchLibEventSubEventArgs<TModel>, new()
+    where TModel : new()
+{
+    /// <inheritdoc />
+    public abstract string SubscriptionType { get; }
+
+    /// <inheritdoc />
+    public abstract string SubscriptionVersion { get; }
+
+    /// <inheritdoc />
+    public abstract string EventName { get; }
+
+    /// <inheritdoc />
+    public void Handle(EventSubWebsocketClient client, string jsonString, JsonSerializerOptions serializerOptions)
+    {
+#pragma warning disable CA1031 // Do not catch general exception types
+        try
+        {
+            var data = JsonSerializer.Deserialize<TModel>(jsonString, serializerOptions);
+
+            if (data is null)
+                throw new InvalidOperationException("Parsed JSON cannot be null!");
+
+            client.RaiseEvent("UserUpdate", new TEvent { Notification = data });
+        }
+        catch (Exception ex)
+        {
+            // TODO events are async, so we NEVER get here
+            // possible solutions:
+            // rewriting RaiseEvent to return: 'Task?' and await if not null
+            client.RaiseEvent("ErrorOccurred", new ErrorOccuredArgs { Exception = ex, Message = $"Error encountered while trying to handle {SubscriptionType}/{SubscriptionVersion} notification! Raw Json: {jsonString}" });
+        }
+#pragma warning restore CA1031 // Do not catch general exception types
+    }
+}

TwitchLib.EventSub.Websockets/TwitchLib.EventSub.Websockets.csproj

@@ -31,7 +31,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
-    <PackageReference Include="TwitchLib.EventSub.Core" Version="2.6.0" />
+    <PackageReference Include="TwitchLib.EventSub.Core" Version="3.0.0-preview.58.b20c9f1" />
 	  <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>