Adds a Fetch() method to the ContentSuggestionService which asks any provider to provide more conte…

components/ntp_snippets/remote/ntp_snippets_service.h

 // Copyright 2015 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.
 
 #ifndef COMPONENTS_NTP_SNIPPETS_REMOTE_NTP_SNIPPETS_SERVICE_H_
 #define COMPONENTS_NTP_SNIPPETS_REMOTE_NTP_SNIPPETS_SERVICE_H_
 
 #include <cstddef>
 #include <map>
 #include <memory>
@@ skipping 99 matching lines @@
   // tasks will be re-scheduled even if they already exist and have the correct
   // periods.
   void RescheduleFetching(bool force);
 
   // ContentSuggestionsProvider implementation
   CategoryStatus GetCategoryStatus(Category category) override;
   CategoryInfo GetCategoryInfo(Category category) override;
   void DismissSuggestion(const ContentSuggestion::ID& suggestion_id) override;
   void FetchSuggestionImage(const ContentSuggestion::ID& suggestion_id,
                             const ImageFetchedCallback& callback) override;
+  void Fetch(const Category& category,
+             const std::set<std::string>& known_suggestion_ids,
+             FetchingCallback callback) override;
   void ClearHistory(
       base::Time begin,
       base::Time end,
       const base::Callback<bool(const GURL& url)>& filter) override;
   void ClearCachedSuggestions(Category category) override;
   void GetDismissedSuggestionsForDebugging(
       Category category,
       const DismissedSuggestionsCallback& callback) override;
   void ClearDismissedSuggestionsForDebugging(Category category) override;
 
@@ skipping 13 matching lines @@
   }
 
   // Dismissed snippets, only for unit tests.
   const NTPSnippet::PtrVector& GetDismissedSnippetsForTesting(
       Category category) const {
     return categories_.find(category)->second.dismissed;
   }
 
  private:
   friend class NTPSnippetsServiceTest;
+
   FRIEND_TEST_ALL_PREFIXES(NTPSnippetsServiceTest,
                            RemoveExpiredDismissedContent);
   FRIEND_TEST_ALL_PREFIXES(NTPSnippetsServiceTest, RescheduleOnStateChange);
   FRIEND_TEST_ALL_PREFIXES(NTPSnippetsServiceTest, StatusChanges);
   FRIEND_TEST_ALL_PREFIXES(NTPSnippetsServiceTest,
                            SuggestionsFetchedOnSignInAndSignOut);
 
   // Possible state transitions:
   //       NOT_INITED --------+
   //       /       \          |
@@ skipping 39 matching lines @@
   // image_fetcher::ImageFetcherDelegate implementation.
   void OnImageDataFetched(const std::string& id_within_category,
                           const std::string& image_data) override;
 
   // Callbacks for the NTPSnippetsDatabase.
   void OnDatabaseLoaded(NTPSnippet::PtrVector snippets);
   void OnDatabaseError();
 
   // Callback for the NTPSnippetsFetcher.
   void OnFetchFinished(
+      bool fetched_more,
+      base::Optional<FetchingCallback> fetching_callback,

[markusheintz_, 2016/11/03 11:43:54]

Given that this is optional now a comment describing when it is passed in would
be nice.

[tschumann, 2016/11/03 11:55:46]

good point! done. In fact, we should change NotifyMoreSuggestions() to take a
FetchingCallback parameter. Added TODO.

       NTPSnippetsFetcher::OptionalFetchedCategories fetched_categories);
 
   // Moves all snippets from |to_archive| into the archive of the |category|.
   // It also deletes the snippets from the DB and keeps the archive reasonably
   // short.
   void ArchiveSnippets(Category category, NTPSnippet::PtrVector* to_archive);
 
