chrome/browser/ui/webui/settings/search_engines_handler_unittest.cc

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ui/webui/settings/search_engines_handler.h"

#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/time/time.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/regional_capabilities/regional_capabilities_service_factory.h"
#include "chrome/browser/search_engine_choice/search_engine_choice_service_factory.h"
#include "chrome/browser/search_engines/template_url_service_factory.h"
#include "chrome/test/base/testing_browser_process.h"
#include "chrome/test/base/testing_profile_manager.h"
#include "components/country_codes/country_codes.h"
#include "components/regional_capabilities/regional_capabilities_service.h"
#include "components/regional_capabilities/regional_capabilities_switches.h"
#include "components/search_engines/search_engine_choice/search_engine_choice_service.h"
#include "components/search_engines/search_engine_choice/search_engine_choice_utils.h"
#include "components/search_engines/search_engine_type.h"
#include "components/search_engines/search_engines_pref_names.h"
#include "components/search_engines/search_engines_test_util.h"
#include "components/search_engines/template_url.h"
#include "components/search_engines/template_url_service.h"
#include "components/signin/public/base/signin_switches.h"
#include "components/version_info/version_info.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/test_web_contents_factory.h"
#include "content/public/test/test_web_ui.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/search_engines_data/resources/definitions/prepopulated_engines.h"
#include "ui/events/devices/device_data_manager.h"

using ::country_codes::CountryId;

namespace settings {
namespace {
TemplateURL* AddSearchEngine(TemplateURLService* template_url_service,
                             const std::string& name,
                             const std::u16string& keyword,
                             int prepopulated_id,
                             std::optional<std::string> url) {
  TemplateURLData default_search_engine;
  default_search_engine.SetShortName(base::UTF8ToUTF16(name));
  default_search_engine.SetKeyword(keyword);
  default_search_engine.prepopulate_id = prepopulated_id;

  if (url.has_value()) {
    default_search_engine.SetURL(*url);
  } else {
    default_search_engine.SetURL("http://" + name +
                                 "foo.com/url?bar={searchTerms}");
  }
  default_search_engine.alternate_urls.push_back("http://" + name +
                                                 "/alt#quux={searchTerms}");
  return template_url_service->Add(
      std::make_unique<TemplateURL>(default_search_engine));
}
}  // namespace

class SearchEnginesHandlerTest : public testing::Test {
 public:
  SearchEnginesHandlerTest()
      : profile_manager_(TestingBrowserProcess::GetGlobal()) {
    ui::DeviceDataManager::CreateInstance();
  }

  void SetUp() override {
    testing::Test::SetUp();

    // The search engine choice feature is only enabled for countries in the
    // EEA region.
    base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
        switches::kSearchEngineChoiceCountry, "BE");

    ASSERT_TRUE(profile_manager_.SetUp());
  }

  void ConfigureTestWithRegularProfile() {
    ConfigureTestWithProfile(
        profile_manager_.CreateTestingProfile("Profile 1"));
  }

  void ConfigureTestWithProfile(Profile* profile) {
    // The test should be configured only once.
    ASSERT_FALSE(handler_);
    ASSERT_FALSE(web_ui_);

    profile_ = profile;

    TemplateURLServiceFactory::GetInstance()->SetTestingFactoryAndUse(
        profile,
        base::BindRepeating(&TemplateURLServiceFactory::BuildInstanceFor));
    TemplateURLService* template_url_service =
        TemplateURLServiceFactory::GetForProfile(profile);
    TemplateURL* default_engine = AddSearchEngine(
        template_url_service, "foo.com", u"foo_com", /*prepopulated_id=*/0,
        /*url=*/std::nullopt);
    AddSearchEngine(template_url_service, "bing",
                    TemplateURLPrepopulateData::bing.keyword,
                    TemplateURLPrepopulateData::bing.id,
                    TemplateURLPrepopulateData::bing.search_url);

    template_url_service->SetUserSelectedDefaultSearchProvider(default_engine);

    web_ui_ = std::make_unique<content::TestWebUI>();
    web_ui_->set_web_contents(web_contents_factory_.CreateWebContents(profile));

    handler_ = std::make_unique<SearchEnginesHandler>(profile);
    handler_->set_web_ui(web_ui_.get());

    handler()->AllowJavascript();
    handler()->RegisterMessages();
    web_ui()->ClearTrackedCalls();
  }

