Ben Kraft
f99c10d6fd
## Summary:
In previous commits I added support to genqlient for interfaces and
inline fragments. This means the only query structures that remain are
named fragments and their spreads, e.g.
```
fragment MyFragment on MyType { myField }
query MyQuery { getMyType { ...MyFragment } }
```
Other than mere completionism, these are potentially useful for code
sharing: you can spread the same fragment multiple places; and then
genqlient can notice that and generate the same type for each. (They
can even be shared between different queries in the same package.)
In this commit I add support for named fragments of concrete
(object/struct, not interface) type, spread into either concrete or
abstract scope. For genqlient's purposes, these are a new "root"
type-name, just like each operation, and are then embedded into the
appropriate struct. (Using embeds allows their fields to be referenced
as fields of the containing type, if convenient. Further design
considerations are discussed in DESIGN.md.)
This requires new code in two main places (plus miscellaneous glue),
both nontrivial but neither particularly complex:
- We need to actually traverse both structures and generate the types
(in `convert.go`).
- We need to decide which fragments from this package to send to the
server, both for good hyigene and because GraphQL requires we send
only ones this query uses (in `generate.go`).
- We need a little new wiring for options -- because fragments can be
shared between queries they get their own toplevel options, rather
than inheriting the query's options.
Finally, this required slightly subtler changes to how we do
unmarshaling (in `types.go` and `unmarshal.go.tmpl`). Basically,
because embedded fields' methods, including `UnmarshalJSON`, get
promoted to the parent type, and because the JSON library ignores their
fields when shadowed by those of the parent type, we need a little bit
of special logic in each such parent type to do its own unmarshal and
then delegate to each embed. This is similar (and much simpler) to
what we did for interfaces, although it required some changes to the
"method-hiding" trick (used for both). It's only really necessary in
certain specific cases (namely when an embedded type has an
`UnmarshalJSON` method or a field with the same name as the embedder),
but it's easier to just generate it always. This is all described in
more detail inline.
This does not support fragments of abstract type, which have their own
complexities. I'll address those, which are now the only remaining
piece of #8, in a future commit.
Issue: https://github.com/Khan/genqlient/issues/8
## Test plan:
make check
Author: benjaminjkraft
Reviewers: dnerdy, benjaminjkraft, aberkan, MiguelCastillo
Required Reviewers:
Approved By: dnerdy
Checks: ✅ Lint, ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Test (1.13), ✅ 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/75
370 lines
13 KiB
Go
370 lines
13 KiB
Go
package test
|
|
|
|
// Code generated by github.com/Khan/genqlient, DO NOT EDIT.
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"github.com/Khan/genqlient/graphql"
|
|
"github.com/Khan/genqlient/internal/testutil"
|
|
)
|
|
|
|
// InterfaceListFieldResponse is returned by InterfaceListField on success.
|
|
type InterfaceListFieldResponse struct {
|
|
Root InterfaceListFieldRootTopic `json:"root"`
|
|
WithPointer *InterfaceListFieldWithPointerTopic `json:"withPointer"`
|
|
}
|
|
|
|
// InterfaceListFieldRootTopic includes the requested fields of the GraphQL type Topic.
|
|
type InterfaceListFieldRootTopic struct {
|
|
// ID is documented in the Content interface.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
Children []InterfaceListFieldRootTopicChildrenContent `json:"-"`
|
|
}
|
|
|
|
func (v *InterfaceListFieldRootTopic) UnmarshalJSON(b []byte) error {
|
|
|
|
var firstPass struct {
|
|
*InterfaceListFieldRootTopic
|
|
Children []json.RawMessage `json:"children"`
|
|
graphql.NoUnmarshalJSON
|
|
}
|
|
firstPass.InterfaceListFieldRootTopic = v
|
|
|
|
err := json.Unmarshal(b, &firstPass)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
{
|
|
target := &v.Children
|
|
raw := firstPass.Children
|
|
*target = make(
|
|
[]InterfaceListFieldRootTopicChildrenContent,
|
|
len(raw))
|
|
for i, raw := range raw {
|
|
target := &(*target)[i]
|
|
err = __unmarshalInterfaceListFieldRootTopicChildrenContent(
|
|
target, raw)
|
|
if err != nil {
|
|
return fmt.Errorf(
|
|
"Unable to unmarshal InterfaceListFieldRootTopic.Children: %w", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// InterfaceListFieldRootTopicChildrenArticle includes the requested fields of the GraphQL type Article.
|
|
type InterfaceListFieldRootTopicChildrenArticle struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// InterfaceListFieldRootTopicChildrenContent includes the requested fields of the GraphQL interface Content.
|
|
//
|
|
// InterfaceListFieldRootTopicChildrenContent is implemented by the following types:
|
|
// InterfaceListFieldRootTopicChildrenArticle
|
|
// InterfaceListFieldRootTopicChildrenVideo
|
|
// InterfaceListFieldRootTopicChildrenTopic
|
|
//
|
|
// The GraphQL type's documentation follows.
|
|
//
|
|
// Content is implemented by various types like Article, Video, and Topic.
|
|
type InterfaceListFieldRootTopicChildrenContent interface {
|
|
implementsGraphQLInterfaceInterfaceListFieldRootTopicChildrenContent()
|
|
// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
|
|
GetTypename() string
|
|
// GetId returns the interface-field "id" from its implementation.
|
|
// The GraphQL interface field's documentation follows.
|
|
//
|
|
// ID is the identifier of the content.
|
|
GetId() testutil.ID
|
|
// GetName returns the interface-field "name" from its implementation.
|
|
GetName() string
|
|
}
|
|
|
|
func (v *InterfaceListFieldRootTopicChildrenArticle) implementsGraphQLInterfaceInterfaceListFieldRootTopicChildrenContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenArticle) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenArticle) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenArticle) GetName() string { return v.Name }
|
|
|
|
func (v *InterfaceListFieldRootTopicChildrenVideo) implementsGraphQLInterfaceInterfaceListFieldRootTopicChildrenContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenVideo) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenVideo) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenVideo) GetName() string { return v.Name }
|
|
|
|
func (v *InterfaceListFieldRootTopicChildrenTopic) implementsGraphQLInterfaceInterfaceListFieldRootTopicChildrenContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenTopic) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenTopic) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface InterfaceListFieldRootTopicChildrenContent.
|
|
func (v *InterfaceListFieldRootTopicChildrenTopic) GetName() string { return v.Name }
|
|
|
|
func __unmarshalInterfaceListFieldRootTopicChildrenContent(v *InterfaceListFieldRootTopicChildrenContent, m json.RawMessage) error {
|
|
if string(m) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var tn struct {
|
|
TypeName string `json:"__typename"`
|
|
}
|
|
err := json.Unmarshal(m, &tn)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
switch tn.TypeName {
|
|
case "Article":
|
|
*v = new(InterfaceListFieldRootTopicChildrenArticle)
|
|
return json.Unmarshal(m, *v)
|
|
case "Video":
|
|
*v = new(InterfaceListFieldRootTopicChildrenVideo)
|
|
return json.Unmarshal(m, *v)
|
|
case "Topic":
|
|
*v = new(InterfaceListFieldRootTopicChildrenTopic)
|
|
return json.Unmarshal(m, *v)
|
|
case "":
|
|
return fmt.Errorf(
|
|
"Response was missing Content.__typename")
|
|
default:
|
|
return fmt.Errorf(
|
|
`Unexpected concrete type for InterfaceListFieldRootTopicChildrenContent: "%v"`, tn.TypeName)
|
|
}
|
|
}
|
|
|
|
// InterfaceListFieldRootTopicChildrenTopic includes the requested fields of the GraphQL type Topic.
|
|
type InterfaceListFieldRootTopicChildrenTopic struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// InterfaceListFieldRootTopicChildrenVideo includes the requested fields of the GraphQL type Video.
|
|
type InterfaceListFieldRootTopicChildrenVideo struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// InterfaceListFieldWithPointerTopic includes the requested fields of the GraphQL type Topic.
|
|
type InterfaceListFieldWithPointerTopic struct {
|
|
// ID is documented in the Content interface.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
Children []InterfaceListFieldWithPointerTopicChildrenContent `json:"-"`
|
|
}
|
|
|
|
func (v *InterfaceListFieldWithPointerTopic) UnmarshalJSON(b []byte) error {
|
|
|
|
var firstPass struct {
|
|
*InterfaceListFieldWithPointerTopic
|
|
Children []json.RawMessage `json:"children"`
|
|
graphql.NoUnmarshalJSON
|
|
}
|
|
firstPass.InterfaceListFieldWithPointerTopic = v
|
|
|
|
err := json.Unmarshal(b, &firstPass)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
{
|
|
target := &v.Children
|
|
raw := firstPass.Children
|
|
*target = make(
|
|
[]InterfaceListFieldWithPointerTopicChildrenContent,
|
|
len(raw))
|
|
for i, raw := range raw {
|
|
target := &(*target)[i]
|
|
err = __unmarshalInterfaceListFieldWithPointerTopicChildrenContent(
|
|
target, raw)
|
|
if err != nil {
|
|
return fmt.Errorf(
|
|
"Unable to unmarshal InterfaceListFieldWithPointerTopic.Children: %w", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// InterfaceListFieldWithPointerTopicChildrenArticle includes the requested fields of the GraphQL type Article.
|
|
type InterfaceListFieldWithPointerTopicChildrenArticle struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// InterfaceListFieldWithPointerTopicChildrenContent includes the requested fields of the GraphQL interface Content.
|
|
//
|
|
// InterfaceListFieldWithPointerTopicChildrenContent is implemented by the following types:
|
|
// InterfaceListFieldWithPointerTopicChildrenArticle
|
|
// InterfaceListFieldWithPointerTopicChildrenVideo
|
|
// InterfaceListFieldWithPointerTopicChildrenTopic
|
|
//
|
|
// The GraphQL type's documentation follows.
|
|
//
|
|
// Content is implemented by various types like Article, Video, and Topic.
|
|
type InterfaceListFieldWithPointerTopicChildrenContent interface {
|
|
implementsGraphQLInterfaceInterfaceListFieldWithPointerTopicChildrenContent()
|
|
// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
|
|
GetTypename() string
|
|
// GetId returns the interface-field "id" from its implementation.
|
|
// The GraphQL interface field's documentation follows.
|
|
//
|
|
// ID is the identifier of the content.
|
|
GetId() testutil.ID
|
|
// GetName returns the interface-field "name" from its implementation.
|
|
GetName() string
|
|
}
|
|
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenArticle) implementsGraphQLInterfaceInterfaceListFieldWithPointerTopicChildrenContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenArticle) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenArticle) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenArticle) GetName() string { return v.Name }
|
|
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenVideo) implementsGraphQLInterfaceInterfaceListFieldWithPointerTopicChildrenContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenVideo) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenVideo) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenVideo) GetName() string { return v.Name }
|
|
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenTopic) implementsGraphQLInterfaceInterfaceListFieldWithPointerTopicChildrenContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenTopic) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenTopic) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface InterfaceListFieldWithPointerTopicChildrenContent.
|
|
func (v *InterfaceListFieldWithPointerTopicChildrenTopic) GetName() string { return v.Name }
|
|
|
|
func __unmarshalInterfaceListFieldWithPointerTopicChildrenContent(v *InterfaceListFieldWithPointerTopicChildrenContent, m json.RawMessage) error {
|
|
if string(m) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var tn struct {
|
|
TypeName string `json:"__typename"`
|
|
}
|
|
err := json.Unmarshal(m, &tn)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
switch tn.TypeName {
|
|
case "Article":
|
|
*v = new(InterfaceListFieldWithPointerTopicChildrenArticle)
|
|
return json.Unmarshal(m, *v)
|
|
case "Video":
|
|
*v = new(InterfaceListFieldWithPointerTopicChildrenVideo)
|
|
return json.Unmarshal(m, *v)
|
|
case "Topic":
|
|
*v = new(InterfaceListFieldWithPointerTopicChildrenTopic)
|
|
return json.Unmarshal(m, *v)
|
|
case "":
|
|
return fmt.Errorf(
|
|
"Response was missing Content.__typename")
|
|
default:
|
|
return fmt.Errorf(
|
|
`Unexpected concrete type for InterfaceListFieldWithPointerTopicChildrenContent: "%v"`, tn.TypeName)
|
|
}
|
|
}
|
|
|
|
// InterfaceListFieldWithPointerTopicChildrenTopic includes the requested fields of the GraphQL type Topic.
|
|
type InterfaceListFieldWithPointerTopicChildrenTopic struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// InterfaceListFieldWithPointerTopicChildrenVideo includes the requested fields of the GraphQL type Video.
|
|
type InterfaceListFieldWithPointerTopicChildrenVideo struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
func InterfaceListField(
|
|
client graphql.Client,
|
|
) (*InterfaceListFieldResponse, error) {
|
|
var err error
|
|
|
|
var retval InterfaceListFieldResponse
|
|
err = client.MakeRequest(
|
|
nil,
|
|
"InterfaceListField",
|
|
`
|
|
query InterfaceListField {
|
|
root {
|
|
id
|
|
name
|
|
children {
|
|
__typename
|
|
id
|
|
name
|
|
}
|
|
}
|
|
withPointer: root {
|
|
id
|
|
name
|
|
children {
|
|
__typename
|
|
id
|
|
name
|
|
}
|
|
}
|
|
}
|
|
`,
|
|
&retval,
|
|
nil,
|
|
)
|
|
return &retval, err
|
|
}
|
|
|