From 0f680b194761bd35628e8ca09751565efaf79b34 Mon Sep 17 00:00:00 2001 From: John Colvin Date: Thu, 11 Jul 2024 10:25:24 -0400 Subject: [PATCH] improvement: Accept CancellationToken, catch exceptions when running ds websocket server --- .../DataStreamSubscriptionController.cs | 18 ++--- .../DataStreamWebSocketServer.cs | 71 ++++++++++++++----- 2 files changed, 62 insertions(+), 27 deletions(-) diff --git a/src/DataStreamSuite/Bts.DataStreamWebApp.Server/Controllers/DataStreamSubscriptionController.cs b/src/DataStreamSuite/Bts.DataStreamWebApp.Server/Controllers/DataStreamSubscriptionController.cs index 02eb88e19..7f7e5dd19 100644 --- a/src/DataStreamSuite/Bts.DataStreamWebApp.Server/Controllers/DataStreamSubscriptionController.cs +++ b/src/DataStreamSuite/Bts.DataStreamWebApp.Server/Controllers/DataStreamSubscriptionController.cs @@ -1,7 +1,5 @@ namespace Bts.DataStreamWebApp.Server.Controllers; -using bts.api.core; - using Microsoft.AspNetCore.Mvc; [Route("/ws")] @@ -14,17 +12,19 @@ public class DataStreamSubscriptionController : ControllerBase { } [Route("/ws")] - public async Task Get() { + public async Task Get(CancellationToken cancellationToken) { if (!HttpContext.WebSockets.IsWebSocketRequest) { logger.LogError("Expected websocket request on path '{}'", HttpContext.Request.Path); return; } logger.LogInformation("Establishing websocket connection..."); - using var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync(); - logger.LogInformation("Websocket connection established."); - var context = ServiceContext.create(); - await context.login("bts", string.Empty); - var server = new DataStreamWebSocketServer(webSocket, logger); - await server.Run(); + try { + using var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync(); + logger.LogInformation("Websocket connection established."); + using var server = new DataStreamWebSocketServer(webSocket, logger); + await server.Run(cancellationToken); + } catch (Exception ex) { + logger.LogError("DataStreamSubscriptionController.Run threw exception: {Exception}", ex); + } } } diff --git a/src/DataStreamSuite/Bts.DataStreamWebApp.Server/DataStreamWebSocketServer.cs b/src/DataStreamSuite/Bts.DataStreamWebApp.Server/DataStreamWebSocketServer.cs index 11e0e5008..1a8e15443 100644 --- a/src/DataStreamSuite/Bts.DataStreamWebApp.Server/DataStreamWebSocketServer.cs +++ b/src/DataStreamSuite/Bts.DataStreamWebApp.Server/DataStreamWebSocketServer.cs @@ -9,7 +9,7 @@ using System.Text; using System.Text.Json; using System.Text.Json.Nodes; -public class DataStreamWebSocketServer { +public class DataStreamWebSocketServer : IDisposable, IAsyncDisposable { readonly ILogger logger; readonly WebSocket webSocket; readonly Dictionary subscriptions = new(); @@ -19,12 +19,12 @@ public class DataStreamWebSocketServer { this.logger = logger; } - public async Task Run() { + public async Task Run(CancellationToken cancellationToken) { logger.LogInformation("DataStreamWebSocketServer running"); - await foreach (var req in JsonRpcRequestAsyncEnumerable.Create(webSocket, logger)) { + await foreach (var req in JsonRpcRequestAsyncEnumerable.Create(webSocket, logger, cancellationToken)) { await (req.Method switch { - "subscribe" => onSubscribe(req), - "unsubscribe" => onUnsubscribe(req.Deserialize()), + "subscribe" => onSubscribe(req, cancellationToken), + "unsubscribe" => onUnsubscribe(req.Deserialize(), cancellationToken), _ => Task.CompletedTask, }); } @@ -32,27 +32,51 @@ public class DataStreamWebSocketServer { return 0; } - async Task onSubscribe(JsonRpcRequest req) { + /// + /// Disposes internal subscriptions. To additionally notify the client of the subscription status + /// change(s), use . + /// + public void Dispose() { + GC.SuppressFinalize(this); + disposeSubscriptions(); + } + + /// + /// Disposes internal subscriptions (like ), then sends 'subscription status change' + /// notifications to the client (unlike ). + /// + public async ValueTask DisposeAsync() { + GC.SuppressFinalize(this); + var finalSubs = subscriptions.Values.Select(s => (s.RequestId, s.Id)).ToList(); + disposeSubscriptions(); + // Send a 'subscription status change' msg to the client for each one. + foreach (var (requestId, id) in finalSubs) { + await sendSubscriptionStatus(requestId, id, "unsubscribe", SubscriptionStatus.Unsubscribed, CancellationToken.None); + } + } + + async Task onSubscribe(JsonRpcRequest req, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(req.Id); ArgumentException.ThrowIfNullOrEmpty(req.Method); if (!SubscribeRequest.ParseQuery(req, out var vs, out var subId, out var errMsg, out var errCode)) { logger.LogError("Invalid 'subscribe' request: {Reason}", errMsg); - await send(new JsonRpcError() { + var rpcError = new JsonRpcError() { Code = (long)errCode, Message = $"{errCode}: {errMsg}", - }); + }; + await send(rpcError, cancellationToken); return; } if (subscriptions.TryGetValue(subId, out var oldSub)) { oldSub.Dispose(); } - var sub = new DataStreamSubscription(subId, vs, webSocket, logger); + var sub = new DataStreamSubscription(subId, req.Id.Value, vs, webSocket, logger); subscriptions[subId] = sub; - await sendSubscriptionStatus(req.Id.Value, subId, req.Method, SubscriptionStatus.Subscribed); - sub.Start(); + await sendSubscriptionStatus(req.Id.Value, subId, req.Method, SubscriptionStatus.Subscribed, cancellationToken); + await sub.StartAsync(cancellationToken); } - async Task onUnsubscribe(JsonRpcRequest req) { + async Task onUnsubscribe(JsonRpcRequest req, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(req.Id); ArgumentException.ThrowIfNullOrEmpty(req.Method); var subId = req.Params?.SubscriptionId ?? string.Empty; @@ -63,24 +87,35 @@ public class DataStreamWebSocketServer { logger.LogInformation("Disposing subscription"); sub.Dispose(); subscriptions.Remove(subId); - await sendSubscriptionStatus(req.Id.Value, subId, req.Method, SubscriptionStatus.Unsubscribed); + await sendSubscriptionStatus(req.Id.Value, subId, req.Method, SubscriptionStatus.Unsubscribed, cancellationToken); } - Task sendSubscriptionStatus(JsonRpcId reqId, string subId, string method, SubscriptionStatus status) { + async Task unsubscribe(JsonRpcId requestId, string subscriptionId, CancellationToken cancellationToken) { + await sendSubscriptionStatus(requestId, subscriptionId, "unsubscribe", SubscriptionStatus.Unsubscribed, cancellationToken); + } + + Task sendSubscriptionStatus(JsonRpcId reqId, string subId, string method, SubscriptionStatus status, CancellationToken cancellationToken) { logger.LogInformation("Sending {Method} ack. SubscriptionId = {SubscriptionId}", method, subId); - return send(JsonRpcResponse.Create(reqId, new SubscriptionStatusMessage() { + var response = JsonRpcResponse.Create(reqId, new SubscriptionStatusMessage() { SubscriptionId = subId, Status = status, - })); + }); + return send(response, cancellationToken); } - Task send(T message) { + Task send(T message, CancellationToken cancellationToken) { if (message is null) { return Task.CompletedTask; } var str = JsonSerializer.Serialize(message); var bytes = Encoding.UTF8.GetBytes(str); logger.LogTrace("Sending data. Length = {Length}", bytes.Length); - return webSocket.SendAsync(bytes, WebSocketMessageType.Text, true, CancellationToken.None); + return webSocket.SendAsync(bytes, WebSocketMessageType.Text, true, cancellationToken); + } + + void disposeSubscriptions() { + logger.LogInformation("Disposing DataStreamWebSocketServer subscriptions. Count: {Count}", subscriptions.Count); + subscriptions.Values.DisposeAll(); + subscriptions.Clear(); } }