Add search result type getter to all SearchProviders.

The plan for integration testing in the launcher is roughly as follows:

 1. Give search providers a method to identify themselves with a
    search result type (<- this CL).
 2. Use the getter to inform the Mixer _which_ search provider is
    triggering a OnResultsChanged call.
 3. Add hooks into the Mixer allowing a RunLoop to wait until a list of
    providers have created results and called OnResultsChanged.
 4. Use the RunLoop hooks to build integration tests that inspect the
    result of a query after all relevant providers have completed.

This CL adds a getter method that lets each SearchProvider identify
itself with a particular search result type. Two providers,
SettingsShortcutProvider and ArcAppDataSearchProvider, don't
appear to have enum entries for their result types. I've given them
kUnknown for now, and we can update them if they ever need to be
integration tested.

Due to the asynchrony of the search backend, we need this kind of "wait
until providers are done" system in order to know how long to wait for
in a browser test, as browser tests don't support
ScopedTasksEnvironments and the like.

In future we could use this system to optimize search ranking, as we
would know which results are new, and could avoid re-ranking already
ranked results.

Bug: 1086713
Change-Id: Icac3efaaf963a4b5e445dd0a0de8fd435fd27f61
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2214736Reviewed-by: Jia Meng <jiameng@chromium.org>
Commit-Queue: Tony Yeoman <tby@chromium.org>
Cr-Commit-Position: refs/heads/master@{#774434}

chrome/browser/ui/app_list/search/answer_card/answer_card_search_provider.cc

@@ -35,6 +35,10 @@ AnswerCardSearchProvider::AnswerCardSearchProvider(
 
 AnswerCardSearchProvider::~AnswerCardSearchProvider() = default;
 
+ash::AppListSearchResultType AnswerCardSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kAnswerCard;
+}
+
 void AnswerCardSearchProvider::Start(const base::string16& query) {
   if (!model_updater_->SearchEngineIsGoogle()) {
     UpdateQuery(base::string16());

chrome/browser/ui/app_list/search/answer_card/answer_card_search_provider.h

@@ -29,6 +29,7 @@ class AnswerCardSearchProvider : public SearchProvider {
 
   // SearchProvider overrides:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   void UpdateQuery(const base::string16& query);

chrome/browser/ui/app_list/search/app_search_provider.cc

@@ -448,6 +448,10 @@ void AppSearchProvider::ViewClosing() {
     data_source->ViewClosing();
 }
 
+ash::AppListSearchResultType AppSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kInstalledApp;
+}
+
 void AppSearchProvider::RefreshAppsAndUpdateResults() {
   // Clear any pending requests if any.
   refresh_apps_factory_.InvalidateWeakPtrs();

chrome/browser/ui/app_list/search/app_search_provider.h

@@ -48,6 +48,7 @@ class AppSearchProvider : public SearchProvider {
   // SearchProvider overrides:
   void Start(const base::string16& query) override;
   void ViewClosing() override;
+  ash::AppListSearchResultType ResultType() override;
 
   // Refreshes apps and updates results inline
   void RefreshAppsAndUpdateResults();

chrome/browser/ui/app_list/search/arc/arc_app_data_search_provider.cc

@@ -34,6 +34,10 @@ ArcAppDataSearchProvider::ArcAppDataSearchProvider(
 
 ArcAppDataSearchProvider::~ArcAppDataSearchProvider() = default;
 
+ash::AppListSearchResultType ArcAppDataSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kUnknown;
+}
+
 void ArcAppDataSearchProvider::Start(const base::string16& query) {
   arc::mojom::AppInstance* app_instance =
       arc::ArcServiceManager::Get()

chrome/browser/ui/app_list/search/arc/arc_app_data_search_provider.h

@@ -24,6 +24,7 @@ class ArcAppDataSearchProvider : public SearchProvider {
 
   // SearchProvider:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   void OnResults(arc::mojom::AppDataRequestState state,

chrome/browser/ui/app_list/search/arc/arc_app_reinstall_search_provider.cc

@@ -237,6 +237,10 @@ void ArcAppReinstallSearchProvider::StopRepeatingFetch() {
   UpdateResults();
 }
 
+ash::AppListSearchResultType ArcAppReinstallSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kPlayStoreReinstallApp;
+}
+
 void ArcAppReinstallSearchProvider::Start(const base::string16& query) {
   if (query_is_empty_ == query.empty())
     return;

chrome/browser/ui/app_list/search/arc/arc_app_reinstall_search_provider.h

@@ -75,6 +75,7 @@ class ArcAppReinstallSearchProvider
 
   // SearchProvider:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
   // Used by unit tests. SearchProvider takes ownership of pointer.
   void SetTimerForTesting(std::unique_ptr<base::RepeatingTimer> timer);

chrome/browser/ui/app_list/search/arc/arc_app_shortcuts_search_provider.cc

@@ -28,6 +28,10 @@ ArcAppShortcutsSearchProvider::ArcAppShortcutsSearchProvider(
 
 ArcAppShortcutsSearchProvider::~ArcAppShortcutsSearchProvider() = default;
 
+ash::AppListSearchResultType ArcAppShortcutsSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kArcAppShortcut;
+}
+
 void ArcAppShortcutsSearchProvider::Start(const base::string16& query) {
   arc::mojom::AppInstance* app_instance =
       arc::ArcServiceManager::Get()

chrome/browser/ui/app_list/search/arc/arc_app_shortcuts_search_provider.h

@@ -27,6 +27,7 @@ class ArcAppShortcutsSearchProvider : public SearchProvider {
 
   // SearchProvider:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   void OnGetAppShortcutGlobalQueryItems(

chrome/browser/ui/app_list/search/arc/arc_playstore_search_provider.cc

@@ -94,6 +94,10 @@ ArcPlayStoreSearchProvider::ArcPlayStoreSearchProvider(
 
 ArcPlayStoreSearchProvider::~ArcPlayStoreSearchProvider() = default;
 
+ash::AppListSearchResultType ArcPlayStoreSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kPlayStoreApp;
+}
+
 void ArcPlayStoreSearchProvider::Start(const base::string16& query) {
   last_query_ = query;
 

chrome/browser/ui/app_list/search/arc/arc_playstore_search_provider.h

@@ -30,6 +30,7 @@ class ArcPlayStoreSearchProvider : public SearchProvider {
 
   // SearchProvider:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   void OnResults(const base::string16& query,

chrome/browser/ui/app_list/search/assistant_search_provider.cc

@@ -131,6 +131,10 @@ AssistantSearchProvider::~AssistantSearchProvider() {
   }
 }
 
+ash::AppListSearchResultType AssistantSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kAssistantChip;
+}
+
 void AssistantSearchProvider::OnAssistantControllerDestroying() {
   ash::AssistantSuggestionsController::Get()->GetModel()->RemoveObserver(this);
   assistant_state_observer_.Remove(ash::AssistantState::Get());

chrome/browser/ui/app_list/search/assistant_search_provider.h

@@ -33,6 +33,7 @@ class AssistantSearchProvider : public SearchProvider,
  private:
   // SearchProvider:
   void Start(const base::string16& query) override {}
+  ash::AppListSearchResultType ResultType() override;
 
   // ash::AssistantControllerObserver:
   void OnAssistantControllerDestroying() override;

chrome/browser/ui/app_list/search/drive_quick_access_provider.cc

@@ -135,6 +135,10 @@ void DriveQuickAccessProvider::StartSearchController() {
   search_controller_->Start(base::string16());
 }
 
+ash::AppListSearchResultType DriveQuickAccessProvider::ResultType() {
+  return ash::AppListSearchResultType::kDriveQuickAccess;
+}
+
 void DriveQuickAccessProvider::Start(const base::string16& query) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
   ClearResultsSilently();

chrome/browser/ui/app_list/search/drive_quick_access_provider.h

@@ -34,6 +34,7 @@ class DriveQuickAccessProvider : public SearchProvider,
   // SearchProvider:
   void Start(const base::string16& query) override;
   void AppListShown() override;
+  ash::AppListSearchResultType ResultType() override;
 
   // drive::DriveIntegrationServiceObserver:
   void OnFileSystemMounted() override;

chrome/browser/ui/app_list/search/launcher_search/launcher_search_provider.cc

@@ -74,6 +74,10 @@ void LauncherSearchProvider::SetSearchResults(
   SwapResults(&new_results);
 }
 
+ash::AppListSearchResultType LauncherSearchProvider::ResultType() {
+  return ash::AppListSearchResultType::kLauncher;
+}
+
 void LauncherSearchProvider::DelayQuery(const base::Closure& closure) {
   base::TimeDelta delay =
       base::TimeDelta::FromMilliseconds(kLauncherSearchProviderQueryDelayInMs);

chrome/browser/ui/app_list/search/launcher_search/launcher_search_provider.h

@@ -31,6 +31,7 @@ class LauncherSearchProvider : public SearchProvider {
   void SetSearchResults(
       const extensions::ExtensionId& extension_id,
       std::vector<std::unique_ptr<LauncherSearchResult>> extension_results);
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   // Delays query for |kLauncherSearchProviderQueryDelayInMs|. This dispatches

chrome/browser/ui/app_list/search/omnibox_provider.cc

@@ -63,6 +63,10 @@ void OmniboxProvider::Start(const base::string16& query) {
   controller_->Start(input);
 }
 
+ash::AppListSearchResultType OmniboxProvider::ResultType() {
+  return ash::AppListSearchResultType::kOmnibox;
+}
+
 void OmniboxProvider::PopulateFromACResult(const AutocompleteResult& result) {
   SearchProvider::Results new_results;
   new_results.reserve(result.size());

chrome/browser/ui/app_list/search/omnibox_provider.h

@@ -28,6 +28,7 @@ class OmniboxProvider : public SearchProvider,
 
   // SearchProvider overrides:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   // Populates result list from AutocompleteResult.

chrome/browser/ui/app_list/search/os_settings_provider.cc

@@ -165,6 +165,10 @@ OsSettingsProvider::OsSettingsProvider(Profile* profile)
 
 OsSettingsProvider::~OsSettingsProvider() = default;
 
+ash::AppListSearchResultType OsSettingsProvider::ResultType() {
+  return ash::AppListSearchResultType::kOsSettings;
+}
+
 void OsSettingsProvider::Start(const base::string16& query) {
   if (!search_handler_)
     return;

chrome/browser/ui/app_list/search/os_settings_provider.h

@@ -68,6 +68,7 @@ class OsSettingsProvider : public SearchProvider,
 
   // SearchProvider:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
   // apps::AppRegistryCache::Observer:
   void OnAppUpdate(const apps::AppUpdate& update) override;

chrome/browser/ui/app_list/search/search_provider.h

@@ -6,8 +6,10 @@
 #define CHROME_BROWSER_UI_APP_LIST_SEARCH_SEARCH_PROVIDER_H_
 
 #include <memory>
+#include <string>
 #include <vector>
 
+#include "ash/public/cpp/app_list/app_list_types.h"
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/strings/string16.h"
@@ -38,6 +40,8 @@ class SearchProvider {
   // Invoked when the app list is shown. This can optionally be used by a
   // provider to eg. warm up a cache of results.
   virtual void AppListShown() {}
+  // Returns the main result type created by this provider.
+  virtual ash::AppListSearchResultType ResultType() = 0;
 
   void set_result_changed_callback(const ResultChangedCallback& callback) {
     result_changed_callback_ = callback;

chrome/browser/ui/app_list/search/settings_shortcut/settings_shortcut_provider.cc

@@ -35,4 +35,8 @@ void SettingsShortcutProvider::Start(const base::string16& query) {
   SwapResults(&search_results);
 }
 
+ash::AppListSearchResultType SettingsShortcutProvider::ResultType() {
+  return ash::AppListSearchResultType::kUnknown;
+}
+
 }  // namespace app_list

chrome/browser/ui/app_list/search/settings_shortcut/settings_shortcut_provider.h

@@ -23,6 +23,7 @@ class SettingsShortcutProvider : public SearchProvider {
 
   // SearchProvider overrides:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
  private:
   Profile* const profile_;

chrome/browser/ui/app_list/search/tests/mixer_unittest.cc

@@ -30,7 +30,7 @@ class FakeAppListModelUpdater;
 namespace app_list {
 namespace test {
 
-using ResultType = ash::AppListSearchResultType;
+using SearchResultType = ash::AppListSearchResultType;
 
 // Maximum number of results to show in each mixer group.
 const size_t kMaxAppsGroupResults = 4;
@@ -72,7 +72,7 @@ int TestSearchResult::instantiation_count = 0;
 
 class TestSearchProvider : public SearchProvider {
  public:
-  TestSearchProvider(const std::string& prefix, ResultType result_type)
+  TestSearchProvider(const std::string& prefix, SearchResultType result_type)
       : prefix_(prefix),
         count_(0),
         bad_relevance_range_(false),
@@ -108,6 +108,10 @@ class TestSearchProvider : public SearchProvider {
     }
   }
 
+  ash::AppListSearchResultType ResultType() override {
+    return ash::AppListSearchResultType::kUnknown;
+  }
+
   void set_prefix(const std::string& prefix) { prefix_ = prefix; }
   void SetDisplayType(ChromeSearchResult::DisplayType display_type) {
     display_type_ = display_type;
@@ -126,7 +130,7 @@ class TestSearchProvider : public SearchProvider {
   bool small_relevance_range_;
   bool last_result_has_display_index_;
   ChromeSearchResult::DisplayType display_type_;
-  ResultType result_type_;
+  SearchResultType result_type_;
 
   DISALLOW_COPY_AND_ASSIGN(TestSearchProvider);
 };
@@ -140,12 +144,12 @@ class MixerTest : public testing::Test {
   void SetUp() override {
     model_updater_ = std::make_unique<FakeAppListModelUpdater>();
 
-    providers_.push_back(
-        std::make_unique<TestSearchProvider>("app", ResultType::kInternalApp));
-    providers_.push_back(
-        std::make_unique<TestSearchProvider>("omnibox", ResultType::kOmnibox));
     providers_.push_back(std::make_unique<TestSearchProvider>(
-        "playstore", ResultType::kPlayStoreApp));
+        "app", SearchResultType::kInternalApp));
+    providers_.push_back(std::make_unique<TestSearchProvider>(
+        "omnibox", SearchResultType::kOmnibox));
+    providers_.push_back(std::make_unique<TestSearchProvider>(
+        "playstore", SearchResultType::kPlayStoreApp));
   }
 
   void CreateMixer() {

chrome/browser/ui/app_list/search/zero_state_file_provider.cc

@@ -83,6 +83,10 @@ ZeroStateFileProvider::ZeroStateFileProvider(Profile* profile)
 
 ZeroStateFileProvider::~ZeroStateFileProvider() = default;
 
+ash::AppListSearchResultType ZeroStateFileProvider::ResultType() {
+  return ash::AppListSearchResultType::kZeroStateFile;
+}
+
 void ZeroStateFileProvider::Start(const base::string16& query) {
   query_start_time_ = base::TimeTicks::Now();
   ClearResultsSilently();

chrome/browser/ui/app_list/search/zero_state_file_provider.h

@@ -42,7 +42,9 @@ class ZeroStateFileProvider : public SearchProvider,
   explicit ZeroStateFileProvider(Profile* profile);
   ~ZeroStateFileProvider() override;
 
+  // SearchProvider:
   void Start(const base::string16& query) override;
+  ash::AppListSearchResultType ResultType() override;
 
   // file_manager::file_tasks::FileTaskObserver:
   void OnFilesOpened(const std::vector<FileOpenEvent>& file_opens) override;