Make fieldmask output deterministic (#1950)

johanbrandhorst · web-flow · commit 69552d673bdb · 2021-02-05T11:16:48.000Z
The repeated paths parsing that was introduced in #1921 was causing tests to fail sporadically as the output of the parser was not deterministic. Sort the paths after parsing for deterministic output.
diff --git a/runtime/fieldmask.go b/runtime/fieldmask.go
@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"sort"
 
 	"google.golang.org/genproto/protobuf/field_mask"
 	"google.golang.org/protobuf/proto"
@@ -89,6 +90,10 @@ func FieldMaskFromRequestBody(r io.Reader, msg proto.Message) (*field_mask.Field
 		}
 	}
 
+	// Sort for deterministic output in the presence
+	// of repeated fields.
+	sort.Strings(fm.Paths)
+
 	return fm, nil
 }
 

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import (`
`4`	`4`	`"encoding/json"`
`5`	`5`	`"fmt"`
`6`	`6`	`"io"`
	`7`	`+ "sort"`
`7`	`8`
`8`	`9`	`"google.golang.org/genproto/protobuf/field_mask"`
`9`	`10`	`"google.golang.org/protobuf/proto"`
`@@ -89,6 +90,10 @@ func FieldMaskFromRequestBody(r io.Reader, msg proto.Message) (*field_mask.Field`
`89`	`90`	`}`
`90`	`91`	`}`
`91`	`92`
	`93`	`+ // Sort for deterministic output in the presence`
	`94`	`+ // of repeated fields.`
	`95`	`+ sort.Strings(fm.Paths)`
	`96`	`+`
`92`	`97`	`return fm, nil`
`93`	`98`	`}`
`94`	`99`