// 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 #include "base/callback_list.h" #include "base/check_deref.h" #include "base/strings/strcat.h" #include "base/test/metrics/histogram_tester.h" #include "base/test/scoped_feature_list.h" #include "base/test/test_future.h" #include "build/buildflag.h" #include "chrome/browser/browser_process.h" #include "chrome/browser/prefs/session_startup_pref.h" #include "chrome/browser/profiles/keep_alive/profile_keep_alive_types.h" #include "chrome/browser/profiles/keep_alive/scoped_profile_keep_alive.h" #include "chrome/browser/profiles/profile_manager.h" #include "chrome/browser/profiles/profile_test_util.h" #include "chrome/browser/profiles/profile_window.h" #include "chrome/browser/search_engine_choice/search_engine_choice_dialog_service.h" #include "chrome/browser/search_engine_choice/search_engine_choice_dialog_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/browser/sessions/session_restore_test_helper.h" #include "chrome/browser/sessions/session_service_factory.h" #include "chrome/browser/ui/browser_commands.h" #include "chrome/browser/ui/browser_tabstrip.h" #include "chrome/browser/ui/browser_window/public/browser_window_features.h" #include "chrome/browser/ui/browser_window/public/browser_window_interface.h" #include "chrome/browser/ui/browser_window/public/browser_window_interface_iterator.h" #include "chrome/browser/ui/browser_window/public/create_browser_window.h" #include "chrome/browser/ui/browser_window/public/global_browser_collection.h" #include "chrome/browser/ui/navigator/browser_navigator.h" #include "chrome/browser/ui/signin/signin_view_controller.h" #include "chrome/browser/ui/web_applications/test/web_app_browsertest_util.h" #include "chrome/browser/ui/webui/ntp/new_tab_ui.h" #include "chrome/browser/web_applications/test/os_integration_test_override_impl.h" #include "chrome/browser/web_applications/test/web_app_install_test_utils.h" #include "chrome/browser/web_applications/web_app_install_info.h" #include "chrome/common/chrome_constants.h" #include "chrome/common/webui_url_constants.h" #include "chrome/test/base/in_process_browser_test.h" #include "chrome/test/base/ui_test_utils.h" #include "components/keep_alive_registry/keep_alive_types.h" #include "components/keep_alive_registry/scoped_keep_alive.h" #include "components/keyed_service/content/browser_context_dependency_manager.h" #include "components/keyed_service/core/keyed_service.h" #include "components/regional_capabilities/regional_capabilities_switches.h" #include "components/search_engines/default_search_manager.h" #include "components/search_engines/search_engine_choice/search_engine_choice_utils.h" #include "components/search_engines/search_engines_pref_names.h" #include "components/search_engines/search_engines_switches.h" #include "components/search_engines/search_engines_test_util.h" #include "components/search_engines/template_url.h" #include "components/search_engines/template_url_prepopulate_data.h" #include "components/search_engines/template_url_service.h" #include "components/variations/variations_switches.h" #include "components/version_info/version_info.h" #include "components/webapps/common/web_app_id.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/web_contents.h" #include "content/public/test/browser_test.h" #include "content/public/test/browser_test_utils.h" #include "content/public/test/test_navigation_observer.h" #include "testing/gmock/include/gmock/gmock.h" #include "testing/gtest/include/gtest/gtest.h" #include "third_party/search_engines_data/resources/definitions/prepopulated_engines.h" #include "ui/base/window_open_disposition.h" using ::testing::_; using ::testing::TestParamInfo; using ::testing::ValuesIn; using ::testing::WithParamInterface; using EntryPoint = ::SearchEngineChoiceDialogService::EntryPoint; using ::regional_capabilities::SearchEngineChoiceScreenConditions; namespace { // Class that mocks `SearchEngineChoiceDialogService`. class MockSearchEngineChoiceDialogService : public SearchEngineChoiceDialogService { public: explicit MockSearchEngineChoiceDialogService(Profile* profile) : SearchEngineChoiceDialogService( *profile, *search_engines::SearchEngineChoiceServiceFactory::GetForProfile( profile), *TemplateURLServiceFactory::GetForProfile(profile)) { ON_CALL(*this, RegisterDialog) .WillByDefault([this](BrowserWindowInterface& browser, base::OnceClosure callback) { number_of_browsers_with_dialogs_open_++; return SearchEngineChoiceDialogService::RegisterDialog( browser, std::move(callback)); }); ON_CALL(*this, NotifyChoiceMade) .WillByDefault([this](int prepopulate_id, bool save_guest_mode_selection, EntryPoint entry_point) { number_of_browsers_with_dialogs_open_ = 0; SearchEngineChoiceDialogService::NotifyChoiceMade( prepopulate_id, save_guest_mode_selection, entry_point); }); } ~MockSearchEngineChoiceDialogService() override = default; static std::unique_ptr Create( content::BrowserContext* context) { Profile* profile = Profile::FromBrowserContext(context); if (SearchEngineChoiceDialogServiceFactory:: ComputeProfileEligibilityForTesting(CHECK_DEREF(profile)) != SearchEngineChoiceScreenConditions::kEligible) { return nullptr; } return std::make_unique< testing::NiceMock>(profile); } unsigned int GetNumberOfBrowsersWithDialogsOpen() const { return number_of_browsers_with_dialogs_open_; } MOCK_METHOD(bool, RegisterDialog, (BrowserWindowInterface&, base::OnceClosure), (override)); MOCK_METHOD(void, NotifyChoiceMade, (int, bool, EntryPoint), (override)); private: unsigned int number_of_browsers_with_dialogs_open_ = 0; }; webapps::AppId InstallPWA(Profile* profile, const GURL& start_url) { auto web_app_info = web_app::WebAppInstallInfo::CreateWithStartUrlForTesting(start_url); web_app_info->scope = start_url.GetWithoutFilename(); web_app_info->user_display_mode = web_app::mojom::UserDisplayMode::kStandalone; web_app_info->title = u"A Web App"; return web_app::test::InstallWebApp(profile, std::move(web_app_info)); } } // namespace class SearchEngineChoiceDialogBrowserTest : public InProcessBrowserTest { public: explicit SearchEngineChoiceDialogBrowserTest(bool use_spy_service = true) : use_spy_service_(use_spy_service) {} SearchEngineChoiceDialogBrowserTest( const SearchEngineChoiceDialogBrowserTest&) = delete; SearchEngineChoiceDialogBrowserTest& operator=( const SearchEngineChoiceDialogBrowserTest&) = delete; ~SearchEngineChoiceDialogBrowserTest() override = default; void SetUpCommandLine(base::CommandLine* command_line) override { InProcessBrowserTest::SetUpCommandLine(command_line); command_line->AppendSwitch( switches::kIgnoreNoFirstRunForSearchEngineChoiceScreen); command_line->AppendSwitchASCII( variations::switches::kVariationsOverrideCountry, "BE"); } void SetUpInProcessBrowserTestFixture() override { InProcessBrowserTest::SetUpInProcessBrowserTestFixture(); // The search engine choice feature is enabled for countries in the EEA // region. base::CommandLine::ForCurrentProcess()->AppendSwitchASCII( switches::kSearchEngineChoiceCountry, "BE"); if (use_spy_service_) { create_services_subscription_ = BrowserContextDependencyManager::GetInstance() ->RegisterCreateServicesCallbackForTesting( base::BindRepeating([](content::BrowserContext* context) { SearchEngineChoiceDialogServiceFactory::GetInstance() ->SetTestingFactoryAndUse( context, base::BindRepeating( &MockSearchEngineChoiceDialogService::Create)); })); } } void SetUpOnMainThread() override { InProcessBrowserTest::SetUpOnMainThread(); // We want the dialog to be enabled after browser creation so that it // doesn't get displayed before running the test. SearchEngineChoiceDialogService::SetDialogDisabledForTests( /*dialog_disabled=*/false); } // TODO(crbug.com/40277150): Make this function handle multiple browsers. void QuitAndRestoreBrowser(BrowserWindowInterface* browser) { Profile* profile = browser->GetProfile(); // Enable SessionRestore to last used pages. SessionStartupPref startup_pref(SessionStartupPref::LAST); SessionStartupPref::SetStartupPref(profile, startup_pref); // Close the browser. auto keep_alive = std::make_unique( KeepAliveOrigin::SESSION_RESTORE, KeepAliveRestartOption::DISABLED); auto profile_keep_alive = std::make_unique( profile, ProfileKeepAliveOrigin::kBrowserWindow); CloseBrowserSynchronously(browser); ui_test_utils::AllBrowserTabAddedWaiter tab_waiter; SessionRestoreTestHelper restore_observer; // Create a new window, which should trigger session restore. ui_test_utils::BrowserCreatedObserver browser_created_observer; chrome::NewEmptyWindow(profile); tab_waiter.Wait(); SetBrowser(browser_created_observer.Wait()); ForEachCurrentBrowserWindowInterfaceOrderedByActivation( [this](BrowserWindowInterface* browser) { WaitForTabsToLoad(browser); return true; }); restore_observer.Wait(); keep_alive.reset(); profile_keep_alive.reset(); } void WaitForTabsToLoad(BrowserWindowInterface* browser) { TabStripModel* const tab_strip_model = browser->GetTabStripModel(); for (int i = 0; i < tab_strip_model->count(); ++i) { content::WebContents* const contents = tab_strip_model->GetWebContentsAt(i); contents->GetController().LoadIfNecessary(); EXPECT_TRUE(content::WaitForLoadStop(contents)); } } void CheckChoiceScreenWasDisplayedRecordedOnce() { histogram_tester_.ExpectBucketCount( search_engines::kSearchEngineChoiceScreenEventsHistogram, search_engines::SearchEngineChoiceScreenEvents:: kChoiceScreenWasDisplayed, 1); } void CheckDefaultWasSetRecorded() { histogram_tester_.ExpectBucketCount( search_engines::kSearchEngineChoiceScreenEventsHistogram, search_engines::SearchEngineChoiceScreenEvents::kDefaultWasSet, 1); } // We check that the histogram is recorded for at least `count` because // navigations could happen multiple times in a browser and might record the // histogram more than the number specified in `count`. void CheckNavigationConditionRecorded( regional_capabilities::SearchEngineChoiceScreenConditions condition, int count) { EXPECT_GE(histogram_tester_.GetBucketCount( search_engines:: kSearchEngineChoiceScreenNavigationConditionsHistogram, condition), count); } void CheckProfileInitConditionRecorded( regional_capabilities::SearchEngineChoiceScreenConditions condition, int count) { histogram_tester_.ExpectBucketCount( search_engines::kSearchEngineChoiceScreenProfileInitConditionsHistogram, condition, count); } const base::HistogramTester& histogram_tester() const { return histogram_tester_; } // Unlike `CreateGuestBrowser()` which opens a blank tab, this opens a guest // profile and shows the Guest NTP. BrowserWindowInterface* CreateGuestBrowserAndLoadNTP() { base::test::TestFuture browser_future; profiles::SwitchToGuestProfile(browser_future.GetCallback()); BrowserWindowInterface* guest_browser = browser_future.Get(); CHECK(guest_browser); EXPECT_TRUE(guest_browser->GetProfile()->IsGuestSession()); content::WebContents* ntp_contents = guest_browser->GetTabStripModel()->GetActiveWebContents(); content::WaitForLoadStop(ntp_contents); CHECK(NewTabUI::IsNewTab(ntp_contents->GetURL())); return guest_browser; } private: web_app::OsIntegrationTestOverrideBlockingRegistration faked_os_integration_; base::AutoReset scoped_chrome_build_override_ = SearchEngineChoiceDialogServiceFactory:: ScopedChromeBuildOverrideForTesting( /*force_chrome_build=*/true); bool use_spy_service_; base::CallbackListSubscription create_services_subscription_; base::HistogramTester histogram_tester_; }; IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, RestoreBrowserWithMultipleTabs) { // Open 2 more tabs in addition to the existing tab. for (int i = 0; i < 2; i++) { ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::NEW_FOREGROUND_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP); } EXPECT_EQ(browser()->tab_strip_model()->count(), 3); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( browser()->GetProfile())); ASSERT_TRUE(service); // Make sure that the dialog gets opened only once and the display is // recorded. EXPECT_CALL(*service, RegisterDialog(_, _)).Times(1); CheckChoiceScreenWasDisplayedRecordedOnce(); QuitAndRestoreBrowser(browser()); ASSERT_TRUE(browser()); EXPECT_EQ(browser()->tab_strip_model()->count(), 3); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, BackgroundTab) { // Navigate the current tab to the settings page. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), GURL(chrome::kChromeUISettingsURL), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_EQ(browser()->tab_strip_model()->count(), 1); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( browser()->GetProfile())); ASSERT_TRUE(service); EXPECT_FALSE(service->IsShowingDialog(*browser())); // Load an eligible tab in the background, the dialog does not open. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::NEW_BACKGROUND_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); ASSERT_EQ(browser()->tab_strip_model()->count(), 2); EXPECT_FALSE(service->IsShowingDialog(*browser())); // Switch to the eligible tab after it's loaded, the dialog opens. browser()->tab_strip_model()->ActivateTabAt(1); ASSERT_EQ( browser()->tab_strip_model()->GetActiveWebContents()->GetVisibleURL(), chrome::ChromeUINewTabPageURLAsGURL()); EXPECT_TRUE(service->IsShowingDialog(*browser())); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, RestoreSessionWithMultipleBrowsers) { EXPECT_EQ(browser()->tab_strip_model()->count(), 1); Profile* profile = browser()->GetProfile(); // Open another browser with the same profile. Browser* new_browser = CreateBrowser(profile); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); // Make sure that we have 2 dialogs open, one for each browser. EXPECT_CALL(*service, RegisterDialog(_, _)).Times(2); // Make sure that the display was recorded only once. CheckChoiceScreenWasDisplayedRecordedOnce(); // Simulate an exit by shutting down the session service. If we don't do this // the first window close is treated as though the user closed the window // and won't be restored. SessionServiceFactory::ShutdownForProfile(profile); CloseBrowserSynchronously(new_browser); QuitAndRestoreBrowser(browser()); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); } IN_PROC_BROWSER_TEST_F( SearchEngineChoiceDialogBrowserTest, ComputeProfileManagementFlowConditions_AlreadyBeingShown) { Profile* profile = browser()->GetProfile(); SearchEngineChoiceDialogService* service = SearchEngineChoiceDialogServiceFactory::GetForProfile(profile); ASSERT_TRUE(service); EXPECT_EQ( regional_capabilities::SearchEngineChoiceScreenConditions::kEligible, service->ComputeProfileManagementFlowConditions()); // Register a dialog for `browser()`. EXPECT_TRUE(service->RegisterDialog(*browser(), base::DoNothing())); // With an open dialog registered, ComputeProfileManagementFlowConditions // should return kAlreadyBeingShown instead of crashing. EXPECT_EQ(regional_capabilities::SearchEngineChoiceScreenConditions:: kAlreadyBeingShown, service->ComputeProfileManagementFlowConditions()); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, BrowserIsRemovedFromListAfterClose) { Profile* profile = browser()->GetProfile(); Browser* new_browser = CreateBrowser(profile); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); // Navigate to a URL to display the dialog. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); // Check that both browsers are in the set. EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); EXPECT_EQ(service->GetNumberOfBrowsersWithDialogsOpen(), 2u); EXPECT_TRUE(service->IsShowingDialog(*browser())); EXPECT_TRUE(service->IsShowingDialog(*new_browser)); // Check that the open browser remains alone in the set. CloseBrowserSynchronously(new_browser); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); EXPECT_TRUE(service->IsShowingDialog(*browser())); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogsOnBrowsersWithSameProfileCloseAfterMakingChoice) { // Create 2 browsers with the same profile. Profile* first_profile = browser()->GetProfile(); Browser* first_browser_with_first_profile = browser(); Browser* second_browser_with_first_profile = CreateBrowser(first_profile); auto* first_profile_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(first_profile)); // Navigate to a URL to display the dialog. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); // Make sure that there are 2 dialogs open for that profile EXPECT_EQ(first_profile_service->GetNumberOfBrowsersWithDialogsOpen(), 2u); CheckChoiceScreenWasDisplayedRecordedOnce(); // Simulate a dialog closing event for the first profile and test that the // dialogs for that profile are closed. first_profile_service->NotifyChoiceMade( /*prepopulate_id=*/1, /*save_guest_mode_selection=*/false, EntryPoint::kDialog); CheckDefaultWasSetRecorded(); EXPECT_FALSE(first_profile_service->IsShowingDialog( *first_browser_with_first_profile)); EXPECT_FALSE(first_profile_service->IsShowingDialog( *second_browser_with_first_profile)); EXPECT_EQ(first_profile_service->GetNumberOfBrowsersWithDialogsOpen(), 0u); } // We don't run this test on ChromeOS because we can't create multiple // profiles. #if !BUILDFLAG(IS_CHROMEOS) IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogGetsDisplayedForAllProfiles) { // Start a first profile that will later show the dialog. Profile* first_profile = browser()->GetProfile(); Browser* browser_with_first_profile = browser(); auto* first_profile_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(first_profile)); ASSERT_TRUE(first_profile_service); // Create the second profile. ProfileManager* profile_manager = g_browser_process->profile_manager(); Profile* second_profile = &profiles::testing::CreateProfileSync( profile_manager, profile_manager->GenerateNextProfileDirectoryPath()); auto* second_profile_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( second_profile)); ASSERT_TRUE(second_profile_service); // Navigate to a URL to display the dialog in the first profile. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser_with_first_profile, chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_TRUE( first_profile_service->IsShowingDialog(*browser_with_first_profile)); CheckChoiceScreenWasDisplayedRecordedOnce(); // So far, no dialog check should have been failed based on a profile having // claimed the dialog. EXPECT_EQ(1, histogram_tester().GetBucketCount( search_engines:: kSearchEngineChoiceScreenNavigationConditionsHistogram, SearchEngineChoiceScreenConditions::kEligible)); // Open a browser with the second profile, it should open a dialog too. Browser* browser_with_second_profile = CreateBrowser(second_profile); EXPECT_TRUE( second_profile_service->IsShowingDialog(*browser_with_second_profile)); // An additional success record should have been made. histogram_tester().ExpectBucketCount( search_engines::kSearchEngineChoiceScreenEventsHistogram, search_engines::SearchEngineChoiceScreenEvents::kChoiceScreenWasDisplayed, 2); // Still expect no profile-based rejection. EXPECT_EQ(2, histogram_tester().GetBucketCount( search_engines:: kSearchEngineChoiceScreenNavigationConditionsHistogram, SearchEngineChoiceScreenConditions::kEligible)); } #endif IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, PRE_DialogDoesNotShowAgainAfterSettingPref) { Profile* profile = browser()->GetProfile(); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); // Navigate to a URL to display the dialog. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_TRUE(service->IsShowingDialog(*browser())); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kEligible, 1); // Choose the first search engine to close the dialog. TemplateURL* first_search_engine = service->GetSearchEngines().at(0); service->NotifyChoiceMade(first_search_engine->prepopulate_id(), /*save_guest_mode_selection=*/false, EntryPoint::kDialog); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogDoesNotShowAgainAfterSettingPref) { auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( browser()->GetProfile())); // Test that the search engine choice dialog service is null after relaunching // a browser with a profile in which the search engine choice was already // made. EXPECT_FALSE(service); } #if !BUILDFLAG(IS_CHROMEOS) IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogDoesNotOverlapWithProfileCustomizationDialog) { Profile* profile = browser()->GetProfile(); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); // Show the profile customization dialog. browser() ->GetFeatures() .signin_view_controller() ->ShowModalProfileCustomizationDialog( /*is_local_profile_creation=*/true); // Navigate to a URL ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_FALSE(service->IsShowingDialog(*browser())); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kSuppressedByOtherDialog, 1); } #endif // TODO(crbug.com/429600559): Re-implement this test and cover windows once a // non-flaky implementation is found. #if BUILDFLAG(IS_WIN) #define MAYBE_DialogDoesNotShowWithExtensionEnabledThatOverridesDSE \ DISABLED_DialogDoesNotShowWithExtensionEnabledThatOverridesDSE #else #define MAYBE_DialogDoesNotShowWithExtensionEnabledThatOverridesDSE \ DialogDoesNotShowWithExtensionEnabledThatOverridesDSE #endif IN_PROC_BROWSER_TEST_F( SearchEngineChoiceDialogBrowserTest, MAYBE_DialogDoesNotShowWithExtensionEnabledThatOverridesDSE) { Profile* profile = browser()->GetProfile(); auto* search_engine_choice_dialog_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); TemplateURLService* template_url_service = TemplateURLServiceFactory::GetForProfile(profile); ASSERT_TRUE(template_url_service->GetDefaultSearchProvider()); std::unique_ptr extension = GenerateDummyTemplateURLData("extension"); template_url_service->ApplyDefaultSearchChangeForTesting( extension.get(), DefaultSearchManager::FROM_EXTENSION); // Using a dedicated histogram tester for more more granular error reporting // in the checks below. // TODO(crbug.com/429600559): Revert to the usual one if we can make this // extension configuration more reliable. base::HistogramTester scoped_histogram_tester; // Navigate to a URL to display the dialog. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_FALSE( search_engine_choice_dialog_service->IsShowingDialog(*browser())); // TODO(crbug.com/429600559): Documenting a bug, this is not the right way to // set an extension-provided DSE. It needs to be registered in prefs first. // Also, DSE-controlling extensions are supported only on Mac & Win, which is // another source of no being able to properly test this flow. if (!template_url_service->GetDefaultSearchProvider()) { scoped_histogram_tester.ExpectUniqueSample( search_engines::kSearchEngineChoiceScreenNavigationConditionsHistogram, // Indicating that default search is disabled. SearchEngineChoiceScreenConditions::kControlledByPolicy, 1); } else { EXPECT_EQ(template_url_service->GetDefaultSearchProvider()->keyword(), u"extension"); scoped_histogram_tester.ExpectUniqueSample( search_engines::kSearchEngineChoiceScreenNavigationConditionsHistogram, SearchEngineChoiceScreenConditions::kExtensionControlled, 1); } } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogDoesNotShownForWebApp) { Profile* profile = browser()->GetProfile(); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); const GURL start_url("https://app.site.test/example/index"); const webapps::AppId app_id = InstallPWA(profile, start_url); // PWA browsers should not show the dialog. BrowserWindowInterface* app_browser = web_app::LaunchWebAppBrowserAndWait(profile, app_id); EXPECT_FALSE(service->IsShowingDialog(*app_browser)); // The same URL in the regular browser shows the dialog. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), start_url, WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_TRUE(service->IsShowingDialog(*browser())); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogNotShownOverSpecificBrowserTypes) { Profile* profile = browser()->GetProfile(); auto* search_engine_choice_dialog_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); BrowserWindowInterface* app_browser = CreateBrowserWindow(BrowserWindowCreateParams::CreateForApp( "Test", /*trusted_source=*/false, gfx::Rect(), profile, /*user_gesture=*/true)); chrome::AddTabAt(app_browser, GURL(), -1, true); EXPECT_EQ(app_browser->GetType(), BrowserWindowInterface::Type::TYPE_APP); GURL url = GURL("https://www.google.com/"); content::TestNavigationObserver observer(url); observer.StartWatchingNewWebContents(); NavigateParams params(app_browser, url, ui::PAGE_TRANSITION_LINK); params.window_action = NavigateParams::WindowAction::kShowWindow; params.disposition = WindowOpenDisposition::NEW_POPUP; Navigate(¶ms); // Wait for the URL to finish loading. observer.Wait(); // Navigate() should have opened a new `TYPE_APP_POPUP` window. BrowserWindowInterface* app_popup_browser = params.browser; EXPECT_EQ(app_popup_browser->GetType(), BrowserWindowInterface::Type::TYPE_APP_POPUP); ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); // Dialog shown over normal browser. EXPECT_TRUE(search_engine_choice_dialog_service->IsShowingDialog(*browser())); // Dialog not shown over browser of type `TYPE_APP_POPUP`. EXPECT_FALSE( search_engine_choice_dialog_service->IsShowingDialog(*app_popup_browser)); // Dialog not shown over browser of type `TYPE_APP` EXPECT_FALSE( search_engine_choice_dialog_service->IsShowingDialog(*app_browser)); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kUnsupportedBrowserType, 2); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, RecordingSearchEngineIsDoneAfterSettingDefault) { Profile* profile = browser()->GetProfile(); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); TemplateURLService* template_url_service = TemplateURLServiceFactory::GetForProfile(profile); // Navigate to a URL to display the dialog. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_TRUE(service->IsShowingDialog(*browser())); const TemplateURL* default_search_engine = template_url_service->GetDefaultSearchProvider(); const int default_search_engine_id = default_search_engine->prepopulate_id(); const int kBingId = 3; EXPECT_NE(default_search_engine_id, kBingId); // Set the pref and simulate a dialog closing event. service->NotifyChoiceMade(kBingId, /*save_guest_mode_selection=*/false, EntryPoint::kDialog); EXPECT_FALSE(service->IsShowingDialog(*browser())); histogram_tester().ExpectUniqueSample( search_engines::kSearchEngineChoiceScreenDefaultSearchEngineTypeHistogram, SearchEngineType::SEARCH_ENGINE_BING, 1); } #if !BUILDFLAG(IS_CHROMEOS) IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogIsDisplayedOnEveryGuestSession) { // Initial browser EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); BrowserWindowInterface* first_guest_session = CreateGuestBrowserAndLoadNTP(); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); auto* first_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( first_guest_session->GetProfile())); EXPECT_TRUE(first_service->IsShowingDialog(*first_guest_session)); // Complete the choice for the first guest profile. first_service->NotifyChoiceMade( TemplateURLPrepopulateData::bing.id, /*save_guest_mode_selection=*/false, SearchEngineChoiceDialogService::EntryPoint::kDialog); EXPECT_FALSE(first_service->IsShowingDialog(*first_guest_session)); CloseBrowserSynchronously(first_guest_session); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); BrowserWindowInterface* second_guest_session = CreateGuestBrowserAndLoadNTP(); auto* second_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( second_guest_session->GetProfile())); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); // The second guest profile still needs to choose again EXPECT_TRUE(second_service->IsShowingDialog(*second_guest_session)); second_service->NotifyChoiceMade( TemplateURLPrepopulateData::bing.id, /*save_guest_mode_selection=*/false, SearchEngineChoiceDialogService::EntryPoint::kDialog); EXPECT_FALSE(second_service->IsShowingDialog(*second_guest_session)); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kUsingPersistedGuestSessionChoice, 0); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, SearchEngineIsSavedBetweenGuestSessionsWithoutRestart) { // Initial browser EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); BrowserWindowInterface* first_guest_session = CreateGuestBrowserAndLoadNTP(); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); auto* first_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( first_guest_session->GetProfile())); EXPECT_TRUE(first_service->IsShowingDialog(*first_guest_session)); // Complete the choice for the first guest profile. first_service->NotifyChoiceMade( TemplateURLPrepopulateData::bing.id, /*save_guest_mode_selection=*/true, SearchEngineChoiceDialogService::EntryPoint::kDialog); EXPECT_FALSE(first_service->IsShowingDialog(*first_guest_session)); EXPECT_EQ(TemplateURLServiceFactory::GetForProfile( first_guest_session->GetProfile()) ->GetDefaultSearchProvider() ->data() .prepopulate_id, TemplateURLPrepopulateData::bing.id); CloseBrowserSynchronously(first_guest_session); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); BrowserWindowInterface* second_guest_session = CreateGuestBrowserAndLoadNTP(); auto* second_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( second_guest_session->GetProfile())); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); // The second guest profile still needs to choose again EXPECT_FALSE(second_service->IsShowingDialog(*second_guest_session)); EXPECT_EQ(TemplateURLServiceFactory::GetForProfile( second_guest_session->GetProfile()) ->GetDefaultSearchProvider() ->data() .prepopulate_id, TemplateURLPrepopulateData::bing.id); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kUsingPersistedGuestSessionChoice, 1); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, PRE_SearchEngineChoiceIsShownOnEachGuestSession) { // Initial browser EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); BrowserWindowInterface* guest_session = CreateGuestBrowserAndLoadNTP(); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); auto* first_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( guest_session->GetProfile())); // Complete the choice for the first guest profile and choose to NOT save the // choice between guest sessions. first_service->NotifyChoiceMade( TemplateURLPrepopulateData::bing.id, /*save_guest_mode_selection=*/false, SearchEngineChoiceDialogService::EntryPoint::kDialog); EXPECT_FALSE(first_service->IsShowingDialog(*guest_session)); EXPECT_EQ( TemplateURLServiceFactory::GetForProfile(guest_session->GetProfile()) ->GetDefaultSearchProvider() ->data() .prepopulate_id, TemplateURLPrepopulateData::bing.id); EXPECT_TRUE(guest_session->GetProfile()->GetPrefs()->HasPrefPath( prefs::kDefaultSearchProviderChoiceScreenCompletionTimestamp)); EXPECT_TRUE(guest_session->GetProfile()->GetPrefs()->HasPrefPath( DefaultSearchManager::kDefaultSearchProviderDataPrefName)); CloseBrowserSynchronously(guest_session); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, SearchEngineChoiceIsShownOnEachGuestSession) { BrowserWindowInterface* guest_session = CreateGuestBrowserAndLoadNTP(); EXPECT_FALSE(guest_session->GetProfile()->GetPrefs()->HasPrefPath( prefs::kDefaultSearchProviderChoiceScreenCompletionTimestamp)); EXPECT_FALSE(guest_session->GetProfile()->GetPrefs()->HasPrefPath( DefaultSearchManager::kDefaultSearchProviderDataPrefName)); auto* second_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( guest_session->GetProfile())); // On this new guest session the DSE effective is Google, until a choice is // made. EXPECT_FALSE(g_browser_process->local_state()->HasPrefPath( prefs::kDefaultSearchProviderGuestModePrepopulatedId)); EXPECT_EQ( TemplateURLServiceFactory::GetForProfile(guest_session->GetProfile()) ->GetDefaultSearchProvider() ->data() .prepopulate_id, TemplateURLPrepopulateData::google.id); // The choice was not persisted across Guest sessions, so the // the search engine choice dialog gets displayed again. ASSERT_TRUE(second_service); EXPECT_TRUE(second_service->IsShowingDialog(*guest_session)); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, PRE_SearchEngineIsSavedBetweenGuestSessionsIfNeeded) { // Initial browser EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); BrowserWindowInterface* guest_session = CreateGuestBrowserAndLoadNTP(); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 2u); auto* first_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( guest_session->GetProfile())); // Complete the choice for the first guest profile and choose to save the // choice between guest sessions. first_service->NotifyChoiceMade( TemplateURLPrepopulateData::bing.id, /*save_guest_mode_selection=*/true, SearchEngineChoiceDialogService::EntryPoint::kDialog); EXPECT_FALSE(first_service->IsShowingDialog(*guest_session)); EXPECT_EQ( TemplateURLServiceFactory::GetForProfile(guest_session->GetProfile()) ->GetDefaultSearchProvider() ->data() .prepopulate_id, TemplateURLPrepopulateData::bing.id); CloseBrowserSynchronously(guest_session); EXPECT_EQ(GlobalBrowserCollection::GetInstance()->GetSize(), 1u); } // TODO(crbug.com/431133510): Flakiness of this test is under observation. It // seems to be affected by dysfunctions in Guest profile cleanup between the // PRE_ and normal test phases. If it does get too flaky, please only disable // it. IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, SearchEngineIsSavedBetweenGuestSessionsIfNeeded) { BrowserWindowInterface* guest_session = CreateGuestBrowserAndLoadNTP(); auto* second_service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile( guest_session->GetProfile())); // The search engine choice dialog doesn't get displayed for the second guest // profile and the previously chosen default search engine is used. EXPECT_FALSE(second_service->IsShowingDialog(*guest_session)); EXPECT_EQ(g_browser_process->local_state()->GetInt64( prefs::kDefaultSearchProviderGuestModePrepopulatedId), TemplateURLPrepopulateData::bing.id); EXPECT_EQ( TemplateURLServiceFactory::GetForProfile(guest_session->GetProfile()) ->GetDefaultSearchProvider() ->data() .prepopulate_id, TemplateURLPrepopulateData::bing.id); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kUsingPersistedGuestSessionChoice, 1); } #endif IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogNotShownIfPolicyIsSet) { Profile* profile = browser()->GetProfile(); TemplateURLService* template_url_service = TemplateURLServiceFactory::GetForProfile(profile); // Set the default search provider via policy. TemplateURLData data; data.SetShortName(u"Policy Engine"); data.SetKeyword(u"policy"); data.SetURL("https://policy.com/url?bar={searchTerms}"); data.policy_origin = TemplateURLData::PolicyOrigin::kDefaultSearchProvider; TemplateURL* template_url = template_url_service->Add(std::make_unique(data)); template_url_service->SetUserSelectedDefaultSearchProvider(template_url); // Navigate to an eligible URL. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); EXPECT_FALSE(service->IsShowingDialog(*browser())); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kControlledByPolicy, 1); } IN_PROC_BROWSER_TEST_F(SearchEngineChoiceDialogBrowserTest, DialogNotShownForSmallHeightBrowserWindows) { NavigateParams params(browser(), chrome::ChromeUINewTabPageURLAsGURL(), ui::PAGE_TRANSITION_FIRST); params.window_action = NavigateParams::WindowAction::kShowWindow; params.disposition = WindowOpenDisposition::NEW_POPUP; params.window_features.bounds = gfx::Rect(0, 0, 200, 150); ui_test_utils::NavigateToURL(¶ms); Profile* profile = browser()->GetProfile(); auto* service = static_cast( SearchEngineChoiceDialogServiceFactory::GetForProfile(profile)); EXPECT_FALSE(service->IsShowingDialog(*browser())); CheckNavigationConditionRecorded( SearchEngineChoiceScreenConditions::kBrowserWindowTooSmall, 1); } struct RepromptTestParam { const std::string test_suffix; const bool expect_prompt; const bool select_google_in_pre = true; }; const RepromptTestParam kTestParams[] = { {.test_suffix = "AllProfiles", .expect_prompt = true}, {.test_suffix = "Skip3p", .expect_prompt = false, .select_google_in_pre = false}, {.test_suffix = "Skip3pButPickGoogle", .expect_prompt = true, .select_google_in_pre = true}, }; class SearchEngineRepromptBrowserTest : public SearchEngineChoiceDialogBrowserTest, public WithParamInterface { public: SearchEngineRepromptBrowserTest() : SearchEngineChoiceDialogBrowserTest( /*use_spy_service=*/false) { // The param looks like: {"*":"6.7.8.9"}, where 6.7.8.9 is the current // Chrome version, and * is the wildcard country. std::string reprompt_param = base::StrCat({"{\"*\":\"", version_info::GetVersionNumber(), "\"}"}); base::FieldTrialParams field_trial_params = { {switches::kSearchEngineChoiceTriggerRepromptParams.name, reprompt_param}}; feature_list_.InitWithFeaturesAndParameters( /* enabled_features= */ {{switches::kSearchEngineChoiceTriggerReprompt, std::move(field_trial_params)}, {switches::kInvalidateSearchEngineChoiceOnDeviceRestoreDetection, {}}}, /* disabled_features= */ {}); } bool expect_prompt() const { return GetParam().expect_prompt; } bool select_google_in_pre() const { return GetParam().select_google_in_pre; } private: base::test::ScopedFeatureList feature_list_; }; IN_PROC_BROWSER_TEST_P(SearchEngineRepromptBrowserTest, PRE_Reprompt) { Profile* profile = browser()->GetProfile(); ASSERT_TRUE(profile->IsNewProfile()); auto* service = SearchEngineChoiceDialogServiceFactory::GetForProfile(profile); ASSERT_TRUE(service); EXPECT_EQ(service->ComputeDialogConditions(*browser()), SearchEngineChoiceScreenConditions::kEligible); // Navigate to a URL. The first load happened while the dialog was // force-disabled for testing. ASSERT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); EXPECT_TRUE(service->IsShowingDialog(*browser())); // Make a choice by grabbing the ID for one of the search engines in the // displayed list. int prepopulate_id = service->GetSearchEngines().at(0)->prepopulate_id(); if (select_google_in_pre()) { prepopulate_id = TemplateURLPrepopulateData::google.id; } else if (prepopulate_id == TemplateURLPrepopulateData::google.id) { // The first item was Google, pick the second then. prepopulate_id = service->GetSearchEngines().at(1)->prepopulate_id(); } service->NotifyChoiceMade(prepopulate_id, /*save_guest_mode_selection=*/false, EntryPoint::kDialog); // Choice prefs have been written. ASSERT_NE(profile->GetPrefs()->GetInt64( prefs::kDefaultSearchProviderChoiceScreenCompletionTimestamp), 0); ASSERT_EQ(profile->GetPrefs()->GetString( prefs::kDefaultSearchProviderChoiceScreenCompletionVersion), version_info::GetVersionNumber()); // Change the choice version to an earlier version, so that it can // re-trigger. profile->GetPrefs()->SetString( prefs::kDefaultSearchProviderChoiceScreenCompletionVersion, "10.1.2.3"); } IN_PROC_BROWSER_TEST_P(SearchEngineRepromptBrowserTest, Reprompt) { Profile* profile = browser()->GetProfile(); EXPECT_FALSE(profile->IsNewProfile()); auto* service = SearchEngineChoiceDialogServiceFactory::GetForProfile(profile); EXPECT_TRUE(service); EXPECT_TRUE(ui_test_utils::NavigateToURLWithDisposition( browser(), chrome::ChromeUINewTabPageURLAsGURL(), WindowOpenDisposition::CURRENT_TAB, ui_test_utils::BROWSER_TEST_WAIT_FOR_LOAD_STOP)); if (expect_prompt()) { EXPECT_TRUE(service->IsShowingDialog(*browser())); } else { EXPECT_FALSE(service->IsShowingDialog(*browser())); } } INSTANTIATE_TEST_SUITE_P(, SearchEngineRepromptBrowserTest, ValuesIn(kTestParams), [](const TestParamInfo& info) { return info.param.test_suffix; });