Packages
ash_json_api
1.6.1
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/resource/verifiers/verify_actions.ex
# SPDX-FileCopyrightText: 2019 ash_json_api contributors <https://github.com/ash-project/ash_json_api/graphs/contributors>
#
# SPDX-License-Identifier: MIT
defmodule AshJsonApi.Resource.Verifiers.VerifyActions do
@moduledoc "Verifies that all actions are valid for each route."
use Spark.Dsl.Verifier
@compatible_action_types [
get: [:read, :action],
index: [:read, :action],
post: [:create, :action, :read],
patch: [:update, :action],
delete: [:destroy, :action],
route: [:action],
get_related: [:read],
relationship: [:read],
post_to_relationship: [:update],
patch_relationship: [:update],
delete_from_relationship: [:update]
]
@doc false
def compatible_action_types, do: @compatible_action_types
@impl true
def verify(dsl) do
module = Spark.Dsl.Verifier.get_persisted(dsl, :module)
dsl
|> AshJsonApi.Resource.Info.routes()
|> Enum.each(fn route ->
action =
if route.action do
Ash.Resource.Info.action(dsl, route.action)
else
route.action_type && Ash.Resource.Info.primary_action!(dsl, route.action_type)
end
if !action do
raise Spark.Error.DslError,
module: module,
path: [:json_api, :routes, route.type, route.action],
message: """
Unknown action specified: #{inspect(route.action)}
"""
end
valid_action_types = List.wrap(@compatible_action_types[route.type])
unless action.type in valid_action_types do
raise Spark.Error.DslError,
module: module,
path: [:json_api, :routes, route.type, route.action],
message: """
Unsupported action type for route type #{inspect(route.type)}.
Got: #{inspect(action.type)}
Allowed: #{inspect(valid_action_types)}
"""
end
if action.type == :action do
verify_return_type!(module, module, route, action)
end
end)
:ok
end
@doc false
def verify_return_type!(module, resource, route, action) do
case route.type do
:route ->
:ok
:index ->
needed_type = "{:array, :struct}"
needed_constraints = "items: [instance_of: #{inspect(resource)}]"
case action.returns do
{:array, value} ->
{type, constraints} = flatten_new_type(value, action.constraints[:items] || [])
unless type == Ash.Type.Struct && constraints[:instance_of] == resource do
invalid_return_type!(module, route, action, needed_type, needed_constraints)
end
_ ->
invalid_return_type!(module, route, action, needed_type, needed_constraints)
end
type when type in [:get, :post] ->
needed_type = ":struct"
needed_constraints = "instance_of: #{inspect(resource)}"
{type, constraints} = flatten_new_type(action.returns, action.constraints || [])
unless type == Ash.Type.Struct && constraints[:instance_of] == resource do
invalid_return_type!(module, route, action, needed_type, needed_constraints)
end
type when type in [:patch, :delete] ->
argument_names = Enum.map(action.arguments, &to_string(&1.name))
path_params =
route.route
|> Path.split()
|> Enum.filter(&String.starts_with?(&1, ":"))
|> Enum.map(&String.trim(String.trim_leading(&1, ":")))
|> Enum.uniq()
path_params
|> Kernel.--(argument_names)
|> case do
[] ->
:ok
missing_arguments ->
raise Spark.Error.DslError,
module: module,
path: [:json_api, :routes, route.type, route.action],
message: """
Generic action #{inspect(action.name)} does not have corresponding arguments for all of its path params:
Route: #{route.route}
Path Params: #{inspect(path_params)}
Missing: #{inspect(missing_arguments)}
"""
end
needed_type = ":struct"
needed_constraints = "instance_of: #{inspect(resource)}"
{type, constraints} = flatten_new_type(action.returns, action.constraints || [])
unless type == Ash.Type.Struct && constraints[:instance_of] == resource do
invalid_return_type!(module, route, action, needed_type, needed_constraints)
end
end
:ok
end
defp invalid_return_type!(module, route, action, needed_type, constraints) do
raise Spark.Error.DslError,
module: module,
path: [:json_api, :routes, route.type, route.action],
message: """
Invalid return type for generic action used in #{route.type} route.
Expected type `#{needed_type}`
Expected constraints: #{constraints}
Got type: #{inspect(action.returns)}
Got constraints: #{inspect(action.constraints)}
"""
end
defp flatten_new_type(type, constraints) do
if Ash.Type.NewType.new_type?(type) do
new_constraints = Ash.Type.NewType.constraints(type, constraints)
new_type = Ash.Type.NewType.subtype_of(type)
{new_type, new_constraints}
else
{type, constraints}
end
end
end