  content::TestWebUI* web_ui() { return web_ui_.get(); }
  Profile* profile() const { return profile_; }
  SearchEnginesHandler* handler() const { return handler_.get(); }
  base::HistogramTester& histogram_tester() { return histogram_tester_; }

  TestingProfileManager& profile_manager() { return profile_manager_; }

 private:
  base::HistogramTester histogram_tester_;
  content::BrowserTaskEnvironment task_environment_;
  TestingProfileManager profile_manager_;
  content::TestWebContentsFactory web_contents_factory_;

  raw_ptr<Profile> profile_ = nullptr;
  std::unique_ptr<content::TestWebUI> web_ui_;
  std::unique_ptr<SearchEnginesHandler> handler_;
};

TEST_F(SearchEnginesHandlerTest, ChangeInTemplateUrlDataTriggersCallback) {
  ConfigureTestWithRegularProfile();

  EXPECT_EQ(0U, web_ui()->call_data().size());
  TemplateURLService* template_url_service =
      TemplateURLServiceFactory::GetForProfile(profile());
  TemplateURL* template_url = AddSearchEngine(template_url_service, "bar.com",
                                              u"bar_com", /*prepopulated_id=*/0,
                                              /*url=*/std::nullopt);

  EXPECT_EQ(1U, web_ui()->call_data().size());
  const content::TestWebUI::CallData& call_data = *web_ui()->call_data().back();
  EXPECT_EQ("cr.webUIListenerCallback", call_data.function_name());
  EXPECT_EQ("search-engines-changed", call_data.arg1()->GetString());

  template_url_service->SetUserSelectedDefaultSearchProvider(template_url);
  EXPECT_EQ(2U, web_ui()->call_data().size());
  const content::TestWebUI::CallData& second_call_data =
      *web_ui()->call_data().back();
  EXPECT_EQ("cr.webUIListenerCallback", second_call_data.function_name());
  EXPECT_EQ("search-engines-changed", second_call_data.arg1()->GetString());
}

TEST_F(SearchEnginesHandlerTest,
       SettingTheDefaultSearchEngineRecordsHistogram) {
  ConfigureTestWithRegularProfile();

  base::Value::List first_call_args;
  // Search engine model id.
  first_call_args.Append(1);
  first_call_args.Append(static_cast<int>(
      search_engines::ChoiceMadeLocation::kSearchEngineSettings));
  first_call_args.Append(base::Value());  // saveGuestChoice
  web_ui()->HandleReceivedMessage("setDefaultSearchEngine", first_call_args);

  histogram_tester().ExpectUniqueSample(
      search_engines::kSearchEngineChoiceScreenDefaultSearchEngineTypeHistogram,
      SearchEngineType::SEARCH_ENGINE_BING, 1);

  base::Value::List second_call_args;
  // Search engine model id.
  second_call_args.Append(1);
  second_call_args.Append(
      static_cast<int>(search_engines::ChoiceMadeLocation::kSearchSettings));
  second_call_args.Append(base::Value());  // saveGuestChoice
  web_ui()->HandleReceivedMessage("setDefaultSearchEngine", second_call_args);

  histogram_tester().ExpectUniqueSample(
      search_engines::kSearchEngineChoiceScreenDefaultSearchEngineTypeHistogram,
      SearchEngineType::SEARCH_ENGINE_BING, 1);
}

TEST_F(SearchEnginesHandlerTest,
       ModifyingSearchEngineSetsSearchEngineChoiceTimestamp) {
  ConfigureTestWithRegularProfile();
  PrefService* pref_service = profile()->GetPrefs();

  EXPECT_FALSE(pref_service->HasPrefPath(
      prefs::kDefaultSearchProviderChoiceScreenCompletionTimestamp));
  EXPECT_FALSE(pref_service->HasPrefPath(
      prefs::kDefaultSearchProviderChoiceScreenCompletionVersion));

  base::Value::List args;
  // Search engine model id.
  args.Append(1);
  args.Append(static_cast<int>(
      search_engines::ChoiceMadeLocation::kSearchEngineSettings));
  args.Append(base::Value());  // saveGuestChoice
  web_ui()->HandleReceivedMessage("setDefaultSearchEngine", args);

  EXPECT_NEAR(pref_service->GetInt64(
                  prefs::kDefaultSearchProviderChoiceScreenCompletionTimestamp),
              base::Time::Now().ToDeltaSinceWindowsEpoch().InSeconds(),
              /*abs_error=*/2);
  EXPECT_EQ(pref_service->GetString(
                prefs::kDefaultSearchProviderChoiceScreenCompletionVersion),
            version_info::GetVersionNumber());
}

