Convert charlists in metadata to strings (#646)

Closes #645.

Author: whatyouhide

lib/sentry/logger_utils.ex

@@ -51,6 +51,29 @@ defmodule Sentry.LoggerUtils do
     nil
   end
 
-  defp logger_metadata(meta, :all), do: Map.new(meta)
-  defp logger_metadata(meta, allowed_meta), do: meta |> Map.new() |> Map.take(allowed_meta)
+  defp logger_metadata(meta, allowed_meta) do
+    meta = Map.new(meta)
+
+    # Filter allowed meta.
+    meta =
+      case allowed_meta do
+        :all -> meta
+        allowed_meta -> Map.take(meta, allowed_meta)
+      end
+
+    # Potentially convert to iodata.
+    :maps.map(fn _key, val -> attempt_to_convert_iodata(val) end, meta)
+  end
+
+  defp attempt_to_convert_iodata(list) when is_list(list) do
+    IO.chardata_to_string(list)
+  rescue
+    _exception -> list
+  else
+    str -> if String.printable?(str), do: str, else: list
+  end
+
+  defp attempt_to_convert_iodata(other) do
+    other
+  end
 end

test/logger_backend_test.exs

@@ -150,7 +150,9 @@ defmodule Sentry.LoggerBackendTest do
   end
 
   test "includes Logger metadata for keys configured to be included" do
-    Logger.configure_backend(Sentry.LoggerBackend, metadata: [:string, :number, :map, :list])
+    Logger.configure_backend(Sentry.LoggerBackend,
+      metadata: [:string, :number, :map, :list, :chardata]
+    )
 
     ref = register_before_send()
 
@@ -161,6 +163,7 @@ defmodule Sentry.LoggerBackendTest do
       Logger.metadata(number: 43)
       Logger.metadata(map: %{a: "b"})
       Logger.metadata(list: [1, 2, 3])
+      Logger.metadata(chardata: ["π's unicode is", ?\s, [?π]])
       {:noreply, state}
     end)
 
@@ -171,6 +174,7 @@ defmodule Sentry.LoggerBackendTest do
     assert event.extra.logger_metadata.map == %{a: "b"}
     assert event.extra.logger_metadata.list == [1, 2, 3]
     assert event.extra.logger_metadata.number == 43
+    assert event.extra.logger_metadata.chardata == "π's unicode is π"
   end
 
   test "does not include Logger metadata when disabled" do

test/sentry/logger_handler_test.exs

@@ -172,15 +172,16 @@ defmodule Sentry.LoggerHandlerTest do
       end
     end
 
-    @tag handler_config: %{metadata: [:string, :number, :map, :list]}
+    @tag handler_config: %{metadata: [:string, :number, :map, :list, :chardata]}
     test "includes Logger metadata for keys configured to be included",
          %{sender_ref: ref, test_genserver: test_genserver} do
       run_and_catch_exit(test_genserver, fn ->
         Logger.metadata(
           string: "string",
           number: 43,
           map: %{a: "b"},
-          list: [1, 2, 3]
+          list: [1, 2, 3],
+          chardata: ["π's unicode is", ?\s, [?π]]
         )
 
         invalid_function()
@@ -191,6 +192,7 @@ defmodule Sentry.LoggerHandlerTest do
       assert event.extra.logger_metadata.map == %{a: "b"}
       assert event.extra.logger_metadata.list == [1, 2, 3]
       assert event.extra.logger_metadata.number == 43
+      assert event.extra.logger_metadata.chardata == "π's unicode is π"
     end
 
     @tag handler_config: %{metadata: []}