Reland "[omnibox] Rename the ZeroSuggestProvider::ResultType values"

This is a reland of a9d56928

Original change's description:
> [omnibox] Rename the ZeroSuggestProvider::ResultType values
> 
> This CL renames the ZeroSuggestProvider::ResultType values to be
> more descriptive, and adds more commentary.
> 
> They used to imply that we asked the default search provider for
> zero-suggestions, which was sometimes misleading, since that's not
> always true.
> 
> Bug: 963173
> Change-Id: I85a55cb57749441d2adfdb53642247fd055b7d9a
> Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1631903
> Commit-Queue: Tommy Li <tommycli@chromium.org>
> Reviewed-by: Justin Donnelly <jdonnelly@chromium.org>
> Cr-Commit-Position: refs/heads/master@{#665330}

Bug: 963173
Change-Id: I206a4fd36189e2400bfd754ac4f0fba4ab076075
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1640160
Commit-Queue: Tommy Li <tommycli@chromium.org>
Reviewed-by: Justin Donnelly <jdonnelly@chromium.org>
Cr-Commit-Position: refs/heads/master@{#666125}

components/omnibox/browser/zero_suggest_provider.cc

@@ -180,9 +180,8 @@ void ZeroSuggestProvider::Start(const AutocompleteInput& input,
     return;
   }
 
-  const std::string current_url = result_type_running_ == DEFAULT_SERP_FOR_URL
-                                      ? current_query_
-                                      : std::string();
+  const std::string current_url =
+      result_type_running_ == REMOTE_SEND_URL ? current_query_ : std::string();
   // Create a request for suggestions, routing completion to
   // OnContextualSuggestionsLoaderAvailable.
   client()
@@ -350,7 +349,7 @@ bool ZeroSuggestProvider::UpdateResults(const std::string& json_data) {
 
   // When running the personalized service, we want to store suggestion
   // responses if non-empty.
-  if (result_type_running_ == DEFAULT_SERP && !json_data.empty()) {
+  if (result_type_running_ == REMOTE_NO_URL && !json_data.empty()) {
     client()->GetPrefs()->SetString(omnibox::kZeroSuggestCachedResults,
                                     json_data);
 
@@ -564,7 +563,7 @@ bool ZeroSuggestProvider::AllowZeroSuggestSuggestions(
 }
 
 void ZeroSuggestProvider::MaybeUseCachedSuggestions() {
-  if (result_type_running_ != DEFAULT_SERP)
+  if (result_type_running_ != REMOTE_NO_URL)
     return;
 
   std::string json_data =
@@ -590,7 +589,6 @@ ZeroSuggestProvider::ResultType ZeroSuggestProvider::TypeOfResultToRun(
   const bool can_send_current_url = CanSendURL(
       current_url, suggest_url, default_provider, current_page_classification_,
       template_url_service->search_terms_data(), client());
-
   // Collect metrics on eligibility.
   GURL arbitrary_insecure_url(kArbitraryInsecureUrlString);
   ZeroSuggestEligibility eligibility = ZeroSuggestEligibility::ELIGIBLE;
@@ -614,7 +612,7 @@ ZeroSuggestProvider::ResultType ZeroSuggestProvider::TypeOfResultToRun(
 
   if (current_page_classification_ ==
       metrics::OmniboxEventProto::CHROMEOS_APP_LIST) {
-    return DEFAULT_SERP;
+    return REMOTE_NO_URL;
   }
 
   if (OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial(
@@ -623,7 +621,7 @@ ZeroSuggestProvider::ResultType ZeroSuggestProvider::TypeOfResultToRun(
                client()->GetPrefs(), client()->IsAuthenticated(),
                template_url_service)
                ? MOST_VISITED
-               : DEFAULT_SERP;
+               : REMOTE_NO_URL;
   }
 
   if (OmniboxFieldTrial::InZeroSuggestMostVisitedWithoutSerpFieldTrial(
@@ -642,7 +640,7 @@ ZeroSuggestProvider::ResultType ZeroSuggestProvider::TypeOfResultToRun(
   if (can_send_current_url &&
       OmniboxFieldTrial::InZeroSuggestRemoteSendURLFieldTrial(
           current_page_classification_)) {
-    return DEFAULT_SERP_FOR_URL;
+    return REMOTE_SEND_URL;
   }
 
   return NONE;

components/omnibox/browser/zero_suggest_provider.h

@@ -64,6 +64,7 @@ class ZeroSuggestProvider : public BaseSearchProvider {
   void ResetSession() override;
 
  private:
+  FRIEND_TEST_ALL_PREFIXES(ZeroSuggestProviderTest, TypeOfResultToRun);
   FRIEND_TEST_ALL_PREFIXES(ZeroSuggestProviderTest,
                            TestStartWillStopForSomeInput);
   ZeroSuggestProvider(AutocompleteProviderClient* client,
@@ -76,12 +77,19 @@ class ZeroSuggestProvider : public BaseSearchProvider {
   // at any time.
   enum ResultType {
     NONE,
-    DEFAULT_SERP,          // The default search provider is queried for
-                           // zero-suggest suggestions.
-    DEFAULT_SERP_FOR_URL,  // The default search provider is queried for
-                           // zero-suggest suggestions that are specific
-                           // to the visited URL.
-    MOST_VISITED
+
+    // A remote endpoint (usually the default search provider) is queried for
+    // suggestions. The endpoint is sent the user's authentication state, but
+    // not sent the current URL.
+    REMOTE_NO_URL,
+
+    // A remote endpoint (usually the default search provider) is queried for
+    // suggestions. The endpoint is sent the user's authentication state and
+    // the current URL.
+    REMOTE_SEND_URL,
+
+    // Gets the most visited sites from local history.
+    MOST_VISITED,
   };
 
   // BaseSearchProvider:
@@ -177,7 +185,8 @@ class ZeroSuggestProvider : public BaseSearchProvider {
 
   // The type of page the user is viewing (a search results page doing search
   // term replacement, an arbitrary URL, etc.).
-  metrics::OmniboxEventProto::PageClassification current_page_classification_;
+  metrics::OmniboxEventProto::PageClassification current_page_classification_ =
+      metrics::OmniboxEventProto::INVALID_SPEC;
 
   // Copy of OmniboxEditModel::permanent_text_.
   base::string16 permanent_text_;

components/omnibox/browser/zero_suggest_provider_unittest.cc

@@ -14,6 +14,7 @@
 #include "base/strings/utf_string_conversions.h"
 #include "base/test/scoped_feature_list.h"
 #include "base/test/scoped_task_environment.h"
+#include "build/build_config.h"
 #include "components/history/core/browser/top_sites.h"
 #include "components/omnibox/browser/autocomplete_provider_listener.h"
 #include "components/omnibox/browser/mock_autocomplete_provider_client.h"
@@ -151,7 +152,6 @@ class ZeroSuggestProviderTest : public testing::Test,
 
   void CreatePersonalizedFieldTrial();
   void CreateMostVisitedFieldTrial();
-  void CreateContextualSuggestFieldTrial();
   void SetZeroSuggestVariantForAllContexts(const std::string& variant);
 
   base::test::ScopedTaskEnvironment scoped_task_environment_;
@@ -205,6 +205,36 @@ void ZeroSuggestProviderTest::SetZeroSuggestVariantForAllContexts(
         variant}});
 }
 
+TEST_F(ZeroSuggestProviderTest, TypeOfResultToRun) {
+  GURL current_url = GURL("https://example.com/");
+  GURL suggest_url = GURL("https://www.google.com/complete/?q={searchTerms}");
+
+  EXPECT_CALL(*client_, IsAuthenticated())
+      .WillRepeatedly(testing::Return(true));
+  EXPECT_CALL(*client_, IsPersonalizedUrlDataCollectionActive())
+      .WillRepeatedly(testing::Return(true));
+
+#if defined(OS_IOS) || defined(OS_ANDROID)
+  EXPECT_EQ(ZeroSuggestProvider::ResultType::MOST_VISITED,
+            provider_->TypeOfResultToRun(current_url, suggest_url));
+#else
+  EXPECT_EQ(ZeroSuggestProvider::ResultType::NONE,
+            provider_->TypeOfResultToRun(current_url, suggest_url));
+#endif
+
+  SetZeroSuggestVariantForAllContexts("RemoteSendURL");
+  EXPECT_EQ(ZeroSuggestProvider::ResultType::REMOTE_SEND_URL,
+            provider_->TypeOfResultToRun(current_url, suggest_url));
+
+  CreatePersonalizedFieldTrial();
+  EXPECT_EQ(ZeroSuggestProvider::ResultType::REMOTE_NO_URL,
+            provider_->TypeOfResultToRun(current_url, suggest_url));
+
+  CreateMostVisitedFieldTrial();
+  EXPECT_EQ(ZeroSuggestProvider::ResultType::MOST_VISITED,
+            provider_->TypeOfResultToRun(current_url, suggest_url));
+}
+
 TEST_F(ZeroSuggestProviderTest, TestDoesNotReturnMatchesForPrefix) {
   CreatePersonalizedFieldTrial();