Set unexpected errors in Status.DebugException (grpc#947)

Author: JamesNK

src/Grpc.AspNetCore.Server/Internal/HttpContextServerCallContext.cs

@@ -189,7 +189,10 @@ private void ProcessHandlerError(Exception ex, string method)
                 GrpcServerLog.ErrorExecutingServiceMethod(Logger, method, ex);
 
                 var message = ErrorMessageHelper.BuildErrorMessage("Exception was thrown by handler.", ex, Options.EnableDetailedErrors);
-                _status = new Status(StatusCode.Unknown, message);
+
+                // Note that the exception given to status won't be returned to the client.
+                // It is still useful to set in case an interceptor accesses the status on the server.
+                _status = new Status(StatusCode.Unknown, message, ex);
             }
 
             // Don't update trailers if request has exceeded deadline/aborted

src/Grpc.Net.Client/Internal/GrpcCall.cs

@@ -610,7 +610,7 @@ private void ResolveException(Exception ex, [NotNull] out Status? status, out Ex
             {
                 var exceptionMessage = CommonGrpcProtocolHelpers.ConvertToRpcExceptionMessage(ex);
 
-                status = new Status(StatusCode.Internal, "Error starting gRPC call. " +  exceptionMessage);
+                status = new Status(StatusCode.Internal, "Error starting gRPC call. " +  exceptionMessage, ex);
                 resolvedException = CreateRpcException(status.Value);
             }
         }

src/Grpc.Net.Client/Internal/GrpcProtocolHelpers.cs

@@ -315,7 +315,7 @@ public static Status GetResponseStatus(HttpResponseMessage httpResponse)
             catch (Exception ex)
             {
                 // Handle error from parsing badly formed status
-                status = new Status(StatusCode.Cancelled, ex.Message);
+                status = new Status(StatusCode.Cancelled, ex.Message, ex);
             }
 
             return status.Value;

test/Grpc.AspNetCore.Server.Tests/CallHandlerTests.cs

@@ -29,7 +29,6 @@
 using Grpc.AspNetCore.Server.Tests.Infrastructure;
 using Grpc.AspNetCore.Server.Tests.TestObjects;
 using Grpc.Core;
-using Grpc.Net.Compression;
 using Grpc.Shared.Server;
 using Grpc.Tests.Shared;
 using Microsoft.AspNetCore.Http;
@@ -176,7 +175,26 @@ public async Task ProtocolValidation_IISHttp2Protocol_Success()
             Assert.IsNull(log);
         }
 
