Packages
ash_json_api
1.4.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0-rc.2
1.6.0-rc.1
1.6.0-rc.0
1.5.1
1.5.0
1.4.45
1.4.44
1.4.43
1.4.42
1.4.41
1.4.40
1.4.39
1.4.38
1.4.37
1.4.36
1.4.35
1.4.34
1.4.33
1.4.32
1.4.31
1.4.30
1.4.29
1.4.28
1.4.27
1.4.26
1.4.25
1.4.24
1.4.23
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
retired
1.3.3
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.34.2
0.34.1
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.3
0.31.2
retired
0.31.1
0.31.0
0.30.1
0.30.0-rc.4
0.30.0-rc.3
0.30.0-rc.2
0.30.0-rc.1
0.30.0-rc.0
0.29.1
0.29.0
0.28.6
0.28.5
0.28.4
0.28.3
0.28.2
0.28.1
0.28.0
0.27.6
0.27.5
0.27.1
0.27.0
0.25.0
0.24.4
0.24.2
0.24.1
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.10.0
0.9.0
0.8.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.4
0.2.3
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
The JSON:API extension for the Ash Framework.
Current section
Files
Jump to
Current section
Files
lib/ash_json_api/error/error.ex
defmodule AshJsonApi.Error do
@moduledoc "Represents an AshJsonApi Error"
defstruct id: :undefined,
about: :undefined,
code: :undefined,
title: :undefined,
detail: :undefined,
source_pointer: :undefined,
source_parameter: :undefined,
meta: :undefined,
status_code: :undefined,
internal_description: nil,
log_level: :error
@type t :: %__MODULE__{}
alias Ash.Error.{Forbidden, Framework, Invalid, Unknown}
require Logger
def to_json_api_errors(domain, resource, errors, type) when is_list(errors) do
Enum.flat_map(errors, &to_json_api_errors(domain, resource, &1, type))
end
def to_json_api_errors(domain, resource, %mod{errors: errors}, type)
when mod in [Forbidden, Framework, Invalid, Unknown] do
Enum.flat_map(errors, &to_json_api_errors(domain, resource, &1, type))
end
def to_json_api_errors(_domain, _resource, %__MODULE__{} = error, _type) do
[error]
end
def to_json_api_errors(domain, resource, %{class: :invalid} = error, type) do
if AshJsonApi.ToJsonApiError.impl_for(error) do
error
|> AshJsonApi.ToJsonApiError.to_json_api_error()
|> List.wrap()
|> Enum.flat_map(&with_source_pointer(&1, error, resource, type))
else
uuid = Ash.UUID.generate()
stacktrace =
case error do
%{stacktrace: %{stacktrace: v}} ->
v
_ ->
nil
end
Logger.warning(
"`#{uuid}`: AshJsonApi.Error not implemented for error:\n\n#{Exception.format(:error, error, stacktrace)}"
)
if AshJsonApi.Domain.Info.show_raised_errors?(domain) do
[
%__MODULE__{
id: uuid,
status_code: class_to_status(error.class),
code: "something_went_wrong",
title: "SomethingWentWrong",
detail: """
Raised error: #{uuid}
#{Exception.format(:error, error, stacktrace)}"
"""
}
]
else
[
%__MODULE__{
id: uuid,
status_code: class_to_status(error.class),
code: "something_went_wrong",
title: "SomethingWentWrong",
detail: "Something went wrong. Error id: #{uuid}"
}
]
end
end
end
def to_json_api_errors(_domain, _resource, %{class: :forbidden} = error, _type) do
[
%__MODULE__{
id: Ash.UUID.generate(),
status_code: class_to_status(error.class),
code: "forbidden",
title: "Forbidden",
detail: "forbidden"
}
]
end
def to_json_api_errors(_domain, _resource, error, _type) do
uuid = Ash.UUID.generate()
stacktrace =
case error do
%{stacktrace: %{stacktrace: v}} ->
v
_ ->
nil
end
Logger.warning(
"`#{uuid}`: AshJsonApi.Error not implemented for error:\n\n#{Exception.format(:error, error, stacktrace)}"
)
[
%__MODULE__{
id: uuid,
status_code: class_to_status(error.class),
code: "something_went_wrong",
title: "SomethingWentWrong",
detail: "Something went wrong. Error id: #{uuid}"
}
]
end
@doc "Turns an error class into an HTTP status code"
def class_to_status(:forbidden), do: 403
def class_to_status(:invalid), do: 400
def class_to_status(_), do: 500
def new(opts) do
struct(__MODULE__, opts)
end
def format_log(error) when is_bitstring(error) do
format_log(Ash.Error.Framework.exception([]))
end
def format_log(error) do
code =
if is_bitstring(error.code) do
[error.code, ": "]
else
""
end
title =
if is_bitstring(error.title) do
error.title
else
"Unknown Error"
end
description =
cond do
is_bitstring(error.internal_description) ->
error.internal_description
is_bitstring(error.detail) ->
error.detail
true ->
"No description"
end
[code, title, " | ", description]
end
def with_source_pointer(%{source_pointer: source_pointer} = built_error, _, _, _)
when source_pointer not in [nil, :undefined] do
[built_error]
end
def with_source_pointer(built_error, %{fields: fields, path: path}, resource, type)
when is_list(fields) and fields != [] do
Enum.map(fields, fn field ->
%{built_error | source_pointer: source_pointer(resource, field, path, type)}
end)
end
def with_source_pointer(built_error, %{field: field, path: path}, resource, type)
when not is_nil(field) do
[
%{built_error | source_pointer: source_pointer(resource, field, path, type)}
]
end
def with_source_pointer(built_error, _, _resource, _type) do
[built_error]
end
defp source_pointer(_resource, field, path, :action) do
"/data/attributes/#{Enum.join(List.wrap(path) ++ [field], "/")}"
end
defp source_pointer(resource, field, path, type)
when type in [:create, :update] and not is_nil(field) do
if path == [] && Ash.Resource.Info.public_relationship(resource, field) do
"/data/relationships/#{field}"
else
"/data/attributes/#{Enum.join(List.wrap(path) ++ [field], "/")}"
end
end
defp source_pointer(_resource, _field, _path, _) do
:undefined
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Changes.InvalidChanges do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid",
title: "Invalid",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Query.InvalidQuery do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_query",
title: "InvalidQuery",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Page.InvalidKeyset do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_keyset",
title: "InvalidKeyset",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Changes.InvalidAttribute do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_attribute",
title: "InvalidAttribute",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Changes.InvalidArgument do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_argument",
title: "InvalidArgument",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Query.InvalidArgument do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_argument",
title: "InvalidArgument",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Action.InvalidArgument do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_argument",
title: "InvalidArgument",
detail: error.message,
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Changes.Required do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "required",
title: "Required",
detail: "is required",
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Query.NotFound do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "not_found",
title: "NotFound",
detail: "could not be found",
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Query.Required do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "required",
title: "Required",
detail: "is required",
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Forbidden.Policy do
def to_json_api_error(error) do
message =
if Application.get_env(:ash_json_api, :policies)[:show_policy_breakdowns?] ||
false do
Ash.Error.Forbidden.Policy.report(error, help_text?: false)
else
"forbidden"
end
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "forbidden",
title: "Forbidden",
detail: message,
meta: %{}
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Forbidden.ForbiddenField do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "forbidden",
title: "Forbidden",
detail: "forbidden",
meta: %{}
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Invalid.InvalidPrimaryKey do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: AshJsonApi.Error.class_to_status(error.class),
code: "invalid_primary_key",
title: "InvalidPrimaryKey",
detail: "invalid primary key provided",
meta: Map.new(error.vars)
}
end
end
defimpl AshJsonApi.ToJsonApiError, for: Ash.Error.Invalid.NoSuchInput do
def to_json_api_error(error) do
%AshJsonApi.Error{
id: Ash.UUID.generate(),
status_code: 422,
code: "no_such_input",
title: "NoSuchInput",
detail: Ash.Error.Invalid.NoSuchInput.message(error),
meta: Map.new(error.vars)
}
end
end