blob: 4cb9c15a6ff2e81fd7cf6edd5ab09b22f57b887a [file] [log] [blame]
hbosdb346a72016-11-29 09:57:011/*
2 * Copyright 2016 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Yves Gerey3e707812018-11-28 15:47:4911#include <stdint.h>
12#include <string.h>
Jonas Olssona4d87372019-07-05 17:08:3313
Yves Gerey3e707812018-11-28 15:47:4914#include <memory>
hbosdb346a72016-11-29 09:57:0115#include <set>
Yves Gerey3e707812018-11-28 15:47:4916#include <string>
hbosdb346a72016-11-29 09:57:0117#include <vector>
18
Steve Anton64b626b2019-01-29 01:25:2619#include "absl/algorithm/container.h"
Steve Anton68586e82018-12-14 01:41:2520#include "absl/strings/match.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3121#include "api/audio_codecs/builtin_audio_decoder_factory.h"
22#include "api/audio_codecs/builtin_audio_encoder_factory.h"
Yves Gerey3e707812018-11-28 15:47:4923#include "api/audio_options.h"
Steve Anton10542f22019-01-11 17:11:0024#include "api/data_channel_interface.h"
25#include "api/peer_connection_interface.h"
26#include "api/rtp_receiver_interface.h"
27#include "api/rtp_sender_interface.h"
Mirko Bonadeid9708072019-01-25 19:26:4828#include "api/scoped_refptr.h"
Steve Anton10542f22019-01-11 17:11:0029#include "api/stats/rtc_stats.h"
30#include "api/stats/rtc_stats_report.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3131#include "api/stats/rtcstats_objects.h"
Steve Anton10542f22019-01-11 17:11:0032#include "pc/rtc_stats_traversal.h"
33#include "pc/test/peer_connection_test_wrapper.h"
34#include "pc/test/rtc_stats_obtainer.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3135#include "rtc_base/checks.h"
36#include "rtc_base/event_tracer.h"
37#include "rtc_base/gunit.h"
Yves Gerey3e707812018-11-28 15:47:4938#include "rtc_base/thread.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3139#include "rtc_base/trace_event.h"
Steve Anton10542f22019-01-11 17:11:0040#include "rtc_base/virtual_socket_server.h"
Steve Anton64b626b2019-01-29 01:25:2641#include "test/gmock.h"
Yves Gerey3e707812018-11-28 15:47:4942#include "test/gtest.h"
hbosdb346a72016-11-29 09:57:0143
Steve Anton64b626b2019-01-29 01:25:2644using ::testing::Contains;
45
hbosdb346a72016-11-29 09:57:0146namespace webrtc {
47
48namespace {
49
50const int64_t kGetStatsTimeoutMs = 10000;
51
ehmaldonado80c829f2017-07-18 14:35:1952const unsigned char* GetCategoryEnabledHandler(const char* name) {
ehmaldonado8ab0fd82017-09-04 21:35:0453 if (strcmp("webrtc_stats", name) != 0) {
54 return reinterpret_cast<const unsigned char*>("");
55 }
56 return reinterpret_cast<const unsigned char*>(name);
ehmaldonado80c829f2017-07-18 14:35:1957}
58
ehmaldonado8ab0fd82017-09-04 21:35:0459class RTCStatsReportTraceListener {
60 public:
61 static void SetUp() {
62 if (!traced_report_)
63 traced_report_ = new RTCStatsReportTraceListener();
64 traced_report_->last_trace_ = "";
65 SetupEventTracer(&GetCategoryEnabledHandler,
66 &RTCStatsReportTraceListener::AddTraceEventHandler);
67 }
68
69 static const std::string& last_trace() {
70 RTC_DCHECK(traced_report_);
71 return traced_report_->last_trace_;
72 }
73
74 private:
Steve Anton36b29d12017-10-30 16:57:4275 static void AddTraceEventHandler(
76 char phase,
77 const unsigned char* category_enabled,
78 const char* name,
79 unsigned long long id, // NOLINT(runtime/int)
80 int num_args,
81 const char** arg_names,
82 const unsigned char* arg_types,
83 const unsigned long long* arg_values, // NOLINT(runtime/int)
84 unsigned char flags) {
ehmaldonado8ab0fd82017-09-04 21:35:0485 RTC_DCHECK(traced_report_);
86 EXPECT_STREQ("webrtc_stats",
87 reinterpret_cast<const char*>(category_enabled));
88 EXPECT_STREQ("webrtc_stats", name);
89 EXPECT_EQ(1, num_args);
90 EXPECT_STREQ("report", arg_names[0]);
91 EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
92
93 traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
94 }
95
96 static RTCStatsReportTraceListener* traced_report_;
97 std::string last_trace_;
98};
99
100RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
101 nullptr;
ehmaldonado80c829f2017-07-18 14:35:19102
Mirko Bonadei6a489f22019-04-09 13:11:12103class RTCStatsIntegrationTest : public ::testing::Test {
hbosdb346a72016-11-29 09:57:01104 public:
105 RTCStatsIntegrationTest()
tommie7251592017-07-14 21:44:46106 : network_thread_(new rtc::Thread(&virtual_socket_server_)),
107 worker_thread_(rtc::Thread::Create()) {
ehmaldonado8ab0fd82017-09-04 21:35:04108 RTCStatsReportTraceListener::SetUp();
ehmaldonado80c829f2017-07-18 14:35:19109
tommie7251592017-07-14 21:44:46110 RTC_CHECK(network_thread_->Start());
111 RTC_CHECK(worker_thread_->Start());
hbosdb346a72016-11-29 09:57:01112
Tommi87f70902021-04-27 12:43:08113 caller_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
Byoungchan Leed58f5262022-06-27 09:05:22114 "caller", &virtual_socket_server_, network_thread_.get(),
115 worker_thread_.get());
Tommi87f70902021-04-27 12:43:08116 callee_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
Byoungchan Leed58f5262022-06-27 09:05:22117 "callee", &virtual_socket_server_, network_thread_.get(),
118 worker_thread_.get());
hbosdb346a72016-11-29 09:57:01119 }
120
121 void StartCall() {
122 // Create PeerConnections and "connect" sigslots
123 PeerConnectionInterface::RTCConfiguration config;
Henrik Boström62995db2022-01-03 08:58:10124 config.sdp_semantics = SdpSemantics::kUnifiedPlan;
hbosdb346a72016-11-29 09:57:01125 PeerConnectionInterface::IceServer ice_server;
126 ice_server.uri = "stun:1.1.1.1:3478";
127 config.servers.push_back(ice_server);
Niels Möllerf06f9232018-08-07 10:32:18128 EXPECT_TRUE(caller_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 10:47:57129 CreateBuiltinAudioDecoderFactory()));
Niels Möllerf06f9232018-08-07 10:32:18130 EXPECT_TRUE(callee_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 10:47:57131 CreateBuiltinAudioDecoderFactory()));
hbosdb346a72016-11-29 09:57:01132 PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
133
134 // Get user media for audio and video
Niels Möller5c4ddad2019-02-12 11:30:58135 caller_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
136 callee_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
hbosdb346a72016-11-29 09:57:01137
138 // Create data channels
139 DataChannelInit init;
140 caller_->CreateDataChannel("data", init);
141 callee_->CreateDataChannel("data", init);
142
143 // Negotiate and wait for call to establish
Niels Möllerf06f9232018-08-07 10:32:18144 caller_->CreateOffer(PeerConnectionInterface::RTCOfferAnswerOptions());
hbosdb346a72016-11-29 09:57:01145 caller_->WaitForCallEstablished();
146 callee_->WaitForCallEstablished();
147 }
148
149 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
150 return GetStats(caller_->pc());
151 }
Henrik Boström1df1bf82018-03-20 12:24:20152 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
153 rtc::scoped_refptr<RtpSenderInterface> selector) {
154 return GetStats(caller_->pc(), selector);
155 }
156 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
157 rtc::scoped_refptr<RtpReceiverInterface> selector) {
158 return GetStats(caller_->pc(), selector);
159 }
hbosdb346a72016-11-29 09:57:01160
161 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
162 return GetStats(callee_->pc());
163 }
Henrik Boström1df1bf82018-03-20 12:24:20164 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
165 rtc::scoped_refptr<RtpSenderInterface> selector) {
166 return GetStats(callee_->pc(), selector);
167 }
168 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
169 rtc::scoped_refptr<RtpReceiverInterface> selector) {
170 return GetStats(callee_->pc(), selector);
171 }
hbosdb346a72016-11-29 09:57:01172
173 protected:
174 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
175 PeerConnectionInterface* pc) {
176 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
177 RTCStatsObtainer::Create();
Niels Möllerafb246b2022-04-20 12:26:50178 pc->GetStats(stats_obtainer.get());
179 EXPECT_TRUE_WAIT(stats_obtainer->report() != nullptr, kGetStatsTimeoutMs);
hbosdb346a72016-11-29 09:57:01180 return stats_obtainer->report();
181 }
182
Henrik Boström1df1bf82018-03-20 12:24:20183 template <typename T>
184 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
185 PeerConnectionInterface* pc,
186 rtc::scoped_refptr<T> selector) {
187 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
188 RTCStatsObtainer::Create();
189 pc->GetStats(selector, stats_obtainer);
Niels Möllerafb246b2022-04-20 12:26:50190 EXPECT_TRUE_WAIT(stats_obtainer->report() != nullptr, kGetStatsTimeoutMs);
Henrik Boström1df1bf82018-03-20 12:24:20191 return stats_obtainer->report();
192 }
193
Artem Titov880fa812021-07-30 20:30:23194 // `network_thread_` uses `virtual_socket_server_` so they must be
deadbeef98e186c2017-05-17 01:00:06195 // constructed/destructed in the correct order.
hbosdb346a72016-11-29 09:57:01196 rtc::VirtualSocketServer virtual_socket_server_;
tommie7251592017-07-14 21:44:46197 std::unique_ptr<rtc::Thread> network_thread_;
198 std::unique_ptr<rtc::Thread> worker_thread_;
hbosdb346a72016-11-29 09:57:01199 rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
200 rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
201};
202
203class RTCStatsVerifier {
204 public:
205 RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
206 : report_(report), stats_(stats), all_tests_successful_(true) {
207 RTC_CHECK(report_);
208 RTC_CHECK(stats_);
209 for (const RTCStatsMemberInterface* member : stats_->Members()) {
210 untested_members_.insert(member);
211 }
212 }
213
Yves Gerey665174f2018-06-19 13:03:05214 void MarkMemberTested(const RTCStatsMemberInterface& member,
215 bool test_successful) {
hbosdb346a72016-11-29 09:57:01216 untested_members_.erase(&member);
217 all_tests_successful_ &= test_successful;
218 }
219
220 void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05221 EXPECT_TRUE(member.is_defined())
222 << stats_->type() << "." << member.name() << "[" << stats_->id()
223 << "] was undefined.";
hbosdb346a72016-11-29 09:57:01224 MarkMemberTested(member, member.is_defined());
225 }
226
227 void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05228 EXPECT_FALSE(member.is_defined())
229 << stats_->type() << "." << member.name() << "[" << stats_->id()
230 << "] was defined (" << member.ValueToString() << ").";
hbosdb346a72016-11-29 09:57:01231 MarkMemberTested(member, !member.is_defined());
232 }
233
Yves Gerey665174f2018-06-19 13:03:05234 template <typename T>
hbos23351192017-01-02 14:52:19235 void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05236 EXPECT_TRUE(member.is_defined())
237 << stats_->type() << "." << member.name() << "[" << stats_->id()
238 << "] was undefined.";
hbos23351192017-01-02 14:52:19239 if (!member.is_defined()) {
240 MarkMemberTested(member, false);
241 return;
242 }
243 bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
Yves Gerey665174f2018-06-19 13:03:05244 EXPECT_TRUE(is_positive)
245 << stats_->type() << "." << member.name() << "[" << stats_->id()
246 << "] was not positive (" << member.ValueToString() << ").";
hbos23351192017-01-02 14:52:19247 MarkMemberTested(member, is_positive);
248 }
249
Yves Gerey665174f2018-06-19 13:03:05250 template <typename T>
hbos23351192017-01-02 14:52:19251 void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05252 EXPECT_TRUE(member.is_defined())
253 << stats_->type() << "." << member.name() << "[" << stats_->id()
254 << "] was undefined.";
hbos23351192017-01-02 14:52:19255 if (!member.is_defined()) {
256 MarkMemberTested(member, false);
257 return;
258 }
259 bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
Yves Gerey665174f2018-06-19 13:03:05260 EXPECT_TRUE(is_non_negative)
261 << stats_->type() << "." << member.name() << "[" << stats_->id()
262 << "] was not non-negative (" << member.ValueToString() << ").";
hbos23351192017-01-02 14:52:19263 MarkMemberTested(member, is_non_negative);
264 }
265
Yves Gerey665174f2018-06-19 13:03:05266 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
267 const char* expected_type) {
hbosdb346a72016-11-29 09:57:01268 TestMemberIsIDReference(member, expected_type, false);
269 }
270
Yves Gerey665174f2018-06-19 13:03:05271 void TestMemberIsOptionalIDReference(const RTCStatsMemberInterface& member,
272 const char* expected_type) {
hbosdb346a72016-11-29 09:57:01273 TestMemberIsIDReference(member, expected_type, true);
274 }
275
276 bool ExpectAllMembersSuccessfullyTested() {
277 if (untested_members_.empty())
278 return all_tests_successful_;
279 for (const RTCStatsMemberInterface* member : untested_members_) {
Yves Gerey665174f2018-06-19 13:03:05280 EXPECT_TRUE(false) << stats_->type() << "." << member->name() << "["
281 << stats_->id() << "] was not tested.";
hbosdb346a72016-11-29 09:57:01282 }
283 return false;
284 }
285
286 private:
Yves Gerey665174f2018-06-19 13:03:05287 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
288 const char* expected_type,
289 bool optional) {
hbosdb346a72016-11-29 09:57:01290 if (optional && !member.is_defined()) {
291 MarkMemberTested(member, true);
292 return;
293 }
294 bool valid_reference = false;
295 if (member.is_defined()) {
296 if (member.type() == RTCStatsMemberInterface::kString) {
297 // A single ID.
298 const RTCStatsMember<std::string>& id =
299 member.cast_to<RTCStatsMember<std::string>>();
300 const RTCStats* referenced_stats = report_->Get(*id);
301 valid_reference =
302 referenced_stats && referenced_stats->type() == expected_type;
303 } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
304 // A vector of IDs.
305 valid_reference = true;
306 const RTCStatsMember<std::vector<std::string>>& ids =
307 member.cast_to<RTCStatsMember<std::vector<std::string>>>();
Mirko Bonadeic61ce0d2017-11-21 16:04:20308 for (const std::string& id : *ids) {
hbosdb346a72016-11-29 09:57:01309 const RTCStats* referenced_stats = report_->Get(id);
310 if (!referenced_stats || referenced_stats->type() != expected_type) {
311 valid_reference = false;
312 break;
313 }
314 }
315 }
316 }
Yves Gerey665174f2018-06-19 13:03:05317 EXPECT_TRUE(valid_reference)
318 << stats_->type() << "." << member.name()
319 << " is not a reference to an "
Jonas Olssonb2b20312020-01-14 11:11:31320 "existing dictionary of type "
321 << expected_type << " (value: "
Henrik Boström646fda02019-05-22 13:49:42322 << (member.is_defined() ? member.ValueToString() : "null") << ").";
hbosdb346a72016-11-29 09:57:01323 MarkMemberTested(member, valid_reference);
324 }
325
326 rtc::scoped_refptr<const RTCStatsReport> report_;
327 const RTCStats* stats_;
328 std::set<const RTCStatsMemberInterface*> untested_members_;
329 bool all_tests_successful_;
330};
331
332class RTCStatsReportVerifier {
333 public:
334 static std::set<const char*> StatsTypes() {
335 std::set<const char*> stats_types;
336 stats_types.insert(RTCCertificateStats::kType);
337 stats_types.insert(RTCCodecStats::kType);
338 stats_types.insert(RTCDataChannelStats::kType);
339 stats_types.insert(RTCIceCandidatePairStats::kType);
340 stats_types.insert(RTCLocalIceCandidateStats::kType);
341 stats_types.insert(RTCRemoteIceCandidateStats::kType);
342 stats_types.insert(RTCMediaStreamStats::kType);
343 stats_types.insert(RTCMediaStreamTrackStats::kType);
344 stats_types.insert(RTCPeerConnectionStats::kType);
345 stats_types.insert(RTCInboundRTPStreamStats::kType);
346 stats_types.insert(RTCOutboundRTPStreamStats::kType);
347 stats_types.insert(RTCTransportStats::kType);
348 return stats_types;
349 }
350
351 explicit RTCStatsReportVerifier(const RTCStatsReport* report)
Yves Gerey665174f2018-06-19 13:03:05352 : report_(report) {}
hbosdb346a72016-11-29 09:57:01353
Eldar Rello9276e2c2020-06-10 14:53:39354 void VerifyReport(std::vector<const char*> allowed_missing_stats) {
hbosdb346a72016-11-29 09:57:01355 std::set<const char*> missing_stats = StatsTypes();
356 bool verify_successful = true;
hbos338f78a2017-02-07 14:41:21357 std::vector<const RTCTransportStats*> transport_stats =
358 report_->GetStatsOfType<RTCTransportStats>();
Mirko Bonadeie12c1fe2018-07-03 10:53:23359 EXPECT_EQ(transport_stats.size(), 1U);
hbos338f78a2017-02-07 14:41:21360 std::string selected_candidate_pair_id =
361 *transport_stats[0]->selected_candidate_pair_id;
hbosdb346a72016-11-29 09:57:01362 for (const RTCStats& stats : *report_) {
363 missing_stats.erase(stats.type());
364 if (stats.type() == RTCCertificateStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05365 verify_successful &=
366 VerifyRTCCertificateStats(stats.cast_to<RTCCertificateStats>());
hbosdb346a72016-11-29 09:57:01367 } else if (stats.type() == RTCCodecStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05368 verify_successful &=
369 VerifyRTCCodecStats(stats.cast_to<RTCCodecStats>());
hbosdb346a72016-11-29 09:57:01370 } else if (stats.type() == RTCDataChannelStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05371 verify_successful &=
372 VerifyRTCDataChannelStats(stats.cast_to<RTCDataChannelStats>());
hbosdb346a72016-11-29 09:57:01373 } else if (stats.type() == RTCIceCandidatePairStats::kType) {
374 verify_successful &= VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 14:41:21375 stats.cast_to<RTCIceCandidatePairStats>(),
376 stats.id() == selected_candidate_pair_id);
hbosdb346a72016-11-29 09:57:01377 } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
378 verify_successful &= VerifyRTCLocalIceCandidateStats(
379 stats.cast_to<RTCLocalIceCandidateStats>());
380 } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
381 verify_successful &= VerifyRTCRemoteIceCandidateStats(
382 stats.cast_to<RTCRemoteIceCandidateStats>());
383 } else if (stats.type() == RTCMediaStreamStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05384 verify_successful &=
385 VerifyRTCMediaStreamStats(stats.cast_to<RTCMediaStreamStats>());
hbosdb346a72016-11-29 09:57:01386 } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
387 verify_successful &= VerifyRTCMediaStreamTrackStats(
388 stats.cast_to<RTCMediaStreamTrackStats>());
389 } else if (stats.type() == RTCPeerConnectionStats::kType) {
390 verify_successful &= VerifyRTCPeerConnectionStats(
391 stats.cast_to<RTCPeerConnectionStats>());
392 } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
393 verify_successful &= VerifyRTCInboundRTPStreamStats(
394 stats.cast_to<RTCInboundRTPStreamStats>());
395 } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
396 verify_successful &= VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 14:53:39397 stats.cast_to<RTCOutboundRTPStreamStats>());
Henrik Boström883eefc2019-05-27 11:40:25398 } else if (stats.type() == RTCRemoteInboundRtpStreamStats::kType) {
399 verify_successful &= VerifyRTCRemoteInboundRtpStreamStats(
400 stats.cast_to<RTCRemoteInboundRtpStreamStats>());
Alessio Bazzicaf7b1b952021-03-23 16:23:04401 } else if (stats.type() == RTCRemoteOutboundRtpStreamStats::kType) {
402 verify_successful &= VerifyRTCRemoteOutboundRTPStreamStats(
403 stats.cast_to<RTCRemoteOutboundRtpStreamStats>());
Henrik Boström646fda02019-05-22 13:49:42404 } else if (stats.type() == RTCAudioSourceStats::kType) {
405 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
406 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 20:30:23407 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 13:49:42408 verify_successful &=
409 VerifyRTCAudioSourceStats(stats.cast_to<RTCAudioSourceStats>());
410 } else if (stats.type() == RTCVideoSourceStats::kType) {
411 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
412 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 20:30:23413 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 13:49:42414 verify_successful &=
415 VerifyRTCVideoSourceStats(stats.cast_to<RTCVideoSourceStats>());
hbosdb346a72016-11-29 09:57:01416 } else if (stats.type() == RTCTransportStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05417 verify_successful &=
418 VerifyRTCTransportStats(stats.cast_to<RTCTransportStats>());
hbosdb346a72016-11-29 09:57:01419 } else {
420 EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
421 verify_successful = false;
422 }
423 }
Henrik Boström1df1bf82018-03-20 12:24:20424 for (const char* missing : missing_stats) {
Steve Anton64b626b2019-01-29 01:25:26425 if (!absl::c_linear_search(allowed_missing_stats, missing)) {
Henrik Boström1df1bf82018-03-20 12:24:20426 verify_successful = false;
hbosdb346a72016-11-29 09:57:01427 EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
428 }
429 }
Yves Gerey665174f2018-06-19 13:03:05430 EXPECT_TRUE(verify_successful)
431 << "One or more problems with the stats. This is the report:\n"
432 << report_->ToJson();
hbosdb346a72016-11-29 09:57:01433 }
434
Yves Gerey665174f2018-06-19 13:03:05435 bool VerifyRTCCertificateStats(const RTCCertificateStats& certificate) {
Niels Möllerafb246b2022-04-20 12:26:50436 RTCStatsVerifier verifier(report_.get(), &certificate);
hbosdb346a72016-11-29 09:57:01437 verifier.TestMemberIsDefined(certificate.fingerprint);
438 verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
439 verifier.TestMemberIsDefined(certificate.base64_certificate);
Yves Gerey665174f2018-06-19 13:03:05440 verifier.TestMemberIsOptionalIDReference(certificate.issuer_certificate_id,
441 RTCCertificateStats::kType);
hbosdb346a72016-11-29 09:57:01442 return verifier.ExpectAllMembersSuccessfullyTested();
443 }
444
Yves Gerey665174f2018-06-19 13:03:05445 bool VerifyRTCCodecStats(const RTCCodecStats& codec) {
Niels Möllerafb246b2022-04-20 12:26:50446 RTCStatsVerifier verifier(report_.get(), &codec);
Philipp Hancke95157a02020-11-16 19:08:27447 verifier.TestMemberIsIDReference(codec.transport_id,
448 RTCTransportStats::kType);
hbosdb346a72016-11-29 09:57:01449 verifier.TestMemberIsDefined(codec.payload_type);
hbos13f54b22017-02-28 14:56:04450 verifier.TestMemberIsDefined(codec.mime_type);
hbos23351192017-01-02 14:52:19451 verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
Johannes Kron72d69152020-02-10 13:05:55452
453 if (codec.mime_type->rfind("audio", 0) == 0)
454 verifier.TestMemberIsPositive<uint32_t>(codec.channels);
455 else
456 verifier.TestMemberIsUndefined(codec.channels);
457
458 // sdp_fmtp_line is an optional field.
459 verifier.MarkMemberTested(codec.sdp_fmtp_line, true);
hbosdb346a72016-11-29 09:57:01460 return verifier.ExpectAllMembersSuccessfullyTested();
461 }
462
Yves Gerey665174f2018-06-19 13:03:05463 bool VerifyRTCDataChannelStats(const RTCDataChannelStats& data_channel) {
Niels Möllerafb246b2022-04-20 12:26:50464 RTCStatsVerifier verifier(report_.get(), &data_channel);
hbosdb346a72016-11-29 09:57:01465 verifier.TestMemberIsDefined(data_channel.label);
466 verifier.TestMemberIsDefined(data_channel.protocol);
Harald Alvestrand10ef8472020-06-05 13:38:51467 verifier.TestMemberIsDefined(data_channel.data_channel_identifier);
hbosdb346a72016-11-29 09:57:01468 verifier.TestMemberIsDefined(data_channel.state);
hbos23351192017-01-02 14:52:19469 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
470 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
471 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
472 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
hbosdb346a72016-11-29 09:57:01473 return verifier.ExpectAllMembersSuccessfullyTested();
474 }
475
476 bool VerifyRTCIceCandidatePairStats(
Yves Gerey665174f2018-06-19 13:03:05477 const RTCIceCandidatePairStats& candidate_pair,
478 bool is_selected_pair) {
Niels Möllerafb246b2022-04-20 12:26:50479 RTCStatsVerifier verifier(report_.get(), &candidate_pair);
Yves Gerey665174f2018-06-19 13:03:05480 verifier.TestMemberIsIDReference(candidate_pair.transport_id,
481 RTCTransportStats::kType);
482 verifier.TestMemberIsIDReference(candidate_pair.local_candidate_id,
483 RTCLocalIceCandidateStats::kType);
484 verifier.TestMemberIsIDReference(candidate_pair.remote_candidate_id,
485 RTCRemoteIceCandidateStats::kType);
hbos06495bc2017-01-02 16:08:18486 verifier.TestMemberIsDefined(candidate_pair.state);
487 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
hbos92eaec62017-02-27 09:38:08488 verifier.TestMemberIsDefined(candidate_pair.nominated);
hbosdb346a72016-11-29 09:57:01489 verifier.TestMemberIsDefined(candidate_pair.writable);
Taylor Brandstetter79326ea2021-09-28 22:09:53490 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.packets_sent);
491 verifier.TestMemberIsNonNegative<uint64_t>(
492 candidate_pair.packets_discarded_on_send);
493 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.packets_received);
hbos23351192017-01-02 14:52:19494 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
Taylor Brandstetter79326ea2021-09-28 22:09:53495 verifier.TestMemberIsNonNegative<uint64_t>(
496 candidate_pair.bytes_discarded_on_send);
hbos23351192017-01-02 14:52:19497 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
hbosbf8d3e52017-02-28 14:34:47498 verifier.TestMemberIsNonNegative<double>(
499 candidate_pair.total_round_trip_time);
hbos23351192017-01-02 14:52:19500 verifier.TestMemberIsNonNegative<double>(
501 candidate_pair.current_round_trip_time);
hbos338f78a2017-02-07 14:41:21502 if (is_selected_pair) {
503 verifier.TestMemberIsNonNegative<double>(
504 candidate_pair.available_outgoing_bitrate);
deadbeef86c40a12017-06-28 16:37:23505 // A pair should be nominated in order to be selected.
506 EXPECT_TRUE(*candidate_pair.nominated);
hbos338f78a2017-02-07 14:41:21507 } else {
508 verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
509 }
hbosdb346a72016-11-29 09:57:01510 verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
hbos23351192017-01-02 14:52:19511 verifier.TestMemberIsNonNegative<uint64_t>(
512 candidate_pair.requests_received);
513 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.requests_sent);
514 verifier.TestMemberIsNonNegative<uint64_t>(
515 candidate_pair.responses_received);
516 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.responses_sent);
hbos23351192017-01-02 14:52:19517 verifier.TestMemberIsNonNegative<uint64_t>(
518 candidate_pair.consent_requests_sent);
Jonas Oreland0d13bbd2022-03-02 10:17:36519
hbosdb346a72016-11-29 09:57:01520 return verifier.ExpectAllMembersSuccessfullyTested();
521 }
522
Yves Gerey665174f2018-06-19 13:03:05523 bool VerifyRTCIceCandidateStats(const RTCIceCandidateStats& candidate) {
Niels Möllerafb246b2022-04-20 12:26:50524 RTCStatsVerifier verifier(report_.get(), &candidate);
Yves Gerey665174f2018-06-19 13:03:05525 verifier.TestMemberIsIDReference(candidate.transport_id,
526 RTCTransportStats::kType);
hbosc3a2b7f2017-01-02 12:46:15527 verifier.TestMemberIsDefined(candidate.is_remote);
Gary Liu37e489c2017-11-21 18:49:36528 if (*candidate.is_remote) {
529 verifier.TestMemberIsUndefined(candidate.network_type);
Jonas Oreland0d13bbd2022-03-02 10:17:36530 verifier.TestMemberIsUndefined(candidate.network_adapter_type);
531 verifier.TestMemberIsUndefined(candidate.vpn);
Gary Liu37e489c2017-11-21 18:49:36532 } else {
533 verifier.TestMemberIsDefined(candidate.network_type);
Jonas Oreland0d13bbd2022-03-02 10:17:36534 verifier.TestMemberIsDefined(candidate.network_adapter_type);
535 verifier.TestMemberIsDefined(candidate.vpn);
Gary Liu37e489c2017-11-21 18:49:36536 }
hbosdb346a72016-11-29 09:57:01537 verifier.TestMemberIsDefined(candidate.ip);
Philipp Hanckea9ba4502021-03-22 12:22:54538 verifier.TestMemberIsDefined(candidate.address);
hbos23351192017-01-02 14:52:19539 verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
hbosdb346a72016-11-29 09:57:01540 verifier.TestMemberIsDefined(candidate.protocol);
541 verifier.TestMemberIsDefined(candidate.candidate_type);
hbos23351192017-01-02 14:52:19542 verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
hbosdb346a72016-11-29 09:57:01543 verifier.TestMemberIsUndefined(candidate.url);
Philipp Hancke95513752018-09-27 12:40:08544 verifier.TestMemberIsUndefined(candidate.relay_protocol);
hbosdb346a72016-11-29 09:57:01545 return verifier.ExpectAllMembersSuccessfullyTested();
546 }
547
548 bool VerifyRTCLocalIceCandidateStats(
549 const RTCLocalIceCandidateStats& local_candidate) {
550 return VerifyRTCIceCandidateStats(local_candidate);
551 }
552
553 bool VerifyRTCRemoteIceCandidateStats(
554 const RTCRemoteIceCandidateStats& remote_candidate) {
555 return VerifyRTCIceCandidateStats(remote_candidate);
556 }
557
Yves Gerey665174f2018-06-19 13:03:05558 bool VerifyRTCMediaStreamStats(const RTCMediaStreamStats& media_stream) {
Niels Möllerafb246b2022-04-20 12:26:50559 RTCStatsVerifier verifier(report_.get(), &media_stream);
hbosdb346a72016-11-29 09:57:01560 verifier.TestMemberIsDefined(media_stream.stream_identifier);
Yves Gerey665174f2018-06-19 13:03:05561 verifier.TestMemberIsIDReference(media_stream.track_ids,
562 RTCMediaStreamTrackStats::kType);
hbosdb346a72016-11-29 09:57:01563 return verifier.ExpectAllMembersSuccessfullyTested();
564 }
565
566 bool VerifyRTCMediaStreamTrackStats(
567 const RTCMediaStreamTrackStats& media_stream_track) {
Niels Möllerafb246b2022-04-20 12:26:50568 RTCStatsVerifier verifier(report_.get(), &media_stream_track);
hbosdb346a72016-11-29 09:57:01569 verifier.TestMemberIsDefined(media_stream_track.track_identifier);
570 verifier.TestMemberIsDefined(media_stream_track.remote_source);
571 verifier.TestMemberIsDefined(media_stream_track.ended);
572 verifier.TestMemberIsDefined(media_stream_track.detached);
hbos160e4a72017-01-17 10:53:23573 verifier.TestMemberIsDefined(media_stream_track.kind);
Guido Urdaneta67378412019-05-28 15:38:08574 RTC_DCHECK(media_stream_track.remote_source.is_defined());
hbosdb346a72016-11-29 09:57:01575 // Video or audio media stream track?
hbos160e4a72017-01-17 10:53:23576 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
Henrik Boström646fda02019-05-22 13:49:42577 // The type of the referenced media source depends on kind.
hbos42f6d2f2017-01-20 11:56:50578 if (*media_stream_track.remote_source) {
Guido Urdaneta67378412019-05-28 15:38:08579 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
580 verifier.TestMemberIsNonNegative<double>(
581 media_stream_track.jitter_buffer_delay);
582 verifier.TestMemberIsNonNegative<uint64_t>(
583 media_stream_track.jitter_buffer_emitted_count);
hbosfefe0762017-01-20 14:14:25584 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 15:35:03585 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 11:56:50586 verifier.TestMemberIsNonNegative<uint32_t>(
587 media_stream_track.frames_received);
hbosf64941f2017-01-20 15:39:09588 verifier.TestMemberIsNonNegative<uint32_t>(
589 media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 15:21:55590 verifier.TestMemberIsNonNegative<uint32_t>(
591 media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 15:45:42592 verifier.TestMemberIsNonNegative<uint32_t>(
593 media_stream_track.freeze_count);
594 verifier.TestMemberIsNonNegative<uint32_t>(
595 media_stream_track.pause_count);
596 verifier.TestMemberIsNonNegative<double>(
597 media_stream_track.total_freezes_duration);
598 verifier.TestMemberIsNonNegative<double>(
599 media_stream_track.total_pauses_duration);
600 verifier.TestMemberIsNonNegative<double>(
601 media_stream_track.total_frames_duration);
602 verifier.TestMemberIsNonNegative<double>(
603 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 11:56:50604 } else {
Guido Urdaneta67378412019-05-28 15:38:08605 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
606 RTCVideoSourceStats::kType);
607 // Local tracks have no jitter buffer.
608 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
609 verifier.TestMemberIsUndefined(
610 media_stream_track.jitter_buffer_emitted_count);
hbosfefe0762017-01-20 14:14:25611 verifier.TestMemberIsNonNegative<uint32_t>(
612 media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 15:35:03613 verifier.TestMemberIsNonNegative<uint32_t>(
614 media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 11:56:50615 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
hbosf64941f2017-01-20 15:39:09616 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 15:21:55617 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 15:45:42618 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
619 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
620 verifier.TestMemberIsUndefined(
621 media_stream_track.total_freezes_duration);
622 verifier.TestMemberIsUndefined(
623 media_stream_track.total_pauses_duration);
624 verifier.TestMemberIsUndefined(
625 media_stream_track.total_frames_duration);
626 verifier.TestMemberIsUndefined(
627 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 11:56:50628 }
Guido Urdaneta67378412019-05-28 15:38:08629 // Video-only members
630 verifier.TestMemberIsNonNegative<uint32_t>(
631 media_stream_track.frame_width);
632 verifier.TestMemberIsNonNegative<uint32_t>(
633 media_stream_track.frame_height);
hbosdb346a72016-11-29 09:57:01634 // Audio-only members should be undefined
635 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
636 verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
637 verifier.TestMemberIsUndefined(
638 media_stream_track.echo_return_loss_enhancement);
zsteine76bd3a2017-07-14 19:17:49639 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
640 verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 15:38:08641 verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
642 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 10:09:51643 verifier.TestMemberIsUndefined(
644 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 15:38:08645 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
Henrik Boström21e99da2019-08-21 10:09:51646 verifier.TestMemberIsUndefined(
647 media_stream_track.inserted_samples_for_deceleration);
648 verifier.TestMemberIsUndefined(
649 media_stream_track.removed_samples_for_acceleration);
Guido Urdaneta67378412019-05-28 15:38:08650 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_flushes);
651 verifier.TestMemberIsUndefined(
652 media_stream_track.delayed_packet_outage_samples);
653 verifier.TestMemberIsUndefined(
654 media_stream_track.relative_packet_arrival_delay);
655 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
656 verifier.TestMemberIsUndefined(
657 media_stream_track.total_interruption_duration);
hbosdb346a72016-11-29 09:57:01658 } else {
Yves Gerey665174f2018-06-19 13:03:05659 RTC_DCHECK_EQ(*media_stream_track.kind, RTCMediaStreamTrackKind::kAudio);
Henrik Boström646fda02019-05-22 13:49:42660 // The type of the referenced media source depends on kind.
Guido Urdaneta67378412019-05-28 15:38:08661 if (*media_stream_track.remote_source) {
Henrik Boström646fda02019-05-22 13:49:42662 // Remote tracks don't have media source stats.
663 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
Guido Urdaneta67378412019-05-28 15:38:08664 verifier.TestMemberIsNonNegative<double>(
665 media_stream_track.jitter_buffer_delay);
666 verifier.TestMemberIsNonNegative<uint64_t>(
667 media_stream_track.jitter_buffer_emitted_count);
Henrik Boströmd2c336f2019-07-03 15:11:10668 verifier.TestMemberIsPositive<double>(media_stream_track.audio_level);
669 verifier.TestMemberIsPositive<double>(
670 media_stream_track.total_audio_energy);
671 verifier.TestMemberIsPositive<uint64_t>(
Guido Urdaneta67378412019-05-28 15:38:08672 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 15:11:10673 verifier.TestMemberIsPositive<double>(
674 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 15:38:08675 verifier.TestMemberIsNonNegative<uint64_t>(
676 media_stream_track.concealed_samples);
677 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boström21e99da2019-08-21 10:09:51678 media_stream_track.silent_concealed_samples);
679 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 15:38:08680 media_stream_track.concealment_events);
681 verifier.TestMemberIsNonNegative<uint64_t>(
682 media_stream_track.inserted_samples_for_deceleration);
683 verifier.TestMemberIsNonNegative<uint64_t>(
684 media_stream_track.removed_samples_for_acceleration);
685 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 15:38:08686 media_stream_track.jitter_buffer_flushes);
687 verifier.TestMemberIsNonNegative<uint64_t>(
688 media_stream_track.delayed_packet_outage_samples);
689 verifier.TestMemberIsNonNegative<double>(
690 media_stream_track.relative_packet_arrival_delay);
691 verifier.TestMemberIsNonNegative<uint32_t>(
692 media_stream_track.interruption_count);
693 verifier.TestMemberIsNonNegative<double>(
694 media_stream_track.total_interruption_duration);
695 } else {
696 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
697 RTCAudioSourceStats::kType);
698 // Local audio tracks have no jitter buffer.
699 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
700 verifier.TestMemberIsUndefined(
701 media_stream_track.jitter_buffer_emitted_count);
Henrik Boströmd2c336f2019-07-03 15:11:10702 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
703 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
Guido Urdaneta67378412019-05-28 15:38:08704 verifier.TestMemberIsUndefined(
705 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 15:11:10706 verifier.TestMemberIsUndefined(
707 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 15:38:08708 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 10:09:51709 verifier.TestMemberIsUndefined(
710 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 15:38:08711 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
712 verifier.TestMemberIsUndefined(
Henrik Boström21e99da2019-08-21 10:09:51713 media_stream_track.inserted_samples_for_deceleration);
714 verifier.TestMemberIsUndefined(
715 media_stream_track.removed_samples_for_acceleration);
716 verifier.TestMemberIsUndefined(
Guido Urdaneta67378412019-05-28 15:38:08717 media_stream_track.jitter_buffer_flushes);
718 verifier.TestMemberIsUndefined(
719 media_stream_track.delayed_packet_outage_samples);
720 verifier.TestMemberIsUndefined(
721 media_stream_track.relative_packet_arrival_delay);
722 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
723 verifier.TestMemberIsUndefined(
724 media_stream_track.total_interruption_duration);
Henrik Boström646fda02019-05-22 13:49:42725 }
hbosdb346a72016-11-29 09:57:01726 // Video-only members should be undefined
727 verifier.TestMemberIsUndefined(media_stream_track.frame_width);
728 verifier.TestMemberIsUndefined(media_stream_track.frame_height);
hbosdb346a72016-11-29 09:57:01729 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 15:35:03730 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbosdb346a72016-11-29 09:57:01731 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
732 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
733 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 15:45:42734 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
735 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
736 verifier.TestMemberIsUndefined(media_stream_track.total_freezes_duration);
737 verifier.TestMemberIsUndefined(media_stream_track.total_pauses_duration);
738 verifier.TestMemberIsUndefined(media_stream_track.total_frames_duration);
739 verifier.TestMemberIsUndefined(
740 media_stream_track.sum_squared_frame_durations);
hbosdb346a72016-11-29 09:57:01741 // Audio-only members
Artem Titov880fa812021-07-30 20:30:23742 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
hbos2d4d6532017-01-20 12:16:41743 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
744 // test run until available or is there a way to have it always be
745 // defined? crbug.com/627816
746 verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
Yves Gerey665174f2018-06-19 13:03:05747 verifier.MarkMemberTested(media_stream_track.echo_return_loss_enhancement,
748 true);
hbosdb346a72016-11-29 09:57:01749 }
750 return verifier.ExpectAllMembersSuccessfullyTested();
751 }
752
753 bool VerifyRTCPeerConnectionStats(
754 const RTCPeerConnectionStats& peer_connection) {
Niels Möllerafb246b2022-04-20 12:26:50755 RTCStatsVerifier verifier(report_.get(), &peer_connection);
hbos23351192017-01-02 14:52:19756 verifier.TestMemberIsNonNegative<uint32_t>(
757 peer_connection.data_channels_opened);
758 verifier.TestMemberIsNonNegative<uint32_t>(
759 peer_connection.data_channels_closed);
hbosdb346a72016-11-29 09:57:01760 return verifier.ExpectAllMembersSuccessfullyTested();
761 }
762
Yves Gerey665174f2018-06-19 13:03:05763 void VerifyRTCRTPStreamStats(const RTCRTPStreamStats& stream,
Alessio Bazzicaf7b1b952021-03-23 16:23:04764 RTCStatsVerifier& verifier) {
765 verifier.TestMemberIsDefined(stream.ssrc);
766 verifier.TestMemberIsDefined(stream.kind);
Henrik Boström2f71b612021-03-23 14:18:55767 // Some legacy metrics are only defined for some of the RTP types in the
768 // hierarcy.
769 if (stream.type() == RTCInboundRTPStreamStats::kType ||
770 stream.type() == RTCOutboundRTPStreamStats::kType) {
Alessio Bazzicaf7b1b952021-03-23 16:23:04771 verifier.TestMemberIsDefined(stream.media_type);
772 verifier.TestMemberIsIDReference(stream.track_id,
773 RTCMediaStreamTrackStats::kType);
Henrik Boström2f71b612021-03-23 14:18:55774 } else {
Alessio Bazzicaf7b1b952021-03-23 16:23:04775 verifier.TestMemberIsUndefined(stream.media_type);
776 verifier.TestMemberIsUndefined(stream.track_id);
Henrik Boström2f71b612021-03-23 14:18:55777 }
Alessio Bazzicaf7b1b952021-03-23 16:23:04778 verifier.TestMemberIsIDReference(stream.transport_id,
779 RTCTransportStats::kType);
780 verifier.TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
781 }
782
783 void VerifyRTCSentRTPStreamStats(const RTCSentRtpStreamStats& sent_stream,
784 RTCStatsVerifier& verifier) {
785 VerifyRTCRTPStreamStats(sent_stream, verifier);
786 verifier.TestMemberIsDefined(sent_stream.packets_sent);
787 verifier.TestMemberIsDefined(sent_stream.bytes_sent);
hbosdb346a72016-11-29 09:57:01788 }
789
790 bool VerifyRTCInboundRTPStreamStats(
791 const RTCInboundRTPStreamStats& inbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:50792 RTCStatsVerifier verifier(report_.get(), &inbound_stream);
Philipp Hanckea116da52022-06-17 09:20:39793 VerifyRTCReceivedRtpStreamStats(
794 inbound_stream, verifier,
795 inbound_stream.kind.is_defined() && *inbound_stream.kind == "audio");
Alessio Bazzicaf7b1b952021-03-23 16:23:04796 verifier.TestMemberIsOptionalIDReference(
797 inbound_stream.remote_id, RTCRemoteOutboundRtpStreamStats::kType);
Henrik Boström1ab61882022-06-16 15:07:33798 verifier.TestMemberIsDefined(inbound_stream.mid);
Henrik Boströma6c7d5c2022-06-16 14:55:31799 verifier.TestMemberIsDefined(inbound_stream.track_identifier);
Philipp Hanckea116da52022-06-17 09:20:39800 if (inbound_stream.kind.is_defined() && *inbound_stream.kind == "video") {
sakal5fec1282017-02-20 14:43:58801 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 11:09:51802 verifier.TestMemberIsDefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 14:43:58803 } else {
hbosa51d4f32017-02-16 13:34:48804 verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 11:09:51805 verifier.TestMemberIsUndefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 14:43:58806 }
hbos23351192017-01-02 14:52:19807 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
Philipp Hanckea116da52022-06-17 09:20:39808 if (inbound_stream.kind.is_defined() && *inbound_stream.kind == "audio") {
Ivo Creusen8d8ffdb2019-04-30 07:45:21809 verifier.TestMemberIsNonNegative<uint64_t>(
810 inbound_stream.fec_packets_received);
811 verifier.TestMemberIsNonNegative<uint64_t>(
812 inbound_stream.fec_packets_discarded);
Henrik Boström4a5dab02020-01-28 10:15:35813 } else {
814 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_received);
815 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_discarded);
Ivo Creusen8d8ffdb2019-04-30 07:45:21816 }
hbos23351192017-01-02 14:52:19817 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
Niels Möllerac0a4cb2019-10-09 13:01:33818 verifier.TestMemberIsNonNegative<uint64_t>(
819 inbound_stream.header_bytes_received);
Henrik Boström01738c62019-04-15 15:32:00820 verifier.TestMemberIsDefined(inbound_stream.last_packet_received_timestamp);
Eldar Rello4e5bc9f2020-07-06 11:18:07821 if (inbound_stream.frames_received.ValueOrDefault(0) > 0) {
822 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_width);
823 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_height);
824 } else {
825 verifier.TestMemberIsUndefined(inbound_stream.frame_width);
826 verifier.TestMemberIsUndefined(inbound_stream.frame_height);
827 }
828 if (inbound_stream.frames_per_second.is_defined()) {
829 verifier.TestMemberIsNonNegative<double>(
830 inbound_stream.frames_per_second);
831 } else {
832 verifier.TestMemberIsUndefined(inbound_stream.frames_per_second);
833 }
Byoungchan Lee899b29e2021-06-29 13:09:18834 verifier.TestMemberIsNonNegative<double>(
835 inbound_stream.jitter_buffer_delay);
836 verifier.TestMemberIsNonNegative<uint64_t>(
837 inbound_stream.jitter_buffer_emitted_count);
Philipp Hanckea116da52022-06-17 09:20:39838 if (inbound_stream.kind.is_defined() && *inbound_stream.kind == "video") {
Eldar Rello4e5bc9f2020-07-06 11:18:07839 verifier.TestMemberIsUndefined(inbound_stream.total_samples_received);
840 verifier.TestMemberIsUndefined(inbound_stream.concealed_samples);
841 verifier.TestMemberIsUndefined(inbound_stream.silent_concealed_samples);
842 verifier.TestMemberIsUndefined(inbound_stream.concealment_events);
843 verifier.TestMemberIsUndefined(
844 inbound_stream.inserted_samples_for_deceleration);
845 verifier.TestMemberIsUndefined(
846 inbound_stream.removed_samples_for_acceleration);
Ivo Creusen11fdb082022-07-04 12:16:39847 verifier.TestMemberIsUndefined(inbound_stream.jitter_buffer_target_delay);
Ivo Creusen1a84b562022-07-19 14:33:10848 verifier.TestMemberIsUndefined(
849 inbound_stream.jitter_buffer_minimum_delay);
Eldar Rello4e5bc9f2020-07-06 11:18:07850 verifier.TestMemberIsUndefined(inbound_stream.audio_level);
851 verifier.TestMemberIsUndefined(inbound_stream.total_audio_energy);
852 verifier.TestMemberIsUndefined(inbound_stream.total_samples_duration);
853 verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.frames_received);
Di Wufd1e9d12021-03-09 17:25:28854 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.fir_count);
855 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.pli_count);
856 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.nack_count);
hbosdb346a72016-11-29 09:57:01857 } else {
Di Wufd1e9d12021-03-09 17:25:28858 verifier.TestMemberIsUndefined(inbound_stream.fir_count);
859 verifier.TestMemberIsUndefined(inbound_stream.pli_count);
860 verifier.TestMemberIsUndefined(inbound_stream.nack_count);
Eldar Rello4e5bc9f2020-07-06 11:18:07861 verifier.TestMemberIsPositive<uint64_t>(
862 inbound_stream.total_samples_received);
863 verifier.TestMemberIsNonNegative<uint64_t>(
864 inbound_stream.concealed_samples);
865 verifier.TestMemberIsNonNegative<uint64_t>(
866 inbound_stream.silent_concealed_samples);
867 verifier.TestMemberIsNonNegative<uint64_t>(
868 inbound_stream.concealment_events);
869 verifier.TestMemberIsNonNegative<uint64_t>(
870 inbound_stream.inserted_samples_for_deceleration);
871 verifier.TestMemberIsNonNegative<uint64_t>(
872 inbound_stream.removed_samples_for_acceleration);
Ivo Creusen11fdb082022-07-04 12:16:39873 verifier.TestMemberIsNonNegative<double>(
874 inbound_stream.jitter_buffer_target_delay);
Ivo Creusen1a84b562022-07-19 14:33:10875 verifier.TestMemberIsNonNegative<double>(
876 inbound_stream.jitter_buffer_minimum_delay);
Eldar Rello4e5bc9f2020-07-06 11:18:07877 verifier.TestMemberIsPositive<double>(inbound_stream.audio_level);
878 verifier.TestMemberIsPositive<double>(inbound_stream.total_audio_energy);
879 verifier.TestMemberIsPositive<double>(
880 inbound_stream.total_samples_duration);
881 verifier.TestMemberIsUndefined(inbound_stream.frames_received);
hbosdb346a72016-11-29 09:57:01882 }
Åsa Perssonfcf79cc2019-10-22 13:23:44883 // Test runtime too short to get an estimate (at least two RTCP sender
884 // reports need to be received).
885 verifier.MarkMemberTested(inbound_stream.estimated_playout_timestamp, true);
Philipp Hanckea116da52022-06-17 09:20:39886 if (inbound_stream.kind.is_defined() && *inbound_stream.kind == "video") {
hbos6769c492017-01-02 16:35:13887 verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 12:29:34888 verifier.TestMemberIsDefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 11:18:07889 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 08:07:50890 verifier.TestMemberIsNonNegative<double>(
891 inbound_stream.total_decode_time);
Johannes Kron00376e12019-11-25 09:25:42892 verifier.TestMemberIsNonNegative<double>(
Philipp Hanckea16a6a62022-04-25 10:21:30893 inbound_stream.total_processing_delay);
894 verifier.TestMemberIsNonNegative<double>(
Philipp Hancke0359ba22022-05-05 13:55:36895 inbound_stream.total_assembly_time);
896 verifier.TestMemberIsDefined(
897 inbound_stream.frames_assembled_from_multiple_packets);
898 verifier.TestMemberIsNonNegative<double>(
Johannes Kron00376e12019-11-25 09:25:42899 inbound_stream.total_inter_frame_delay);
900 verifier.TestMemberIsNonNegative<double>(
901 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 11:59:31902 // The integration test is not set up to test screen share; don't require
903 // this to be present.
904 verifier.MarkMemberTested(inbound_stream.content_type, true);
Philipp Hancke6fb8d1a2022-05-30 10:37:04905 verifier.TestMemberIsNonNegative<double>(
906 inbound_stream.min_playout_delay);
hbos6769c492017-01-02 16:35:13907 } else {
908 verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 12:29:34909 verifier.TestMemberIsUndefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 11:18:07910 verifier.TestMemberIsUndefined(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 08:07:50911 verifier.TestMemberIsUndefined(inbound_stream.total_decode_time);
Philipp Hanckea16a6a62022-04-25 10:21:30912 verifier.TestMemberIsUndefined(inbound_stream.total_processing_delay);
Philipp Hancke0359ba22022-05-05 13:55:36913 verifier.TestMemberIsUndefined(inbound_stream.total_assembly_time);
914 verifier.TestMemberIsUndefined(
915 inbound_stream.frames_assembled_from_multiple_packets);
Johannes Kron00376e12019-11-25 09:25:42916 verifier.TestMemberIsUndefined(inbound_stream.total_inter_frame_delay);
917 verifier.TestMemberIsUndefined(
918 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 11:59:31919 verifier.TestMemberIsUndefined(inbound_stream.content_type);
Philipp Hancke6fb8d1a2022-05-30 10:37:04920 verifier.TestMemberIsUndefined(inbound_stream.min_playout_delay);
hbos6769c492017-01-02 16:35:13921 }
hbosdb346a72016-11-29 09:57:01922 return verifier.ExpectAllMembersSuccessfullyTested();
923 }
924
925 bool VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 14:53:39926 const RTCOutboundRTPStreamStats& outbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:50927 RTCStatsVerifier verifier(report_.get(), &outbound_stream);
Alessio Bazzicaf7b1b952021-03-23 16:23:04928 VerifyRTCRTPStreamStats(outbound_stream, verifier);
Henrik Boström1ab61882022-06-16 15:07:33929 verifier.TestMemberIsDefined(outbound_stream.mid);
Philipp Hanckea116da52022-06-17 09:20:39930 if (outbound_stream.kind.is_defined() && *outbound_stream.kind == "video") {
Henrik Boström646fda02019-05-22 13:49:42931 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
932 RTCVideoSourceStats::kType);
Di Wufd1e9d12021-03-09 17:25:28933 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.fir_count);
934 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.pli_count);
Henrik Boströma0ff50c2020-05-05 13:54:46935 if (*outbound_stream.frames_encoded > 0) {
936 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
937 } else {
938 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
939 }
hbos6769c492017-01-02 16:35:13940 } else {
Di Wufd1e9d12021-03-09 17:25:28941 verifier.TestMemberIsUndefined(outbound_stream.fir_count);
942 verifier.TestMemberIsUndefined(outbound_stream.pli_count);
Henrik Boström646fda02019-05-22 13:49:42943 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
944 RTCAudioSourceStats::kType);
hbos6769c492017-01-02 16:35:13945 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
946 }
Jakob Ivarssone91c9922021-07-06 07:55:43947 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.nack_count);
Henrik Boström4f40fa52019-12-19 12:27:27948 verifier.TestMemberIsOptionalIDReference(
949 outbound_stream.remote_id, RTCRemoteInboundRtpStreamStats::kType);
hbos23351192017-01-02 14:52:19950 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
Henrik Boströmcf96e0f2019-04-17 11:51:53951 verifier.TestMemberIsNonNegative<uint64_t>(
952 outbound_stream.retransmitted_packets_sent);
hbos23351192017-01-02 14:52:19953 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
Henrik Boströmcf96e0f2019-04-17 11:51:53954 verifier.TestMemberIsNonNegative<uint64_t>(
Niels Möllerac0a4cb2019-10-09 13:01:33955 outbound_stream.header_bytes_sent);
956 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boströmcf96e0f2019-04-17 11:51:53957 outbound_stream.retransmitted_bytes_sent);
Philipp Hanckea116da52022-06-17 09:20:39958 if (outbound_stream.kind.is_defined() && *outbound_stream.kind == "video") {
hbos6769c492017-01-02 16:35:13959 verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 12:29:34960 verifier.TestMemberIsDefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 14:14:23961 verifier.TestMemberIsNonNegative<double>(
962 outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 13:15:38963 verifier.TestMemberIsNonNegative<uint64_t>(
964 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 16:38:20965 verifier.TestMemberIsNonNegative<double>(
966 outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 15:42:38967 verifier.TestMemberIsDefined(outbound_stream.quality_limitation_reason);
Byoungchan Lee7d235352021-05-28 12:32:04968 verifier.TestMemberIsDefined(
969 outbound_stream.quality_limitation_durations);
Evan Shrubsolecc62b162019-09-09 09:26:45970 verifier.TestMemberIsNonNegative<uint32_t>(
971 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 11:59:31972 // The integration test is not set up to test screen share; don't require
973 // this to be present.
974 verifier.MarkMemberTested(outbound_stream.content_type, true);
Henrik Boström6b430862019-08-16 11:09:51975 verifier.TestMemberIsDefined(outbound_stream.encoder_implementation);
Eldar Rello9276e2c2020-06-10 14:53:39976 // Unless an implementation-specific amount of time has passed and at
977 // least one frame has been encoded, undefined is reported. Because it
978 // is hard to tell what is the case here, we treat FPS as optional.
979 // TODO(hbos): Update the tests to run until all implemented metrics
980 // should be populated.
981 if (outbound_stream.frames_per_second.is_defined()) {
982 verifier.TestMemberIsNonNegative<double>(
983 outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 13:54:46984 } else {
985 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 13:54:46986 }
Eldar Rello9276e2c2020-06-10 14:53:39987 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_height);
988 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_width);
989 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frames_sent);
990 verifier.TestMemberIsNonNegative<uint32_t>(
991 outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 12:43:49992 verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
Eldar Rello9276e2c2020-06-10 14:53:39993 verifier.MarkMemberTested(outbound_stream.rid, true);
hbos6769c492017-01-02 16:35:13994 } else {
995 verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 12:29:34996 verifier.TestMemberIsUndefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 14:14:23997 verifier.TestMemberIsUndefined(outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 13:15:38998 verifier.TestMemberIsUndefined(
999 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 16:38:201000 // TODO(https://crbug.com/webrtc/10635): Implement for audio as well.
1001 verifier.TestMemberIsUndefined(outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 15:42:381002 verifier.TestMemberIsUndefined(outbound_stream.quality_limitation_reason);
Evan Shrubsolecc62b162019-09-09 09:26:451003 verifier.TestMemberIsUndefined(
Byoungchan Lee7d235352021-05-28 12:32:041004 outbound_stream.quality_limitation_durations);
1005 verifier.TestMemberIsUndefined(
Evan Shrubsolecc62b162019-09-09 09:26:451006 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 11:59:311007 verifier.TestMemberIsUndefined(outbound_stream.content_type);
Henrik Boström6b430862019-08-16 11:09:511008 // TODO(hbos): Implement for audio as well.
1009 verifier.TestMemberIsUndefined(outbound_stream.encoder_implementation);
Henrik Boströma0ff50c2020-05-05 13:54:461010 verifier.TestMemberIsUndefined(outbound_stream.rid);
1011 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
1012 verifier.TestMemberIsUndefined(outbound_stream.frame_height);
1013 verifier.TestMemberIsUndefined(outbound_stream.frame_width);
1014 verifier.TestMemberIsUndefined(outbound_stream.frames_sent);
1015 verifier.TestMemberIsUndefined(outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 12:43:491016 verifier.TestMemberIsNonNegative<double>(outbound_stream.target_bitrate);
hbos6769c492017-01-02 16:35:131017 }
hbosdb346a72016-11-29 09:57:011018 return verifier.ExpectAllMembersSuccessfullyTested();
1019 }
1020
Henrik Boström2f71b612021-03-23 14:18:551021 void VerifyRTCReceivedRtpStreamStats(
1022 const RTCReceivedRtpStreamStats& received_rtp,
Minyue Li28a2c632021-07-07 13:53:381023 RTCStatsVerifier& verifier,
1024 bool packets_discarded_defined) {
Henrik Boström2f71b612021-03-23 14:18:551025 VerifyRTCRTPStreamStats(received_rtp, verifier);
Alessio Bazzicaf7b1b952021-03-23 16:23:041026 verifier.TestMemberIsNonNegative<double>(received_rtp.jitter);
1027 verifier.TestMemberIsDefined(received_rtp.packets_lost);
Minyue Li28a2c632021-07-07 13:53:381028 if (packets_discarded_defined) {
1029 verifier.TestMemberIsNonNegative<uint64_t>(
1030 received_rtp.packets_discarded);
1031 } else {
1032 verifier.TestMemberIsUndefined(received_rtp.packets_discarded);
1033 }
Henrik Boström2f71b612021-03-23 14:18:551034 }
1035
Henrik Boström883eefc2019-05-27 11:40:251036 bool VerifyRTCRemoteInboundRtpStreamStats(
1037 const RTCRemoteInboundRtpStreamStats& remote_inbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:501038 RTCStatsVerifier verifier(report_.get(), &remote_inbound_stream);
Minyue Li28a2c632021-07-07 13:53:381039 VerifyRTCReceivedRtpStreamStats(remote_inbound_stream, verifier, false);
Di Wu86f04ad2021-03-01 07:36:031040 verifier.TestMemberIsDefined(remote_inbound_stream.fraction_lost);
Henrik Boström883eefc2019-05-27 11:40:251041 verifier.TestMemberIsIDReference(remote_inbound_stream.local_id,
1042 RTCOutboundRTPStreamStats::kType);
1043 verifier.TestMemberIsNonNegative<double>(
1044 remote_inbound_stream.round_trip_time);
Di Wu88a51b22021-03-01 19:22:061045 verifier.TestMemberIsNonNegative<double>(
1046 remote_inbound_stream.total_round_trip_time);
1047 verifier.TestMemberIsNonNegative<int32_t>(
1048 remote_inbound_stream.round_trip_time_measurements);
Henrik Boström883eefc2019-05-27 11:40:251049 return verifier.ExpectAllMembersSuccessfullyTested();
1050 }
1051
Alessio Bazzicaf7b1b952021-03-23 16:23:041052 bool VerifyRTCRemoteOutboundRTPStreamStats(
1053 const RTCRemoteOutboundRtpStreamStats& remote_outbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:501054 RTCStatsVerifier verifier(report_.get(), &remote_outbound_stream);
Alessio Bazzicaf7b1b952021-03-23 16:23:041055 VerifyRTCRTPStreamStats(remote_outbound_stream, verifier);
1056 VerifyRTCSentRTPStreamStats(remote_outbound_stream, verifier);
1057 verifier.TestMemberIsIDReference(remote_outbound_stream.local_id,
1058 RTCOutboundRTPStreamStats::kType);
1059 verifier.TestMemberIsNonNegative<double>(
1060 remote_outbound_stream.remote_timestamp);
1061 verifier.TestMemberIsDefined(remote_outbound_stream.reports_sent);
1062 return verifier.ExpectAllMembersSuccessfullyTested();
1063 }
1064
Henrik Boström646fda02019-05-22 13:49:421065 void VerifyRTCMediaSourceStats(const RTCMediaSourceStats& media_source,
1066 RTCStatsVerifier* verifier) {
1067 verifier->TestMemberIsDefined(media_source.track_identifier);
1068 verifier->TestMemberIsDefined(media_source.kind);
1069 if (media_source.kind.is_defined()) {
1070 EXPECT_TRUE((*media_source.kind == "audio" &&
1071 media_source.type() == RTCAudioSourceStats::kType) ||
1072 (*media_source.kind == "video" &&
1073 media_source.type() == RTCVideoSourceStats::kType));
1074 }
1075 }
1076
1077 bool VerifyRTCAudioSourceStats(const RTCAudioSourceStats& audio_source) {
Niels Möllerafb246b2022-04-20 12:26:501078 RTCStatsVerifier verifier(report_.get(), &audio_source);
Henrik Boström646fda02019-05-22 13:49:421079 VerifyRTCMediaSourceStats(audio_source, &verifier);
Henrik Boström262bbae2019-09-13 09:34:551080 // Audio level, unlike audio energy, only gets updated at a certain
1081 // frequency, so we don't require that one to be positive to avoid a race
1082 // (https://crbug.com/webrtc/10962).
1083 verifier.TestMemberIsNonNegative<double>(audio_source.audio_level);
Henrik Boströmd2c336f2019-07-03 15:11:101084 verifier.TestMemberIsPositive<double>(audio_source.total_audio_energy);
1085 verifier.TestMemberIsPositive<double>(audio_source.total_samples_duration);
Artem Titov880fa812021-07-30 20:30:231086 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
Taylor Brandstetter64851c02021-06-24 20:32:501087 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
1088 // test run until available or is there a way to have it always be
1089 // defined? crbug.com/627816
1090 verifier.MarkMemberTested(audio_source.echo_return_loss, true);
1091 verifier.MarkMemberTested(audio_source.echo_return_loss_enhancement, true);
Henrik Boström646fda02019-05-22 13:49:421092 return verifier.ExpectAllMembersSuccessfullyTested();
1093 }
1094
1095 bool VerifyRTCVideoSourceStats(const RTCVideoSourceStats& video_source) {
Niels Möllerafb246b2022-04-20 12:26:501096 RTCStatsVerifier verifier(report_.get(), &video_source);
Henrik Boström646fda02019-05-22 13:49:421097 VerifyRTCMediaSourceStats(video_source, &verifier);
1098 // TODO(hbos): This integration test uses fakes that doesn't support
1099 // VideoTrackSourceInterface::Stats. When this is fixed we should
Artem Titov880fa812021-07-30 20:30:231100 // TestMemberIsNonNegative<uint32_t>() for `width` and `height` instead to
Henrik Boström646fda02019-05-22 13:49:421101 // reflect real code.
1102 verifier.TestMemberIsUndefined(video_source.width);
1103 verifier.TestMemberIsUndefined(video_source.height);
Di Wu668dbf62021-02-27 08:29:151104 verifier.TestMemberIsNonNegative<uint32_t>(video_source.frames);
Byoungchan Leeefe46b62021-11-10 02:23:561105 verifier.TestMemberIsNonNegative<double>(video_source.frames_per_second);
Henrik Boström646fda02019-05-22 13:49:421106 return verifier.ExpectAllMembersSuccessfullyTested();
1107 }
1108
Yves Gerey665174f2018-06-19 13:03:051109 bool VerifyRTCTransportStats(const RTCTransportStats& transport) {
Niels Möllerafb246b2022-04-20 12:26:501110 RTCStatsVerifier verifier(report_.get(), &transport);
hbos23351192017-01-02 14:52:191111 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
Artem Titovedacbd52020-07-06 14:06:371112 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_sent);
hbos23351192017-01-02 14:52:191113 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
Artem Titovedacbd52020-07-06 14:06:371114 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_received);
Yves Gerey665174f2018-06-19 13:03:051115 verifier.TestMemberIsOptionalIDReference(transport.rtcp_transport_stats_id,
1116 RTCTransportStats::kType);
hbos7064d592017-01-16 15:38:021117 verifier.TestMemberIsDefined(transport.dtls_state);
Yves Gerey665174f2018-06-19 13:03:051118 verifier.TestMemberIsIDReference(transport.selected_candidate_pair_id,
1119 RTCIceCandidatePairStats::kType);
1120 verifier.TestMemberIsIDReference(transport.local_certificate_id,
1121 RTCCertificateStats::kType);
1122 verifier.TestMemberIsIDReference(transport.remote_certificate_id,
1123 RTCCertificateStats::kType);
Harald Alvestrand5cb78072019-10-28 08:51:171124 verifier.TestMemberIsDefined(transport.tls_version);
1125 verifier.TestMemberIsDefined(transport.dtls_cipher);
Philipp Hancke69c1df22022-04-22 13:46:241126 verifier.TestMemberIsDefined(transport.dtls_role);
Harald Alvestrand5cb78072019-10-28 08:51:171127 verifier.TestMemberIsDefined(transport.srtp_cipher);
Jonas Oreland149dc722019-08-28 06:10:271128 verifier.TestMemberIsPositive<uint32_t>(
1129 transport.selected_candidate_pair_changes);
Philipp Hanckecc1b9b02022-05-04 16:58:261130 verifier.TestMemberIsDefined(transport.ice_role);
Philipp Hancke95b1a342022-05-05 05:53:541131 verifier.TestMemberIsDefined(transport.ice_local_username_fragment);
Philipp Hancke1f491572022-05-09 15:43:311132 verifier.TestMemberIsDefined(transport.ice_state);
hbosdb346a72016-11-29 09:57:011133 return verifier.ExpectAllMembersSuccessfullyTested();
1134 }
1135
1136 private:
1137 rtc::scoped_refptr<const RTCStatsReport> report_;
1138};
1139
Mirko Bonadei5eb43b42021-01-18 12:24:401140#ifdef WEBRTC_HAVE_SCTP
hbosdb346a72016-11-29 09:57:011141TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
1142 StartCall();
1143
1144 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
Eldar Rello9276e2c2020-06-10 14:53:391145 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 13:24:311146
Henrik Boströma0ff50c2020-05-05 13:54:461147#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 21:35:041148 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251149#endif
hbosdb346a72016-11-29 09:57:011150}
1151
1152TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
1153 StartCall();
1154
1155 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
Eldar Rello9276e2c2020-06-10 14:53:391156 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 13:24:311157
Henrik Boströma0ff50c2020-05-05 13:54:461158#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 21:35:041159 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251160#endif
hbosdb346a72016-11-29 09:57:011161}
1162
Henrik Boström1df1bf82018-03-20 12:24:201163// These tests exercise the integration of the stats selection algorithm inside
1164// of PeerConnection. See rtcstatstraveral_unittest.cc for more detailed stats
1165// traversal tests on particular stats graphs.
1166TEST_F(RTCStatsIntegrationTest, GetStatsWithSenderSelector) {
1167 StartCall();
1168 ASSERT_FALSE(caller_->pc()->GetSenders().empty());
1169 rtc::scoped_refptr<const RTCStatsReport> report =
1170 GetStatsFromCaller(caller_->pc()->GetSenders()[0]);
1171 std::vector<const char*> allowed_missing_stats = {
1172 // TODO(hbos): Include RTC[Audio/Video]ReceiverStats when implemented.
1173 // TODO(hbos): Include RTCRemoteOutboundRtpStreamStats when implemented.
1174 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 17:08:331175 RTCInboundRTPStreamStats::kType,
1176 RTCPeerConnectionStats::kType,
1177 RTCMediaStreamStats::kType,
1178 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 12:24:201179 };
Eldar Rello9276e2c2020-06-10 14:53:391180 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 12:24:201181 EXPECT_TRUE(report->size());
1182}
1183
1184TEST_F(RTCStatsIntegrationTest, GetStatsWithReceiverSelector) {
1185 StartCall();
1186
1187 ASSERT_FALSE(caller_->pc()->GetReceivers().empty());
1188 rtc::scoped_refptr<const RTCStatsReport> report =
1189 GetStatsFromCaller(caller_->pc()->GetReceivers()[0]);
1190 std::vector<const char*> allowed_missing_stats = {
1191 // TODO(hbos): Include RTC[Audio/Video]SenderStats when implemented.
1192 // TODO(hbos): Include RTCRemoteInboundRtpStreamStats when implemented.
1193 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 17:08:331194 RTCOutboundRTPStreamStats::kType,
1195 RTCPeerConnectionStats::kType,
1196 RTCMediaStreamStats::kType,
1197 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 12:24:201198 };
Eldar Rello9276e2c2020-06-10 14:53:391199 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 12:24:201200 EXPECT_TRUE(report->size());
1201}
1202
1203TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidSenderSelector) {
1204 StartCall();
1205
1206 ASSERT_FALSE(callee_->pc()->GetSenders().empty());
1207 // The selector is invalid for the caller because it belongs to the callee.
1208 auto invalid_selector = callee_->pc()->GetSenders()[0];
1209 rtc::scoped_refptr<const RTCStatsReport> report =
1210 GetStatsFromCaller(invalid_selector);
1211 EXPECT_FALSE(report->size());
1212}
1213
1214TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidReceiverSelector) {
1215 StartCall();
1216
1217 ASSERT_FALSE(callee_->pc()->GetReceivers().empty());
1218 // The selector is invalid for the caller because it belongs to the callee.
1219 auto invalid_selector = callee_->pc()->GetReceivers()[0];
1220 rtc::scoped_refptr<const RTCStatsReport> report =
1221 GetStatsFromCaller(invalid_selector);
1222 EXPECT_FALSE(report->size());
1223}
1224
Yves Gerey59cfd352018-11-26 15:22:201225// TODO(bugs.webrtc.org/10041) For now this is equivalent to the following
1226// test GetsStatsWhileClosingPeerConnection, because pc() is closed by
1227// PeerConnectionTestWrapper. See: bugs.webrtc.org/9847
Yves Gereyb5bb5132018-11-14 17:00:141228TEST_F(RTCStatsIntegrationTest,
Yves Gerey59cfd352018-11-26 15:22:201229 DISABLED_GetStatsWhileDestroyingPeerConnection) {
hbosb78306a2016-12-19 13:06:571230 StartCall();
1231
1232 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1233 RTCStatsObtainer::Create();
Niels Möllerafb246b2022-04-20 12:26:501234 caller_->pc()->GetStats(stats_obtainer.get());
hbosb78306a2016-12-19 13:06:571235 // This will destroy the peer connection.
1236 caller_ = nullptr;
1237 // Any pending stats requests should have completed in the act of destroying
1238 // the peer connection.
Steve Anton25cfeb92018-04-26 18:44:001239 ASSERT_TRUE(stats_obtainer->report());
Jianhui Daib1ba8532022-05-13 02:40:251240#if RTC_TRACE_EVENTS_ENABLED
Steve Anton25cfeb92018-04-26 18:44:001241 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1242 RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251243#endif
Steve Anton25cfeb92018-04-26 18:44:001244}
1245
1246TEST_F(RTCStatsIntegrationTest, GetsStatsWhileClosingPeerConnection) {
1247 StartCall();
1248
1249 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1250 RTCStatsObtainer::Create();
Niels Möllerafb246b2022-04-20 12:26:501251 caller_->pc()->GetStats(stats_obtainer.get());
Steve Anton25cfeb92018-04-26 18:44:001252 caller_->pc()->Close();
1253
1254 ASSERT_TRUE(stats_obtainer->report());
Jianhui Daib1ba8532022-05-13 02:40:251255#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 21:35:041256 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1257 RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251258#endif
hbosb78306a2016-12-19 13:06:571259}
Henrik Boströmb6199362018-03-12 09:27:551260
1261// GetStatsReferencedIds() is optimized to recognize what is or isn't a
1262// referenced ID based on dictionary type information and knowing what members
1263// are used as references, as opposed to iterating all members to find the ones
1264// with the "Id" or "Ids" suffix. As such, GetStatsReferencedIds() is tested as
1265// an integration test instead of a unit test in order to guard against adding
1266// new references and forgetting to update GetStatsReferencedIds().
1267TEST_F(RTCStatsIntegrationTest, GetStatsReferencedIds) {
1268 StartCall();
1269
1270 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1271 for (const RTCStats& stats : *report) {
1272 // Find all references by looking at all string members with the "Id" or
1273 // "Ids" suffix.
1274 std::set<const std::string*> expected_ids;
1275 for (const auto* member : stats.Members()) {
1276 if (!member->is_defined())
1277 continue;
1278 if (member->type() == RTCStatsMemberInterface::kString) {
Steve Anton68586e82018-12-14 01:41:251279 if (absl::EndsWith(member->name(), "Id")) {
Henrik Boströmb6199362018-03-12 09:27:551280 const auto& id = member->cast_to<const RTCStatsMember<std::string>>();
1281 expected_ids.insert(&(*id));
1282 }
1283 } else if (member->type() == RTCStatsMemberInterface::kSequenceString) {
Steve Anton68586e82018-12-14 01:41:251284 if (absl::EndsWith(member->name(), "Ids")) {
Henrik Boströmb6199362018-03-12 09:27:551285 const auto& ids =
1286 member->cast_to<const RTCStatsMember<std::vector<std::string>>>();
1287 for (const std::string& id : *ids)
1288 expected_ids.insert(&id);
1289 }
1290 }
1291 }
1292
1293 std::vector<const std::string*> neighbor_ids = GetStatsReferencedIds(stats);
1294 EXPECT_EQ(neighbor_ids.size(), expected_ids.size());
1295 for (const std::string* neighbor_id : neighbor_ids) {
Steve Anton64b626b2019-01-29 01:25:261296 EXPECT_THAT(expected_ids, Contains(neighbor_id));
Henrik Boströmb6199362018-03-12 09:27:551297 }
1298 for (const std::string* expected_id : expected_ids) {
Steve Anton64b626b2019-01-29 01:25:261299 EXPECT_THAT(neighbor_ids, Contains(expected_id));
Henrik Boströmb6199362018-03-12 09:27:551300 }
1301 }
1302}
Henrik Boström943ad972021-04-08 07:30:051303
1304TEST_F(RTCStatsIntegrationTest, GetStatsContainsNoDuplicateMembers) {
1305 StartCall();
1306
1307 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1308 for (const RTCStats& stats : *report) {
1309 std::set<std::string> member_names;
1310 for (const auto* member : stats.Members()) {
1311 EXPECT_TRUE(member_names.find(member->name()) == member_names.end())
1312 << member->name() << " is a duplicate!";
1313 member_names.insert(member->name());
1314 }
1315 }
1316}
Mirko Bonadei5eb43b42021-01-18 12:24:401317#endif // WEBRTC_HAVE_SCTP
hbosb78306a2016-12-19 13:06:571318
hbosdb346a72016-11-29 09:57:011319} // namespace
1320
1321} // namespace webrtc