Merge pull request #388 from edpark11/367-with-bfs

Breadth-first-traversal for PR #367 (allows for thunk-based dataloader batching)
graphql-go · Sep 10, 2018 · b3d68b1 · b3d68b1
2 parents ef7caf8 + 75ee0d1
commit b3d68b1
Show file tree

Hide file tree

Showing 2 changed files with 150 additions and 22 deletions.
diff --git a/executor.go b/executor.go
@@ -245,6 +245,7 @@ func executeFieldsSerially(p executeFieldsParams) *Result {
 		}
 		finalResults[responseName] = resolved
 	}
+	dethunkMapDepthFirst(finalResults)
 
 	return &Result{
 		Data:   finalResults,
@@ -254,6 +255,17 @@ func executeFieldsSerially(p executeFieldsParams) *Result {
 
 // Implements the "Evaluating selection sets" section of the spec for "read" mode.
 func executeFields(p executeFieldsParams) *Result {
+	finalResults := executeSubFields(p)
+
+	dethunkMapWithBreadthFirstTraversal(finalResults)
+
+	return &Result{
+		Data:   finalResults,
+		Errors: p.ExecutionContext.Errors,
+	}
+}
+
+func executeSubFields(p executeFieldsParams) map[string]interface{} {
 	if p.Source == nil {
 		p.Source = map[string]interface{}{}
 	}
@@ -271,9 +283,94 @@ func executeFields(p executeFieldsParams) *Result {
 		finalResults[responseName] = resolved
 	}
 
-	return &Result{
-		Data:   finalResults,
-		Errors: p.ExecutionContext.Errors,
+	return finalResults
+}
+
+// dethunkQueue is a structure that allows us to execute a classic breadth-first traversal.
+type dethunkQueue struct {
+	DethunkFuncs []func()
+}
+
+func (d *dethunkQueue) push(f func()) {
+	d.DethunkFuncs = append(d.DethunkFuncs, f)
+}
+
+func (d *dethunkQueue) shift() func() {
+	f := d.DethunkFuncs[0]
+	d.DethunkFuncs = d.DethunkFuncs[1:]
+	return f
+}
+
+// dethunkWithBreadthFirstTraversal performs a breadth-first descent of the map, calling any thunks
+// in the map values and replacing each thunk with that thunk's return value. This parallels
+// the reference graphql-js implementation, which calls Promise.all on thunks at each depth (which
+// is an implicit parallel descent).
+func dethunkMapWithBreadthFirstTraversal(finalResults map[string]interface{}) {
+	dethunkQueue := &dethunkQueue{DethunkFuncs: []func(){}}
+	dethunkMapBreadthFirst(finalResults, dethunkQueue)
+	for len(dethunkQueue.DethunkFuncs) > 0 {
+		f := dethunkQueue.shift()
+		f()
+	}
+}
+
+func dethunkMapBreadthFirst(m map[string]interface{}, dethunkQueue *dethunkQueue) {
+	for k, v := range m {
+		if f, ok := v.(func() interface{}); ok {
+			m[k] = f()
+		}
+		switch val := m[k].(type) {
+		case map[string]interface{}:
+			dethunkQueue.push(func() { dethunkMapBreadthFirst(val, dethunkQueue) })
+		case []interface{}:
+			dethunkQueue.push(func() { dethunkListBreadthFirst(val, dethunkQueue) })
+		}
+	}
+}
+
+func dethunkListBreadthFirst(list []interface{}, dethunkQueue *dethunkQueue) {
+	for i, v := range list {
+		if f, ok := v.(func() interface{}); ok {
+			list[i] = f()
+		}
+		switch val := list[i].(type) {
+		case map[string]interface{}:
+			dethunkQueue.push(func() { dethunkMapBreadthFirst(val, dethunkQueue) })
+		case []interface{}:
+			dethunkQueue.push(func() { dethunkListBreadthFirst(val, dethunkQueue) })
+		}
+	}
+}
+
+// dethunkMapDepthFirst performs a serial descent of the map, calling any thunks
+// in the map values and replacing each thunk with that thunk's return value. This is needed
+// to conform to the graphql-js reference implementation, which requires serial (depth-first)
+// implementations for mutation selects.
+func dethunkMapDepthFirst(m map[string]interface{}) {
+	for k, v := range m {
+		if f, ok := v.(func() interface{}); ok {
+			m[k] = f()
+		}
+		switch val := m[k].(type) {
+		case map[string]interface{}:
+			dethunkMapDepthFirst(val)
+		case []interface{}:
+			dethunkListDepthFirst(val)
+		}
+	}
+}
+
+func dethunkListDepthFirst(list []interface{}) {
+	for i, v := range list {
+		if f, ok := v.(func() interface{}); ok {
+			list[i] = f()
+		}
+		switch val := list[i].(type) {
+		case map[string]interface{}:
+			dethunkMapDepthFirst(val)
+		case []interface{}:
+			dethunkListDepthFirst(val)
+		}
 	}
 }
 
@@ -558,13 +655,9 @@ func completeValueCatchingError(eCtx *executionContext, returnType Type, fieldAS
 func completeValue(eCtx *executionContext, returnType Type, fieldASTs []*ast.Field, info ResolveInfo, path *responsePath, result interface{}) interface{} {
 
 	resultVal := reflect.ValueOf(result)
-	for resultVal.IsValid() && resultVal.Type().Kind() == reflect.Func {
-		if propertyFn, ok := result.(func() interface{}); ok {
-			result = propertyFn()
-			resultVal = reflect.ValueOf(result)
-		} else {
-			err := gqlerrors.NewFormattedError("Error resolving func. Expected `func() interface{}` signature")
-			panic(gqlerrors.FormatError(err))
+	if resultVal.IsValid() && resultVal.Kind() == reflect.Func {
+		return func() interface{} {
+			return completeThunkValueCatchingError(eCtx, returnType, fieldASTs, info, path, result)
 		}
 	}
 
@@ -626,6 +719,30 @@ func completeValue(eCtx *executionContext, returnType Type, fieldASTs []*ast.Fie
 	return nil
 }
 
+func completeThunkValueCatchingError(eCtx *executionContext, returnType Type, fieldASTs []*ast.Field, info ResolveInfo, path *responsePath, result interface{}) (completed interface{}) {
+
+	// catch any panic invoked from the propertyFn (thunk)
+	defer func() {
+		if r := recover(); r != nil {
+			handleFieldError(r, FieldASTsToNodeASTs(fieldASTs), path, returnType, eCtx)
+		}
+	}()
+
+	propertyFn, ok := result.(func() interface{})
+	if !ok {
+		err := gqlerrors.NewFormattedError("Error resolving func. Expected `func() interface{}` signature")
+		panic(gqlerrors.FormatError(err))
+	}
+	result = propertyFn()
+
+	if returnType, ok := returnType.(*NonNull); ok {
+		completed := completeValue(eCtx, returnType, fieldASTs, info, path, result)
+		return completed
+	}
+	completed = completeValue(eCtx, returnType, fieldASTs, info, path, result)
+	return completed
+}
+
 // completeAbstractValue completes value of an Abstract type (Union / Interface) by determining the runtime type
 // of that value, then completing based on that type.
 func completeAbstractValue(eCtx *executionContext, returnType Abstract, fieldASTs []*ast.Field, info ResolveInfo, path *responsePath, result interface{}) interface{} {
@@ -709,10 +826,7 @@ func completeObjectValue(eCtx *executionContext, returnType *Object, fieldASTs [
 		Fields:           subFieldASTs,
 		Path:             path,
 	}
-	results := executeFields(executeFieldsParams)
-
-	return results.Data
-
+	return executeSubFields(executeFieldsParams)
 }
 
 // completeLeafValue complete a leaf value (Scalar / Enum) by serializing to a valid value, returning nil if serialization is not possible.

diff --git a/lists_test.go b/lists_test.go
@@ -579,11 +579,18 @@ func TestLists_NullableListOfNonNullArrayOfFunc_ContainsNulls(t *testing.T) {
 		},
 	}
 	expected := &graphql.Result{
-		Data: map[string]interface{}{
-			"nest": map[string]interface{}{
-				"test": nil,
-			},
-		},
+		/*
+			// TODO: Because thunks are called after the result map has been assembled,
+			// we are not able to traverse up the tree until we find a nullable type,
+			// so in this case the entire data is nil. Will need some significant code
+			// restructure to restore this.
+			Data: map[string]interface{}{
+				"nest": map[string]interface{}{
+					"test": nil,
+				},
+			},
+		*/
+		Data: nil,
 		Errors: []gqlerrors.FormattedError{
 			{
 				Message: "Cannot return null for non-nullable field DataType.test.",
@@ -803,9 +810,16 @@ func TestLists_NonNullListOfNonNullArrayOfFunc_ContainsNulls(t *testing.T) {
 		},
 	}
 	expected := &graphql.Result{
-		Data: map[string]interface{}{
-			"nest": nil,
-		},
+		/*
+			// TODO: Because thunks are called after the result map has been assembled,
+			// we are not able to traverse up the tree until we find a nullable type,
+			// so in this case the entire data is nil. Will need some significant code
+			// restructure to restore this.
+			Data: map[string]interface{}{
+				"nest": nil,
+			},
+		*/
+		Data: nil,
 		Errors: []gqlerrors.FormattedError{
 			{
 				Message: "Cannot return null for non-nullable field DataType.test.",