feat: add operation name and ID to error messages of timed out WebSocket opeartions

kacper-dudziak-elympics · kacper-dudziak-elympics · commit 9bcb53dfcc17 · 2025-10-13T18:05:51.000+02:00
diff --git a/Runtime/Communication/Lobby/ResultUtils.cs b/Runtime/Communication/Lobby/ResultUtils.cs
@@ -9,7 +9,13 @@ namespace Elympics.Lobby
 {
     internal static class ResultUtils
     {
-        public static async UniTask<TResult> WaitForResult<TResult, TAction>(TimeSpan timeout, Func<UniTaskCompletionSource<TResult>, TAction> handlerFactory, Action<TAction>? onBeforeWait = null, Action<TAction>? onAfterWait = null, CancellationToken ct = default)
+        public static async UniTask<TResult> WaitForResult<TResult, TAction>(
+            TimeSpan timeout,
+            Func<UniTaskCompletionSource<TResult>, TAction> handlerFactory,
+            string operationName,
+            Action<TAction>? onBeforeWait = null,
+            Action<TAction>? onAfterWait = null,
+            CancellationToken ct = default)
             where TAction : Delegate
         {
             var tcs = new UniTaskCompletionSource<TResult>();
@@ -32,7 +38,7 @@ public static async UniTask<TResult> WaitForResult<TResult, TAction>(TimeSpan ti
             }
 
             ct.ThrowIfCancellationRequested();
-            throw new LobbyOperationException($"Operation {nameof(WaitForResult)} timed out");
+            throw new LobbyOperationException($"{nameof(WaitForResult)} timed out for operation: {operationName}.");
         }
 
         public static async UniTask<T> WithTimeout<T>(this UniTaskCompletionSource<T> tcs, TimeSpan timeout, CancellationToken ct = default)
diff --git a/Runtime/Communication/Lobby/WebSocketSession.cs b/Runtime/Communication/Lobby/WebSocketSession.cs
@@ -121,7 +121,7 @@ public async UniTask<OperationResultDto> ExecuteOperation(LobbyOperation message
         private async UniTask<OperationResultDto> ExecuteOperationInternal(LobbyOperation message, CancellationToken ct)
         {
             using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(Token, ct);
-            var task = WaitForOperationResult(message.OperationId, ElympicsTimeout.WebSocketOperationTimeout, linkedCts.Token);
+            var task = WaitForOperationResult(message.OperationId, ElympicsTimeout.WebSocketOperationTimeout, $"{nameof(ExecuteOperationInternal)} {message.GetType().Name} with {nameof(message.OperationId)}: {message.OperationId}", linkedCts.Token);
             SendMessage(message);
             return await task;
         }
@@ -168,6 +168,7 @@ private async UniTask OpenWebSocket(IWebSocket ws)
         {
             var openTask = ResultUtils.WaitForResult<ValueTuple, WebSocketOpenEventHandler>(ElympicsTimeout.WebSocketOpeningTimeout,
                 tcs => () => tcs.TrySetResult(new ValueTuple()),
+                nameof(OpenWebSocket),
                 handler => ws.OnOpen += handler,
                 handler => ws.OnOpen -= handler,
                 Token);
@@ -342,9 +343,10 @@ private async UniTask PropagateDisconnection(DisconnectionReason reason)
                 Disconnected?.Invoke(data);
         }
 
-        private UniTask<OperationResultDto> WaitForOperationResult(Guid operationId, TimeSpan timeout, CancellationToken ct) =>
+        private UniTask<OperationResultDto> WaitForOperationResult(Guid operationId, TimeSpan timeout, string operationName, CancellationToken ct) =>
             ResultUtils.WaitForResult<OperationResultDto, Action<OperationResultDto>>(timeout,
                 tcs => result => _ = result.Success ? tcs.TrySetResult(result) : tcs.TrySetException(new LobbyOperationException(result)),
+                operationName,
                 handler => _operationResultHandlers.TryAdd(operationId, handler),
                 _ => _operationResultHandlers.TryRemove(operationId, out var _),
                 ct);
@@ -354,6 +356,7 @@ private async UniTask<TData> WaitForLobbyData<TData>(Guid requestId, TimeSpan ti
         {
             var result = await ResultUtils.WaitForResult<IFromLobby, Action<IFromLobby>>(timeout,
                 tcs => result => _ = tcs.TrySetResult(result),
+                $"{nameof(WaitForLobbyData)} {nameof(TData)} with {nameof(requestId)}: {requestId}",
                 handler => _dataResponses.TryAdd(requestId, handler),
                 _ => _dataResponses.TryRemove(requestId, out var _),
                 ct);

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,13 @@ namespace Elympics.Lobby`
`9`	`9`	`{`
`10`	`10`	`internal static class ResultUtils`
`11`	`11`	`{`
`12`		`- public static async UniTask<TResult> WaitForResult<TResult, TAction>(TimeSpan timeout, Func<UniTaskCompletionSource<TResult>, TAction> handlerFactory, Action<TAction>? onBeforeWait = null, Action<TAction>? onAfterWait = null, CancellationToken ct = default)`
	`12`	`+ public static async UniTask<TResult> WaitForResult<TResult, TAction>(`
	`13`	`+ TimeSpan timeout,`
	`14`	`+ Func<UniTaskCompletionSource<TResult>, TAction> handlerFactory,`
	`15`	`+ string operationName,`
	`16`	`+ Action<TAction>? onBeforeWait = null,`
	`17`	`+ Action<TAction>? onAfterWait = null,`
	`18`	`+ CancellationToken ct = default)`
`13`	`19`	`where TAction : Delegate`
`14`	`20`	`{`
`15`	`21`	`var tcs = new UniTaskCompletionSource<TResult>();`
`@@ -32,7 +38,7 @@ public static async UniTask<TResult> WaitForResult<TResult, TAction>(TimeSpan ti`
`32`	`38`	`}`
`33`	`39`
`34`	`40`	`ct.ThrowIfCancellationRequested();`
`35`		`- throw new LobbyOperationException($"Operation {nameof(WaitForResult)} timed out");`
	`41`	`+ throw new LobbyOperationException($"{nameof(WaitForResult)} timed out for operation: {operationName}.");`
`36`	`42`	`}`
`37`	`43`
`38`	`44`	`public static async UniTask<T> WithTimeout<T>(this UniTaskCompletionSource<T> tcs, TimeSpan timeout, CancellationToken ct = default)`