mirror of
https://github.com/livekit/livekit.git
synced 2026-09-17 03:44:48 +00:00
Raja SubramanianandClaude Fable 5.1
d2405a72b1
* telemetry: add visibility into stats worker reference underflow Log the paths that can leave a stats worker with no references, so the `-1` never-closed cases seen in production can be traced to their origin. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * telemetry: guard StatsWorker.MarshalLogObject against a nil receiver The new worker-created log passes the existing worker, which is a typed nil when there is none. Mirror ReferenceGuard.MarshalLogObject. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
70 lines
2.5 KiB
Go
70 lines
2.5 KiB
Go
package telemetry
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
"go.uber.org/zap/zapcore"
|
|
)
|
|
|
|
func TestStatsWorker(t *testing.T) {
|
|
t.Run("reference counted close works", func(t *testing.T) {
|
|
var g0, g1 ReferenceGuard
|
|
w := newStatsWorker(t.Context(), nil, "", "", "", "", &g0)
|
|
require.False(t, w.Closed(&g1))
|
|
require.False(t, w.Close(&g0))
|
|
require.False(t, w.Closed(&g1))
|
|
require.True(t, w.Close(&g1))
|
|
require.True(t, w.Closed(&g1))
|
|
})
|
|
|
|
// a ReferenceGuard records that it activated some worker, not which one, so a
|
|
// superseded worker has to hand its references to the one reachable in its place
|
|
t.Run("force close hands references to the successor", func(t *testing.T) {
|
|
t.Run("a guard shared by both workers", func(t *testing.T) {
|
|
// the second worker never got a reference, the guard was already activated
|
|
var g ReferenceGuard
|
|
superseded := newStatsWorker(t.Context(), nil, "", "", "", "", &g)
|
|
survivor := newStatsWorker(t.Context(), nil, "", "", "", "", &g)
|
|
require.Equal(t, 1, superseded.refCount.count)
|
|
require.Equal(t, 0, survivor.refCount.count)
|
|
|
|
require.True(t, superseded.ForceClose(survivor))
|
|
require.Equal(t, 0, superseded.refCount.count)
|
|
require.Equal(t, 1, survivor.refCount.count)
|
|
|
|
// without the hand over this would leave the survivor at -1 and never closed
|
|
require.True(t, survivor.Close(&g))
|
|
require.True(t, survivor.Closed(&g))
|
|
})
|
|
|
|
t.Run("a guard per worker", func(t *testing.T) {
|
|
var gSuperseded, gSurvivor ReferenceGuard
|
|
superseded := newStatsWorker(t.Context(), nil, "", "", "", "", &gSuperseded)
|
|
survivor := newStatsWorker(t.Context(), nil, "", "", "", "", &gSurvivor)
|
|
|
|
require.True(t, superseded.ForceClose(survivor))
|
|
require.Equal(t, 2, survivor.refCount.count)
|
|
|
|
// the superseded worker's owner departs, it must not close the survivor early
|
|
require.False(t, survivor.Close(&gSuperseded))
|
|
require.True(t, survivor.Close(&gSurvivor))
|
|
})
|
|
|
|
t.Run("closing an already closed worker holds on to its references", func(t *testing.T) {
|
|
var g ReferenceGuard
|
|
superseded := newStatsWorker(t.Context(), nil, "", "", "", "", &g)
|
|
survivor := newStatsWorker(t.Context(), nil, "", "", "", "", nil)
|
|
|
|
require.True(t, superseded.ForceClose(nil))
|
|
require.False(t, superseded.ForceClose(survivor))
|
|
require.Equal(t, 0, survivor.refCount.count)
|
|
})
|
|
})
|
|
|
|
t.Run("logging a nil worker does not panic", func(t *testing.T) {
|
|
var w *StatsWorker
|
|
require.NoError(t, w.MarshalLogObject(zapcore.NewMapObjectEncoder()))
|
|
})
|
|
}
|