[translate] Add translate ranker model loader.

components/translate/core/browser/translate_ranker_impl_unittest.cc

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "components/translate/core/browser/translate_ranker.h"
+#include "components/translate/core/browser/translate_ranker_impl.h"
 
 #include <initializer_list>
 #include <memory>
 
 #include "base/feature_list.h"
+#include "base/memory/ptr_util.h"
+#include "base/message_loop/message_loop.h"
 #include "base/strings/stringprintf.h"
 #include "base/test/scoped_feature_list.h"
+#include "base/test/test_simple_task_runner.h"
+#include "base/threading/thread_task_runner_handle.h"
 #include "components/metrics/proto/translate_event.pb.h"
 #include "components/prefs/scoped_user_pref_update.h"
 #include "components/sync_preferences/testing_pref_service_syncable.h"
+#include "components/translate/core/browser/proto/ranker_model.pb.h"
 #include "components/translate/core/browser/proto/translate_ranker_model.pb.h"
 #include "components/translate/core/browser/translate_download_manager.h"
 #include "components/translate/core/browser/translate_prefs.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace translate {
 
-class TranslateRankerTest : public ::testing::Test {
+class TranslateRankerImplTest : public ::testing::Test {
  protected:
-  TranslateRankerTest() {}
+  TranslateRankerImplTest() {}
 
   void SetUp() override {
+    // Setup the task runner environment.
+    task_runner_ = new base::TestSimpleTaskRunner();
+    thread_task_runner_handle_ =
+        base::MakeUnique<base::ThreadTaskRunnerHandle>(task_runner_);
+
+    // Setup the application locale.
     locale_ = TranslateDownloadManager::GetInstance()->application_locale();
     TranslateDownloadManager::GetInstance()->set_application_locale("zh-CN");
 
     // Setup a 50/50 accepted/denied count for "english" when initialize the
     // prefs and translate prefs.
     base::DictionaryValue lang_count;
     lang_count.SetInteger("en", 50);
     prefs_.reset(new sync_preferences::TestingPrefServiceSyncable());
     TranslatePrefs::RegisterProfilePrefs(prefs_->registry());
     prefs_->Set(TranslatePrefs::kPrefTranslateAcceptedCount, lang_count);
     prefs_->Set(TranslatePrefs::kPrefTranslateDeniedCount, lang_count);
     translate_prefs_.reset(new TranslatePrefs(
         prefs_.get(), "intl.accept_languages", kPreferredLanguagePrefs));
     translate_prefs_->SetCountry("us");
   }
 
   void TearDown() override {
     TranslateDownloadManager::GetInstance()->set_application_locale(locale_);
   }
 
   void InitFeatures(const std::initializer_list<base::Feature>& enabled,
                     const std::initializer_list<base::Feature>& disabled) {
     scoped_feature_list_.InitWithFeatures(enabled, disabled);
   }
 
-  static std::unique_ptr<TranslateRanker> GetRankerForTest(float bias) {
-    chrome_intelligence::TranslateRankerModel model;
-    chrome_intelligence::TranslateRankerModel::LogisticRegressionModel*
-        details = model.mutable_logistic_regression_model();
+  std::unique_ptr<TranslateRankerImpl> GetRankerForTest(float bias) {
+    auto model = base::MakeUnique<chrome_intelligence::RankerModel>();
+    auto* details =
+        model->mutable_translate()->mutable_logistic_regression_model();
     details->set_bias(bias);
     details->set_accept_ratio_weight(0.02f);
     details->set_decline_ratio_weight(0.03f);
 
     auto& src_language_weight = *details->mutable_source_language_weight();
     src_language_weight["en"] = 0.04f;
     src_language_weight["fr"] = 0.05f;
     src_language_weight["zh"] = 0.06f;
 
     auto& dest_language_weight = *details->mutable_dest_language_weight();
     dest_language_weight["UNKNOWN"] = 0.00f;
 
     auto& country_weight = *details->mutable_country_weight();
     country_weight["us"] = 0.07f;
     country_weight["ca"] = 0.08f;
     country_weight["cn"] = 0.09f;
 
     auto& locale_weight = *details->mutable_locale_weight();
     locale_weight["en-us"] = 0.10f;
     locale_weight["en-ca"] = 0.11f;
     locale_weight["zh-cn"] = 0.12f;  // Normalized to lowercase.
 
-    return TranslateRanker::CreateForTesting(model.SerializeAsString());
+    auto impl = base::MakeUnique<TranslateRankerImpl>(base::FilePath(), GURL());
+    impl->OnModelAvailable(std::move(model));
+    task_runner_->RunUntilIdle();
+    return impl;
   }
 
   static double Sigmoid(double x) { return 1.0 / (1.0 + exp(-x)); }
 
-  static metrics::TranslateEventProto CreateTranslateEvent(
+  static std::unique_ptr<metrics::TranslateEventProto> CreateTranslateEvent(
       const std::string& src_lang,
       const std::string& dst_lang,
       int accept_count,
       int decline_count,
       int ignore_count) {
-    metrics::TranslateEventProto translate_event;
-    translate_event.set_source_language(src_lang);
-    translate_event.set_target_language(dst_lang);
-    translate_event.set_accept_count(accept_count);
-    translate_event.set_decline_count(decline_count);
-    translate_event.set_ignore_count(ignore_count);
+    auto translate_event = base::MakeUnique<metrics::TranslateEventProto>();
+    translate_event->set_source_language(src_lang);
+    translate_event->set_target_language(dst_lang);
+    translate_event->set_accept_count(accept_count);
+    translate_event->set_decline_count(decline_count);
+    translate_event->set_ignore_count(ignore_count);
     return translate_event;
   }
 
   static const char* const kPreferredLanguagePrefs;
 
+  // To setup the task scheduling/task-runner environment for each test.
+  scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
+  std::unique_ptr<base::ThreadTaskRunnerHandle> thread_task_runner_handle_;
+
+  // Prefs.
   std::unique_ptr<sync_preferences::TestingPrefServiceSyncable> prefs_;
   std::unique_ptr<translate::TranslatePrefs> translate_prefs_;
 
  private:
   // Manages the enabling/disabling of features within the scope of a test.
   base::test::ScopedFeatureList scoped_feature_list_;
 
   // Cache and reset the application locale for each test.
   std::string locale_;
 
-  DISALLOW_COPY_AND_ASSIGN(TranslateRankerTest);
+  DISALLOW_COPY_AND_ASSIGN(TranslateRankerImplTest);
 };
 
-const char* const TranslateRankerTest::kPreferredLanguagePrefs =
+const char* const TranslateRankerImplTest::kPreferredLanguagePrefs =
 #if defined(OS_CHROMEOS)
     "settings.language.preferred_languages";
 #else
     nullptr;
 #endif
 
-TEST_F(TranslateRankerTest, DisabledByDefault) {
+TEST_F(TranslateRankerImplTest, DisabledByDefault) {
   InitFeatures({}, {});
-  EXPECT_FALSE(TranslateRanker::IsEnabled());
+  EXPECT_FALSE(GetRankerForTest(0.5)->IsEnabled());
 }
 
-TEST_F(TranslateRankerTest, Disabled) {
+TEST_F(TranslateRankerImplTest, Disabled) {
   InitFeatures({}, {kTranslateRankerQuery, kTranslateRankerEnforcement});
-  EXPECT_FALSE(TranslateRanker::IsEnabled());
+  EXPECT_FALSE(GetRankerForTest(0.5)->IsEnabled());
 }
 
-TEST_F(TranslateRankerTest, EnableQuery) {
+TEST_F(TranslateRankerImplTest, EnableQuery) {
   InitFeatures({kTranslateRankerQuery}, {kTranslateRankerEnforcement});
-  EXPECT_TRUE(TranslateRanker::IsEnabled());
+  EXPECT_TRUE(GetRankerForTest(0.5)->IsEnabled());
 }
 
-TEST_F(TranslateRankerTest, EnableEnforcement) {
+TEST_F(TranslateRankerImplTest, EnableEnforcement) {
   InitFeatures({kTranslateRankerEnforcement}, {kTranslateRankerQuery});
-  EXPECT_TRUE(TranslateRanker::IsEnabled());
+  EXPECT_TRUE(GetRankerForTest(0.5)->IsEnabled());
 }
 
-TEST_F(TranslateRankerTest, EnableQueryAndEnforcement) {
+TEST_F(TranslateRankerImplTest, EnableQueryAndEnforcement) {
   InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement}, {});
-  EXPECT_TRUE(TranslateRanker::IsEnabled());
-  EXPECT_FALSE(TranslateRanker::IsLoggingEnabled());
+  EXPECT_TRUE(GetRankerForTest(0.5)->IsEnabled());
+  EXPECT_FALSE(GetRankerForTest(0.5)->IsLoggingEnabled());
 }
 
-TEST_F(TranslateRankerTest, EnableLogging) {
+TEST_F(TranslateRankerImplTest, EnableLogging) {
   InitFeatures({kTranslateRankerLogging}, {});
-  EXPECT_FALSE(TranslateRanker::IsEnabled());
-  EXPECT_TRUE(TranslateRanker::IsLoggingEnabled());
+  EXPECT_FALSE(GetRankerForTest(0.5)->IsEnabled());
+  EXPECT_TRUE(GetRankerForTest(0.5)->IsLoggingEnabled());
 }
 
-
-TEST_F(TranslateRankerTest, CalculateScore) {
+TEST_F(TranslateRankerImplTest, CalculateScore) {
   InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement}, {});
-  std::unique_ptr<translate::TranslateRanker> ranker = GetRankerForTest(0.01f);
+  auto ranker = GetRankerForTest(0.01f);
   // Calculate the score using: a 50:50 accept/decline ratio; the one-hot
   // values for the src lang, dest lang, locale and counry; and, the bias.
   double expected = Sigmoid(0.5 * 0.02f +  // accept ratio * weight
                             0.5 * 0.03f +  // decline ratio * weight
                             0.0 * 0.00f +  // ignore ratio * (default) weight
                             1.0 * 0.04f +  // one-hot src-language "en" * weight
                             1.0 * 0.00f +  // one-hot dst-language "fr" * weight
                             1.0 * 0.07f +  // one-hot country * weight
                             1.0 * 0.12f +  // one-hot locale * weight
                             0.01f);        // bias
+  TranslateRankerFeatures features;
+  features.src_lang = "en";
+  features.dst_lang = "fr";
+  features.country = "us";
+  features.app_locale = "zh-CN";
+  features.accepted_ratio = 0.5;
+  features.denied_ratio = 0.5;
+  features.ignored_ratio = 0.0;
 
-  EXPECT_NEAR(expected,
-              ranker->CalculateScore(0.5, 0.5, 0.0, "en", "fr", "zh-CN", "us"),
-              0.000001);
+  EXPECT_NEAR(expected, ranker->CalculateScore(features), 0.000001);
 }
 
-TEST_F(TranslateRankerTest, ShouldOfferTranslation) {
+TEST_F(TranslateRankerImplTest, ShouldOfferTranslation) {
   InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement}, {});
   // With a bias of -0.5 en->fr is not over the threshold.
   EXPECT_FALSE(GetRankerForTest(-0.5f)->ShouldOfferTranslation(
       *translate_prefs_, "en", "fr"));
   // With a bias of 0.25 en-fr is over the threshold.
   EXPECT_TRUE(GetRankerForTest(0.25f)->ShouldOfferTranslation(*translate_prefs_,
                                                               "en", "fr"));
 }
 
-TEST_F(TranslateRankerTest, RecordAndFlushEvents) {
+TEST_F(TranslateRankerImplTest, RecordAndFlushEvents) {
   InitFeatures({kTranslateRankerLogging}, {});
   std::unique_ptr<translate::TranslateRanker> ranker = GetRankerForTest(0.0f);
-  std::vector<metrics::TranslateEventProto> flushed_events;
+  std::vector<std::unique_ptr<metrics::TranslateEventProto>> flushed_events;
 
   // Check that flushing an empty cache will return an empty vector.
   ranker->FlushTranslateEvents(&flushed_events);
   EXPECT_EQ(0U, flushed_events.size());
 
-  auto event_1 = CreateTranslateEvent("fr", "en", 1, 0, 3);
-  auto event_2 = CreateTranslateEvent("jp", "en", 2, 0, 3);
-  auto event_3 = CreateTranslateEvent("es", "de", 4, 5, 6);
-  ranker->RecordTranslateEvent(event_1);
-  ranker->RecordTranslateEvent(event_2);
-  ranker->RecordTranslateEvent(event_3);
+  ranker->AddTranslateEvent(CreateTranslateEvent("fr", "en", 1, 0, 3));
+  ranker->AddTranslateEvent(CreateTranslateEvent("jp", "en", 2, 0, 3));
+  ranker->AddTranslateEvent(CreateTranslateEvent("es", "de", 4, 5, 6));
 
   // Capture the data and verify that it is as expected.
   ranker->FlushTranslateEvents(&flushed_events);
   EXPECT_EQ(3U, flushed_events.size());
-  ASSERT_EQ("fr", flushed_events[0].source_language());
-  ASSERT_EQ("jp", flushed_events[1].source_language());
-  ASSERT_EQ("es", flushed_events[2].source_language());
+  ASSERT_EQ("fr", flushed_events[0]->source_language());
+  ASSERT_EQ("jp", flushed_events[1]->source_language());
+  ASSERT_EQ("es", flushed_events[2]->source_language());
 
   // Check that the cache has been cleared.
   ranker->FlushTranslateEvents(&flushed_events);
   EXPECT_EQ(0U, flushed_events.size());
 }
 
-TEST_F(TranslateRankerTest, LoggingDisabled) {
+TEST_F(TranslateRankerImplTest, LoggingDisabled) {
   InitFeatures({}, {kTranslateRankerLogging});
   std::unique_ptr<translate::TranslateRanker> ranker = GetRankerForTest(0.0f);
-  std::vector<metrics::TranslateEventProto> flushed_events;
+  std::vector<std::unique_ptr<metrics::TranslateEventProto>> flushed_events;
 
   ranker->FlushTranslateEvents(&flushed_events);
   EXPECT_EQ(0U, flushed_events.size());
 
-  auto event_1 = CreateTranslateEvent("fr", "en", 1, 0, 3);
-  auto event_2 = CreateTranslateEvent("jp", "en", 2, 0, 3);
-  auto event_3 = CreateTranslateEvent("es", "de", 4, 5, 6);
-  ranker->RecordTranslateEvent(event_1);
-  ranker->RecordTranslateEvent(event_2);
-  ranker->RecordTranslateEvent(event_3);
+  ranker->AddTranslateEvent(CreateTranslateEvent("fr", "en", 1, 0, 3));
+  ranker->AddTranslateEvent(CreateTranslateEvent("jp", "en", 2, 0, 3));
+  ranker->AddTranslateEvent(CreateTranslateEvent("es", "de", 4, 5, 6));
 
   // Logging is disabled, so no events should be cached.
   ranker->FlushTranslateEvents(&flushed_events);
   EXPECT_EQ(0U, flushed_events.size());
 }
 
 }  // namespace translate