Only show Last N Pages in the UI when the corresponding tab is visible.

components/ntp_snippets/offline_pages/recent_tab_suggestions_provider.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/offline_pages/recent_tab_suggestions_provider.h"
 
 #include <algorithm>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "components/ntp_snippets/features.h"
 #include "components/ntp_snippets/pref_names.h"
 #include "components/ntp_snippets/pref_util.h"
 #include "components/offline_pages/core/client_policy_controller.h"
 #include "components/offline_pages/core/offline_page_item.h"

[vitaliii, 2017/02/15 10:12:15]

I guess this won't be needed once you remove
GetPagesMatchingQueryCallbackForFetchRecentTabs.

[dewittj, 2017/02/15 19:49:44]

Done.

 #include "components/offline_pages/core/offline_page_model_query.h"

[vitaliii, 2017/02/15 10:12:15]

Please remove this line.

[dewittj, 2017/02/15 19:49:44]

Done.

+#include "components/offline_pages/core/recent_tabs/recent_tabs_ui_adapter_delegate.h"
 #include "components/prefs/pref_registry_simple.h"
 #include "components/prefs/pref_service.h"
 #include "components/variations/variations_associated_data.h"
 #include "grit/components_strings.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/gfx/image/image.h"
 
 using offline_pages::ClientId;
