Defer syncing TopSites with history until the first tab closure

chrome/browser/win/jumplist.cc

 // Copyright 2012 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 "chrome/browser/win/jumplist.h"
 
 #include "base/base_paths.h"
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
@@ skipping 203 matching lines @@
       TabRestoreServiceFactory::GetForProfile(profile_);
   if (!tab_restore_service)
     return;
 
   app_id_ =
       shell_integration::win::GetChromiumModelIdForProfile(profile_->GetPath());
 
   scoped_refptr<history::TopSites> top_sites =
       TopSitesFactory::GetForProfile(profile_);
   if (top_sites) {
-    // TopSites updates itself after a delay. This is especially noticable when
-    // your profile is empty. Ask TopSites to update itself when jumplist is
-    // initialized.
-    top_sites->SyncWithHistory();
     // Register as TopSitesObserver so that we can update ourselves when the
-    // TopSites changes.
+    // TopSites changes. TopSites updates itself after a delay. This is
+    // especially noticable when your profile is empty.
     top_sites->AddObserver(this);
   }
   tab_restore_service->AddObserver(this);
   pref_change_registrar_.reset(new PrefChangeRegistrar);
   pref_change_registrar_->Init(profile_->GetPrefs());
   pref_change_registrar_->Add(
       prefs::kIncognitoModeAvailability,
       base::Bind(&JumpList::OnIncognitoAvailabilityChanged, this));
 }
 
