From c7448a8dae5751555a461cfeb93d6a67a3e02917 Mon Sep 17 00:00:00 2001
From: Michael Ruoss <michael.ruoss@ufirstgroup.com>
Date: Mon, 31 Oct 2022 17:42:00 +0100
Subject: [PATCH] HexDocs and prepare RC.1

---
 CHANGELOG.md                         |  7 +++++++
 lib/bonny/pluggable/logger.ex        | 16 ++++++++++------
 mix.exs                              |  2 +-
 test/bonny/pluggable/logger_test.exs |  4 ++--
 4 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 90169af..e313599 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- No new entries below this line! -->
 
+## [1.0.0-rc.1] - 2022-10-31
+
+# Added
+
+- Better logs in case of errors while applying status, descendants or events
+- Integration tests for these logs
+
 ## [1.0.0-rc.0] - 2022-10-29
 
 ### Changed
diff --git a/lib/bonny/pluggable/logger.ex b/lib/bonny/pluggable/logger.ex
index 421e563..acda587 100644
--- a/lib/bonny/pluggable/logger.ex
+++ b/lib/bonny/pluggable/logger.ex
@@ -2,10 +2,14 @@ defmodule Bonny.Pluggable.Logger do
   @moduledoc """
   A pluggable step for logging basic action event information in the format:
 
-      {:add, "example.com/v1", "Widget"} - Processing event
-      {:add, "example.com/v1", "Widget"} - Status applied
-      {:add, "example.com/v1", "Widget"} - Normal event emitted
-      {:add, "example.com/v1", "Widget"} - Descendant {"v1", "Deployment", "default/nginx"} applied
+      {"NAMESPACE/OBJECT_NAME", API_VERSION, "Kind=KIND, Action=ACTION"}
+
+  Example:
+
+      {"default/my-object", "example.com/v1", "Kind=MyCustomResource, Action=:add"} - Processing event
+      {"default/my-object", "example.com/v1", "Kind=MyCustomResource, Action=:add"} - Applying status
+      {"default/my-object", "example.com/v1", "Kind=MyCustomResource, Action=:add"} - Emitting Normal event
+      {"default/my-object", "example.com/v1", "Kind=MyCustomResource, Action=:add"} - Applying descendant {"default/nginx", "apps/v1", "Kind=Deployment"}
 
   To use it, just add a step to the desired module.
 
@@ -56,7 +60,7 @@ defmodule Bonny.Pluggable.Logger do
         Logger.log(
           level,
           fn ->
-            inspect(id) <> " - Descendant #{inspect(gvkn)} applied"
+            inspect(id) <> " - Applying descendant #{inspect(gvkn)}"
           end,
           resource: axn.resource,
           descendant: descendant
@@ -69,7 +73,7 @@ defmodule Bonny.Pluggable.Logger do
       Logger.log(
         level,
         fn ->
-          inspect(id) <> " - #{event.event_type} event emitted"
+          inspect(id) <> " - Emitting #{event.event_type} event"
         end,
         resource: axn.resource,
         event: event
diff --git a/mix.exs b/mix.exs
index 1a7fb55..f696dc3 100644
--- a/mix.exs
+++ b/mix.exs
@@ -1,6 +1,6 @@
 defmodule Bonny.MixProject do
   use Mix.Project
-  @version "1.0.0-rc.0"
+  @version "1.0.0-rc.1"
   @source_url "https://github.com/coryodaniel/bonny"
 
   def project do
diff --git a/test/bonny/pluggable/logger_test.exs b/test/bonny/pluggable/logger_test.exs
index 748c59e..a809c92 100644
--- a/test/bonny/pluggable/logger_test.exs
+++ b/test/bonny/pluggable/logger_test.exs
@@ -96,7 +96,7 @@ defmodule Bonny.Pluggable.LoggerTest do
       end)
 
     assert captured_log =~
-             ~s|{"default/foo", "example.com/v1", "Kind=Widget, Action=:add"} - Descendant {"default/bar", "example.com/v1", "Kind=Cog"} applied|
+             ~s|{"default/foo", "example.com/v1", "Kind=Widget, Action=:add"} - Applying descendant {"default/bar", "example.com/v1", "Kind=Cog"}|
   end
 
   test "logs when events are emitted", %{axn: axn} do
@@ -111,6 +111,6 @@ defmodule Bonny.Pluggable.LoggerTest do
       end)
 
     assert captured_log =~
-             ~s|{"default/foo", "example.com/v1", "Kind=Widget, Action=:add"} - Normal event emitted|
+             ~s|{"default/foo", "example.com/v1", "Kind=Widget, Action=:add"} - Emitting Normal event|
   end
 end