Fix Omnibox search provider's confusing internal variable semantics

chrome/browser/autocomplete/search_provider.cc

 // 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.
 
 #include "chrome/browser/autocomplete/search_provider.h"
 
 #include <algorithm>
 #include <cmath>
 
 #include "base/callback.h"
@@ skipping 104 matching lines @@
 const int SearchProvider::kDefaultProviderURLFetcherID = 1;
 // static
 const int SearchProvider::kKeywordProviderURLFetcherID = 2;
 // static
 bool SearchProvider::query_suggest_immediately_ = false;
 
 SearchProvider::SearchProvider(AutocompleteProviderListener* listener,
                                Profile* profile)
     : AutocompleteProvider(listener, profile, "Search"),
       providers_(TemplateURLServiceFactory::GetForProfile(profile)),
+      in_timer_phase_(false),
       suggest_results_pending_(0),
       suggest_field_trial_group_number_(
           AutocompleteFieldTrial::GetSuggestNumberOfGroups()),
       has_suggested_relevance_(false),
       verbatim_relevance_(-1),
       have_suggest_results_(false),
       instant_finalized_(false) {
   // Above, we default |suggest_field_trial_group_number_| to the number of
   // groups to mean "not in field trial."  Field trial groups run from 0 to
   // GetSuggestNumberOfGroups() - 1 (inclusive).
@@ skipping 167 matching lines @@
  public:
   bool operator()(const Result& a, const Result& b) {
     // Sort in descending relevance order.
     return a.relevance() > b.relevance();
   }
 };
 
 void SearchProvider::Run() {
   // Start a new request with the current input.
   DCHECK(!done_);
+  DCHECK(in_timer_phase_);
+  in_timer_phase_ = false;
   suggest_results_pending_ = 0;
   time_suggest_request_sent_ = base::TimeTicks::Now();
   const TemplateURL* default_url = providers_.GetDefaultProviderURL();
   if (default_url && !default_url->suggestions_url().empty()) {
     suggest_results_pending_++;
     LogOmniboxSuggestRequest(REQUEST_SENT);
     default_fetcher_.reset(CreateSuggestFetcher(kDefaultProviderURLFetcherID,
         default_url->suggestions_url_ref(), input_.text()));
   }
   const TemplateURL* keyword_url = providers_.GetKeywordProviderURL();
@@ skipping 175 matching lines @@
   // We can't keep running any previous query, so halt it.
   StopSuggest();
 
   // Remove existing results that cannot inline autocomplete the new input.
   RemoveStaleResults();
 
   // We can't start a new query if we're only allowed synchronous results.
   if (input_.matches_requested() != AutocompleteInput::ALL_MATCHES)
     return;
 
-  // We'll have at least one pending fetch. Set it to 1 now, but the value is
-  // correctly set in Run. As Run isn't invoked immediately we need to set this
-  // now, else we won't think we're waiting on results from the server when we
-  // really are.
-  suggest_results_pending_ = 1;
-
   // Kick off a timer that will start the URL fetch if it completes before
   // the user types another character.  Requests may be delayed to avoid
   // flooding the server with requests that are likely to be thrown away later
   // anyway.
+  in_timer_phase_ = true;
   timer_.Start(FROM_HERE, GetSuggestQueryDelay(), this, &SearchProvider::Run);
 }
 
 bool SearchProvider::IsQuerySuitableForSuggest() const {
   // Don't run Suggest in incognito mode, if the engine doesn't support it, or
   // if the user has disabled it.
   const TemplateURL* default_url = providers_.GetDefaultProviderURL();
   const TemplateURL* keyword_url = providers_.GetKeywordProviderURL();
   if (profile_->IsOffTheRecord() ||
       ((!default_url || default_url->suggestions_url().empty()) &&
@@ skipping 45 matching lines @@
   return true;
 }
 
 void SearchProvider::StopSuggest() {
   // Increment the appropriate field in the histogram by the number of
   // pending requests that were invalidated.
   for (int i = 0; i < suggest_results_pending_; i++)
     LogOmniboxSuggestRequest(REQUEST_INVALIDATED);
   suggest_results_pending_ = 0;
   timer_.Stop();
+  in_timer_phase_ = false;
   // Stop any in-progress URL fetches.
   keyword_fetcher_.reset();
   default_fetcher_.reset();
 }
 
 void SearchProvider::ClearResults() {
   keyword_suggest_results_.clear();
   default_suggest_results_.clear();
   keyword_navigation_results_.clear();
   default_navigation_results_.clear();
@@ skipping 645 matching lines @@
 
   match.description = navigation.description();
   AutocompleteMatch::ClassifyMatchInString(input, match.description,
       ACMatchClassification::NONE, &match.description_class);
   return match;
 }
 
 void SearchProvider::UpdateDone() {
   // We're done when there are no more suggest queries pending (this is set to 1
   // when the timer is started) and we're not waiting on instant.
-  done_ = ((suggest_results_pending_ == 0) &&
+  done_ = (!in_timer_phase_ && (suggest_results_pending_ == 0) &&
            (instant_finalized_ || !InstantController::IsEnabled(profile_)));
 }