Skip to content

fix: propagate fetch reasons for interface-related fields #1312

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

Merged
ysmolski merged 6 commits into from
Oct 9, 2025
+387 −25
Merged

fix: propagate fetch reasons for interface-related fields #1312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5a7ad58
draft the implementation for interfaces
ysmolski Oct 3, 2025
5889624
make first working version
ysmolski Oct 6, 2025
4689e83
deduplicate and merge propagated fetch reasons
ysmolski Oct 7, 2025
9667f9d
rename a var
ysmolski Oct 9, 2025
b605de8
Merge branch 'master' of github.com:wundergraph/graphql-go-tools into…
ysmolski Oct 9, 2025
7e9d0f2
sort and dedupe the BySubgraphs slice
ysmolski Oct 9, 2025
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
283 changes: 277 additions & 6 deletions execution/engine/execution_engine_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@ func TestExecutionEngine_Execute(t *testing.T) {
},
))

t.Run("execute simple hero operation with propagating to subgraphs fetch reasons", runWithoutError(
t.Run("operation on interface, subgraph expects fetch reasons for all implementing types", runWithoutError(
ExecutionEngineTestCase{
schema: graphql.StarwarsSchema(t),
operation: graphql.LoadStarWarsQuery(starwars.FileSimpleHeroQuery, nil),
Expand All @@ -854,23 +854,223 @@ func TestExecutionEngine_Execute(t *testing.T) {
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: `{"query":"{hero {name}}","extensions":{"fetch_reasons":[{"typename":"Character","field":"name","by_user":true},{"typename":"Query","field":"hero","by_user":true}]}}`,
expectedBody: `{"query":"{hero {name}}","extensions":{"fetch_reasons":[{"typename":"Character","field":"name","by_user":true},{"typename":"Droid","field":"name","by_user":true},{"typename":"Human","field":"name","by_user":true}]}}`,
sendResponseBody: `{"data":{"hero":{"name":"Luke Skywalker"}}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"hero"},
FetchReasonFields: []string{"hero"},
TypeName: "Query",
FieldNames: []string{"hero"},
},
{
TypeName: "Human",
FieldNames: []string{"name", "height", "friends"},
},
{
TypeName: "Droid",
FieldNames: []string{"name", "primaryFunctions", "friends"},
},
},
ChildNodes: []plan.TypeField{
{
TypeName: "Character",
FieldNames: []string{"name", "friends"},
// An interface field implicitly marks all the implementing types.
FetchReasonFields: []string{"name"},
},
},
},
mustConfiguration(t, graphql_datasource.ConfigurationInput{
Fetch: &graphql_datasource.FetchConfiguration{
URL: "https://example.com/",
Method: "POST",
},
SchemaConfiguration: mustSchemaConfig(
t,
nil,
string(graphql.StarwarsSchema(t).RawSchema()),
),
}),
),
},
fields: []plan.FieldConfiguration{},
expectedResponse: `{"data":{"hero":{"name":"Luke Skywalker"}}}`,
},
withFetchReasons(),
))

t.Run("operation on interface, subgraph expects fetch reasons for one implementing type", runWithoutError(
ExecutionEngineTestCase{
schema: graphql.StarwarsSchema(t),
operation: graphql.LoadStarWarsQuery(starwars.FileSimpleHeroQuery, nil),
dataSources: []plan.DataSource{
mustGraphqlDataSourceConfiguration(t,
"id",
mustFactory(t,
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: `{"query":"{hero {name}}","extensions":{"fetch_reasons":[{"typename":"Droid","field":"name","by_user":true}]}}`,
sendResponseBody: `{"data":{"hero":{"name":"Droid Number 6"}}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"hero"},
},
{
TypeName: "Human",
FieldNames: []string{"name", "height", "friends"},
},
{
TypeName: "Droid",
FieldNames: []string{"name", "primaryFunctions", "friends"},
// Only for this field propagate the fetch reasons,
// even if a user has asked for the interface in the query.
FetchReasonFields: []string{"name"},
},
},
ChildNodes: []plan.TypeField{
{
TypeName: "Character",
FieldNames: []string{"name", "friends"},
},
},
},
mustConfiguration(t, graphql_datasource.ConfigurationInput{
Fetch: &graphql_datasource.FetchConfiguration{
URL: "https://example.com/",
Method: "POST",
},
SchemaConfiguration: mustSchemaConfig(
t,
nil,
string(graphql.StarwarsSchema(t).RawSchema()),
),
}),
),
},
fields: []plan.FieldConfiguration{},
expectedResponse: `{"data":{"hero":{"name":"Droid Number 6"}}}`,
},
withFetchReasons(),
))

