Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: concurrent omap reads #1608

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 32 additions & 6 deletions internal/omap/orderedmap.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"cmp"
"fmt"
"slices"
"sync"

"gopkg.in/yaml.v3"

Expand All @@ -15,15 +16,17 @@ import (
// list of the map's keys. This allows you to run deterministic and ordered
// operations on the map such as printing/serializing/iterating.
type OrderedMap[K cmp.Ordered, V any] struct {
s []K
m map[K]V
mutex *sync.RWMutex
s []K
m map[K]V
}

// New will create a new OrderedMap of the given type and return it.
func New[K cmp.Ordered, V any]() OrderedMap[K, V] {
return OrderedMap[K, V]{
s: make([]K, 0),
m: make(map[K]V),
mutex: &sync.RWMutex{},
s: make([]K, 0),
m: make(map[K]V),
}
}

Expand Down Expand Up @@ -61,16 +64,31 @@ func (om *OrderedMap[K, V]) Set(key K, value V) {
if om.m == nil {
om.m = make(map[K]V)
}
if om.mutex == nil {
Copy link
Contributor

@trim21 trim21 Apr 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't look right, there is still a race condition here. Otherwise this if branch is a no-op

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we should likely instantiate this mutex on the New function.

om.mutex = &sync.RWMutex{}
}
om.mutex.RLock()
if _, ok := om.m[key]; !ok {
om.s = append(om.s, key)
}
om.mutex.RUnlock()
om.mutex.Lock()
om.m[key] = value
om.mutex.Unlock()
}

// Get will return the value for a given key.
// If the key does not exist, it will return the zero value of the value type.
func (om *OrderedMap[K, V]) Get(key K) V {
if om.m == nil {
om.m = make(map[K]V)
}
if om.mutex == nil {
om.mutex = &sync.RWMutex{}
}
om.mutex.RLock()
value, ok := om.m[key]
om.mutex.RUnlock()
if !ok {
var zero V
return zero
Expand All @@ -80,7 +98,15 @@ func (om *OrderedMap[K, V]) Get(key K) V {

// Exists will return whether or not the given key exists.
func (om *OrderedMap[K, V]) Exists(key K) bool {
if om.m == nil {
om.m = make(map[K]V)
}
if om.mutex == nil {
om.mutex = &sync.RWMutex{}
}
om.mutex.RLock()
_, ok := om.m[key]
om.mutex.RUnlock()
return ok
}

Expand All @@ -103,15 +129,15 @@ func (om *OrderedMap[K, V]) Keys() []K {
func (om *OrderedMap[K, V]) Values() []V {
var values []V
for _, key := range om.s {
values = append(values, om.m[key])
values = append(values, om.Get(key))
}
return values
}

// Range will iterate over the map and call the given function for each key/value.
func (om *OrderedMap[K, V]) Range(fn func(key K, value V) error) error {
for _, key := range om.s {
if err := fn(key, om.m[key]); err != nil {
if err := fn(key, om.Get(key)); err != nil {
return err
}
}
Expand Down