Alerting: Resource-level write locking for resources backed by UA config file (#602)

alexweav · web-flow · commit fb8979dfa20a · 2022-08-23T11:28:03.000-05:00
* Resource-level locking for resources backed by UA config file

* Regenerate docs

* Regenerate docs
diff --git a/docs/resources/notification_policy.md b/docs/resources/notification_policy.md
@@ -29,10 +29,6 @@ resource "grafana_mute_timing" "a_mute_timing" {
     intervals {
         weekdays = ["monday"]
     }
-
-    depends_on = [
-        grafana_contact_point.a_contact_point
-    ]
 }
 
 
diff --git a/examples/resources/grafana_notification_policy/resource.tf b/examples/resources/grafana_notification_policy/resource.tf
@@ -13,10 +13,6 @@ resource "grafana_mute_timing" "a_mute_timing" {
     intervals {
         weekdays = ["monday"]
     }
-
-    depends_on = [
-        grafana_contact_point.a_contact_point
-    ]
 }
 
 
diff --git a/grafana/provider.go b/grafana/provider.go
@@ -10,6 +10,7 @@ import (
 	"os"
 	"regexp"
 	"strings"
+	"sync"
 
 	"github.com/hashicorp/go-cleanhttp"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -258,6 +259,8 @@ type client struct {
 	mlapi *mlapi.Client
 
 	onCallAPI *onCallAPI.Client
+
+	alertingMutex sync.Mutex
 }
 
 func configure(version string, p *schema.Provider) func(context.Context, *schema.ResourceData) (interface{}, diag.Diagnostics) {
diff --git a/grafana/resource_alerting_contact_point.go b/grafana/resource_alerting_contact_point.go
@@ -99,10 +99,14 @@ func readContactPoint(ctx context.Context, data *schema.ResourceData, meta inter
 }
 
 func createContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	ps := unpackContactPoints(data)
 	uids := make([]string, 0, len(ps))
+
+	lock.Lock()
+	defer lock.Unlock()
 	for i := range ps {
 		uid, err := client.NewContactPoint(&ps[i])
 		if err != nil {
@@ -116,13 +120,16 @@ func createContactPoint(ctx context.Context, data *schema.ResourceData, meta int
 }
 
 func updateContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	existingUIDs := unpackUIDs(data.Id())
 	ps := unpackContactPoints(data)
 
 	unprocessedUIDs := toUIDSet(existingUIDs)
 	newUIDs := make([]string, 0, len(ps))
+	lock.Lock()
+	defer lock.Unlock()
 	for i := range ps {
 		delete(unprocessedUIDs, ps[i].UID)
 		err := client.UpdateContactPoint(&ps[i])
@@ -154,9 +161,13 @@ func updateContactPoint(ctx context.Context, data *schema.ResourceData, meta int
 }
 
 func deleteContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	uids := unpackUIDs(data.Id())
+
+	lock.Lock()
+	defer lock.Unlock()
 	for _, uid := range uids {
 		if err := client.DeleteContactPoint(uid); err != nil {
 			return diag.FromErr(err)
diff --git a/grafana/resource_alerting_message_template.go b/grafana/resource_alerting_message_template.go
@@ -62,10 +62,13 @@ func readMessageTemplate(ctx context.Context, data *schema.ResourceData, meta in
 }
 
 func createMessageTemplate(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 	name := data.Get("name").(string)
 	content := data.Get("template").(string)
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.SetMessageTemplate(name, content); err != nil {
 		return diag.FromErr(err)
 	}
@@ -75,10 +78,13 @@ func createMessageTemplate(ctx context.Context, data *schema.ResourceData, meta
 }
 
 func updateMessageTemplate(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 	name := data.Get("name").(string)
 	content := data.Get("template").(string)
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.SetMessageTemplate(name, content); err != nil {
 		return diag.FromErr(err)
 	}
@@ -87,11 +93,15 @@ func updateMessageTemplate(ctx context.Context, data *schema.ResourceData, meta
 }
 
 func deleteMessageTemplate(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 	name := data.Id()
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.DeleteMessageTemplate(name); err != nil {
 		return diag.FromErr(err)
 	}
+
 	return diag.Diagnostics{}
 }
diff --git a/grafana/resource_alerting_mute_timing.go b/grafana/resource_alerting_mute_timing.go
@@ -127,9 +127,13 @@ func readMuteTiming(ctx context.Context, data *schema.ResourceData, meta interfa
 }
 
 func createMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	mt := unpackMuteTiming(data)
+
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.NewMuteTiming(&mt); err != nil {
 		return diag.FromErr(err)
 	}
@@ -139,20 +143,26 @@ func createMuteTiming(ctx context.Context, data *schema.ResourceData, meta inter
 }
 
 func updateMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	mt := unpackMuteTiming(data)
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.UpdateMuteTiming(&mt); err != nil {
 		return diag.FromErr(err)
 	}
 	return readMuteTiming(ctx, data, meta)
 }
 
 func deleteMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 	name := data.Id()
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.DeleteMuteTiming(name); err != nil {
 		return diag.FromErr(err)
 	}
diff --git a/grafana/resource_alerting_notification_policy.go b/grafana/resource_alerting_notification_policy.go
@@ -174,13 +174,16 @@ func readNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta
 }
 
 func createNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	npt, err := unpackNotifPolicy(data)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.SetNotificationPolicyTree(&npt); err != nil {
 		return diag.FromErr(err)
 	}
@@ -190,13 +193,16 @@ func createNotificationPolicy(ctx context.Context, data *schema.ResourceData, me
 }
 
 func updateNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
 	npt, err := unpackNotifPolicy(data)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.SetNotificationPolicyTree(&npt); err != nil {
 		return diag.FromErr(err)
 	}
@@ -205,11 +211,15 @@ func updateNotificationPolicy(ctx context.Context, data *schema.ResourceData, me
 }
 
 func deleteNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	lock := &meta.(*client).alertingMutex
 	client := meta.(*client).gapi
 
+	lock.Lock()
+	defer lock.Unlock()
 	if err := client.ResetNotificationPolicyTree(); err != nil {
 		return diag.FromErr(err)
 	}
+
 	return diag.Diagnostics{}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,6 @@ resource "grafana_mute_timing" "a_mute_timing" {`
`29`	`29`	`intervals {`
`30`	`30`	`weekdays = ["monday"]`
`31`	`31`	`}`
`32`		`-`
`33`		`- depends_on = [`
`34`		`- grafana_contact_point.a_contact_point`
`35`		`- ]`
`36`	`32`	`}`
`37`	`33`
`38`	`34`
Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,6 @@ resource "grafana_mute_timing" "a_mute_timing" {`
`13`	`13`	`intervals {`
`14`	`14`	`weekdays = ["monday"]`
`15`	`15`	`}`
`16`		`-`
`17`		`- depends_on = [`
`18`		`- grafana_contact_point.a_contact_point`
`19`		`- ]`
`20`	`16`	`}`
`21`	`17`
`22`	`18`
Original file line number	Diff line number	Diff line change
`@@ -62,10 +62,13 @@ func readMessageTemplate(ctx context.Context, data *schema.ResourceData, meta in`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`func createMessageTemplate(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`65`	`+ lock := &meta.(*client).alertingMutex`
`65`	`66`	`client := meta.(*client).gapi`
`66`	`67`	`name := data.Get("name").(string)`
`67`	`68`	`content := data.Get("template").(string)`
`68`	`69`
	`70`	`+ lock.Lock()`
	`71`	`+ defer lock.Unlock()`
`69`	`72`	`if err := client.SetMessageTemplate(name, content); err != nil {`
`70`	`73`	`return diag.FromErr(err)`
`71`	`74`	`}`
`@@ -75,10 +78,13 @@ func createMessageTemplate(ctx context.Context, data *schema.ResourceData, meta`
`75`	`78`	`}`
`76`	`79`
`77`	`80`	`func updateMessageTemplate(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`81`	`+ lock := &meta.(*client).alertingMutex`
`78`	`82`	`client := meta.(*client).gapi`
`79`	`83`	`name := data.Get("name").(string)`
`80`	`84`	`content := data.Get("template").(string)`
`81`	`85`
	`86`	`+ lock.Lock()`
	`87`	`+ defer lock.Unlock()`
`82`	`88`	`if err := client.SetMessageTemplate(name, content); err != nil {`
`83`	`89`	`return diag.FromErr(err)`
`84`	`90`	`}`
`@@ -87,11 +93,15 @@ func updateMessageTemplate(ctx context.Context, data *schema.ResourceData, meta`
`87`	`93`	`}`
`88`	`94`
`89`	`95`	`func deleteMessageTemplate(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`96`	`+ lock := &meta.(*client).alertingMutex`
`90`	`97`	`client := meta.(*client).gapi`
`91`	`98`	`name := data.Id()`
`92`	`99`
	`100`	`+ lock.Lock()`
	`101`	`+ defer lock.Unlock()`
`93`	`102`	`if err := client.DeleteMessageTemplate(name); err != nil {`
`94`	`103`	`return diag.FromErr(err)`
`95`	`104`	`}`
	`105`	`+`
`96`	`106`	`return diag.Diagnostics{}`
`97`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -127,9 +127,13 @@ func readMuteTiming(ctx context.Context, data *schema.ResourceData, meta interfa`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`func createMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`130`	`+ lock := &meta.(*client).alertingMutex`
`130`	`131`	`client := meta.(*client).gapi`
`131`	`132`
`132`	`133`	`mt := unpackMuteTiming(data)`
	`134`	`+`
	`135`	`+ lock.Lock()`
	`136`	`+ defer lock.Unlock()`
`133`	`137`	`if err := client.NewMuteTiming(&mt); err != nil {`
`134`	`138`	`return diag.FromErr(err)`
`135`	`139`	`}`
`@@ -139,20 +143,26 @@ func createMuteTiming(ctx context.Context, data *schema.ResourceData, meta inter`
`139`	`143`	`}`
`140`	`144`
`141`	`145`	`func updateMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`146`	`+ lock := &meta.(*client).alertingMutex`
`142`	`147`	`client := meta.(*client).gapi`
`143`	`148`
`144`	`149`	`mt := unpackMuteTiming(data)`
`145`	`150`
	`151`	`+ lock.Lock()`
	`152`	`+ defer lock.Unlock()`
`146`	`153`	`if err := client.UpdateMuteTiming(&mt); err != nil {`
`147`	`154`	`return diag.FromErr(err)`
`148`	`155`	`}`
`149`	`156`	`return readMuteTiming(ctx, data, meta)`
`150`	`157`	`}`
`151`	`158`
`152`	`159`	`func deleteMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`160`	`+ lock := &meta.(*client).alertingMutex`
`153`	`161`	`client := meta.(*client).gapi`
`154`	`162`	`name := data.Id()`
`155`	`163`
	`164`	`+ lock.Lock()`
	`165`	`+ defer lock.Unlock()`
`156`	`166`	`if err := client.DeleteMuteTiming(name); err != nil {`
`157`	`167`	`return diag.FromErr(err)`
`158`	`168`	`}`
Original file line number	Diff line number	Diff line change
`@@ -174,13 +174,16 @@ func readNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`func createNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`177`	`+ lock := &meta.(*client).alertingMutex`
`177`	`178`	`client := meta.(*client).gapi`
`178`	`179`
`179`	`180`	`npt, err := unpackNotifPolicy(data)`
`180`	`181`	`if err != nil {`
`181`	`182`	`return diag.FromErr(err)`
`182`	`183`	`}`
`183`	`184`
	`185`	`+ lock.Lock()`
	`186`	`+ defer lock.Unlock()`
`184`	`187`	`if err := client.SetNotificationPolicyTree(&npt); err != nil {`
`185`	`188`	`return diag.FromErr(err)`
`186`	`189`	`}`
`@@ -190,13 +193,16 @@ func createNotificationPolicy(ctx context.Context, data *schema.ResourceData, me`
`190`	`193`	`}`
`191`	`194`
`192`	`195`	`func updateNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`196`	`+ lock := &meta.(*client).alertingMutex`
`193`	`197`	`client := meta.(*client).gapi`
`194`	`198`
`195`	`199`	`npt, err := unpackNotifPolicy(data)`
`196`	`200`	`if err != nil {`
`197`	`201`	`return diag.FromErr(err)`
`198`	`202`	`}`
`199`	`203`
	`204`	`+ lock.Lock()`
	`205`	`+ defer lock.Unlock()`
`200`	`206`	`if err := client.SetNotificationPolicyTree(&npt); err != nil {`
`201`	`207`	`return diag.FromErr(err)`
`202`	`208`	`}`
`@@ -205,11 +211,15 @@ func updateNotificationPolicy(ctx context.Context, data *schema.ResourceData, me`
`205`	`211`	`}`
`206`	`212`
`207`	`213`	`func deleteNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {`
	`214`	`+ lock := &meta.(*client).alertingMutex`
`208`	`215`	`client := meta.(*client).gapi`
`209`	`216`
	`217`	`+ lock.Lock()`
	`218`	`+ defer lock.Unlock()`
`210`	`219`	`if err := client.ResetNotificationPolicyTree(); err != nil {`
`211`	`220`	`return diag.FromErr(err)`
`212`	`221`	`}`
	`222`	`+`
`213`	`223`	`return diag.Diagnostics{}`
`214`	`224`	`}`
`215`	`225`