Apply type system directives in macro based schemas #1140
Conversation
This change was necessary to to implement macro-based directive handling. Because these fields are deprecated, they would use the new `deprecated` directive. This directive definition is taken from the prototype schema. However, during compilation of the prototype schema it would also invoke the introspection builtins with 'deprecated' directive, which is not yet available. This new phase extracts the deprecated fields, thus allowing the prototype phase to skip it in its schema pipeline to avoid the problem. In Absinthe 2.0 the entire phase can be removed but as of now it's a backwards incompatible change.
This also handles deprecation at the directive level, so it works similar to SDL schema's.
| @@ -310,6 +310,9 @@ defmodule Absinthe.Middleware do | |||
| [{:ref, Absinthe.Type.BuiltIns.Introspection, _}] -> | |||
| expanded | |||
|
|
|||
| [{:ref, Absinthe.Phase.Schema.DeprecatedDirectiveFields, _}] -> | |||
There was a problem hiding this comment.
Not really happy with this, but can be removed when these fields are no longer necessary.
| end | ||
| ``` | ||
| """ | ||
| defmacro directive(identifier, attrs \\ [], do: block) do | ||
| defmacro directive(identifier, attrs, do: block) when is_list(attrs) when not is_nil(block) do |
There was a problem hiding this comment.
directive/1,2,3 can be used for both defining directives as applying them to types in the schema.
I think this is clear for the users but perhaps there's another function name we can use for applying the directive.
There was a problem hiding this comment.
Amazing! As commented in #1045 I was also looking into the issue and saw it a huge undertaking to properly support type system directives in macro schema by my hand, even for only supporting deprecated.
As a workaround I was to adopt @zoldar's gist on userland (which works for now, at least for deprecated) but this patch should nicely remove the extra work. Love it!
Co-authored-by: Yu Matsuzawa <ymtszw@gmail.com>
|
A step to move #1003 forward (by a lot!) |
|
|
||
| query do | ||
| field :post, :post do | ||
| directive :feature, name: ":field_definition" |
There was a problem hiding this comment.
I am a bit confused about these strings that look like atoms? are they arbitrary strings and you just happened to use strings that look like atoms or is there some significance to this format?
There was a problem hiding this comment.
It's arbitrary, in the same test file there's an SDL schema that follows the same format (https://github.com/absinthe-graphql/absinthe/blob/2390500573c08d882143b48bc02f455ae5d0fd86/test/absinthe/schema/type_system_directive_test.exs). The macro-schema is a near copy of that.
|
❤️ Really looking forward to this since it will greatly simplify the https://github.com/DivvyPayHQ/absinthe_federation library |
This PR allows schemas to apply type system directives in macro based schemas. This was already possible for SDL based schemas.
It makes deprecations work through the
deprecatedtype system directive. This directive is defined on the default prototype schema and this led to a problem with the several deprecated introspection fields. These were extracted to a separate schema phase so the prototype schema can skip them. In Absinthe 2.0 this phase can be removed altogether but I've kept it for now for backwards compatibility.Some work for a followup is to validate the arguments passed into applied type system directives. This is currently also not done for SDL based schema afaict.
Schema level directives also are not possible yet e.g.
Since macro based deprecations are no longer special cased it will also fix #1045