mirror of
https://github.com/pion/webrtc.git
synced 2025-12-24 11:51:03 +08:00
f35dc4efd0
It is possible to call GetStats() after the peer connection is closed. The statsGetter gets cleared when peer connection is closed. That is causing a panic when RtpReceiver.collectStats runs.
280 lines
8.2 KiB
Go
280 lines
8.2 KiB
Go
// SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//go:build !js
|
|
// +build !js
|
|
|
|
package webrtc
|
|
|
|
import (
|
|
"context"
|
|
"math"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/pion/interceptor"
|
|
"github.com/pion/interceptor/pkg/stats"
|
|
"github.com/pion/logging"
|
|
"github.com/pion/transport/v3/test"
|
|
"github.com/pion/webrtc/v4/pkg/media"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// Assert that SetReadDeadline works as expected
|
|
// This test uses VNet since we must have zero loss.
|
|
func Test_RTPReceiver_SetReadDeadline(t *testing.T) {
|
|
lim := test.TimeOut(time.Second * 30)
|
|
defer lim.Stop()
|
|
|
|
report := test.CheckRoutines(t)
|
|
defer report()
|
|
|
|
sender, receiver, wan := createVNetPair(t, &interceptor.Registry{})
|
|
|
|
track, err := NewTrackLocalStaticSample(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
|
|
assert.NoError(t, err)
|
|
|
|
_, err = sender.AddTrack(track)
|
|
assert.NoError(t, err)
|
|
|
|
seenPacket, seenPacketCancel := context.WithCancel(context.Background())
|
|
receiver.OnTrack(func(trackRemote *TrackRemote, r *RTPReceiver) {
|
|
// Set Deadline for both RTP and RTCP Stream
|
|
assert.NoError(t, r.SetReadDeadline(time.Now().Add(time.Second)))
|
|
assert.NoError(t, trackRemote.SetReadDeadline(time.Now().Add(time.Second)))
|
|
|
|
// First call will not error because we cache for probing
|
|
_, _, readErr := trackRemote.ReadRTP()
|
|
assert.NoError(t, readErr)
|
|
|
|
_, _, readErr = trackRemote.ReadRTP()
|
|
assert.Error(t, readErr)
|
|
|
|
_, _, readErr = r.ReadRTCP()
|
|
assert.Error(t, readErr)
|
|
|
|
seenPacketCancel()
|
|
})
|
|
|
|
peerConnectionsConnected := untilConnectionState(PeerConnectionStateConnected, sender, receiver)
|
|
|
|
assert.NoError(t, signalPair(sender, receiver))
|
|
|
|
peerConnectionsConnected.Wait()
|
|
assert.NoError(t, track.WriteSample(media.Sample{Data: []byte{0xAA}, Duration: time.Second}))
|
|
|
|
<-seenPacket.Done()
|
|
assert.NoError(t, wan.Stop())
|
|
closePairNow(t, sender, receiver)
|
|
}
|
|
|
|
// TestRTPReceiver_CollectStats_Mapping validates that collectStats maps
|
|
// interceptor/pkg/stats values into InboundRTPStreamStats.
|
|
func TestRTPReceiver_CollectStats_Mapping(t *testing.T) {
|
|
ssrc := SSRC(1234)
|
|
now := time.Now()
|
|
pr := uint64(math.MaxUint32) + 42
|
|
pl := int64(math.MaxInt32) + 7
|
|
jitter := 0.123
|
|
bytes := uint64(98765)
|
|
hdrBytes := uint64(4321)
|
|
fir := uint32(3)
|
|
pli := uint32(5)
|
|
nack := uint32(7)
|
|
|
|
fg := &fakeGetter{s: stats.Stats{
|
|
InboundRTPStreamStats: stats.InboundRTPStreamStats{
|
|
ReceivedRTPStreamStats: stats.ReceivedRTPStreamStats{
|
|
PacketsReceived: pr,
|
|
PacketsLost: pl,
|
|
Jitter: jitter,
|
|
},
|
|
LastPacketReceivedTimestamp: now,
|
|
HeaderBytesReceived: hdrBytes,
|
|
BytesReceived: bytes,
|
|
FIRCount: fir,
|
|
PLICount: pli,
|
|
NACKCount: nack,
|
|
},
|
|
}}
|
|
|
|
// Minimal RTPReceiver with one track
|
|
receiver := &RTPReceiver{
|
|
kind: RTPCodecTypeVideo,
|
|
log: logging.NewDefaultLoggerFactory().NewLogger("RTPReceiverTest"),
|
|
}
|
|
tr := newTrackRemote(RTPCodecTypeVideo, ssrc, 0, "", receiver)
|
|
receiver.tracks = []trackStreams{{track: tr}}
|
|
|
|
collector := newStatsReportCollector()
|
|
receiver.collectStats(collector, nil)
|
|
report := collector.Ready()
|
|
|
|
// Fetch the generated inbound-rtp stat by ID
|
|
statID := "inbound-rtp-1234"
|
|
_, ok := report[statID]
|
|
require.False(t, ok, "unexpected inbound stat")
|
|
|
|
receiver.collectStats(collector, fg)
|
|
report = collector.Ready()
|
|
got, ok := report[statID]
|
|
require.True(t, ok, "missing inbound stat")
|
|
|
|
inbound, ok := got.(InboundRTPStreamStats)
|
|
require.True(t, ok)
|
|
|
|
// Wrap-around semantics for casts
|
|
assert.Equal(t, uint32(pr), inbound.PacketsReceived) //nolint:gosec
|
|
assert.Equal(t, int32(pl), inbound.PacketsLost) //nolint:gosec
|
|
assert.Equal(t, jitter, inbound.Jitter)
|
|
assert.Equal(t, bytes, inbound.BytesReceived)
|
|
assert.Equal(t, hdrBytes, inbound.HeaderBytesReceived)
|
|
assert.Equal(t, fir, inbound.FIRCount)
|
|
assert.Equal(t, pli, inbound.PLICount)
|
|
assert.Equal(t, nack, inbound.NACKCount)
|
|
// Timestamp should be set (millisecond precision)
|
|
assert.Greater(t, float64(inbound.LastPacketReceivedTimestamp), 0.0)
|
|
}
|
|
|
|
func TestRTPReceiver_CollectStats_AudioPlayoutPull(t *testing.T) {
|
|
receiver := &RTPReceiver{
|
|
kind: RTPCodecTypeAudio,
|
|
log: logging.NewDefaultLoggerFactory().NewLogger("RTPReceiverTest"),
|
|
}
|
|
|
|
track := newTrackRemote(RTPCodecTypeAudio, 7777, 0, "", receiver)
|
|
receiver.tracks = []trackStreams{{track: track}}
|
|
|
|
provider := &fakeAudioPlayoutStatsProvider{
|
|
stats: AudioPlayoutStats{
|
|
ID: "media-playout-7777",
|
|
Type: StatsTypeMediaPlayout,
|
|
Kind: string(MediaKindAudio),
|
|
TotalSamplesCount: 960,
|
|
TotalSamplesDuration: float64(960) / 48000,
|
|
TotalPlayoutDelay: 0.5,
|
|
},
|
|
ok: true,
|
|
}
|
|
_ = provider.AddTrack(track)
|
|
|
|
collector := newStatsReportCollector()
|
|
receiver.collectStats(collector, &fakeGetter{})
|
|
report := collector.Ready()
|
|
|
|
got, ok := report["media-playout-7777"]
|
|
require.True(t, ok, "missing audio playout stats entry")
|
|
|
|
playout, ok := got.(AudioPlayoutStats)
|
|
require.True(t, ok)
|
|
|
|
assert.Equal(t, provider.stats.TotalSamplesCount, playout.TotalSamplesCount)
|
|
assert.Equal(t, provider.stats.TotalSamplesDuration, playout.TotalSamplesDuration)
|
|
assert.Equal(t, provider.stats.TotalPlayoutDelay, playout.TotalPlayoutDelay)
|
|
assert.NotZero(t, playout.Timestamp)
|
|
assert.Equal(t, 1, provider.calls)
|
|
}
|
|
|
|
func TestRTPReceiver_CollectStats_AudioPlayoutSharedProvider(t *testing.T) {
|
|
receiver := &RTPReceiver{
|
|
kind: RTPCodecTypeAudio,
|
|
log: logging.NewDefaultLoggerFactory().NewLogger("RTPReceiverTest"),
|
|
}
|
|
|
|
trackOne := newTrackRemote(RTPCodecTypeAudio, 5555, 0, "", receiver)
|
|
trackTwo := newTrackRemote(RTPCodecTypeAudio, 6666, 0, "", receiver)
|
|
receiver.tracks = []trackStreams{{track: trackOne}, {track: trackTwo}}
|
|
|
|
provider := &fakeAudioPlayoutStatsProvider{
|
|
stats: AudioPlayoutStats{
|
|
ID: "shared-playout",
|
|
Type: StatsTypeMediaPlayout,
|
|
Kind: string(MediaKindAudio),
|
|
TotalSamplesCount: 100,
|
|
},
|
|
ok: true,
|
|
}
|
|
|
|
_ = provider.AddTrack(trackOne)
|
|
_ = provider.AddTrack(trackTwo)
|
|
|
|
collector := newStatsReportCollector()
|
|
receiver.collectStats(collector, &fakeGetter{})
|
|
report := collector.Ready()
|
|
|
|
got, ok := report["shared-playout"]
|
|
require.True(t, ok, "shared provider stats missing")
|
|
|
|
playout, ok := got.(AudioPlayoutStats)
|
|
require.True(t, ok)
|
|
assert.Equal(t, provider.stats.TotalSamplesCount, playout.TotalSamplesCount)
|
|
assert.Equal(t, provider.stats.Type, playout.Type)
|
|
assert.Equal(t, provider.stats.Kind, playout.Kind)
|
|
assert.Equal(t, provider.stats.ID, playout.ID)
|
|
assert.NotZero(t, playout.Timestamp)
|
|
assert.Equal(t, 2, provider.calls)
|
|
}
|
|
|
|
func TestRTPReceiver_CollectStats_AudioPlayoutTimestampAlignment(t *testing.T) {
|
|
receiver := &RTPReceiver{
|
|
kind: RTPCodecTypeAudio,
|
|
log: logging.NewDefaultLoggerFactory().NewLogger("RTPReceiverTest"),
|
|
}
|
|
|
|
track := newTrackRemote(RTPCodecTypeAudio, 9999, 0, "", receiver)
|
|
receiver.tracks = []trackStreams{{track: track}}
|
|
|
|
provider := &fakeAudioPlayoutStatsProvider{
|
|
stats: AudioPlayoutStats{
|
|
ID: "media-playout-9999",
|
|
Type: StatsTypeMediaPlayout,
|
|
Kind: string(MediaKindAudio),
|
|
TotalSamplesCount: 1,
|
|
},
|
|
ok: true,
|
|
}
|
|
|
|
_ = provider.AddTrack(track)
|
|
|
|
collector := newStatsReportCollector()
|
|
receiver.collectStats(collector, &fakeGetter{})
|
|
report := collector.Ready()
|
|
|
|
got, ok := report["media-playout-9999"]
|
|
require.True(t, ok, "playout stats missing")
|
|
playout, ok := got.(AudioPlayoutStats)
|
|
require.True(t, ok, "playout stats type assertion failed")
|
|
require.NotZero(t, provider.lastNow)
|
|
assert.Equal(t, statsTimestampFrom(provider.lastNow), playout.Timestamp)
|
|
}
|
|
|
|
type fakeGetter struct{ s stats.Stats }
|
|
|
|
func (f *fakeGetter) Get(uint32) *stats.Stats { return &f.s }
|
|
|
|
type fakeAudioPlayoutStatsProvider struct {
|
|
stats AudioPlayoutStats
|
|
ok bool
|
|
|
|
calls int
|
|
lastNow time.Time
|
|
}
|
|
|
|
func (f *fakeAudioPlayoutStatsProvider) Snapshot(now time.Time) (AudioPlayoutStats, bool) {
|
|
f.calls++
|
|
f.lastNow = now
|
|
|
|
return f.stats, f.ok
|
|
}
|
|
|
|
func (f *fakeAudioPlayoutStatsProvider) AddTrack(track *TrackRemote) error {
|
|
track.addProvider(f)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (f *fakeAudioPlayoutStatsProvider) RemoveTrack(track *TrackRemote) {
|
|
track.removeProvider(f)
|
|
}
|