Add public Phoenix.json_library

chrismccord · chrismccord · commit 7be6a88d24e1 · 2018-02-09T13:49:29.000-05:00
Use json_library for plug parser config
Flatten iodata for less brittle tests
diff --git a/config/config.exs b/config/config.exs
@@ -5,3 +5,5 @@ config :logger, :console, colors: [enabled: false]
 
 # Use higher stacktrace depth.
 config :phoenix, :stacktrace_depth, 20
+
+config :phoenix, :json_library, Jason
diff --git a/installer/templates/phx_single/config/config.exs b/installer/templates/phx_single/config/config.exs
@@ -25,8 +25,7 @@ config :logger, :console,
   metadata: [:request_id]
 
 # Use Jason for JSON parsing in Phoenix<%= if ecto do %> and Ecto<% end %>
-config :phoenix, :format_encoders, json: Jason
-<%= if ecto do %>
+config :phoenix, :json_library, Jason<%= if ecto do %>
 config :ecto, :json_library, Jason
 <% end %>
 # Import environment specific config. This must remain at the bottom
diff --git a/installer/templates/phx_umbrella/apps/app_name/config/config.exs b/installer/templates/phx_umbrella/apps/app_name/config/config.exs
@@ -1,6 +1,6 @@
 use Mix.Config
 
-<%= if ecto do %>config :<%= app_name %>, ecto_repos: [<%= app_module %>.Repo]<% end %>
-<%= if ecto do %>config :ecto, :json_library, Jason<% end %>
+<%= if ecto do %>config :<%= app_name %>, ecto_repos: [<%= app_module %>.Repo]
+config :ecto, :json_library, Jason<% end %>
 
 import_config "#{Mix.env}.exs"
diff --git a/installer/templates/phx_umbrella/apps/app_name_web/config/config.exs b/installer/templates/phx_umbrella/apps/app_name_web/config/config.exs
@@ -20,7 +20,7 @@ config :<%= web_app_name %>, <%= endpoint_module %>,
            adapter: Phoenix.PubSub.PG2]
 
 # Use Jason for JSON parsing in Phoenix
-config :phoenix, :format_encoders, json: Jason
+config :phoenix, :json_library, Jason
 
 # Import environment specific config. This must remain at the bottom
 # of this file so it overrides the configuration defined above.
diff --git a/installer/templates/phx_web/endpoint.ex b/installer/templates/phx_web/endpoint.ex
@@ -25,7 +25,7 @@ defmodule <%= endpoint_module %> do
   plug Plug.Parsers,
     parsers: [:urlencoded, :multipart, :json],
     pass: ["*/*"],
-    json_decoder: Jason
+    json_decoder: Phoenix.json_library()
 
   plug Plug.MethodOverride
   plug Plug.Head
diff --git a/installer/test/phx_new_test.exs b/installer/test/phx_new_test.exs
@@ -32,7 +32,7 @@ defmodule Mix.Tasks.Phx.NewTest do
 
       assert_file "phx_blog/config/config.exs", fn file ->
         assert file =~ "ecto_repos: [PhxBlog.Repo]"
-        assert file =~ "config :phoenix, :format_encoders, json: Jason"
+        assert file =~ "config :phoenix, :json_library, Jason"
         assert file =~ "config :ecto, :json_library, Jason"
         refute file =~ "namespace: PhxBlog"
         refute file =~ "config :phx_blog, :generators"
diff --git a/installer/test/phx_new_umbrella_test.exs b/installer/test/phx_new_umbrella_test.exs
@@ -66,7 +66,7 @@ defmodule Mix.Tasks.Phx.New.UmbrellaTest do
         assert file =~ "ecto_repos: [PhxUmb.Repo]"
         assert file =~ ":phx_umb_web, PhxUmbWeb.Endpoint"
         assert file =~ "generators: [context_app: :phx_umb]\n"
-        assert file =~ "config :phoenix, :format_encoders, json: Jason"
+        assert file =~ "config :phoenix, :json_library, Jason"
       end
 
       assert_file web_path(@app, "config/prod.exs"), fn file ->