-  // Replace old snippets in |category| by newly available snippets.
-  void ReplaceSnippets(Category category, NTPSnippet::PtrVector new_snippets);
+  // Adds newly available suggestions in |category| to the available ones.
+  // If |replace_snippets| is set, archives existing suggestions.
+  void IncludeSnippets(const Category& category,
+                       NTPSnippet::PtrVector new_snippets,
+                       bool replace_snippets);
 
   // Removes expired dismissed snippets from the service and the database.
   void ClearExpiredDismissedSnippets();
 
   // Removes images from the DB that are not referenced from any known snippet.
   // Needs to iterate the whole snippet database -- so do it often enough to
   // keep it small but not too often as it still iterates over the file system.
   void ClearOrphanedImages();
 
   // Clears all stored snippets and updates the observer.
@@ skipping 37 matching lines @@
   void EnterStateDisabled();
 
   // Disables the service permanently because an unrecoverable error occurred.
   // Do not call directly, use |EnterState| instead.
   void EnterStateError();
 
   // Converts the cached snippets in the given |category| to content suggestions
   // and notifies the observer.
   void NotifyNewSuggestions(Category category);
 
+  // Converts the cached snippets in the given |category| to content suggestions
+  // and passes them to the |callback|.
+  void NotifyMoreSuggestions(Category category,
+                             base::Optional<FetchingCallback> callback);
+
   // Updates the internal status for |category| to |category_status_| and
   // notifies the content suggestions observer if it changed.
   void UpdateCategoryStatus(Category category, CategoryStatus status);
   // Calls UpdateCategoryStatus() for all provided categories.
   void UpdateAllCategoryStatus(CategoryStatus status);
 
   void RestoreCategoriesFromPrefs();
   void StoreCategoriesToPrefs();
 
+  // Implementation for |FetchSnippets| and |Fetch| that calls the snippet
+  // fetcher and replaces or adds the fetched snippets depending on the
+  // |fetch_more| parameter.
+  void FetchSnippetsFromHostsImpl(
+      const std::set<std::string>& hosts,
+      bool interactive_request,
+      bool fetch_more,
+      const std::set<std::string>& known_suggestion_ids,
+      base::Optional<Category> exclusive_category,
+      base::Optional<FetchingCallback> fetched_more_callback);
+
+  // Returns a set of snippet IDs that should not be fetched. These IDs always
+  // include dismissed snippets. If |fetch_more| is set, they include all known
+  // snippet IDs.
+  std::set<std::string> CollectIdsToExclude(
+      bool fetch_more,
+      const std::set<std::string>& additional_ids) const;
+
+  void MarkEmptyCategoriesAsLoading();
+
   State state_;
 
   PrefService* pref_service_;
 
   const Category articles_category_;
 
   // TODO(sfiera): Reduce duplication of CategoryContent with CategoryInfo.
   struct CategoryContent {
     CategoryStatus status = CategoryStatus::INITIALIZING;
 
@@ skipping 20 matching lines @@
 
     // Returns a non-dismissed snippet with the given |id_within_category|, or
     // null if none exist.
     const NTPSnippet* FindSnippet(const std::string& id_within_category) const;
 
     CategoryContent();
     CategoryContent(CategoryContent&&);
     ~CategoryContent();
     CategoryContent& operator=(CategoryContent&&);
   };
-  std::map<Category, CategoryContent, Category::CompareByID> categories_;
+  using CategoryContentMap =
+      std::map<Category, CategoryContent, Category::CompareByID>;
+  CategoryContentMap categories_;
 
   // The ISO 639-1 code of the language used by the application.
   const std::string application_language_code_;
 
   // Classifier that tells us how active the user is. Not owned.
   const UserClassifier* user_classifier_;
 
   // Scheduler for fetching snippets. Not owned.
   NTPSnippetsScheduler* scheduler_;
 
@@ skipping 21 matching lines @@
 
   // Request throttler for limiting requests to thumbnail images.
   RequestThrottler thumbnail_requests_throttler_;
 
   DISALLOW_COPY_AND_ASSIGN(NTPSnippetsService);
 };
 
 }  // namespace ntp_snippets
 
 #endif  // COMPONENTS_NTP_SNIPPETS_REMOTE_NTP_SNIPPETS_SERVICE_H_