Add omitempty to struct tags for nullable types (#2436)

Signed-off-by: Steve Coffman <[email protected]>
99designs · Mar 9, 2023 · 0bbc7f8 · 0bbc7f8
1 parent acbae6f
commit 0bbc7f8
Show file tree

Hide file tree

Showing 14 changed files with 113 additions and 106 deletions.
diff --git a/_examples/scalars/model/generated.go b/_examples/scalars/model/generated.go
diff --git a/_examples/selection/models_gen.go b/_examples/selection/models_gen.go
diff --git a/_examples/starwars/models/generated.go b/_examples/starwars/models/generated.go
diff --git a/_examples/todo/models_gen.go b/_examples/todo/models_gen.go
diff --git a/codegen/testserver/followschema/models-gen.go b/codegen/testserver/followschema/models-gen.go
diff --git a/codegen/testserver/singlefile/models-gen.go b/codegen/testserver/singlefile/models-gen.go
diff --git a/integration/models-go/generated.go b/integration/models-go/generated.go
diff --git a/plugin/federation/testdata/entityresolver/generated/models.go b/plugin/federation/testdata/entityresolver/generated/models.go
diff --git a/plugin/modelgen/models.go b/plugin/modelgen/models.go
@@ -371,7 +371,7 @@ func (m *Plugin) generateFields(cfg *config.Config, schemaType *ast.Definition)
 			GoName:      name,
 			Type:        typ,
 			Description: field.Description,
-			Tag:         `json:"` + field.Name + `"`,
+			Tag:         getStructTagFromField(field),
 		}
 
 		if m.FieldHook != nil {
@@ -388,6 +388,13 @@ func (m *Plugin) generateFields(cfg *config.Config, schemaType *ast.Definition)
 	return fields, nil
 }
 
+func getStructTagFromField(field *ast.FieldDefinition) string {
+	if !field.Type.NonNull {
+		return `json:"` + field.Name + `,omitempty"`
+	}
+	return `json:"` + field.Name + `"`
+}
+
 // GoTagFieldHook prepends the goTag directive to the generated Field f.
 // When applying the Tag to the field, the field
 // name is used if no value argument is present.

diff --git a/plugin/modelgen/models_test.go b/plugin/modelgen/models_test.go
@@ -65,13 +65,13 @@ func TestModelGeneration(t *testing.T) {
 
 		expectedTags := []string{
 			`json:"missing2" database:"MissingTypeNotNullmissing2"`,
-			`json:"name" database:"MissingInputname"`,
-			`json:"missing2" database:"MissingTypeNullablemissing2"`,
-			`json:"name" database:"TypeWithDescriptionname"`,
+			`json:"name,omitempty" database:"MissingInputname"`,
+			`json:"missing2,omitempty" database:"MissingTypeNullablemissing2"`,
+			`json:"name,omitempty" database:"TypeWithDescriptionname"`,
 		}
 
 		for _, tag := range expectedTags {
-			require.True(t, strings.Contains(fileText, tag))
+			require.True(t, strings.Contains(fileText, tag), "\nexpected:\n"+tag+"\ngot\n"+fileText)
 		}
 	})
 
@@ -82,10 +82,10 @@ func TestModelGeneration(t *testing.T) {
 		fileText := string(file)
 
 		expectedTags := []string{
-			`json:"name" anotherTag:"tag"`,
-			`json:"enum" yetAnotherTag:"12"`,
-			`json:"noVal" yaml:"noVal" repeated:"true"`,
-			`json:"repeated" someTag:"value" repeated:"true"`,
+			`json:"name,omitempty" anotherTag:"tag"`,
+			`json:"enum,omitempty" yetAnotherTag:"12"`,
+			`json:"noVal,omitempty" yaml:"noVal" repeated:"true"`,
+			`json:"repeated,omitempty" someTag:"value" repeated:"true"`,
 		}
 
 		for _, tag := range expectedTags {