📰 Persist category dismissals

components/ntp_snippets/content_suggestions_service.cc

 // Copyright 2016 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 "components/ntp_snippets/content_suggestions_service.h"
 
 #include <algorithm>
 #include <iterator>
 #include <set>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/location.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
+#include "base/values.h"
+#include "components/ntp_snippets/pref_names.h"
+#include "components/prefs/pref_registry_simple.h"
 #include "ui/gfx/image/image.h"
 
 namespace ntp_snippets {
 
 ContentSuggestionsService::ContentSuggestionsService(
     State state,
     history::HistoryService* history_service,
     PrefService* pref_service)
     : state_(state),
       history_service_observer_(this),
       ntp_snippets_service_(nullptr),
+      pref_service_(pref_service),
       user_classifier_(pref_service) {
   // Can be null in tests.
   if (history_service)
     history_service_observer_.Add(history_service);
+
+  RestoreDismissedCategoriesFromPrefs();
 }
 
 ContentSuggestionsService::~ContentSuggestionsService() = default;
 
 void ContentSuggestionsService::Shutdown() {
   ntp_snippets_service_ = nullptr;
   suggestions_by_category_.clear();
   providers_by_category_.clear();
   categories_.clear();
   providers_.clear();
   state_ = State::DISABLED;
   FOR_EACH_OBSERVER(Observer, observers_, ContentSuggestionsServiceShutdown());
 }
 
+// static
+void ContentSuggestionsService::RegisterProfilePrefs(
+    PrefRegistrySimple* registry) {
+  registry->RegisterListPref(prefs::kDismissedCategories);
+}
+
 CategoryStatus ContentSuggestionsService::GetCategoryStatus(
     Category category) const {
-  if (state_ == State::DISABLED) {
+  if (state_ == State::DISABLED)
     return CategoryStatus::ALL_SUGGESTIONS_EXPLICITLY_DISABLED;
-  }
+
+  if (IsCategoryDismissed(category))
+    return CategoryStatus::NOT_PROVIDED;
 
   auto iterator = providers_by_category_.find(category);
   if (iterator == providers_by_category_.end())
     return CategoryStatus::NOT_PROVIDED;
 
   return iterator->second->GetCategoryStatus(category);
 }
 
 base::Optional<CategoryInfo> ContentSuggestionsService::GetCategoryInfo(
     Category category) const {
+  if (IsCategoryDismissed(category))
+    return base::Optional<CategoryInfo>();
+
   auto iterator = providers_by_category_.find(category);
   if (iterator == providers_by_category_.end())
     return base::Optional<CategoryInfo>();
   return iterator->second->GetCategoryInfo(category);
 }
 
 const std::vector<ContentSuggestion>&
 ContentSuggestionsService::GetSuggestionsForCategory(Category category) const {
+  if (IsCategoryDismissed(category))
+    return no_suggestions_;
+
   auto iterator = suggestions_by_category_.find(category);
   if (iterator == suggestions_by_category_.end())
     return no_suggestions_;
   return iterator->second;
 }
 
 void ContentSuggestionsService::FetchSuggestionImage(
     const ContentSuggestion::ID& suggestion_id,
     const ImageFetchedCallback& callback) {
   if (!providers_by_category_.count(suggestion_id.category())) {
@@ skipping 65 matching lines @@
   DCHECK(removed) << "The dismissed suggestion " << suggestion_id
                   << " has already been removed. Providers must not call"
                   << " OnNewSuggestions in response to DismissSuggestion.";
 }
 
 void ContentSuggestionsService::DismissCategory(Category category) {
   auto providers_it = providers_by_category_.find(category);
   if (providers_it == providers_by_category_.end())
     return;
 
-  providers_by_category_.erase(providers_it);
-  categories_.erase(
-      std::find(categories_.begin(), categories_.end(), category));
+  dismissed_categories_.insert(category);
+  StoreDismissedCategoriesToPrefs();
 }
 
 void ContentSuggestionsService::AddObserver(Observer* observer) {
   observers_.AddObserver(observer);
 }
 
 void ContentSuggestionsService::RemoveObserver(Observer* observer) {
   observers_.RemoveObserver(observer);
 }
 
 void ContentSuggestionsService::RegisterProvider(
     std::unique_ptr<ContentSuggestionsProvider> provider) {
   DCHECK(state_ == State::ENABLED);
   providers_.push_back(std::move(provider));
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // Private methods
 
 void ContentSuggestionsService::OnNewSuggestions(
     ContentSuggestionsProvider* provider,
     Category category,
     std::vector<ContentSuggestion> suggestions) {
-  if (RegisterCategoryIfRequired(provider, category))
-    NotifyCategoryStatusChanged(category);
+  if (!suggestions.empty()) {
+    dismissed_categories_.erase(category);
+    StoreDismissedCategoriesToPrefs();
+  }
 
-  if (!IsCategoryStatusAvailable(provider->GetCategoryStatus(category)))
-    return;
+  OnNewSuggestionsInternal(provider, category, std::move(suggestions));
+}
 
-  suggestions_by_category_[category] = std::move(suggestions);
+void ContentSuggestionsService::OnNewSuggestionBatch(
+    ContentSuggestionsProvider* provider,
+    SuggestionBatch suggestion_batch) {
+  // Update the dismissed suggestions. Remote suggestions are received at once
+  // from the server. Because of that, we always have the full list of valid
+  // remote categories according to the server. We remove invalid categories or
+  // the ones for which we got new suggestions to show.
+  for (auto it = dismissed_categories_.begin();
+       it != dismissed_categories_.end();) {
+    // Do nothing to the local sections, we only clean up the remote ones here.
+    if (!it->IsRemote()) {
+      ++it;
+      continue;
+    }
 
-  // The positioning of the bookmarks category depends on whether it's empty.
-  // TODO(treib): Remove this temporary hack, crbug.com/640568.
-  if (category.IsKnownCategory(KnownCategories::BOOKMARKS))
-    SortCategories();
+    auto entry = suggestion_batch.find(*it);
 
-  FOR_EACH_OBSERVER(Observer, observers_, OnNewSuggestions(category));
+    // If the category is not included in the new bundle, it's not valid anymore
+    // and we can just remove it.
+    // TODO(dgn) Also remove all the related local data?
+    if (entry == suggestion_batch.end()) {
+      DVLOG(1) << "Dismissed category " << it->id()
+               << " unknown on the server.";
+      it = dismissed_categories_.erase(it);
+      continue;
+    }
+
+    // The category has new suggestions to show, it's not dismissed anymore.
+    if (!entry->second.empty()) {
+      DVLOG(1) << "Dismissed category " << it->id()
+               << " has new suggestions to show.";
+      it = dismissed_categories_.erase(it);
+      continue;
+    }
+
+    ++it;
+  }
+
+  StoreDismissedCategoriesToPrefs();
+
+  for (auto it = suggestion_batch.begin(); it != suggestion_batch.end(); ++it) {
+    OnNewSuggestionsInternal(provider, it->first, std::move(it->second));
+  }
 }
 
 void ContentSuggestionsService::OnCategoryStatusChanged(
     ContentSuggestionsProvider* provider,
     Category category,
     CategoryStatus new_status) {
   if (!IsCategoryStatusAvailable(new_status)) {
     suggestions_by_category_.erase(category);
   }
   if (new_status == CategoryStatus::NOT_PROVIDED) {
-    DCHECK(providers_by_category_.find(category) !=
-           providers_by_category_.end());
-    DCHECK_EQ(provider, providers_by_category_.find(category)->second);
-    DismissCategory(category);
+    auto providers_it = providers_by_category_.find(category);
+    DCHECK(providers_it != providers_by_category_.end());
+    DCHECK_EQ(provider, providers_it->second);
+    providers_by_category_.erase(providers_it);
+    categories_.erase(
+        std::find(categories_.begin(), categories_.end(), category));
   } else {
     RegisterCategoryIfRequired(provider, category);
     DCHECK_EQ(new_status, provider->GetCategoryStatus(category));
   }
   NotifyCategoryStatusChanged(category);
 }
 
 void ContentSuggestionsService::OnSuggestionInvalidated(
     ContentSuggestionsProvider* provider,
     const ContentSuggestion::ID& suggestion_id) {
@@ skipping 60 matching lines @@
   providers_by_category_[category] = provider;
   categories_.push_back(category);
   SortCategories();
   if (IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) {
     suggestions_by_category_.insert(
         std::make_pair(category, std::vector<ContentSuggestion>()));
   }
   return true;
 }
 
+void ContentSuggestionsService::OnNewSuggestionsInternal(
+    ContentSuggestionsProvider* provider,
+    Category category,
+    std::vector<ContentSuggestion> suggestions) {
+  // Ignore notifications concerning dismissed categories.
+  if (IsCategoryDismissed(category))
+    return;
+
+  if (RegisterCategoryIfRequired(provider, category))
+    NotifyCategoryStatusChanged(category);
+
+  if (!IsCategoryStatusAvailable(provider->GetCategoryStatus(category)))
+    return;
+
+  suggestions_by_category_[category] = std::move(suggestions);
+
+  // The positioning of the bookmarks category depends on whether it's empty.
+  // TODO(treib): Remove this temporary hack, crbug.com/640568.
+  if (category.IsKnownCategory(KnownCategories::BOOKMARKS))
+    SortCategories();
+
+  FOR_EACH_OBSERVER(Observer, observers_, OnNewSuggestions(category));
+}
+
 bool ContentSuggestionsService::RemoveSuggestionByID(
     const ContentSuggestion::ID& suggestion_id) {
   std::vector<ContentSuggestion>* suggestions =
       &suggestions_by_category_[suggestion_id.category()];
   auto position =
       std::find_if(suggestions->begin(), suggestions->end(),
                    [&suggestion_id](const ContentSuggestion& suggestion) {
                      return suggestion_id == suggestion.id();
                    });
   if (position == suggestions->end())
     return false;
   suggestions->erase(position);
 
   // The positioning of the bookmarks category depends on whether it's empty.
   // TODO(treib): Remove this temporary hack, crbug.com/640568.
   if (suggestion_id.category().IsKnownCategory(KnownCategories::BOOKMARKS))
     SortCategories();
 
   return true;
 }
 
 void ContentSuggestionsService::NotifyCategoryStatusChanged(Category category) {
+  // Ignore notifications concerning dismissed categories.
+  if (IsCategoryDismissed(category))

[Marc Treib, 2016/10/11 07:52:55]

I thought changing the status should make the dismissal go away?

[dgn, 2016/10/11 19:14:01]

It currently works just by the fact that when status changes or we received new
suggestions, we run RegisterCategoryIfNecessary, which will make the category
reappear. With this patch we have a more explicit way of controlling it.

But I'll wait for Michael's patch to land, since it does mostly the same as this
already.

+    return;
+
   FOR_EACH_OBSERVER(
       Observer, observers_,
       OnCategoryStatusChanged(category, GetCategoryStatus(category)));
 }
 
+bool ContentSuggestionsService::IsCategoryDismissed(Category category) const {
+  return dismissed_categories_.find(category) != dismissed_categories_.end();
+}
+
 void ContentSuggestionsService::SortCategories() {
   auto it = suggestions_by_category_.find(
       category_factory_.FromKnownCategory(KnownCategories::BOOKMARKS));
   bool bookmarks_empty =
       (it == suggestions_by_category_.end() || it->second.empty());
   std::sort(
       categories_.begin(), categories_.end(),
       [this, bookmarks_empty](const Category& left, const Category& right) {
         // If the bookmarks section is empty, put it at the end.
         // TODO(treib): This is a temporary hack, see crbug.com/640568.
         if (bookmarks_empty) {
           if (left.IsKnownCategory(KnownCategories::BOOKMARKS))
             return false;
           if (right.IsKnownCategory(KnownCategories::BOOKMARKS))
             return true;
         }
         return category_factory_.CompareCategories(left, right);
       });
 }
 
+void ContentSuggestionsService::RestoreDismissedCategoriesFromPrefs() {
+  // This must only be called at startup.
+  DCHECK(dismissed_categories_.empty());
+
+  const base::ListValue* list =
+      pref_service_->GetList(prefs::kDismissedCategories);
+  for (const std::unique_ptr<base::Value>& entry : *list) {
+    int id = 0;
+    if (!entry->GetAsInteger(&id)) {
+      DLOG(WARNING) << "Invalid category pref value: " << *entry;
+      continue;
+    }
+
+    dismissed_categories_.insert(category_factory()->FromIDValue(id));

[Marc Treib, 2016/10/11 07:52:55]

This might create the category, and the category order is atm defined by order
of creation. That's probably not what we want...

[dgn, 2016/10/11 19:14:01]

To be addressed by registering the articles at the same time as the local
categories.

+  }
+}
+
+void ContentSuggestionsService::StoreDismissedCategoriesToPrefs() {
+  base::ListValue list;
+  for (Category category : dismissed_categories_) {
+    list.AppendInteger(category.id());
+  }
+
+  pref_service_->Set(prefs::kDismissedCategories, list);
+}
+
 }  // namespace ntp_snippets