convert formatter_opts to a map

Nebo15 · Jun 21, 2022 · fe26628 · fe26628
1 parent a07bf0b
commit fe26628
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 18 deletions.
diff --git a/lib/logger_json.ex b/lib/logger_json.ex
@@ -62,7 +62,7 @@ defmodule LoggerJSON do
             json_encoder: nil,
             on_init: nil,
             formatter: nil,
-            formatter_state: []
+            formatter_state: %{}
 
   @doc """
   Configures Logger log level at runtime by using value from environment variable.
@@ -204,7 +204,7 @@ defmodule LoggerJSON do
       |> Keyword.get(:metadata, [])
       |> configure_metadata()
 
-    formatter_opts = Keyword.get(config, :formatter_opts, [])
+    formatter_opts = Keyword.get(config, :formatter_opts, %{})
     formatter_state = apply(formatter, :init, [formatter_opts])
 
     %{

diff --git a/lib/logger_json/formatter.ex b/lib/logger_json/formatter.ex
@@ -24,6 +24,6 @@ defmodule LoggerJSON.Formatter do
               ts :: Logger.Formatter.time(),
               md :: [atom] | :all,
               state :: map,
-              formatter_state :: Keyword.t()
+              formatter_state :: map
             ) :: map | iodata() | %Jason.Fragment{}
 end
diff --git a/lib/logger_json/formatters/datadog_logger.ex b/lib/logger_json/formatters/datadog_logger.ex
@@ -28,17 +28,17 @@ defmodule LoggerJSON.Formatters.DatadogLogger do
 
   @behaviour LoggerJSON.Formatter
 
-  @default_opts [hostname: :system]
+  @default_opts %{hostname: :system}
   @processed_metadata_keys ~w[pid file line function module application span_id trace_id]a
 
   @impl true
-  def init(formatter_opts \\ []) do
-    opts = Keyword.merge(@default_opts, formatter_opts)
+  def init(formatter_opts \\ %{}) do
+    opts = Map.merge(@default_opts, formatter_opts)
 
-    unless is_binary(opts[:hostname]) or opts[:hostname] in [:system, :unset] do
+    unless is_binary(opts.hostname) or opts.hostname in [:system, :unset] do
       raise ArgumentError,
             "invalid :hostname option for :formatter_opts logger_json backend. " <>
-              "Expected :system, :unset, or string, " <> "got: #{inspect(opts[:hostname])}"
+              "Expected :system, :unset, or string, " <> "got: #{inspect(opts.hostname)}"
     end
 
     opts
@@ -56,7 +56,7 @@ defmodule LoggerJSON.Formatters.DatadogLogger do
             line: Keyword.get(md, :line)
           ),
         message: IO.chardata_to_string(msg),
-        syslog: syslog(level, ts, formatter_state[:hostname])
+        syslog: syslog(level, ts, formatter_state.hostname)
       },
       format_metadata(md, md_keys)
     )

diff --git a/test/unit/logger_json/ecto_test.exs b/test/unit/logger_json/ecto_test.exs
@@ -13,7 +13,7 @@ defmodule LoggerJSON.EctoTest do
         json_encoder: Jason,
         on_init: :disabled,
         formatter: LoggerJSON.Formatters.GoogleCloudLogger,
-        formatter_state: []
+        formatter_state: %{}
       )
 
     diff = :erlang.convert_time_unit(1, :microsecond, :native)

diff --git a/test/unit/logger_json/plug_test.exs b/test/unit/logger_json/plug_test.exs
@@ -25,7 +25,7 @@ defmodule LoggerJSON.PlugTest do
         json_encoder: Jason,
         on_init: :disabled,
         formatter: LoggerJSON.Formatters.GoogleCloudLogger,
-        formatter_state: []
+        formatter_state: %{}
       )
   end
 

diff --git a/test/unit/logger_json_basic_test.exs b/test/unit/logger_json_basic_test.exs
@@ -15,7 +15,7 @@ defmodule LoggerJSONBasicTest do
         json_encoder: Jason,
         on_init: :disabled,
         formatter: BasicLogger,
-        formatter_state: []
+        formatter_state: %{}
       )
   end
 

diff --git a/test/unit/logger_json_datadog_test.exs b/test/unit/logger_json_datadog_test.exs
@@ -16,7 +16,7 @@ defmodule LoggerJSONDatadogTest do
         json_encoder: Jason,
         on_init: :disabled,
         formatter: DatadogLogger,
-        formatter_state: []
+        formatter_state: %{}
       )
 
     :ok = Logger.reset_metadata([])
@@ -282,7 +282,7 @@ defmodule LoggerJSONDatadogTest do
   end
 
   test "logs hostname when set to :system" do
-    Logger.configure_backend(LoggerJSON, formatter_opts: [hostname: :system])
+    Logger.configure_backend(LoggerJSON, formatter_opts: %{hostname: :system})
     {:ok, hostname} = :inet.gethostname()
 
     log =
@@ -294,7 +294,7 @@ defmodule LoggerJSONDatadogTest do
   end
 
   test "does not log hostname when set to :unset" do
-    Logger.configure_backend(LoggerJSON, formatter_opts: [hostname: :unset])
+    Logger.configure_backend(LoggerJSON, formatter_opts: %{hostname: :unset})
 
     log =
       fn -> Logger.debug("hello") end
@@ -305,7 +305,7 @@ defmodule LoggerJSONDatadogTest do
   end
 
   test "logs hostname when set to string" do
-    Logger.configure_backend(LoggerJSON, formatter_opts: [hostname: "testing"])
+    Logger.configure_backend(LoggerJSON, formatter_opts: %{hostname: "testing"})
 
     log =
       fn -> Logger.debug("hello") end

diff --git a/test/unit/logger_json_google_error_reporter_test.exs b/test/unit/logger_json_google_error_reporter_test.exs
@@ -13,7 +13,7 @@ defmodule LoggerJSONGoogleErrorReporterTest do
         json_encoder: Jason,
         on_init: :disabled,
         formatter: GoogleCloudLogger,
-        formatter_state: []
+        formatter_state: %{}
       )
 
     :ok = Logger.reset_metadata([])

diff --git a/test/unit/logger_json_google_test.exs b/test/unit/logger_json_google_test.exs
@@ -16,7 +16,7 @@ defmodule LoggerJSONGoogleTest do
         json_encoder: Jason,
         on_init: :disabled,
         formatter: GoogleCloudLogger,
-        formatter_state: []
+        formatter_state: %{}
       )
 
     :ok = Logger.reset_metadata([])