controller, router: Add content-type headers to embedded resposes (#35)

Fixes #29

Author: magnetised

lib/phoenix/sync/electric.ex

@@ -568,11 +568,13 @@ if Code.ensure_loaded?(Electric.Shapes.Api) do
       case Shapes.Api.validate(api, params) do
         {:ok, request} ->
           conn
+          |> content_type()
           |> Plug.Conn.assign(:request, request)
           |> Shapes.Api.serve_shape_log(request)
 
         {:error, response} ->
           conn
+          |> content_type()
           |> Shapes.Api.Response.send(response)
           |> Plug.Conn.halt()
       end
@@ -582,11 +584,13 @@ if Code.ensure_loaded?(Electric.Shapes.Api) do
       case Shapes.Api.validate_for_delete(api, params) do
         {:ok, request} ->
           conn
+          |> content_type()
           |> Plug.Conn.assign(:request, request)
           |> Shapes.Api.delete_shape(request)
 
         {:error, response} ->
           conn
+          |> content_type()
           |> Shapes.Api.Response.send(response)
           |> Plug.Conn.halt()
       end
@@ -595,5 +599,9 @@ if Code.ensure_loaded?(Electric.Shapes.Api) do
     def call(_api, %{method: "OPTIONS"} = conn, _params) do
       Shapes.Api.options(conn)
     end
+
+    defp content_type(conn) do
+      Plug.Conn.put_resp_content_type(conn, "application/json")
+    end
   end
 end

test/phoenix/sync/client_test.exs

@@ -4,12 +4,14 @@ defmodule Phoenix.Sync.ClientTest do
     parameterize: [
       %{
         sync_config: [
+          env: :test,
           mode: :embedded,
           pool_opts: [backoff_type: :stop, max_restarts: 0, pool_size: 2]
         ]
       },
       %{
         sync_config: [
+          env: :test,
           mode: :http,
           url: "http://localhost:3000",
           pool_opts: [backoff_type: :stop, max_restarts: 0, pool_size: 2]

test/phoenix/sync/controller_test.exs

@@ -4,13 +4,15 @@ defmodule Phoenix.Sync.ControllerTest do
     parameterize: [
       %{
         sync_config: [
+          env: :test,
           mode: :embedded,
           pool_opts: [backoff_type: :stop, max_restarts: 0, pool_size: 2]
         ]
       },
       %{
         sync_config: [
           mode: :http,
+          env: :test,
           url: "http://localhost:3000",
           pool_opts: [backoff_type: :stop, max_restarts: 0, pool_size: 2]
         ]
@@ -156,8 +158,7 @@ defmodule Phoenix.Sync.ControllerTest do
 
   describe "plug: sync_render/3" do
     setup(ctx) do
-      opts = Phoenix.Sync.plug_opts(electric_opts(ctx))
-      [plug_opts: [phoenix_sync: opts]]
+      [plug_opts: [phoenix_sync: Phoenix.Sync.plug_opts(ctx.electric_opts)]]
     end
 
     test "returns the sync events", ctx do
@@ -174,5 +175,15 @@ defmodule Phoenix.Sync.ControllerTest do
                %{"headers" => %{"operation" => "insert"}, "value" => %{"title" => "three"}}
              ] = Jason.decode!(resp.resp_body)
     end
+
+    test "includes content-type header", ctx do
+      conn = conn(:get, "/shape/todos", %{"offset" => "-1"})
+
+      resp = PlugRouter.call(conn, PlugRouter.init(ctx.plug_opts))
+
+      assert Plug.Conn.get_resp_header(resp, "content-type") == [
+               "application/json; charset=utf-8"
+             ]
+    end
   end
 end

test/phoenix/sync/electric_test.exs

@@ -4,12 +4,14 @@ defmodule Phoenix.Sync.ElectricTest do
     parameterize: [
       %{
         sync_config: [
+          env: :test,
           mode: :embedded,
           pool_opts: [backoff_type: :stop, max_restarts: 0, pool_size: 2]
         ]
       },
       %{
         sync_config: [
+          env: :test,
           mode: :http,
           url: "http://localhost:3000",
           pool_opts: [backoff_type: :stop, max_restarts: 0, pool_size: 2]

test/phoenix/sync/router_test.exs

@@ -6,12 +6,14 @@ defmodule Phoenix.Sync.RouterTest do
     parameterize: [
       %{
         sync_config: [
+          env: :test,
           mode: :embedded,
           pool_opts: @pool_opts
         ]
       },
       %{
         sync_config: [
+          env: :test,
           mode: :http,
           url: "http://localhost:3000",
           pool_opts: @pool_opts
@@ -135,6 +137,29 @@ defmodule Phoenix.Sync.RouterTest do
              ] = Jason.decode!(resp.resp_body)
     end
 
+    @tag table: {
+           "todos",
+           [
+             "id int8 not null primary key generated always as identity",
+             "title text",
+             "completed boolean default false"
+           ]
+         }
+    @tag data: {"todos", ["title"], [["one"], ["two"], ["three"]]}
+
+    test "returns a correct content-type header", _ctx do
+      resp =
+        Phoenix.ConnTest.build_conn()
+        |> Phoenix.ConnTest.get("/sync/things-to-do", %{offset: "-1"})
+
+      assert resp.status == 200
+      assert Plug.Conn.get_resp_header(resp, "electric-offset") == ["0_0"]
+
+      assert Plug.Conn.get_resp_header(resp, "content-type") == [
+               "application/json; charset=utf-8"
+             ]
+    end
+
     @tag table: {
            "ideas",
            [
@@ -362,9 +387,7 @@ defmodule Phoenix.Sync.RouterTest do
     end
 
     setup(ctx) do
-      opts = Phoenix.Sync.plug_opts(electric_opts(ctx))
-
-      [plug_opts: [phoenix_sync: opts]]
+      [plug_opts: [phoenix_sync: Phoenix.Sync.plug_opts(ctx.electric_opts)]]
     end
 
     test "raises compile-time error if Plug.Router is not configured to copy_opts_to_assign" do

test/support/electric_helpers.ex

@@ -133,7 +133,7 @@ defmodule Support.ElectricHelpers do
   end
 
   def start_embedded(%{stack_config: stack_config, sync_config: sync_config} = ctx) do
-    config = Keyword.merge(sync_config, Enum.to_list(stack_config))
+    config = Keyword.merge(Enum.to_list(stack_config), sync_config)
 
     {:ok, children} = Phoenix.Sync.Application.children(config)
 
@@ -152,7 +152,11 @@ defmodule Support.ElectricHelpers do
     if endpoint == @endpoint && ctx.async,
       do: raise(RuntimeError, message: "do not use configure_endpoint in async tests")
 
-    Phoenix.Config.put(endpoint, :phoenix_sync, Phoenix.Sync.Application.plug_opts(electric_opts))
+    Phoenix.Config.put(
+      endpoint,
+      :phoenix_sync,
+      Phoenix.Sync.Application.plug_opts(electric_opts)
+    )
 
     [endpoint: endpoint]
   end