diff --git a/lib/phoenix.ex b/lib/phoenix.ex
@@ -55,12 +55,21 @@ defmodule Phoenix do
     Supervisor.start_link(children, strategy: :one_for_one, name: Phoenix.Supervisor)
   end
 
-  @doc false
-  # TODO remove Poison default in 2.0
-  def json do
-    :phoenix
-    |> Application.fetch_env!(:format_encoders)
-    |> Keyword.get(:json, Poison)
+  # TODO: swap Poison default with Jason in 2.0
+  # from there we can ditch explicit config for new projects
+  @doc """
+  Returns the configured JSON encoding library for Phoenix.
+
+  To customize the JSON library, including the following
+  in your `config/config.exs`:
+
+      config :phoenix, :json_library, Jason
+  """
+  def json_library do
+    case Application.fetch_env(:phoenix, :json_library) do
+      {:ok, module} -> module
+      :error -> Poison
+    end
   end
 
   defp warn_on_missing_format_encoders do
diff --git a/lib/phoenix/controller.ex b/lib/phoenix/controller.ex
@@ -266,7 +266,7 @@ defmodule Phoenix.Controller do
   @doc """
   Sends JSON response.
 
-  It uses the configured `:format_encoders` under the `:phoenix`
+  It uses the configured `:json_library` under the `:phoenix`
   application for `:json` to pick up the encoder module.
 
   ## Examples
@@ -276,7 +276,7 @@ defmodule Phoenix.Controller do
   """
   @spec json(Plug.Conn.t, term) :: Plug.Conn.t
   def json(conn, data) do
-    response = Phoenix.json().encode_to_iodata!(data)
+    response = Phoenix.json_library().encode_to_iodata!(data)
     send_resp(conn, conn.status || 200, "application/json", response)
   end
 
diff --git a/lib/phoenix/digester.ex b/lib/phoenix/digester.ex
@@ -65,7 +65,7 @@ defmodule Phoenix.Digester do
     if File.exists?(manifest_path) do
       manifest_path
       |> File.read!()
-      |> Phoenix.json().decode!()
+      |> Phoenix.json_library().decode!()
       |> migrate_manifest(output_path)
     else
       @empty_manifest
@@ -105,7 +105,7 @@ defmodule Phoenix.Digester do
   end
 
   defp save_manifest(%{"latest" => _, "version" => _, "digests" => _} = manifest, output_path) do
-    manifest_content = Phoenix.json().encode!(manifest)
+    manifest_content = Phoenix.json_library().encode!(manifest)
     File.write!(Path.join(output_path, "cache_manifest.json"), manifest_content)
   end
 
diff --git a/lib/phoenix/endpoint/supervisor.ex b/lib/phoenix/endpoint/supervisor.ex
@@ -319,7 +319,7 @@ defmodule Phoenix.Endpoint.Supervisor do
         manifest =
           outer
           |> File.read!()
-          |> Phoenix.json().decode!()
+          |> Phoenix.json_library().decode!()
 
         manifest["latest"]
       else
diff --git a/lib/phoenix/template.ex b/lib/phoenix/template.ex
@@ -93,8 +93,7 @@ defmodule Phoenix.Template do
   New encoders can be added via the format encoder option:
 
       config :phoenix, :format_encoders,
-        html: Phoenix.Template.HTML,
-        json: Jason
+        html: Phoenix.Template.HTML
 
   """
 
@@ -251,7 +250,7 @@ defmodule Phoenix.Template do
   end
 
   defp default_encoders do
-    [html: Phoenix.Template.HTML, json: Phoenix.json(), js: Phoenix.Template.HTML]
+    [html: Phoenix.Template.HTML, json: Phoenix.json_library(), js: Phoenix.Template.HTML]
   end
 
   @doc """
diff --git a/lib/phoenix/test/conn_test.ex b/lib/phoenix/test/conn_test.ex
@@ -408,7 +408,7 @@ defmodule Phoenix.ConnTest do
     body = response(conn, status)
     _    = response_content_type(conn, :json)
 
