BUG/MAJOR: equal: check for nil before calling equal

on models that have Equal method we need to check first if any of the values is nil
haproxytech · Dec 1, 2023 · 3b9aa03 · 3b9aa03
1 parent f1632f3
commit 3b9aa03
Show file tree

Hide file tree

Showing 21 changed files with 2,823 additions and 153 deletions.
diff --git a/cmd/struct_equal_generator/generate.go b/cmd/struct_equal_generator/generate.go
@@ -7,11 +7,12 @@ import (
 
 func generateEqualAndDiff(opt generateEqualAndDiffOptions) error {
 	funcMaps := template.FuncMap{
-		"HasPrefix": strings.HasPrefix,
-		"Title":     toTitle,
-		"CamelCase": toCamelCase,
-		"LowerCase": toLowerCase,
-		"JSON":      toJSON,
+		"HasPrefix":  strings.HasPrefix,
+		"TrimPrefix": strings.TrimPrefix,
+		"Title":      toTitle,
+		"CamelCase":  toCamelCase,
+		"LowerCase":  toLowerCase,
+		"JSON":       toJSON,
 	}
 	tmpl, err := template.New("generate.tmpl").Funcs(funcMaps).Parse(tmplEqualAndDiff)
 	if err != nil {

diff --git a/cmd/struct_equal_generator/generate.tmpl b/cmd/struct_equal_generator/generate.tmpl
@@ -40,7 +40,43 @@ func (s {{.Data.Name}}) {{.Name}}(t {{.Data.Name}}, opts ...Options) {{- if eq $
 			{{- end }}
 		}
 	{{- else if or .HasEqual .HasEqualOpt }}
-		if !s.{{.Name}}.Equal({{if HasPrefix .Type "*"}}*{{end}}t.{{.Name}}{{if .HasEqualOpt}}, opt{{end}}) {
+	    {{if HasPrefix .Type "*"}}
+		if s.{{.Name}} == nil || t.{{.Name}} == nil {
+			if s.{{.Name}} != nil || t.{{.Name}} != nil {
+				if opt.NilSameAsEmpty {
+					{{- if eq .TypeInFile "" }}
+					empty := &{{ TrimPrefix .Type "*"}}{}
+					{{- else }}
+					empty := &{{ TrimPrefix .TypeInFile "*"}}{}
+					{{- end }}
+					if s.{{.Name}} == nil {
+						if !(t.{{.Name}}.Equal(*empty)){
+							{{- if eq $topLevel.Name "Equal" }}
+								return false
+							{{- else if eq $topLevel.Name "Diff" }}
+								diff["{{.Name}}"] = []interface{}{ {{if HasPrefix .Type "*"}}ValueOrNil({{end}}s.{{.Name}}{{if HasPrefix .Type "*"}}){{end}}, {{if HasPrefix .Type "*"}}ValueOrNil({{end}}t.{{.Name}}{{if HasPrefix .Type "*"}}){{end}} }
+							{{- end }}
+						}
+					}
+					if t.{{.Name}} == nil {
+						if !(s.{{.Name}}.Equal(*empty)){
+							{{- if eq $topLevel.Name "Equal" }}
+								return false
+							{{- else if eq $topLevel.Name "Diff" }}
+								diff["{{.Name}}"] = []interface{}{ {{if HasPrefix .Type "*"}}ValueOrNil({{end}}s.{{.Name}}{{if HasPrefix .Type "*"}}){{end}}, {{if HasPrefix .Type "*"}}ValueOrNil({{end}}t.{{.Name}}{{if HasPrefix .Type "*"}}){{end}} }
+							{{- end }}
+						}
+					}
+				} else {
+					{{- if eq $topLevel.Name "Equal" }}
+						return false
+					{{- else if eq $topLevel.Name "Diff" }}
+						diff["{{.Name}}"] = []interface{}{ {{if HasPrefix .Type "*"}}ValueOrNil({{end}}s.{{.Name}}{{if HasPrefix .Type "*"}}){{end}}, {{if HasPrefix .Type "*"}}ValueOrNil({{end}}t.{{.Name}}{{if HasPrefix .Type "*"}}){{end}} }
+					{{- end }}
+				}
+			}
+		{{- end}}
+		{{if HasPrefix .Type "*"}} } else {{end}}if !s.{{.Name}}.Equal({{if HasPrefix .Type "*"}}*{{end}}t.{{.Name}}{{if .HasEqualOpt}}, opt{{end}}) {
 			{{- if eq $topLevel.Name "Equal" }}
 				return false
 			{{- else if eq $topLevel.Name "Diff" }}

diff --git a/cmd/struct_equal_generator/main.go b/cmd/struct_equal_generator/main.go
@@ -71,7 +71,7 @@ func scanAllTypes(fileName string) []string {
 	return typesInFile
 }
 
-func generate(fileName string, args Args) (string, error) { //nolint:gocognit
+func generate(fileName string, args Args) (string, error) { //nolint:gocognit,maintidx
 	fset := token.NewFileSet()
 	var packageName string
 
@@ -165,6 +165,12 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit
 				needsOptions := false
 				needsOptionsIndex := false
 				fields, needsOptions, needsOptionsIndex = getFields(fields, currType, imports)
+				for _, f := range fields {
+					if strings.HasPrefix(f.Type, "*") && (f.HasEqualOpt || f.HasEqual) {
+						needsOptions = true
+						break
+					}
+				}
 				hasTests = true
 				err = generateEqualAndDiff(generateEqualAndDiffOptions{
 					PackageName:       packageName,