log: reorganize Show ValidationFailure error message

Lead with description, follow with header, add parent and adjacents only if relevant and available. Change-Id: Iba0c7994480e9e958b61529c7d521241a5867bd9
kadena-io · May 31, 2024 · 3ab3e64 · 3ab3e64
1 parent 24ff3ca
commit 3ab3e64
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/changes/2024-05-30T145855-0400.txt b/changes/2024-05-30T145855-0400.txt
@@ -0,0 +1 @@
+Reorganize ValidationFailure error message to be more readable
diff --git a/src/Chainweb/BlockHeader/Validation.hs b/src/Chainweb/BlockHeader/Validation.hs
@@ -288,10 +288,10 @@ webStepFailure hp = ValidationFailure
 instance Show ValidationFailure where
     show (ValidationFailure p as e ts)
         = T.unpack $ "Validation failure"
-            <> ". Parent: " <> encodeToText (ObjectEncoded . _parentHeader <$> p)
-            <> ". Adjacents: " <> encodeToText ((fmap (ObjectEncoded . _parentHeader)) <$> as)
-            <> ". Header: " <> encodeToText (ObjectEncoded e)
             <> ". Description: " <> T.unlines (map description ts)
+            <> ". Header: " <> encodeToText (ObjectEncoded e)
+            <> maybe "" (\p' -> ". Parent: " <> encodeToText (ObjectEncoded $ _parentHeader p')) p
+            <> maybe "" (\as' -> ". Adjacents: " <> encodeToText (ObjectEncoded . _parentHeader <$> as')) as
       where
         description t = case t of
             MissingParent -> "Parent isn't in the database"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Reorganize ValidationFailure error message to be more readable