@@ skipping 36 matching lines @@
 
 void JumpList::ShutdownOnUIThread() {
   DCHECK(CalledOnValidThread());
   Terminate();
 }
 
 void JumpList::OnMostVisitedURLsAvailable(
     const history::MostVisitedURLList& urls) {
   DCHECK(CalledOnValidThread());
 
-  // At most 9 JumpList items can be displayed for the "Most Visited"
+  // At most 5 JumpList items can be displayed for the "Most Visited"
   // category.
-  const int kMostVistedCount = 9;
+  const int kMostVistedCount = 5;
   {
     JumpListData* data = &jumplist_data_->data;
     base::AutoLock auto_lock(data->list_lock_);
     data->most_visited_pages_.clear();
 
     for (size_t i = 0; i < urls.size() && i < kMostVistedCount; i++) {
       const history::MostVisitedURL& url = urls[i];
       scoped_refptr<ShellLinkItem> link = CreateShellLink();
       std::string url_string = url.url.spec();
       base::string16 url_string_wide = base::UTF8ToUTF16(url_string);
@@ skipping 226 matching lines @@
         base::Bind(&JumpList::DeferredTopSitesChanged, base::Unretained(this)));
   }
 }
 
 void JumpList::DeferredTopSitesChanged() {
   if (updates_to_skip_ > 0) {
     --updates_to_skip_;
     return;
   }
 
+  // Opening the first tab in one session triggers a TopSite history sync.
+  // Delay this sync till the first tab is closed to allow the "recently closed"
+  // category from last session stay longer.
+  if (!has_tab_closed_)
+    return;
+
   scoped_refptr<history::TopSites> top_sites =
       TopSitesFactory::GetForProfile(profile_);
   if (top_sites) {
     top_sites->GetMostVisitedURLs(
         base::Bind(&JumpList::OnMostVisitedURLsAvailable,
                    weak_ptr_factory_.GetWeakPtr()),
         false);
   }
 }
 
 void JumpList::DeferredTabRestoreServiceChanged() {
   if (updates_to_skip_ > 0) {

[grt (UTC plus 2), 2017/05/18 09:35:14]

please add
  DCHECK(CalledOnValidThread());
since this must run on the UI thread. same for DeferredTopSitesChanged, please.

[chengx, 2017/05/19 02:11:58]

Done.

     --updates_to_skip_;
     return;
   }
 
+  // Force to do a TopSite history sync when closing a first tab in one session.

[grt (UTC plus 2), 2017/05/18 09:35:14]

nit: "Force a TopSite..."

[chengx, 2017/05/19 02:11:58]

Done.

+  if (!has_tab_closed_) {
+    has_tab_closed_ = true;
+    scoped_refptr<history::TopSites> top_sites =
+        TopSitesFactory::GetForProfile(profile_);
+    if (top_sites)
+      top_sites->SyncWithHistory();
+  }
+
   // Create a list of ShellLinkItems from the "Recently Closed" pages.
   // As noted above, we create a ShellLinkItem objects with the following
   // parameters.
   // * arguments
   //   The last URL of the tab object.
   // * title
   //   The title of the last URL.
   // * icon
   //   An empty string. This value is to be updated in OnFaviconDataAvailable().
   const int kRecentlyClosedCount = 3;
@@ skipping 74 matching lines @@
   // than the maximum allowed time, as it's very likely the following update
   // steps will also take a long time. As we've not updated the icons on the
   // disk, discarding this update wont't affect the current JumpList used by OS.
   if (begin_update_timer.Elapsed() >= kTimeOutForJumplistBeginUpdate) {
     updates_to_skip_ = kUpdatesToSkipUnderHeavyLoad;
     return false;
   }
 
   // The default maximum number of items to display in JumpList is 10.
   // https://msdn.microsoft.com/library/windows/desktop/dd378398.aspx
-  // The "Most visited" category title always takes 1 of the JumpList slots if
-  // |most_visited_pages| isn't empty.
-  // The "Recently closed" category title will also take 1 if
-  // |recently_closed_pages| isn't empty.
-  // For the remaining slots, we allocate 5/8 (i.e., 5 slots if both categories
-  // present) to "most-visited" items and 3/8 (i.e., 3 slots if both categories
-  // present) to "recently-closed" items, respectively.
-  // Nevertheless, if there are not so many items in |recently_closed_pages|,
-  // we give the remaining slots to "most-visited" items.
+  // The "Most visited" and "Recently closed" category titles always takes 2 of
+  // the JumpList slots. For the remaining slots, we allocate 5/8 (i.e., 5 slots
+  // by default) to "most-visited" items and 3/8 (i.e., 3 slots by default) to
+  // "recently-closed" items, respectively.
 
   const int kMostVisited = 50;
   const int kRecentlyClosed = 30;
   const int kTotal = kMostVisited + kRecentlyClosed;
 
-  // Adjust the available jumplist slots to account for the category titles.
-  size_t user_max_items_adjusted = jumplist_updater.user_max_items();
-  if (!most_visited_pages.empty())
-    --user_max_items_adjusted;
-  if (!recently_closed_pages.empty())
-    --user_max_items_adjusted;
+  // Adjust the available jumplist slots to account for the two category titles.
+  size_t user_max_items_adjusted = jumplist_updater.user_max_items() - 2;
 
+  // Cap 5 items for "Most visited" category, and 3 items for "Recently closed"
+  // category.
+  user_max_items_adjusted = std::min((int)jumplist_updater.user_max_items(), 8);
   size_t most_visited_items =
       MulDiv(user_max_items_adjusted, kMostVisited, kTotal);
   size_t recently_closed_items = user_max_items_adjusted - most_visited_items;
-  if (recently_closed_pages.size() < recently_closed_items) {
-    most_visited_items += recently_closed_items - recently_closed_pages.size();
-    recently_closed_items = recently_closed_pages.size();
-  }
 
   // Record the desired number of icons to create in this JumpList update.
   int icons_to_create = 0;
 
   // Update the icons for "Most Visisted" category of the JumpList if needed.
   if (most_visited_pages_have_updates) {
     base::FilePath icon_dir_most_visited = GenerateJumplistIconDirName(
         profile_dir, FILE_PATH_LITERAL("MostVisited"));
 
     UpdateIconFiles(icon_dir_most_visited, most_visited_pages,
@@ skipping 105 matching lines @@
           app_id, profile_dir, local_most_visited_pages,
           local_recently_closed_pages, most_visited_pages_have_updates,
           recently_closed_pages_have_updates, incognito_availability)) {
     base::AutoLock auto_lock(data->list_lock_);
     if (most_visited_pages_have_updates)
       data->most_visited_pages_have_updates_ = true;
     if (recently_closed_pages_have_updates)
       data->recently_closed_pages_have_updates_ = true;
   }
 }