Ben Kraft
5995653583
## Summary: In this commit I refactor the argument-generation logic to move most of the code out of the template and into the type-generator. This logic predates #51, and I didn't think to update it there, but I think it benefits from similar treatment, for similar reasons. Specifically, the main change is to treat variables as another struct type we can generate, rather than handling them inline as a `map[string]interface{}`. Users still pass them the same way, but instead of putting them into a `map[string]interface{}` and JSONifying that, we generate a struct and put them there. This turns out to simplify things quite a lot, because we already have a lot of code to generate types. Notably, the omitempty code goes from a dozen lines to basically two, and fixes a bug (#43) in the process, because now that we have a struct, `json.Marshal` will do our work for us! (And, once we have syntax for it (#14), we'll be able to handle field-level omitempty basically for free.) More importantly, it will simplify custom marshalers (#38, forthcoming) significantly, since we do all that logic at the containing-struct level, but will need to apply it to arguments. It does require two breaking changes: 1. For folks implementing the `graphql.Client` API (rather than just calling `NewClient`): we now pass them variables as an `interface{}` rather than a `map[string]interface{}`. For most callers, including Khan/webapp, this is basically a one-line change to the signature of their `MakeRequest`, and it should be a lot more future-proof. 2. genqlient's handling of the `omitempty` option has changed to match that of `encoding/json`, in particular it now never considers structs "empty". The difference was never intentional (I just didn't realize that behavior of `encoding/json`); arguably our behavior was more useful but I think that's outweighed by the value of consistency with `encoding/json` as well as the simpler and more correct implementation (fixing #43 is actually quite nontrivial otherwise). Once we have custom unmarshaler support (#38), users will be able to map a zero value to JSON null if they wish, which is mostly if not entirely equivalent for GraphQL's purposes. Issue: https://github.com/Khan/genqlient/issues/38 Issue: https://github.com/Khan/genqlient/issues/43 ## Test plan: make check Author: benjaminjkraft Reviewers: StevenACoffman, 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, ✅ Lint, ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14) Pull Request URL: https://github.com/Khan/genqlient/pull/103
90 lines
2.5 KiB
Go
90 lines
2.5 KiB
Go
package test
|
|
|
|
// Code generated by github.com/Khan/genqlient, DO NOT EDIT.
|
|
|
|
import (
|
|
"github.com/Khan/genqlient/graphql"
|
|
"github.com/Khan/genqlient/internal/testutil"
|
|
)
|
|
|
|
// InputObjectQueryResponse is returned by InputObjectQuery on success.
|
|
type InputObjectQueryResponse struct {
|
|
// user looks up a user by some stuff.
|
|
//
|
|
// See UserQueryInput for what stuff is supported.
|
|
// If query is null, returns the current user.
|
|
User InputObjectQueryUser `json:"user"`
|
|
}
|
|
|
|
// InputObjectQueryUser includes the requested fields of the GraphQL type User.
|
|
// The GraphQL type's documentation follows.
|
|
//
|
|
// A User is a user!
|
|
type InputObjectQueryUser struct {
|
|
// id is the user's ID.
|
|
//
|
|
// It is stable, unique, and opaque, like all good IDs.
|
|
Id testutil.ID `json:"id"`
|
|
}
|
|
|
|
// Role is a type a user may have.
|
|
type Role string
|
|
|
|
const (
|
|
// 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))
|
|
RoleStudent Role = "STUDENT"
|
|
// Teacher is a teacher, who teaches the students.
|
|
RoleTeacher Role = "TEACHER"
|
|
)
|
|
|
|
// 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.
|
|
type UserQueryInput struct {
|
|
Email string `json:"email"`
|
|
Name string `json:"name"`
|
|
// id looks the user up by ID. It's a great way to look up users.
|
|
Id testutil.ID `json:"id"`
|
|
Role Role `json:"role"`
|
|
Names []string `json:"names"`
|
|
HasPokemon testutil.Pokemon `json:"hasPokemon"`
|
|
}
|
|
|
|
// __InputObjectQueryInput is used internally by genqlient
|
|
type __InputObjectQueryInput struct {
|
|
Query UserQueryInput `json:"query"`
|
|
}
|
|
|
|
func InputObjectQuery(
|
|
client graphql.Client,
|
|
query UserQueryInput,
|
|
) (*InputObjectQueryResponse, error) {
|
|
__input := __InputObjectQueryInput{
|
|
Query: query,
|
|
}
|
|
var err error
|
|
|
|
var retval InputObjectQueryResponse
|
|
err = client.MakeRequest(
|
|
nil,
|
|
"InputObjectQuery",
|
|
`
|
|
query InputObjectQuery ($query: UserQueryInput) {
|
|
user(query: $query) {
|
|
id
|
|
}
|
|
}
|
|
`,
|
|
&retval,
|
|
&__input,
|
|
)
|
|
return &retval, err
|
|
}
|
|
|