Files
genqlient/generate/testdata/queries/schema.graphql
T
Ben KraftandGitHub 520532eb65 Add tests to check that genqlient handles covariance (#203)
I didn't realize until today that implementations of GraphQL interfaces
are actually allowed to be covariant: if the interface has a field
`f: T`, then the implementations may have fields `f: U` where `U` is a
subtype of `T` (for example `U` may be an implementation of the
interface `T`, or `U` may be `T!` if `T` is non-nullable. (I thought it
had to be `f: T` exactly.) So I figured I'd add a test and see what
breaks.

Surprisingly, and despite the fact that Go interfaces do *not* allow
covariance, everything... worked? There's at least one place where it's
possible we could ideally use a more specific type [1], but for now I
just wanted to make sure we at least write something that builds and is
vaguely reasonable. Of course I'm not sure if there's anything I've
missed (some day I need to find a fuzzing engine that can fuzz GraphQL).

[1] Specifically, the field
`CovariantInterfaceImplementationRandomItemTopic.Next` might ideally
have type `...NextContentTopic`, not `...NextContent`; we know it's a
topic. This doesn't directly cause covariance problems in Go: the method
`GetNext` still returns `...NextContent` so the interface matches. But
that trick doesn't work for the sibling field `.Related` which is
slice-typed: or rather, we'd need the method to copy the slice to the
correct type. (Not to mention the implemention of any change here would
require a bunch of plumbing because the AST doesn't quite have what we
want.) So it's probably best to just keep this as-is for simplicity and
consistency.

Test plan: make check
2022-06-03 22:53:44 -07:00

188 lines
4.2 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!
next: Content
related: [Content!]
}
"""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
next: Content
related: [Content!]
}
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
next: Content
related: [Content!]
}
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
next: Topic
related: [Topic!]
}
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
}