mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Tim Deeb-SwihartandGitHub
0f17459a46
## What changed? `go.temporal.io/server/common/concurrent.Map` is now the canonical "locking map" implementation for the server (unless there's another one I'm aware of). ## Why? We recently found a data race in matching's lockableResultMap where the wrong lock type was taken during the `pop` operation, causing panics at run time. It's an easy mistake to make when you're writing multiple implementations like this, so I made a common one we can reuse. ## How did you test it? Added new tests and manually looked at all 40 lines of code to ensure the correct locks were taken. ## Potential risks None ## Documentation No ## Is hotfix candidate? Maybe?
114 lines
2.8 KiB
Go
114 lines
2.8 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package collection_test
|
|
|
|
import (
|
|
"sync"
|
|
"testing"
|
|
|
|
"go.temporal.io/server/common/collection"
|
|
)
|
|
|
|
// This isn't exhaustive but serves as a basic stress test to ensure our implementation is collection
|
|
func TestMap_MultiThreaded(t *testing.T) {
|
|
m := collection.NewSyncMap[int, int]()
|
|
var wg sync.WaitGroup
|
|
barrier := make(chan struct{})
|
|
wg.Add(3)
|
|
go func() {
|
|
defer wg.Done()
|
|
<-barrier
|
|
for i := 0; i < 1000; i++ {
|
|
m.Set(i, i)
|
|
}
|
|
}()
|
|
go func() {
|
|
<-barrier
|
|
defer wg.Done()
|
|
for i := 0; i < 1000; i++ {
|
|
m.Get(i)
|
|
}
|
|
}()
|
|
go func() {
|
|
<-barrier
|
|
defer wg.Done()
|
|
for i := 0; i < 1000; i++ {
|
|
m.Pop(i)
|
|
}
|
|
}()
|
|
close(barrier)
|
|
wg.Wait()
|
|
}
|
|
|
|
func TestMap_Get(t *testing.T) {
|
|
m := collection.NewSyncMap[int, int]()
|
|
m.Set(1, 1)
|
|
v, ok := m.Get(1)
|
|
if !ok {
|
|
t.Error("Expected true, got false")
|
|
}
|
|
if v != 1 {
|
|
t.Errorf("Expected 1, got %v", v)
|
|
}
|
|
}
|
|
|
|
func TestMap_Delete(t *testing.T) {
|
|
m := collection.NewSyncMap[int, int]()
|
|
m.Set(1, 1)
|
|
m.Set(2, 1)
|
|
m.Delete(1)
|
|
_, ok := m.Get(1)
|
|
if ok {
|
|
t.Error("Expected false, got true")
|
|
}
|
|
v, ok := m.Get(2)
|
|
if !ok {
|
|
t.Error("Expected true, got false")
|
|
}
|
|
if v != 1 {
|
|
t.Errorf("Expected 1, got %v", v)
|
|
}
|
|
}
|
|
|
|
func TestMap_Pop_ReturnsFalseWhenKeyDoesNotExist(t *testing.T) {
|
|
m := collection.NewSyncMap[int, int]()
|
|
_, ok := m.Pop(1)
|
|
if ok {
|
|
t.Error("Expected false, got true")
|
|
}
|
|
}
|
|
|
|
func TestMap_Pop_ReturnsTrueWhenKeyExists(t *testing.T) {
|
|
m := collection.NewSyncMap[int, int]()
|
|
m.Set(1, 1)
|
|
v, ok := m.Pop(1)
|
|
if !ok {
|
|
t.Error("Expected true, got false")
|
|
}
|
|
if v != 1 {
|
|
t.Errorf("Expected 1, got %v", v)
|
|
}
|
|
}
|