Add getter methods to all fields, not just where needed (#126)
## Summary: If your type implements an interface, we add getter methods for the shared fields, so that those may be accessed via the interface. But it turns out occasionally it's useful to have these getter methods when they don't implement a GraphQL interface, so you can use two genqlient-generated types in the same function if they have the same fields. (This comes up most often when you have a GraphQL union that maybe should really be an interface, or if you don't yet support interfaces implementing other interfaces (indeed our parser doesn't either). But one can imagine other use cases.) We can't predict how you want to do that, so we can't generate the interface, but we can generate the methods, so you can define the interface and do a type assertion from there. Since these methods are pretty simple to generate, we just do it always. (As with #120, if binary size becomes an issue we could later add an option to only generate methods that are truly needed but including them seems like the better default.) This also fixes a subtle and rare bug, which would have become much more common (indeed existing tests caught it). Specifically, if you have a query like ```graphql fragment FragmentOne on T { id } fragment FragmentTwo on T { id } query Q { f { # interface type T ...FragmentOne ...FragmentTwo } } ``` since both `FragmentOne` and `FragmentTwo` request some common field, say `id`, we generate a method `GetId` on each one. But since `FragmentOne` and `FragmentTwo` are both on `T`, we also include their interfaces in the interface we generate for the type of `f`, `QFT`. So `QFT` includes a method `GetId`. But on the implementations, the two methods conflict, and neither gets promoted; this causes various code to fail to compile. With this change, this would have happened much more frequently -- even if only one of the two fragments is on `T`, as long as both request the field. Anyway, we now generate explicit methods on each struct for all of its recursively emebedded fields -- using the logic from #120 to compute them -- so that we don't need to rely on method-promotion. ## Test plan: make tesc 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/126
This commit is contained in:
+54
@@ -23,6 +23,18 @@ type OmitEmptyQueryResponse struct {
|
||||
Convert2 time.Time `json:"convert2"`
|
||||
}
|
||||
|
||||
// GetUser returns OmitEmptyQueryResponse.User, and is useful for accessing the field via an interface.
|
||||
func (v *OmitEmptyQueryResponse) GetUser() OmitEmptyQueryUser { return v.User }
|
||||
|
||||
// GetUsers returns OmitEmptyQueryResponse.Users, and is useful for accessing the field via an interface.
|
||||
func (v *OmitEmptyQueryResponse) GetUsers() []OmitEmptyQueryUsersUser { return v.Users }
|
||||
|
||||
// GetMaybeConvert returns OmitEmptyQueryResponse.MaybeConvert, and is useful for accessing the field via an interface.
|
||||
func (v *OmitEmptyQueryResponse) GetMaybeConvert() time.Time { return v.MaybeConvert }
|
||||
|
||||
// GetConvert2 returns OmitEmptyQueryResponse.Convert2, and is useful for accessing the field via an interface.
|
||||
func (v *OmitEmptyQueryResponse) GetConvert2() time.Time { return v.Convert2 }
|
||||
|
||||
// OmitEmptyQueryUser includes the requested fields of the GraphQL type User.
|
||||
// The GraphQL type's documentation follows.
|
||||
//
|
||||
@@ -34,6 +46,9 @@ type OmitEmptyQueryUser struct {
|
||||
Id testutil.ID `json:"id"`
|
||||
}
|
||||
|
||||
// GetId returns OmitEmptyQueryUser.Id, and is useful for accessing the field via an interface.
|
||||
func (v *OmitEmptyQueryUser) GetId() testutil.ID { return v.Id }
|
||||
|
||||
// OmitEmptyQueryUsersUser includes the requested fields of the GraphQL type User.
|
||||
// The GraphQL type's documentation follows.
|
||||
//
|
||||
@@ -45,6 +60,9 @@ type OmitEmptyQueryUsersUser struct {
|
||||
Id testutil.ID `json:"id"`
|
||||
}
|
||||
|
||||
// GetId returns OmitEmptyQueryUsersUser.Id, and is useful for accessing the field via an interface.
|
||||
func (v *OmitEmptyQueryUsersUser) GetId() testutil.ID { return v.Id }
|
||||
|
||||
// Role is a type a user may have.
|
||||
type Role string
|
||||
|
||||
@@ -75,6 +93,27 @@ type UserQueryInput struct {
|
||||
Birthdate time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// GetEmail returns UserQueryInput.Email, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetEmail() string { return v.Email }
|
||||
|
||||
// GetName returns UserQueryInput.Name, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetName() string { return v.Name }
|
||||
|
||||
// GetId returns UserQueryInput.Id, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetId() testutil.ID { return v.Id }
|
||||
|
||||
// GetRole returns UserQueryInput.Role, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetRole() Role { return v.Role }
|
||||
|
||||
// GetNames returns UserQueryInput.Names, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetNames() []string { return v.Names }
|
||||
|
||||
// GetHasPokemon returns UserQueryInput.HasPokemon, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetHasPokemon() testutil.Pokemon { return v.HasPokemon }
|
||||
|
||||
// GetBirthdate returns UserQueryInput.Birthdate, and is useful for accessing the field via an interface.
|
||||
func (v *UserQueryInput) GetBirthdate() time.Time { return v.Birthdate }
|
||||
|
||||
func (v *UserQueryInput) UnmarshalJSON(b []byte) error {
|
||||
|
||||
if string(b) == "null" {
|
||||
@@ -165,6 +204,21 @@ type __OmitEmptyQueryInput struct {
|
||||
TzNoOmitEmpty string `json:"tzNoOmitEmpty"`
|
||||
}
|
||||
|
||||
// GetQuery returns __OmitEmptyQueryInput.Query, and is useful for accessing the field via an interface.
|
||||
func (v *__OmitEmptyQueryInput) GetQuery() UserQueryInput { return v.Query }
|
||||
|
||||
// GetQueries returns __OmitEmptyQueryInput.Queries, and is useful for accessing the field via an interface.
|
||||
func (v *__OmitEmptyQueryInput) GetQueries() []UserQueryInput { return v.Queries }
|
||||
|
||||
// GetDt returns __OmitEmptyQueryInput.Dt, and is useful for accessing the field via an interface.
|
||||
func (v *__OmitEmptyQueryInput) GetDt() time.Time { return v.Dt }
|
||||
|
||||
// GetTz returns __OmitEmptyQueryInput.Tz, and is useful for accessing the field via an interface.
|
||||
func (v *__OmitEmptyQueryInput) GetTz() string { return v.Tz }
|
||||
|
||||
// GetTzNoOmitEmpty returns __OmitEmptyQueryInput.TzNoOmitEmpty, and is useful for accessing the field via an interface.
|
||||
func (v *__OmitEmptyQueryInput) GetTzNoOmitEmpty() string { return v.TzNoOmitEmpty }
|
||||
|
||||
func OmitEmptyQuery(
|
||||
client graphql.Client,
|
||||
query UserQueryInput,
|
||||
|
||||
Reference in New Issue
Block a user