Fixed: do not duplicate the list of JSON:API errors in meta stack trace, but do write them when logging

Author: Bart Koelman

src/JsonApiDotNetCore/Errors/InvalidModelStateException.cs

@@ -116,10 +116,14 @@ private static ErrorObject FromModelError(ModelError modelError, string attribut
 
             if (includeExceptionStackTraceInErrors && modelError.Exception != null)
             {
-                string[] stackTraceLines = modelError.Exception.Demystify().ToString().Split(Environment.NewLine);
+                Exception exception = modelError.Exception.Demystify();
+                string[] stackTraceLines = exception.ToString().Split(Environment.NewLine);
 
-                error.Meta ??= new Dictionary<string, object>();
-                error.Meta["StackTrace"] = stackTraceLines;
+                if (stackTraceLines.Any())
+                {
+                    error.Meta ??= new Dictionary<string, object>();
+                    error.Meta["StackTrace"] = stackTraceLines;
+                }
             }
 
             return error;

src/JsonApiDotNetCore/Errors/JsonApiException.cs

@@ -24,8 +24,6 @@ public class JsonApiException : Exception
 
         public IReadOnlyList<ErrorObject> Errors { get; }
 
-        public override string Message => $"Errors = {JsonSerializer.Serialize(Errors, SerializerOptions)}";
-
         public JsonApiException(ErrorObject error, Exception innerException = null)
             : base(null, innerException)
         {
@@ -42,5 +40,10 @@ public JsonApiException(IEnumerable<ErrorObject> errors, Exception innerExceptio
 
             Errors = errorList;
         }
+
+        public string GetSummary()
+        {
+            return $"{nameof(JsonApiException)}: Errors = {JsonSerializer.Serialize(Errors, SerializerOptions)}";
+        }
     }
 }

src/JsonApiDotNetCore/Middleware/ExceptionHandler.cs

@@ -67,7 +67,7 @@ protected virtual string GetLogMessage(Exception exception)
         {
             ArgumentGuard.NotNull(exception, nameof(exception));
 
-            return exception.Message;
+            return exception is JsonApiException jsonApiException ? jsonApiException.GetSummary() : exception.Message;
         }
 
         protected virtual Document CreateErrorDocument(Exception exception)
@@ -103,8 +103,11 @@ private void ApplyOptions(ErrorObject error, Exception exception)
             {
                 string[] stackTraceLines = resultException.ToString().Split(Environment.NewLine);
 
-                error.Meta ??= new Dictionary<string, object>();
-                error.Meta["StackTrace"] = stackTraceLines;
+                if (stackTraceLines.Any())
+                {
+                    error.Meta ??= new Dictionary<string, object>();
+                    error.Meta["StackTrace"] = stackTraceLines;
+                }
             }
         }
     }

test/JsonApiDotNetCoreTests/IntegrationTests/ExceptionHandling/ExceptionHandlerTests.cs

@@ -116,7 +116,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             error.Detail.Should().Be("Exception has been thrown by the target of an invocation.");
 
             IEnumerable<string> stackTraceLines = ((JsonElement)error.Meta["stackTrace"]).EnumerateArray().Select(token => token.GetString());
-            stackTraceLines.Should().ContainMatch("* System.InvalidOperationException: Article status could not be determined.*");
+            stackTraceLines.Should().ContainMatch("*at object System.Reflection.*");
 
             loggerFactory.Logger.Messages.Should().HaveCount(1);
             loggerFactory.Logger.Messages.Single().LogLevel.Should().Be(LogLevel.Error);