yawaflua/WebSockets
1
0
Fork 0
mirror of https://github.com/yawaflua/WebSockets.git synced 2026-02-04 14:04:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Refactor WebSocket routing and error handling logic

Browse Source 
Replaces `Dictionary` with `ConcurrentDictionary` for thread-safe WebSocket route management and improves error logging with added debug assertions. Also fixes duplicate registrations, enhances dependency injection, updates package references, and adjusts WebSocket attribute structure for better extensibility and usage.
This commit is contained in:
Dmitri Shimanski
2025-05-25 03:32:33 +03:00
parent 59ddda6077
commit c851815a2c
10 changed files with 131 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
yawaflua.WebSockets/Attributes/WebSocketAttribute.cs
View File

@@ -21,7 +21,7 @@ namespace yawaflua.WebSockets.Attributes;
/// </remarks>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
[ApiExplorerSettings(IgnoreApi = true)]
public class WebSocketAttribute : RouteAttribute, IRouteTemplateProvider, IApiDescriptionVisibilityProvider
public class WebSocketAttribute : Attribute, IApiDescriptionVisibilityProvider
{
/// <summary>
/// Original route template specified in attribute
@@ -39,7 +39,7 @@ public class WebSocketAttribute : RouteAttribute, IRouteTemplateProvider, IApiDe
/// - Parameters: "/user/{id}"
/// - Constraints: "/file/{name:alpha}"
/// - Optional: "/feed/{category?}"</param>
public WebSocketAttribute([RouteTemplate]string path) : base(path)
public WebSocketAttribute(string path)
{
Template = path;
Name = path;

76
yawaflua.WebSockets/Core/WebSocketRouter.cs
View File

@@ -1,4 +1,6 @@
using System.Diagnostics.CodeAnalysis;
using System.Collections.Concurrent;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Net.WebSockets;
using System.Reflection;
using System.Text;
@@ -15,7 +17,7 @@ namespace yawaflua.WebSockets.Core;
[SuppressMessage("ReSharper", "AsyncVoidLambda")]
public class WebSocketRouter
{
internal static readonly Dictionary<string, Func<WebSocket, HttpContext, Task>> Routes = new();
internal static readonly ConcurrentDictionary<string, Func<WebSocket, HttpContext, Task>> Routes = new();
internal static readonly List<IWebSocketClient> Clients = new();
private readonly IServiceProvider _serviceProvider;
private readonly ILogger<WebSocketRouter> _logger;
@@ -69,6 +71,7 @@ public class WebSocketRouter
parameters[1].ParameterType != typeof(HttpContext) ||
func.ReturnType != typeof(Task))
{
_logger.LogCritical($"Invalid handler signature in {type.Name}.{func.Name}");
throw new InvalidOperationException(
$"Invalid handler signature in {type.Name}.{func.Name}");
}
@@ -79,15 +82,25 @@ public class WebSocketRouter
typeof(Func<WebSocket, HttpContext, Task>),
func
);
Routes.Add(parentAttributeTemplate, delegateFunc);
if (!Routes.TryAdd(parentAttributeTemplate, delegateFunc))
{
_logger.LogCritical($"Error registered whilest adds new route: {parentAttributeTemplate}");
throw new InvalidOperationException(
$"Error registered whilest adds new route: {parentAttributeTemplate}");
}
}
else
{
Routes.Add(parentAttributeTemplate, async (ws, context) =>
if (!Routes.TryAdd(parentAttributeTemplate, async (ws, context) =>
{
var instance = context.RequestServices.GetRequiredService(type);
await (Task)func.Invoke(instance, new object[] { ws, context })!;
}))
{
var instance = context.RequestServices.GetRequiredService(type);
await (Task)func.Invoke(instance, new object[] { ws, context })!;
});
_logger.LogCritical($"Error registered whilest adds new route: {parentAttributeTemplate}");
throw new InvalidOperationException(
$"Error registered whilest adds new route: {parentAttributeTemplate}");
}
}
}
else
@@ -96,21 +109,42 @@ public class WebSocketRouter
{
var attribute =
(WebSocketAttribute)method.GetCustomAttributes(typeof(WebSocketAttribute), false).First();
var key = parentAttributeTemplate+attribute.Template;
if (Routes.ContainsKey(key))
{
Debug.WriteLine(Routes);
_logger.LogCritical($"Duplicate route error: {key}");
throw new InvalidOperationException(
$"Duplicate route error: {key}");
}
if (method.IsStatic)
{
var delegateFunc = (Func<WebSocket, HttpContext, Task>)Delegate.CreateDelegate(
typeof(Func<WebSocket, HttpContext, Task>),
method
);
Routes.Add(parentAttributeTemplate+attribute.Template, delegateFunc);
if (!Routes.TryAdd(key, delegateFunc))
{
_logger.LogCritical($"Error registered whilest adds new route: {key}");
throw new InvalidOperationException(
$"Error registered whilest adds new route: {key}");
}
}
else
{
Routes.Add(parentAttributeTemplate+attribute.Template, async (ws, context) =>
if (!Routes.TryAdd(key, async (ws, context) =>
{
var instance = context.RequestServices.GetRequiredService(type);
await (Task)method.Invoke(instance, new object[] { ws, context })!;
}))
{
var instance = context.RequestServices.GetRequiredService(type);
await (Task)method.Invoke(instance, new object[] { ws, context })!;
});
_logger.LogCritical($"Error registered whilest adds new route: {key}");
throw new InvalidOperationException(
$"Error registered whilest adds new route: {key}");
}
}
}
}
@@ -127,8 +161,19 @@ public class WebSocketRouter
}
catch (Exception ex)
{
_logger.LogCritical(message:"Error when parsing attributes from assemblies: ", exception:ex);
_logger.LogCritical("Error when parsing attributes from assemblies: {ex}", ex);
Debug.WriteLine(ex);
Debug.WriteLine(Routes);
throw new Exception("Error when parsing attributes from assemblies", ex);
}
#if DEBUG
_logger.LogDebug("Routes:");
foreach (var route in Routes)
{
_logger.LogDebug("Key:FuncName => {k}:{f}", route.Key, route.Value.Method.Name);
}
#endif
}
internal async Task HandleRequest(HttpContext context, CancellationToken cts = default)
@@ -179,12 +224,13 @@ public class WebSocketRouter
}
catch (Exception ex)
{
_logger.LogError(message:"Error with handling request: ",exception: ex);
_logger.LogError("Error with handling request: {ex}", ex);
await Task.Run(async () =>
{
if (_webSocketConfig?.OnErrorHandler != null)
await _webSocketConfig.OnErrorHandler(ex, new WebSocket(webSocket, client, webSocketManager), context);
}, cts);
}
}, cts);
@@ -197,7 +243,7 @@ public class WebSocketRouter
}
catch (Exception ex)
{
_logger.LogError(ex, $"Error when handle request {context.Connection.Id}: ");
_logger.LogError($"Error when handle request {context.Connection.RemoteIpAddress}: {ex}");
if (_webSocketConfig!.OnConnectionErrorHandler != null)
await _webSocketConfig.OnConnectionErrorHandler(ex, context);
}

