Skip to content

adds simple warning when falling back to jsonstring #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adds simple warning when falling back to jsonstring #368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion lib/resource/resource.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4942,7 +4942,26 @@ defmodule AshGraphql.Resource do
AshGraphql.Resource.Info.type(constraints[:instance_of])
end

type || get_specific_field_type(Ash.Type.Map, %{constraints: constraints}, resource, input?)
result =
type || get_specific_field_type(Ash.Type.Map, %{constraints: constraints}, resource, input?)

# Warn when struct with instance_of falls back to JsonString for input
if input? && constraints[:instance_of] &&
Ash.Resource.Info.resource?(constraints[:instance_of]) &&
result == (Application.get_env(:ash_graphql, :json_type) || :json_string) do
IO.warn("""
Struct type with instance_of constraint falls back to JsonString for input.
Consider creating a custom type with `use AshGraphql.Type` and `graphql_input_type/1`
for structured validation.

Resource: #{inspect(resource)}
Target: #{inspect(constraints[:instance_of])}

See: https://hexdocs.pm/ash_graphql/use-struct-types-with-graphql.html
""")
end

result
end

defp get_specific_field_type(Ash.Type.File, _, _, _), do: :upload
Expand Down