feat: add hooks arg to mutations in resource-store

Author: spy16

.golangci.yml

@@ -1,8 +1,12 @@
 run:
   go: '1.17'
   timeout: 10m
+  skip-files:
+    - expt/main.go
+
 output:
   format: colored-line-number
+
 linters:
   enable-all: true
   disable:
@@ -49,7 +53,7 @@ linters-settings:
     threshold: 100
   errcheck: # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
     check-type-assertions: true
-  goconst:   
+  goconst:
     min-len: 2 # Minimal length of string constant.
     min-occurrences: 2 # Minimum occurrences of constant string count to trigger issue.
     ignore-tests: true
@@ -120,13 +124,14 @@ linters-settings:
       - singleCaseSwitch
     enabled-tags:
       - diagnostic
-#      - style
-#      - opinionated
-#      - performance
+  #      - style
+  #      - opinionated
+  #      - performance
   unparam:
     # Inspect exported functions.
     # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
     check-exported: true
+
 issues:
   exclude-rules:
     # Exclude some linters from running on tests files.

core/mocks/resource_repository.go renamed to core/mocks/resource_repo.go

@@ -1,5 +1,7 @@
 package resource
 
+//go:generate mockery --name=Repository -r --case underscore --with-expecter --structname ResourceRepository --filename=resource_repo.go --output=../mocks
+
 import (
 	"context"
 	"encoding/json"
@@ -14,6 +16,23 @@ const urnSeparator = ":"
 
 var namingPattern = regexp.MustCompile(`^[A-Za-z][A-Za-z0-9_-]+$`)
 
+type Repository interface {
+	GetByURN(ctx context.Context, urn string) (*Resource, error)
+	List(ctx context.Context, filter map[string]string) ([]*Resource, error)
+
+	Create(ctx context.Context, r Resource, hooks ...MutationHook) error
+	Update(ctx context.Context, r Resource, hooks ...MutationHook) error
+	Delete(ctx context.Context, urn string, hooks ...MutationHook) error
+
+	DoPending(ctx context.Context, fn PendingHandler) error
+}
+
+// MutationHook values are passed to mutation operations of resource storage
+// to handle any transactional requirements.
+type MutationHook func(ctx context.Context) error
+
+type PendingHandler func(ctx context.Context, res Resource) (*Resource, bool, error)
+
 type Resource struct {
 	URN       string            `json:"urn"`
 	Kind      string            `json:"kind"`
@@ -31,18 +50,6 @@ type Spec struct {
 	Dependencies map[string]string `json:"dependencies"`
 }
 
-type Repository interface {
-	GetByURN(ctx context.Context, urn string) (*Resource, error)
-	List(ctx context.Context, filter map[string]string) ([]*Resource, error)
-	Create(ctx context.Context, r Resource) error
-	Update(ctx context.Context, r Resource) error
-	Delete(ctx context.Context, urn string) error
-
-	DoPending(ctx context.Context, fn PendingHandler) error
-}
-
-type PendingHandler func(ctx context.Context, res Resource) (*Resource, bool, error)
-
 func (res *Resource) Validate() error {
 	res.Kind = strings.TrimSpace(res.Kind)
 	res.Name = strings.TrimSpace(res.Name)

core/resource/resource.go

@@ -30,7 +30,7 @@ require (
 require (
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
 	github.com/BurntSushi/toml v1.0.0 // indirect
-	github.com/MakeNowJust/heredoc v1.0.0 // indirect
+	github.com/MakeNowJust/heredoc v1.0.0
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver/v3 v3.1.1 // indirect
 	github.com/Masterminds/sprig/v3 v3.2.2 // indirect

go.mod

@@ -54,7 +54,7 @@ func (rc *ResourceRepository) List(ctx context.Context, filter map[string]string
 	return res, nil
 }
 
-func (rc *ResourceRepository) Create(ctx context.Context, res resource.Resource) error {
+func (rc *ResourceRepository) Create(ctx context.Context, res resource.Resource, _ ...resource.MutationHook) error {
 	res.CreatedAt = time.Now()
 	res.UpdatedAt = time.Now()
 
@@ -69,7 +69,7 @@ func (rc *ResourceRepository) Create(ctx context.Context, res resource.Resource)
 	return nil
 }
 
-func (rc *ResourceRepository) Update(ctx context.Context, res resource.Resource) error {
+func (rc *ResourceRepository) Update(ctx context.Context, res resource.Resource, _ ...resource.MutationHook) error {
 	res.UpdatedAt = time.Now()
 
 	filter := map[string]interface{}{"urn": res.URN}
@@ -86,7 +86,7 @@ func (rc *ResourceRepository) Update(ctx context.Context, res resource.Resource)
 	return nil
 }
 
-func (rc *ResourceRepository) Delete(ctx context.Context, urn string) error {
+func (rc *ResourceRepository) Delete(ctx context.Context, urn string, _ ...resource.MutationHook) error {
 	_, err := rc.coll.DeleteOne(ctx, map[string]interface{}{"urn": urn})
 	if err != nil {
 		if errors.Is(err, mongo.ErrNoDocuments) {