## Summary: When genqlient generates output types, it generates whatever code is necessary to unmarshal them. Conversely, when it generates input types, it generates whatever code is necessary to marshal. This is all that's needed for genqlient itself: it never needs to marshal output types or unmarshal input types. But maybe you do! (For example, to put the responses in a cache, which is the use case that @csilvers hit at Khan, although there are others one can imagine.) While we can't support every serialization format you might want (at least not without adding plugins or some such), it's not unreasonable to expect that since genqlient can read JSON, it can write it too. Sadly, in the past this was not true for types requiring custom unmarshaling logic, for several reasons. In this commit I implement logic to always write both marshalers and unmarshalers whenever they're needed to be able to correctly round-trip the types, even though genqlient doesn't do so. I wasn't starting from scratch, since of course we already write both marshalers and unmarshalers in some cases. But this ended up requiring surprisingly large changes on the marshaling side, mostly to correctly support embedding (which we use for named fragments). Specifically, as the comments in `types.go` discuss, the most difficult issue is spreads with duplicate fields, which translate to Go embedded fields which end up hidden from the json-marshaler. Ultimately, I had to do things quite differently from unmarshaling, and essentially flatten the type when we write marshaler. But in the end it's not so ugly -- indeed arguably it's cleaner! Mainly it's just different. One thing to note is that we do marshal `__typename` based on what we know about the types; users need not fill it in (and if they do we'll ignore it). This seemed to me to be a better UX, and didn't add much complexity. In general, I begin to wonder whether using `encoding/json` at all is really right for genqlient: we're doing a lot of work to appease it, despite knowing what our types look like. I think it would still be a significant increase in lines of code to roll our own, but that code would perhaps be simpler, and would surely be faster (although if we just want the speed gains we could use another JSON-generator library, see also #47). Anyway, something to think about in the future. ## Test plan: make tesc Author: benjaminjkraft Reviewers: csilvers, StevenACoffman, benjaminjkraft, dnerdy, aberkan, jvoll, mahtabsabet, MiguelCastillo Required Reviewers: Approved By: StevenACoffman, dnerdy 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/120
534 lines
15 KiB
Go
534 lines
15 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"
|
|
)
|
|
|
|
// SimpleNamedFragmentRandomItemArticle includes the requested fields of the GraphQL type Article.
|
|
type SimpleNamedFragmentRandomItemArticle struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// SimpleNamedFragmentRandomItemContent includes the requested fields of the GraphQL interface Content.
|
|
//
|
|
// SimpleNamedFragmentRandomItemContent is implemented by the following types:
|
|
// SimpleNamedFragmentRandomItemArticle
|
|
// SimpleNamedFragmentRandomItemVideo
|
|
// SimpleNamedFragmentRandomItemTopic
|
|
// The GraphQL type's documentation follows.
|
|
//
|
|
// Content is implemented by various types like Article, Video, and Topic.
|
|
type SimpleNamedFragmentRandomItemContent interface {
|
|
implementsGraphQLInterfaceSimpleNamedFragmentRandomItemContent()
|
|
// 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 *SimpleNamedFragmentRandomItemArticle) implementsGraphQLInterfaceSimpleNamedFragmentRandomItemContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemArticle) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemArticle) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemArticle) GetName() string { return v.Name }
|
|
|
|
func (v *SimpleNamedFragmentRandomItemVideo) implementsGraphQLInterfaceSimpleNamedFragmentRandomItemContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemVideo) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemVideo) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemVideo) GetName() string { return v.Name }
|
|
|
|
func (v *SimpleNamedFragmentRandomItemTopic) implementsGraphQLInterfaceSimpleNamedFragmentRandomItemContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemTopic) GetTypename() string { return v.Typename }
|
|
|
|
// GetId is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemTopic) GetId() testutil.ID { return v.Id }
|
|
|
|
// GetName is a part of, and documented with, the interface SimpleNamedFragmentRandomItemContent.
|
|
func (v *SimpleNamedFragmentRandomItemTopic) GetName() string { return v.Name }
|
|
|
|
func __unmarshalSimpleNamedFragmentRandomItemContent(b []byte, v *SimpleNamedFragmentRandomItemContent) error {
|
|
if string(b) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var tn struct {
|
|
TypeName string `json:"__typename"`
|
|
}
|
|
err := json.Unmarshal(b, &tn)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
switch tn.TypeName {
|
|
case "Article":
|
|
*v = new(SimpleNamedFragmentRandomItemArticle)
|
|
return json.Unmarshal(b, *v)
|
|
case "Video":
|
|
*v = new(SimpleNamedFragmentRandomItemVideo)
|
|
return json.Unmarshal(b, *v)
|
|
case "Topic":
|
|
*v = new(SimpleNamedFragmentRandomItemTopic)
|
|
return json.Unmarshal(b, *v)
|
|
case "":
|
|
return fmt.Errorf(
|
|
"Response was missing Content.__typename")
|
|
default:
|
|
return fmt.Errorf(
|
|
`Unexpected concrete type for SimpleNamedFragmentRandomItemContent: "%v"`, tn.TypeName)
|
|
}
|
|
}
|
|
|
|
func __marshalSimpleNamedFragmentRandomItemContent(v *SimpleNamedFragmentRandomItemContent) ([]byte, error) {
|
|
|
|
var typename string
|
|
switch v := (*v).(type) {
|
|
case *SimpleNamedFragmentRandomItemArticle:
|
|
typename = "Article"
|
|
|
|
result := struct {
|
|
TypeName string `json:"__typename"`
|
|
*SimpleNamedFragmentRandomItemArticle
|
|
}{typename, v}
|
|
return json.Marshal(result)
|
|
case *SimpleNamedFragmentRandomItemVideo:
|
|
typename = "Video"
|
|
|
|
premarshaled, err := v.__premarshalJSON()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
result := struct {
|
|
TypeName string `json:"__typename"`
|
|
*__premarshalSimpleNamedFragmentRandomItemVideo
|
|
}{typename, premarshaled}
|
|
return json.Marshal(result)
|
|
case *SimpleNamedFragmentRandomItemTopic:
|
|
typename = "Topic"
|
|
|
|
result := struct {
|
|
TypeName string `json:"__typename"`
|
|
*SimpleNamedFragmentRandomItemTopic
|
|
}{typename, v}
|
|
return json.Marshal(result)
|
|
case nil:
|
|
return []byte("null"), nil
|
|
default:
|
|
return nil, fmt.Errorf(
|
|
`Unexpected concrete type for SimpleNamedFragmentRandomItemContent: "%T"`, v)
|
|
}
|
|
}
|
|
|
|
// SimpleNamedFragmentRandomItemTopic includes the requested fields of the GraphQL type Topic.
|
|
type SimpleNamedFragmentRandomItemTopic struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// SimpleNamedFragmentRandomItemVideo includes the requested fields of the GraphQL type Video.
|
|
type SimpleNamedFragmentRandomItemVideo struct {
|
|
Typename string `json:"__typename"`
|
|
// ID is the identifier of the content.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
VideoFields `json:"-"`
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomItemVideo) UnmarshalJSON(b []byte) error {
|
|
|
|
if string(b) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var firstPass struct {
|
|
*SimpleNamedFragmentRandomItemVideo
|
|
graphql.NoUnmarshalJSON
|
|
}
|
|
firstPass.SimpleNamedFragmentRandomItemVideo = v
|
|
|
|
err := json.Unmarshal(b, &firstPass)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = json.Unmarshal(
|
|
b, &v.VideoFields)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type __premarshalSimpleNamedFragmentRandomItemVideo struct {
|
|
Typename string `json:"__typename"`
|
|
|
|
Id testutil.ID `json:"id"`
|
|
|
|
Name string `json:"name"`
|
|
|
|
Url string `json:"url"`
|
|
|
|
Duration int `json:"duration"`
|
|
|
|
Thumbnail VideoFieldsThumbnail `json:"thumbnail"`
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomItemVideo) MarshalJSON() ([]byte, error) {
|
|
premarshaled, err := v.__premarshalJSON()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return json.Marshal(premarshaled)
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomItemVideo) __premarshalJSON() (*__premarshalSimpleNamedFragmentRandomItemVideo, error) {
|
|
var retval __premarshalSimpleNamedFragmentRandomItemVideo
|
|
|
|
retval.Typename = v.Typename
|
|
retval.Id = v.Id
|
|
retval.Name = v.Name
|
|
retval.Url = v.VideoFields.Url
|
|
retval.Duration = v.VideoFields.Duration
|
|
retval.Thumbnail = v.VideoFields.Thumbnail
|
|
return &retval, nil
|
|
}
|
|
|
|
// SimpleNamedFragmentRandomLeafArticle includes the requested fields of the GraphQL type Article.
|
|
type SimpleNamedFragmentRandomLeafArticle struct {
|
|
Typename string `json:"__typename"`
|
|
}
|
|
|
|
// SimpleNamedFragmentRandomLeafLeafContent includes the requested fields of the GraphQL interface LeafContent.
|
|
//
|
|
// SimpleNamedFragmentRandomLeafLeafContent is implemented by the following types:
|
|
// SimpleNamedFragmentRandomLeafArticle
|
|
// SimpleNamedFragmentRandomLeafVideo
|
|
// The GraphQL type's documentation follows.
|
|
//
|
|
// LeafContent represents content items that can't have child-nodes.
|
|
type SimpleNamedFragmentRandomLeafLeafContent interface {
|
|
implementsGraphQLInterfaceSimpleNamedFragmentRandomLeafLeafContent()
|
|
// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
|
|
GetTypename() string
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomLeafArticle) implementsGraphQLInterfaceSimpleNamedFragmentRandomLeafLeafContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface SimpleNamedFragmentRandomLeafLeafContent.
|
|
func (v *SimpleNamedFragmentRandomLeafArticle) GetTypename() string { return v.Typename }
|
|
|
|
func (v *SimpleNamedFragmentRandomLeafVideo) implementsGraphQLInterfaceSimpleNamedFragmentRandomLeafLeafContent() {
|
|
}
|
|
|
|
// GetTypename is a part of, and documented with, the interface SimpleNamedFragmentRandomLeafLeafContent.
|
|
func (v *SimpleNamedFragmentRandomLeafVideo) GetTypename() string { return v.Typename }
|
|
|
|
func __unmarshalSimpleNamedFragmentRandomLeafLeafContent(b []byte, v *SimpleNamedFragmentRandomLeafLeafContent) error {
|
|
if string(b) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var tn struct {
|
|
TypeName string `json:"__typename"`
|
|
}
|
|
err := json.Unmarshal(b, &tn)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
switch tn.TypeName {
|
|
case "Article":
|
|
*v = new(SimpleNamedFragmentRandomLeafArticle)
|
|
return json.Unmarshal(b, *v)
|
|
case "Video":
|
|
*v = new(SimpleNamedFragmentRandomLeafVideo)
|
|
return json.Unmarshal(b, *v)
|
|
case "":
|
|
return fmt.Errorf(
|
|
"Response was missing LeafContent.__typename")
|
|
default:
|
|
return fmt.Errorf(
|
|
`Unexpected concrete type for SimpleNamedFragmentRandomLeafLeafContent: "%v"`, tn.TypeName)
|
|
}
|
|
}
|
|
|
|
func __marshalSimpleNamedFragmentRandomLeafLeafContent(v *SimpleNamedFragmentRandomLeafLeafContent) ([]byte, error) {
|
|
|
|
var typename string
|
|
switch v := (*v).(type) {
|
|
case *SimpleNamedFragmentRandomLeafArticle:
|
|
typename = "Article"
|
|
|
|
result := struct {
|
|
TypeName string `json:"__typename"`
|
|
*SimpleNamedFragmentRandomLeafArticle
|
|
}{typename, v}
|
|
return json.Marshal(result)
|
|
case *SimpleNamedFragmentRandomLeafVideo:
|
|
typename = "Video"
|
|
|
|
premarshaled, err := v.__premarshalJSON()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
result := struct {
|
|
TypeName string `json:"__typename"`
|
|
*__premarshalSimpleNamedFragmentRandomLeafVideo
|
|
}{typename, premarshaled}
|
|
return json.Marshal(result)
|
|
case nil:
|
|
return []byte("null"), nil
|
|
default:
|
|
return nil, fmt.Errorf(
|
|
`Unexpected concrete type for SimpleNamedFragmentRandomLeafLeafContent: "%T"`, v)
|
|
}
|
|
}
|
|
|
|
// SimpleNamedFragmentRandomLeafVideo includes the requested fields of the GraphQL type Video.
|
|
type SimpleNamedFragmentRandomLeafVideo struct {
|
|
Typename string `json:"__typename"`
|
|
VideoFields `json:"-"`
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomLeafVideo) UnmarshalJSON(b []byte) error {
|
|
|
|
if string(b) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var firstPass struct {
|
|
*SimpleNamedFragmentRandomLeafVideo
|
|
graphql.NoUnmarshalJSON
|
|
}
|
|
firstPass.SimpleNamedFragmentRandomLeafVideo = v
|
|
|
|
err := json.Unmarshal(b, &firstPass)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = json.Unmarshal(
|
|
b, &v.VideoFields)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type __premarshalSimpleNamedFragmentRandomLeafVideo struct {
|
|
Typename string `json:"__typename"`
|
|
|
|
Id testutil.ID `json:"id"`
|
|
|
|
Name string `json:"name"`
|
|
|
|
Url string `json:"url"`
|
|
|
|
Duration int `json:"duration"`
|
|
|
|
Thumbnail VideoFieldsThumbnail `json:"thumbnail"`
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomLeafVideo) MarshalJSON() ([]byte, error) {
|
|
premarshaled, err := v.__premarshalJSON()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return json.Marshal(premarshaled)
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentRandomLeafVideo) __premarshalJSON() (*__premarshalSimpleNamedFragmentRandomLeafVideo, error) {
|
|
var retval __premarshalSimpleNamedFragmentRandomLeafVideo
|
|
|
|
retval.Typename = v.Typename
|
|
retval.Id = v.VideoFields.Id
|
|
retval.Name = v.VideoFields.Name
|
|
retval.Url = v.VideoFields.Url
|
|
retval.Duration = v.VideoFields.Duration
|
|
retval.Thumbnail = v.VideoFields.Thumbnail
|
|
return &retval, nil
|
|
}
|
|
|
|
// SimpleNamedFragmentResponse is returned by SimpleNamedFragment on success.
|
|
type SimpleNamedFragmentResponse struct {
|
|
RandomItem SimpleNamedFragmentRandomItemContent `json:"-"`
|
|
RandomLeaf SimpleNamedFragmentRandomLeafLeafContent `json:"-"`
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentResponse) UnmarshalJSON(b []byte) error {
|
|
|
|
if string(b) == "null" {
|
|
return nil
|
|
}
|
|
|
|
var firstPass struct {
|
|
*SimpleNamedFragmentResponse
|
|
RandomItem json.RawMessage `json:"randomItem"`
|
|
RandomLeaf json.RawMessage `json:"randomLeaf"`
|
|
graphql.NoUnmarshalJSON
|
|
}
|
|
firstPass.SimpleNamedFragmentResponse = v
|
|
|
|
err := json.Unmarshal(b, &firstPass)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
{
|
|
dst := &v.RandomItem
|
|
src := firstPass.RandomItem
|
|
if len(src) != 0 && string(src) != "null" {
|
|
err = __unmarshalSimpleNamedFragmentRandomItemContent(
|
|
src, dst)
|
|
if err != nil {
|
|
return fmt.Errorf(
|
|
"Unable to unmarshal SimpleNamedFragmentResponse.RandomItem: %w", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
{
|
|
dst := &v.RandomLeaf
|
|
src := firstPass.RandomLeaf
|
|
if len(src) != 0 && string(src) != "null" {
|
|
err = __unmarshalSimpleNamedFragmentRandomLeafLeafContent(
|
|
src, dst)
|
|
if err != nil {
|
|
return fmt.Errorf(
|
|
"Unable to unmarshal SimpleNamedFragmentResponse.RandomLeaf: %w", err)
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type __premarshalSimpleNamedFragmentResponse struct {
|
|
RandomItem json.RawMessage `json:"randomItem"`
|
|
|
|
RandomLeaf json.RawMessage `json:"randomLeaf"`
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentResponse) MarshalJSON() ([]byte, error) {
|
|
premarshaled, err := v.__premarshalJSON()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return json.Marshal(premarshaled)
|
|
}
|
|
|
|
func (v *SimpleNamedFragmentResponse) __premarshalJSON() (*__premarshalSimpleNamedFragmentResponse, error) {
|
|
var retval __premarshalSimpleNamedFragmentResponse
|
|
|
|
{
|
|
|
|
dst := &retval.RandomItem
|
|
src := v.RandomItem
|
|
var err error
|
|
*dst, err = __marshalSimpleNamedFragmentRandomItemContent(
|
|
&src)
|
|
if err != nil {
|
|
return nil, fmt.Errorf(
|
|
"Unable to marshal SimpleNamedFragmentResponse.RandomItem: %w", err)
|
|
}
|
|
}
|
|
{
|
|
|
|
dst := &retval.RandomLeaf
|
|
src := v.RandomLeaf
|
|
var err error
|
|
*dst, err = __marshalSimpleNamedFragmentRandomLeafLeafContent(
|
|
&src)
|
|
if err != nil {
|
|
return nil, fmt.Errorf(
|
|
"Unable to marshal SimpleNamedFragmentResponse.RandomLeaf: %w", err)
|
|
}
|
|
}
|
|
return &retval, nil
|
|
}
|
|
|
|
// VideoFields includes the GraphQL fields of Video requested by the fragment VideoFields.
|
|
type VideoFields struct {
|
|
// ID is documented in the Content interface.
|
|
Id testutil.ID `json:"id"`
|
|
Name string `json:"name"`
|
|
Url string `json:"url"`
|
|
Duration int `json:"duration"`
|
|
Thumbnail VideoFieldsThumbnail `json:"thumbnail"`
|
|
}
|
|
|
|
// VideoFieldsThumbnail includes the requested fields of the GraphQL type Thumbnail.
|
|
type VideoFieldsThumbnail struct {
|
|
Id testutil.ID `json:"id"`
|
|
}
|
|
|
|
func SimpleNamedFragment(
|
|
client graphql.Client,
|
|
) (*SimpleNamedFragmentResponse, error) {
|
|
var err error
|
|
|
|
var retval SimpleNamedFragmentResponse
|
|
err = client.MakeRequest(
|
|
nil,
|
|
"SimpleNamedFragment",
|
|
`
|
|
query SimpleNamedFragment {
|
|
randomItem {
|
|
__typename
|
|
id
|
|
name
|
|
... VideoFields
|
|
}
|
|
randomLeaf {
|
|
__typename
|
|
... VideoFields
|
|
}
|
|
}
|
|
fragment VideoFields on Video {
|
|
id
|
|
name
|
|
url
|
|
duration
|
|
thumbnail {
|
|
id
|
|
}
|
|
}
|
|
`,
|
|
&retval,
|
|
nil,
|
|
)
|
|
return &retval, err
|
|
}
|
|
|