Skip to content

Commit eca757b

Browse files
carldunhamcarldunham
committed
wip: move defer extraction to plan
1 parent 3316344 commit eca757b

12 files changed

+231
-46
lines changed

‎v2/pkg/engine/plan/configuration_visitor.go‎

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/wundergraph/graphql-go-tools/v2/pkg/astvisitor"
1313
"github.com/wundergraph/graphql-go-tools/v2/pkg/engine/argument_templates"
1414
"github.com/wundergraph/graphql-go-tools/v2/pkg/engine/resolve"
15+
"github.com/wundergraph/graphql-go-tools/v2/pkg/lexer/literal"
1516
)
1617

1718
// configurationVisitor - walks through the operation multiple times to collect plannings paths
@@ -53,6 +54,8 @@ type configurationVisitor struct {
5354

5455
fieldDependsOn map[fieldIndexKey][]int // fieldDependsOn is a map[fieldRef][]fieldRef - holds list of field refs which are required by a field ref, e.g. field should be planned only after required fields were planned
5556
fieldRequirementsConfigs map[fieldIndexKey][]FederationFieldConfiguration
57+
58+
defers []deferInfo
5659
}
5760

5861
type FailedToCreatePlanningPathsError struct {
@@ -402,7 +405,7 @@ func (c *configurationVisitor) EnterField(fieldRef int) {
402405
}
403406
isSubscription := c.isSubscription(root.Ref, currentPath)
404407

405-
suggestions := c.nodeSuggestions.SuggestionsForPath(typeName, fieldName, currentPath)
408+
suggestions := c.nodeSuggestions.SuggestionsForPath(typeName, fieldName, currentPath, c.currentDeferPath())
406409
shareable := len(suggestions) > 1
407410
for _, suggestion := range suggestions {
408411
dsIdx := slices.IndexFunc(c.dataSources, func(d DataSource) bool {
@@ -639,6 +642,7 @@ func (c *configurationVisitor) planWithExistingPlanners(fieldRef int, typeName,
639642
planningBehaviour := plannerConfig.DataSourcePlanningBehavior()
640643
dsConfiguration := plannerConfig.DataSourceConfiguration()
641644
currentPlannerDSHash := dsConfiguration.Hash()
645+
currentDeferPath := c.currentDeferPath()
642646

643647
hasSuggestion := suggestion != nil
644648
if !hasSuggestion {
@@ -649,6 +653,10 @@ func (c *configurationVisitor) planWithExistingPlanners(fieldRef int, typeName,
649653
continue
650654
}
651655

656+
if suggestion.DeferPath == currentDeferPath {
657+
continue
658+
}
659+
652660
isProvided := suggestion.IsProvided
653661
isRootNode := suggestion.IsRootNode
654662
isChildNode := !isRootNode
@@ -841,6 +849,7 @@ func (c *configurationVisitor) addNewPlanner(fieldRef int, typeName, fieldName,
841849
plannerPath,
842850
c.plannerPathType(plannerPath),
843851
paths,
852+
c.currentDeferPath(),
844853
)
845854

846855
plannerConfig := dsConfig.CreatePlannerConfiguration(c.logger, fetchConfiguration, plannerPathConfig, c.plannerConfiguration)
@@ -994,7 +1003,7 @@ func (c *configurationVisitor) resolveRootFieldOperationType(typeName string) as
9941003

9951004
// handleMissingPath - records missing path for the case when we don't yet have a planner for the field
9961005
func (c *configurationVisitor) handleMissingPath(planned bool, typeName string, fieldName string, currentPath string, shareable bool) {
997-
suggestions := c.nodeSuggestions.SuggestionsForPath(typeName, fieldName, currentPath)
1006+
suggestions := c.nodeSuggestions.SuggestionsForPath(typeName, fieldName, currentPath, c.currentDeferPath())
9981007

9991008
if len(suggestions) <= 1 {
10001009
if planned {
@@ -1051,6 +1060,49 @@ func (c *configurationVisitor) LeaveField(ref int) {
10511060
}
10521061
}
10531062

1063+
func (c *configurationVisitor) EnterInlineFragment(ref int) {
1064+
typeName := c.operation.InlineFragmentTypeConditionNameString(ref)
1065+
c.debugPrint("EnterInlineFragment ref:", ref, "typeName:", typeName)
1066+
1067+
directives := c.operation.InlineFragments[ref].Directives.Refs
1068+
if _, ok := c.operation.DirectiveWithNameBytes(directives, literal.DEFER); ok {
1069+
c.enterDefer(ref)
1070+
}
1071+
}
1072+
1073+
func (c *configurationVisitor) LeaveInlineFragment(ref int) {
1074+
typeName := c.operation.InlineFragmentTypeConditionNameString(ref)
1075+
c.debugPrint("LeaveInlineFragment ref:", ref, "typeName:", typeName)
1076+
1077+
directives := c.operation.InlineFragments[ref].Directives.Refs
1078+
if _, ok := c.operation.DirectiveWithNameBytes(directives, literal.DEFER); ok {
1079+
c.leaveDefer()
1080+
}
1081+
}
1082+
1083+
func (c *configurationVisitor) enterDefer(ref int) {
1084+
path := c.walker.Path.StringSlice()
1085+
fragName := c.operation.InlineFragmentTypeConditionNameString(ref)
1086+
1087+
c.defers = append(c.defers, deferInfo{
1088+
Path: append(path[:], fmt.Sprintf("%s%d%s", ast.InlineFragmentPathPrefix, ref, fragName)),
1089+
Ref: ref,
1090+
})
1091+
}
1092+
1093+
func (c *configurationVisitor) leaveDefer() {
1094+
if depth := len(c.defers); depth > 0 {
1095+
c.defers = c.defers[:depth-1]
1096+
}
1097+
}
1098+
1099+
func (c *configurationVisitor) currentDeferPath() string {
1100+
if len(c.defers) == 0 {
1101+
return ""
1102+
}
1103+
return strings.Join(c.defers[len(c.defers)-1].Path, ".")
1104+
}
1105+
10541106
// addPlannerPathForTypename adds a path for the __typename field
10551107
// adding __typename should be done only in case particular planner has parent path
10561108
// otherwise it will be added to all planners and will cause visiting of incorrect selection sets

‎v2/pkg/engine/plan/datasource_filter_collect_nodes_visitor.go‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ package plan
33
import (
44
"fmt"
55
"slices"
6+
"strings"
67
"sync"
78

89
"github.com/wundergraph/graphql-go-tools/v2/pkg/ast"
910
"github.com/wundergraph/graphql-go-tools/v2/pkg/astvisitor"
11+
"github.com/wundergraph/graphql-go-tools/v2/pkg/lexer/literal"
1012
"github.com/wundergraph/graphql-go-tools/v2/pkg/operationreport"
1113
)
1214

@@ -51,6 +53,7 @@ func (c *nodesCollector) collectNodes() {
5153
info: info,
5254
}
5355
walker.RegisterFieldVisitor(visitor)
56+
walker.RegisterInlineFragmentVisitor(visitor)
5457
visitor.dataSource = dataSource
5558
visitor.keyPaths = make(map[string]struct{})
5659
visitors[i] = visitor
@@ -143,6 +146,7 @@ type collectNodesVisitor struct {
143146
dataSource DataSource
144147

145148
localSuggestions []*NodeSuggestion
149+
defers []deferInfo
146150

147151
nodes *NodeSuggestions
148152

@@ -430,6 +434,7 @@ func (f *collectNodesVisitor) EnterField(fieldRef int) {
430434
DataSourceName: f.dataSource.Name(),
431435
Path: info.currentPath,
432436
ParentPath: info.parentPath,
437+
DeferPath: f.currentDeferPath(),
433438
IsRootNode: hasRootNode,
434439
onFragment: info.onFragment,
435440
parentPathWithoutFragment: info.parentPathWithoutFragment,
@@ -460,6 +465,43 @@ func (f *collectNodesVisitor) LeaveField(ref int) {
460465

461466
}
462467

468+
func (f *collectNodesVisitor) EnterInlineFragment(ref int) {
469+
directives := f.operation.InlineFragments[ref].Directives.Refs
470+
if _, ok := f.operation.DirectiveWithNameBytes(directives, literal.DEFER); ok {
471+
f.enterDefer(ref)
472+
}
473+
}
474+
475+
func (f *collectNodesVisitor) LeaveInlineFragment(ref int) {
476+
directives := f.operation.InlineFragments[ref].Directives.Refs
477+
if _, ok := f.operation.DirectiveWithNameBytes(directives, literal.DEFER); ok {
478+
f.leaveDefer()
479+
}
480+
}
481+
482+
func (f *collectNodesVisitor) enterDefer(ref int) {
483+
path := f.walker.Path.StringSlice()
484+
fragName := f.operation.InlineFragmentTypeConditionNameString(ref)
485+
486+
f.defers = append(f.defers, deferInfo{
487+
Path: append(path[:], fmt.Sprintf("%s%d%s", ast.InlineFragmentPathPrefix, ref, fragName)),
488+
Ref: ref,
489+
})
490+
}
491+
492+
func (f *collectNodesVisitor) leaveDefer() {
493+
if depth := len(f.defers); depth > 0 {
494+
f.defers = f.defers[:depth-1]
495+
}
496+
}
497+
498+
func (f *collectNodesVisitor) currentDeferPath() string {
499+
if len(f.defers) == 0 {
500+
return ""
501+
}
502+
return strings.Join(f.defers[len(f.defers)-1].Path, ".")
503+
}
504+
463505
func (f *collectNodesVisitor) applySuggestions() {
464506
for _, suggestion := range f.localSuggestions {
465507
f.nodes.addSuggestion(suggestion)

‎v2/pkg/engine/plan/datasource_filter_node_suggestions.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ type NodeSuggestion struct {
1414
DataSourceName string `json:"dsName"`
1515
DataSourceHash DSHash `json:"-"`
1616
Path string `json:"path"`
17+
DeferPath string `json:"deferPath"`
1718
TypeName string `json:"typeName"`
1819
FieldName string `json:"fieldName"`
1920
FieldRef int `json:"fieldRef"`
@@ -117,14 +118,14 @@ func (f *NodeSuggestions) addSuggestion(node *NodeSuggestion) (suggestionIdx int
117118
return len(f.items) - 1
118119
}
119120

120-
func (f *NodeSuggestions) SuggestionsForPath(typeName, fieldName, path string) (suggestions []*NodeSuggestion) {
121+
func (f *NodeSuggestions) SuggestionsForPath(typeName, fieldName, path string, deferPath string) (suggestions []*NodeSuggestion) {
121122
items, ok := f.pathSuggestions[path]
122123
if !ok {
123124
return nil
124125
}
125126

126127
for i := range items {
127-
if items[i].Selected && typeName == items[i].TypeName && fieldName == items[i].FieldName {
128+
if items[i].Selected && typeName == items[i].TypeName && fieldName == items[i].FieldName && items[i].DeferPath == deferPath {
128129
suggestions = append(suggestions, items[i])
129130
}
130131
}

‎v2/pkg/engine/postprocess/extract_deferred_fields.go‎ renamed to ‎v2/pkg/engine/plan/extract_deferred_fields.go‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package postprocess
1+
package plan
22

33
import (
44
"slices"
@@ -168,12 +168,16 @@ func (v *deferredFieldsVisitor) enterDefer(field *resolve.Field) {
168168
Nullable: preDeferObject.Nullable,
169169
// Field will be appended below.
170170
Path: preDeferObject.Path,
171-
Fetches: v.fetchesFromPath(),
171+
Fetches: preDeferObject.Fetches,
172172

173173
PossibleTypes: preDeferObject.PossibleTypes,
174174
TypeName: preDeferObject.TypeName,
175175
}
176176

177+
if newObj.Fetches == nil {
178+
newObj.Fetches = v.fetchesFromPath()
179+
}
180+
177181
parentResponse := v.currentResponseItem()
178182
newResponse := &resolve.GraphQLResponse{
179183
Data: newObj,

‎v2/pkg/engine/postprocess/extract_deferred_fields_test.go‎ renamed to ‎v2/pkg/engine/plan/extract_deferred_fields_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package postprocess
1+
package plan
22

33
import (
44
"fmt"

‎v2/pkg/engine/plan/node_selection_visitor.go‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ import (
44
"errors"
55
"fmt"
66
"slices"
7+
"strings"
78

89
"github.com/wundergraph/graphql-go-tools/v2/pkg/ast"
910
"github.com/wundergraph/graphql-go-tools/v2/pkg/astvisitor"
11+
"github.com/wundergraph/graphql-go-tools/v2/pkg/lexer/literal"
1012
)
1113

1214
// nodeSelectionVisitor - walks through the operation multiple times to rewrite operation
@@ -44,6 +46,8 @@ type nodeSelectionVisitor struct {
4446
hasUnresolvedFields bool // hasUnresolvedFields is used to determine if we need to run the planner again. We should set it to true in case we have unresolved fields
4547

4648
fieldPathCoordinates []KeyConditionCoordinate // currentFieldPathCoordinates is a stack of field path coordinates
49+
50+
defers []deferInfo
4751
}
4852

4953
func (c *nodeSelectionVisitor) shouldRevisit() bool {
@@ -159,6 +163,20 @@ func (c *nodeSelectionVisitor) EnterOperationDefinition(ref int) {
159163
}
160164
}
161165

166+
func (c *nodeSelectionVisitor) EnterInlineFragment(ref int) {
167+
directives := c.operation.InlineFragments[ref].Directives.Refs
168+
if _, ok := c.operation.DirectiveWithNameBytes(directives, literal.DEFER); ok {
169+
c.enterDefer(ref)
170+
}
171+
}
172+
173+
func (c *nodeSelectionVisitor) LeaveInlineFragment(ref int) {
174+
directives := c.operation.InlineFragments[ref].Directives.Refs
175+
if _, ok := c.operation.DirectiveWithNameBytes(directives, literal.DEFER); ok {
176+
c.leaveDefer()
177+
}
178+
}
179+
162180
func (c *nodeSelectionVisitor) EnterSelectionSet(ref int) {
163181
c.debugPrint("EnterSelectionSet ref:", ref)
164182
c.selectionSetRefs = append(c.selectionSetRefs, ref)
@@ -186,7 +204,7 @@ func (c *nodeSelectionVisitor) EnterField(fieldRef int) {
186204
parentPath := c.walker.Path.DotDelimitedString()
187205
currentPath := parentPath + "." + fieldAliasOrName
188206

189-
suggestions := c.nodeSuggestions.SuggestionsForPath(typeName, fieldName, currentPath)
207+
suggestions := c.nodeSuggestions.SuggestionsForPath(typeName, fieldName, currentPath, c.currentDeferPath())
190208

191209
for _, suggestion := range suggestions {
192210
if suggestion.IsRequiredKeyField {
@@ -226,6 +244,29 @@ func (c *nodeSelectionVisitor) LeaveField(ref int) {
226244
}
227245
}
228246

247+
func (c *nodeSelectionVisitor) enterDefer(ref int) {
248+
path := c.walker.Path.StringSlice()
249+
fragName := c.operation.InlineFragmentTypeConditionNameString(ref)
250+
251+
c.defers = append(c.defers, deferInfo{
252+
Path: append(path[:], fmt.Sprintf("%s%d%s", ast.InlineFragmentPathPrefix, ref, fragName)),
253+
Ref: ref,
254+
})
255+
}
256+
257+
func (c *nodeSelectionVisitor) leaveDefer() {
258+
if depth := len(c.defers); depth > 0 {
259+
c.defers = c.defers[:depth-1]
260+
}
261+
}
262+
263+
func (c *nodeSelectionVisitor) currentDeferPath() string {
264+
if len(c.defers) == 0 {
265+
return ""
266+
}
267+
return strings.Join(c.defers[len(c.defers)-1].Path, ".")
268+
}
269+
229270
func (c *nodeSelectionVisitor) handleFieldRequiredByRequires(fieldRef int, parentPath, typeName, fieldName, currentPath string, dsConfig DataSource) {
230271
fieldKey := fieldIndexKey{fieldRef, dsConfig.Hash()}
231272
_, visited := c.visitedFieldsRequiresChecks[fieldKey]

‎v2/pkg/engine/postprocess/plan_visitor.go‎ renamed to ‎v2/pkg/engine/plan/plan_visitor.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package postprocess
1+
package plan
22

33
import (
44
"strings"

‎v2/pkg/engine/plan/planner.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ func NewPlanner(config Configuration) (*Planner, error) {
6464
nodeSelection.RegisterFieldVisitor(nodeSelectionVisitor)
6565
nodeSelection.RegisterEnterOperationVisitor(nodeSelectionVisitor)
6666
nodeSelection.RegisterSelectionSetVisitor(nodeSelectionVisitor)
67+
nodeSelection.RegisterInlineFragmentVisitor(nodeSelectionVisitor)
6768

6869
// configuration
6970
configurationWalker := astvisitor.NewWalker(48)
@@ -76,6 +77,7 @@ func NewPlanner(config Configuration) (*Planner, error) {
7677
configurationWalker.RegisterFieldVisitor(configVisitor)
7778
configurationWalker.RegisterEnterOperationVisitor(configVisitor)
7879
configurationWalker.RegisterSelectionSetVisitor(configVisitor)
80+
configurationWalker.RegisterInlineFragmentVisitor(configVisitor)
7981

8082
// planning
8183

‎v2/pkg/engine/plan/planner_configuration.go‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ type PlannerPathConfiguration interface {
8282
ForEachPath(each func(*pathConfiguration) (shouldBreak bool))
8383
RemoveLeafFragmentPaths() (hasRemovals bool)
8484
ParentPath() string
85+
DeferPath() string
8586
AddPath(configuration pathConfiguration)
8687
IsNestedPlanner() bool
8788
HasPath(path string) bool
@@ -91,10 +92,11 @@ type PlannerPathConfiguration interface {
9192
HasParent(parent string) bool
9293
}
9394

94-
func newPlannerPathsConfiguration(parentPath string, parentPathType PlannerPathType, paths []pathConfiguration) *plannerPathsConfiguration {
95+
func newPlannerPathsConfiguration(parentPath string, parentPathType PlannerPathType, paths []pathConfiguration, deferPath string) *plannerPathsConfiguration {
9596
p := &plannerPathsConfiguration{
9697
parentPath: parentPath,
9798
parentPathType: parentPathType,
99+
deferPath: deferPath,
98100
index: make(map[string][]int),
99101
indexByFieldRef: make(map[int]struct{}),
100102
fragmentPaths: make(map[pathConfiguration]struct{}),
@@ -112,6 +114,7 @@ type plannerPathsConfiguration struct {
112114
parentPath string
113115
parentPathType PlannerPathType
114116
paths []pathConfiguration
117+
deferPath string
115118

116119
// indexes
117120

@@ -136,6 +139,10 @@ func (p *plannerPathsConfiguration) ParentPath() string {
136139
return p.parentPath
137140
}
138141

142+
func (p *plannerPathsConfiguration) DeferPath() string {
143+
return p.deferPath
144+
}
145+
139146
func (p *plannerPathsConfiguration) AddPath(configuration pathConfiguration) {
140147
// fmt.Println("[plannerConfiguration.AddPath] parentPath:", p.parentPath, "path:", configuration.String())
141148
p.paths = append(p.paths, configuration)

0 commit comments

Comments
 (0)