Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Optionally render entity requires populator function for advanced @requires use cases #2884

Merged
merged 14 commits into from
Feb 23, 2024
Merged

Optionally render entity requires populator function for advanced @requires use cases #2884

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1c6e304
Adding generation of new functions to populate requires representatio…
mentat Jun 13, 2023
05a4d81
Something.
mentat Jan 18, 2024
f6e0185
Merge from master.
mentat Jan 18, 2024
a6fd6b8
Adding config option for Package to allow for enabling flags. Added …
mentat Jan 18, 2024
d4df245
Adding fixed by @ldebruijn.
mentat Jan 18, 2024
e137fec
Adding explicit requires testsing and make requires follow federation…
mentat Jan 23, 2024
90a143f
Fix test failure.
mentat Jan 23, 2024
4044c5e
Using embeded template like federation gotpl. Fix rewriter not using…
mentat Jan 23, 2024
90fa40f
Update generated code.
mentat Jan 23, 2024
6dd1290
Docs (#1)
brh55 Jan 25, 2024
c19c948
Adding ordering fix.
mentat Feb 21, 2024
c410e1b
Merge branch 'master' of github.com:jesse-apollo/gqlgen
mentat Feb 21, 2024
9ada2e2
Merge branch '99designs:master' into master
jesse-apollo Feb 21, 2024
c839ad5
Regenerate.
mentat Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion plugin/federation/federation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ func (f *federation) GenerateCode(data *codegen.Data) error {
return err
}

requiresFile := data.Config.Resolver.Dir() + "/federation.requires.go"
requiresFile := data.Config.Federation.Dir() + "/federation.requires.go"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ldebruijn I've reverted this from your proposed change as it breaks the implementation and the test code generation.

existingImports := rewriter.ExistingImports(requiresFile)
for _, imp := range existingImports {
if imp.Alias == "" {
Expand Down
261 changes: 261 additions & 0 deletions plugin/federation/federation_explicitrequires_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
//go:generate go run ../../testdata/gqlgen.go -config testdata/explicitrequires/gqlgen.yml
package federation

import (
"testing"

"github.com/stretchr/testify/require"

"github.com/99designs/gqlgen/client"
"github.com/99designs/gqlgen/graphql/handler"
"github.com/99designs/gqlgen/plugin/federation/testdata/explicitrequires"
"github.com/99designs/gqlgen/plugin/federation/testdata/explicitrequires/generated"
)

func TestExplicitRequires(t *testing.T) {
c := client.New(handler.NewDefaultServer(
generated.NewExecutableSchema(generated.Config{
Resolvers: &explicitrequires.Resolver{},
}),
))

t.Run("PlanetRequires entities with requires directive", func(t *testing.T) {
representations := []map[string]interface{}{
{
"__typename": "PlanetRequires",
"name": "earth",
"diameter": 12,
}, {
"__typename": "PlanetRequires",
"name": "mars",
"diameter": 10,
},
}

var resp struct {
Entities []struct {
Name string `json:"name"`
Diameter int `json:"diameter"`
} `json:"_entities"`
}

err := c.Post(
entityQuery([]string{
"PlanetRequires {name, diameter}",
}),
&resp,
client.Var("representations", representations),
)

require.NoError(t, err)
require.Equal(t, resp.Entities[0].Name, "earth")
require.Equal(t, resp.Entities[0].Diameter, 12)
require.Equal(t, resp.Entities[1].Name, "mars")
require.Equal(t, resp.Entities[1].Diameter, 10)
})

t.Run("PlanetRequires entities with multiple required fields directive", func(t *testing.T) {
representations := []map[string]interface{}{
{
"__typename": "PlanetMultipleRequires",
"name": "earth",
"density": 800,
"diameter": 12,
}, {
"__typename": "PlanetMultipleRequires",
"name": "mars",
"density": 850,
"diameter": 10,
},
}

var resp struct {
Entities []struct {
Name string `json:"name"`
Density int `json:"density"`
Diameter int `json:"diameter"`
} `json:"_entities"`
}

err := c.Post(
entityQuery([]string{
"PlanetMultipleRequires {name, diameter, density}",
}),
&resp,
client.Var("representations", representations),
)

require.NoError(t, err)
require.Equal(t, resp.Entities[0].Name, "earth")
require.Equal(t, resp.Entities[0].Diameter, 12)
require.Equal(t, resp.Entities[0].Density, 800)
require.Equal(t, resp.Entities[1].Name, "mars")
require.Equal(t, resp.Entities[1].Diameter, 10)
require.Equal(t, resp.Entities[1].Density, 850)
})

t.Run("PlanetRequiresNested entities with requires directive having nested field", func(t *testing.T) {
representations := []map[string]interface{}{
{
"__typename": "PlanetRequiresNested",
"name": "earth",
"world": map[string]interface{}{
"foo": "A",
},
}, {
"__typename": "PlanetRequiresNested",
"name": "mars",
"world": map[string]interface{}{
"foo": "B",
},
},
}

var resp struct {
Entities []struct {
Name string `json:"name"`
World struct {
Foo string `json:"foo"`
} `json:"world"`
} `json:"_entities"`
}

err := c.Post(
entityQuery([]string{
"PlanetRequiresNested {name, world { foo }}",
}),
&resp,
client.Var("representations", representations),
)

require.NoError(t, err)
require.Equal(t, resp.Entities[0].Name, "earth")
require.Equal(t, resp.Entities[0].World.Foo, "A")
require.Equal(t, resp.Entities[1].Name, "mars")
require.Equal(t, resp.Entities[1].World.Foo, "B")
})
}

func TestMultiExplicitRequires(t *testing.T) {
c := client.New(handler.NewDefaultServer(
generated.NewExecutableSchema(generated.Config{
Resolvers: &explicitrequires.Resolver{},
}),
))

t.Run("MultiHelloRequires entities with requires directive", func(t *testing.T) {
representations := []map[string]interface{}{
{
"__typename": "MultiHelloRequires",
"name": "first name - 1",
"key1": "key1 - 1",
}, {
"__typename": "MultiHelloRequires",
"name": "first name - 2",
"key1": "key1 - 2",
},
}

var resp struct {
Entities []struct {
Name string `json:"name"`
Key1 string `json:"key1"`
} `json:"_entities"`
}

err := c.Post(
entityQuery([]string{
"MultiHelloRequires {name, key1}",
}),
&resp,
client.Var("representations", representations),
)

require.NoError(t, err)
require.Equal(t, resp.Entities[0].Name, "first name - 1")
require.Equal(t, resp.Entities[0].Key1, "key1 - 1")
require.Equal(t, resp.Entities[1].Name, "first name - 2")
require.Equal(t, resp.Entities[1].Key1, "key1 - 2")
})

t.Run("MultiHelloMultipleRequires entities with multiple required fields", func(t *testing.T) {
representations := []map[string]interface{}{
{
"__typename": "MultiHelloMultipleRequires",
"name": "first name - 1",
"key1": "key1 - 1",
"key2": "key2 - 1",
}, {
"__typename": "MultiHelloMultipleRequires",
"name": "first name - 2",
"key1": "key1 - 2",
"key2": "key2 - 2",
},
}

var resp struct {
Entities []struct {
Name string `json:"name"`
Key1 string `json:"key1"`
Key2 string `json:"key2"`
} `json:"_entities"`
}

err := c.Post(
entityQuery([]string{
"MultiHelloMultipleRequires {name, key1, key2}",
}),
&resp,
client.Var("representations", representations),
)

require.NoError(t, err)
require.Equal(t, resp.Entities[0].Name, "first name - 1")
require.Equal(t, resp.Entities[0].Key1, "key1 - 1")
require.Equal(t, resp.Entities[0].Key2, "key2 - 1")
require.Equal(t, resp.Entities[1].Name, "first name - 2")
require.Equal(t, resp.Entities[1].Key1, "key1 - 2")
require.Equal(t, resp.Entities[1].Key2, "key2 - 2")
})

t.Run("MultiPlanetRequiresNested entities with requires directive having nested field", func(t *testing.T) {
representations := []map[string]interface{}{
{
"__typename": "MultiPlanetRequiresNested",
"name": "earth",
"world": map[string]interface{}{
"foo": "A",
},
}, {
"__typename": "MultiPlanetRequiresNested",
"name": "mars",
"world": map[string]interface{}{
"foo": "B",
},
},
}

var resp struct {
Entities []struct {
Name string `json:"name"`
World struct {
Foo string `json:"foo"`
} `json:"world"`
} `json:"_entities"`
}

err := c.Post(
entityQuery([]string{
"MultiPlanetRequiresNested {name, world { foo }}",
}),
&resp,
client.Var("representations", representations),
)

require.NoError(t, err)
require.Equal(t, resp.Entities[0].Name, "earth")
require.Equal(t, resp.Entities[0].World.Foo, "A")
require.Equal(t, resp.Entities[1].Name, "mars")
require.Equal(t, resp.Entities[1].World.Foo, "B")
})
}
Loading