blob: be9cd6fbc05756784d2a9a5efb652988674ba785 [file] [log] [blame]
hbosdb346a72016-11-29 01:57:01 -08001/*
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 16:47:49 +010011#include <stdint.h>
12#include <string.h>
Jonas Olssona4d87372019-07-05 19:08:33 +020013
Yves Gerey3e707812018-11-28 16:47:49 +010014#include <memory>
hbosdb346a72016-11-29 01:57:01 -080015#include <set>
Yves Gerey3e707812018-11-28 16:47:49 +010016#include <string>
hbosdb346a72016-11-29 01:57:01 -080017#include <vector>
18
Steve Anton64b626b2019-01-28 17:25:26 -080019#include "absl/algorithm/container.h"
Steve Anton68586e82018-12-13 17:41:25 -080020#include "absl/strings/match.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020021#include "api/audio_codecs/builtin_audio_decoder_factory.h"
22#include "api/audio_codecs/builtin_audio_encoder_factory.h"
Yves Gerey3e707812018-11-28 16:47:49 +010023#include "api/audio_options.h"
Steve Anton10542f22019-01-11 09:11:00 -080024#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 20:26:48 +010028#include "api/scoped_refptr.h"
Steve Anton10542f22019-01-11 09:11:00 -080029#include "api/stats/rtc_stats.h"
30#include "api/stats/rtc_stats_report.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020031#include "api/stats/rtcstats_objects.h"
Steve Anton10542f22019-01-11 09:11:00 -080032#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 06:47:31 +020035#include "rtc_base/checks.h"
36#include "rtc_base/event_tracer.h"
37#include "rtc_base/gunit.h"
Steve Anton10542f22019-01-11 09:11:00 -080038#include "rtc_base/ref_counted_object.h"
Yves Gerey3e707812018-11-28 16:47:49 +010039#include "rtc_base/thread.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020040#include "rtc_base/trace_event.h"
Steve Anton10542f22019-01-11 09:11:00 -080041#include "rtc_base/virtual_socket_server.h"
Steve Anton64b626b2019-01-28 17:25:26 -080042#include "test/gmock.h"
Yves Gerey3e707812018-11-28 16:47:49 +010043#include "test/gtest.h"
hbosdb346a72016-11-29 01:57:01 -080044
Steve Anton64b626b2019-01-28 17:25:26 -080045using ::testing::Contains;
46
hbosdb346a72016-11-29 01:57:01 -080047namespace webrtc {
48
49namespace {
50
51const int64_t kGetStatsTimeoutMs = 10000;
52
ehmaldonado80c829f2017-07-18 07:35:19 -070053const unsigned char* GetCategoryEnabledHandler(const char* name) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070054 if (strcmp("webrtc_stats", name) != 0) {
55 return reinterpret_cast<const unsigned char*>("");
56 }
57 return reinterpret_cast<const unsigned char*>(name);
ehmaldonado80c829f2017-07-18 07:35:19 -070058}
59
ehmaldonado8ab0fd82017-09-04 14:35:04 -070060class RTCStatsReportTraceListener {
61 public:
62 static void SetUp() {
63 if (!traced_report_)
64 traced_report_ = new RTCStatsReportTraceListener();
65 traced_report_->last_trace_ = "";
66 SetupEventTracer(&GetCategoryEnabledHandler,
67 &RTCStatsReportTraceListener::AddTraceEventHandler);
68 }
69
70 static const std::string& last_trace() {
71 RTC_DCHECK(traced_report_);
72 return traced_report_->last_trace_;
73 }
74
75 private:
Steve Anton36b29d12017-10-30 09:57:42 -070076 static void AddTraceEventHandler(
77 char phase,
78 const unsigned char* category_enabled,
79 const char* name,
80 unsigned long long id, // NOLINT(runtime/int)
81 int num_args,
82 const char** arg_names,
83 const unsigned char* arg_types,
84 const unsigned long long* arg_values, // NOLINT(runtime/int)
85 unsigned char flags) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070086 RTC_DCHECK(traced_report_);
87 EXPECT_STREQ("webrtc_stats",
88 reinterpret_cast<const char*>(category_enabled));
89 EXPECT_STREQ("webrtc_stats", name);
90 EXPECT_EQ(1, num_args);
91 EXPECT_STREQ("report", arg_names[0]);
92 EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
93
94 traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
95 }
96
97 static RTCStatsReportTraceListener* traced_report_;
98 std::string last_trace_;
99};
100
101RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
102 nullptr;
ehmaldonado80c829f2017-07-18 07:35:19 -0700103
Mirko Bonadei6a489f22019-04-09 15:11:12 +0200104class RTCStatsIntegrationTest : public ::testing::Test {
hbosdb346a72016-11-29 01:57:01 -0800105 public:
106 RTCStatsIntegrationTest()
tommie7251592017-07-14 14:44:46 -0700107 : network_thread_(new rtc::Thread(&virtual_socket_server_)),
108 worker_thread_(rtc::Thread::Create()) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700109 RTCStatsReportTraceListener::SetUp();
ehmaldonado80c829f2017-07-18 07:35:19 -0700110
tommie7251592017-07-14 14:44:46 -0700111 RTC_CHECK(network_thread_->Start());
112 RTC_CHECK(worker_thread_->Start());
hbosdb346a72016-11-29 01:57:01 -0800113
Tommi87f70902021-04-27 14:43:08 +0200114 caller_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700115 "caller", network_thread_.get(), worker_thread_.get());
Tommi87f70902021-04-27 14:43:08 +0200116 callee_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700117 "callee", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 01:57:01 -0800118 }
119
120 void StartCall() {
121 // Create PeerConnections and "connect" sigslots
122 PeerConnectionInterface::RTCConfiguration config;
Henrik Boström62995db2022-01-03 09:58:10 +0100123 config.sdp_semantics = SdpSemantics::kUnifiedPlan;
hbosdb346a72016-11-29 01:57:01 -0800124 PeerConnectionInterface::IceServer ice_server;
125 ice_server.uri = "stun:1.1.1.1:3478";
126 config.servers.push_back(ice_server);
Niels Möllerf06f9232018-08-07 12:32:18 +0200127 EXPECT_TRUE(caller_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 03:47:57 -0700128 CreateBuiltinAudioDecoderFactory()));
Niels Möllerf06f9232018-08-07 12:32:18 +0200129 EXPECT_TRUE(callee_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 03:47:57 -0700130 CreateBuiltinAudioDecoderFactory()));
hbosdb346a72016-11-29 01:57:01 -0800131 PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
132
133 // Get user media for audio and video
Niels Möller5c4ddad2019-02-12 12:30:58 +0100134 caller_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
135 callee_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
hbosdb346a72016-11-29 01:57:01 -0800136
137 // Create data channels
138 DataChannelInit init;
139 caller_->CreateDataChannel("data", init);
140 callee_->CreateDataChannel("data", init);
141
142 // Negotiate and wait for call to establish
Niels Möllerf06f9232018-08-07 12:32:18 +0200143 caller_->CreateOffer(PeerConnectionInterface::RTCOfferAnswerOptions());
hbosdb346a72016-11-29 01:57:01 -0800144 caller_->WaitForCallEstablished();
145 callee_->WaitForCallEstablished();
146 }
147
148 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
149 return GetStats(caller_->pc());
150 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100151 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
152 rtc::scoped_refptr<RtpSenderInterface> selector) {
153 return GetStats(caller_->pc(), selector);
154 }
155 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
156 rtc::scoped_refptr<RtpReceiverInterface> selector) {
157 return GetStats(caller_->pc(), selector);
158 }
hbosdb346a72016-11-29 01:57:01 -0800159
160 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
161 return GetStats(callee_->pc());
162 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100163 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
164 rtc::scoped_refptr<RtpSenderInterface> selector) {
165 return GetStats(callee_->pc(), selector);
166 }
167 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
168 rtc::scoped_refptr<RtpReceiverInterface> selector) {
169 return GetStats(callee_->pc(), selector);
170 }
hbosdb346a72016-11-29 01:57:01 -0800171
172 protected:
173 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
174 PeerConnectionInterface* pc) {
175 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
176 RTCStatsObtainer::Create();
177 pc->GetStats(stats_obtainer);
178 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
179 return stats_obtainer->report();
180 }
181
Henrik Boström1df1bf82018-03-20 13:24:20 +0100182 template <typename T>
183 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
184 PeerConnectionInterface* pc,
185 rtc::scoped_refptr<T> selector) {
186 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
187 RTCStatsObtainer::Create();
188 pc->GetStats(selector, stats_obtainer);
189 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
190 return stats_obtainer->report();
191 }
192
Artem Titov880fa812021-07-30 22:30:23 +0200193 // `network_thread_` uses `virtual_socket_server_` so they must be
deadbeef98e186c2017-05-16 18:00:06 -0700194 // constructed/destructed in the correct order.
hbosdb346a72016-11-29 01:57:01 -0800195 rtc::VirtualSocketServer virtual_socket_server_;
tommie7251592017-07-14 14:44:46 -0700196 std::unique_ptr<rtc::Thread> network_thread_;
197 std::unique_ptr<rtc::Thread> worker_thread_;
hbosdb346a72016-11-29 01:57:01 -0800198 rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
199 rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
200};
201
202class RTCStatsVerifier {
203 public:
204 RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
205 : report_(report), stats_(stats), all_tests_successful_(true) {
206 RTC_CHECK(report_);
207 RTC_CHECK(stats_);
208 for (const RTCStatsMemberInterface* member : stats_->Members()) {
209 untested_members_.insert(member);
210 }
211 }
212
Yves Gerey665174f2018-06-19 15:03:05 +0200213 void MarkMemberTested(const RTCStatsMemberInterface& member,
214 bool test_successful) {
hbosdb346a72016-11-29 01:57:01 -0800215 untested_members_.erase(&member);
216 all_tests_successful_ &= test_successful;
217 }
218
219 void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200220 EXPECT_TRUE(member.is_defined())
221 << stats_->type() << "." << member.name() << "[" << stats_->id()
222 << "] was undefined.";
hbosdb346a72016-11-29 01:57:01 -0800223 MarkMemberTested(member, member.is_defined());
224 }
225
226 void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200227 EXPECT_FALSE(member.is_defined())
228 << stats_->type() << "." << member.name() << "[" << stats_->id()
229 << "] was defined (" << member.ValueToString() << ").";
hbosdb346a72016-11-29 01:57:01 -0800230 MarkMemberTested(member, !member.is_defined());
231 }
232
Yves Gerey665174f2018-06-19 15:03:05 +0200233 template <typename T>
hbos23351192017-01-02 06:52:19 -0800234 void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200235 EXPECT_TRUE(member.is_defined())
236 << stats_->type() << "." << member.name() << "[" << stats_->id()
237 << "] was undefined.";
hbos23351192017-01-02 06:52:19 -0800238 if (!member.is_defined()) {
239 MarkMemberTested(member, false);
240 return;
241 }
242 bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
Yves Gerey665174f2018-06-19 15:03:05 +0200243 EXPECT_TRUE(is_positive)
244 << stats_->type() << "." << member.name() << "[" << stats_->id()
245 << "] was not positive (" << member.ValueToString() << ").";
hbos23351192017-01-02 06:52:19 -0800246 MarkMemberTested(member, is_positive);
247 }
248
Yves Gerey665174f2018-06-19 15:03:05 +0200249 template <typename T>
hbos23351192017-01-02 06:52:19 -0800250 void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200251 EXPECT_TRUE(member.is_defined())
252 << stats_->type() << "." << member.name() << "[" << stats_->id()
253 << "] was undefined.";
hbos23351192017-01-02 06:52:19 -0800254 if (!member.is_defined()) {
255 MarkMemberTested(member, false);
256 return;
257 }
258 bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
Yves Gerey665174f2018-06-19 15:03:05 +0200259 EXPECT_TRUE(is_non_negative)
260 << stats_->type() << "." << member.name() << "[" << stats_->id()
261 << "] was not non-negative (" << member.ValueToString() << ").";
hbos23351192017-01-02 06:52:19 -0800262 MarkMemberTested(member, is_non_negative);
263 }
264
Yves Gerey665174f2018-06-19 15:03:05 +0200265 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
266 const char* expected_type) {
hbosdb346a72016-11-29 01:57:01 -0800267 TestMemberIsIDReference(member, expected_type, false);
268 }
269
Yves Gerey665174f2018-06-19 15:03:05 +0200270 void TestMemberIsOptionalIDReference(const RTCStatsMemberInterface& member,
271 const char* expected_type) {
hbosdb346a72016-11-29 01:57:01 -0800272 TestMemberIsIDReference(member, expected_type, true);
273 }
274
275 bool ExpectAllMembersSuccessfullyTested() {
276 if (untested_members_.empty())
277 return all_tests_successful_;
278 for (const RTCStatsMemberInterface* member : untested_members_) {
Yves Gerey665174f2018-06-19 15:03:05 +0200279 EXPECT_TRUE(false) << stats_->type() << "." << member->name() << "["
280 << stats_->id() << "] was not tested.";
hbosdb346a72016-11-29 01:57:01 -0800281 }
282 return false;
283 }
284
285 private:
Yves Gerey665174f2018-06-19 15:03:05 +0200286 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
287 const char* expected_type,
288 bool optional) {
hbosdb346a72016-11-29 01:57:01 -0800289 if (optional && !member.is_defined()) {
290 MarkMemberTested(member, true);
291 return;
292 }
293 bool valid_reference = false;
294 if (member.is_defined()) {
295 if (member.type() == RTCStatsMemberInterface::kString) {
296 // A single ID.
297 const RTCStatsMember<std::string>& id =
298 member.cast_to<RTCStatsMember<std::string>>();
299 const RTCStats* referenced_stats = report_->Get(*id);
300 valid_reference =
301 referenced_stats && referenced_stats->type() == expected_type;
302 } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
303 // A vector of IDs.
304 valid_reference = true;
305 const RTCStatsMember<std::vector<std::string>>& ids =
306 member.cast_to<RTCStatsMember<std::vector<std::string>>>();
Mirko Bonadeic61ce0d2017-11-21 17:04:20 +0100307 for (const std::string& id : *ids) {
hbosdb346a72016-11-29 01:57:01 -0800308 const RTCStats* referenced_stats = report_->Get(id);
309 if (!referenced_stats || referenced_stats->type() != expected_type) {
310 valid_reference = false;
311 break;
312 }
313 }
314 }
315 }
Yves Gerey665174f2018-06-19 15:03:05 +0200316 EXPECT_TRUE(valid_reference)
317 << stats_->type() << "." << member.name()
318 << " is not a reference to an "
Jonas Olssonb2b20312020-01-14 12:11:31 +0100319 "existing dictionary of type "
320 << expected_type << " (value: "
Henrik Boström646fda02019-05-22 15:49:42 +0200321 << (member.is_defined() ? member.ValueToString() : "null") << ").";
hbosdb346a72016-11-29 01:57:01 -0800322 MarkMemberTested(member, valid_reference);
323 }
324
325 rtc::scoped_refptr<const RTCStatsReport> report_;
326 const RTCStats* stats_;
327 std::set<const RTCStatsMemberInterface*> untested_members_;
328 bool all_tests_successful_;
329};
330
331class RTCStatsReportVerifier {
332 public:
333 static std::set<const char*> StatsTypes() {
334 std::set<const char*> stats_types;
335 stats_types.insert(RTCCertificateStats::kType);
336 stats_types.insert(RTCCodecStats::kType);
337 stats_types.insert(RTCDataChannelStats::kType);
338 stats_types.insert(RTCIceCandidatePairStats::kType);
339 stats_types.insert(RTCLocalIceCandidateStats::kType);
340 stats_types.insert(RTCRemoteIceCandidateStats::kType);
341 stats_types.insert(RTCMediaStreamStats::kType);
342 stats_types.insert(RTCMediaStreamTrackStats::kType);
343 stats_types.insert(RTCPeerConnectionStats::kType);
344 stats_types.insert(RTCInboundRTPStreamStats::kType);
345 stats_types.insert(RTCOutboundRTPStreamStats::kType);
346 stats_types.insert(RTCTransportStats::kType);
347 return stats_types;
348 }
349
350 explicit RTCStatsReportVerifier(const RTCStatsReport* report)
Yves Gerey665174f2018-06-19 15:03:05 +0200351 : report_(report) {}
hbosdb346a72016-11-29 01:57:01 -0800352
Eldar Rello9276e2c2020-06-10 17:53:39 +0300353 void VerifyReport(std::vector<const char*> allowed_missing_stats) {
hbosdb346a72016-11-29 01:57:01 -0800354 std::set<const char*> missing_stats = StatsTypes();
355 bool verify_successful = true;
hbos338f78a2017-02-07 06:41:21 -0800356 std::vector<const RTCTransportStats*> transport_stats =
357 report_->GetStatsOfType<RTCTransportStats>();
Mirko Bonadeie12c1fe2018-07-03 12:53:23 +0200358 EXPECT_EQ(transport_stats.size(), 1U);
hbos338f78a2017-02-07 06:41:21 -0800359 std::string selected_candidate_pair_id =
360 *transport_stats[0]->selected_candidate_pair_id;
hbosdb346a72016-11-29 01:57:01 -0800361 for (const RTCStats& stats : *report_) {
362 missing_stats.erase(stats.type());
363 if (stats.type() == RTCCertificateStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200364 verify_successful &=
365 VerifyRTCCertificateStats(stats.cast_to<RTCCertificateStats>());
hbosdb346a72016-11-29 01:57:01 -0800366 } else if (stats.type() == RTCCodecStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200367 verify_successful &=
368 VerifyRTCCodecStats(stats.cast_to<RTCCodecStats>());
hbosdb346a72016-11-29 01:57:01 -0800369 } else if (stats.type() == RTCDataChannelStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200370 verify_successful &=
371 VerifyRTCDataChannelStats(stats.cast_to<RTCDataChannelStats>());
hbosdb346a72016-11-29 01:57:01 -0800372 } else if (stats.type() == RTCIceCandidatePairStats::kType) {
373 verify_successful &= VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 06:41:21 -0800374 stats.cast_to<RTCIceCandidatePairStats>(),
375 stats.id() == selected_candidate_pair_id);
hbosdb346a72016-11-29 01:57:01 -0800376 } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
377 verify_successful &= VerifyRTCLocalIceCandidateStats(
378 stats.cast_to<RTCLocalIceCandidateStats>());
379 } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
380 verify_successful &= VerifyRTCRemoteIceCandidateStats(
381 stats.cast_to<RTCRemoteIceCandidateStats>());
382 } else if (stats.type() == RTCMediaStreamStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200383 verify_successful &=
384 VerifyRTCMediaStreamStats(stats.cast_to<RTCMediaStreamStats>());
hbosdb346a72016-11-29 01:57:01 -0800385 } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
386 verify_successful &= VerifyRTCMediaStreamTrackStats(
387 stats.cast_to<RTCMediaStreamTrackStats>());
388 } else if (stats.type() == RTCPeerConnectionStats::kType) {
389 verify_successful &= VerifyRTCPeerConnectionStats(
390 stats.cast_to<RTCPeerConnectionStats>());
391 } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
392 verify_successful &= VerifyRTCInboundRTPStreamStats(
393 stats.cast_to<RTCInboundRTPStreamStats>());
394 } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
395 verify_successful &= VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 17:53:39 +0300396 stats.cast_to<RTCOutboundRTPStreamStats>());
Henrik Boström883eefc2019-05-27 13:40:25 +0200397 } else if (stats.type() == RTCRemoteInboundRtpStreamStats::kType) {
398 verify_successful &= VerifyRTCRemoteInboundRtpStreamStats(
399 stats.cast_to<RTCRemoteInboundRtpStreamStats>());
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100400 } else if (stats.type() == RTCRemoteOutboundRtpStreamStats::kType) {
401 verify_successful &= VerifyRTCRemoteOutboundRTPStreamStats(
402 stats.cast_to<RTCRemoteOutboundRtpStreamStats>());
Henrik Boström646fda02019-05-22 15:49:42 +0200403 } else if (stats.type() == RTCAudioSourceStats::kType) {
404 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
405 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 22:30:23 +0200406 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 15:49:42 +0200407 verify_successful &=
408 VerifyRTCAudioSourceStats(stats.cast_to<RTCAudioSourceStats>());
409 } else if (stats.type() == RTCVideoSourceStats::kType) {
410 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
411 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 22:30:23 +0200412 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 15:49:42 +0200413 verify_successful &=
414 VerifyRTCVideoSourceStats(stats.cast_to<RTCVideoSourceStats>());
hbosdb346a72016-11-29 01:57:01 -0800415 } else if (stats.type() == RTCTransportStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200416 verify_successful &=
417 VerifyRTCTransportStats(stats.cast_to<RTCTransportStats>());
hbosdb346a72016-11-29 01:57:01 -0800418 } else {
419 EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
420 verify_successful = false;
421 }
422 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100423 for (const char* missing : missing_stats) {
Steve Anton64b626b2019-01-28 17:25:26 -0800424 if (!absl::c_linear_search(allowed_missing_stats, missing)) {
Henrik Boström1df1bf82018-03-20 13:24:20 +0100425 verify_successful = false;
hbosdb346a72016-11-29 01:57:01 -0800426 EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
427 }
428 }
Yves Gerey665174f2018-06-19 15:03:05 +0200429 EXPECT_TRUE(verify_successful)
430 << "One or more problems with the stats. This is the report:\n"
431 << report_->ToJson();
hbosdb346a72016-11-29 01:57:01 -0800432 }
433
Yves Gerey665174f2018-06-19 15:03:05 +0200434 bool VerifyRTCCertificateStats(const RTCCertificateStats& certificate) {
hbosdb346a72016-11-29 01:57:01 -0800435 RTCStatsVerifier verifier(report_, &certificate);
436 verifier.TestMemberIsDefined(certificate.fingerprint);
437 verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
438 verifier.TestMemberIsDefined(certificate.base64_certificate);
Yves Gerey665174f2018-06-19 15:03:05 +0200439 verifier.TestMemberIsOptionalIDReference(certificate.issuer_certificate_id,
440 RTCCertificateStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800441 return verifier.ExpectAllMembersSuccessfullyTested();
442 }
443
Yves Gerey665174f2018-06-19 15:03:05 +0200444 bool VerifyRTCCodecStats(const RTCCodecStats& codec) {
hbosdb346a72016-11-29 01:57:01 -0800445 RTCStatsVerifier verifier(report_, &codec);
Philipp Hancke95157a02020-11-16 20:08:27 +0100446 verifier.TestMemberIsIDReference(codec.transport_id,
447 RTCTransportStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800448 verifier.TestMemberIsDefined(codec.payload_type);
hbos13f54b22017-02-28 06:56:04 -0800449 verifier.TestMemberIsDefined(codec.mime_type);
hbos23351192017-01-02 06:52:19 -0800450 verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
Johannes Kron72d69152020-02-10 14:05:55 +0100451
452 if (codec.mime_type->rfind("audio", 0) == 0)
453 verifier.TestMemberIsPositive<uint32_t>(codec.channels);
454 else
455 verifier.TestMemberIsUndefined(codec.channels);
456
457 // sdp_fmtp_line is an optional field.
458 verifier.MarkMemberTested(codec.sdp_fmtp_line, true);
hbosdb346a72016-11-29 01:57:01 -0800459 return verifier.ExpectAllMembersSuccessfullyTested();
460 }
461
Yves Gerey665174f2018-06-19 15:03:05 +0200462 bool VerifyRTCDataChannelStats(const RTCDataChannelStats& data_channel) {
hbosdb346a72016-11-29 01:57:01 -0800463 RTCStatsVerifier verifier(report_, &data_channel);
464 verifier.TestMemberIsDefined(data_channel.label);
465 verifier.TestMemberIsDefined(data_channel.protocol);
Harald Alvestrand10ef8472020-06-05 15:38:51 +0200466 verifier.TestMemberIsDefined(data_channel.data_channel_identifier);
hbosdb346a72016-11-29 01:57:01 -0800467 verifier.TestMemberIsDefined(data_channel.state);
hbos23351192017-01-02 06:52:19 -0800468 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
469 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
470 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
471 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
hbosdb346a72016-11-29 01:57:01 -0800472 return verifier.ExpectAllMembersSuccessfullyTested();
473 }
474
475 bool VerifyRTCIceCandidatePairStats(
Yves Gerey665174f2018-06-19 15:03:05 +0200476 const RTCIceCandidatePairStats& candidate_pair,
477 bool is_selected_pair) {
hbosdb346a72016-11-29 01:57:01 -0800478 RTCStatsVerifier verifier(report_, &candidate_pair);
Yves Gerey665174f2018-06-19 15:03:05 +0200479 verifier.TestMemberIsIDReference(candidate_pair.transport_id,
480 RTCTransportStats::kType);
481 verifier.TestMemberIsIDReference(candidate_pair.local_candidate_id,
482 RTCLocalIceCandidateStats::kType);
483 verifier.TestMemberIsIDReference(candidate_pair.remote_candidate_id,
484 RTCRemoteIceCandidateStats::kType);
hbos06495bc2017-01-02 08:08:18 -0800485 verifier.TestMemberIsDefined(candidate_pair.state);
486 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
hbos92eaec62017-02-27 01:38:08 -0800487 verifier.TestMemberIsDefined(candidate_pair.nominated);
hbosdb346a72016-11-29 01:57:01 -0800488 verifier.TestMemberIsDefined(candidate_pair.writable);
489 verifier.TestMemberIsUndefined(candidate_pair.readable);
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700490 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 06:52:19 -0800494 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700495 verifier.TestMemberIsNonNegative<uint64_t>(
496 candidate_pair.bytes_discarded_on_send);
hbos23351192017-01-02 06:52:19 -0800497 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
hbosbf8d3e52017-02-28 06:34:47 -0800498 verifier.TestMemberIsNonNegative<double>(
499 candidate_pair.total_round_trip_time);
hbos23351192017-01-02 06:52:19 -0800500 verifier.TestMemberIsNonNegative<double>(
501 candidate_pair.current_round_trip_time);
hbos338f78a2017-02-07 06:41:21 -0800502 if (is_selected_pair) {
503 verifier.TestMemberIsNonNegative<double>(
504 candidate_pair.available_outgoing_bitrate);
deadbeef86c40a12017-06-28 09:37:23 -0700505 // A pair should be nominated in order to be selected.
506 EXPECT_TRUE(*candidate_pair.nominated);
hbos338f78a2017-02-07 06:41:21 -0800507 } else {
508 verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
509 }
hbosdb346a72016-11-29 01:57:01 -0800510 verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
hbos23351192017-01-02 06:52:19 -0800511 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);
hbosdb346a72016-11-29 01:57:01 -0800517 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_received);
518 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_sent);
519 verifier.TestMemberIsUndefined(candidate_pair.consent_requests_received);
hbos23351192017-01-02 06:52:19 -0800520 verifier.TestMemberIsNonNegative<uint64_t>(
521 candidate_pair.consent_requests_sent);
hbosdb346a72016-11-29 01:57:01 -0800522 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_received);
523 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_sent);
524 return verifier.ExpectAllMembersSuccessfullyTested();
525 }
526
Yves Gerey665174f2018-06-19 15:03:05 +0200527 bool VerifyRTCIceCandidateStats(const RTCIceCandidateStats& candidate) {
hbosdb346a72016-11-29 01:57:01 -0800528 RTCStatsVerifier verifier(report_, &candidate);
Yves Gerey665174f2018-06-19 15:03:05 +0200529 verifier.TestMemberIsIDReference(candidate.transport_id,
530 RTCTransportStats::kType);
hbosc3a2b7f2017-01-02 04:46:15 -0800531 verifier.TestMemberIsDefined(candidate.is_remote);
Gary Liu37e489c2017-11-21 10:49:36 -0800532 if (*candidate.is_remote) {
533 verifier.TestMemberIsUndefined(candidate.network_type);
534 } else {
535 verifier.TestMemberIsDefined(candidate.network_type);
536 }
hbosdb346a72016-11-29 01:57:01 -0800537 verifier.TestMemberIsDefined(candidate.ip);
Philipp Hanckea9ba4502021-03-22 13:22:54 +0100538 verifier.TestMemberIsDefined(candidate.address);
hbos23351192017-01-02 06:52:19 -0800539 verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
hbosdb346a72016-11-29 01:57:01 -0800540 verifier.TestMemberIsDefined(candidate.protocol);
541 verifier.TestMemberIsDefined(candidate.candidate_type);
hbos23351192017-01-02 06:52:19 -0800542 verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
hbosdb346a72016-11-29 01:57:01 -0800543 verifier.TestMemberIsUndefined(candidate.url);
Philipp Hancke95513752018-09-27 14:40:08 +0200544 verifier.TestMemberIsUndefined(candidate.relay_protocol);
hbosdb346a72016-11-29 01:57:01 -0800545 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 15:03:05 +0200558 bool VerifyRTCMediaStreamStats(const RTCMediaStreamStats& media_stream) {
hbosdb346a72016-11-29 01:57:01 -0800559 RTCStatsVerifier verifier(report_, &media_stream);
560 verifier.TestMemberIsDefined(media_stream.stream_identifier);
Yves Gerey665174f2018-06-19 15:03:05 +0200561 verifier.TestMemberIsIDReference(media_stream.track_ids,
562 RTCMediaStreamTrackStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800563 return verifier.ExpectAllMembersSuccessfullyTested();
564 }
565
566 bool VerifyRTCMediaStreamTrackStats(
567 const RTCMediaStreamTrackStats& media_stream_track) {
568 RTCStatsVerifier verifier(report_, &media_stream_track);
569 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 02:53:23 -0800573 verifier.TestMemberIsDefined(media_stream_track.kind);
Guido Urdaneta67378412019-05-28 17:38:08 +0200574 RTC_DCHECK(media_stream_track.remote_source.is_defined());
hbosdb346a72016-11-29 01:57:01 -0800575 // Video or audio media stream track?
hbos160e4a72017-01-17 02:53:23 -0800576 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
Henrik Boström646fda02019-05-22 15:49:42 +0200577 // The type of the referenced media source depends on kind.
hbos42f6d2f2017-01-20 03:56:50 -0800578 if (*media_stream_track.remote_source) {
Guido Urdaneta67378412019-05-28 17:38:08 +0200579 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 06:14:25 -0800584 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100585 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800586 verifier.TestMemberIsNonNegative<uint32_t>(
587 media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800588 verifier.TestMemberIsNonNegative<uint32_t>(
589 media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800590 verifier.TestMemberIsNonNegative<uint32_t>(
591 media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 16:45:42 +0100592 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 03:56:50 -0800604 } else {
Guido Urdaneta67378412019-05-28 17:38:08 +0200605 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 06:14:25 -0800611 verifier.TestMemberIsNonNegative<uint32_t>(
612 media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100613 verifier.TestMemberIsNonNegative<uint32_t>(
614 media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800615 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800616 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800617 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 16:45:42 +0100618 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 03:56:50 -0800628 }
Guido Urdaneta67378412019-05-28 17:38:08 +0200629 // 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);
634 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
hbosdb346a72016-11-29 01:57:01 -0800635 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
636 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
637 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
638 // Audio-only members should be undefined
639 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
640 verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
641 verifier.TestMemberIsUndefined(
642 media_stream_track.echo_return_loss_enhancement);
zsteine76bd3a2017-07-14 12:17:49 -0700643 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
644 verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200645 verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
646 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 12:09:51 +0200647 verifier.TestMemberIsUndefined(
648 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 17:38:08 +0200649 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
Henrik Boström21e99da2019-08-21 12:09:51 +0200650 verifier.TestMemberIsUndefined(
651 media_stream_track.inserted_samples_for_deceleration);
652 verifier.TestMemberIsUndefined(
653 media_stream_track.removed_samples_for_acceleration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200654 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_flushes);
655 verifier.TestMemberIsUndefined(
656 media_stream_track.delayed_packet_outage_samples);
657 verifier.TestMemberIsUndefined(
658 media_stream_track.relative_packet_arrival_delay);
659 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
660 verifier.TestMemberIsUndefined(
661 media_stream_track.total_interruption_duration);
Artem Titove618cc92020-03-11 11:18:54 +0100662 verifier.TestMemberIsUndefined(
663 media_stream_track.jitter_buffer_target_delay);
hbosdb346a72016-11-29 01:57:01 -0800664 } else {
Yves Gerey665174f2018-06-19 15:03:05 +0200665 RTC_DCHECK_EQ(*media_stream_track.kind, RTCMediaStreamTrackKind::kAudio);
Henrik Boström646fda02019-05-22 15:49:42 +0200666 // The type of the referenced media source depends on kind.
Guido Urdaneta67378412019-05-28 17:38:08 +0200667 if (*media_stream_track.remote_source) {
Henrik Boström646fda02019-05-22 15:49:42 +0200668 // Remote tracks don't have media source stats.
669 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
Guido Urdaneta67378412019-05-28 17:38:08 +0200670 verifier.TestMemberIsNonNegative<double>(
671 media_stream_track.jitter_buffer_delay);
672 verifier.TestMemberIsNonNegative<uint64_t>(
673 media_stream_track.jitter_buffer_emitted_count);
Artem Titove618cc92020-03-11 11:18:54 +0100674 verifier.TestMemberIsNonNegative<double>(
675 media_stream_track.jitter_buffer_target_delay);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200676 verifier.TestMemberIsPositive<double>(media_stream_track.audio_level);
677 verifier.TestMemberIsPositive<double>(
678 media_stream_track.total_audio_energy);
679 verifier.TestMemberIsPositive<uint64_t>(
Guido Urdaneta67378412019-05-28 17:38:08 +0200680 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200681 verifier.TestMemberIsPositive<double>(
682 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200683 verifier.TestMemberIsNonNegative<uint64_t>(
684 media_stream_track.concealed_samples);
685 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boström21e99da2019-08-21 12:09:51 +0200686 media_stream_track.silent_concealed_samples);
687 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 17:38:08 +0200688 media_stream_track.concealment_events);
689 verifier.TestMemberIsNonNegative<uint64_t>(
690 media_stream_track.inserted_samples_for_deceleration);
691 verifier.TestMemberIsNonNegative<uint64_t>(
692 media_stream_track.removed_samples_for_acceleration);
693 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 17:38:08 +0200694 media_stream_track.jitter_buffer_flushes);
695 verifier.TestMemberIsNonNegative<uint64_t>(
696 media_stream_track.delayed_packet_outage_samples);
697 verifier.TestMemberIsNonNegative<double>(
698 media_stream_track.relative_packet_arrival_delay);
699 verifier.TestMemberIsNonNegative<uint32_t>(
700 media_stream_track.interruption_count);
701 verifier.TestMemberIsNonNegative<double>(
702 media_stream_track.total_interruption_duration);
703 } else {
704 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
705 RTCAudioSourceStats::kType);
706 // Local audio tracks have no jitter buffer.
707 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
708 verifier.TestMemberIsUndefined(
709 media_stream_track.jitter_buffer_emitted_count);
Artem Titove618cc92020-03-11 11:18:54 +0100710 verifier.TestMemberIsUndefined(
711 media_stream_track.jitter_buffer_target_delay);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200712 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
713 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
Guido Urdaneta67378412019-05-28 17:38:08 +0200714 verifier.TestMemberIsUndefined(
715 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200716 verifier.TestMemberIsUndefined(
717 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200718 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 12:09:51 +0200719 verifier.TestMemberIsUndefined(
720 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 17:38:08 +0200721 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
722 verifier.TestMemberIsUndefined(
Henrik Boström21e99da2019-08-21 12:09:51 +0200723 media_stream_track.inserted_samples_for_deceleration);
724 verifier.TestMemberIsUndefined(
725 media_stream_track.removed_samples_for_acceleration);
726 verifier.TestMemberIsUndefined(
Guido Urdaneta67378412019-05-28 17:38:08 +0200727 media_stream_track.jitter_buffer_flushes);
728 verifier.TestMemberIsUndefined(
729 media_stream_track.delayed_packet_outage_samples);
730 verifier.TestMemberIsUndefined(
731 media_stream_track.relative_packet_arrival_delay);
732 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
733 verifier.TestMemberIsUndefined(
734 media_stream_track.total_interruption_duration);
Henrik Boström646fda02019-05-22 15:49:42 +0200735 }
hbosdb346a72016-11-29 01:57:01 -0800736 // Video-only members should be undefined
737 verifier.TestMemberIsUndefined(media_stream_track.frame_width);
738 verifier.TestMemberIsUndefined(media_stream_track.frame_height);
739 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
740 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100741 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbosdb346a72016-11-29 01:57:01 -0800742 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
743 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
744 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
745 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
746 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
747 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
Sergey Silkin02371062019-01-31 16:45:42 +0100748 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
749 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
750 verifier.TestMemberIsUndefined(media_stream_track.total_freezes_duration);
751 verifier.TestMemberIsUndefined(media_stream_track.total_pauses_duration);
752 verifier.TestMemberIsUndefined(media_stream_track.total_frames_duration);
753 verifier.TestMemberIsUndefined(
754 media_stream_track.sum_squared_frame_durations);
hbosdb346a72016-11-29 01:57:01 -0800755 // Audio-only members
Artem Titov880fa812021-07-30 22:30:23 +0200756 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
hbos2d4d6532017-01-20 04:16:41 -0800757 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
758 // test run until available or is there a way to have it always be
759 // defined? crbug.com/627816
760 verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
Yves Gerey665174f2018-06-19 15:03:05 +0200761 verifier.MarkMemberTested(media_stream_track.echo_return_loss_enhancement,
762 true);
hbosdb346a72016-11-29 01:57:01 -0800763 }
764 return verifier.ExpectAllMembersSuccessfullyTested();
765 }
766
767 bool VerifyRTCPeerConnectionStats(
768 const RTCPeerConnectionStats& peer_connection) {
769 RTCStatsVerifier verifier(report_, &peer_connection);
hbos23351192017-01-02 06:52:19 -0800770 verifier.TestMemberIsNonNegative<uint32_t>(
771 peer_connection.data_channels_opened);
772 verifier.TestMemberIsNonNegative<uint32_t>(
773 peer_connection.data_channels_closed);
hbosdb346a72016-11-29 01:57:01 -0800774 return verifier.ExpectAllMembersSuccessfullyTested();
775 }
776
Yves Gerey665174f2018-06-19 15:03:05 +0200777 void VerifyRTCRTPStreamStats(const RTCRTPStreamStats& stream,
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100778 RTCStatsVerifier& verifier) {
779 verifier.TestMemberIsDefined(stream.ssrc);
780 verifier.TestMemberIsDefined(stream.kind);
Henrik Boström2f71b612021-03-23 15:18:55 +0100781 // Some legacy metrics are only defined for some of the RTP types in the
782 // hierarcy.
783 if (stream.type() == RTCInboundRTPStreamStats::kType ||
784 stream.type() == RTCOutboundRTPStreamStats::kType) {
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100785 verifier.TestMemberIsDefined(stream.media_type);
786 verifier.TestMemberIsIDReference(stream.track_id,
787 RTCMediaStreamTrackStats::kType);
Henrik Boström2f71b612021-03-23 15:18:55 +0100788 } else {
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100789 verifier.TestMemberIsUndefined(stream.media_type);
790 verifier.TestMemberIsUndefined(stream.track_id);
Henrik Boström2f71b612021-03-23 15:18:55 +0100791 }
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100792 verifier.TestMemberIsIDReference(stream.transport_id,
793 RTCTransportStats::kType);
794 verifier.TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
795 }
796
797 void VerifyRTCSentRTPStreamStats(const RTCSentRtpStreamStats& sent_stream,
798 RTCStatsVerifier& verifier) {
799 VerifyRTCRTPStreamStats(sent_stream, verifier);
800 verifier.TestMemberIsDefined(sent_stream.packets_sent);
801 verifier.TestMemberIsDefined(sent_stream.bytes_sent);
hbosdb346a72016-11-29 01:57:01 -0800802 }
803
804 bool VerifyRTCInboundRTPStreamStats(
805 const RTCInboundRTPStreamStats& inbound_stream) {
806 RTCStatsVerifier verifier(report_, &inbound_stream);
Minyue Li28a2c632021-07-07 15:53:38 +0200807 VerifyRTCReceivedRtpStreamStats(inbound_stream, verifier,
808 inbound_stream.media_type.is_defined() &&
809 *inbound_stream.media_type == "audio");
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100810 verifier.TestMemberIsOptionalIDReference(
811 inbound_stream.remote_id, RTCRemoteOutboundRtpStreamStats::kType);
sakal5fec1282017-02-20 06:43:58 -0800812 if (inbound_stream.media_type.is_defined() &&
813 *inbound_stream.media_type == "video") {
814 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 13:09:51 +0200815 verifier.TestMemberIsDefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 06:43:58 -0800816 } else {
hbosa51d4f32017-02-16 05:34:48 -0800817 verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 13:09:51 +0200818 verifier.TestMemberIsUndefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 06:43:58 -0800819 }
hbos23351192017-01-02 06:52:19 -0800820 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200821 if (inbound_stream.media_type.is_defined() &&
822 *inbound_stream.media_type == "audio") {
823 verifier.TestMemberIsNonNegative<uint64_t>(
824 inbound_stream.fec_packets_received);
825 verifier.TestMemberIsNonNegative<uint64_t>(
826 inbound_stream.fec_packets_discarded);
Henrik Boström4a5dab02020-01-28 11:15:35 +0100827 } else {
828 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_received);
829 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_discarded);
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200830 }
hbos23351192017-01-02 06:52:19 -0800831 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200832 verifier.TestMemberIsNonNegative<uint64_t>(
833 inbound_stream.header_bytes_received);
Henrik Boström01738c62019-04-15 17:32:00 +0200834 verifier.TestMemberIsDefined(inbound_stream.last_packet_received_timestamp);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300835 if (inbound_stream.frames_received.ValueOrDefault(0) > 0) {
836 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_width);
837 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_height);
838 } else {
839 verifier.TestMemberIsUndefined(inbound_stream.frame_width);
840 verifier.TestMemberIsUndefined(inbound_stream.frame_height);
841 }
842 if (inbound_stream.frames_per_second.is_defined()) {
843 verifier.TestMemberIsNonNegative<double>(
844 inbound_stream.frames_per_second);
845 } else {
846 verifier.TestMemberIsUndefined(inbound_stream.frames_per_second);
847 }
848 verifier.TestMemberIsUndefined(inbound_stream.frame_bit_depth);
Byoungchan Lee899b29e2021-06-29 22:09:18 +0900849 verifier.TestMemberIsNonNegative<double>(
850 inbound_stream.jitter_buffer_delay);
851 verifier.TestMemberIsNonNegative<uint64_t>(
852 inbound_stream.jitter_buffer_emitted_count);
hbosdb346a72016-11-29 01:57:01 -0800853 if (inbound_stream.media_type.is_defined() &&
854 *inbound_stream.media_type == "video") {
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300855 verifier.TestMemberIsUndefined(inbound_stream.total_samples_received);
856 verifier.TestMemberIsUndefined(inbound_stream.concealed_samples);
857 verifier.TestMemberIsUndefined(inbound_stream.silent_concealed_samples);
858 verifier.TestMemberIsUndefined(inbound_stream.concealment_events);
859 verifier.TestMemberIsUndefined(
860 inbound_stream.inserted_samples_for_deceleration);
861 verifier.TestMemberIsUndefined(
862 inbound_stream.removed_samples_for_acceleration);
863 verifier.TestMemberIsUndefined(inbound_stream.audio_level);
864 verifier.TestMemberIsUndefined(inbound_stream.total_audio_energy);
865 verifier.TestMemberIsUndefined(inbound_stream.total_samples_duration);
866 verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.frames_received);
Di Wufd1e9d12021-03-09 09:25:28 -0800867 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.fir_count);
868 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.pli_count);
869 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.nack_count);
hbosdb346a72016-11-29 01:57:01 -0800870 } else {
Di Wufd1e9d12021-03-09 09:25:28 -0800871 verifier.TestMemberIsUndefined(inbound_stream.fir_count);
872 verifier.TestMemberIsUndefined(inbound_stream.pli_count);
873 verifier.TestMemberIsUndefined(inbound_stream.nack_count);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300874 verifier.TestMemberIsPositive<uint64_t>(
875 inbound_stream.total_samples_received);
876 verifier.TestMemberIsNonNegative<uint64_t>(
877 inbound_stream.concealed_samples);
878 verifier.TestMemberIsNonNegative<uint64_t>(
879 inbound_stream.silent_concealed_samples);
880 verifier.TestMemberIsNonNegative<uint64_t>(
881 inbound_stream.concealment_events);
882 verifier.TestMemberIsNonNegative<uint64_t>(
883 inbound_stream.inserted_samples_for_deceleration);
884 verifier.TestMemberIsNonNegative<uint64_t>(
885 inbound_stream.removed_samples_for_acceleration);
886 verifier.TestMemberIsPositive<double>(inbound_stream.audio_level);
887 verifier.TestMemberIsPositive<double>(inbound_stream.total_audio_energy);
888 verifier.TestMemberIsPositive<double>(
889 inbound_stream.total_samples_duration);
890 verifier.TestMemberIsUndefined(inbound_stream.frames_received);
hbosdb346a72016-11-29 01:57:01 -0800891 }
hbosa7a9be12017-03-01 01:02:45 -0800892 verifier.TestMemberIsUndefined(inbound_stream.round_trip_time);
hbosdb346a72016-11-29 01:57:01 -0800893 verifier.TestMemberIsUndefined(inbound_stream.packets_repaired);
894 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_lost);
895 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_discarded);
896 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_count);
897 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_count);
898 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_rate);
899 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_rate);
900 verifier.TestMemberIsUndefined(inbound_stream.gap_loss_rate);
901 verifier.TestMemberIsUndefined(inbound_stream.gap_discard_rate);
Åsa Perssonfcf79cc2019-10-22 15:23:44 +0200902 // Test runtime too short to get an estimate (at least two RTCP sender
903 // reports need to be received).
904 verifier.MarkMemberTested(inbound_stream.estimated_playout_timestamp, true);
hbos6769c492017-01-02 08:35:13 -0800905 if (inbound_stream.media_type.is_defined() &&
906 *inbound_stream.media_type == "video") {
907 verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +0200908 verifier.TestMemberIsDefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300909 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 10:07:50 +0200910 verifier.TestMemberIsNonNegative<double>(
911 inbound_stream.total_decode_time);
Johannes Kron00376e12019-11-25 10:25:42 +0100912 verifier.TestMemberIsNonNegative<double>(
913 inbound_stream.total_inter_frame_delay);
914 verifier.TestMemberIsNonNegative<double>(
915 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 13:59:31 +0200916 // The integration test is not set up to test screen share; don't require
917 // this to be present.
918 verifier.MarkMemberTested(inbound_stream.content_type, true);
hbos6769c492017-01-02 08:35:13 -0800919 } else {
920 verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +0200921 verifier.TestMemberIsUndefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300922 verifier.TestMemberIsUndefined(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 10:07:50 +0200923 verifier.TestMemberIsUndefined(inbound_stream.total_decode_time);
Johannes Kron00376e12019-11-25 10:25:42 +0100924 verifier.TestMemberIsUndefined(inbound_stream.total_inter_frame_delay);
925 verifier.TestMemberIsUndefined(
926 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 13:59:31 +0200927 verifier.TestMemberIsUndefined(inbound_stream.content_type);
hbos6769c492017-01-02 08:35:13 -0800928 }
hbosdb346a72016-11-29 01:57:01 -0800929 return verifier.ExpectAllMembersSuccessfullyTested();
930 }
931
932 bool VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 17:53:39 +0300933 const RTCOutboundRTPStreamStats& outbound_stream) {
hbosdb346a72016-11-29 01:57:01 -0800934 RTCStatsVerifier verifier(report_, &outbound_stream);
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100935 VerifyRTCRTPStreamStats(outbound_stream, verifier);
hbos6769c492017-01-02 08:35:13 -0800936 if (outbound_stream.media_type.is_defined() &&
937 *outbound_stream.media_type == "video") {
Henrik Boström646fda02019-05-22 15:49:42 +0200938 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
939 RTCVideoSourceStats::kType);
Di Wufd1e9d12021-03-09 09:25:28 -0800940 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.fir_count);
941 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.pli_count);
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200942 if (*outbound_stream.frames_encoded > 0) {
943 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
944 } else {
945 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
946 }
hbos6769c492017-01-02 08:35:13 -0800947 } else {
Di Wufd1e9d12021-03-09 09:25:28 -0800948 verifier.TestMemberIsUndefined(outbound_stream.fir_count);
949 verifier.TestMemberIsUndefined(outbound_stream.pli_count);
Henrik Boström646fda02019-05-22 15:49:42 +0200950 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
951 RTCAudioSourceStats::kType);
hbos6769c492017-01-02 08:35:13 -0800952 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
953 }
Jakob Ivarssone91c9922021-07-06 09:55:43 +0200954 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.nack_count);
Henrik Boström4f40fa52019-12-19 13:27:27 +0100955 verifier.TestMemberIsOptionalIDReference(
956 outbound_stream.remote_id, RTCRemoteInboundRtpStreamStats::kType);
hbos23351192017-01-02 06:52:19 -0800957 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200958 verifier.TestMemberIsNonNegative<uint64_t>(
959 outbound_stream.retransmitted_packets_sent);
hbos23351192017-01-02 06:52:19 -0800960 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200961 verifier.TestMemberIsNonNegative<uint64_t>(
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200962 outbound_stream.header_bytes_sent);
963 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200964 outbound_stream.retransmitted_bytes_sent);
hbos6769c492017-01-02 08:35:13 -0800965 if (outbound_stream.media_type.is_defined() &&
966 *outbound_stream.media_type == "video") {
967 verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +0200968 verifier.TestMemberIsDefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 16:14:23 +0200969 verifier.TestMemberIsNonNegative<double>(
970 outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 15:15:38 +0200971 verifier.TestMemberIsNonNegative<uint64_t>(
972 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 18:38:20 +0200973 verifier.TestMemberIsNonNegative<double>(
974 outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200975 verifier.TestMemberIsDefined(outbound_stream.quality_limitation_reason);
Byoungchan Lee7d235352021-05-28 21:32:04 +0900976 verifier.TestMemberIsDefined(
977 outbound_stream.quality_limitation_durations);
Evan Shrubsolecc62b162019-09-09 11:26:45 +0200978 verifier.TestMemberIsNonNegative<uint32_t>(
979 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 13:59:31 +0200980 // The integration test is not set up to test screen share; don't require
981 // this to be present.
982 verifier.MarkMemberTested(outbound_stream.content_type, true);
Henrik Boström6b430862019-08-16 13:09:51 +0200983 verifier.TestMemberIsDefined(outbound_stream.encoder_implementation);
Eldar Rello9276e2c2020-06-10 17:53:39 +0300984 // Unless an implementation-specific amount of time has passed and at
985 // least one frame has been encoded, undefined is reported. Because it
986 // is hard to tell what is the case here, we treat FPS as optional.
987 // TODO(hbos): Update the tests to run until all implemented metrics
988 // should be populated.
989 if (outbound_stream.frames_per_second.is_defined()) {
990 verifier.TestMemberIsNonNegative<double>(
991 outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200992 } else {
993 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200994 }
Eldar Rello9276e2c2020-06-10 17:53:39 +0300995 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_height);
996 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_width);
997 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frames_sent);
998 verifier.TestMemberIsNonNegative<uint32_t>(
999 outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 13:43:49 +01001000 verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
Eldar Rello9276e2c2020-06-10 17:53:39 +03001001 verifier.MarkMemberTested(outbound_stream.rid, true);
hbos6769c492017-01-02 08:35:13 -08001002 } else {
1003 verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +02001004 verifier.TestMemberIsUndefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 16:14:23 +02001005 verifier.TestMemberIsUndefined(outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 15:15:38 +02001006 verifier.TestMemberIsUndefined(
1007 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 18:38:20 +02001008 // TODO(https://crbug.com/webrtc/10635): Implement for audio as well.
1009 verifier.TestMemberIsUndefined(outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 17:42:38 +02001010 verifier.TestMemberIsUndefined(outbound_stream.quality_limitation_reason);
Evan Shrubsolecc62b162019-09-09 11:26:45 +02001011 verifier.TestMemberIsUndefined(
Byoungchan Lee7d235352021-05-28 21:32:04 +09001012 outbound_stream.quality_limitation_durations);
1013 verifier.TestMemberIsUndefined(
Evan Shrubsolecc62b162019-09-09 11:26:45 +02001014 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 13:59:31 +02001015 verifier.TestMemberIsUndefined(outbound_stream.content_type);
Henrik Boström6b430862019-08-16 13:09:51 +02001016 // TODO(hbos): Implement for audio as well.
1017 verifier.TestMemberIsUndefined(outbound_stream.encoder_implementation);
Henrik Boströma0ff50c2020-05-05 15:54:46 +02001018 verifier.TestMemberIsUndefined(outbound_stream.rid);
1019 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
1020 verifier.TestMemberIsUndefined(outbound_stream.frame_height);
1021 verifier.TestMemberIsUndefined(outbound_stream.frame_width);
1022 verifier.TestMemberIsUndefined(outbound_stream.frames_sent);
1023 verifier.TestMemberIsUndefined(outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 13:43:49 +01001024 verifier.TestMemberIsNonNegative<double>(outbound_stream.target_bitrate);
hbos6769c492017-01-02 08:35:13 -08001025 }
hbosdb346a72016-11-29 01:57:01 -08001026 return verifier.ExpectAllMembersSuccessfullyTested();
1027 }
1028
Henrik Boström2f71b612021-03-23 15:18:55 +01001029 void VerifyRTCReceivedRtpStreamStats(
1030 const RTCReceivedRtpStreamStats& received_rtp,
Minyue Li28a2c632021-07-07 15:53:38 +02001031 RTCStatsVerifier& verifier,
1032 bool packets_discarded_defined) {
Henrik Boström2f71b612021-03-23 15:18:55 +01001033 VerifyRTCRTPStreamStats(received_rtp, verifier);
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +01001034 verifier.TestMemberIsNonNegative<double>(received_rtp.jitter);
1035 verifier.TestMemberIsDefined(received_rtp.packets_lost);
Minyue Li28a2c632021-07-07 15:53:38 +02001036 if (packets_discarded_defined) {
1037 verifier.TestMemberIsNonNegative<uint64_t>(
1038 received_rtp.packets_discarded);
1039 } else {
1040 verifier.TestMemberIsUndefined(received_rtp.packets_discarded);
1041 }
Henrik Boström2f71b612021-03-23 15:18:55 +01001042 }
1043
Henrik Boström883eefc2019-05-27 13:40:25 +02001044 bool VerifyRTCRemoteInboundRtpStreamStats(
1045 const RTCRemoteInboundRtpStreamStats& remote_inbound_stream) {
1046 RTCStatsVerifier verifier(report_, &remote_inbound_stream);
Minyue Li28a2c632021-07-07 15:53:38 +02001047 VerifyRTCReceivedRtpStreamStats(remote_inbound_stream, verifier, false);
Di Wu86f04ad2021-02-28 23:36:03 -08001048 verifier.TestMemberIsDefined(remote_inbound_stream.fraction_lost);
Henrik Boström883eefc2019-05-27 13:40:25 +02001049 verifier.TestMemberIsIDReference(remote_inbound_stream.local_id,
1050 RTCOutboundRTPStreamStats::kType);
1051 verifier.TestMemberIsNonNegative<double>(
1052 remote_inbound_stream.round_trip_time);
Di Wu88a51b22021-03-01 11:22:06 -08001053 verifier.TestMemberIsNonNegative<double>(
1054 remote_inbound_stream.total_round_trip_time);
1055 verifier.TestMemberIsNonNegative<int32_t>(
1056 remote_inbound_stream.round_trip_time_measurements);
Henrik Boström883eefc2019-05-27 13:40:25 +02001057 return verifier.ExpectAllMembersSuccessfullyTested();
1058 }
1059
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +01001060 bool VerifyRTCRemoteOutboundRTPStreamStats(
1061 const RTCRemoteOutboundRtpStreamStats& remote_outbound_stream) {
1062 RTCStatsVerifier verifier(report_, &remote_outbound_stream);
1063 VerifyRTCRTPStreamStats(remote_outbound_stream, verifier);
1064 VerifyRTCSentRTPStreamStats(remote_outbound_stream, verifier);
1065 verifier.TestMemberIsIDReference(remote_outbound_stream.local_id,
1066 RTCOutboundRTPStreamStats::kType);
1067 verifier.TestMemberIsNonNegative<double>(
1068 remote_outbound_stream.remote_timestamp);
1069 verifier.TestMemberIsDefined(remote_outbound_stream.reports_sent);
1070 return verifier.ExpectAllMembersSuccessfullyTested();
1071 }
1072
Henrik Boström646fda02019-05-22 15:49:42 +02001073 void VerifyRTCMediaSourceStats(const RTCMediaSourceStats& media_source,
1074 RTCStatsVerifier* verifier) {
1075 verifier->TestMemberIsDefined(media_source.track_identifier);
1076 verifier->TestMemberIsDefined(media_source.kind);
1077 if (media_source.kind.is_defined()) {
1078 EXPECT_TRUE((*media_source.kind == "audio" &&
1079 media_source.type() == RTCAudioSourceStats::kType) ||
1080 (*media_source.kind == "video" &&
1081 media_source.type() == RTCVideoSourceStats::kType));
1082 }
1083 }
1084
1085 bool VerifyRTCAudioSourceStats(const RTCAudioSourceStats& audio_source) {
1086 RTCStatsVerifier verifier(report_, &audio_source);
1087 VerifyRTCMediaSourceStats(audio_source, &verifier);
Henrik Boström262bbae2019-09-13 11:34:55 +02001088 // Audio level, unlike audio energy, only gets updated at a certain
1089 // frequency, so we don't require that one to be positive to avoid a race
1090 // (https://crbug.com/webrtc/10962).
1091 verifier.TestMemberIsNonNegative<double>(audio_source.audio_level);
Henrik Boströmd2c336f2019-07-03 17:11:10 +02001092 verifier.TestMemberIsPositive<double>(audio_source.total_audio_energy);
1093 verifier.TestMemberIsPositive<double>(audio_source.total_samples_duration);
Artem Titov880fa812021-07-30 22:30:23 +02001094 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
Taylor Brandstetter64851c02021-06-24 13:32:50 -07001095 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
1096 // test run until available or is there a way to have it always be
1097 // defined? crbug.com/627816
1098 verifier.MarkMemberTested(audio_source.echo_return_loss, true);
1099 verifier.MarkMemberTested(audio_source.echo_return_loss_enhancement, true);
Henrik Boström646fda02019-05-22 15:49:42 +02001100 return verifier.ExpectAllMembersSuccessfullyTested();
1101 }
1102
1103 bool VerifyRTCVideoSourceStats(const RTCVideoSourceStats& video_source) {
1104 RTCStatsVerifier verifier(report_, &video_source);
1105 VerifyRTCMediaSourceStats(video_source, &verifier);
1106 // TODO(hbos): This integration test uses fakes that doesn't support
1107 // VideoTrackSourceInterface::Stats. When this is fixed we should
Artem Titov880fa812021-07-30 22:30:23 +02001108 // TestMemberIsNonNegative<uint32_t>() for `width` and `height` instead to
Henrik Boström646fda02019-05-22 15:49:42 +02001109 // reflect real code.
1110 verifier.TestMemberIsUndefined(video_source.width);
1111 verifier.TestMemberIsUndefined(video_source.height);
Di Wu668dbf62021-02-27 00:29:15 -08001112 verifier.TestMemberIsNonNegative<uint32_t>(video_source.frames);
Byoungchan Leeefe46b62021-11-10 11:23:56 +09001113 verifier.TestMemberIsNonNegative<double>(video_source.frames_per_second);
Henrik Boström646fda02019-05-22 15:49:42 +02001114 return verifier.ExpectAllMembersSuccessfullyTested();
1115 }
1116
Yves Gerey665174f2018-06-19 15:03:05 +02001117 bool VerifyRTCTransportStats(const RTCTransportStats& transport) {
hbosdb346a72016-11-29 01:57:01 -08001118 RTCStatsVerifier verifier(report_, &transport);
hbos23351192017-01-02 06:52:19 -08001119 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
Artem Titovedacbd52020-07-06 16:06:37 +02001120 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_sent);
hbos23351192017-01-02 06:52:19 -08001121 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
Artem Titovedacbd52020-07-06 16:06:37 +02001122 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_received);
Yves Gerey665174f2018-06-19 15:03:05 +02001123 verifier.TestMemberIsOptionalIDReference(transport.rtcp_transport_stats_id,
1124 RTCTransportStats::kType);
hbos7064d592017-01-16 07:38:02 -08001125 verifier.TestMemberIsDefined(transport.dtls_state);
Yves Gerey665174f2018-06-19 15:03:05 +02001126 verifier.TestMemberIsIDReference(transport.selected_candidate_pair_id,
1127 RTCIceCandidatePairStats::kType);
1128 verifier.TestMemberIsIDReference(transport.local_certificate_id,
1129 RTCCertificateStats::kType);
1130 verifier.TestMemberIsIDReference(transport.remote_certificate_id,
1131 RTCCertificateStats::kType);
Harald Alvestrand5cb78072019-10-28 09:51:17 +01001132 verifier.TestMemberIsDefined(transport.tls_version);
1133 verifier.TestMemberIsDefined(transport.dtls_cipher);
1134 verifier.TestMemberIsDefined(transport.srtp_cipher);
Jonas Oreland149dc722019-08-28 08:10:27 +02001135 verifier.TestMemberIsPositive<uint32_t>(
1136 transport.selected_candidate_pair_changes);
hbosdb346a72016-11-29 01:57:01 -08001137 return verifier.ExpectAllMembersSuccessfullyTested();
1138 }
1139
1140 private:
1141 rtc::scoped_refptr<const RTCStatsReport> report_;
1142};
1143
Mirko Bonadei5eb43b42021-01-18 13:24:40 +01001144#ifdef WEBRTC_HAVE_SCTP
hbosdb346a72016-11-29 01:57:01 -08001145TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
1146 StartCall();
1147
1148 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
Eldar Rello9276e2c2020-06-10 17:53:39 +03001149 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001150
Henrik Boströma0ff50c2020-05-05 15:54:46 +02001151#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001152 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001153 #endif
hbosdb346a72016-11-29 01:57:01 -08001154}
1155
1156TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
1157 StartCall();
1158
1159 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
Eldar Rello9276e2c2020-06-10 17:53:39 +03001160 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001161
Henrik Boströma0ff50c2020-05-05 15:54:46 +02001162#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001163 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001164 #endif
hbosdb346a72016-11-29 01:57:01 -08001165}
1166
Henrik Boström1df1bf82018-03-20 13:24:20 +01001167// These tests exercise the integration of the stats selection algorithm inside
1168// of PeerConnection. See rtcstatstraveral_unittest.cc for more detailed stats
1169// traversal tests on particular stats graphs.
1170TEST_F(RTCStatsIntegrationTest, GetStatsWithSenderSelector) {
1171 StartCall();
1172 ASSERT_FALSE(caller_->pc()->GetSenders().empty());
1173 rtc::scoped_refptr<const RTCStatsReport> report =
1174 GetStatsFromCaller(caller_->pc()->GetSenders()[0]);
1175 std::vector<const char*> allowed_missing_stats = {
1176 // TODO(hbos): Include RTC[Audio/Video]ReceiverStats when implemented.
1177 // TODO(hbos): Include RTCRemoteOutboundRtpStreamStats when implemented.
1178 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 19:08:33 +02001179 RTCInboundRTPStreamStats::kType,
1180 RTCPeerConnectionStats::kType,
1181 RTCMediaStreamStats::kType,
1182 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 13:24:20 +01001183 };
Eldar Rello9276e2c2020-06-10 17:53:39 +03001184 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 13:24:20 +01001185 EXPECT_TRUE(report->size());
1186}
1187
1188TEST_F(RTCStatsIntegrationTest, GetStatsWithReceiverSelector) {
1189 StartCall();
1190
1191 ASSERT_FALSE(caller_->pc()->GetReceivers().empty());
1192 rtc::scoped_refptr<const RTCStatsReport> report =
1193 GetStatsFromCaller(caller_->pc()->GetReceivers()[0]);
1194 std::vector<const char*> allowed_missing_stats = {
1195 // TODO(hbos): Include RTC[Audio/Video]SenderStats when implemented.
1196 // TODO(hbos): Include RTCRemoteInboundRtpStreamStats when implemented.
1197 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 19:08:33 +02001198 RTCOutboundRTPStreamStats::kType,
1199 RTCPeerConnectionStats::kType,
1200 RTCMediaStreamStats::kType,
1201 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 13:24:20 +01001202 };
Eldar Rello9276e2c2020-06-10 17:53:39 +03001203 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 13:24:20 +01001204 EXPECT_TRUE(report->size());
1205}
1206
1207TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidSenderSelector) {
1208 StartCall();
1209
1210 ASSERT_FALSE(callee_->pc()->GetSenders().empty());
1211 // The selector is invalid for the caller because it belongs to the callee.
1212 auto invalid_selector = callee_->pc()->GetSenders()[0];
1213 rtc::scoped_refptr<const RTCStatsReport> report =
1214 GetStatsFromCaller(invalid_selector);
1215 EXPECT_FALSE(report->size());
1216}
1217
1218TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidReceiverSelector) {
1219 StartCall();
1220
1221 ASSERT_FALSE(callee_->pc()->GetReceivers().empty());
1222 // The selector is invalid for the caller because it belongs to the callee.
1223 auto invalid_selector = callee_->pc()->GetReceivers()[0];
1224 rtc::scoped_refptr<const RTCStatsReport> report =
1225 GetStatsFromCaller(invalid_selector);
1226 EXPECT_FALSE(report->size());
1227}
1228
Yves Gerey59cfd352018-11-26 16:22:20 +01001229// TODO(bugs.webrtc.org/10041) For now this is equivalent to the following
1230// test GetsStatsWhileClosingPeerConnection, because pc() is closed by
1231// PeerConnectionTestWrapper. See: bugs.webrtc.org/9847
Yves Gereyb5bb5132018-11-14 18:00:14 +01001232TEST_F(RTCStatsIntegrationTest,
Yves Gerey59cfd352018-11-26 16:22:20 +01001233 DISABLED_GetStatsWhileDestroyingPeerConnection) {
hbosb78306a2016-12-19 05:06:57 -08001234 StartCall();
1235
1236 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1237 RTCStatsObtainer::Create();
1238 caller_->pc()->GetStats(stats_obtainer);
1239 // This will destroy the peer connection.
1240 caller_ = nullptr;
1241 // Any pending stats requests should have completed in the act of destroying
1242 // the peer connection.
Steve Anton25cfeb92018-04-26 11:44:00 -07001243 ASSERT_TRUE(stats_obtainer->report());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001244 #if RTC_TRACE_EVENTS_ENABLED
Steve Anton25cfeb92018-04-26 11:44:00 -07001245 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1246 RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001247 #endif
Steve Anton25cfeb92018-04-26 11:44:00 -07001248}
1249
1250TEST_F(RTCStatsIntegrationTest, GetsStatsWhileClosingPeerConnection) {
1251 StartCall();
1252
1253 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1254 RTCStatsObtainer::Create();
1255 caller_->pc()->GetStats(stats_obtainer);
1256 caller_->pc()->Close();
1257
1258 ASSERT_TRUE(stats_obtainer->report());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001259 #if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001260 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1261 RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001262 #endif
hbosb78306a2016-12-19 05:06:57 -08001263}
Henrik Boströmb6199362018-03-12 10:27:55 +01001264
1265// GetStatsReferencedIds() is optimized to recognize what is or isn't a
1266// referenced ID based on dictionary type information and knowing what members
1267// are used as references, as opposed to iterating all members to find the ones
1268// with the "Id" or "Ids" suffix. As such, GetStatsReferencedIds() is tested as
1269// an integration test instead of a unit test in order to guard against adding
1270// new references and forgetting to update GetStatsReferencedIds().
1271TEST_F(RTCStatsIntegrationTest, GetStatsReferencedIds) {
1272 StartCall();
1273
1274 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1275 for (const RTCStats& stats : *report) {
1276 // Find all references by looking at all string members with the "Id" or
1277 // "Ids" suffix.
1278 std::set<const std::string*> expected_ids;
1279 for (const auto* member : stats.Members()) {
1280 if (!member->is_defined())
1281 continue;
1282 if (member->type() == RTCStatsMemberInterface::kString) {
Steve Anton68586e82018-12-13 17:41:25 -08001283 if (absl::EndsWith(member->name(), "Id")) {
Henrik Boströmb6199362018-03-12 10:27:55 +01001284 const auto& id = member->cast_to<const RTCStatsMember<std::string>>();
1285 expected_ids.insert(&(*id));
1286 }
1287 } else if (member->type() == RTCStatsMemberInterface::kSequenceString) {
Steve Anton68586e82018-12-13 17:41:25 -08001288 if (absl::EndsWith(member->name(), "Ids")) {
Henrik Boströmb6199362018-03-12 10:27:55 +01001289 const auto& ids =
1290 member->cast_to<const RTCStatsMember<std::vector<std::string>>>();
1291 for (const std::string& id : *ids)
1292 expected_ids.insert(&id);
1293 }
1294 }
1295 }
1296
1297 std::vector<const std::string*> neighbor_ids = GetStatsReferencedIds(stats);
1298 EXPECT_EQ(neighbor_ids.size(), expected_ids.size());
1299 for (const std::string* neighbor_id : neighbor_ids) {
Steve Anton64b626b2019-01-28 17:25:26 -08001300 EXPECT_THAT(expected_ids, Contains(neighbor_id));
Henrik Boströmb6199362018-03-12 10:27:55 +01001301 }
1302 for (const std::string* expected_id : expected_ids) {
Steve Anton64b626b2019-01-28 17:25:26 -08001303 EXPECT_THAT(neighbor_ids, Contains(expected_id));
Henrik Boströmb6199362018-03-12 10:27:55 +01001304 }
1305 }
1306}
Henrik Boström943ad972021-04-08 09:30:05 +02001307
1308TEST_F(RTCStatsIntegrationTest, GetStatsContainsNoDuplicateMembers) {
1309 StartCall();
1310
1311 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1312 for (const RTCStats& stats : *report) {
1313 std::set<std::string> member_names;
1314 for (const auto* member : stats.Members()) {
1315 EXPECT_TRUE(member_names.find(member->name()) == member_names.end())
1316 << member->name() << " is a duplicate!";
1317 member_names.insert(member->name());
1318 }
1319 }
1320}
Mirko Bonadei5eb43b42021-01-18 13:24:40 +01001321#endif // WEBRTC_HAVE_SCTP
hbosb78306a2016-12-19 05:06:57 -08001322
hbosdb346a72016-11-29 01:57:01 -08001323} // namespace
1324
1325} // namespace webrtc