Log full command json when sending command fails

net-daemon · Nov 7, 2023 · ada5e99 · ada5e99
1 parent 9691a5d
commit ada5e99
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/src/Client/NetDaemon.HassClient.Tests/HelperTest/ResultMessageHandlerTests.cs b/src/Client/NetDaemon.HassClient.Tests/HelperTest/ResultMessageHandlerTests.cs
@@ -35,19 +35,19 @@ public async Task TestTaskCompleteWithErrorResultShouldLogWarning()
         _resultMessageHandler.HandleResult(task, new CommandMessage {Type = "test"});
         await _resultMessageHandler.DisposeAsync().ConfigureAwait(false);
         task.IsCompletedSuccessfully.Should().BeTrue();
-        _loggerMock.VerifyWarningWasCalled("Failed command (test) error: (null).  Sent command is CommandMessage { Type = test, Id = 0 }");
+        _loggerMock.VerifyErrorWasCalled("""Failed command (test) error: (null).  Sent command is {"id":0,"type":"test"}""");
     }
 
     [Fact]
     public async Task TestTaskCompleteWithExceptionShouldLogError()
     {
         // TODO: Test sometimes fails in CI
         var task = SomeUnSuccessfulResultThrowsException();
-        _resultMessageHandler.HandleResult(task, new CommandMessage {Type = "test"});
+        _resultMessageHandler.HandleResult(task, new CallServiceCommand {Type = "test", Service = "light.turn_on", ServiceData = new {brightness = 2.3 }});
         await _resultMessageHandler.DisposeAsync().ConfigureAwait(false);
         task.IsCompletedSuccessfully.Should().BeFalse();
         task.IsFaulted.Should().BeTrue();
-        _loggerMock.VerifyErrorWasCalled("Exception waiting for result message  Sent command is CommandMessage { Type = test, Id = 0 }");
+        _loggerMock.VerifyErrorWasCalled("""Exception waiting for result message  Sent command is {"domain":"","service":"light.turn_on","service_data":{"brightness":2.3},"target":null,"id":0,"type":"test"}""");
     }
 
     [Fact]
@@ -59,7 +59,7 @@ public async Task TestTaskCompleteWithTimeoutShouldLogWarning()
         _resultMessageHandler.HandleResult(task, new CommandMessage {Type = "test"});
         await _resultMessageHandler.DisposeAsync().ConfigureAwait(false);
         task.IsCompletedSuccessfully.Should().BeTrue();
-        _loggerMock.VerifyWarningWasCalled("Command (test) did not get response in timely fashion.  Sent command is CommandMessage { Type = test, Id = 0 }");
+        _loggerMock.VerifyWarningWasCalled("""Command (test) did not get response in timely fashion.  Sent command is {"id":0,"type":"test"}""");
     }
 
 

diff --git a/src/Client/NetDaemon.HassClient/Common/HomeAssistant/Model/CommandMessage.cs b/src/Client/NetDaemon.HassClient/Common/HomeAssistant/Model/CommandMessage.cs
@@ -2,5 +2,9 @@
 
 public record CommandMessage : HassMessageBase
 {
+    private static readonly JsonSerializerOptions NonIndentingJsonSerializerOptions = new() { WriteIndented = false };
+
     [JsonPropertyName("id")] public int Id { get; set; }
-}
+
+    public string GetJsonString() => JsonSerializer.Serialize(this, GetType(), NonIndentingJsonSerializerOptions);
+}
diff --git a/src/Client/NetDaemon.HassClient/Internal/Helpers/ResultMessageHandler.cs b/src/Client/NetDaemon.HassClient/Internal/Helpers/ResultMessageHandler.cs
@@ -29,21 +29,21 @@ async Task Wrap()
                     // We have a timeout
                     logger.LogWarning(
                         "Command ({CommandType}) did not get response in timely fashion.  Sent command is {CommandMessage}",
-                        command.Type, command);
+                        command.Type, command.GetJsonString());
                 }
                 // We wait for the task even if there was a timeout so we make sure
                 // we catch the original error
                 var result = await task.ConfigureAwait(false);
                 if (!result.Success ?? false)
                 {
-                    logger.LogWarning(
+                    logger.LogError(
                         "Failed command ({CommandType}) error: {ErrorResult}.  Sent command is {CommandMessage}",
-                        command.Type, result.Error, command);
+                        command.Type, result.Error, command.GetJsonString());
                 }
             }
             catch (Exception e)
             {
-                logger.LogError(e, "Exception waiting for result message  Sent command is {CommandMessage}", command);
+                logger.LogError(e, "Exception waiting for result message  Sent command is {CommandMessage}", command.GetJsonString());
             }
             finally
             {