MD Downloads: limit the amount of downloads we send

chrome/browser/ui/webui/md_downloads/downloads_list_tracker.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 CHROME_BROWSER_UI_WEBUI_MD_DOWNLOADS_DOWNLOADS_LIST_TRACKER_H_
 #define CHROME_BROWSER_UI_WEBUI_MD_DOWNLOADS_DOWNLOADS_LIST_TRACKER_H_
 
 #include <set>
 
 #include "base/callback_forward.h"
@@ skipping 16 matching lines @@
 }
 
 // A class that tracks all downloads activity and keeps a sorted representation
 // of the downloads as chrome://downloads wants to display them.
 class DownloadsListTracker : public AllDownloadItemNotifier::Observer {
  public:
   DownloadsListTracker(content::DownloadManager* download_manager,
                        content::WebUI* web_ui);
   ~DownloadsListTracker() override;
 
-  // Clears all downloads on the page (if it's ready).
-  void CallClearAll();
-
-  // Shows only downloads that match |search_terms|. An empty list shows all
-  // downloads. Returns whether |search_terms.Equals(&search_terms_)|.
+  // This class only cares about downloads that match |search_terms|.
+  // An empty list shows all downloads (the default). Returns true if
+  // |search_terms| differ from the current ones.
   bool SetSearchTerms(const base::ListValue& search_terms);
 
-  // Sends all downloads and enables updates.
-  void Start();
+  // Starts sending updates and sends a capped amount of downloads. Tracks which
+  // downloads have been sent. Re-call this to send more.
+  void StartAndSendChunk();
 
-  // Stops sending updates to the page.
-  void Stop();
+  // Clears all downloads on the page if currently sending updates, resets chunk
+  // tracking data, and stops sending updates.
+  void Reset();
 
   content::DownloadManager* GetMainNotifierManager() const;
   content::DownloadManager* GetOriginalNotifierManager() const;
 
   // AllDownloadItemNotifier::Observer:
   void OnDownloadCreated(content::DownloadManager* manager,
                          content::DownloadItem* download_item) override;
   void OnDownloadUpdated(content::DownloadManager* manager,
                          content::DownloadItem* download_item) override;
   void OnDownloadRemoved(content::DownloadManager* manager,
@@ skipping 14 matching lines @@
  private:
   struct StartTimeComparator {
     bool operator() (const content::DownloadItem* a,
                      const content::DownloadItem* b) const;
   };
   using SortedSet = std::set<content::DownloadItem*, StartTimeComparator>;
 
   // Called by both constructors to initialize common state.
   void Init();
 
-  // Clears and re-inserts all visible items in a sorted order into
-  // |sorted_visible_items_|.
-  void RebuildSortedSet();
+  // Clears and re-inserts all downloads items into |sorted_items_|.
+  void RebuildSortedItems();
 
   // Whether |item| should show on the current page.
   bool ShouldShow(const content::DownloadItem& item) const;
 
-  // Gets a page index for |position| from |sorted_visible_items_|.
-  int GetIndex(const SortedSet::iterator& position) const;
+  // Returns the index of |item| in |sorted_items_|.
+  size_t GetIndex(const SortedSet::iterator& item) const;
 
-  // Calls "insertItems" if |sending_updates_|.
-  void CallInsertItem(const SortedSet::iterator& insert);
+  // Calls "insertItems" if sending updates and the page knows about |insert|.
+  void InsertItem(const SortedSet::iterator& insert);
 
-  // Calls "updateItem" if |sending_updates_|.
-  void CallUpdateItem(const SortedSet::iterator& update);
+  // Calls "updateItem" if sending updates and the page knows about |update|.
+  void UpdateItem(const SortedSet::iterator& update);
 
-  // Removes the item that corresponds to |remove| and sends a "removeItems"
-  // message to the page if |sending_updates_|.
+  // Removes the item that corresponds to |remove| and sends "removeItems"
+  // if sending updates.
   void RemoveItem(const SortedSet::iterator& remove);
 
   AllDownloadItemNotifier main_notifier_;
   scoped_ptr<AllDownloadItemNotifier> original_notifier_;
 
   // The WebUI object corresponding to the page we care about.
   content::WebUI* const web_ui_;
 
   // Callback used to determine if an item should show on the page. Set to
   // |ShouldShow()| in default constructor, passed in while testing.
   base::Callback<bool(const content::DownloadItem&)> should_show_;
 
   // When this is true, all changes to downloads that affect the page are sent
   // via JavaScript.
   bool sending_updates_ = false;
 
-  SortedSet sorted_visible_items_;
+  SortedSet sorted_items_;
+
+  // The number of items sent to the page so far.
+  size_t sent_to_page_ = 0u;
 
   // Current search terms.
   std::vector<base::string16> search_terms_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadsListTracker);
 };
 
 #endif  // CHROME_BROWSER_UI_WEBUI_MD_DOWNLOADS_DOWNLOADS_LIST_TRACKER_H_