From 7c68e772dd682fcbaa2967ee8c13fd190ae357f2 Mon Sep 17 00:00:00 2001
From: campersau <buchholz.bastian@googlemail.com>
Date: Wed, 22 Jun 2022 20:00:29 +0200
Subject: [PATCH] Log error when exception occurs during streaming (#42283)
---
.../Core/src/Internal/DefaultHubDispatcher.cs | 2 ++
.../src/Internal/DefaultHubDispatcherLog.cs | 3 ++
.../HubConnectionHandlerTestUtils/Hubs.cs | 23 +++++++++++++++
.../SignalR/test/HubConnectionHandlerTests.cs | 28 +++++++++++++------
4 files changed, 48 insertions(+), 8 deletions(-)
diff --git a/src/SignalR/server/Core/src/Internal/DefaultHubDispatcher.cs b/src/SignalR/server/Core/src/Internal/DefaultHubDispatcher.cs
index b6f7ffd02a0..49224d1de1e 100644
--- a/src/SignalR/server/Core/src/Internal/DefaultHubDispatcher.cs
+++ b/src/SignalR/server/Core/src/Internal/DefaultHubDispatcher.cs
@@ -474,6 +474,7 @@ internal sealed partial class DefaultHubDispatcher<THub> : HubDispatcher<THub> w
catch (ChannelClosedException ex)
{
// If the channel closes from an exception in the streaming method, grab the innerException for the error from the streaming method
+ Log.FailedStreaming(_logger, invocationId, descriptor.MethodExecutor.MethodInfo.Name, ex.InnerException ?? ex);
error = ErrorMessageHelper.BuildErrorMessage("An error occurred on the server while streaming results.", ex.InnerException ?? ex, _enableDetailedErrors);
}
catch (Exception ex)
@@ -481,6 +482,7 @@ internal sealed partial class DefaultHubDispatcher<THub> : HubDispatcher<THub> w
// If the streaming method was canceled we don't want to send a HubException message - this is not an error case
if (!(ex is OperationCanceledException && streamCts.IsCancellationRequested))
{
+ Log.FailedStreaming(_logger, invocationId, descriptor.MethodExecutor.MethodInfo.Name, ex);
error = ErrorMessageHelper.BuildErrorMessage("An error occurred on the server while streaming results.", ex, _enableDetailedErrors);
}
}
diff --git a/src/SignalR/server/Core/src/Internal/DefaultHubDispatcherLog.cs b/src/SignalR/server/Core/src/Internal/DefaultHubDispatcherLog.cs
index f80a970935a..6394c478458 100644
--- a/src/SignalR/server/Core/src/Internal/DefaultHubDispatcherLog.cs
+++ b/src/SignalR/server/Core/src/Internal/DefaultHubDispatcherLog.cs
@@ -105,4 +105,7 @@ internal static partial class DefaultHubDispatcherLog
[LoggerMessage(24, LogLevel.Debug, "CompletionMessage for invocation ID '{InvocationId}' received unexpectedly.", EventName = "UnexpectedCompletion")]
public static partial void UnexpectedCompletion(ILogger logger, string invocationId);
+
+ [LoggerMessage(25, LogLevel.Error, "Invocation ID {InvocationId}: Failed while sending stream items from hub method {HubMethod}.", EventName = "FailedStreaming")]
+ public static partial void FailedStreaming(ILogger logger, string invocationId, string hubMethod, Exception exception);
}
diff --git a/src/SignalR/server/SignalR/test/HubConnectionHandlerTestUtils/Hubs.cs b/src/SignalR/server/SignalR/test/HubConnectionHandlerTestUtils/Hubs.cs
index 7ee5efc3b12..d1ab0f3b3c0 100644
--- a/src/SignalR/server/SignalR/test/HubConnectionHandlerTestUtils/Hubs.cs
+++ b/src/SignalR/server/SignalR/test/HubConnectionHandlerTestUtils/Hubs.cs
@@ -691,6 +691,15 @@ public class StreamingHub : TestHub
}
}
+ public async IAsyncEnumerable<string> ExceptionAsyncEnumerable()
+ {
+ await Task.Yield();
+ throw new Exception("Exception from async enumerable");
+#pragma warning disable CS0162 // Unreachable code detected
+ yield break;
+#pragma warning restore CS0162 // Unreachable code detected
+ }
+
public async Task<IAsyncEnumerable<string>> CounterAsyncEnumerableAsync(int count)
{
await Task.Yield();
@@ -719,6 +728,20 @@ public class StreamingHub : TestHub
return channel.Reader;
}
+ public ChannelReader<int> ChannelClosedExceptionStream()
+ {
+ var channel = Channel.CreateUnbounded<int>();
+ channel.Writer.TryComplete(new ChannelClosedException("ChannelClosedException from channel"));
+ return channel.Reader;
+ }
+
+ public ChannelReader<int> ChannelClosedExceptionInnerExceptionStream()
+ {
+ var channel = Channel.CreateUnbounded<int>();
+ channel.Writer.TryComplete(new ChannelClosedException(new Exception("ChannelClosedException from channel")));
+ return channel.Reader;
+ }
+
public ChannelReader<int> ThrowStream()
{
throw new Exception("Throw from hub method");
diff --git a/src/SignalR/server/SignalR/test/HubConnectionHandlerTests.cs b/src/SignalR/server/SignalR/test/HubConnectionHandlerTests.cs
index bce1522e597..8b35d464759 100644
--- a/src/SignalR/server/SignalR/test/HubConnectionHandlerTests.cs
+++ b/src/SignalR/server/SignalR/test/HubConnectionHandlerTests.cs
@@ -2066,16 +2066,28 @@ public partial class HubConnectionHandlerTests : VerifiableLoggedTest
}
[Theory]
- [InlineData(true)]
- [InlineData(false)]
- public async Task ReceiveCorrectErrorFromStreamThrowing(bool detailedErrors)
+ [InlineData(nameof(StreamingHub.ExceptionAsyncEnumerable), "Exception: Exception from async enumerable")]
+ [InlineData(nameof(StreamingHub.ExceptionAsyncEnumerable), null)]
+ [InlineData(nameof(StreamingHub.ExceptionStream), "Exception: Exception from channel")]
+ [InlineData(nameof(StreamingHub.ExceptionStream), null)]
+ [InlineData(nameof(StreamingHub.ChannelClosedExceptionStream), "ChannelClosedException: ChannelClosedException from channel")]
+ [InlineData(nameof(StreamingHub.ChannelClosedExceptionStream), null)]
+ [InlineData(nameof(StreamingHub.ChannelClosedExceptionInnerExceptionStream), "Exception: ChannelClosedException from channel")]
+ [InlineData(nameof(StreamingHub.ChannelClosedExceptionInnerExceptionStream), null)]
+ public async Task ReceiveCorrectErrorFromStreamThrowing(string streamMethod, string detailedError)
{
- using (StartVerifiableLog())
+ bool ExpectedErrors(WriteContext writeContext)
+ {
+ return writeContext.LoggerName == "Microsoft.AspNetCore.SignalR.Internal.DefaultHubDispatcher" &&
+ writeContext.EventId.Name == "FailedStreaming";
+ }
+
+ using (StartVerifiableLog(ExpectedErrors))
{
var serviceProvider = HubConnectionHandlerTestUtils.CreateServiceProvider(builder =>
builder.AddSignalR(options =>
{
- options.EnableDetailedErrors = detailedErrors;
+ options.EnableDetailedErrors = detailedError != null;
}), LoggerFactory);
var connectionHandler = serviceProvider.GetService<HubConnectionHandler<StreamingHub>>();
@@ -2085,14 +2097,14 @@ public partial class HubConnectionHandlerTests : VerifiableLoggedTest
await client.Connected.DefaultTimeout();
- var messages = await client.StreamAsync(nameof(StreamingHub.ExceptionStream));
+ var messages = await client.StreamAsync(streamMethod);
Assert.Equal(1, messages.Count);
var completion = messages[0] as CompletionMessage;
Assert.NotNull(completion);
- if (detailedErrors)
+ if (detailedError != null)
{
- Assert.Equal("An error occurred on the server while streaming results. Exception: Exception from channel", completion.Error);
+ Assert.Equal($"An error occurred on the server while streaming results. {detailedError}", completion.Error);
}
else
{
--
GitLab