t.Run("operation on interface, interface and object marked, subgraph expects fetch reasons for one implementing type", runWithoutError(
ExecutionEngineTestCase{
schema: graphql.StarwarsSchema(t),
operation: graphql.LoadStarWarsQuery(starwars.FileSimpleHeroQuery, nil),
dataSources: []plan.DataSource{
mustGraphqlDataSourceConfiguration(t,
"id",
mustFactory(t,
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: `{"query":"{hero {name}}","extensions":{"fetch_reasons":[{"typename":"Character","field":"name","by_user":true},{"typename":"Droid","field":"name","by_user":true},{"typename":"Human","field":"name","by_user":true}]}}`,
sendResponseBody: `{"data":{"hero":{"name":"Droid Number 6"}}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"hero"},
},
{
TypeName: "Human",
FieldNames: []string{"name", "height", "friends"},
},
{
TypeName: "Droid",
FieldNames: []string{"name", "primaryFunctions", "friends"},
FetchReasonFields: []string{"name"}, // implementing is marked
},
},
ChildNodes: []plan.TypeField{
{
TypeName: "Character",
FieldNames: []string{"name"},
FieldNames: []string{"name", "friends"},
FetchReasonFields: []string{"name"}, // interface is marked
},
},
},
mustConfiguration(t, graphql_datasource.ConfigurationInput{
Fetch: &graphql_datasource.FetchConfiguration{
URL: "https://example.com/",
Method: "POST",
},
SchemaConfiguration: mustSchemaConfig(
t,
nil,
string(graphql.StarwarsSchema(t).RawSchema()),
),
}),
),
},
fields: []plan.FieldConfiguration{},
expectedResponse: `{"data":{"hero":{"name":"Droid Number 6"}}}`,
},
withFetchReasons(),
))

t.Run("operation on fragment, subgraph expects fetch reasons for one implementing type", runWithoutError(
ExecutionEngineTestCase{
schema: graphql.StarwarsSchema(t),
operation: func(t *testing.T) graphql.Request {
return graphql.Request{
Query: `query {
hero {
...humanFields
}
}
fragment humanFields on Human {
name
height
}`,
}
},
dataSources: []plan.DataSource{
mustGraphqlDataSourceConfiguration(t,
"id",
mustFactory(t,
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: `{"query":"{hero {__typename ... on Human {name height}}}","extensions":{"fetch_reasons":[{"typename":"Human","field":"name","by_user":true}]}}`,
sendResponseBody: `{"data":{"hero":{"__typename": "Human", "name":"Luke Skywalker", "height": "1.99"}}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"hero"},
},
{
TypeName: "Human",
FieldNames: []string{"name", "height", "friends"},
},
{
TypeName: "Droid",
FieldNames: []string{"name", "primaryFunctions", "friends"},
},
},
ChildNodes: []plan.TypeField{
{
TypeName: "Character",
FieldNames: []string{"name", "friends"},
// Interface is marked, and we should propagate reasons if
// a user has asked for the fragment on concrete type
// that is not marked for fetch reasons.
FetchReasonFields: []string{"name"},
},
},
Expand All @@ -889,6 +1089,77 @@ func TestExecutionEngine_Execute(t *testing.T) {
),
},
fields: []plan.FieldConfiguration{},
expectedResponse: `{"data":{"hero":{"name":"Luke Skywalker","height":"1.99"}}}`,
},
withFetchReasons(),
))
t.Run("operation on fragment, subgraph expects fetch reasons for interface and implementing types without dupes", runWithoutError(
ExecutionEngineTestCase{
schema: graphql.StarwarsSchema(t),
operation: func(t *testing.T) graphql.Request {
return graphql.Request{
Query: `query {
hero {
...humanFields
name
}
}
fragment humanFields on Human {
name
}`,
}
},
dataSources: []plan.DataSource{
mustGraphqlDataSourceConfiguration(t,
"id",
mustFactory(t,
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: `{"query":"{hero {__typename ... on Human {name} name}}","extensions":{"fetch_reasons":[{"typename":"Character","field":"name","by_user":true},{"typename":"Droid","field":"name","by_user":true},{"typename":"Human","field":"name","by_user":true}]}}`,
sendResponseBody: `{"data":{"hero":{"__typename": "Human", "name":"Luke Skywalker"}}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"hero"},
},
{
TypeName: "Human",
FieldNames: []string{"name", "height", "friends"},
FetchReasonFields: []string{"name"}, // implementing is marked
},
{
TypeName: "Droid",
FieldNames: []string{"name", "primaryFunctions", "friends"},
FetchReasonFields: []string{"name"}, // implementing is marked
},
},
ChildNodes: []plan.TypeField{
{
TypeName: "Character",
FieldNames: []string{"name", "friends"},
FetchReasonFields: []string{"name"}, // interface is marked
},
},
},
mustConfiguration(t, graphql_datasource.ConfigurationInput{
Fetch: &graphql_datasource.FetchConfiguration{
URL: "https://example.com/",
Method: "POST",
},
SchemaConfiguration: mustSchemaConfig(
t,
nil,
string(graphql.StarwarsSchema(t).RawSchema()),
),
}),
),
},
fields: []plan.FieldConfiguration{},
expectedResponse: `{"data":{"hero":{"name":"Luke Skywalker"}}}`,
},
withFetchReasons(),
Expand Down
Loading