configurable JSON libraries

Author: mitchellhenke

.travis.yml

@@ -19,7 +19,7 @@ notifications:
 script:
   - if [ "$STRICT" = "true" ]; then mix compile --warnings-as-errors; fi
   - mix test
-  - mix credo
+  - MIX_ENV=test mix credo
   - if [ "$STRICT" = "true" ]; then travis_wait mix dialyzer; fi
   - if [ "$STRICT" = "true" ]; then mix format --dry-run --check-formatted; fi
 cache:

CHANGELOG.md

@@ -5,7 +5,7 @@
 ## 7.0.0 (2018-09-05)
 
 * Enhancements
-  * Replace Poison with Jason
+  * Replace Poison with configurable JSON library
   * Implement `Sentry.LoggerBackend`
 
 * Breaking Changes

README.md

@@ -17,13 +17,14 @@ If you would like to upgrade a project to use Sentry 7.x, see [here](https://gis
 
 ## Installation
 
-To use Sentry with your projects, edit your mix.exs file and add it as a dependency:
+To use Sentry with your projects, edit your mix.exs file and add it as a dependency.  Sentry defaults to trying to use Jason for JSON operations, but can be configured to use other ones.
 
 ```elixir
 defp deps do
   [
     # ...
     {:sentry, "~> 7.0"},
+    {:jason, "~> 1.1"},
   ]
 end
 ```
@@ -116,6 +117,7 @@ For optional settings check the [docs](https://hexdocs.pm/sentry/readme.html).
 | `source_code_exclude_patterns` | False  | `[~r"/_build/", ~r"/deps/", ~r"/priv/"]` | |
 | `source_code_path_pattern` | False  | `"**/*.ex"` | |
 | `filter` | False | | Module where the filter rules are defined (see [Filtering Exceptions](https://hexdocs.pm/sentry/Sentry.html#module-filtering-exceptions)) |
+| `json_library` | False | `Jason` | |
 
 An example production config might look like this:
 

lib/sentry.ex

@@ -103,8 +103,9 @@ defmodule Sentry do
       )
     ]
 
-    opts = [strategy: :one_for_one, name: Sentry.Supervisor]
+    validate_json_config!()
 
+    opts = [strategy: :one_for_one, name: Sentry.Supervisor]
     Supervisor.start_link(children, opts)
   end
 
@@ -164,4 +165,31 @@ defmodule Sentry do
       :ignored
     end
   end
+
+  defp validate_json_config!() do
+    case Config.json_library() do
+      nil ->
+        raise ArgumentError.exception("nil is not a valid :json_library configuration")
+
+      library ->
+        try do
+          with {:ok, %{}} <- library.decode("{}"),
+               {:ok, "{}"} <- library.encode(%{}) do
+            :ok
+          else
+            _ ->
+              raise ArgumentError.exception(
+                      "configured :json_library #{inspect(library)} does not implement decode/1 and encode/1"
+                    )
+          end
+        rescue
+          UndefinedFunctionError ->
+            reraise ArgumentError.exception("""
+                    configured :json_library #{inspect(library)} is not available or does not implement decode/1 and encode/1.
+                    Do you need to add #{inspect(library)} to your mix.exs?
+                    """),
+                    __STACKTRACE__
+        end
+    end
+  end
 end

lib/sentry/client.ex

@@ -74,8 +74,10 @@ defmodule Sentry.Client do
   end
 
   defp encode_and_send(event, result) do
+    json_library = Config.json_library()
+
     render_event(event)
-    |> Jason.encode()
+    |> json_library.encode()
     |> case do
       {:ok, body} ->
         do_send_event(event, body, result)
@@ -158,13 +160,15 @@ defmodule Sentry.Client do
   @spec request(String.t(), list({String.t(), String.t()}), String.t()) ::
           {:ok, String.t()} | {:error, term()}
   def request(url, headers, body) do
+    json_library = Config.json_library()
+
     hackney_opts =
       Config.hackney_opts()
       |> Keyword.put_new(:pool, @hackney_pool_name)
 
     with {:ok, 200, _, client} <- :hackney.request(:post, url, headers, body, hackney_opts),
          {:ok, body} <- :hackney.body(client),
-         {:ok, json} <- Jason.decode(body) do
+         {:ok, json} <- json_library.decode(body) do
       {:ok, Map.get(json, "id")}
     else
       {:ok, status, headers, client} ->

lib/sentry/config.ex

@@ -123,6 +123,10 @@ defmodule Sentry.Config do
     get_config(:report_deps, default: true, check_dsn: false)
   end
 
+  def json_library do
+    get_config(:json_library, default: Jason, check_dsn: false)
+  end
+
   defp get_config(key, opts \\ []) when is_atom(key) do
     default = Keyword.get(opts, :default)
     check_dsn = Keyword.get(opts, :check_dsn, true)

lib/sentry/plug.ex

@@ -1,6 +1,8 @@
 if Code.ensure_loaded?(Plug) do
-  require Protocol
-  Protocol.derive(Jason.Encoder, Plug.Upload)
+  if Code.ensure_loaded?(Jason) do
+    require Protocol
+    Protocol.derive(Jason.Encoder, Plug.Upload)
+  end
 
   defmodule Sentry.Plug do
     @default_scrubbed_param_keys ["password", "passwd", "secret"]

mix.exs

@@ -25,12 +25,12 @@ defmodule Sentry.Mixfile do
   defp deps do
     [
       {:hackney, "~> 1.8 or 1.6.5"},
-      {:jason, "~> 1.1"},
+      {:jason, "~> 1.1", only: [:test]},
       {:plug, "~> 1.6", optional: true},
       {:phoenix, "~> 1.3", optional: true},
       {:dialyxir, "> 0.0.0", only: [:dev], runtime: false},
       {:ex_doc, "~> 0.19.0", only: :dev},
-      {:credo, "~> 0.10.0", only: [:dev, :test], runtime: false},
+      {:credo, "~> 0.10.0", only: [:test], runtime: false},
       {:bypass, "~> 0.8.0", only: [:test]}
     ]
   end