Skip hashing annotations (#267)

* add option to ignore annotations for the purposes of hashing a resource
* ch

api/v1/solo-kit.proto

@@ -20,6 +20,9 @@ message Resource {
     bool cluster_scoped = 3;
     // indicates whether documentation generation has to be skipped for the given resource, defaults to false
     bool skip_docs_gen = 4;
+    // indicates whether annotations should be excluded from the resource's generated hash function.
+    // if set to true, changes in annotations will not cause a new snapshot to be emitted
+    bool skip_hashing_annotations = 5;
 }
 
 extend google.protobuf.FieldOptions {

changelog/v0.10.18/skip-annotations.yaml

@@ -0,0 +1,4 @@
+changelog:
+  - type: NEW_FEATURE
+    description: add option to ignore annotations for the purposes of hashing a resource
+    issueLink: https://github.com/solo-io/solo-kit/pull/266

pkg/code-generator/codegen/templates/resource_template.go

@@ -61,6 +61,10 @@ func (r *{{ .Name }}) Hash() uint64 {
 
 	resources.UpdateMetadata(clone, func(meta *core.Metadata) {
 		meta.ResourceVersion = ""
+
+		{{- if $.SkipHashingAnnotations }}
+		meta.Annotations = nil
+		{{- end }}
 	})
 
 	return hashutils.HashAll(clone)
@@ -82,6 +86,9 @@ func (r *{{ .Name }}) SetStatus(status core.Status) {
 func (r *{{ .Name }}) Hash() uint64 {
 	metaCopy := r.GetMetadata()
 	metaCopy.ResourceVersion = ""
+	{{- if $.SkipHashingAnnotations }}
+	metaCopy.Annotations = nil
+	{{- end }}
 	return hashutils.HashAll(
 		metaCopy,
 {{- range .Fields }}

pkg/code-generator/model/project.go

@@ -64,11 +64,11 @@ type CustomResourceConfig struct {
 	// the import path for the Go Type
 	Package string `json:"package"`
 	// the name of the Go Type
-	Type          string `json:"type"`
-	PluralName    string `json:"plural_name"`
-	ShortName     string `json:"short_name"`
-	ClusterScoped bool   `json:"cluster_scoped"`
-
+	Type                   string `json:"type"`
+	PluralName             string `json:"plural_name"`
+	ShortName              string `json:"short_name"`
+	ClusterScoped          bool   `json:"cluster_scoped"`
+	SkipHashingAnnotations bool   `json:"skip_hashing_annotations"`
 	// set by load
 	Imported bool
 }
@@ -102,6 +102,8 @@ type Resource struct {
 	CustomResource     CustomResourceConfig // this struct will be empty unless IsCustom is true
 	CustomImportPrefix string               // import prefix for the struct type the generated wrapper will wrap
 
+	SkipHashingAnnotations bool // if true, zero out annotations in the generated hash func
+
 	Fields []*Field
 	Oneofs []*Oneof
 

pkg/code-generator/parser/parser_resource.go

@@ -97,16 +97,17 @@ func getResources(project *model.Project, allProjectConfigs []*model.ProjectConf
 		impPrefix = strings.Replace(impPrefix, ".", "_", -1)
 		impPrefix = strings.Replace(impPrefix, "-", "_", -1)
 		resources = append(resources, &model.Resource{
-			Name:               custom.Type,
-			ShortName:          custom.ShortName,
-			PluralName:         custom.PluralName,
-			GoPackage:          custom.Package,
-			ClusterScoped:      custom.ClusterScoped,
-			CustomImportPrefix: impPrefix,
-			SkipDocsGen:        true,
-			Project:            project,
-			IsCustom:           true,
-			CustomResource:     custom,
+			Name:                   custom.Type,
+			ShortName:              custom.ShortName,
+			PluralName:             custom.PluralName,
+			GoPackage:              custom.Package,
+			ClusterScoped:          custom.ClusterScoped,
+			SkipHashingAnnotations: custom.SkipHashingAnnotations,
+			CustomImportPrefix:     impPrefix,
+			SkipDocsGen:            true,
+			Project:                project,
+			IsCustom:               true,
+			CustomResource:         custom,
 		})
 	}
 
@@ -193,8 +194,8 @@ func describeResource(messageWrapper ProtoMessageWrapper) (*model.Resource, erro
 
 	name := msg.GetName()
 	var (
-		shortName, pluralName      string
-		clusterScoped, skipDocsGen bool
+		shortName, pluralName                              string
+		clusterScoped, skipDocsGen, skipHashingAnnotations bool
 	)
 	resourceOpts, err := proto.GetExtension(msg.Options, core.E_Resource)
 	if err != nil {
@@ -220,6 +221,7 @@ func describeResource(messageWrapper ProtoMessageWrapper) (*model.Resource, erro
 		pluralName = res.PluralName
 		clusterScoped = res.ClusterScoped
 		skipDocsGen = res.SkipDocsGen
+		skipHashingAnnotations = res.SkipHashingAnnotations
 	}
 
 	// always make it upper camel
@@ -231,17 +233,18 @@ func describeResource(messageWrapper ProtoMessageWrapper) (*model.Resource, erro
 	oneofs := collectOneofs(msg)
 
 	return &model.Resource{
-		Name:          name,
-		ProtoPackage:  msg.GetPackage(),
-		GoPackage:     messageWrapper.GoPackage,
-		ShortName:     shortName,
-		PluralName:    pluralName,
-		HasStatus:     hasStatus,
-		Fields:        fields,
-		Oneofs:        oneofs,
-		ClusterScoped: clusterScoped,
-		SkipDocsGen:   skipDocsGen,
-		Filename:      msg.GetFile().GetName(),
-		Original:      msg,
+		Name:                   name,
+		ProtoPackage:           msg.GetPackage(),
+		GoPackage:              messageWrapper.GoPackage,
+		ShortName:              shortName,
+		PluralName:             pluralName,
+		HasStatus:              hasStatus,
+		Fields:                 fields,
+		Oneofs:                 oneofs,
+		ClusterScoped:          clusterScoped,
+		SkipHashingAnnotations: skipHashingAnnotations,
+		SkipDocsGen:            skipDocsGen,
+		Filename:               msg.GetFile().GetName(),
+		Original:               msg,
 	}, nil
 }

test/mocks/api/v2alpha1/mock_resources.proto

@@ -28,3 +28,13 @@ message MockResource {
         bool oneof_two = 2;
     };
 }
+
+message FrequentlyChangingAnnotationsResource {
+    option (core.solo.io.resource).short_name = "fcar";
+    option (core.solo.io.resource).plural_name = "fcars";
+    option (core.solo.io.resource).skip_hashing_annotations = true;
+
+    core.solo.io.Metadata metadata = 7 [(gogoproto.nullable) = false];
+
+    string blah = 1 ;
+}

test/mocks/tests/resource_hashing_test.go

@@ -5,6 +5,7 @@ import (
 	. "github.com/onsi/gomega"
 	"github.com/solo-io/solo-kit/pkg/api/v1/resources/core"
 	v1 "github.com/solo-io/solo-kit/test/mocks/v1"
+	"github.com/solo-io/solo-kit/test/mocks/v2alpha1"
 )
 
 var _ = Describe("Resource Hashing", func() {
@@ -17,6 +18,18 @@ var _ = Describe("Resource Hashing", func() {
 		Expect(originalSnap.Hash()).To(Equal(snapWithInsensitiveChanged.Hash()))
 		Expect(originalSnap.Hash()).NotTo(Equal(snapWithSensitiveChanged.Hash()))
 	})
+	Context("skip_hashing_annotations=true", func() {
+		It("ignores the resource meta annotations in the hash", func() {
+			res1 := v2alpha1.NewFrequentlyChangingAnnotationsResource("a", "b")
+			res2 := v2alpha1.NewFrequentlyChangingAnnotationsResource("a", "b")
+
+			// sanity check
+			Expect(res1.Hash()).To(Equal(res2.Hash()))
+
+			res1.Metadata.Annotations = map[string]string{"ignore": "me"}
+			Expect(res1.Hash()).To(Equal(res2.Hash()))
+		})
+	})
 })
 
 func snapWithFields(hashSensitiveField, hashInsensitiveField string) *v1.TestingSnapshot {