Adds an experiment that enabled SuggestionsService suggestions (MostLikely) on LocalNTP

chrome/browser/search/instant_service.cc

 // Copyright 2013 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/search/instant_service.h"
 
+#include "base/metrics/field_trial.h"
+#include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/favicon/fallback_icon_service_factory.h"
 #include "chrome/browser/favicon/large_icon_service_factory.h"
 #include "chrome/browser/history/top_sites_factory.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/search/instant_io_context.h"
 #include "chrome/browser/search/instant_service_observer.h"
 #include "chrome/browser/search/most_visited_iframe_source.h"
 #include "chrome/browser/search/search.h"
+#include "chrome/browser/search/suggestions/suggestions_service_factory.h"
 #include "chrome/browser/search/suggestions/suggestions_source.h"
 #include "chrome/browser/search/thumbnail_source.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/search_engines/ui_thread_search_terms_data.h"
 #include "chrome/browser/thumbnails/thumbnail_list_source.h"
 #include "chrome/browser/ui/search/instant_search_prerenderer.h"
 #include "chrome/browser/ui/webui/fallback_icon_source.h"
 #include "chrome/browser/ui/webui/favicon_source.h"
 #include "chrome/browser/ui/webui/large_icon_source.h"
 #include "chrome/browser/ui/webui/theme_source.h"
 #include "chrome/common/render_messages.h"
 #include "components/favicon/core/fallback_icon_service.h"
 #include "components/favicon/core/large_icon_service.h"
 #include "components/history/core/browser/top_sites.h"
 #include "components/keyed_service/core/service_access_type.h"
 #include "components/search_engines/template_url_service.h"
+#include "components/suggestions/proto/suggestions.pb.h"
+#include "components/suggestions/suggestions_service.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/url_data_source.h"
 #include "grit/theme_resources.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/gfx/color_utils.h"
 #include "ui/gfx/image/image_skia.h"
 
 #if !defined(OS_ANDROID)
 #include "chrome/browser/search/local_ntp_source.h"
 #endif
 
 #if defined(ENABLE_THEMES)
 #include "chrome/browser/themes/theme_properties.h"
 #include "chrome/browser/themes/theme_service.h"
 #include "chrome/browser/themes/theme_service_factory.h"
 #endif  // defined(ENABLE_THEMES)
 
 InstantService::InstantService(Profile* profile)
     : profile_(profile),
       template_url_service_(TemplateURLServiceFactory::GetForProfile(profile_)),
       omnibox_start_margin_(chrome::kDisableStartMargin),
-      weak_ptr_factory_(this) {
+      weak_ptr_factory_(this),
+      suggestions_service(NULL) {
   // The initialization below depends on a typical set of browser threads. Skip
   // it if we are running in a unit test without the full suite.
   if (!content::BrowserThread::CurrentlyOn(content::BrowserThread::UI))
     return;
 
   // This depends on the existence of the typical browser threads. Therefore it
   // is only instantiated here (after the check for a UI thread above).
   instant_io_context_ = new InstantIOContext();
 
   previous_google_base_url_ =
@@ skipping 56 matching lines @@
       LargeIconServiceFactory::GetForBrowserContext(profile_);
   content::URLDataSource::Add(
       profile_, new FallbackIconSource(fallback_icon_service));
   content::URLDataSource::Add(
       profile_, new FaviconSource(profile_, FaviconSource::FAVICON));
   content::URLDataSource::Add(
       profile_, new LargeIconSource(fallback_icon_service, large_icon_service));
   content::URLDataSource::Add(profile_, new MostVisitedIframeSource());
   content::URLDataSource::Add(
       profile_, new suggestions::SuggestionsSource(profile_));
+
+  if (base::StartsWith(
+          base::FieldTrialList::FindFullName("LocalNTPSuggestionsService"),
+          "Enabled", base::CompareCase::INSENSITIVE_ASCII)) {
+    suggestions_service =
+        suggestions::SuggestionsServiceFactory::GetForProfile(profile_);
+  }
+
+  if (suggestions_service) {
+    suggestions::SuggestionsService* if (suggestions_service) {

[kmadhusu, 2015/07/29 17:42:31]

Can you please explain this code? Why do you need
"suggestions::SuggestionsService* " before an if statement?

[fserb, 2015/07/29 19:02:59]

I messed up the last comment fix. :) thanks. done.

+      suggestions_service->FetchSuggestionsData(
+          suggestions::INITIALIZED_ENABLED_HISTORY,
+          base::Bind(&InstantService::OnSuggestionsAvailable,
+                     weak_ptr_factory_.GetWeakPtr()));
+    }
+  }
 }
 
 InstantService::~InstantService() {
   if (template_url_service_)
     template_url_service_->RemoveObserver(this);
 }
 
 void InstantService::AddInstantProcess(int process_id) {
   process_ids_.insert(process_id);
 
@@ skipping 17 matching lines @@
   observers_.RemoveObserver(observer);
 }
 
 void InstantService::DeleteMostVisitedItem(const GURL& url) {
   scoped_refptr<history::TopSites> top_sites =
       TopSitesFactory::GetForProfile(profile_);
   if (!top_sites)
     return;
 
   top_sites->AddBlacklistedURL(url);
+  if (suggestions_service) {
+    suggestions_service->BlacklistURL(
+        url, base::Bind(&InstantService::OnSuggestionsAvailable,

[kmadhusu, 2015/07/29 17:42:31]

Instead of passing a callback as an argument, have you considered implementing
SuggestionServiceObserver something similar to TopSitesObserver?

[fserb, 2015/07/29 19:03:00]

SuggestionsService has a callback model, it doesn't expose an observer.

[kmadhusu, 2015/07/30 21:57:02]

(My 2 cents) Hmm. I am not entirely convinced by the callback model. I don't
know the rationale behind the original model. InstantService should not worry
about suggestions_service->BlacklistURL() response success/failure.
InstantService should just notify SuggestionService about the new black list url
and SuggestionService should notify the corresponding observers about this. Git
blame says that mathp@ modified/wrote most of the suggestions_service. Please
discuss with mathp@ and consider adding an observer model in the future.

+                        weak_ptr_factory_.GetWeakPtr()),
+        base::Closure());
+  }
 }
 
 void InstantService::UndoMostVisitedDeletion(const GURL& url) {
   scoped_refptr<history::TopSites> top_sites =
       TopSitesFactory::GetForProfile(profile_);
   if (!top_sites)

[kmadhusu, 2015/07/30 21:57:02]

Do you want to do an early return when top_sites is null even when
suggestions_service is not null?

[fserb, 2015/07/31 17:08:17]

Nice catch. Fixed them all.

[fserb, 2015/07/31 17:08:17]

ops. Fixed all of them. Thanks for catching this.

     return;
 
   top_sites->RemoveBlacklistedURL(url);
+  if (suggestions_service) {
+    suggestions_service->UndoBlacklistURL(
+        url, base::Bind(&InstantService::OnSuggestionsAvailable,
+                        weak_ptr_factory_.GetWeakPtr()),
+        base::Closure());
+  }
 }
 
 void InstantService::UndoAllMostVisitedDeletions() {
   scoped_refptr<history::TopSites> top_sites =
       TopSitesFactory::GetForProfile(profile_);
   if (!top_sites)
     return;
 
   top_sites->ClearBlacklistedURLs();
+  if (suggestions_service) {
+    suggestions_service->ClearBlacklist(
+        base::Bind(&InstantService::OnSuggestionsAvailable,
+                   weak_ptr_factory_.GetWeakPtr()));
+  }
 }
 
 void InstantService::UpdateThemeInfo() {
 #if defined(ENABLE_THEMES)
   // Update theme background info.
   // Initialize |theme_info| if necessary.
   if (!theme_info_)
     OnThemeChanged(ThemeServiceFactory::GetForProfile(profile_));
   else
     OnThemeChanged(NULL);
@@ skipping 60 matching lines @@
   process_ids_.erase(process_id);
 
   if (instant_io_context_.get()) {
     content::BrowserThread::PostTask(
         content::BrowserThread::IO, FROM_HERE,
         base::Bind(&InstantIOContext::RemoveInstantProcessOnIO,
                    instant_io_context_, process_id));
   }
 }
 