-        private static ServerCallHandlerBase<TestService, TestMessage, TestMessage> CreateHandler(MethodType methodType, ILoggerFactory? loggerFactory = null)
+        [Test]
+        public async Task StatusDebugException_ErrorInHandler_SetInDebugException()
+        {
+            // Arrange
+            var ex = new Exception("Test exception");
+            var httpContext = HttpContextHelpers.CreateContext();
+            var call = CreateHandler(MethodType.ClientStreaming, handlerAction: () => throw ex);
+
+            // Act
+            await call.HandleCallAsync(httpContext).DefaultTimeout();
+
+            // Assert
+            var serverCallContext = httpContext.Features.Get<IServerCallContextFeature>();
+            Assert.AreEqual(ex, serverCallContext.ServerCallContext.Status.DebugException);
+        }
+
+        private static ServerCallHandlerBase<TestService, TestMessage, TestMessage> CreateHandler(
+            MethodType methodType,
+            ILoggerFactory? loggerFactory = null,
+            Action? handlerAction = null)
         {
             var method = new Method<TestMessage, TestMessage>(methodType, "test", "test", _marshaller, _marshaller);
 
@@ -185,31 +203,47 @@ private static ServerCallHandlerBase<TestService, TestMessage, TestMessage> Crea
                 case MethodType.Unary:
                     return new UnaryServerCallHandler<TestService, TestMessage, TestMessage>(
                         new UnaryServerMethodInvoker<TestService, TestMessage, TestMessage>(
-                            (service, reader, context) => Task.FromResult(new TestMessage()),
+                            (service, reader, context) =>
+                            {
+                                handlerAction?.Invoke();
+                                return Task.FromResult(new TestMessage());
+                            },
                             method,
                             HttpContextServerCallContextHelper.CreateMethodOptions(),
                             new TestGrpcServiceActivator<TestService>()),
                         loggerFactory ?? NullLoggerFactory.Instance);
                 case MethodType.ClientStreaming:
                     return new ClientStreamingServerCallHandler<TestService, TestMessage, TestMessage>(
                         new ClientStreamingServerMethodInvoker<TestService, TestMessage, TestMessage>(
-                            (service, reader, context) => Task.FromResult(new TestMessage()),
+                            (service, reader, context) =>
+                            {
+                                handlerAction?.Invoke();
+                                return Task.FromResult(new TestMessage());
+                            },
                             method,
                             HttpContextServerCallContextHelper.CreateMethodOptions(),
                             new TestGrpcServiceActivator<TestService>()),
                         loggerFactory ?? NullLoggerFactory.Instance);
                 case MethodType.ServerStreaming:
                     return new ServerStreamingServerCallHandler<TestService, TestMessage, TestMessage>(
                         new ServerStreamingServerMethodInvoker<TestService, TestMessage, TestMessage>(
-                            (service, request, writer, context) => Task.FromResult(new TestMessage()),
+                            (service, request, writer, context) =>
+                            {
+                                handlerAction?.Invoke();
+                                return Task.FromResult(new TestMessage());
+                            },
                             method,
                             HttpContextServerCallContextHelper.CreateMethodOptions(),
                             new TestGrpcServiceActivator<TestService>()),
                         loggerFactory ?? NullLoggerFactory.Instance);
                 case MethodType.DuplexStreaming:
                     return new DuplexStreamingServerCallHandler<TestService, TestMessage, TestMessage>(
                         new DuplexStreamingServerMethodInvoker<TestService, TestMessage, TestMessage>(
-                            (service, reader, writer, context) => Task.CompletedTask,
+                            (service, reader, writer, context) =>
+                            {
+                                handlerAction?.Invoke();
+                                return Task.CompletedTask;
+                            },
                             method,
                             HttpContextServerCallContextHelper.CreateMethodOptions(),
                             new TestGrpcServiceActivator<TestService>()),

test/Grpc.Net.Client.Tests/CompressionTests.cs

@@ -84,6 +84,7 @@ public async Task AsyncUnaryCall_UnknownCompressMetadataSentWithRequest_ThrowsEr
             var ex = await ExceptionAssert.ThrowsAsync<RpcException>(() => call.ResponseAsync).DefaultTimeout();
             Assert.AreEqual(StatusCode.Internal, ex.StatusCode);
             Assert.AreEqual("Error starting gRPC call. InvalidOperationException: Could not find compression provider for 'not-supported'.", ex.Status.Detail);
+            Assert.AreEqual("Could not find compression provider for 'not-supported'.", ex.Status.DebugException.Message);
         }
 
         [TestCase(true)]

test/Grpc.Net.Client.Tests/ResponseAsyncTests.cs

@@ -136,6 +136,7 @@ public async Task AsyncUnaryCall_ErrorSendingRequest_ThrowsError()
             // Assert
             Assert.AreEqual(StatusCode.Internal, ex.StatusCode);
             Assert.AreEqual("Error starting gRPC call. Exception: An error!", ex.Status.Detail);
+            Assert.AreEqual("An error!", ex.Status.DebugException.Message);
             Assert.AreEqual(StatusCode.Internal, call.GetStatus().StatusCode);
         }
 
@@ -156,6 +157,7 @@ public async Task AsyncUnaryCall_ErrorSendingRequest_ThrowsErrorWithInnerExcepti
             // Assert
             Assert.AreEqual(StatusCode.Internal, ex.StatusCode);
             Assert.AreEqual("Error starting gRPC call. Exception: An error! Exception: Nested error!", ex.Status.Detail);
+            Assert.AreEqual("Nested error!", ex.Status.DebugException.InnerException!.Message);
             Assert.AreEqual(StatusCode.Internal, call.GetStatus().StatusCode);
         }