2
yawaflua.WebSockets/Models/Abstracts/WebSocketController.cs
View File

@@ -5,7 +5,7 @@ using WebSocketManager = yawaflua.WebSockets.Core.WebSocketManager;
namespace yawaflua.WebSockets.Models.Abstracts;
public abstract class WebSocketController : IWebSocketController
public abstract class WebSocketController : IWebSocketController
{
/// <summary>
/// WebsocketManager provides work with all clients

2
yawaflua.WebSockets/ServiceBindings.cs
View File

@@ -16,6 +16,8 @@ public static class ServiceBindings
if (isc.All(k => k.ServiceType != typeof(WebSocketConfig)))
isc.AddSingleton(new WebSocketConfig());
isc.AddScoped<IWebSocketManager, WebSocketManager>();
isc.AddSingleton<IWebSocketManager, WebSocketManager>();
isc.AddTransient<IWebSocketManager, WebSocketManager>();
isc.AddSingleton<WebSocketMiddleware>();
return isc;
}

3
yawaflua.WebSockets/yawaflua.WebSockets.csproj
View File

@@ -4,7 +4,7 @@
<TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<Version>1.0.1</Version>
<Version>1.0.2</Version>
<Title>yawaflua.WebSockets</Title>
<Description>New AspNet controllers looks like websocket manager </Description>
<Copyright>Dmitrii Shimanskii</Copyright>
@@ -20,6 +20,7 @@
<ItemGroup>
<PackageReference Include="JetBrains.Annotations" Version=">= (2023.3.0,)"/>
<PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.3.0" />
<PackageReference Include="Microsoft.AspNetCore.WebSockets" Version=">= (2.1.7,)" />
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version=">= (6.0.0,)" />
<PackageReference Include="System.Net.WebSockets" Version=">= (4.0.0,)"/>