[release] v0.6.0

.github/workflows/preview-release.yml

@@ -11,7 +11,7 @@ jobs:
 
    steps:
    - uses: actions/checkout@v4
-   - uses: benjlevesque/short-sha@v2.2
+   - uses: benjlevesque/short-sha@v3.0
      id: short-sha
    - name: Setup .NET
      uses: actions/setup-dotnet@v3
@@ -22,6 +22,6 @@ jobs:
    - name: Build TwitchLib.EventSub.Websockets
      run: dotnet build -c Release --no-restore
    - name: Pack TwitchLib.EventSub.Websockets
-     run: dotnet pack ./TwitchLib.EventSub.Websockets/TwitchLib.EventSub.Websockets.csproj -v normal -c Release -o nugets --no-build --version-suffix "preview-${{ steps.short-sha.outputs.sha }}"
+     run: dotnet pack ./TwitchLib.EventSub.Websockets/TwitchLib.EventSub.Websockets.csproj -v normal -c Release -o nugets --no-build --version-suffix "preview.${{ github.run_number }}.${{ steps.short-sha.outputs.sha }}"
    - name: Push to Nuget
      run: dotnet nuget push "./nugets/*.nupkg" -k ${{ secrets.API_NUGET_TOKEN }} -s https://api.nuget.org/v3/index.json

README.md

@@ -17,10 +17,10 @@ You can also find a console app example for .NET 8 and for .NET Framework 4.8 in
 
 | NuGet            |       | [![TwitchLib.EventSub.Websockets][1]][2]                                       |
 | :--------------- | ----: | :--------------------------------------------------------------------------- |
-| Package Manager  | `PM>` | `Install-Package TwitchLib.EventSub.Websockets -Version 0.5.0`                 |
-| .NET CLI         | `>`   | `dotnet add package TwitchLib.EventSub.Websockets --version 0.5.0`             |
-| PackageReference |       | `<PackageReference Include="TwitchLib.EventSub.Websockets" Version="0.5.0" />` |
-| Paket CLI        | `>`   | `paket add TwitchLib.EventSub.Websockets --version 0.5.0`                      |
+| Package Manager  | `PM>` | `Install-Package TwitchLib.EventSub.Websockets -Version 0.6.0`                 |
+| .NET CLI         | `>`   | `dotnet add package TwitchLib.EventSub.Websockets --version 0.6.0`             |
+| PackageReference |       | `<PackageReference Include="TwitchLib.EventSub.Websockets" Version="0.6.0" />` |
+| Paket CLI        | `>`   | `paket add TwitchLib.EventSub.Websockets --version 0.6.0`                      |
 
 [1]: https://img.shields.io/nuget/v/TwitchLib.EventSub.Websockets.svg?label=TwitchLib.EventSub.Websockets
 [2]: https://www.nuget.org/packages/TwitchLib.EventSub.Websockets

TwitchLib.EventSub.Websockets.Example.NetStandard/TwitchLib.EventSub.Websockets.Example.NetStandard.csproj

@@ -5,10 +5,12 @@
     <TargetFramework>netframework4.8</TargetFramework>
     <ImplicitUsings>disable</ImplicitUsings>
     <Nullable>disable</Nullable>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
+		<PackageReference Include="TwitchLib.Api" Version="3.10.0-preview-4e0146c" />
 	</ItemGroup>
 
 	<ItemGroup>

TwitchLib.EventSub.Websockets.Example.NetStandard/WebsocketHostedService.cs

@@ -5,7 +5,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using TwitchLib.Api;
-using TwitchLib.Api.Core.Enums;
 using TwitchLib.EventSub.Websockets.Core.EventArgs;
 using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
 
@@ -16,7 +15,7 @@ public class WebsocketHostedService : IHostedService
         private readonly IConfiguration _configuration;
         private readonly ILogger<WebsocketHostedService> _logger;
         private readonly EventSubWebsocketClient _eventSubWebsocketClient;
-        private readonly TwitchApi _twitchApi = new();
+        private readonly TwitchAPI _twitchApi = new();
         private string _userId;
 
         public WebsocketHostedService(IConfiguration configuration ,ILogger<WebsocketHostedService> logger, EventSubWebsocketClient eventSubWebsocketClient)

TwitchLib.EventSub.Websockets.Example.NetStandard/WebsocketHostedServiceWithoutDI.cs

@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using TwitchLib.Api;
 using TwitchLib.EventSub.Websockets.Core.EventArgs;
 using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
 
