Add support for interfaces, part 4: getter methods (#57)
## Summary:
Right now, if you make a query like `{ myInterface { field } }`, you
have to type-switch on all the possible implementations of `myInterface`
to get at `field`. Now, we generate getter-methods (e.g. `GetField`),
to make that access easier. Of course this only applies to shared
fields (which for now are the only ones, but once we support fragments
will no longer be).
This also includes a small change to the way we generate type-names for
interfaces: we no longer include the name of the concrete type in the
interface we propagate forward, so we generate
`MyInterfaceMyFieldMyType`, not `MyInterfaceMyImplMyFieldMyType`, in the
case where you have an interface `MyInterface` implemented by `MyImpl`
(and maybe other types) with field `myField: MyType`. This is necessary
so the getter method returns a well-defined type, and also probably
convenient for calling code. It will have to get a little bit more
complicated once we support fragments, where you could have two
implementing types with identically-named fields of different types, but
I think it'll be easiest to figure out how to deal with that when
implementing fragments.
While I was in the area, I added to the interface doc-comment a list of
the implementations. (In GraphQL, we're guaranteed to know them all
assuming our schema is up to date.)
Issue: https://github.com/Khan/genqlient/issues/8
## Test plan:
make check
Author: benjaminjkraft
Reviewers: benjaminjkraft, dnerdy, aberkan, MiguelCastillo
Required Reviewers:
Approved by: dnerdy
Checks: ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Test (1.13), ✅ Lint, ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Test (1.13), ✅ Lint
Pull request URL: https://github.com/Khan/genqlient/pull/57
This commit is contained in:
@@ -71,9 +71,18 @@ func TestInterfaceNoFragments(t *testing.T) {
|
||||
resp, err := queryWithInterfaceNoFragments(ctx, client, "1")
|
||||
require.NoError(t, err)
|
||||
|
||||
// We should get the following response:
|
||||
// me: User{Id: 1, Name: "Yours Truly"},
|
||||
// being: User{Id: 1, Name: "Yours Truly"},
|
||||
|
||||
assert.Equal(t, "1", resp.Me.Id)
|
||||
assert.Equal(t, "Yours Truly", resp.Me.Name)
|
||||
|
||||
// Check fields both via interface and via type-assertion:
|
||||
assert.Equal(t, "User", resp.Being.GetTypename())
|
||||
assert.Equal(t, "1", resp.Being.GetId())
|
||||
assert.Equal(t, "Yours Truly", resp.Being.GetName())
|
||||
|
||||
user, ok := resp.Being.(*queryWithInterfaceNoFragmentsBeingUser)
|
||||
require.Truef(t, ok, "got %T, not User", resp.Being)
|
||||
assert.Equal(t, "1", user.Id)
|
||||
@@ -82,9 +91,17 @@ func TestInterfaceNoFragments(t *testing.T) {
|
||||
resp, err = queryWithInterfaceNoFragments(ctx, client, "3")
|
||||
require.NoError(t, err)
|
||||
|
||||
// We should get the following response:
|
||||
// me: User{Id: 1, Name: "Yours Truly"},
|
||||
// being: Animal{Id: 3, Name: "Fido"},
|
||||
|
||||
assert.Equal(t, "1", resp.Me.Id)
|
||||
assert.Equal(t, "Yours Truly", resp.Me.Name)
|
||||
|
||||
assert.Equal(t, "Animal", resp.Being.GetTypename())
|
||||
assert.Equal(t, "3", resp.Being.GetId())
|
||||
assert.Equal(t, "Fido", resp.Being.GetName())
|
||||
|
||||
animal, ok := resp.Being.(*queryWithInterfaceNoFragmentsBeingAnimal)
|
||||
require.Truef(t, ok, "got %T, not Animal", resp.Being)
|
||||
assert.Equal(t, "3", animal.Id)
|
||||
@@ -93,6 +110,10 @@ func TestInterfaceNoFragments(t *testing.T) {
|
||||
resp, err = queryWithInterfaceNoFragments(ctx, client, "4757233945723")
|
||||
require.NoError(t, err)
|
||||
|
||||
// We should get the following response:
|
||||
// me: User{Id: 1, Name: "Yours Truly"},
|
||||
// being: null
|
||||
|
||||
assert.Equal(t, "1", resp.Me.Id)
|
||||
assert.Equal(t, "Yours Truly", resp.Me.Name)
|
||||
|
||||
@@ -116,11 +137,25 @@ func TestInterfaceListField(t *testing.T) {
|
||||
|
||||
require.Len(t, resp.Beings, 3)
|
||||
|
||||
// We should get the following three beings:
|
||||
// User{Id: 1, Name: "Yours Truly"},
|
||||
// Animal{Id: 3, Name: "Fido"},
|
||||
// null
|
||||
|
||||
// Check fields both via interface and via type-assertion:
|
||||
assert.Equal(t, "User", resp.Beings[0].GetTypename())
|
||||
assert.Equal(t, "1", resp.Beings[0].GetId())
|
||||
assert.Equal(t, "Yours Truly", resp.Beings[0].GetName())
|
||||
|
||||
user, ok := resp.Beings[0].(*queryWithInterfaceListFieldBeingsUser)
|
||||
require.Truef(t, ok, "got %T, not User", resp.Beings[0])
|
||||
assert.Equal(t, "1", user.Id)
|
||||
assert.Equal(t, "Yours Truly", user.Name)
|
||||
|
||||
assert.Equal(t, "Animal", resp.Beings[1].GetTypename())
|
||||
assert.Equal(t, "3", resp.Beings[1].GetId())
|
||||
assert.Equal(t, "Fido", resp.Beings[1].GetName())
|
||||
|
||||
animal, ok := resp.Beings[1].(*queryWithInterfaceListFieldBeingsAnimal)
|
||||
require.Truef(t, ok, "got %T, not Animal", resp.Beings[1])
|
||||
assert.Equal(t, "3", animal.Id)
|
||||
@@ -149,11 +184,20 @@ func TestInterfaceListPointerField(t *testing.T) {
|
||||
|
||||
require.Len(t, resp.Beings, 3)
|
||||
|
||||
// Check fields both via interface and via type-assertion:
|
||||
assert.Equal(t, "User", (*resp.Beings[0]).GetTypename())
|
||||
assert.Equal(t, "1", (*resp.Beings[0]).GetId())
|
||||
assert.Equal(t, "Yours Truly", (*resp.Beings[0]).GetName())
|
||||
|
||||
user, ok := (*resp.Beings[0]).(*queryWithInterfaceListPointerFieldBeingsUser)
|
||||
require.Truef(t, ok, "got %T, not User", resp.Beings[0])
|
||||
require.Truef(t, ok, "got %T, not User", (*resp.Beings[0]))
|
||||
assert.Equal(t, "1", user.Id)
|
||||
assert.Equal(t, "Yours Truly", user.Name)
|
||||
|
||||
assert.Equal(t, "Animal", (*resp.Beings[1]).GetTypename())
|
||||
assert.Equal(t, "3", (*resp.Beings[1]).GetId())
|
||||
assert.Equal(t, "Fido", (*resp.Beings[1]).GetName())
|
||||
|
||||
animal, ok := (*resp.Beings[1]).(*queryWithInterfaceListPointerFieldBeingsAnimal)
|
||||
require.Truef(t, ok, "got %T, not Animal", resp.Beings[1])
|
||||
assert.Equal(t, "3", animal.Id)
|
||||
|
||||
Reference in New Issue
Block a user