File size: 10,731 Bytes
fea99b3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | package lockr
import (
"context"
"sync"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/openmeterio/openmeter/openmeter/testutils"
"github.com/openmeterio/openmeter/pkg/framework/pgdriver"
)
func newTestSessionLocker(t *testing.T, dbConn string, opts ...pgdriver.Option) *SessionLocker {
t.Helper()
postgresDriver, err := pgdriver.NewPostgresDriver(t.Context(), dbConn, opts...)
if err != nil {
t.Fatalf("failed to get postgres driver: %s", err)
}
t.Cleanup(func() {
if err := postgresDriver.Close(); err != nil {
t.Errorf("failed to close postgres driver: %v", err)
}
})
locker, err := NewSessionLockr(SessionLockerConfig{
Logger: testutils.NewLogger(t),
PostgresDriver: postgresDriver,
})
require.NoError(t, err)
return locker
}
func Test_SessionLocker(t *testing.T) {
testDB := testutils.InitPostgresDB(t, testutils.PostgresDBStateEmpty)
t.Cleanup(func() {
testDB.Close(t)
})
t.Run("Lock and release", func(t *testing.T) {
locker := newTestSessionLocker(t, testDB.URL)
err := locker.Start(t.Context())
require.NoError(t, err)
defer locker.Close()
k, err := NewKey("test", "lock-release")
require.NoError(t, err)
releaser, err := locker.Lock(t.Context(), k)
require.NoError(t, err)
require.NotNil(t, releaser)
err = releaser(t.Context())
require.NoError(t, err)
})
t.Run("TryLock and release", func(t *testing.T) {
locker := newTestSessionLocker(t, testDB.URL)
err := locker.Start(t.Context())
require.NoError(t, err)
defer locker.Close()
k, err := NewKey("test", "trylock-release")
require.NoError(t, err)
releaser, err := locker.TryLock(t.Context(), k)
require.NoError(t, err)
require.NotNil(t, releaser)
err = releaser(t.Context())
require.NoError(t, err)
})
t.Run("Same session can acquire the same lock twice", func(t *testing.T) {
locker := newTestSessionLocker(t, testDB.URL)
err := locker.Start(t.Context())
require.NoError(t, err)
defer locker.Close()
k, err := NewKey("test", "reentrant")
require.NoError(t, err)
releaser1, err := locker.Lock(t.Context(), k)
require.NoError(t, err)
releaser2, err := locker.Lock(t.Context(), k)
require.NoError(t, err)
// PostgreSQL session-level advisory locks are reentrant: each acquisition
// increments a counter and requires a matching unlock to fully release.
require.NoError(t, releaser2(t.Context()))
require.NoError(t, releaser1(t.Context()))
})
t.Run("TryLock fails when lock is held by another session", func(t *testing.T) {
locker1 := newTestSessionLocker(t, testDB.URL)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
k, err := NewKey("test", "trylock-contention")
require.NoError(t, err)
// Session 1 acquires the lock
releaser, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
// Session 2 tries to acquire the same lock non-blocking
_, err = locker2.TryLock(t.Context(), k)
require.ErrorIs(t, err, ErrNoLockAcquired)
// After session 1 releases, session 2 can acquire
require.NoError(t, releaser(t.Context()))
releaser2, err := locker2.TryLock(t.Context(), k)
require.NoError(t, err)
require.NoError(t, releaser2(t.Context()))
})
t.Run("Different keys do not conflict", func(t *testing.T) {
locker1 := newTestSessionLocker(t, testDB.URL)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
key1, err := NewKey("test", "key-a")
require.NoError(t, err)
key2, err := NewKey("test", "key-b")
require.NoError(t, err)
// Both sessions acquire different locks concurrently
releaser1, err := locker1.Lock(t.Context(), key1)
require.NoError(t, err)
releaser2, err := locker2.Lock(t.Context(), key2)
require.NoError(t, err)
require.NoError(t, releaser1(t.Context()))
require.NoError(t, releaser2(t.Context()))
})
t.Run("Lock blocks until released by another session", func(t *testing.T) {
locker1 := newTestSessionLocker(t, testDB.URL)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
k, err := NewKey("test", "blocking")
require.NoError(t, err)
// Session 1 acquires the lock
releaser1, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
// Track ordering of operations
events := make(chan string, 4)
var wg sync.WaitGroup
wg.Add(1)
waitCh := make(chan int)
// Session 2 blocks trying to acquire the same lock
go func() {
defer wg.Done()
events <- "s2 waiting"
time.Sleep(50 * time.Millisecond)
close(waitCh)
releaser2, err := locker2.Lock(t.Context(), k)
assert.NoError(t, err)
events <- "s2 acquired"
if releaser2 != nil {
assert.NoError(t, releaser2(t.Context()))
}
}()
// Wait until session 2 is blocked
assert.Eventually(t, func() bool {
select {
case <-waitCh:
return true
default:
t.Log("waiting for session 2 to block")
return false
}
}, time.Second, 10*time.Millisecond)
events <- "s1 releasing"
require.NoError(t, releaser1(t.Context()))
wg.Wait()
close(events)
var results []string
for e := range events {
results = append(results, e)
}
require.Equal(t, []string{"s2 waiting", "s1 releasing", "s2 acquired"}, results)
})
t.Run("Lock respects context cancellation", func(t *testing.T) {
locker1 := newTestSessionLocker(t, testDB.URL)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
k, err := NewKey("test", "ctx-cancel")
require.NoError(t, err)
// Session 1 holds the lock
releaser, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
t.Cleanup(func() {
_ = releaser(t.Context())
})
// Session 2 tries to acquire with a short-lived context
ctx, cancel := context.WithTimeout(t.Context(), 500*time.Millisecond)
defer cancel()
_, err = locker2.Lock(ctx, k)
require.Error(t, err)
})
t.Run("Lock timeout returns ErrLockTimeout", func(t *testing.T) {
lockTimeout := 2 * time.Second
opts := []pgdriver.Option{
pgdriver.WithLockTimeout(lockTimeout),
}
locker1 := newTestSessionLocker(t, testDB.URL, opts...)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL, opts...)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
k, err := NewKey("test", "timeout")
require.NoError(t, err)
// Session 1 holds the lock
releaser, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
done := make(chan struct{})
go func() {
defer close(done)
// Session 2 blocks and eventually times out via PostgreSQL lock_timeout
_, err := locker2.Lock(t.Context(), k)
assert.ErrorIs(t, err, ErrLockTimeout)
}()
// Wait for session 2 to time out, then release
assert.Eventually(t, func() bool {
select {
case <-done:
return true
default:
t.Log("waiting for session 2 to block")
return false
}
}, 3*lockTimeout, lockTimeout)
require.NoError(t, releaser(t.Context()))
})
t.Run("Multiple locks held and released independently", func(t *testing.T) {
locker := newTestSessionLocker(t, testDB.URL)
err := locker.Start(t.Context())
require.NoError(t, err)
defer locker.Close()
key1, err := NewKey("test", "multi-a")
require.NoError(t, err)
key2, err := NewKey("test", "multi-b")
require.NoError(t, err)
key3, err := NewKey("test", "multi-c")
require.NoError(t, err)
releaser1, err := locker.Lock(t.Context(), key1)
require.NoError(t, err)
releaser2, err := locker.Lock(t.Context(), key2)
require.NoError(t, err)
releaser3, err := locker.Lock(t.Context(), key3)
require.NoError(t, err)
// Release in different order than acquired
require.NoError(t, releaser2(t.Context()))
require.NoError(t, releaser1(t.Context()))
require.NoError(t, releaser3(t.Context()))
})
t.Run("Releaser only releases lock once", func(t *testing.T) {
locker1 := newTestSessionLocker(t, testDB.URL)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
k, err := NewKey("test", "release-once")
require.NoError(t, err)
// Session 1 acquires the lock twice (reentrant)
releaser1a, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
releaser1b, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
// Release the second acquisition
require.NoError(t, releaser1b(t.Context()))
// Call releaser1b again — should be a no-op (sync.Once), so the first
// acquisition still holds the lock and session 2 cannot acquire it.
require.NoError(t, releaser1b(t.Context()))
// Session 2 should still be unable to acquire because session 1's first
// lock acquisition has not been released yet.
_, err = locker2.TryLock(t.Context(), k)
require.ErrorIs(t, err, ErrNoLockAcquired)
// Now release the first acquisition
require.NoError(t, releaser1a(t.Context()))
// Session 2 can now acquire the lock
releaser2, err := locker2.TryLock(t.Context(), k)
require.NoError(t, err)
require.NoError(t, releaser2(t.Context()))
})
t.Run("TryLock succeeds after blocking Lock is released", func(t *testing.T) {
locker1 := newTestSessionLocker(t, testDB.URL)
err := locker1.Start(t.Context())
require.NoError(t, err)
defer locker1.Close()
locker2 := newTestSessionLocker(t, testDB.URL)
err = locker2.Start(t.Context())
require.NoError(t, err)
defer locker2.Close()
k, err := NewKey("test", "trylock-after-release")
require.NoError(t, err)
// Session 1 acquires with blocking Lock
releaser, err := locker1.Lock(t.Context(), k)
require.NoError(t, err)
// Session 2 can't TryLock while held
_, err = locker2.TryLock(t.Context(), k)
require.ErrorIs(t, err, ErrNoLockAcquired)
// Release and retry
require.NoError(t, releaser(t.Context()))
releaser2, err := locker2.TryLock(t.Context(), k)
require.NoError(t, err)
require.NoError(t, releaser2(t.Context()))
})
}
|