+using offline_pages::DownloadUIAdapter;
+using offline_pages::DownloadUIItem;
 using offline_pages::OfflinePageItem;
 using offline_pages::OfflinePageModelQuery;
 using offline_pages::OfflinePageModelQueryBuilder;
 
 namespace ntp_snippets {
 
 namespace {
 
 const int kDefaultMaxSuggestionsCount = 5;
 
 const char* kMaxSuggestionsCountParamName = "recent_tabs_max_count";
 
 int GetMaxSuggestionsCount() {
   return variations::GetVariationParamByFeatureAsInt(
       kRecentOfflineTabSuggestionsFeature, kMaxSuggestionsCountParamName,
       kDefaultMaxSuggestionsCount);
 }
 
-struct OrderOfflinePagesByMostRecentlyCreatedFirst {
-  bool operator()(const OfflinePageItem* left,
-                  const OfflinePageItem* right) const {
-    return left->creation_time > right->creation_time;
+struct OrderUIItemsByMostRecentlyCreatedFirst {
+  bool operator()(const DownloadUIItem* left,
+                  const DownloadUIItem* right) const {
+    return left->start_time > right->start_time;
   }
 };
 
-struct OrderOfflinePagesByUrlAndThenMostRecentlyCreatedFirst {
-  bool operator()(const OfflinePageItem* left,
-                  const OfflinePageItem* right) const {
+struct OrderUIItemsByUrlAndThenMostRecentlyCreatedFirst {
+  bool operator()(const DownloadUIItem* left,
+                  const DownloadUIItem* right) const {
     if (left->url != right->url) {
       return left->url < right->url;
     }
-    return left->creation_time > right->creation_time;
+    return left->start_time > right->start_time;
   }
 };
 
-std::unique_ptr<OfflinePageModelQuery> BuildRecentTabsQuery(
-    offline_pages::OfflinePageModel* model) {
-  OfflinePageModelQueryBuilder builder;
-  builder.RequireShownAsRecentlyVisitedSite(
-      OfflinePageModelQuery::Requirement::INCLUDE_MATCHING);
-  return builder.Build(model->GetPolicyController());
-}
-
-bool IsRecentTab(offline_pages::ClientPolicyController* policy_controller,
-                 const OfflinePageItem& offline_page) {
-  return policy_controller->IsShownAsRecentlyVisitedSite(
-      offline_page.client_id.name_space);
-}
-
 }  // namespace
 
 RecentTabSuggestionsProvider::RecentTabSuggestionsProvider(
     ContentSuggestionsProvider::Observer* observer,
     offline_pages::OfflinePageModel* offline_page_model,
+    offline_pages::RequestCoordinator* request_coordinator,
     PrefService* pref_service)
     : ContentSuggestionsProvider(observer),
       category_status_(CategoryStatus::AVAILABLE_LOADING),
       provided_category_(
           Category::FromKnownCategory(KnownCategories::RECENT_TABS)),
-      offline_page_model_(offline_page_model),
       pref_service_(pref_service),
       weak_ptr_factory_(this) {
   observer->OnCategoryStatusChanged(this, provided_category_, category_status_);
-  offline_page_model_->AddObserver(this);
-  FetchRecentTabs();
+
+  recent_tabs_ui_adapter_ = offline_pages::RecentTabsUIAdapterDelegate::

[vitaliii, 2017/02/15 10:12:15]

Please do this in the factory and do not propagate offline_page_model and
request_coordinator to the provider.

[dewittj, 2017/02/15 19:49:44]

Done.

+      GetOrCreateRecentTabsUIAdapter(offline_page_model, request_coordinator);
+  recent_tabs_ui_adapter_->AddObserver(this);
 }
 
 RecentTabSuggestionsProvider::~RecentTabSuggestionsProvider() {
-  offline_page_model_->RemoveObserver(this);
+  recent_tabs_ui_adapter_->RemoveObserver(this);
 }
 
+// static

[vitaliii, 2017/02/15 10:12:15]

Please remove this comment.

[dewittj, 2017/02/15 19:49:45]

Done.

 CategoryStatus RecentTabSuggestionsProvider::GetCategoryStatus(
     Category category) {
   if (category == provided_category_) {
     return category_status_;
   }
   NOTREACHED() << "Unknown category " << category.id();
   return CategoryStatus::NOT_PROVIDED;
 }
 
 CategoryInfo RecentTabSuggestionsProvider::GetCategoryInfo(Category category) {
@@ skipping 48 matching lines @@
 
 void RecentTabSuggestionsProvider::ClearCachedSuggestions(Category category) {
   // Ignored.
 }
 
 void RecentTabSuggestionsProvider::GetDismissedSuggestionsForDebugging(
     Category category,
     const DismissedSuggestionsCallback& callback) {
   DCHECK_EQ(provided_category_, category);
 
-  // Offline pages which are not related to recent tabs are also queried here,
-  // so that they can be returned if they happen to be dismissed (e.g. due to a
-  // bug).
-  OfflinePageModelQueryBuilder query_builder;
-  offline_page_model_->GetPagesMatchingQuery(
-      query_builder.Build(offline_page_model_->GetPolicyController()),
-      base::Bind(&RecentTabSuggestionsProvider::
-                     GetPagesMatchingQueryCallbackForGetDismissedSuggestions,
-                 weak_ptr_factory_.GetWeakPtr(), callback));
+  std::vector<const DownloadUIItem*> items =
+      recent_tabs_ui_adapter_->GetAllItems();
+
+  std::set<std::string> dismissed_ids = ReadDismissedIDsFromPrefs();
+  std::vector<ContentSuggestion> suggestions;
+  for (const DownloadUIItem* item : items) {
+    int64_t offline_page_id =
+        recent_tabs_ui_adapter_->GetOfflineIdByGuid(item->guid);

[vitaliii, 2017/02/15 10:12:15]

Do I understand right that there may be different pages with same GUID, but not
at the same time? E.g. when one navigates the tab to a different URL the new
offline page will get the same GUID as the old one?

I though about dismissing by GUID, but if my understanding above is right, then
this is not possible.

[dewittj, 2017/02/15 19:49:44]

Yes, this is currently a limitation with how we interact with DownloadUIAdapter.
 In fact GUID is misnamed once we start doing this.  I will discuss with Dmitry
about changing guid to something else now.

+    if (!dismissed_ids.count(base::IntToString(offline_page_id))) {
+      continue;
+    }
+
+    suggestions.push_back(ConvertUIItem(*item));
+  }
+  callback.Run(std::move(suggestions));
 }
 
 void RecentTabSuggestionsProvider::ClearDismissedSuggestionsForDebugging(
     Category category) {
   DCHECK_EQ(provided_category_, category);
   StoreDismissedIDsToPrefs(std::set<std::string>());
   FetchRecentTabs();
 }
 
 // static
 void RecentTabSuggestionsProvider::RegisterProfilePrefs(
     PrefRegistrySimple* registry) {
   registry->RegisterListPref(prefs::kDismissedRecentOfflineTabSuggestions);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // Private methods
 
-void RecentTabSuggestionsProvider::
-    GetPagesMatchingQueryCallbackForGetDismissedSuggestions(
-        const DismissedSuggestionsCallback& callback,
-        const std::vector<OfflinePageItem>& offline_pages) const {
-  std::set<std::string> dismissed_ids = ReadDismissedIDsFromPrefs();
-  std::vector<ContentSuggestion> suggestions;
-  for (const OfflinePageItem& item : offline_pages) {
-    if (!dismissed_ids.count(base::IntToString(item.offline_id))) {
-      continue;
-    }
-
-    suggestions.push_back(ConvertOfflinePage(item));
-  }
-  callback.Run(std::move(suggestions));
+void RecentTabSuggestionsProvider::ItemsLoaded() {
+  FetchRecentTabs();
 }
 
-void RecentTabSuggestionsProvider::OfflinePageModelLoaded(
-    offline_pages::OfflinePageModel* model) {}
+void RecentTabSuggestionsProvider::ItemAdded(const DownloadUIItem& ui_item) {

[vitaliii, 2017/02/15 10:12:15]

Is this called before |ItemsLoaded|?
If yes, we should not query RecentTabs before ItemsLoaded. Otherwise, we will
prune dismissed IDs on incomplete list of recent tabs.

[dewittj, 2017/02/15 19:49:45]

No, the design of DownloadUIAdapter is that ItemsLoaded is
1) Always called for new observers even if the adapter is already loaded
2) Always called first.

+  FetchRecentTabs();
+}
 
-void RecentTabSuggestionsProvider::OfflinePageAdded(
-    offline_pages::OfflinePageModel* model,
-    const offline_pages::OfflinePageItem& added_page) {
-  DCHECK_EQ(offline_page_model_, model);
-  if (IsRecentTab(model->GetPolicyController(), added_page)) {
-    FetchRecentTabs();
-  }
+void RecentTabSuggestionsProvider::ItemUpdated(const DownloadUIItem& ui_item) {
+  FetchRecentTabs();
+}
+
+void RecentTabSuggestionsProvider::ItemDeleted(
+    const std::string& ui_item_guid) {
+  // Because we never switch to NOT_PROVIDED dynamically, there can be no open
+  // UI containing an invalidated suggestion unless the status is something
+  // other than NOT_PROVIDED, so only notify invalidation in that case.
+  if (category_status_ != CategoryStatus::NOT_PROVIDED)

[vitaliii, 2017/02/15 10:12:15]

Please add curly brackets { }.
We use curly brackets even for one line bodies.

[dewittj, 2017/02/15 19:49:44]

Done.

+    InvalidateSuggestion(ui_item_guid);
 }
 
 void RecentTabSuggestionsProvider::
     GetPagesMatchingQueryCallbackForFetchRecentTabs(
-        const std::vector<OfflinePageItem>& offline_pages) {
+        const std::vector<OfflinePageItem>& offline_pages) {}

[carlosk, 2017/02/15 01:20:54]

It seems this method could be removed.

[dewittj, 2017/02/15 19:49:45]

Done.

+
+void RecentTabSuggestionsProvider::FetchRecentTabs() {
+  std::vector<const DownloadUIItem*> ui_items =
+      recent_tabs_ui_adapter_->GetAllItems();
   NotifyStatusChanged(CategoryStatus::AVAILABLE);
   std::set<std::string> old_dismissed_ids = ReadDismissedIDsFromPrefs();
   std::set<std::string> new_dismissed_ids;
-  std::vector<const OfflinePageItem*> recent_tab_items;
-  for (const OfflinePageItem& item : offline_pages) {
-    std::string offline_page_id = base::IntToString(item.offline_id);
+  std::vector<const DownloadUIItem*> non_dismissed_items;
+
+  for (const DownloadUIItem* item : ui_items) {
+    std::string offline_page_id = base::IntToString(
+        recent_tabs_ui_adapter_->GetOfflineIdByGuid(item->guid));
     if (old_dismissed_ids.count(offline_page_id)) {
       new_dismissed_ids.insert(offline_page_id);
     } else {
-      recent_tab_items.push_back(&item);
+      non_dismissed_items.push_back(item);
     }
   }
 
   observer()->OnNewSuggestions(
       this, provided_category_,
-      GetMostRecentlyCreatedWithoutDuplicates(std::move(recent_tab_items)));
+      GetMostRecentlyCreatedWithoutDuplicates(std::move(non_dismissed_items)));
   if (new_dismissed_ids.size() != old_dismissed_ids.size()) {
     StoreDismissedIDsToPrefs(new_dismissed_ids);
   }
 }
 
-void RecentTabSuggestionsProvider::OfflinePageDeleted(
-    int64_t offline_id,
-    const ClientId& client_id) {
-  // Because we never switch to NOT_PROVIDED dynamically, there can be no open
-  // UI containing an invalidated suggestion unless the status is something
-  // other than NOT_PROVIDED, so only notify invalidation in that case.
-  if (category_status_ != CategoryStatus::NOT_PROVIDED) {
-    InvalidateSuggestion(offline_id);
-  }
-}
-
-void RecentTabSuggestionsProvider::FetchRecentTabs() {
-  offline_page_model_->GetPagesMatchingQuery(
-      BuildRecentTabsQuery(offline_page_model_),
-      base::Bind(&RecentTabSuggestionsProvider::
-                     GetPagesMatchingQueryCallbackForFetchRecentTabs,
-                 weak_ptr_factory_.GetWeakPtr()));
-}
-
 void RecentTabSuggestionsProvider::NotifyStatusChanged(
     CategoryStatus new_status) {
   DCHECK_NE(CategoryStatus::NOT_PROVIDED, category_status_);
   if (category_status_ == new_status) {
     return;
   }
   category_status_ = new_status;
   observer()->OnCategoryStatusChanged(this, provided_category_, new_status);
 }
 
-ContentSuggestion RecentTabSuggestionsProvider::ConvertOfflinePage(
-    const OfflinePageItem& offline_page) const {
+ContentSuggestion RecentTabSuggestionsProvider::ConvertUIItem(
+    const DownloadUIItem& ui_item) const {
+  // UI items have the Tab ID embedded in the GUID and the offline ID is
+  // available by querying.
+  //
   // TODO(vitaliii): Make sure the URL is opened in the existing tab.
+  int64_t offline_page_id =
+      recent_tabs_ui_adapter_->GetOfflineIdByGuid(ui_item.guid);
   ContentSuggestion suggestion(provided_category_,
-                               base::IntToString(offline_page.offline_id),
-                               offline_page.url);
-
-  if (offline_page.title.empty()) {
-    // TODO(vitaliii): Remove this fallback once the OfflinePageModel provides
-    // titles for all (relevant) OfflinePageItems.
-    suggestion.set_title(base::UTF8ToUTF16(offline_page.url.spec()));
-  } else {
-    suggestion.set_title(offline_page.title);
-  }
-  suggestion.set_publish_date(offline_page.creation_time);
-  suggestion.set_publisher_name(base::UTF8ToUTF16(offline_page.url.host()));
+                               base::IntToString(offline_page_id), ui_item.url);
+  suggestion.set_title(ui_item.title);
+  suggestion.set_publish_date(ui_item.start_time);
+  suggestion.set_publisher_name(base::UTF8ToUTF16(ui_item.url.host()));
   auto extra = base::MakeUnique<RecentTabSuggestionExtra>();
   int tab_id;
-  bool success = base::StringToInt(offline_page.client_id.id, &tab_id);
+  bool success = base::StringToInt(ui_item.guid, &tab_id);
   DCHECK(success);
   extra->tab_id = tab_id;
-  extra->offline_page_id = offline_page.offline_id;
+  extra->offline_page_id = offline_page_id;
   suggestion.set_recent_tab_suggestion_extra(std::move(extra));
+
   return suggestion;
 }
 
 std::vector<ContentSuggestion>
 RecentTabSuggestionsProvider::GetMostRecentlyCreatedWithoutDuplicates(
-    std::vector<const OfflinePageItem*> offline_page_items) const {
+    std::vector<const DownloadUIItem*> ui_items) const {
   // |std::unique| only removes duplicates that immediately follow each other.
   // Thus, first, we have to sort by URL and creation time and only then remove
   // duplicates and sort the remaining items by creation time.
-  std::sort(offline_page_items.begin(), offline_page_items.end(),
-            OrderOfflinePagesByUrlAndThenMostRecentlyCreatedFirst());
-  std::vector<const OfflinePageItem*>::iterator new_end = std::unique(
-      offline_page_items.begin(), offline_page_items.end(),
-      [](const OfflinePageItem* left, const OfflinePageItem* right) {
-        return left->url == right->url;
-      });
-  offline_page_items.erase(new_end, offline_page_items.end());
-  std::sort(offline_page_items.begin(), offline_page_items.end(),
-            OrderOfflinePagesByMostRecentlyCreatedFirst());
+  std::sort(ui_items.begin(), ui_items.end(),
+            OrderUIItemsByUrlAndThenMostRecentlyCreatedFirst());
+  std::vector<const DownloadUIItem*>::iterator new_end =
+      std::unique(ui_items.begin(), ui_items.end(),
+                  [](const DownloadUIItem* left, const DownloadUIItem* right) {
+                    return left->url == right->url;
+                  });
+  ui_items.erase(new_end, ui_items.end());
+  std::sort(ui_items.begin(), ui_items.end(),
+            OrderUIItemsByMostRecentlyCreatedFirst());
   std::vector<ContentSuggestion> suggestions;
-  for (const OfflinePageItem* offline_page_item : offline_page_items) {
-    suggestions.push_back(ConvertOfflinePage(*offline_page_item));
+  for (const DownloadUIItem* ui_item : ui_items) {
+    suggestions.push_back(ConvertUIItem(*ui_item));
     if (static_cast<int>(suggestions.size()) == GetMaxSuggestionsCount()) {
       break;
     }
   }
   return suggestions;
 }
 
-void RecentTabSuggestionsProvider::InvalidateSuggestion(int64_t offline_id) {
-  std::string offline_page_id = base::IntToString(offline_id);
+void RecentTabSuggestionsProvider::InvalidateSuggestion(
+    const std::string& ui_item_guid) {
+  std::string offline_page_id = base::IntToString(
+      recent_tabs_ui_adapter_->GetOfflineIdByGuid(ui_item_guid));
   observer()->OnSuggestionInvalidated(
       this, ContentSuggestion::ID(provided_category_, offline_page_id));
 
   std::set<std::string> dismissed_ids = ReadDismissedIDsFromPrefs();
   auto it = dismissed_ids.find(offline_page_id);
   if (it != dismissed_ids.end()) {
     dismissed_ids.erase(it);
     StoreDismissedIDsToPrefs(dismissed_ids);
   }
 }
 
 std::set<std::string> RecentTabSuggestionsProvider::ReadDismissedIDsFromPrefs()
     const {
   return prefs::ReadDismissedIDsFromPrefs(
       *pref_service_, prefs::kDismissedRecentOfflineTabSuggestions);
 }
 
 void RecentTabSuggestionsProvider::StoreDismissedIDsToPrefs(
     const std::set<std::string>& dismissed_ids) {
   prefs::StoreDismissedIDsToPrefs(pref_service_,
                                   prefs::kDismissedRecentOfflineTabSuggestions,
                                   dismissed_ids);
 }
 
 }  // namespace ntp_snippets