TEST_F(SearchEnginesHandlerTest,
       RecordingSearchEngineShouldBeDoneAfterSettingDefault) {
  ConfigureTestWithRegularProfile();
  TemplateURLService* template_url_service =
      TemplateURLServiceFactory::GetForProfile(profile());

  const TemplateURL* default_search_engine =
      template_url_service->GetDefaultSearchProvider();
  SearchEngineType default_search_engine_type =
      default_search_engine->GetEngineType(
          template_url_service->search_terms_data());

  CHECK_NE(default_search_engine_type, SearchEngineType::SEARCH_ENGINE_BING);
  base::Value::List args;
  // Search engine model id.
  args.Append(1);
  args.Append(static_cast<int>(
      search_engines::ChoiceMadeLocation::kSearchEngineSettings));
  args.Append(base::Value());  // saveGuestChoice
  web_ui()->HandleReceivedMessage("setDefaultSearchEngine", args);

  histogram_tester().ExpectUniqueSample(
      search_engines::kSearchEngineChoiceScreenDefaultSearchEngineTypeHistogram,
      SearchEngineType::SEARCH_ENGINE_BING, 1);
}

TEST_F(SearchEnginesHandlerTest, GetSaveGuestChoiceRegularProfile) {
  ConfigureTestWithRegularProfile();

  EXPECT_EQ(0U, web_ui()->call_data().size());
  base::Value::List args;
  args.Append("callback_id");
  web_ui()->HandleReceivedMessage("getSaveGuestChoice", args);
  EXPECT_EQ(1U, web_ui()->call_data().size());
  auto& call_data = web_ui()->call_data().back();
  EXPECT_EQ(call_data->arg1()->GetString(), "callback_id");
  // arg2 is a boolean that is true if the callback is successful.
  EXPECT_TRUE(call_data->arg2()->GetBool());
  // arg3 is our result.
  EXPECT_TRUE(call_data->arg3()->is_none());
}

TEST_F(SearchEnginesHandlerTest, GetSaveGuestChoiceGuestProfile) {
  ConfigureTestWithProfile(profile_manager().CreateGuestProfile());
  auto* choice_service =
      search_engines::SearchEngineChoiceServiceFactory::GetForProfile(
          profile());
  ASSERT_TRUE(
      regional_capabilities::RegionalCapabilitiesServiceFactory::GetForProfile(
          profile())
          ->IsInEeaCountry());
  ASSERT_TRUE(choice_service->IsDsePropagationAllowedForGuest());

  EXPECT_EQ(0U, web_ui()->call_data().size());
  {
    base::Value::List args;
    args.Append("callback_id_1");
    web_ui()->HandleReceivedMessage("getSaveGuestChoice", args);
    EXPECT_EQ(1U, web_ui()->call_data().size());
    auto& call_data = web_ui()->call_data().back();
    EXPECT_EQ(call_data->arg1()->GetString(), "callback_id_1");
    // arg2 is a boolean that is true if the callback is successful.
    EXPECT_TRUE(call_data->arg2()->GetBool());
    // arg3 is our result.
    EXPECT_FALSE(call_data->arg3()->GetBool());
  }

  choice_service->SetSavedSearchEngineBetweenGuestSessions(2);
  {
    base::Value::List args;
    args.Append("callback_id_2");
    web_ui()->HandleReceivedMessage("getSaveGuestChoice", args);
    EXPECT_EQ(2U, web_ui()->call_data().size());
    auto& call_data = web_ui()->call_data().back();
    EXPECT_EQ(call_data->arg1()->GetString(), "callback_id_2");
    // arg2 is a boolean that is true if the callback is successful.
    EXPECT_TRUE(call_data->arg2()->GetBool());
    // arg3 is our result.
    EXPECT_TRUE(call_data->arg3()->GetBool());
  }
}

