Omnibox: Prevent Asynchronous Suggestions from Changing Default Match

chrome/browser/autocomplete/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 51 matching lines @@
   void set_current_page_url(const GURL& current_page_url) {
     current_page_url_ = current_page_url;
   }
 
  protected:
   virtual ~SearchProvider();
 
  private:
   friend class SearchProviderTest;
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, CanSendURL);
+  FRIEND_TEST_ALL_PREFIXES(SearchProviderTest,
+                           DontInlineAutocompleteAsynchronously);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInline);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInlineDomainClassify);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInlineSchemeSubstring);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, RemoveStaleResultsTest);
   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(AutocompleteProviderTest, GetDestinationURL);
@@ skipping 79 matching lines @@
   virtual void Start(const AutocompleteInput& input,
                      bool minimal_changes) OVERRIDE;
 
   // BaseSearchProvider:
   virtual void SortResults(bool is_keyword,
                            SearchSuggestionParser::Results* results) OVERRIDE;
   virtual const TemplateURL* GetTemplateURL(bool is_keyword) const OVERRIDE;
   virtual const AutocompleteInput GetInput(bool is_keyword) const OVERRIDE;
   virtual SearchSuggestionParser::Results* GetResultsToFill(
       bool is_keyword) OVERRIDE;
+  virtual void HandleReceivedResults(bool is_keyword) OVERRIDE;
   virtual bool ShouldAppendExtraParams(
       const SearchSuggestionParser::SuggestResult& result) const OVERRIDE;
   virtual void StopSuggest() OVERRIDE;
   virtual void ClearAllResults() OVERRIDE;
   virtual int GetDefaultResultRelevance() const OVERRIDE;
   virtual void RecordDeletionResult(bool success) OVERRIDE;
   virtual void LogFetchComplete(bool success, bool is_keyword) OVERRIDE;
   virtual bool IsKeywordFetcher(const net::URLFetcher* fetcher) const OVERRIDE;
   virtual void UpdateMatches() OVERRIDE;
 
@@ skipping 141 matching lines @@
   // typing for long enough.
   base::OneShotTimer<SearchProvider> timer_;
 
   // The time at which we sent a query to the suggest server.
   base::TimeTicks time_suggest_request_sent_;
 
   // Fetchers used to retrieve results for the keyword and default providers.
   scoped_ptr<net::URLFetcher> keyword_fetcher_;
   scoped_ptr<net::URLFetcher> default_fetcher_;
 
-  // Results from the default and keyword search providers.
+  // Results from the default and keyword search providers.  The orig results

[msw, 2014/08/14 02:57:23]

nit: s/orig/original/ in comments and identifiers.

[Mark P, 2014/08/15 00:05:56]

Now obsolete.  (Got rid of the orig members.)

+  // hold the original reply from the server; the non-orig results are the
+  // ones that should be used for most purposes.  They may have been modified
+  // in some ways from the orig results, for instance, to demote a brand
+  // new suggestion that would be inline autocompleted.  (We don't want
+  // asynchronous inline autocompletions.)
   SearchSuggestionParser::Results default_results_;
   SearchSuggestionParser::Results keyword_results_;
+  SearchSuggestionParser::Results orig_default_results_;

[msw, 2014/08/14 02:57:23]

Why do we need a copy of the originals? Can't we modify a single set as new
responses are received and when keys are pressed? Explain in the comment.

[Mark P, 2014/08/15 00:05:56]

Removed copy of the originals.  Good idea.

+  SearchSuggestionParser::Results orig_keyword_results_;
 
   GURL current_page_url_;
 
   // Session token management.
   std::string current_token_;
   base::TimeTicks token_expiration_time_;
 
   // Answers prefetch management.
   AnswersQueryData prefetch_data_;     // Data to use for query prefetching.
   AnswersQueryData last_answer_seen_;  // Last answer seen.
 
   DISALLOW_COPY_AND_ASSIGN(SearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_SEARCH_PROVIDER_H_