Merge pull request #323 from nimblehq/feature/revisit-error-view

Convert from ErrorView to new ErrorJSON view

Author: andyduong1920

lib/nimble_template/addons/variants/phoenix/api/error_json.ex

@@ -0,0 +1,44 @@
+defmodule NimbleTemplate.Addons.Phoenix.Api.ErrorJSON do
+  @moduledoc false
+
+  use NimbleTemplate.Addons.Addon
+
+  @impl true
+  def do_apply!(%Project{} = project, _opts) do
+    project
+    |> delete_files!()
+    |> copy_files!()
+  end
+
+  defp delete_files!(%Project{web_path: web_path, web_test_path: web_test_path} = project) do
+    File.rm!("#{web_path}/controllers/error_json.ex")
+    File.rm!("#{web_test_path}/controllers/error_json_test.exs")
+
+    project
+  end
+
+  defp copy_files!(
+         %Project{
+           base_module: base_module,
+           web_module: web_module,
+           web_path: web_path,
+           web_test_path: web_test_path
+         } = project
+       ) do
+    binding = [
+      web_module: web_module,
+      base_module: base_module
+    ]
+
+    files = [
+      {:eex, "lib/otp_app_web/controllers/error_json.ex.eex",
+       "#{web_path}/controllers/error_json.ex"},
+      {:eex, "test/otp_app_web/controllers/error_json_test.exs.eex",
+       "#{web_test_path}/controllers/error_json_test.exs"}
+    ]
+
+    Generator.copy_file!(files, binding)
+
+    project
+  end
+end

lib/nimble_template/addons/variants/phoenix/api/error_view.ex

@@ -61,7 +61,7 @@ defmodule NimbleTemplate.CredoHelper do
          web_test_path: web_test_path
        }) do
     [
-      "#{web_test_path}/views/api/error_view_test.exs",
+      "#{web_test_path}/controllers/error_json_test.exs",
       "#{web_test_path}/params/params_validator_test.exs"
     ]
   end

lib/nimble_template/helpers/credo.ex

@@ -13,7 +13,7 @@ defmodule NimbleTemplate.Templates.Phoenix.Api.Template do
     |> Api.Config.apply!()
     |> Api.EmptyBodyParamsPlug.apply!()
     |> Api.ParamsValidation.apply!()
-    |> Api.ErrorView.apply!()
+    |> Api.ErrorJSON.apply!()
     |> Api.JsonApi.apply!()
     |> Api.FallbackController.apply!()
   end

lib/nimble_template/templates/variants/phoenix/api/template.ex

@@ -8,7 +8,6 @@
     "lib/<%= otp_app %>_web/endpoint.ex",
     "lib/<%= otp_app %>_web/telemetry.ex",
     "lib/<%= otp_app %>_web/channels/user_socket.ex",
-    "lib/<%= otp_app %>_web/views/error_helpers.ex",
     "lib/<%= otp_app %>_web/controllers/api/fallback_controller.ex",
     "lib/<%= otp_app %>_web/components/core_components.ex",
     "test/support"

priv/templates/nimble_template/coveralls.json.eex

@@ -2,19 +2,18 @@ defmodule <%= web_module %>.Api.FallbackController do
   use Phoenix.Controller
 
   alias Ecto.Changeset
-  alias <%= web_module %>.Api.ErrorView
 
   def call(conn, {:error, :invalid_params, %Changeset{valid?: false} = changeset}) do
     conn
     |> put_status(:unprocessable_entity)
-    |> put_view(ErrorView)
+    |> put_view(json: <%= web_module %>.ErrorJSON)
     |> render("error.json", %{code: :validation_error, changeset: changeset})
   end
 
   def call(conn, {:error, %Changeset{valid?: false} = changeset}) do
     conn
     |> put_status(:unprocessable_entity)
-    |> put_view(ErrorView)
+    |> put_view(json: <%= web_module %>.ErrorJSON)
     |> render("error.json", %{code: :unprocessable_entity, changeset: changeset})
   end
 end

priv/templates/nimble_template/lib/otp_app_web/controllers/api/fallback_controller.ex.eex

@@ -1,22 +1,54 @@
-defmodule <%= web_module %>.Api.ErrorView do
-  use <%= web_module %>, :view
-
+defmodule <%= web_module %>.ErrorJSON do
   alias Ecto.Changeset
+  alias Plug.Conn.Status
+
+  # If you want to customize a particular status code,
+  # you may add your own clauses, such as:
+  #
+  # def render("500.json", _assigns) do
+  #   %{errors: %{detail: "Internal Server Error"}}
+  # end
+
+  # By default, Phoenix returns the status message from
+  # the template name. For example, "404.json" becomes
+  # "Not Found".
 
-  def template_not_found(template, assigns) do
+  def render(_template, %{code: code, changeset: %Changeset{} = changeset}) do
+    build_error_response(
+      code: code,
+      detail: translate_errors(changeset),
+      message: build_changeset_error_message(changeset)
+    )
+  end
+
+  def render(template, assigns) do
     build_error_response(
       code: assigns[:code] || status_code_from_template(template),
       detail: %{},
       message: assigns[:message] || Phoenix.Controller.status_message_from_template(template)
     )
   end
 
-  def render("error.json", %{code: code, changeset: %Changeset{} = changeset}) do
-    build_error_response(
-      code: code,
-      detail: translate_errors(changeset),
-      message: build_changeset_error_message(changeset)
-    )
+  defp status_code_from_template(template) do
+    template
+    |> String.split(".")
+    |> hd()
+    |> String.to_integer()
+    |> Status.reason_atom()
+  rescue
+    _ -> :internal_server_error
+  end
+
+  defp build_error_response(code: code, detail: detail, message: message) do
+    %{
+      errors: [
+        %{
+          code: code,
+          detail: detail,
+          message: message
+        }
+      ]
+    }
   end
 
   defp build_changeset_error_message(%Changeset{} = changeset) do
@@ -39,17 +71,13 @@ defmodule <%= web_module %>.Api.ErrorView do
     "#{sentence} and #{List.last(messages)}"
   end
 
-  defp build_error_response(code: code, detail: detail, message: message) do
-    %{
-      errors: [
-        %{
-          code: code,
-          detail: detail,
-          message: message
-        }
-      ]
-    }
-  end
-
   defp translate_errors(changeset), do: Changeset.traverse_errors(changeset, &translate_error/1)
+
+  defp translate_error({msg, opts}) do
+    if count = opts[:count] do
+      Gettext.dngettext(<%= web_module %>.Gettext, "errors", msg, msg, count, opts)
+    else
+      Gettext.dgettext(<%= web_module %>.Gettext, "errors", msg, opts)
+    end
+  end
 end

priv/templates/nimble_template/lib/otp_app_web/views/api/error_view.ex.eex renamed to priv/templates/nimble_template/lib/otp_app_web/controllers/error_json.ex.eex

@@ -4,15 +4,13 @@ defmodule <%= web_module %>.CheckEmptyBodyParamsPlug do
   import Phoenix.Controller, only: [put_view: 2, render: 3]
   import Plug.Conn
 
-  alias <%= web_module %>.Api.ErrorView
-
   def init(opts), do: opts
 
   def call(%{body_params: body_params, method: "POST"} = conn, _opts)
       when body_params == %{} do
     conn
     |> put_status(:bad_request)
-    |> put_view(ErrorView)
+    |> put_view(json: <%= web_module %>.ErrorJSON)
     |> render("400.json", %{message: "Missing body params"})
     |> halt()
   end