TEST_F(SearchEnginesHandlerTest, GetSaveGuestChoiceGuestProfile_NonEEA) {
  base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
      switches::kSearchEngineChoiceCountry, "US");

  ConfigureTestWithProfile(profile_manager().CreateGuestProfile());
  auto* choice_service =
      search_engines::SearchEngineChoiceServiceFactory::GetForProfile(
          profile());
  ASSERT_FALSE(
      regional_capabilities::RegionalCapabilitiesServiceFactory::GetForProfile(
          profile())
          ->IsInEeaCountry());
  ASSERT_FALSE(choice_service->IsDsePropagationAllowedForGuest());

  EXPECT_EQ(0U, web_ui()->call_data().size());
  {
    base::Value::List args;
    args.Append("callback_id_1");
    web_ui()->HandleReceivedMessage("getSaveGuestChoice", args);
    EXPECT_EQ(1U, web_ui()->call_data().size());
    auto& call_data = web_ui()->call_data().back();
    EXPECT_EQ(call_data->arg1()->GetString(), "callback_id_1");
    // arg2 is a boolean that is true if the callback is successful.
    EXPECT_TRUE(call_data->arg2()->GetBool());
    // arg3 is our result.
    EXPECT_TRUE(call_data->arg3()->is_none());
  }
}

TEST_F(SearchEnginesHandlerTest, UpdateSavedGuestSearch) {
  ConfigureTestWithProfile(profile_manager().CreateGuestProfile());

  auto* choice_service =
      search_engines::SearchEngineChoiceServiceFactory::GetForProfile(
          profile());
  ASSERT_TRUE(
      regional_capabilities::RegionalCapabilitiesServiceFactory::GetForProfile(
          profile())
          ->IsInEeaCountry());
  ASSERT_TRUE(choice_service->IsDsePropagationAllowedForGuest());

  EXPECT_EQ(std::nullopt,
            choice_service->GetSavedSearchEngineBetweenGuestSessions());
  {
    base::Value::List args;
    // Search engine model id.
    args.Append(1);
    args.Append(static_cast<int>(
        search_engines::ChoiceMadeLocation::kSearchEngineSettings));
    args.Append(true);  // saveGuestChoice
    web_ui()->HandleReceivedMessage("setDefaultSearchEngine", args);
  }
  // Check that saved guest DSE is updated.
  EXPECT_EQ(TemplateURLPrepopulateData::bing.id,
            choice_service->GetSavedSearchEngineBetweenGuestSessions());

  {
    base::Value::List args;
    // Search engine model id.
    args.Append(0);
    args.Append(static_cast<int>(
        search_engines::ChoiceMadeLocation::kSearchEngineSettings));
    args.Append(base::Value());  // saveGuestChoice
    web_ui()->HandleReceivedMessage("setDefaultSearchEngine", args);
  }
  // Check that saved DSE doesn't change if a null saveGuestChoice parameter is
  // passed in.
  EXPECT_EQ(TemplateURLPrepopulateData::bing.id,
            choice_service->GetSavedSearchEngineBetweenGuestSessions());

  {
    base::Value::List args;
    // Search engine model id.
    args.Append(0);
    args.Append(static_cast<int>(
        search_engines::ChoiceMadeLocation::kSearchEngineSettings));
    args.Append(false);  // saveGuestChoice
    web_ui()->HandleReceivedMessage("setDefaultSearchEngine", args);
  }
  // Check that saved DSE is removed when saveGuestChoice is off.
  EXPECT_EQ(std::nullopt,
            choice_service->GetSavedSearchEngineBetweenGuestSessions());
}

TEST_F(SearchEnginesHandlerTest, UpdateSavedGuestSearch_NonEEA) {
  base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
      switches::kSearchEngineChoiceCountry, "US");

  ConfigureTestWithProfile(profile_manager().CreateGuestProfile());

  auto* choice_service =
      search_engines::SearchEngineChoiceServiceFactory::GetForProfile(
          profile());
  ASSERT_FALSE(
      regional_capabilities::RegionalCapabilitiesServiceFactory::GetForProfile(
          profile())
          ->IsInEeaCountry());
  ASSERT_FALSE(choice_service->IsDsePropagationAllowedForGuest());

  EXPECT_EQ(std::nullopt,
            choice_service->GetSavedSearchEngineBetweenGuestSessions());
  {
    base::Value::List args;
    // Search engine model id.
    args.Append(1);
    args.Append(static_cast<int>(
        search_engines::ChoiceMadeLocation::kSearchEngineSettings));
    args.Append(true);  // saveGuestChoice
    web_ui()->HandleReceivedMessage("setDefaultSearchEngine", args);
  }
  // When not in EEA, the saved guest DSE does not get updated, even if
  // `saveGuestChoice` was somehow enabled.
  EXPECT_EQ(std::nullopt,
            choice_service->GetSavedSearchEngineBetweenGuestSessions());
}

}  // namespace settings