+void InstantService::OnSuggestionsAvailable(
+    const suggestions::SuggestionsProfile& profile) {
+  std::vector<InstantMostVisitedItem> new_suggestions_items;
+  for (int i = 0; i < profile.suggestions_size(); ++i) {
+    const suggestions::ChromeSuggestion& suggestion = profile.suggestions(i);
+
+    InstantMostVisitedItem item;
+    item.url = GURL(suggestion.url());
+    item.title = base::UTF8ToUTF16(suggestion.title());
+    item.thumbnail = GURL(suggestion.thumbnail());
+    item.favicon = GURL(suggestion.favicon_url());
+    new_suggestions_items.push_back(item);
+  }
+  suggestions_items_ = new_suggestions_items;
+  NotifyAboutMostVisitedItems();
+}
+
 void InstantService::OnMostVisitedItemsReceived(
     const history::MostVisitedURLList& data) {
   history::MostVisitedURLList reordered_data(data);
   std::vector<InstantMostVisitedItem> new_most_visited_items;
   for (size_t i = 0; i < reordered_data.size(); i++) {
     const history::MostVisitedURL& url = reordered_data[i];
     InstantMostVisitedItem item;
     item.url = url.url;
     item.title = url.title;
     new_most_visited_items.push_back(item);
   }
 
   most_visited_items_ = new_most_visited_items;
   NotifyAboutMostVisitedItems();
 }
 
 void InstantService::NotifyAboutMostVisitedItems() {
-  FOR_EACH_OBSERVER(InstantServiceObserver, observers_,
-                    MostVisitedItemsChanged(most_visited_items_));
+  if (suggestions_service && !suggestions_items_.empty()) {
+    FOR_EACH_OBSERVER(InstantServiceObserver, observers_,
+                      MostVisitedItemsChanged(suggestions_items_));
+  } else {
+    FOR_EACH_OBSERVER(InstantServiceObserver, observers_,
+                      MostVisitedItemsChanged(most_visited_items_));
+  }
 }
 
 #if defined(ENABLE_THEMES)
 
 namespace {
 
 const int kSectionBorderAlphaTransparency = 80;
 
 // Converts SkColor to RGBAColor
 RGBAColor SkColorToRGBAColor(const SkColor& sKColor) {
@@ skipping 164 matching lines @@
 }
 
 void InstantService::ResetInstantSearchPrerenderer() {
   if (!chrome::ShouldPrefetchSearchResults())
     return;
 
   GURL url(chrome::GetSearchResultPrefetchBaseURL(profile_));
   instant_prerenderer_.reset(
       url.is_valid() ? new InstantSearchPrerenderer(profile_, url) : NULL);
 }