WebRTC-DeprecateGlobalFieldTrialString/Enabled/ - part 1
This cl/
1) move WebRtcKeyValueConfig from api/transport to api/ directory.
2) add a test/ScopedKeyValueConfig (compare ScopedFieldTrials).
3) removes usage of webrtc::field_trial:: from the pc/ directory.
4) removes a few unused includes of system_wrappers/field_trial.h.
Bug: webrtc:10335
Change-Id: If29c07900dbe791050b0a5ad05332bedfad035f2
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/253903
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org>
Commit-Queue: Jonas Oreland <jonaso@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#36160}
diff --git a/test/BUILD.gn b/test/BUILD.gn
index f49dbd4..82d909d 100644
--- a/test/BUILD.gn
+++ b/test/BUILD.gn
@@ -214,7 +214,6 @@
rtc_library("field_trial") {
visibility = [ "*" ]
- testonly = true
sources = [
"field_trial.cc",
"field_trial.h",
@@ -233,9 +232,23 @@
]
deps = [
- "../api/transport:webrtc_key_value_config",
+ ":field_trial",
+ "../api:webrtc_key_value_config",
"../rtc_base:checks",
- "../system_wrappers:field_trial",
+ ]
+ absl_deps = [ "//third_party/abseil-cpp/absl/strings:strings" ]
+}
+
+rtc_library("scoped_key_value_config") {
+ sources = [
+ "scoped_key_value_config.cc",
+ "scoped_key_value_config.h",
+ ]
+
+ deps = [
+ ":field_trial",
+ "../api:webrtc_key_value_config",
+ "../rtc_base:checks",
]
absl_deps = [ "//third_party/abseil-cpp/absl/strings:strings" ]
}
diff --git a/test/explicit_key_value_config.cc b/test/explicit_key_value_config.cc
index 69f725a..6a561fa 100644
--- a/test/explicit_key_value_config.cc
+++ b/test/explicit_key_value_config.cc
@@ -10,9 +10,8 @@
#include "test/explicit_key_value_config.h"
-#include "api/transport/webrtc_key_value_config.h"
+#include "api/webrtc_key_value_config.h"
#include "rtc_base/checks.h"
-#include "system_wrappers/include/field_trial.h"
namespace webrtc {
namespace test {
diff --git a/test/explicit_key_value_config.h b/test/explicit_key_value_config.h
index 9a3bc84..0a728ab 100644
--- a/test/explicit_key_value_config.h
+++ b/test/explicit_key_value_config.h
@@ -15,7 +15,7 @@
#include <string>
#include "absl/strings/string_view.h"
-#include "api/transport/webrtc_key_value_config.h"
+#include "api/webrtc_key_value_config.h"
namespace webrtc {
namespace test {
diff --git a/test/peer_scenario/BUILD.gn b/test/peer_scenario/BUILD.gn
index a08b4ac..d3ac0da 100644
--- a/test/peer_scenario/BUILD.gn
+++ b/test/peer_scenario/BUILD.gn
@@ -49,6 +49,8 @@
"../../rtc_base",
"../../rtc_base:null_socket_server",
"../../rtc_base:stringutils",
+ "../../test:explicit_key_value_config",
+ "../../test:scoped_key_value_config",
"../logging:log_writer",
"../network:emulated_network",
"../scenario",
diff --git a/test/peer_scenario/scenario_connection.cc b/test/peer_scenario/scenario_connection.cc
index dac21d5..07da453 100644
--- a/test/peer_scenario/scenario_connection.cc
+++ b/test/peer_scenario/scenario_connection.cc
@@ -132,6 +132,7 @@
RTC_DCHECK_RUN_ON(network_thread_);
observer_->OnPacketReceived(packet);
};
+ config.field_trials = &field_trials;
return config;
}
diff --git a/test/peer_scenario/scenario_connection.h b/test/peer_scenario/scenario_connection.h
index f43b3d3..e8cef52 100644
--- a/test/peer_scenario/scenario_connection.h
+++ b/test/peer_scenario/scenario_connection.h
@@ -19,6 +19,7 @@
#include "api/jsep.h"
#include "p2p/base/transport_description.h"
#include "test/network/network_emulation_manager.h"
+#include "test/scoped_key_value_config.h"
namespace webrtc {
@@ -56,6 +57,8 @@
virtual EmulatedEndpoint* endpoint() = 0;
virtual const cricket::TransportDescription& transport_description()
const = 0;
+
+ webrtc::test::ScopedKeyValueConfig field_trials;
};
} // namespace webrtc
diff --git a/test/scoped_key_value_config.cc b/test/scoped_key_value_config.cc
new file mode 100644
index 0000000..fe3f426
--- /dev/null
+++ b/test/scoped_key_value_config.cc
@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2020 The WebRTC project authors. All Rights Reserved.
+ *
+ * Use of this source code is governed by a BSD-style license
+ * that can be found in the LICENSE file in the root of the source
+ * tree. An additional intellectual property rights grant can be found
+ * in the file PATENTS. All contributing project authors may
+ * be found in the AUTHORS file in the root of the source tree.
+ */
+
+#include "test/scoped_key_value_config.h"
+
+#include "api/webrtc_key_value_config.h"
+#include "rtc_base/checks.h"
+#include "test/field_trial.h"
+
+namespace {
+
+// This part is copied from system_wrappers/field_trial.cc.
+void InsertIntoMap(std::map<std::string, std::string>& key_value_map,
+ const std::string& s) {
+ std::string::size_type field_start = 0;
+ while (field_start < s.size()) {
+ std::string::size_type separator_pos = s.find('/', field_start);
+ RTC_CHECK_NE(separator_pos, std::string::npos)
+ << "Missing separator '/' after field trial key.";
+ RTC_CHECK_GT(separator_pos, field_start)
+ << "Field trial key cannot be empty.";
+ std::string key = s.substr(field_start, separator_pos - field_start);
+ field_start = separator_pos + 1;
+
+ RTC_CHECK_LT(field_start, s.size())
+ << "Missing value after field trial key. String ended.";
+ separator_pos = s.find('/', field_start);
+ RTC_CHECK_NE(separator_pos, std::string::npos)
+ << "Missing terminating '/' in field trial string.";
+ RTC_CHECK_GT(separator_pos, field_start)
+ << "Field trial value cannot be empty.";
+ std::string value = s.substr(field_start, separator_pos - field_start);
+ field_start = separator_pos + 1;
+
+ key_value_map[key] = value;
+ }
+ // This check is technically redundant due to earlier checks.
+ // We nevertheless keep the check to make it clear that the entire
+ // string has been processed, and without indexing past the end.
+ RTC_CHECK_EQ(field_start, s.size());
+}
+
+} // namespace
+
+namespace webrtc {
+namespace test {
+
+ScopedKeyValueConfig::ScopedKeyValueConfig()
+ : ScopedKeyValueConfig(nullptr, "") {}
+
+ScopedKeyValueConfig::ScopedKeyValueConfig(const std::string& s)
+ : ScopedKeyValueConfig(nullptr, s) {}
+
+ScopedKeyValueConfig::ScopedKeyValueConfig(ScopedKeyValueConfig& parent,
+ const std::string& s)
+ : ScopedKeyValueConfig(&parent, s) {}
+
+ScopedKeyValueConfig::ScopedKeyValueConfig(ScopedKeyValueConfig* parent,
+ const std::string& s)
+ : parent_(parent), leaf_(nullptr) {
+ InsertIntoMap(key_value_map_, s);
+ // Also store field trials in global string (until we get rid of it).
+ scoped_field_trials_ = std::make_unique<ScopedFieldTrials>(s);
+
+ if (parent == nullptr) {
+ // We are root, set leaf_.
+ leaf_ = this;
+ } else {
+ // Link root to new leaf.
+ GetRoot(parent)->leaf_ = this;
+ RTC_DCHECK(leaf_ == nullptr);
+ }
+}
+
+ScopedKeyValueConfig::~ScopedKeyValueConfig() {
+ if (parent_) {
+ GetRoot(parent_)->leaf_ = parent_;
+ }
+}
+
+ScopedKeyValueConfig* ScopedKeyValueConfig::GetRoot(ScopedKeyValueConfig* n) {
+ while (n->parent_ != nullptr) {
+ n = n->parent_;
+ }
+ return n;
+}
+
+std::string ScopedKeyValueConfig::Lookup(absl::string_view key) const {
+ if (parent_ == nullptr) {
+ return leaf_->LookupRecurse(key);
+ } else {
+ return LookupRecurse(key);
+ }
+}
+
+std::string ScopedKeyValueConfig::LookupRecurse(absl::string_view key) const {
+ auto it = key_value_map_.find(std::string(key));
+ if (it != key_value_map_.end())
+ return it->second;
+
+ if (parent_) {
+ return parent_->LookupRecurse(key);
+ }
+
+ return "";
+}
+
+} // namespace test
+} // namespace webrtc
diff --git a/test/scoped_key_value_config.h b/test/scoped_key_value_config.h
new file mode 100644
index 0000000..a00f61a
--- /dev/null
+++ b/test/scoped_key_value_config.h
@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2020 The WebRTC project authors. All Rights Reserved.
+ *
+ * Use of this source code is governed by a BSD-style license
+ * that can be found in the LICENSE file in the root of the source
+ * tree. An additional intellectual property rights grant can be found
+ * in the file PATENTS. All contributing project authors may
+ * be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef TEST_SCOPED_KEY_VALUE_CONFIG_H_
+#define TEST_SCOPED_KEY_VALUE_CONFIG_H_
+
+#include <map>
+#include <memory>
+#include <string>
+
+#include "absl/strings/string_view.h"
+#include "api/webrtc_key_value_config.h"
+#include "test/field_trial.h"
+
+namespace webrtc {
+namespace test {
+
+class ScopedKeyValueConfig : public WebRtcKeyValueConfig {
+ public:
+ virtual ~ScopedKeyValueConfig();
+ ScopedKeyValueConfig();
+ explicit ScopedKeyValueConfig(const std::string& s);
+ ScopedKeyValueConfig(ScopedKeyValueConfig& parent, const std::string& s);
+
+ std::string Lookup(absl::string_view key) const override;
+
+ private:
+ ScopedKeyValueConfig(ScopedKeyValueConfig* parent, const std::string& s);
+ ScopedKeyValueConfig* GetRoot(ScopedKeyValueConfig* n);
+ std::string LookupRecurse(absl::string_view key) const;
+
+ ScopedKeyValueConfig* const parent_;
+
+ // The leaf in a list of stacked ScopedKeyValueConfig.
+ // Only set on root (e.g with parent_ == nullptr).
+ const ScopedKeyValueConfig* leaf_;
+
+ std::map<std::string, std::string> key_value_map_;
+ std::unique_ptr<ScopedFieldTrials> scoped_field_trials_;
+};
+
+} // namespace test
+} // namespace webrtc
+
+#endif // TEST_SCOPED_KEY_VALUE_CONFIG_H_
