Add config boolean for whether resolvers return pointers

99designs · May 24, 2022 · e5baeaa · e5baeaa
1 parent e15da34
commit e5baeaa
Show file tree

Hide file tree

Showing 10 changed files with 3,413 additions and 23 deletions.
diff --git a/codegen/config/config.go b/codegen/config/config.go
@@ -16,22 +16,23 @@ import (
 )
 
 type Config struct {
-	SchemaFilename             StringList                 `yaml:"schema,omitempty"`
-	Exec                       ExecConfig                 `yaml:"exec"`
-	Model                      PackageConfig              `yaml:"model,omitempty"`
-	Federation                 PackageConfig              `yaml:"federation,omitempty"`
-	Resolver                   ResolverConfig             `yaml:"resolver,omitempty"`
-	AutoBind                   []string                   `yaml:"autobind"`
-	Models                     TypeMap                    `yaml:"models,omitempty"`
-	StructTag                  string                     `yaml:"struct_tag,omitempty"`
-	Directives                 map[string]DirectiveConfig `yaml:"directives,omitempty"`
-	OmitSliceElementPointers   bool                       `yaml:"omit_slice_element_pointers,omitempty"`
-	StructFieldsAlwaysPointers bool                       `yaml:"struct_fields_always_pointers,omitempty"`
-	SkipValidation             bool                       `yaml:"skip_validation,omitempty"`
-	SkipModTidy                bool                       `yaml:"skip_mod_tidy,omitempty"`
-	Sources                    []*ast.Source              `yaml:"-"`
-	Packages                   *code.Packages             `yaml:"-"`
-	Schema                     *ast.Schema                `yaml:"-"`
+	SchemaFilename                StringList                 `yaml:"schema,omitempty"`
+	Exec                          ExecConfig                 `yaml:"exec"`
+	Model                         PackageConfig              `yaml:"model,omitempty"`
+	Federation                    PackageConfig              `yaml:"federation,omitempty"`
+	Resolver                      ResolverConfig             `yaml:"resolver,omitempty"`
+	AutoBind                      []string                   `yaml:"autobind"`
+	Models                        TypeMap                    `yaml:"models,omitempty"`
+	StructTag                     string                     `yaml:"struct_tag,omitempty"`
+	Directives                    map[string]DirectiveConfig `yaml:"directives,omitempty"`
+	OmitSliceElementPointers      bool                       `yaml:"omit_slice_element_pointers,omitempty"`
+	StructFieldsAlwaysPointers    bool                       `yaml:"struct_fields_always_pointers,omitempty"`
+	ResolversAlwaysReturnPointers bool                       `yaml:"resolvers_always_return_pointers,omitempty"`
+	SkipValidation                bool                       `yaml:"skip_validation,omitempty"`
+	SkipModTidy                   bool                       `yaml:"skip_mod_tidy,omitempty"`
+	Sources                       []*ast.Source              `yaml:"-"`
+	Packages                      *code.Packages             `yaml:"-"`
+	Schema                        *ast.Schema                `yaml:"-"`
 
 	// Deprecated: use Federation instead. Will be removed next release
 	Federated bool `yaml:"federated,omitempty"`
@@ -42,12 +43,13 @@ var cfgFilenames = []string{".gqlgen.yml", "gqlgen.yml", "gqlgen.yaml"}
 // DefaultConfig creates a copy of the default config
 func DefaultConfig() *Config {
 	return &Config{
-		SchemaFilename:             StringList{"schema.graphql"},
-		Model:                      PackageConfig{Filename: "models_gen.go"},
-		Exec:                       ExecConfig{Filename: "generated.go"},
-		Directives:                 map[string]DirectiveConfig{},
-		Models:                     TypeMap{},
-		StructFieldsAlwaysPointers: true,
+		SchemaFilename:                StringList{"schema.graphql"},
+		Model:                         PackageConfig{Filename: "models_gen.go"},
+		Exec:                          ExecConfig{Filename: "generated.go"},
+		Directives:                    map[string]DirectiveConfig{},
+		Models:                        TypeMap{},
+		StructFieldsAlwaysPointers:    true,
+		ResolversAlwaysReturnPointers: true,
 	}
 }
 

diff --git a/codegen/field.go b/codegen/field.go
@@ -71,7 +71,7 @@ func (b *builder) buildField(obj *Object, field *ast.FieldDefinition) (*Field, e
 		log.Println(err.Error())
 	}
 
-	if f.IsResolver && !f.TypeReference.IsPtr() && f.TypeReference.IsStruct() {
+	if f.IsResolver && b.Config.ResolversAlwaysReturnPointers && !f.TypeReference.IsPtr() && f.TypeReference.IsStruct() {
 		f.TypeReference = b.Binder.PointerTo(f.TypeReference)
 	}
 

diff --git a/docs/content/config.md b/docs/content/config.md
@@ -48,6 +48,9 @@ resolver:
 # e.g. type Thing struct { FieldA OtherThing } instead of { FieldA *OtherThing }
 # struct_fields_always_pointers: true
 
+# Optional: turn off to make resolvers return values instead of pointers for structs
+# resolvers_always_return_pointers: true
+
 # Optional: set to speed up generation time by not performing a final validation pass.
 # skip_validation: true
 

diff --git a/init-templates/gqlgen.yml.gotmpl b/init-templates/gqlgen.yml.gotmpl
@@ -33,6 +33,9 @@ resolver:
 # e.g. type Thing struct { FieldA OtherThing } instead of { FieldA *OtherThing }
 # struct_fields_always_pointers: true
 
+# Optional: turn off to make resolvers return values instead of pointers for structs
+# resolvers_always_return_pointers: true
+
 # Optional: set to speed up generation time by not performing a final validation pass.
 # skip_validation: true
 

diff --git a/plugin/resolvergen/testdata/return_values/gqlgen.yml b/plugin/resolvergen/testdata/return_values/gqlgen.yml
@@ -0,0 +1,11 @@
+schema:
+  - schema.graphqls
+
+exec:
+  filename: ignored.go
+model:
+  filename: model.go
+resolver:
+  filename: resolvers.go
+
+resolvers_always_return_pointers: false