fix: Ignore name attribute in issue alert conditions (#483)

jianyuan · web-flow · commit 55089cc50342 · 2024-09-05T20:21:00.000+01:00
diff --git a/go.mod b/go.mod
@@ -24,8 +24,8 @@ require (
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/yuin/goldmark v1.6.0 // indirect
 	github.com/yuin/goldmark-meta v1.1.0 // indirect
-	golang.org/x/exp v0.0.0-20230809150735-7b3493d9a819 // indirect
-	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
+	golang.org/x/exp v0.0.0-20240904232852-e7e105dedf7e // indirect
+	golang.org/x/tools v0.24.0 // indirect
 	gopkg.in/yaml.v2 v2.3.0 // indirect
 )
 
@@ -80,8 +80,8 @@ require (
 	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
 	github.com/zclconf/go-cty v1.15.0 // indirect
 	golang.org/x/crypto v0.26.0 // indirect
-	golang.org/x/mod v0.19.0 // indirect
-	golang.org/x/net v0.25.0 // indirect
+	golang.org/x/mod v0.20.0 // indirect
+	golang.org/x/net v0.28.0 // indirect
 	golang.org/x/sys v0.23.0 // indirect
 	golang.org/x/text v0.17.0 // indirect
 	google.golang.org/appengine v1.6.8 // indirect
diff --git a/go.sum b/go.sum
@@ -261,11 +261,15 @@ golang.org/x/crypto v0.26.0 h1:RrRspgV4mU+YwB4FYnuBoKsUapNIL5cohGAmSH3azsw=
 golang.org/x/crypto v0.26.0/go.mod h1:GY7jblb9wI+FOo5y8/S2oY4zWP07AkOJ4+jxCqdqn54=
 golang.org/x/exp v0.0.0-20230809150735-7b3493d9a819 h1:EDuYyU/MkFXllv9QF9819VlI9a4tzGuCbhG0ExK9o1U=
 golang.org/x/exp v0.0.0-20230809150735-7b3493d9a819/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc=
+golang.org/x/exp v0.0.0-20240904232852-e7e105dedf7e h1:I88y4caeGeuDQxgdoFPUq097j7kNfw6uvuiNxUBfcBk=
+golang.org/x/exp v0.0.0-20240904232852-e7e105dedf7e/go.mod h1:akd2r19cwCdwSwWeIdzYQGa/EZZyqcOdwWiwj5L5eKQ=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
 golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA=
 golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
 golang.org/x/mod v0.19.0 h1:fEdghXQSo20giMthA7cd28ZC+jts4amQ3YMXiP5oMQ8=
 golang.org/x/mod v0.19.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
+golang.org/x/mod v0.20.0 h1:utOm6MM3R3dnawAiJgn0y+xvuYRsm1RKM/4giyfDgV0=
+golang.org/x/mod v0.20.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
@@ -275,6 +279,8 @@ golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w=
 golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
 golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
 golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
+golang.org/x/net v0.28.0 h1:a9JDOJc5GMUJ0+UDqmLT86WiEy7iWyIhz8gz8E4e5hE=
+golang.org/x/net v0.28.0/go.mod h1:yqtgsTWOOnlGLG9GFRrK3++bGOUEkNBoHZc8MEDWPNg=
 golang.org/x/oauth2 v0.20.0 h1:4mQdhULixXKP1rwYBW0vAijoXnkTG0BLCDRzfe1idMo=
 golang.org/x/oauth2 v0.20.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI=
 golang.org/x/oauth2 v0.21.0 h1:tsimM75w1tF/uws5rbeHzIWxEqElMehnc+iW793zsZs=
@@ -335,6 +341,7 @@ golang.org/x/tools v0.20.0 h1:hz/CVckiOxybQvFw6h7b/q80NTr9IUQb4s1IIzW7KNY=
 golang.org/x/tools v0.20.0/go.mod h1:WvitBU7JJf6A4jOdg4S1tviW9bhUxkgeCui/0JHctQg=
 golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d h1:vU5i/LfpvrRCpgM/VPfJLg5KjxD3E+hfT1SH+d9zLwg=
 golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
+golang.org/x/tools v0.24.0/go.mod h1:YhNqVBIfWHdzvTLs0d8LCuMhkKUgSUKldakyV7W/WDQ=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
diff --git a/internal/provider/resource_issue_alert.go b/internal/provider/resource_issue_alert.go
@@ -137,7 +137,9 @@ Please note the following changes since v0.12.0:
 			"conditions": schema.StringAttribute{
 				MarkdownDescription: "List of conditions. In JSON string format.",
 				Required:            true,
-				CustomType:          sentrytypes.LossyJsonType{},
+				CustomType: sentrytypes.LossyJsonType{
+					IgnoreKeys: []string{"name"},
+				},
 			},
 			"filters": schema.StringAttribute{
 				MarkdownDescription: "A list of filters that determine if a rule fires after the necessary conditions have been met. In JSON string format.",
diff --git a/internal/provider/resource_issue_alert_test.go b/internal/provider/resource_issue_alert_test.go
@@ -374,7 +374,8 @@ resource "sentry_issue_alert" "test" {
 	conditions = <<EOT
 [
 	{
-		"id": "sentry.rules.conditions.first_seen_event.FirstSeenEventCondition"
+		"id": "sentry.rules.conditions.first_seen_event.FirstSeenEventCondition",
+		"name": "ignored"
 	},
 	{
 		"id": "sentry.rules.conditions.regression_event.RegressionEventCondition"
diff --git a/internal/sentrytypes/lossy_json_type.go b/internal/sentrytypes/lossy_json_type.go
@@ -16,14 +16,18 @@ var _ basetypes.StringTypable = (*LossyJsonType)(nil)
 
 type LossyJsonType struct {
 	basetypes.StringType
+
+	IgnoreKeys []string
 }
 
 func (t LossyJsonType) String() string {
 	return "sentrytypes.LossyJsonType"
 }
 
 func (t LossyJsonType) ValueType(_ context.Context) attr.Value {
-	return LossyJson{}
+	return LossyJson{
+		IgnoreKeys: t.IgnoreKeys,
+	}
 }
 
 func (t LossyJsonType) Equal(o attr.Type) bool {
@@ -88,6 +92,7 @@ func (t LossyJsonType) Validate(ctx context.Context, in tftypes.Value, path path
 func (t LossyJsonType) ValueFromString(ctx context.Context, in basetypes.StringValue) (basetypes.StringValuable, diag.Diagnostics) {
 	return LossyJson{
 		StringValue: in,
+		IgnoreKeys:  t.IgnoreKeys,
 	}, nil
 }
 
diff --git a/internal/sentrytypes/lossy_json_value.go b/internal/sentrytypes/lossy_json_value.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
@@ -16,6 +17,8 @@ var _ basetypes.StringValuableWithSemanticEquals = (*LossyJson)(nil)
 
 type LossyJson struct {
 	basetypes.StringValue
+
+	IgnoreKeys []string
 }
 
 func (v LossyJson) Type(_ context.Context) attr.Type {
@@ -48,7 +51,7 @@ func (v LossyJson) StringSemanticEquals(_ context.Context, newValuable basetypes
 		return false, diags
 	}
 
-	result, err := lossyJsonEqual(newValue.ValueString(), v.ValueString())
+	result, err := lossyJsonEqual(newValue.ValueString(), v.ValueString(), v.IgnoreKeys)
 
 	if err != nil {
 		diags.AddError(
@@ -64,7 +67,7 @@ func (v LossyJson) StringSemanticEquals(_ context.Context, newValuable basetypes
 	return result, diags
 }
 
-func lossyJsonEqual(s1, s2 string) (bool, error) {
+func lossyJsonEqual(s1, s2 string, ignoreKeys []string) (bool, error) {
 	v1, err := decodeJson(s1)
 	if err != nil {
 		return false, err
@@ -75,7 +78,7 @@ func lossyJsonEqual(s1, s2 string) (bool, error) {
 		return false, err
 	}
 
-	return deepLossyEqual(v1, v2), nil
+	return deepLossyEqual(v1, v2, ignoreKeys), nil
 }
 
 func decodeJson(s string) (interface{}, error) {
@@ -90,7 +93,7 @@ func decodeJson(s string) (interface{}, error) {
 	return v, nil
 }
 
-func deepLossyEqual(v1, v2 interface{}) bool {
+func deepLossyEqual(v1, v2 interface{}, ignoreKeys []string) bool {
 	switch v1 := v1.(type) {
 	case bool:
 		v2, ok := v2.(bool)
@@ -127,7 +130,7 @@ func deepLossyEqual(v1, v2 interface{}) bool {
 		}
 
 		for i := 0; i < len(v1); i++ {
-			if !deepLossyEqual(v1[i], v2[i]) {
+			if !deepLossyEqual(v1[i], v2[i], ignoreKeys) {
 				return false
 			}
 		}
@@ -145,12 +148,16 @@ func deepLossyEqual(v1, v2 interface{}) bool {
 
 		// Check that all keys in v1 are in v2 but not the other way around (lossy)
 		for k := range v1 {
+			if slices.Contains(ignoreKeys, k) {
+				continue
+			}
+
 			v2Val, ok := v2[k]
 			if !ok {
 				return false
 			}
 
-			if !deepLossyEqual(v1[k], v2Val) {
+			if !deepLossyEqual(v1[k], v2Val, ignoreKeys) {
 				return false
 			}
 		}

Original file line number	Diff line number	Diff line change
`@@ -374,7 +374,8 @@ resource "sentry_issue_alert" "test" {`
`374`	`374`	`conditions = <<EOT`
`375`	`375`	`[`
`376`	`376`	`{`
`377`		`- "id": "sentry.rules.conditions.first_seen_event.FirstSeenEventCondition"`
	`377`	`+ "id": "sentry.rules.conditions.first_seen_event.FirstSeenEventCondition",`
	`378`	`+ "name": "ignored"`
`378`	`379`	`},`
`379`	`380`	`{`
`380`	`381`	`"id": "sentry.rules.conditions.regression_event.RegressionEventCondition"`
Original file line number	Diff line number	Diff line change
`@@ -16,14 +16,18 @@ var _ basetypes.StringTypable = (*LossyJsonType)(nil)`
`16`	`16`
`17`	`17`	`type LossyJsonType struct {`
`18`	`18`	`basetypes.StringType`
	`19`	`+`
	`20`	`+ IgnoreKeys []string`
`19`	`21`	`}`
`20`	`22`
`21`	`23`	`func (t LossyJsonType) String() string {`
`22`	`24`	`return "sentrytypes.LossyJsonType"`
`23`	`25`	`}`
`24`	`26`
`25`	`27`	`func (t LossyJsonType) ValueType(_ context.Context) attr.Value {`
`26`		`- return LossyJson{}`
	`28`	`+ return LossyJson{`
	`29`	`+ IgnoreKeys: t.IgnoreKeys,`
	`30`	`+ }`
`27`	`31`	`}`
`28`	`32`
`29`	`33`	`func (t LossyJsonType) Equal(o attr.Type) bool {`
`@@ -88,6 +92,7 @@ func (t LossyJsonType) Validate(ctx context.Context, in tftypes.Value, path path`
`88`	`92`	`func (t LossyJsonType) ValueFromString(ctx context.Context, in basetypes.StringValue) (basetypes.StringValuable, diag.Diagnostics) {`
`89`	`93`	`return LossyJson{`
`90`	`94`	`StringValue: in,`
	`95`	`+ IgnoreKeys: t.IgnoreKeys,`
`91`	`96`	`}, nil`
`92`	`97`	`}`
`93`	`98`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import (`
`4`	`4`	`"context"`
`5`	`5`	`"encoding/json"`
`6`	`6`	`"fmt"`
	`7`	`+ "slices"`
`7`	`8`	`"strings"`
`8`	`9`
`9`	`10`	`"github.com/hashicorp/terraform-plugin-framework/attr"`
`@@ -16,6 +17,8 @@ var _ basetypes.StringValuableWithSemanticEquals = (*LossyJson)(nil)`
`16`	`17`
`17`	`18`	`type LossyJson struct {`
`18`	`19`	`basetypes.StringValue`
	`20`	`+`
	`21`	`+ IgnoreKeys []string`
`19`	`22`	`}`
`20`	`23`
`21`	`24`	`func (v LossyJson) Type(_ context.Context) attr.Type {`
`@@ -48,7 +51,7 @@ func (v LossyJson) StringSemanticEquals(_ context.Context, newValuable basetypes`
`48`	`51`	`return false, diags`
`49`	`52`	`}`
`50`	`53`
`51`		`- result, err := lossyJsonEqual(newValue.ValueString(), v.ValueString())`
	`54`	`+ result, err := lossyJsonEqual(newValue.ValueString(), v.ValueString(), v.IgnoreKeys)`
`52`	`55`
`53`	`56`	`if err != nil {`
`54`	`57`	`diags.AddError(`
`@@ -64,7 +67,7 @@ func (v LossyJson) StringSemanticEquals(_ context.Context, newValuable basetypes`
`64`	`67`	`return result, diags`
`65`	`68`	`}`
`66`	`69`
`67`		`-func lossyJsonEqual(s1, s2 string) (bool, error) {`
	`70`	`+func lossyJsonEqual(s1, s2 string, ignoreKeys []string) (bool, error) {`
`68`	`71`	`v1, err := decodeJson(s1)`
`69`	`72`	`if err != nil {`
`70`	`73`	`return false, err`
`@@ -75,7 +78,7 @@ func lossyJsonEqual(s1, s2 string) (bool, error) {`
`75`	`78`	`return false, err`
`76`	`79`	`}`
`77`	`80`
`78`		`- return deepLossyEqual(v1, v2), nil`
	`81`	`+ return deepLossyEqual(v1, v2, ignoreKeys), nil`
`79`	`82`	`}`
`80`	`83`
`81`	`84`	`func decodeJson(s string) (interface{}, error) {`
`@@ -90,7 +93,7 @@ func decodeJson(s string) (interface{}, error) {`
`90`	`93`	`return v, nil`
`91`	`94`	`}`
`92`	`95`
`93`		`-func deepLossyEqual(v1, v2 interface{}) bool {`
	`96`	`+func deepLossyEqual(v1, v2 interface{}, ignoreKeys []string) bool {`
`94`	`97`	`switch v1 := v1.(type) {`
`95`	`98`	`case bool:`
`96`	`99`	`v2, ok := v2.(bool)`
`@@ -127,7 +130,7 @@ func deepLossyEqual(v1, v2 interface{}) bool {`
`127`	`130`	`}`
`128`	`131`
`129`	`132`	`for i := 0; i < len(v1); i++ {`
`130`		`- if !deepLossyEqual(v1[i], v2[i]) {`
	`133`	`+ if !deepLossyEqual(v1[i], v2[i], ignoreKeys) {`
`131`	`134`	`return false`
`132`	`135`	`}`
`133`	`136`	`}`
`@@ -145,12 +148,16 @@ func deepLossyEqual(v1, v2 interface{}) bool {`
`145`	`148`
`146`	`149`	`// Check that all keys in v1 are in v2 but not the other way around (lossy)`
`147`	`150`	`for k := range v1 {`
	`151`	`+ if slices.Contains(ignoreKeys, k) {`
	`152`	`+ continue`
	`153`	`+ }`
	`154`	`+`
`148`	`155`	`v2Val, ok := v2[k]`
`149`	`156`	`if !ok {`
`150`	`157`	`return false`
`151`	`158`	`}`
`152`	`159`
`153`		`- if !deepLossyEqual(v1[k], v2Val) {`
	`160`	`+ if !deepLossyEqual(v1[k], v2Val, ignoreKeys) {`
`154`	`161`	`return false`
`155`	`162`	`}`
`156`	`163`	`}`