-    Phoenix.json().decode!(body)
+    Phoenix.json_library().decode!(body)
   end
 
   @doc """
diff --git a/lib/phoenix/transports/long_poll_serializer.ex b/lib/phoenix/transports/long_poll_serializer.ex
@@ -54,7 +54,7 @@ defmodule Phoenix.Transports.LongPollSerializer do
   """
   def decode!(message, _opts) do
     message
-    |> Phoenix.json().decode!()
+    |> Phoenix.json_library().decode!()
     |> Phoenix.Socket.Message.from_map!()
   end
 end
diff --git a/lib/phoenix/transports/v2/longpoll_serializer.ex b/lib/phoenix/transports/v2/longpoll_serializer.ex
@@ -12,7 +12,7 @@ defmodule Phoenix.Transports.V2.LongPollSerializer do
     encoded =
       %Message{topic: msg.topic, event: msg.event, payload: msg.payload}
       |> to_list()
-      |> Phoenix.json().encode_to_iodata!()
+      |> Phoenix.json_library().encode_to_iodata!()
 
     {:socket_push, :text, encoded}
   end
@@ -23,7 +23,7 @@ defmodule Phoenix.Transports.V2.LongPollSerializer do
   Encoding is handled downstream in the LongPoll controller.
   """
   def encode!(msg) do
-    {:socket_push, :text, msg |> to_list() |> Phoenix.json().encode_to_iodata!()}
+    {:socket_push, :text, msg |> to_list() |> Phoenix.json_library().encode_to_iodata!()}
   end
   defp to_list(%Reply{} = reply) do
     [reply.join_ref, reply.ref, reply.topic, "phx_reply",
@@ -37,7 +37,7 @@ defmodule Phoenix.Transports.V2.LongPollSerializer do
   Decodes JSON String into `Phoenix.Socket.Message` struct.
   """
   def decode!(raw_message, _opts) do
