document what is safe about SafeStatus and SafeState

knopers8 · knopers8 · commit c083fa31bea6 · 2025-07-10T08:53:57.000+02:00
OCTRL-873
diff --git a/core/workflow/safestate.go b/core/workflow/safestate.go
@@ -30,6 +30,7 @@ import (
 	"sync"
 )
 
+// SafeState is a thread-safe structure that holds the state of a role.
 type SafeState struct {
 	mu    sync.RWMutex
 	state sm.State
diff --git a/core/workflow/safestatus.go b/core/workflow/safestatus.go
@@ -34,6 +34,7 @@ import (
 	"github.com/spf13/viper"
 )
 
+// SafeStatus is a thread-safe structure that holds the status of a role.
 type SafeStatus struct {
 	mu     sync.RWMutex
 	status task.Status

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ import (`
`30`	`30`	`"sync"`
`31`	`31`	`)`
`32`	`32`
	`33`	`+// SafeState is a thread-safe structure that holds the state of a role.`
`33`	`34`	`type SafeState struct {`
`34`	`35`	`mu sync.RWMutex`
`35`	`36`	`state sm.State`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ import (`
`34`	`34`	`"github.com/spf13/viper"`
`35`	`35`	`)`
`36`	`36`
	`37`	`+// SafeStatus is a thread-safe structure that holds the status of a role.`
`37`	`38`	`type SafeStatus struct {`
`38`	`39`	`mu sync.RWMutex`
`39`	`40`	`status task.Status`