Add extra information for ReadingList ContentSuggestion

components/ntp_snippets/content_suggestion.h

 // 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.
 
 #ifndef COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_
 #define COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_
 
 #include <memory>
 #include <string>
 
 #include "base/files/file_path.h"
 #include "base/macros.h"
 #include "base/strings/string16.h"
 #include "base/time/time.h"
 #include "components/ntp_snippets/category.h"
 #include "url/gurl.h"
 
 namespace ntp_snippets {
 
+// ReadingListSuggestionExtra contains addition data which is only available for

[Marc Treib, 2017/03/28 13:38:20]

nit: s/addition/additional/

nit: Keep the order consistent with the setters, i.e. move this below
RecentTabSuggestionExtra

[gambard, 2017/03/29 06:51:24]

Done.

+// Reading List suggestions.
+struct ReadingListSuggestionExtra {
+  // State of the distillation a suggestion.

[Olivier, 2017/03/28 13:43:45]

Whi not use ReadingListEntry::DistillationState ?
At least, add a comment saying enums should stay synced.

[gambard, 2017/03/29 06:51:24]

I am not using ReadingListEntry::DistillationState directly because we want to
remove the dependence of components/ntp_snippets on components/reading_list

+  enum class ReadingListSuggestionDistilledState {
+    PROCESSING,
+    SUCCESS,
+    FAILURE
+  };
+
+  // State of the distillation of the suggestion.
+  ReadingListSuggestionDistilledState distilled_state;
+  // URL of the page whose favicon should be displayed for this suggestion.
+  GURL favicon_page_url;

[Marc Treib, 2017/03/28 13:38:20]

Can't this be derived from the URL?
Generally, +jkrcal for favicons, since various things are in progress there.

[gambard, 2017/03/29 06:51:24]

No, this is specific to ReadingList: you can have an entry with the url
chromium.org but there is a redirection to foo.bar, the distillation (= download
for offline availability) ends up at foo.bar. The favicon_page_url will be
foo.bar to display the favicon relative to the final page.
The favicon fetching is done through the standard favicon fetcher component.

[Marc Treib, 2017/03/29 08:24:58]

Redirects are officially The Worst :(
Alright then, though I'd still like to get a sanity check from jkrcal, since I'm
not familiar with the latest state on favicons.

+};
+
 // DownloadSuggestionExtra contains additional data which is only available for
 // download suggestions.
 struct DownloadSuggestionExtra {
   DownloadSuggestionExtra();
   DownloadSuggestionExtra(const DownloadSuggestionExtra&);
   ~DownloadSuggestionExtra();
 
   // The GUID for the downloaded file.
   std::string download_guid;
   // The file path of the downloaded file once download completes.
@@ skipping 107 matching lines @@
       std::unique_ptr<DownloadSuggestionExtra> download_suggestion_extra);
 
   // Extra information for recent tab suggestions. Only available for
   // KnownCategories::RECENT_TABS suggestions.
   RecentTabSuggestionExtra* recent_tab_suggestion_extra() const {
     return recent_tab_suggestion_extra_.get();
   }
   void set_recent_tab_suggestion_extra(
       std::unique_ptr<RecentTabSuggestionExtra> recent_tab_suggestion_extra);
 
+  // Extra information for reading list suggestions. Only available for
+  // KnownCategories::READING_LIST suggestions.
+  ReadingListSuggestionExtra* reading_list_suggestion_extra() const {
+    return reading_list_suggestion_extra_.get();
+  }
+  void set_reading_list_suggestion_extra(
+      std::unique_ptr<ReadingListSuggestionExtra>
+          reading_list_suggestion_extra);
+
   // Extra information for notifications. When absent, no notification should be
   // sent for this suggestion. When present, a notification should be sent,
   // unless other factors disallow it (examples: the extra parameters say to;
   // notifications are disabled; Chrome is in the foreground).
   NotificationExtra* notification_extra() const {
     return notification_extra_.get();
   }
   void set_notification_extra(
       std::unique_ptr<NotificationExtra> notification_extra);
 
   const base::Time& fetch_date() const { return fetch_date_; }
   void set_fetch_date(const base::Time& fetch_date) {
     fetch_date_ = fetch_date;
   }
 
  private:
   ID id_;
   GURL url_;
   base::string16 title_;
   base::string16 snippet_text_;
   base::Time publish_date_;
   base::string16 publisher_name_;
   float score_;
   std::unique_ptr<DownloadSuggestionExtra> download_suggestion_extra_;
   std::unique_ptr<RecentTabSuggestionExtra> recent_tab_suggestion_extra_;
+  std::unique_ptr<ReadingListSuggestionExtra> reading_list_suggestion_extra_;
   std::unique_ptr<NotificationExtra> notification_extra_;
 
   // The time when the remote suggestion was fetched from the server. This field
   // is only populated when the ContentSuggestion is created from a
   // RemoteSuggestion.
   base::Time fetch_date_;
 
   DISALLOW_COPY_AND_ASSIGN(ContentSuggestion);
 };
 
 std::ostream& operator<<(std::ostream& os, const ContentSuggestion::ID& id);
 
 }  // namespace ntp_snippets
 
 #endif  // COMPONENTS_NTP_SNIPPETS_CONTENT_SUGGESTION_H_