Always return *Thing from resolvers for structs

99designs · Feb 18, 2019 · 318639b · 318639b
1 parent ef0223c
commit 318639b
Show file tree

Hide file tree

Showing 23 changed files with 176 additions and 65 deletions.
diff --git a/codegen/config/binder.go b/codegen/config/binder.go
@@ -149,6 +149,19 @@ func (b *Binder) FindObject(pkgName string, typeName string) (types.Object, erro
 	return nil, errors.Errorf("unable to find type %s\n", fullName)
 }
 
+func (b *Binder) PointerTo(ref *TypeReference) *TypeReference {
+	newRef := &TypeReference{
+		GO:          types.NewPointer(ref.GO),
+		GQL:         ref.GQL,
+		Definition:  ref.Definition,
+		Unmarshaler: ref.Unmarshaler,
+		Marshaler:   ref.Marshaler,
+	}
+
+	b.References = append(b.References, newRef)
+	return newRef
+}
+
 var modsRegex = regexp.MustCompile(`^(\*|\[\])*`)
 
 func normalizeVendor(pkg string) string {
@@ -205,6 +218,11 @@ func (t *TypeReference) IsNamed() bool {
 	return isSlice
 }
 
+func (t *TypeReference) IsStruct() bool {
+	_, isStruct := t.GO.Underlying().(*types.Struct)
+	return isStruct
+}
+
 func (t *TypeReference) IsScalar() bool {
 	return t.Definition.Kind == ast.Scalar
 }

diff --git a/codegen/field.go b/codegen/field.go
@@ -77,7 +77,12 @@ func (b *builder) bindField(obj *Object, f *Field) error {
 			}
 			f.TypeReference = tr
 		}
+
+		if f.IsResolver && !f.TypeReference.IsPtr() && f.TypeReference.IsStruct() {
+			f.TypeReference = b.Binder.PointerTo(f.TypeReference)
+		}
 	}()
