Files
genqlient/generate/testdata/queries/schema.graphql
T
Ben KraftandGitHub c6d087c29b Add support for "flattening" fragment-spreads (#121)
## Summary:
One common use of fragment spreads is as the entirety of a field's
selection, e.g.
```graphql
query MyQuery {
  myField {
    ...MyFragment
  }
}
```
In this case, by default, genqlient generates a wrapper type
`MyQueryMyFieldMyType`, which just embeds `MyFragment`.  This makes
sense if you later want to add more fields in addition to the fragment
spread.  But if you don't -- and you did the fragment because you want
to share types, it's an extra layer of indirection.  (Which becomes
especially onerous if `myField` has list type (`[MyType!]`), such that
it's not just an extra attribute-access to get to `MyFragment`.)

The new option `# @genqlient(flatten: true)` simplifies this situation:
if applied to `myField` is skips the wrapper type;
`MyQueryResponse.MyField` will simply have type `MyFragment` (or
`[]MyFragment`, or whatever).  This should hopefully make the `typename`
option, which has more limitations, less necessary.

Note that in #30 the initial idea was to support this for fields as
well.  This would require significant additional complexity in the
JSON-(un)marshaling code, and has proven less necessary, so I
implemented this option only for fragment-spreads for now.  With that
restriction, it was shockingly simple; we have to hook into a bunch of
different places, but they're all quite simple, since the structure of
the Go types still matches the structure in GraphQL.

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

## Test plan:
make check


Author: benjaminjkraft

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

Required Reviewers: 

Approved By: csilvers, 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/121
2021-09-29 17:52:06 -07:00

180 lines
4.1 KiB
GraphQL

"""DateTime is a scalar.
We don't really have anything useful to do with this description though.
"""
scalar DateTime
scalar Date
scalar Junk
scalar ComplexJunk
"""Role is a type a user may have."""
enum Role {
"""What is a student?
A student is primarily a person enrolled in a school or other educational institution and who is under learning with goals of acquiring knowledge, developing professions and achieving employment at desired field. In the broader sense, a student is anyone who applies themselves to the intensive intellectual engagement with some matter necessary to master it as part of some practical affair in which such mastery is basic or decisive.
(from [Wikipedia](https://en.wikipedia.org/wiki/Student))
"""
STUDENT
"""Teacher is a teacher, who teaches the students."""
TEACHER
}
input PokemonInput {
species: String!
level: Int!
}
type Pokemon {
species: String!
level: Int!
}
"""UserQueryInput is the argument to Query.users.
Ideally this would support anything and everything!
Or maybe ideally it wouldn't.
Really I'm just talking to make this documentation longer.
"""
input UserQueryInput {
email: String
name: String
"""id looks the user up by ID. It's a great way to look up users."""
id: ID
role: Role
names: [String]
hasPokemon: PokemonInput
birthdate: Date
}
type AuthMethod {
provider: String
email: String
}
"""A User is a user!"""
type User {
"""id is the user's ID.
It is stable, unique, and opaque, like all good IDs."""
id: ID!
roles: [Role!]
name: String
emails: [String!]!
emailsOrNull: [String!]
emailsWithNulls: [String]!
emailsWithNullsOrNull: [String]
authMethods: [AuthMethod!]!
pokemon: [Pokemon!]
greeting: Clip
birthdate: Date
}
"""An audio clip, such as of a user saying hello."""
type Clip implements HasDuration {
id: ID!
duration: Int!
}
"""Content is implemented by various types like Article, Video, and Topic."""
interface Content {
"""ID is the identifier of the content."""
id: ID!
name: String!
parent: Topic
url: String!
}
"""An object with a duration, like a video."""
interface HasDuration {
duration: Int!
}
"""LeafContent represents content items that can't have child-nodes."""
union LeafContent = Article | Video
type Article implements Content {
"""ID is documented in the Content interface."""
id: ID!
name: String!
parent: Topic!
url: String!
text: String!
thumbnail: StuffThumbnail
}
type StuffThumbnail { # for articles, but let's give the name-generator a hard time.
id: ID!
thumbnailUrl: String!
}
type Video implements Content & HasDuration {
"""ID is documented in the Content interface."""
id: ID!
name: String!
parent: Topic!
url: String!
duration: Int!
thumbnail: Thumbnail
}
type Thumbnail { # for videos, but let's give the name-generator a hard time.
id: ID!
timestampSec: Int!
}
type Topic implements Content {
"""ID is documented in the Content interface."""
id: ID!
name: String!
parent: Topic
url: String!
children: [Content!]!
videoChildren: [Video!]!
schoolGrade: String
}
input RecursiveInput {
rec: [RecursiveInput]
}
type Recursive {
id: ID!
rec: Recursive
}
"""Query's description is probably ignored by almost all callers."""
type Query {
"""user looks up a user by some stuff.
See UserQueryInput for what stuff is supported.
If query is null, returns the current user.
"""
user(query: UserQueryInput): User
users(query: [UserQueryInput]): [User]
"""usersWithRole looks a user up by role."""
usersWithRole(role: Role!): [User!]!
usersBornOn(date: Date!): [User!]!
root: Topic!
randomItem: Content!
randomLeaf: LeafContent!
randomVideo: Video!
convert(dt: DateTime!, tz: String): DateTime!
maybeConvert(dt: DateTime, tz: String): DateTime
getJunk: Junk
getComplexJunk: ComplexJunk
listOfListsOfLists: [[[String!]!]!]!
listOfListsOfListsOfContent: [[[Content!]!]!]!
recur(input: RecursiveInput!): Recursive
acceptsListOfListOfListsOfDates(datesss: [[[Date!]!]!]!): Boolean
}
type Mutation {
createUser(name: String!, email: String): User
}