@@ -12,7 +13,7 @@ public class WebsocketHostedServiceWithoutDI : IHostedService
     {
         private readonly ILogger<WebsocketHostedService> _logger;
         private readonly EventSubWebsocketClient _eventSubWebsocketClient;
-        private readonly TwitchApi _twitchApi = new();
+        private readonly TwitchAPI _twitchApi = new();
         private string _userId;
 
         public WebsocketHostedServiceWithoutDI(ILogger<WebsocketHostedService> logger, ILoggerFactory loggerFactory)

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

@@ -8,6 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
+    <PackageReference Include="TwitchLib.Api" Version="3.10.0-preview-4e0146c" />
   </ItemGroup>
 
   <ItemGroup>

TwitchLib.EventSub.Websockets.Example/WebsocketHostedService.cs

@@ -15,7 +15,7 @@ public class WebsocketHostedService : IHostedService
     {
         private readonly ILogger<WebsocketHostedService> _logger;
         private readonly EventSubWebsocketClient _eventSubWebsocketClient;
-        private readonly TwitchApi _twitchApi = new();
+        private readonly TwitchAPI _twitchApi = new();
         private string _userId;
 
         public WebsocketHostedService(ILogger<WebsocketHostedService> logger, EventSubWebsocketClient eventSubWebsocketClient)

TwitchLib.EventSub.Websockets/Client/WebsocketClient.cs

@@ -29,17 +29,17 @@ public class WebsocketClient : IDisposable
         /// </summary>
         public bool IsFaulted => _webSocket.CloseStatus != WebSocketCloseStatus.Empty && _webSocket.CloseStatus != WebSocketCloseStatus.NormalClosure;
 
-        internal event AsyncEventHandler<DataReceivedArgs> OnDataReceived;
-        internal event AsyncEventHandler<ErrorOccuredArgs> OnErrorOccurred;
+        internal event AsyncEventHandler<DataReceivedArgs>? OnDataReceived;
+        internal event AsyncEventHandler<ErrorOccuredArgs>? OnErrorOccurred;
 
-        private readonly ClientWebSocket _webSocket;
-        private readonly ILogger<WebsocketClient> _logger;
+        private ClientWebSocket _webSocket;
+        private readonly ILogger<WebsocketClient>? _logger;
 
         /// <summary>
         /// Constructor to create a new Websocket client with a logger
         /// </summary>
         /// <param name="logger">Logger used by the websocket client to print various state info</param>
-        public WebsocketClient(ILogger<WebsocketClient> logger = null)
+        public WebsocketClient(ILogger<WebsocketClient>? logger = null)
         {
             _webSocket = new ClientWebSocket();
             _logger = logger;
@@ -56,6 +56,8 @@ public async Task<bool> ConnectAsync(Uri url)
             {
                 if (_webSocket.State is WebSocketState.Open or WebSocketState.Connecting)
                     return true;
+                if (_webSocket.State is WebSocketState.Closed)  //after a socken is closed it cannot be reopened
+                    _webSocket = new();
 
                 await _webSocket.ConnectAsync(url, CancellationToken.None);
 
@@ -92,66 +94,63 @@ public async Task<bool> DisconnectAsync()
             }
         }
 
-#if NET6_0_OR_GREATER
         /// <summary>
         /// Background operation to process incoming data via the websocket
         /// </summary>
         /// <returns>Task representing the background operation</returns>
         /// <exception cref="ArgumentOutOfRangeException"></exception>
         private async Task ProcessDataAsync()
         {
-            const int minimumBufferSize = 256;
-            var storeSize = 4096;
-            var decoder = Encoding.UTF8.GetDecoder();
-
-            var store = MemoryPool<byte>.Shared.Rent(storeSize).Memory;
-            var buffer = MemoryPool<byte>.Shared.Rent(minimumBufferSize).Memory;
-
+            const int bufferLength = 4096;
+#if NETSTANDARD2_0
+            var buffer = new ArraySegment<byte>(new byte[bufferLength]);
+#else
+            var buffer = new Memory<byte>(new byte[bufferLength]);
+#endif
+            var store = new byte[4096];
             var payloadSize = 0;
 
             while (IsConnected)
             {
                 try
                 {
+#if NETSTANDARD2_0
+                    WebSocketReceiveResult receiveResult;
+#else
                     ValueWebSocketReceiveResult receiveResult;
+#endif
                     do
                     {
                         receiveResult = await _webSocket.ReceiveAsync(buffer, CancellationToken.None);
-                        
-                        if (payloadSize + receiveResult.Count >= storeSize)
+
+                        if (payloadSize + receiveResult.Count >= store.Length)
                         {
-                            storeSize += 
-#if NET8_0_OR_GREATER
-                            int.Max(4096, receiveResult.Count);
-#else
-                            Math.Max(4096, receiveResult.Count);
-#endif
-                            var newStore = MemoryPool<byte>.Shared.Rent(storeSize).Memory;
-                            store.CopyTo(newStore);
+                            var newStoreLength = store.Length + Math.Max(bufferLength, receiveResult.Count);
+                            var newStore = new byte[newStoreLength];
+                            store.AsSpan().CopyTo(newStore);
                             store = newStore;
                         }
 
-                        buffer.CopyTo(store[payloadSize..]);
+                        buffer
+#if NETSTANDARD2_0
+                            .Array.AsSpan(0, receiveResult.Count)
+#else
+                            .Span.Slice(0, receiveResult.Count)
+#endif
+                            .CopyTo(store.AsSpan(payloadSize));
 
                         payloadSize += receiveResult.Count;
                     } while (!receiveResult.EndOfMessage);
 
                     switch (receiveResult.MessageType)
                     {
                         case WebSocketMessageType.Text:
-                        {
-                            var intermediate = MemoryPool<char>.Shared.Rent(payloadSize).Memory;
-
                             if (payloadSize == 0)
                                 continue;
 
-                            decoder.Convert(store.Span[..payloadSize], intermediate.Span, true, out _, out var charsCount, out _);
-                            var message = intermediate[..charsCount];
-
-                            OnDataReceived?.Invoke(this, new DataReceivedArgs { Message = message.Span.ToString() });
+                            OnDataReceived?.Invoke(this, new DataReceivedArgs { Bytes = store.AsSpan(0, payloadSize).ToArray() });
                             payloadSize = 0;
                             break;
-                        }
                         case WebSocketMessageType.Binary:
                             break;
                         case WebSocketMessageType.Close:
@@ -168,75 +167,6 @@ private async Task ProcessDataAsync()
                 }
             }
         }
-#else
-        /// <summary>
-        /// Background operation to process incoming data via the websocket
-        /// </summary>
-        /// <returns>Task representing the background operation</returns>
-        /// <exception cref="ArgumentOutOfRangeException"></exception>
-        private async Task ProcessDataAsync()
-        {
-            const int minimumBufferSize = 8192;
-
-            var buffer = new ArraySegment<byte>(new byte[minimumBufferSize]);
-            var payloadSize = 0;
-
-            while (IsConnected)
-            {
-                try
-                {
-                    WebSocketReceiveResult receiveResult;
-                    var memory = new MemoryStream();
-
-                    do
-                    {
-                        receiveResult = await _webSocket.ReceiveAsync(buffer, CancellationToken.None);
-
-                        if (buffer.Array == null)
-                            continue;
-
-#pragma warning disable CA1849
-                        memory.Write(buffer.Array, buffer.Offset, receiveResult.Count);
-#pragma warning restore CA1849
-                        payloadSize += receiveResult.Count;
-                    } while (!receiveResult.EndOfMessage);
-
-                    switch (receiveResult.MessageType)
-                    {
-                        case WebSocketMessageType.Text:
-                        {
-                            if (payloadSize == 0)
-                                continue;
-
-                            memory.Seek(0, SeekOrigin.Begin);
-
-                            var reader = new StreamReader(memory, Encoding.UTF8);
-
-                            OnDataReceived?.Invoke(this, new DataReceivedArgs { Message = await reader.ReadToEndAsync() });
-
-                            memory.Dispose();
-                            reader.Dispose();
-                            break;
-                        }
-                        case WebSocketMessageType.Binary:
-                            break;
-                        case WebSocketMessageType.Close:
-                            if (_webSocket.CloseStatus != null)
-                                _logger?.LogWebsocketClosed((WebSocketCloseStatus)_webSocket.CloseStatus!, _webSocket.CloseStatusDescription!);
-                            break;
-                        default:
-                            throw new ArgumentOutOfRangeException();
-                    }
-                }
-
-                catch (Exception ex)
-                {
-                    OnErrorOccurred?.Invoke(this, new ErrorOccuredArgs { Exception = ex });
-                    break;
-                }
-            }
-        }
-#endif
 
         /// <summary>
         /// Cleanup of any unused resources as per IDisposable guidelines

TwitchLib.EventSub.Websockets/Core/EventArgs/Channel/ChannelChatClearArgs.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 ChannelChatClearArgs : TwitchLibEventSubEventArgs<EventSubNotification<ChannelChatClear>>
+{ }

TwitchLib.EventSub.Websockets/Core/EventArgs/Channel/ChannelChatClearUserMessagesArgs.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 ChannelChatClearUserMessagesArgs : TwitchLibEventSubEventArgs<EventSubNotification<ChannelChatClearUserMessage>>
+{ }

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Core.EventArgs.Channel
+{
+    public class ChannelSuspiciousUserMessageArgs : TwitchLibEventSubEventArgs<EventSubNotification<ChannelSuspiciousUserMessage>>
+    {
+    }
+}

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

@@ -0,0 +1,12 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Core.EventArgs.Channel
+{
+    public sealed class ChannelSuspiciousUserUpdateArgs : TwitchLibEventSubEventArgs<EventSubNotification<ChannelSuspiciousUserUpdate>>
+    {
+    }
+}