Support server categories in NTPSnippetsService.

components/ntp_snippets/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_NTP_SNIPPETS_SERVICE_H_
 #define COMPONENTS_NTP_SNIPPETS_NTP_SNIPPETS_SERVICE_H_
 
 #include <stddef.h>
 
 #include <memory>
@@ skipping 118 matching lines @@
   // (Re)schedules the periodic fetching of snippets. This is necessary because
   // the schedule depends on the time of day.
   void RescheduleFetching();
 
   // ContentSuggestionsProvider implementation
   CategoryStatus GetCategoryStatus(Category category) override;
   CategoryInfo GetCategoryInfo(Category category) override;
   void DismissSuggestion(const std::string& suggestion_id) override;
   void FetchSuggestionImage(const std::string& suggestion_id,
                             const ImageFetchedCallback& callback) override;
-  void ClearCachedSuggestionsForDebugging(Category category) override;
+  void ClearCachedSuggestionsForDebugging(Category category_id) override;

[Marc Treib, 2016/08/22 15:06:47]

?

[sfiera, 2016/08/24 14:35:57]

Done.

   std::vector<ContentSuggestion> GetDismissedSuggestionsForDebugging(
       Category category) override;
   void ClearDismissedSuggestionsForDebugging(Category category) override;
 
   // Returns the lists of suggestion hosts the snippets are restricted to.
   std::set<std::string> GetSuggestionsHosts() const;
 
   // Returns the maximum number of snippets that will be shown at once.
   static int GetMaxSnippetCountForTesting();
 
   // Available snippets, only for unit tests.
