Files
tiennm99bot/internal/keylock/keylock.go
T
tiennm99 cf620a257e docs: fix stale code comments and add missing package docs
Correct comments that described the retired webhook transport, a removed
/cron route, the old KV store and wrapper types, and behaviour that has since
changed; drop plan and review labels; reword two startup log lines that
overstated or misnamed what they report.
2026-09-30 14:19:01 +07:00

34 lines
1.4 KiB
Go

// Package keylock serialises compound operations that target the same key
// (typically a chat / user / subject identifier) across goroutines.
//
// Why a separate package: several modules need a per-subject mutex to turn
// the store's single-op atomicity into safe Get→mutate→Put. Telegram updates
// are handled one at a time, but crons fire on scheduler goroutines alongside
// them, so without explicit per-subject serialisation a cron and a handler
// writing the same subject could race and drop a write.
//
// Trade-off: the underlying sync.Map grows unboundedly with distinct keys
// (~32 B each). At the current bot scale, that is acceptable; add eviction if
// production cardinality starts growing materially.
package keylock
import "sync"
// Map gives each string key its own mutex, lazily created. Zero value is
// usable; do not copy after first use (sync.Map is non-copyable).
type Map struct {
m sync.Map // key: string → val: *sync.Mutex
}
// Acquire locks the per-key mutex and returns its Unlock as a func so the
// caller can `defer m.Acquire(key)()` at the top of a critical section.
//
// Distinct keys never block each other; same-key callers run one at a time.
// Like sync.Mutex, it does not guarantee FIFO order among waiters.
func (m *Map) Acquire(key string) func() {
v, _ := m.m.LoadOrStore(key, &sync.Mutex{})
mu := v.(*sync.Mutex)
mu.Lock()
return mu.Unlock
}