+
 	switch {
 	case f.Name == "__schema":
 		f.GoFieldType = GoFieldMethod

diff --git a/codegen/testserver/generated.go b/codegen/testserver/generated.go
diff --git a/codegen/testserver/middleware_test.go b/codegen/testserver/middleware_test.go
@@ -19,8 +19,8 @@ func TestMiddleware(t *testing.T) {
 		return &Error{ID: "E1234"}, nil
 	}
 
-	resolvers.QueryResolver.User = func(ctx context.Context, id int) (user User, e error) {
-		return User{ID: 1}, nil
+	resolvers.QueryResolver.User = func(ctx context.Context, id int) (user *User, e error) {
+		return &User{ID: 1}, nil
 	}
 
 	resolvers.UserResolver.Friends = func(ctx context.Context, obj *User) (users []User, e error) {

diff --git a/codegen/testserver/resolver.go b/codegen/testserver/resolver.go
@@ -71,7 +71,7 @@ func (r *queryResolver) ModelMethods(ctx context.Context) (*ModelMethods, error)
 func (r *queryResolver) Valid(ctx context.Context) (string, error) {
 	panic("not implemented")
 }
-func (r *queryResolver) User(ctx context.Context, id int) (User, error) {
+func (r *queryResolver) User(ctx context.Context, id int) (*User, error) {
 	panic("not implemented")
 }
 func (r *queryResolver) NullableArg(ctx context.Context, arg *int) (*string, error) {

diff --git a/codegen/testserver/stub.go b/codegen/testserver/stub.go
diff --git a/codegen/testserver/time_test.go b/codegen/testserver/time_test.go
@@ -17,8 +17,8 @@ func TestTime(t *testing.T) {
 	srv := httptest.NewServer(handler.GraphQL(NewExecutableSchema(Config{Resolvers: resolvers})))
 	c := client.New(srv.URL)
 
-	resolvers.QueryResolver.User = func(ctx context.Context, id int) (user User, e error) {
-		return User{}, nil
+	resolvers.QueryResolver.User = func(ctx context.Context, id int) (user *User, e error) {
+		return &User{}, nil
 	}
 
 	t.Run("zero value in nullable field", func(t *testing.T) {
@@ -46,9 +46,9 @@ func TestTime(t *testing.T) {
 	})
 
 	t.Run("with values", func(t *testing.T) {
-		resolvers.QueryResolver.User = func(ctx context.Context, id int) (user User, e error) {
+		resolvers.QueryResolver.User = func(ctx context.Context, id int) (user *User, e error) {
 			updated := time.Date(2010, 1, 1, 0, 0, 20, 0, time.UTC)
-			return User{
+			return &User{
 				Created: time.Date(2010, 1, 1, 0, 0, 10, 0, time.UTC),
 				Updated: &updated,
 			}, nil

diff --git a/codegen/testserver/tracer_test.go b/codegen/testserver/tracer_test.go
@@ -16,8 +16,8 @@ import (
 
 func TestTracer(t *testing.T) {
 	resolvers := &Stub{}
-	resolvers.QueryResolver.User = func(ctx context.Context, id int) (user User, e error) {
-		return User{ID: 1}, nil
+	resolvers.QueryResolver.User = func(ctx context.Context, id int) (user *User, e error) {
+		return &User{ID: 1}, nil
 	}
 	t.Run("called in the correct order", func(t *testing.T) {
 		var tracerLog []string

diff --git a/example/chat/generated.go b/example/chat/generated.go
diff --git a/example/chat/resolvers.go b/example/chat/resolvers.go
@@ -37,16 +37,16 @@ func New() Config {
 type Chatroom struct {
 	Name      string
 	Messages  []Message
-	Observers map[string]chan Message
+	Observers map[string]chan *Message
 }
 
 type mutationResolver struct{ *resolver }
 
-func (r *mutationResolver) Post(ctx context.Context, text string, username string, roomName string) (Message, error) {
+func (r *mutationResolver) Post(ctx context.Context, text string, username string, roomName string) (*Message, error) {
 	r.mu.Lock()
 	room := r.Rooms[roomName]
 	if room == nil {
-		room = &Chatroom{Name: roomName, Observers: map[string]chan Message{}}
+		room = &Chatroom{Name: roomName, Observers: map[string]chan *Message{}}
 		r.Rooms[roomName] = room
 	}
 	r.mu.Unlock()
@@ -61,10 +61,10 @@ func (r *mutationResolver) Post(ctx context.Context, text string, username strin
 	room.Messages = append(room.Messages, message)
 	r.mu.Lock()
 	for _, observer := range room.Observers {
-		observer <- message
+		observer <- &message
 	}
 	r.mu.Unlock()
-	return message, nil
+	return &message, nil
 }
 
 type queryResolver struct{ *resolver }
@@ -73,7 +73,7 @@ func (r *queryResolver) Room(ctx context.Context, name string) (*Chatroom, error
 	r.mu.Lock()
 	room := r.Rooms[name]
 	if room == nil {
-		room = &Chatroom{Name: name, Observers: map[string]chan Message{}}
+		room = &Chatroom{Name: name, Observers: map[string]chan *Message{}}
 		r.Rooms[name] = room
 	}
 	r.mu.Unlock()
@@ -83,17 +83,17 @@ func (r *queryResolver) Room(ctx context.Context, name string) (*Chatroom, error
 
 type subscriptionResolver struct{ *resolver }
 
-func (r *subscriptionResolver) MessageAdded(ctx context.Context, roomName string) (<-chan Message, error) {
+func (r *subscriptionResolver) MessageAdded(ctx context.Context, roomName string) (<-chan *Message, error) {
 	r.mu.Lock()
 	room := r.Rooms[roomName]
 	if room == nil {
-		room = &Chatroom{Name: roomName, Observers: map[string]chan Message{}}
+		room = &Chatroom{Name: roomName, Observers: map[string]chan *Message{}}
 		r.Rooms[roomName] = room
 	}
 	r.mu.Unlock()
 
 	id := randString(8)
-	events := make(chan Message, 1)
+	events := make(chan *Message, 1)
 
 	go func() {
 		<-ctx.Done()

diff --git a/example/config/generated.go b/example/config/generated.go
diff --git a/example/config/resolver.go b/example/config/resolver.go
@@ -38,7 +38,7 @@ func (r *Resolver) Todo() TodoResolver {
 
 type mutationResolver struct{ *Resolver }
 
-func (r *mutationResolver) CreateTodo(ctx context.Context, input NewTodo) (Todo, error) {
+func (r *mutationResolver) CreateTodo(ctx context.Context, input NewTodo) (*Todo, error) {
 	newID := r.nextID
 	r.nextID++
 
@@ -49,7 +49,7 @@ func (r *mutationResolver) CreateTodo(ctx context.Context, input NewTodo) (Todo,
 
 	r.todos = append(r.todos, newTodo)
 
-	return newTodo, nil
+	return &newTodo, nil
 }
 
 type queryResolver struct{ *Resolver }

diff --git a/example/scalars/generated.go b/example/scalars/generated.go
diff --git a/example/scalars/resolvers.go b/example/scalars/resolvers.go
@@ -69,6 +69,6 @@ func (r *userResolver) PrimitiveResolver(ctx context.Context, obj *model.User) (
 	return "test", nil
 }
 
-func (r *userResolver) CustomResolver(ctx context.Context, obj *model.User) (model.Point, error) {
-	return model.Point{X: 5, Y: 1}, nil
+func (r *userResolver) CustomResolver(ctx context.Context, obj *model.User) (*model.Point, error) {
+	return &model.Point{X: 5, Y: 1}, nil
 }