Files
beads/cmd/bd/daemon_debouncer.go
Steven Syrek 8e40018701 fix(daemon): Fix double-unlock risk in debouncer on action panic (#1140)
The debouncer's timer callback used a pattern that could cause a
double-unlock panic if the action function panicked:

  d.mu.Lock()
  defer d.mu.Unlock()
  if d.seq == currentSeq {
      d.mu.Unlock()  // Manual unlock
      d.action()     // If this panics...
      d.mu.Lock()    // ...this never runs
  }                  // ...but defer still tries to unlock

Fix: Remove the defer and manually manage lock state. Now if the
action panics, the lock is already released, preventing a
double-unlock panic that would mask the original panic.

Co-authored-by: Steven Syrek <steven.syrek@deepl.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 10:08:53 -08:00

70 lines
1.7 KiB
Go

package main
import (
"sync"
"time"
)
// Debouncer batches rapid events into a single action after a quiet period.
// Thread-safe for concurrent triggers.
type Debouncer struct {
mu sync.Mutex
timer *time.Timer
duration time.Duration
action func()
seq uint64 // Sequence number to prevent stale timer fires
}
// NewDebouncer creates a new debouncer with the given duration and action.
// The action will be called once after the duration has passed since the last trigger.
func NewDebouncer(duration time.Duration, action func()) *Debouncer {
return &Debouncer{
duration: duration,
action: action,
}
}
// Trigger schedules the action to run after the debounce duration.
// If called multiple times, the timer is reset each time, ensuring
// the action only fires once after the last trigger.
func (d *Debouncer) Trigger() {
d.mu.Lock()
defer d.mu.Unlock()
if d.timer != nil {
d.timer.Stop()
}
// Increment sequence number to invalidate any pending timers
d.seq++
currentSeq := d.seq
d.timer = time.AfterFunc(d.duration, func() {
d.mu.Lock()
// Only fire if this is still the latest trigger
if d.seq != currentSeq {
d.mu.Unlock()
return
}
d.timer = nil
d.mu.Unlock() // Unlock before calling action to avoid holding lock during callback
// Action runs without lock held. If action panics, the lock is already
// released, avoiding a double-unlock that would occur with the previous
// defer-based pattern.
d.action()
})
}
// Cancel stops any pending debounced action.
// Safe to call even if no action is pending.
func (d *Debouncer) Cancel() {
d.mu.Lock()
defer d.mu.Unlock()
if d.timer != nil {
d.timer.Stop()
d.timer = nil
}
}