Add a mechanism to specify options on input-type fields (#124)

## Summary:
This has been a bit of a thorn since we started using genqlient in
production: just as you might want to specify, say, `omitempty` on an
argument, you might equally want to specify it on an input-type field.
But there's no obvious syntax to do that, because the input-type field
does not appear in the query (only the schema) so there's nowhere to put
the `# @genqlient` directive.

This commit, at last, fixes that problem, via a new option, `for`, which
you use in an option applied to the entire operation (or fragment), and
says, "actually, apply this directive to the given field, not the entire
operation".  (It's mainly useful for input types, but I allowed it for
output types too; I could imagine it being convenient if you want to say
you always use a certain type or type-name for a certain field.)  It
works basically like you expect: the inline options take precedence over
`for` take precedence over query-global options.

The implementation was fairly straightforward once I did a little
refactoring, mostly in the directive-parsing and directive-merging
(which are now combined, since merging is now a bit more complicated).
With that in place, and extended to support `for`, we need only add the
same wiring to input-fields that we have for other places you can put
directives.  I did not attempt to solve the issue I've now documented
as #123, wherein conflicting options can lead to confusing behavior;
the new `for` is a new and perhaps more attractive avenue to cause it
but the issue remains the same and requires nontrivial refactoring
(described in the issue) to solve.  (The breakage isn't horrible for the
most part; the option will just apply, or not apply, where you don't
expect it to.)

But while applying that logic, I noticed a problem, which is that we
were inconsistently cascading operation-level options down to
input-object fields.  (I think this came out of the fact that initially
I thought to cascade them, then realized that this could cause problems
like #123 and intended to walk them back, but then accidentally only
"fixed" it for `omitempty`.  I guess until this change, operation-level
options were rare enough, and input-field options messy enough, that no
one noticed.)  So in this commit I bring things back into consistency,
by saying that they do cascade: with at least a sketch of a path forward
to solve #123 via better validation, I think that's by far the clearest
behavior.

Issue: https://github.com/Khan/genqlient/issues/14

## Test plan:
make check


Author: benjaminjkraft

Reviewers: csilvers, StevenACoffman, benjaminjkraft, aberkan, dnerdy, jvoll, mahtabsabet, MiguelCastillo

Required Reviewers: 

Approved By: csilvers, StevenACoffman

Checks:  Test (1.17),  Test (1.16),  Test (1.15),  Test (1.14),  Lint,  Test (1.17),  Test (1.16),  Test (1.15),  Test (1.14),  Lint

Pull Request URL: https://github.com/Khan/genqlient/pull/124
This commit is contained in:
Ben Kraft
2021-10-01 11:28:29 -07:00
committed by GitHub
parent 9ef76361e7
commit dd719deb4e
11 changed files with 343 additions and 91 deletions
+47 -12
View File
@@ -7,11 +7,12 @@
# by the server, not by the client, so it would reject a real @genqlient
# directive as nonexistent.)
#
# Directives may be applied to fields, arguments, or the entire query.
# Directives on the line preceding the query apply to all relevant nodes in
# the query; other directives apply to all nodes on the following line. (In
# all cases it's fine for there to be other comments in between the directive
# and the node(s) to which it applies.) For example, in the following query:
# Directives may be applied to fields, arguments, or the entire query or named
# fragment. Directives on the line preceding the query or a named fragment
# apply to all relevant nodes in the query; other directives apply to all nodes
# on the following line. (In all cases it's fine for there to be other
# comments in between the directive and the node(s) to which it applies.) For
# example, in the following query:
# # @genqlient(n: "a")
#
# # @genqlient(n: "b")
@@ -39,16 +40,48 @@
# entire query (so "d", "e", and "f" take precedence over "b" and "c"), and
# multiple directives on the same node ("b" and "c") must not conflict. Note
# that directives on nodes do *not* apply to their "children", so "d" does not
# apply to the fields of MyInput, and "f" does not apply to field4.
# apply to the fields of MyInput, and "f" does not apply to field4. (But
# directives on operations and fragments do: both "b" and "c" apply to fields
# of MyInput and to field4.)
directive genqlient(
# If set, this argument will be omitted if it has an empty value, defined
# (the same as in encoding/json) as false, 0, a nil pointer, a nil interface
# value, and any empty array, slice, map, or string.
# If set to a string "MyType.myField", this entire @genqlient directive
# will be treated as if it were applied to the specified field of the
# specified type. It must be applied to an entire operation or fragment.
#
# This is especially useful for input-type options like omitempty and
# pointer, which are equally meaningful on input-type fields as on arguments,
# but there's no natural syntax to put them on fields.
#
# Note that for input types, unless the type has the "typename" option set,
# all operations and fragments in the same package which use this type should
# have matching directives. (This is to avoid needing to give them more
# complex type-names.) This is not currently validated, but will be
# validated in the future (see issue #123).
#
# For example, given the following query:
# # @genqlient(for: "MyInput.myField", omitempty: true)
# # @genqlient(for: "MyInput.myOtherField", pointer: true)
# # @genqlient(for: "MyOutput.id", bind: "path/to/pkg.MyOutputID")
# query MyQuery($arg: MyInput) { ... }
# genqlient will generate a type
# type MyInput struct {
# MyField <type> `json:"myField,omitempty"`
# MyOtherField *<type> `json:"myField"`
# MyThirdField <type> `json:"myThirdField"`
# }
# and use it for the argument to MyQuery, and similarly if `MyOutput.id` is
# ever requested in the response, it will be set to use the given type.
for: String
# If set, this argument (or input-type field, see "for") will be omitted if
# it has an empty value, defined (the same as in encoding/json) as false, 0,
# a nil pointer, a nil interface value, and any empty array, slice, map, or
# string.
#
# For example, given the following query:
# # @genqlient(omitempty: true)
# query MyQuery(arg: String) { ... }
# query MyQuery($arg: String) { ... }
# genqlient will generate a function
# MyQuery(ctx context.Context, client graphql.Client, arg string) ...
# which will pass {"arg": null} to GraphQL if arg is "", and the actual
@@ -161,8 +194,10 @@ directive genqlient(
# type-name in multiple places unless they request the exact same fields, or
# if your type-name conflicts with an autogenerated one (again, unless they
# request the exact same fields). They must even have the fields in the
# same order. Fragments are often easier to use (see the discussion of
# code-sharing in FAQ.md, and the "flatten" option above).
# same order. They should also have matching @genqlient directives, although
# this is not currently validated (see issue #123). Fragments are often
# easier to use (see the discussion of code-sharing in FAQ.md, and the
# "flatten" option above).
#
# Note that unlike most directives, if applied to the entire operation,
# typename affects the overall response type, rather than being propagated