fix: ordered map race condition (#708)

* chore(release): update changelog and version to 0.13.2

* chore(release): update changelog and version to 0.13.3

* fix: make OrderedMap thread-safe

CHANGELOG.md

@@ -1,10 +1,31 @@
+## [0.13.3] - 2023-10-16
+
+### Bug Fixes
+
+- Issue with GMP not properly being linked on mac (#698)
+- Always propose with current app version (#697)
+
+## [0.13.2] - 2023-10-09
+
+### Bug Fixes
+
+- Log-file-path setting does not work (#691)
+
+### Miscellaneous Tasks
+
+- Update changelog and version to 0.13.2
+
 ## [0.13.1] - 2023-09-14
 
 ### Bug Fixes
 
 - Send evidence only once (#683)
 - Panic verifying evidence due to missing pubkey (#684)
 
+### Miscellaneous Tasks
+
+- Update changelog and version to 0.13.1
+
 ## [0.13.0] - 2023-09-13
 
 ### Bug Fixes

libs/ds/ordered_map.go

@@ -1,11 +1,14 @@
 package ds
 
+import "sync"
+
 // OrderedMap is a map with a deterministic iteration order
-// this datastructure is not thread-safe
+// this datastructure is thread-safe
 type OrderedMap[T comparable, V any] struct {
 	len    int
 	keys   map[T]int
 	values []V
+	mtx    sync.RWMutex
 }
 
 // NewOrderedMap returns a new OrderedMap
@@ -17,6 +20,9 @@ func NewOrderedMap[T comparable, V any]() *OrderedMap[T, V] {
 
 // Put adds a key-value pair to the map
 func (m *OrderedMap[T, V]) Put(key T, val V) {
+	m.mtx.Lock()
+	defer m.mtx.Unlock()
+
 	i, ok := m.keys[key]
 	if ok {
 		m.values[i] = val
@@ -33,6 +39,9 @@ func (m *OrderedMap[T, V]) Put(key T, val V) {
 
 // Get returns the value for a given key
 func (m *OrderedMap[T, V]) Get(key T) (V, bool) {
+	m.mtx.RLock()
+	defer m.mtx.RUnlock()
+
 	i, ok := m.keys[key]
 	if !ok {
 		var v V
@@ -43,12 +52,18 @@ func (m *OrderedMap[T, V]) Get(key T) (V, bool) {
 
 // Has returns true if the map contains the given key
 func (m *OrderedMap[T, V]) Has(key T) bool {
+	m.mtx.RLock()
+	defer m.mtx.RUnlock()
+
 	_, ok := m.keys[key]
 	return ok
 }
 
 // Delete removes a key-value pair from the map
 func (m *OrderedMap[T, V]) Delete(key T) {
+	m.mtx.Lock()
+	defer m.mtx.Unlock()
+
 	i, ok := m.keys[key]
 	if !ok {
 		return
@@ -63,11 +78,17 @@ func (m *OrderedMap[T, V]) Delete(key T) {
 
 // Values returns all values in the map
 func (m *OrderedMap[T, V]) Values() []V {
+	m.mtx.RLock()
+	defer m.mtx.RUnlock()
+
 	return append([]V{}, m.values[0:m.len]...)
 }
 
 // Keys returns all keys in the map
 func (m *OrderedMap[T, V]) Keys() []T {
+	m.mtx.RLock()
+	defer m.mtx.RUnlock()
+
 	keys := make([]T, len(m.keys))
 	for k, v := range m.keys {
 		keys[v] = k
@@ -77,5 +98,8 @@ func (m *OrderedMap[T, V]) Keys() []T {
 
 // Len returns a number of the map
 func (m *OrderedMap[T, V]) Len() int {
+	m.mtx.RLock()
+	defer m.mtx.RUnlock()
+
 	return m.len
 }

libs/ds/ordered_map_test.go

@@ -1,6 +1,8 @@
 package ds
 
 import (
+	"strconv"
+	"sync"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -40,3 +42,20 @@ func TestOrderedMap(t *testing.T) {
 	// delete unknown key
 	om.Delete("c")
 }
+
+// / Run TestOrderedMap in parallel
+func TestOrderedMapMultithread(t *testing.T) {
+	threads := 100
+
+	wg := sync.WaitGroup{}
+	wg.Add(threads)
+
+	for i := 0; i < threads; i++ {
+		go func(id int) {
+			t.Run(strconv.FormatInt(int64(id), 10), TestOrderedMap)
+			wg.Done()
+		}(i)
+	}
+
+	wg.Wait()
+}

version/version.go

@@ -9,7 +9,7 @@ var (
 const (
 	// TMVersionDefault is the used as the fallback version for Tenderdash
 	// when not using git describe. It is formatted with semantic versioning.
-	TMVersionDefault = "0.13.1"
+	TMVersionDefault = "0.13.3"
 	// ABCISemVer is the semantic version of the ABCI library
 	ABCISemVer = "0.23.0"