| OLD | NEW |
| (Empty) |
| 1 // Copyright 2016 The Chromium Authors. All rights reserved. | |
| 2 // Use of this source code is governed by a BSD-style license that can be | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #include "components/translate/core/browser/translate_ranker_impl.h" | |
| 6 | |
| 7 #include <initializer_list> | |
| 8 #include <memory> | |
| 9 | |
| 10 #include "base/feature_list.h" | |
| 11 #include "base/memory/ptr_util.h" | |
| 12 #include "base/message_loop/message_loop.h" | |
| 13 #include "base/run_loop.h" | |
| 14 #include "base/strings/stringprintf.h" | |
| 15 #include "base/task_scheduler/post_task.h" | |
| 16 #include "base/test/scoped_feature_list.h" | |
| 17 #include "base/test/scoped_task_scheduler.h" | |
| 18 #include "components/metrics/proto/translate_event.pb.h" | |
| 19 #include "components/prefs/scoped_user_pref_update.h" | |
| 20 #include "components/sync_preferences/testing_pref_service_syncable.h" | |
| 21 #include "components/translate/core/browser/proto/ranker_model.pb.h" | |
| 22 #include "components/translate/core/browser/proto/translate_ranker_model.pb.h" | |
| 23 #include "components/translate/core/browser/ranker_model.h" | |
| 24 #include "components/translate/core/browser/translate_download_manager.h" | |
| 25 #include "components/translate/core/browser/translate_prefs.h" | |
| 26 #include "net/url_request/test_url_fetcher_factory.h" | |
| 27 #include "net/url_request/url_request_test_util.h" | |
| 28 #include "testing/gtest/include/gtest/gtest.h" | |
| 29 | |
| 30 namespace { | |
| 31 | |
| 32 using translate::kTranslateRankerEnforcement; | |
| 33 using translate::kTranslateRankerLogging; | |
| 34 using translate::kTranslateRankerQuery; | |
| 35 using translate::TranslateDownloadManager; | |
| 36 using translate::TranslateRankerFeatures; | |
| 37 using translate::TranslatePrefs; | |
| 38 using translate::TranslateRankerImpl; | |
| 39 | |
| 40 constexpr int kModelVersion = 1234; | |
| 41 | |
| 42 class TranslateRankerImplTest : public ::testing::Test { | |
| 43 protected: | |
| 44 TranslateRankerImplTest(); | |
| 45 | |
| 46 void SetUp() override; | |
| 47 | |
| 48 void TearDown() override; | |
| 49 | |
| 50 // Initializes the explicitly |enabled| and |disabled| features for this test. | |
| 51 void InitFeatures(const std::initializer_list<base::Feature>& enabled, | |
| 52 const std::initializer_list<base::Feature>& disabled); | |
| 53 | |
| 54 // Returns a TranslateRankerImpl object with |bias| for testing. | |
| 55 std::unique_ptr<TranslateRankerImpl> GetRankerForTest(float bias); | |
| 56 | |
| 57 // Implements the same sigmoid function used by TranslateRankerImpl. | |
| 58 static double Sigmoid(double x); | |
| 59 | |
| 60 // Returns a translate event initialized with the given parameters. | |
| 61 static metrics::TranslateEventProto CreateTranslateEvent( | |
| 62 const std::string& src_lang, | |
| 63 const std::string& dst_lang, | |
| 64 int accept_count, | |
| 65 int decline_count, | |
| 66 int ignore_count); | |
| 67 | |
| 68 // The platform-specific name of the preferred language pref. | |
| 69 static const char* const kPreferredLanguagePref; | |
| 70 | |
| 71 // Prefs. | |
| 72 std::unique_ptr<sync_preferences::TestingPrefServiceSyncable> prefs_; | |
| 73 std::unique_ptr<translate::TranslatePrefs> translate_prefs_; | |
| 74 | |
| 75 private: | |
| 76 // Override the default URL fetcher to return custom responses for tests. | |
| 77 net::TestURLFetcherFactory url_fetcher_factory_; | |
| 78 | |
| 79 // Used to initialize the translate download manager. | |
| 80 scoped_refptr<net::TestURLRequestContextGetter> request_context_; | |
| 81 | |
| 82 // Sets up the task scheduling/task-runner environment for each test. | |
| 83 base::test::ScopedTaskScheduler scoped_task_scheduler_; | |
| 84 | |
| 85 // Manages the enabling/disabling of features within the scope of a test. | |
| 86 base::test::ScopedFeatureList scoped_feature_list_; | |
| 87 | |
| 88 // Cache and reset the application locale for each test. | |
| 89 std::string locale_; | |
| 90 | |
| 91 DISALLOW_COPY_AND_ASSIGN(TranslateRankerImplTest); | |
| 92 }; | |
| 93 | |
| 94 const char* const TranslateRankerImplTest::kPreferredLanguagePref = | |
| 95 #if defined(OS_CHROMEOS) | |
| 96 "settings.language.preferred_languages"; | |
| 97 #else | |
| 98 nullptr; | |
| 99 #endif | |
| 100 | |
| 101 TranslateRankerImplTest::TranslateRankerImplTest() {} | |
| 102 | |
| 103 void TranslateRankerImplTest::SetUp() { | |
| 104 // Setup the translate download manager. | |
| 105 locale_ = TranslateDownloadManager::GetInstance()->application_locale(); | |
| 106 request_context_ = | |
| 107 new net::TestURLRequestContextGetter(base::ThreadTaskRunnerHandle::Get()); | |
| 108 TranslateDownloadManager::GetInstance()->set_application_locale("zh-CN"); | |
| 109 TranslateDownloadManager::GetInstance()->set_request_context( | |
| 110 request_context_.get()); | |
| 111 | |
| 112 // Setup a 50/50 accepted/denied count for "english" when initialize the | |
| 113 // prefs and translate prefs. | |
| 114 base::DictionaryValue lang_count; | |
| 115 lang_count.SetInteger("en", 50); | |
| 116 prefs_.reset(new sync_preferences::TestingPrefServiceSyncable()); | |
| 117 TranslatePrefs::RegisterProfilePrefs(prefs_->registry()); | |
| 118 prefs_->Set(TranslatePrefs::kPrefTranslateAcceptedCount, lang_count); | |
| 119 prefs_->Set(TranslatePrefs::kPrefTranslateDeniedCount, lang_count); | |
| 120 translate_prefs_.reset(new TranslatePrefs( | |
| 121 prefs_.get(), "intl.accept_languages", kPreferredLanguagePref)); | |
| 122 translate_prefs_->SetCountry("de"); | |
| 123 } | |
| 124 | |
| 125 void TranslateRankerImplTest::TearDown() { | |
| 126 base::RunLoop().RunUntilIdle(); | |
| 127 TranslateDownloadManager::GetInstance()->set_application_locale(locale_); | |
| 128 TranslateDownloadManager::GetInstance()->set_request_context(nullptr); | |
| 129 } | |
| 130 | |
| 131 void TranslateRankerImplTest::InitFeatures( | |
| 132 const std::initializer_list<base::Feature>& enabled, | |
| 133 const std::initializer_list<base::Feature>& disabled) { | |
| 134 scoped_feature_list_.InitWithFeatures(enabled, disabled); | |
| 135 } | |
| 136 | |
| 137 std::unique_ptr<TranslateRankerImpl> TranslateRankerImplTest::GetRankerForTest( | |
| 138 float bias) { | |
| 139 auto model = base::MakeUnique<chrome_intelligence::RankerModel>(); | |
| 140 model->mutable_proto()->mutable_translate()->set_version(kModelVersion); | |
| 141 auto* details = model->mutable_proto() | |
| 142 ->mutable_translate() | |
| 143 ->mutable_logistic_regression_model(); | |
| 144 details->set_bias(bias); | |
| 145 details->set_accept_ratio_weight(0.02f); | |
| 146 details->set_decline_ratio_weight(0.03f); | |
| 147 details->set_accept_count_weight(0.13f); | |
| 148 details->set_decline_count_weight(-0.14f); | |
| 149 | |
| 150 auto& src_language_weight = *details->mutable_source_language_weight(); | |
| 151 src_language_weight["en"] = 0.04f; | |
| 152 src_language_weight["fr"] = 0.05f; | |
| 153 src_language_weight["zh"] = 0.06f; | |
| 154 | |
| 155 auto& dest_language_weight = *details->mutable_dest_language_weight(); | |
| 156 dest_language_weight["UNKNOWN"] = 0.00f; | |
| 157 | |
| 158 auto& country_weight = *details->mutable_country_weight(); | |
| 159 country_weight["de"] = 0.07f; | |
| 160 country_weight["ca"] = 0.08f; | |
| 161 country_weight["cn"] = 0.09f; | |
| 162 | |
| 163 auto& locale_weight = *details->mutable_locale_weight(); | |
| 164 locale_weight["en-us"] = 0.10f; | |
| 165 locale_weight["en-ca"] = 0.11f; | |
| 166 locale_weight["zh-cn"] = 0.12f; // Normalized to lowercase. | |
| 167 | |
| 168 auto impl = base::MakeUnique<TranslateRankerImpl>(base::FilePath(), GURL()); | |
| 169 impl->OnModelAvailable(std::move(model)); | |
| 170 base::RunLoop().RunUntilIdle(); | |
| 171 return impl; | |
| 172 } | |
| 173 | |
| 174 // static | |
| 175 double TranslateRankerImplTest::Sigmoid(double x) { | |
| 176 return 1.0 / (1.0 + exp(-x)); | |
| 177 } | |
| 178 | |
| 179 // static | |
| 180 metrics::TranslateEventProto TranslateRankerImplTest::CreateTranslateEvent( | |
| 181 const std::string& src_lang, | |
| 182 const std::string& dst_lang, | |
| 183 int accept_count, | |
| 184 int decline_count, | |
| 185 int ignore_count) { | |
| 186 metrics::TranslateEventProto translate_event; | |
| 187 translate_event.set_source_language(src_lang); | |
| 188 translate_event.set_target_language(dst_lang); | |
| 189 translate_event.set_accept_count(accept_count); | |
| 190 translate_event.set_decline_count(decline_count); | |
| 191 translate_event.set_ignore_count(ignore_count); | |
| 192 return translate_event; | |
| 193 } | |
| 194 | |
| 195 } // namespace | |
| 196 | |
| 197 TEST_F(TranslateRankerImplTest, DisabledByDefault) { | |
| 198 InitFeatures({}, {}); | |
| 199 auto ranker = GetRankerForTest(0.5); | |
| 200 EXPECT_FALSE(ranker->IsQueryEnabled()); | |
| 201 EXPECT_FALSE(ranker->IsEnforcementEnabled()); | |
| 202 EXPECT_FALSE(ranker->IsLoggingEnabled()); | |
| 203 } | |
| 204 | |
| 205 TEST_F(TranslateRankerImplTest, ExplicitlyDisabled) { | |
| 206 InitFeatures({}, {kTranslateRankerQuery, kTranslateRankerEnforcement, | |
| 207 kTranslateRankerLogging}); | |
| 208 auto ranker = GetRankerForTest(0.5); | |
| 209 EXPECT_FALSE(ranker->IsQueryEnabled()); | |
| 210 EXPECT_FALSE(ranker->IsEnforcementEnabled()); | |
| 211 EXPECT_FALSE(ranker->IsLoggingEnabled()); | |
| 212 } | |
| 213 | |
| 214 TEST_F(TranslateRankerImplTest, EnableQuery) { | |
| 215 InitFeatures({kTranslateRankerQuery}, {kTranslateRankerEnforcement}); | |
| 216 auto ranker = GetRankerForTest(0.5); | |
| 217 EXPECT_TRUE(ranker->IsQueryEnabled()); | |
| 218 EXPECT_FALSE(ranker->IsEnforcementEnabled()); | |
| 219 EXPECT_FALSE(ranker->IsLoggingEnabled()); | |
| 220 } | |
| 221 | |
| 222 TEST_F(TranslateRankerImplTest, EnableEnforcement) { | |
| 223 InitFeatures({kTranslateRankerEnforcement}, {kTranslateRankerQuery}); | |
| 224 auto ranker = GetRankerForTest(0.5); | |
| 225 EXPECT_TRUE(ranker->IsQueryEnabled()); | |
| 226 EXPECT_TRUE(ranker->IsEnforcementEnabled()); | |
| 227 EXPECT_FALSE(ranker->IsLoggingEnabled()); | |
| 228 } | |
| 229 | |
| 230 TEST_F(TranslateRankerImplTest, EnableQueryAndEnforcement) { | |
| 231 InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement}, {}); | |
| 232 auto ranker = GetRankerForTest(0.5); | |
| 233 EXPECT_TRUE(ranker->IsQueryEnabled()); | |
| 234 EXPECT_TRUE(ranker->IsEnforcementEnabled()); | |
| 235 EXPECT_FALSE(ranker->IsLoggingEnabled()); | |
| 236 } | |
| 237 | |
| 238 TEST_F(TranslateRankerImplTest, EnableLogging) { | |
| 239 InitFeatures({kTranslateRankerLogging}, {}); | |
| 240 auto ranker = GetRankerForTest(0.5); | |
| 241 EXPECT_FALSE(ranker->IsQueryEnabled()); | |
| 242 EXPECT_FALSE(ranker->IsEnforcementEnabled()); | |
| 243 EXPECT_TRUE(ranker->IsLoggingEnabled()); | |
| 244 } | |
| 245 | |
| 246 TEST_F(TranslateRankerImplTest, EnableAll) { | |
| 247 InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement, | |
| 248 kTranslateRankerLogging}, | |
| 249 {}); | |
| 250 auto ranker = GetRankerForTest(0.5); | |
| 251 EXPECT_TRUE(ranker->IsQueryEnabled()); | |
| 252 EXPECT_TRUE(ranker->IsEnforcementEnabled()); | |
| 253 EXPECT_TRUE(ranker->IsLoggingEnabled()); | |
| 254 } | |
| 255 | |
| 256 TEST_F(TranslateRankerImplTest, GetVersion) { | |
| 257 InitFeatures({kTranslateRankerQuery}, {}); | |
| 258 auto ranker = GetRankerForTest(0.01f); | |
| 259 EXPECT_TRUE(ranker->CheckModelLoaderForTesting()); | |
| 260 EXPECT_EQ(kModelVersion, ranker->GetModelVersion()); | |
| 261 } | |
| 262 | |
| 263 TEST_F(TranslateRankerImplTest, ModelLoaderQueryNotEnabled) { | |
| 264 // If Query is not enabled, the ranker should not try to load the model. | |
| 265 InitFeatures({}, {kTranslateRankerQuery}); | |
| 266 auto ranker = GetRankerForTest(0.01f); | |
| 267 EXPECT_FALSE(ranker->CheckModelLoaderForTesting()); | |
| 268 } | |
| 269 | |
| 270 TEST_F(TranslateRankerImplTest, CalculateScore) { | |
| 271 InitFeatures({kTranslateRankerEnforcement}, {}); | |
| 272 auto ranker = GetRankerForTest(0.01f); | |
| 273 // Calculate the score using: a 50:50 accept/decline ratio; the one-hot | |
| 274 // values for the src lang, dest lang, locale and counry; and, the bias. | |
| 275 double expected = Sigmoid(50.0 * 0.13f + // accept count * weight | |
| 276 50.0 * -0.14f + // decline count * weight | |
| 277 0.0 * 0.00f + // ignore count * (default) weight | |
| 278 0.5 * 0.02f + // accept ratio * weight | |
| 279 0.5 * 0.03f + // decline ratio * weight | |
| 280 0.0 * 0.00f + // ignore ratio * (default) weight | |
| 281 1.0 * 0.04f + // one-hot src-language "en" * weight | |
| 282 1.0 * 0.00f + // one-hot dst-language "fr" * weight | |
| 283 1.0 * 0.07f + // one-hot country "de" * weight | |
| 284 1.0 * 0.12f + // one-hot locale "zh-CN" * weight | |
| 285 0.01f); // bias | |
| 286 TranslateRankerFeatures features(50, 50, 0, "en", "fr", "de", "zh-CN"); | |
| 287 | |
| 288 EXPECT_NEAR(expected, ranker->CalculateScore(features), 0.000001); | |
| 289 } | |
| 290 | |
| 291 TEST_F(TranslateRankerImplTest, ShouldOfferTranslation) { | |
| 292 InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement}, {}); | |
| 293 // With a bias of -0.5 en->fr is not over the threshold. | |
| 294 EXPECT_FALSE(GetRankerForTest(-0.5f)->ShouldOfferTranslation( | |
| 295 *translate_prefs_, "en", "fr")); | |
| 296 // With a bias of 0.25 en-fr is over the threshold. | |
| 297 EXPECT_TRUE(GetRankerForTest(0.25f)->ShouldOfferTranslation(*translate_prefs_, | |
| 298 "en", "fr")); | |
| 299 } | |
| 300 | |
| 301 TEST_F(TranslateRankerImplTest, RecordAndFlushEvents) { | |
| 302 InitFeatures({kTranslateRankerLogging}, {}); | |
| 303 std::unique_ptr<translate::TranslateRanker> ranker = GetRankerForTest(0.0f); | |
| 304 std::vector<metrics::TranslateEventProto> flushed_events; | |
| 305 | |
| 306 // Check that flushing an empty cache will return an empty vector. | |
| 307 ranker->FlushTranslateEvents(&flushed_events); | |
| 308 EXPECT_EQ(0U, flushed_events.size()); | |
| 309 | |
| 310 ranker->AddTranslateEvent(CreateTranslateEvent("fr", "en", 1, 0, 3)); | |
| 311 ranker->AddTranslateEvent(CreateTranslateEvent("jp", "en", 2, 0, 3)); | |
| 312 ranker->AddTranslateEvent(CreateTranslateEvent("es", "de", 4, 5, 6)); | |
| 313 | |
| 314 // Capture the data and verify that it is as expected. | |
| 315 ranker->FlushTranslateEvents(&flushed_events); | |
| 316 EXPECT_EQ(3U, flushed_events.size()); | |
| 317 ASSERT_EQ("fr", flushed_events[0].source_language()); | |
| 318 ASSERT_EQ("jp", flushed_events[1].source_language()); | |
| 319 ASSERT_EQ("es", flushed_events[2].source_language()); | |
| 320 | |
| 321 // Check that the cache has been cleared. | |
| 322 ranker->FlushTranslateEvents(&flushed_events); | |
| 323 EXPECT_EQ(0U, flushed_events.size()); | |
| 324 } | |
| 325 | |
| 326 TEST_F(TranslateRankerImplTest, LoggingDisabled) { | |
| 327 InitFeatures({}, {kTranslateRankerLogging}); | |
| 328 std::unique_ptr<translate::TranslateRanker> ranker = GetRankerForTest(0.0f); | |
| 329 std::vector<metrics::TranslateEventProto> flushed_events; | |
| 330 | |
| 331 ranker->FlushTranslateEvents(&flushed_events); | |
| 332 EXPECT_EQ(0U, flushed_events.size()); | |
| 333 | |
| 334 ranker->AddTranslateEvent(CreateTranslateEvent("fr", "en", 1, 0, 3)); | |
| 335 ranker->AddTranslateEvent(CreateTranslateEvent("jp", "en", 2, 0, 3)); | |
| 336 ranker->AddTranslateEvent(CreateTranslateEvent("es", "de", 4, 5, 6)); | |
| 337 | |
| 338 // Logging is disabled, so no events should be cached. | |
| 339 ranker->FlushTranslateEvents(&flushed_events); | |
| 340 EXPECT_EQ(0U, flushed_events.size()); | |
| 341 } | |
| OLD | NEW |