-    [join_ref, ref, topic, event, payload | _] = Phoenix.json().decode!(raw_message)
+    [join_ref, ref, topic, event, payload | _] = Phoenix.json_library().decode!(raw_message)
 
     %Phoenix.Socket.Message{
       topic: topic,
diff --git a/lib/phoenix/transports/v2/websocket_serializer.ex b/lib/phoenix/transports/v2/websocket_serializer.ex
@@ -9,7 +9,7 @@ defmodule Phoenix.Transports.V2.WebSocketSerializer do
   Translates a `Phoenix.Socket.Broadcast` into a `Phoenix.Socket.Message`.
   """
   def fastlane!(%Broadcast{} = msg) do
-    data = Phoenix.json().encode_to_iodata!([nil, nil, msg.topic, msg.event, msg.payload])
+    data = Phoenix.json_library().encode_to_iodata!([nil, nil, msg.topic, msg.event, msg.payload])
     {:socket_push, :text, data}
   end
 
@@ -19,19 +19,19 @@ defmodule Phoenix.Transports.V2.WebSocketSerializer do
   def encode!(%Reply{} = reply) do
     data = [reply.join_ref, reply.ref, reply.topic, "phx_reply",
             %{status: reply.status, response: reply.payload}]
-    {:socket_push, :text, Phoenix.json().encode_to_iodata!(data)}
+    {:socket_push, :text, Phoenix.json_library().encode_to_iodata!(data)}
   end
 
   def encode!(%Message{} = msg) do
     data = [msg.join_ref, msg.ref, msg.topic, msg.event, msg.payload]
-    {:socket_push, :text, Phoenix.json().encode_to_iodata!(data)}
+    {:socket_push, :text, Phoenix.json_library().encode_to_iodata!(data)}
   end
 
   @doc """
   Decodes JSON String into `Phoenix.Socket.Message` struct.
   """
   def decode!(raw_message, _opts) do
-    [join_ref, ref, topic, event, payload | _] = Phoenix.json().decode!(raw_message)
+    [join_ref, ref, topic, event, payload | _] = Phoenix.json_library().decode!(raw_message)
 
     %Phoenix.Socket.Message{
       topic: topic,
diff --git a/lib/phoenix/transports/websocket_serializer.ex b/lib/phoenix/transports/websocket_serializer.ex
@@ -38,13 +38,13 @@ defmodule Phoenix.Transports.WebSocketSerializer do
   """
   def decode!(message, _opts) do
     message
-    |> Phoenix.json().decode!()
+    |> Phoenix.json_library().decode!()
     |> Phoenix.Socket.Message.from_map!()
   end
 
   defp encode_v1_fields_only(%Message{} = msg) do
     msg
     |> Map.take([:topic, :event, :payload, :ref])
-    |> Phoenix.json().encode_to_iodata!()
+    |> Phoenix.json_library().encode_to_iodata!()
   end
 end
diff --git a/priv/templates/phx.gen.json/controller_test.exs b/priv/templates/phx.gen.json/controller_test.exs
@@ -32,7 +32,7 @@ defmodule <%= inspect context.web_module %>.<%= inspect Module.concat(schema.web
       conn = get conn, Routes.<%= schema.route_helper %>_path(conn, :show, id)
       assert json_response(conn, 200)["data"] == %{
         "id" => id<%= for {key, val} <- schema.params.create do %>,
-        "<%= key %>" => <%= Phoenix.json().encode!(val) %><% end %>}
+        "<%= key %>" => <%= Phoenix.json_library().encode!(val) %><% end %>}
     end
 
     test "renders errors when data is invalid", %{conn: conn} do
@@ -51,7 +51,7 @@ defmodule <%= inspect context.web_module %>.<%= inspect Module.concat(schema.web
       conn = get conn, Routes.<%= schema.route_helper %>_path(conn, :show, id)
       assert json_response(conn, 200)["data"] == %{
         "id" => id<%= for {key, val} <- schema.params.update do %>,
-        "<%= key %>" => <%= Phoenix.json().encode!(val) %><% end %>}
+        "<%= key %>" => <%= Phoenix.json_library().encode!(val) %><% end %>}
     end
 
     test "renders errors when data is invalid", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
diff --git a/test/phoenix/digester_test.exs b/test/phoenix/digester_test.exs
@@ -35,7 +35,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(@output_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
 
       assert json["latest"]["phoenix.png"] =~ ~r"phoenix-#{@hash_regex}.png"
       assert json["version"] == 1
@@ -56,7 +56,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(@output_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
 
       # Keep old entries
       assert json["digests"]["foo-d978852bea6530fcd197b5445ed008fd.css"]["logical_path"] == "foo.css"
@@ -87,7 +87,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(@output_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
 
       assert json["digests"]["foo-d978852bea6530fcd197b5445ed008fd.css"]["mtime"] == 32132171
       assert_in_delta json["digests"]["foo-1198fd3c7ecf0e8f4a33a6e4fc5ae168.css"]["mtime"], now(), 2
@@ -104,7 +104,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(input_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
 
       assert json["digests"] == %{}
     end
@@ -124,7 +124,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(@output_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
       assert json["latest"]["static/phoenix.png"] =~ ~r"static/phoenix-#{@hash_regex}\.png"
     end
 
@@ -145,7 +145,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(@output_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
 
       assert Enum.count(json["digests"]) == 2
     end
@@ -356,7 +356,7 @@ defmodule Phoenix.DigesterTest do
       json =
         Path.join(@output_path, "cache_manifest.json")
         |> File.read!()
-        |> Phoenix.json().decode!()
+        |> Phoenix.json_library().decode!()
 
       refute json["digests"]["app-1.css"]
     end
diff --git a/test/phoenix/integration/endpoint_test.exs b/test/phoenix/integration/endpoint_test.exs
@@ -120,7 +120,7 @@ defmodule Phoenix.Integration.EndpointTest do
 
       {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@prod}/unknown?_format=json", %{})
       assert resp.status == 404
-      assert resp.body |> Phoenix.json().decode!() == %{"error" => "Got 404 from error with GET"}
+      assert resp.body |> Phoenix.json_library().decode!() == %{"error" => "Got 404 from error with GET"}
 
       assert capture_log(fn ->
         {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@prod}/oops", %{})
diff --git a/test/phoenix/integration/long_poll_test.exs b/test/phoenix/integration/long_poll_test.exs
@@ -151,11 +151,11 @@ defmodule Phoenix.Integration.LongPollTest do
   end
   defp decode_body(_vsn, %{body: ""} = resp), do: resp
   defp decode_body("1." <> _, %{} = resp) do
-    put_in(resp, [:body], Phoenix.json().decode!(resp.body))
+    put_in(resp, [:body], Phoenix.json_library().decode!(resp.body))
   end
   defp decode_body("2." <> _, %{} = resp) do
     resp
-    |> put_in([:body], Phoenix.json().decode!(resp.body))
+    |> put_in([:body], Phoenix.json_library().decode!(resp.body))
     |> update_in([:body, "messages"], fn
       nil -> []
       messages ->
@@ -167,19 +167,19 @@ defmodule Phoenix.Integration.LongPollTest do
     end)
   end
   defp decode_body(_invalid, %{} = resp) do
-    put_in(resp, [:body], Phoenix.json().decode!(resp.body))
+    put_in(resp, [:body], Phoenix.json_library().decode!(resp.body))
   end
   def stringify(struct) do
     struct
     |> Map.from_struct()
-    |> Phoenix.json().encode!()
-    |> Phoenix.json().decode!()
+    |> Phoenix.json_library().encode!()
+    |> Phoenix.json_library().decode!()
   end
 
   defp encode(_vsn, nil), do: ""
-  defp encode("1." <> _ = _vsn, map), do: Phoenix.json().encode!(map)
+  defp encode("1." <> _ = _vsn, map), do: Phoenix.json_library().encode!(map)
   defp encode("2." <> _ = _vsn, map) do
-    Phoenix.json().encode!(
+    Phoenix.json_library().encode!(
       [map["join_ref"], map["ref"], map["topic"], map["event"], map["payload"]])
   end
   defp encode(_, map), do: encode("1.0.0", map)
diff --git a/test/phoenix/test/conn_test.exs b/test/phoenix/test/conn_test.exs
@@ -107,7 +107,7 @@ defmodule Phoenix.Test.ConnTest do
       build_conn()
       |> put_req_header("content-type", "application/json")
       |> post(:hello, "[1, 2, 3]")
-      |> Plug.Parsers.call(Plug.Parsers.init(parsers: [:json], json_decoder: Jason))
+      |> Plug.Parsers.call(Plug.Parsers.init(parsers: [:json], json_decoder: Phoenix.json_library()))
 
     assert conn.method == "POST"
     assert conn.path_info == []
diff --git a/test/phoenix/transports/long_poll_serializer_test.exs b/test/phoenix/transports/long_poll_serializer_test.exs
@@ -35,13 +35,13 @@ defmodule Phoenix.Tranports.LongPollSerializerTest do
     test "fastlane!/1 translates `Phoenix.Socket.Broadcast` into 'Phoenix.Socket.Message'" do
       broadcast = %Broadcast{topic: "t", event: "e", payload: "m"}
       assert V2.LongPollSerializer.fastlane!(broadcast) ==
-        {:socket_push, :text, Phoenix.json().encode_to_iodata!([nil, nil, "t", "e", "m"])}
+        {:socket_push, :text, Phoenix.json_library().encode_to_iodata!([nil, nil, "t", "e", "m"])}
     end
 
     test "encode!/1 encodes `Phoenix.Socket.Message` as JSON" do
       reply = %Reply{join_ref: "join", topic: "t", payload: "m", ref: "foo", status: "bar"}
       assert V2.LongPollSerializer.encode!(reply) ==
-        {:socket_push, :text, Phoenix.json().encode_to_iodata!(["join", "foo", "t", "phx_reply", %{response: "m", status: "bar"}])}
+        {:socket_push, :text, Phoenix.json_library().encode_to_iodata!(["join", "foo", "t", "phx_reply", %{response: "m", status: "bar"}])}
     end
 
     test "decode!/2 decodes `Phoenix.Socket.Message` from JSON" do
diff --git a/test/phoenix/transports/websocket_serializer_test.exs b/test/phoenix/transports/websocket_serializer_test.exs
diff --git a/test/test_helper.exs b/test/test_helper.exs