-  const NTPSnippet::PtrVector& GetSnippetsForTesting() const {
-    return snippets_;
+  const NTPSnippet::PtrVector& GetSnippetsForTesting(Category category) const {
+    return categories_.find(category)->second.snippets;
   }
 
  private:
   friend class NTPSnippetsServiceTest;
   FRIEND_TEST_ALL_PREFIXES(NTPSnippetsServiceTest, StatusChanges);
 
   // Possible state transitions:
   //       NOT_INITED --------+
   //       /       \          |
   //      v         v         |
@@ skipping 38 matching lines @@
   void OnDatabaseLoaded(NTPSnippet::PtrVector snippets);
   void OnDatabaseError();
 
   // Callback for the SuggestionsService.
   void OnSuggestionsChanged(const suggestions::SuggestionsProfile& suggestions);
 
   // Callback for the NTPSnippetsFetcher.
   void OnFetchFinished(NTPSnippetsFetcher::OptionalSnippets snippets);
 
   // Merges newly available snippets with the previously available list.
-  void MergeSnippets(NTPSnippet::PtrVector new_snippets);
+  void MergeSnippets(Category category, NTPSnippet::PtrVector new_snippets);
 
   std::set<std::string> GetSnippetHostsFromPrefs() const;
   void StoreSnippetHostsToPrefs(const std::set<std::string>& hosts);
 
   // Removes the expired snippets (including dismissed) from the service and the
   // database, and schedules another pass for the next expiration.
-  void ClearExpiredSnippets();
+  void ClearExpiredSnippets(Category category);
 
   // Completes the initialization phase of the service, registering the last
   // observers. This is done after construction, once the database is loaded.
   void FinishInitialization();
 
   void OnSnippetImageFetchedFromDatabase(const ImageFetchedCallback& callback,
-                                         const std::string& snippet_id,
+                                         const std::string& suggestion_id,
                                          std::string data);
 
   void OnSnippetImageDecodedFromDatabase(const ImageFetchedCallback& callback,
-                                         const std::string& snippet_id,
+                                         const std::string& suggestion_id,
                                          const gfx::Image& image);
 
-  void FetchSnippetImageFromNetwork(const std::string& snippet_id,
+  void FetchSnippetImageFromNetwork(const std::string& suggestion_id,
                                     const ImageFetchedCallback& callback);
 
   void OnSnippetImageDecodedFromNetwork(const ImageFetchedCallback& callback,
                                         const std::string& snippet_id,
                                         const gfx::Image& image);
 
   // Triggers a state transition depending on the provided reason to be
   // disabled (or lack thereof). This method is called when a change is detected
   // by |snippets_status_service_|.
   void OnDisabledReasonChanged(DisabledReason disabled_reason);
 
   // Verifies state transitions (see |State|'s documentation) and applies them.
   // Also updates the provider status. Does nothing except updating the provider
   // status if called with the current state.
-  void EnterState(State state, CategoryStatus status);
+  void EnterState(State state);
 
   // Enables the service and triggers a fetch if required. Do not call directly,
   // use |EnterState| instead.
   void EnterStateEnabled(bool fetch_snippets);
 
   // Disables the service. Do not call directly, use |EnterState| instead.
   void EnterStateDisabled();
 
   // Disables the service permanently because an unrecoverable error occurred.
   // Do not call directly, use |EnterState| instead.
   void EnterStateError();
 
   // Converts the cached snippets to article content suggestions and notifies
   // the observers.
   void NotifyNewSuggestions();
 
-  // Updates the internal status |category_status_| and notifies the content
-  // suggestions observer if it changed.
-  void UpdateCategoryStatus(CategoryStatus status);
+  // Updates the internal status for |category| to |category_status_| and
+  // notifies the content suggestions observer if it changed.
+  void UpdateCategoryStatus(Category category, CategoryStatus status);
+  void UpdateAllCategoryStatus(CategoryStatus status);

[Marc Treib, 2016/08/22 15:06:47]

Add comment?

[sfiera, 2016/08/24 14:35:57]

Done.

 
   State state_;
 
-  CategoryStatus category_status_;
-
   PrefService* pref_service_;
 
   suggestions::SuggestionsService* suggestions_service_;
 
-  // All current suggestions (i.e. not dismissed ones).
-  NTPSnippet::PtrVector snippets_;
+  const Category articles_category_;
 
-  // Suggestions that the user dismissed. We keep these around until they expire
-  // so we won't re-add them on the next fetch.
-  NTPSnippet::PtrVector dismissed_snippets_;
+  struct CategoryContent {
+    CategoryStatus status = CategoryStatus::INITIALIZING;
+
+    // All current suggestions (i.e. not dismissed ones).
+    NTPSnippet::PtrVector snippets;
+
+    // Suggestions that the user dismissed. We keep these around until they
+    // expire so we won't re-add them on the next fetch.
+    NTPSnippet::PtrVector dismissed;
+  };
+  std::map<Category, CategoryContent, Category::CompareByID> categories_;
 
   // The ISO 639-1 code of the language used by the application.
   const std::string application_language_code_;
 
   // Scheduler for fetching snippets. Not owned.
   NTPSnippetsScheduler* scheduler_;
 
   // The subscription to the SuggestionsService. When the suggestions change,
   // SuggestionsService will call |OnSuggestionsChanged|, which triggers an
   // update to the set of snippets.
@@ skipping 13 matching lines @@
   // The database for persisting snippets.
   std::unique_ptr<NTPSnippetsDatabase> database_;
 
   // The service that provides events and data about the signin and sync state.
   std::unique_ptr<NTPSnippetsStatusService> snippets_status_service_;
 
   // Set to true if FetchSnippets is called before the database has been loaded.
   // The fetch will be executed after the database load finishes.
   bool fetch_after_load_;
 
-  const Category provided_category_;
-
   // Request throttler for limiting requests to thumbnail images.
   RequestThrottler thumbnail_requests_throttler_;
 
   DISALLOW_COPY_AND_ASSIGN(NTPSnippetsService);
 };
 
 }  // namespace ntp_snippets
 
 #endif  // COMPONENTS_NTP_SNIPPETS_NTP_SNIPPETS_SERVICE_H_