Tweaks in log formatting

Author: Bart Koelman

src/JsonApiDotNetCore/Exceptions/InvalidRequestBodyException.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Net;
-using System.Text;
 using JsonApiDotNetCore.Models.JsonApiDocuments;
 
 namespace JsonApiDotNetCore.Exceptions
@@ -29,7 +28,7 @@ private static string FormatDetails(string details, string requestBody, Exceptio
             {
                 if (text != null)
                 {
-                    text += Environment.NewLine;
+                    text += " - ";
                 }
 
                 text += "Request body: <<" + requestBody + ">>";

src/JsonApiDotNetCore/Exceptions/JsonApiException.cs

@@ -7,6 +7,12 @@ namespace JsonApiDotNetCore.Exceptions
 {
     public class JsonApiException : Exception
     {
+        private static readonly JsonSerializerSettings _errorSerializerSettings = new JsonSerializerSettings
+        {
+            NullValueHandling = NullValueHandling.Ignore,
+            Formatting = Formatting.Indented
+        };
+
         public Error Error { get; }
 
         public JsonApiException(Error error, Exception innerException = null)
@@ -24,6 +30,6 @@ public JsonApiException(HttpStatusCode status, string message)
             };
         }
 
-        public override string Message => "Error = " + JsonConvert.SerializeObject(Error, Formatting.Indented);
+        public override string Message => "Error = " + JsonConvert.SerializeObject(Error, _errorSerializerSettings);
     }
 }

src/JsonApiDotNetCore/Middleware/DefaultExceptionHandler.cs

@@ -21,17 +21,19 @@ public DefaultExceptionHandler(ILoggerFactory loggerFactory, IJsonApiOptions opt
 
         public ErrorDocument HandleException(Exception exception)
         {
-            LogException(exception);
+            Exception demystified = exception.Demystify();
+
+            LogException(demystified);
 
-            return CreateErrorDocument(exception);
+            return CreateErrorDocument(demystified);
         }
 
         private void LogException(Exception exception)
         {
             var level = GetLogLevel(exception);
-
-            Exception demystified = exception.Demystify();
-            _logger.Log(level, demystified, $"Intercepted {demystified.GetType().Name}: {demystified.Message}");
+            var message = GetLogMessage(exception);
+            
+            _logger.Log(level, exception, message);
         }
 
         protected virtual LogLevel GetLogLevel(Exception exception)
@@ -44,6 +46,13 @@ protected virtual LogLevel GetLogLevel(Exception exception)
             return LogLevel.Error;
         }
 
+        protected virtual string GetLogMessage(Exception exception)
+        {
+            return exception is JsonApiException jsonApiException
+                ? jsonApiException.Error.Title
+                : exception.Message;
+        }
+
         protected virtual ErrorDocument CreateErrorDocument(Exception exception)
         {
             if (exception is InvalidModelStateException modelStateException)

test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/UpdatingDataTests.cs

@@ -88,7 +88,7 @@ public async Task Response422IfUpdatingNotSettableAttribute()
             var error = document.Errors.Single();
             Assert.Equal(HttpStatusCode.UnprocessableEntity, error.StatusCode);
             Assert.Equal("Failed to deserialize request body.", error.Title);
-            Assert.StartsWith("Property set method not found." + Environment.NewLine + "Request body: <<", error.Detail);
+            Assert.StartsWith("Property set method not found. - Request body: <<", error.Detail);
         }
 
         [Fact]