Add support for inline fragments (#65)
## Summary:
In this commit I add support for inline fragments
(`... on MyType { fields }`) to genqlient. This will make interfaces a
lot more useful! In future commits I'll add named fragments, for which
we'll generate slightly different types, as discussed in DESIGN.md.
In general, implementing the flattening approach described in DESIGN.md
was... surprisingly easy. All we have to do is recurse on applicable
fragments when generating our selection-set. The refactor to
selection-set handling this encouraged was, I think, quite beneficial.
It did reveal two tricky pre-existing issues.
One issue is that GraphQL allows for duplicate selections, as long as
they match. (In practice, this is only useful in the context of
fragments, although GraphQL allows it even without.) I decided to handle
the simple case (duplicate leaf fields; we just deduplicate) but leave
to the future the complex cases where we need to merge different
sub-selections (now #64). For now we just forbid that; we can see how
much it comes up.
The other issue is that we are generating type-names incorrectly for
interface types; I had intended to do `MyInterfaceMyFieldMyType` for
shared fields and `MyImplMyFieldMyType` for non-shared ones, but instead
I did `MyFieldMyType`, which is inconsistent already and can result in
conflicts in the presence of fragments. I'm going to fix this in a
separate commit, though, because it's going to require some refactoring
and is irrelevant to the main logic of this commit; I left some TODOs in
the tests related to this.
Issue: https://github.com/Khan/genqlient/issues/8
## Test plan:
make check
Author: benjaminjkraft
Reviewers: dnerdy, aberkan, MiguelCastillo
Required Reviewers:
Approved by: dnerdy
Checks: ⌛ Test (1.17), ⌛ Test (1.16), ⌛ Test (1.15), ⌛ Test (1.14), ⌛ Test (1.13), ✅ Lint, ⌛ Test (1.17), ⌛ Test (1.16), ⌛ Test (1.15), ⌛ Test (1.14), ⌛ Test (1.13), ✅ Lint
Pull request URL: https://github.com/Khan/genqlient/pull/65
This commit is contained in:
Ben Kraft
+165
-49
@@ -200,38 +200,20 @@ func (g *generator) convertDefinition(
|
||||
|
||||
switch def.Kind {
|
||||
case ast.Object:
|
||||
fields, err := g.convertSelectionSet(
|
||||
namePrefix, selectionSet, def, queryOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
goType := &goStructType{
|
||||
GoName: name,
|
||||
Description: def.Description,
|
||||
GraphQLName: def.Name,
|
||||
Fields: make([]*goStructField, len(selectionSet)),
|
||||
Fields: fields,
|
||||
Incomplete: true,
|
||||
}
|
||||
g.typeMap[name] = goType
|
||||
|
||||
for i, selection := range selectionSet {
|
||||
_, selectionDirective, err := g.parsePrecedingComment(
|
||||
selection, selection.GetPosition())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
selectionOptions := queryOptions.merge(selectionDirective)
|
||||
|
||||
switch selection := selection.(type) {
|
||||
case *ast.Field:
|
||||
goType.Fields[i], err = g.convertField(
|
||||
namePrefix, selection, selectionOptions, queryOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
case *ast.FragmentSpread:
|
||||
return nil, errorf(selection.Position, "not implemented: %T", selection)
|
||||
case *ast.InlineFragment:
|
||||
return nil, errorf(selection.Position, "not implemented: %T", selection)
|
||||
default:
|
||||
return nil, errorf(nil, "invalid selection type: %T", selection)
|
||||
}
|
||||
}
|
||||
return goType, nil
|
||||
|
||||
case ast.InputObject:
|
||||
@@ -270,38 +252,22 @@ func (g *generator) convertDefinition(
|
||||
return goType, nil
|
||||
|
||||
case ast.Interface, ast.Union:
|
||||
sharedFields, err := g.convertSelectionSet(
|
||||
namePrefix, selectionSet, def, queryOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
implementationTypes := g.schema.GetPossibleTypes(def)
|
||||
goType := &goInterfaceType{
|
||||
GoName: name,
|
||||
Description: def.Description,
|
||||
GraphQLName: def.Name,
|
||||
SharedFields: make([]*goStructField, 0, len(selectionSet)),
|
||||
SharedFields: sharedFields,
|
||||
Implementations: make([]*goStructType, len(implementationTypes)),
|
||||
}
|
||||
g.typeMap[name] = goType
|
||||
|
||||
// TODO(benkraft): This sorta-duplicates what we'll do in each
|
||||
// implementation when it traverses the fields. But they'll differ
|
||||
// more once we support fragments; at that point we should figure out
|
||||
// how to refactor.
|
||||
for _, selection := range selectionSet {
|
||||
field, ok := selection.(*ast.Field)
|
||||
if !ok { // fragment/interface, not a shared field
|
||||
continue
|
||||
}
|
||||
_, fieldDirective, err := g.parsePrecedingComment(field, field.GetPosition())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
fieldOptions := queryOptions.merge(fieldDirective)
|
||||
|
||||
goField, err := g.convertField(namePrefix, field, fieldOptions, queryOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
goType.SharedFields = append(goType.SharedFields, goField)
|
||||
}
|
||||
|
||||
for i, implDef := range implementationTypes {
|
||||
// Note for shared fields we propagate forward the interface's
|
||||
// name-prefix: that is, the implementations will have fields with
|
||||
@@ -357,7 +323,157 @@ func (g *generator) convertDefinition(
|
||||
}
|
||||
}
|
||||
|
||||
// convertField converts a single GraphQL operation-field into a GraphQL type.
|
||||
// convertSelectionSet converts a GraphQL selection-set into a list of
|
||||
// corresponding Go struct-fields (and their Go types)
|
||||
//
|
||||
// A selection-set is a list of fields within braces like `{ myField }`, as
|
||||
// appears at the toplevel of a query, in a field's sub-selections, or within
|
||||
// an inline or named fragment.
|
||||
//
|
||||
// containingTypedef is the type-def whose fields we are selecting, and may be
|
||||
// an object type or an interface type. In the case of interfaces, we'll call
|
||||
// convertSelectionSet once for the interface, and once for each
|
||||
// implementation.
|
||||
func (g *generator) convertSelectionSet(
|
||||
namePrefix string,
|
||||
selectionSet ast.SelectionSet,
|
||||
containingTypedef *ast.Definition,
|
||||
queryOptions *GenqlientDirective,
|
||||
) ([]*goStructField, error) {
|
||||
fields := make([]*goStructField, 0, len(selectionSet))
|
||||
for _, selection := range selectionSet {
|
||||
_, selectionDirective, err := g.parsePrecedingComment(
|
||||
selection, selection.GetPosition())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
selectionOptions := queryOptions.merge(selectionDirective)
|
||||
|
||||
switch selection := selection.(type) {
|
||||
case *ast.Field:
|
||||
field, err := g.convertField(
|
||||
namePrefix, selection, selectionOptions, queryOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
fields = append(fields, field)
|
||||
case *ast.FragmentSpread:
|
||||
return nil, errorf(selection.Position, "not implemented: %T", selection)
|
||||
case *ast.InlineFragment:
|
||||
// (Note this will return nil, nil if the fragment doesn't apply to
|
||||
// this type.)
|
||||
fragmentFields, err := g.convertInlineFragment(
|
||||
namePrefix, selection, containingTypedef, queryOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
fields = append(fields, fragmentFields...)
|
||||
default:
|
||||
return nil, errorf(nil, "invalid selection type: %T", selection)
|
||||
}
|
||||
}
|
||||
|
||||
// We need to deduplicate, if you asked for
|
||||
// { id, id, id, ... on SubType { id } }
|
||||
// (which, yes, is legal) we'll treat that as just { id }.
|
||||
uniqFields := make([]*goStructField, 0, len(selectionSet))
|
||||
fieldNames := make(map[string]bool, len(selectionSet))
|
||||
for _, field := range fields {
|
||||
// GraphQL (and, effectively, JSON) requires that all fields with the
|
||||
// same alias (JSON-name) must be the same (i.e. refer to the same
|
||||
// field), so that's how we deduplicate.
|
||||
if fieldNames[field.JSONName] {
|
||||
// GraphQL (and, effectively, JSON) forbids you from having two
|
||||
// fields with the same alias (JSON-name) that refer to different
|
||||
// GraphQL fields. But it does allow you to have the same field
|
||||
// with different selections (subject to some additional rules).
|
||||
// We say: that's too complicated! and allow duplicate fields
|
||||
// only if they're "leaf" types (enum or scalar).
|
||||
switch field.GoType.Unwrap().(type) {
|
||||
case *goOpaqueType, *goEnumType:
|
||||
// Leaf field; we can just deduplicate.
|
||||
// Note GraphQL already guarantees that the conflicting field
|
||||
// has scalar/enum type iff this field does:
|
||||
// https://spec.graphql.org/draft/#SameResponseShape()
|
||||
continue
|
||||
case *goStructType, *goInterfaceType:
|
||||
// TODO(benkraft): Keep track of the position of each
|
||||
// selection, so we can put this error on the right line.
|
||||
return nil, errorf(nil,
|
||||
"genqlient doesn't allow duplicate fields with different selections "+
|
||||
"(see https://github.com/Khan/genqlient/issues/64); "+
|
||||
"duplicate field: %s.%s", containingTypedef.Name, field.JSONName)
|
||||
default:
|
||||
return nil, errorf(nil, "unexpected field-type: %T", field.GoType.Unwrap())
|
||||
}
|
||||
}
|
||||
uniqFields = append(uniqFields, field)
|
||||
fieldNames[field.JSONName] = true
|
||||
}
|
||||
return uniqFields, nil
|
||||
}
|
||||
|
||||
// fragmentMatches returns true if the given fragment is "active" when applied
|
||||
// to the given type.
|
||||
//
|
||||
// "Active" here means "the fragment's fields will be returned on all objects
|
||||
// of the given type", which is true when the given type is or implements
|
||||
// the fragment's type. This is distinct from the rules for when a fragment
|
||||
// spread is legal, which is true when the fragment would be active for *any*
|
||||
// of the concrete types the spread-context could have (see
|
||||
// https://spec.graphql.org/draft/#sec-Fragment-Spreads or DESIGN.md).
|
||||
//
|
||||
// containingTypedef is as described in convertInlineFragment, below.
|
||||
// fragmentTypedef is the definition of the fragment's type-condition, i.e. the
|
||||
// definition of MyType in a fragment `on MyType`.
|
||||
func fragmentMatches(containingTypedef, fragmentTypedef *ast.Definition) bool {
|
||||
if containingTypedef.Name == fragmentTypedef.Name {
|
||||
return true
|
||||
}
|
||||
for _, iface := range containingTypedef.Interfaces {
|
||||
// Note we don't need to recurse into the interfaces here, because in
|
||||
// GraphQL types must list all the interfaces they implement, including
|
||||
// all types those interfaces implement [1]. Actually, at present
|
||||
// gqlparser doesn't even support interfaces implementing other
|
||||
// interfaces, but our code would handle that too.
|
||||
// [1] https://spec.graphql.org/draft/#sec-Interfaces.Interfaces-Implementing-Interfaces
|
||||
if iface == fragmentTypedef.Name {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// convertInlineFragment converts a single GraphQL inline fragment
|
||||
// (`... on MyType { myField }`) into Go struct-fields.
|
||||
//
|
||||
// containingTypedef is the type-def corresponding to the type into which we
|
||||
// are spreading; it may be either an interface type (when spreading into one)
|
||||
// or an object type (when writing the implementations of such an interface, or
|
||||
// when using an inline fragment in an object type which is rare). If the
|
||||
// given fragment does not apply to that type, this function returns nil, nil.
|
||||
//
|
||||
// In general, we treat such fragments' fields as if they were fields of the
|
||||
// parent selection-set (except of course they are only included in types the
|
||||
// fragment matches); see DESIGN.md for more.
|
||||
func (g *generator) convertInlineFragment(
|
||||
namePrefix string,
|
||||
fragment *ast.InlineFragment,
|
||||
containingTypedef *ast.Definition,
|
||||
queryOptions *GenqlientDirective,
|
||||
) ([]*goStructField, error) {
|
||||
// You might think fragmentTypedef would be fragment.ObjectDefinition, but
|
||||
// actually that's the type into which the fragment is spread.
|
||||
fragmentTypedef := g.schema.Types[fragment.TypeCondition]
|
||||
if !fragmentMatches(containingTypedef, fragmentTypedef) {
|
||||
return nil, nil
|
||||
}
|
||||
return g.convertSelectionSet(namePrefix, fragment.SelectionSet,
|
||||
containingTypedef, queryOptions)
|
||||
}
|
||||
|
||||
// convertField converts a single GraphQL operation-field into a Go
|
||||
// struct-field (and its type).
|
||||
//
|
||||
// Note that input-type fields are handled separately (inline in
|
||||
// convertDefinition), because they come from the type-definition, not the
|
||||
|
||||
Reference in New Issue
Block a user