Omnibox - Warm Up PSuggest on Focus

components/omnibox/browser/search_provider.h

 // Copyright (c) 2012 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.
 //
 // This file contains the Search autocomplete provider.  This provider is
 // responsible for all autocomplete entries that start with "Search <engine>
 // for ...", including searching for the current input string, search
 // history, and search suggestions.  An instance of it gets created and
 // managed by the autocomplete controller.
 
@@ skipping 79 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInline);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInlineDomainClassify);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInlineSchemeSubstring);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, SuggestRelevanceExperiment);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, TestDeleteMatch);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, SuggestQueryUsesToken);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, SessionToken);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, AnswersCache);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, RemoveExtraAnswers);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, DoesNotProvideOnFocus);
+  FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, SendsWarmUpRequestOnFocus);
   FRIEND_TEST_ALL_PREFIXES(InstantExtendedPrefetchTest, ClearPrefetchedResults);
   FRIEND_TEST_ALL_PREFIXES(InstantExtendedPrefetchTest, SetPrefetchQuery);
 
   // Manages the providers (TemplateURLs) used by SearchProvider. Two providers
   // may be used:
   // . The default provider. This corresponds to the user's default search
   //   engine. This is always used, except for the rare case of no default
   //   engine.
   // . The keyword provider. This is used if the user has typed in a keyword.
   class Providers {
@@ skipping 78 matching lines @@
   // Called after ParseSuggestResults to rank the |results|.
   void SortResults(bool is_keyword, SearchSuggestionParser::Results* results);
 
   // Records UMA statistics about a suggest server response.
   void LogFetchComplete(bool success, bool is_keyword);
 
   // Updates |matches_| from the latest results; applies calculated relevances
   // if suggested relevances cause undesirable behavior. Updates |done_|.
   void UpdateMatches();
 
+  // Check constraints that may be violated by suggested relevances and revises/

[Peter Kasting, 2017/03/02 22:50:42]

Nit: Check -> Checks

[Mark P, 2017/03/03 22:12:24]

Done.

+  // rolls back the suggested relevance scores to make all constraints old.

[Peter Kasting, 2017/03/02 22:50:42]

Nit: old -> hold

[Mark P, 2017/03/03 22:12:24]

Done.

+  void EnforceConstraints();
+
+  // Record the top suggestion (if any) for future use.  SearchProvider tries

[Peter Kasting, 2017/03/02 22:50:42]

Nit: Record -> Records

[Mark P, 2017/03/03 22:12:24]

Done.

+  // to ensure that an inline autocomplete suggestion does not change
+  // asynchronously.
+  void RecordTopSuggestion();
+
   // Called when |timer_| expires.  Sends the suggest requests.
   // If |query_is_private|, the function doesn't send this query to the default
   // provider.
   void Run(bool query_is_private);
 
   // Runs the history query, if necessary. The history query is synchronous.
   // This does not update |done_|.
   void DoHistoryQuery(bool minimal_changes);
 
   // Returns the time to delay before sending the Suggest request.
   base::TimeDelta GetSuggestQueryDelay() const;
 
   // Determines whether an asynchronous subcomponent query should run for the
   // current input.  If so, starts it if necessary; otherwise stops it.
   // NOTE: This function does not update |done_|.  Callers must do so.
   void StartOrStopSuggestQuery(bool minimal_changes);
 
   // Stops |fetcher| if it's running.  This includes resetting the scoped_ptr.
   void CancelFetcher(std::unique_ptr<net::URLFetcher>* fetcher);
 
   // Returns true when the current query can be sent to at least one suggest
   // service.  This will be false for example when suggest is disabled.  In
   // the process, calculates whether the query may contain potentionally
   // private data and stores the result in |is_query_private|; such queries
   // should not be sent to the default search engine.
   bool IsQuerySuitableForSuggest(bool* query_is_private) const;
 
   // Returns true if sending the query to a suggest server may leak sensitive
-  // information (and hence the suggest request shouldn't be sent).
+  // information (and hence the suggest request shouldn't be sent).  In
+  // particular, if the input type might be a URL, we take extra care so that
+  // it isn't sent to the server.
   bool IsQueryPotentionallyPrivate() const;
 
   // Remove existing keyword results if the user is no longer in keyword mode,
   // and, if |minimal_changes| is false, revise the existing results to
   // indicate they were received before the last keystroke.
   void UpdateAllOldResults(bool minimal_changes);
 
   // Given new asynchronous results, ensure that we don't clobber the current
   // top results, which were determined synchronously on the last keystroke.
   void PersistTopSuggestions(SearchSuggestionParser::Results* results);
@@ skipping 163 matching lines @@
   base::TimeTicks token_expiration_time_;
 
   // Answers prefetch management.
   AnswersCache answers_cache_;  // Cache for last answers seen.
   AnswersQueryData prefetch_data_;  // Data to use for query prefetching.
 
   DISALLOW_COPY_AND_ASSIGN(SearchProvider);
 };
 
 #endif  // COMPONENTS_OMNIBOX_BROWSER_SEARCH_PROVIDER_H_