fix(solver) resolve a data race with ops counters

Author: hbagdi

cmd/common.go

@@ -153,14 +153,14 @@ func syncMain(ctx context.Context, filenames []string, dry bool, parallelism,
 	stats, errs := solver.Solve(ctx, s, wsClient, nil, parallelism, dry)
 	printFn := color.New(color.FgGreen, color.Bold).PrintfFunc()
 	printFn("Summary:\n")
-	printFn("  Created: %v\n", stats.CreateOps)
-	printFn("  Updated: %v\n", stats.UpdateOps)
-	printFn("  Deleted: %v\n", stats.DeleteOps)
+	printFn("  Created: %v\n", stats.CreateOps.Read())
+	printFn("  Updated: %v\n", stats.UpdateOps.Read())
+	printFn("  Deleted: %v\n", stats.DeleteOps.Read())
 	if errs != nil {
 		return utils.ErrArray{Errors: errs}
 	}
 	if diffCmdNonZeroExitCode &&
-		stats.CreateOps+stats.UpdateOps+stats.DeleteOps != 0 {
+		stats.CreateOps.Read()+stats.UpdateOps.Read()+stats.DeleteOps.Read() != 0 {
 		os.Exit(exitCodeDiffDetection)
 	}
 	return nil

cmd/common_konnect.go

@@ -82,14 +82,14 @@ func syncKonnect(ctx context.Context,
 	stats, errs := solver.Solve(ctx, s, kongClient, konnectClient, parallelism, dry)
 	printFn := color.New(color.FgGreen, color.Bold).PrintfFunc()
 	printFn("Summary:\n")
-	printFn("  Created: %v\n", stats.CreateOps)
-	printFn("  Updated: %v\n", stats.UpdateOps)
-	printFn("  Deleted: %v\n", stats.DeleteOps)
+	printFn("  Created: %v\n", stats.CreateOps.Read())
+	printFn("  Updated: %v\n", stats.UpdateOps.Read())
+	printFn("  Deleted: %v\n", stats.DeleteOps.Read())
 	if errs != nil {
 		return utils.ErrArray{Errors: errs}
 	}
 	if diffCmdNonZeroExitCode &&
-		stats.CreateOps+stats.UpdateOps+stats.DeleteOps != 0 {
+		stats.CreateOps.Read()+stats.UpdateOps.Read()+stats.DeleteOps.Read() != 0 {
 		os.Exit(exitCodeDiffDetection)
 	}
 

solver/solver.go

@@ -2,6 +2,7 @@ package solver
 
 import (
 	"context"
+	"sync"
 
 	"github.com/kong/deck/crud"
 	"github.com/kong/deck/diff"
@@ -14,9 +15,26 @@ import (
 
 // Stats holds the stats related to a Solve.
 type Stats struct {
-	CreateOps int
-	UpdateOps int
-	DeleteOps int
+	CreateOps *AtomicInt32Counter
+	UpdateOps *AtomicInt32Counter
+	DeleteOps *AtomicInt32Counter
+}
+
+type AtomicInt32Counter struct {
+	counter int32
+	lock    sync.RWMutex
+}
+
+func (a *AtomicInt32Counter) Increment(delta int32) {
+	a.lock.Lock()
+	defer a.lock.Unlock()
+	a.counter += delta
+}
+
+func (a *AtomicInt32Counter) Read() int32 {
+	a.lock.RLock()
+	defer a.lock.RUnlock()
+	return a.counter
 }
 
 // Solve generates a diff and walks the graph.
@@ -26,15 +44,19 @@ func Solve(ctx context.Context, syncer *diff.Syncer,
 
 	r := buildRegistry(client, konnectClient)
 
-	var stats Stats
+	stats := Stats{
+		CreateOps: &AtomicInt32Counter{},
+		UpdateOps: &AtomicInt32Counter{},
+		DeleteOps: &AtomicInt32Counter{},
+	}
 	recordOp := func(op crud.Op) {
 		switch op {
 		case crud.Create:
-			stats.CreateOps = stats.CreateOps + 1
+			stats.CreateOps.Increment(1)
 		case crud.Update:
-			stats.UpdateOps = stats.UpdateOps + 1
+			stats.UpdateOps.Increment(1)
 		case crud.Delete:
-			stats.DeleteOps = stats.DeleteOps + 1
+			stats.DeleteOps.Increment(1)
 		}
 	}
 

solver/solver_test.go

@@ -0,0 +1,23 @@
+package solver
+
+import (
+	"sync"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestStats_CreateOps(t *testing.T) {
+	var a AtomicInt32Counter
+	var wg sync.WaitGroup
+
+	wg.Add(10)
+	for i := 0; i < 10; i++ {
+		go func() {
+			defer wg.Done()
+			a.Increment(int32(1))
+		}()
+	}
+	wg.Wait()
+	assert.Equal(t, int32(10), a.Read())
+}