Add pause/resume functionality to precache

components/precache/content/precache_manager.cc

 // Copyright 2013 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 "components/precache/content/precache_manager.h"
 
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/command_line.h"
-#include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/metrics/field_trial.h"
 #include "base/strings/string_util.h"
 #include "base/time/time.h"
 #include "components/history/core/browser/history_service.h"
 #include "components/precache/core/precache_database.h"
 #include "components/precache/core/precache_switches.h"
+#include "components/precache/core/proto/unfinished_work.pb.h"
 #include "components/prefs/pref_service.h"
 #include "components/sync_driver/sync_service.h"
 #include "components/variations/variations_associated_data.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/storage_partition.h"
 #include "net/base/network_change_notifier.h"
 
 using content::BrowserThread;
 
@@ skipping 10 matching lines @@
 
 namespace precache {
 
 size_t NumTopHosts() {
   return kNumTopHosts;
 }
 
 PrecacheManager::PrecacheManager(
     content::BrowserContext* browser_context,
     const sync_driver::SyncService* const sync_service,
-    const history::HistoryService* const history_service)
+    const history::HistoryService* const history_service,
+    const base::FilePath& db_path,
+    std::unique_ptr<PrecacheDatabase> precache_database)
     : browser_context_(browser_context),
       sync_service_(sync_service),
       history_service_(history_service),
-      precache_database_(new PrecacheDatabase()),
       is_precaching_(false) {
-  base::FilePath db_path(browser_context_->GetPath().Append(
-      base::FilePath(FILE_PATH_LITERAL("PrecacheDatabase"))));
+  precache_database_ = std::move(precache_database);
 
   BrowserThread::PostTask(
       BrowserThread::DB, FROM_HERE,
       base::Bind(base::IgnoreResult(&PrecacheDatabase::Init),
                  base::Unretained(precache_database_.get()), db_path));
 }
 
 PrecacheManager::~PrecacheManager() {
   // DeleteSoon posts a non-nestable task to the task runner, so any previously
   // posted tasks that rely on an Unretained precache_database_ will finish
@@ skipping 46 matching lines @@
     const PrecacheCompletionCallback& precache_completion_callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
   if (is_precaching_) {
     DLOG(WARNING) << "Cannot start precaching because precaching is already "
                      "in progress.";
     return;
   }
   precache_completion_callback_ = precache_completion_callback;
 
+  is_precaching_ = true;
+  BrowserThread::PostTaskAndReplyWithResult(
+      BrowserThread::DB,
+      FROM_HERE,
+      base::Bind(&PrecacheDatabase::GetUnfinishedWork,
+                 base::Unretained(precache_database_.get())),
+      base::Bind(&PrecacheManager::OnGetUnfinishedWorkDone, AsWeakPtr()));
+}
+
+void PrecacheManager::OnGetUnfinishedWorkDone(
+    std::unique_ptr<PrecacheUnfinishedWork> unfinished_work) {
+  base::Time start_time = base::Time::FromInternalValue(
+      unfinished_work->start_time());
+  if (!start_time.is_null() &&

[sclittle, 2016/05/20 21:57:07]

nit: could you explicitly check has_start_time instead of assuming that null is
the default value? It just seems clearer and more readable.

[bengr, 2016/05/21 00:16:32]

Done.

+      base::Time::Now() - base::Time::FromInternalValue(
+      unfinished_work->start_time()) > base::TimeDelta::FromHours(6)) {

[sclittle, 2016/05/20 21:57:07]

Instead of measuring start_time from when the config is fetched, should it
instead track when the proto is created and the hosts are added? e.g. it's
theoretically possible for the hosts to be much older than the config.

[bengr, 2016/05/21 00:16:32]

Done.

+      BrowserThread::PostTask(
+          BrowserThread::DB, FROM_HERE,
+          base::Bind(&PrecacheDatabase::DeleteUnfinishedWork,

[sclittle, 2016/05/20 21:57:07]

Should the UnfinishedWork be deleted from the database right after you read it
in, instead of removing it here?

[bengr, 2016/05/21 00:16:32]

Done.

+                     precache_database_->GetWeakPtr()));
+    PrecacheFetcher::RecordCompletionStatistics(
+        *(unfinished_work.get()),
+        unfinished_work->manifest_size(),
+        unfinished_work->resource_size());
+    unfinished_work.reset(new PrecacheUnfinishedWork);
+  }
+  unfinished_work_ = std::move(unfinished_work);
+  bool needs_top_hosts = unfinished_work_->top_host_size() == 0;
+
   if (IsInExperimentGroup()) {
-    is_precaching_ = true;
-
     BrowserThread::PostTask(
         BrowserThread::DB, FROM_HERE,
         base::Bind(&PrecacheDatabase::DeleteExpiredPrecacheHistory,
                    base::Unretained(precache_database_.get()),
                    base::Time::Now()));
 
     // Request NumTopHosts() top hosts. Note that PrecacheFetcher is further
     // bound by the value of PrecacheConfigurationSettings.top_sites_count, as
     // retrieved from the server.
-    history_service_->TopHosts(
-        NumTopHosts(),
-        base::Bind(&PrecacheManager::OnHostsReceived, AsWeakPtr()));
+    if (needs_top_hosts) {
+      history_service_->TopHosts(
+          NumTopHosts(),
+          base::Bind(&PrecacheManager::OnHostsReceived, AsWeakPtr()));
+    } else {
+      InitializeAndStartFetcher();
+    }
   } else if (IsInControlGroup()) {
-    // Set is_precaching_ so that the longer delay is placed between calls to
-    // TopHosts.
-    is_precaching_ = true;
-
     // Calculate TopHosts solely for metrics purposes.
-    history_service_->TopHosts(
-        NumTopHosts(),
-        base::Bind(&PrecacheManager::OnHostsReceivedThenDone, AsWeakPtr()));
+    if (needs_top_hosts) {
+      history_service_->TopHosts(
+          NumTopHosts(),
+          base::Bind(&PrecacheManager::OnHostsReceivedThenDone, AsWeakPtr()));
+    } else {
+      OnDone();
+    }
   } else {
     if (PrecachingAllowed() != AllowedType::PENDING) {
       // We are not waiting on the sync backend to be initialized. The user
       // either is not in the field trial, or does not have sync enabled.
       // Pretend that precaching started, so that the PrecacheServiceLauncher
       // doesn't try to start it again.
-      is_precaching_ = true;
     }
 
     OnDone();
   }
 }
 
 void PrecacheManager::CancelPrecaching() {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
-
   if (!is_precaching_) {
     // Do nothing if precaching is not in progress.
     return;
   }
   is_precaching_ = false;
-
-  // Destroying the |precache_fetcher_| will cancel any fetch in progress.
-  precache_fetcher_.reset();
-
-  // Uninitialize the callback so that any scoped_refptrs in it are released.
+  // If cancellation occurs after StartPrecaching but before OnHostsReceived,
+  // is_precaching will be true, but the precache_fetcher_ will not yet be
+  // constructed.
+  if (precache_fetcher_) {
+    std::unique_ptr<PrecacheUnfinishedWork> unfinished_work =
+        precache_fetcher_->CancelPrecaching();
+    BrowserThread::PostTask(
+        BrowserThread::DB,
+        FROM_HERE,
+        base::Bind(&PrecacheDatabase::SaveUnfinishedWork,
+                   precache_database_->GetWeakPtr(),
+                   base::Passed(&unfinished_work)));
+    // Destroying the |precache_fetcher_| will cancel any fetch in progress.
+    precache_fetcher_.reset();
+  }
   precache_completion_callback_.Reset();
 }
 
 bool PrecacheManager::IsPrecaching() const {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   return is_precaching_;
 }
 
 void PrecacheManager::RecordStatsForFetch(const GURL& url,
                                           const GURL& referrer,
@@ skipping 58 matching lines @@
       base::Bind(&PrecacheDatabase::ClearHistory,
                  base::Unretained(precache_database_.get())));
 }
 
 void PrecacheManager::Shutdown() {
   CancelPrecaching();
 }
 
 void PrecacheManager::OnDone() {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
-
+  BrowserThread::PostTask(
+      BrowserThread::DB, FROM_HERE,
+      base::Bind(&PrecacheDatabase::DeleteUnfinishedWork,
+                 precache_database_->GetWeakPtr()));
   precache_fetcher_.reset();
 
   // Run completion callback if not null. It's null if the client is in the
   // Control group and CancelPrecaching is called before TopHosts computation
   // finishes.
   if (!precache_completion_callback_.is_null()) {
     precache_completion_callback_.Run(!is_precaching_);
     // Uninitialize the callback so that any scoped_refptrs in it are released.
     precache_completion_callback_.Reset();
   }
 
   is_precaching_ = false;
 }
 
 void PrecacheManager::OnHostsReceived(
     const history::TopHostsList& host_counts) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
+  std::vector<std::string> hosts;
+  for (const auto& host_count : host_counts)
+    unfinished_work_->add_top_host()->set_hostname(host_count.first);
+  InitializeAndStartFetcher();
+}
+
+void PrecacheManager::InitializeAndStartFetcher() {
   if (!is_precaching_) {
     // Don't start precaching if it was canceled while waiting for the list of
     // hosts.
     return;
   }
-
-  std::vector<std::string> hosts;
-  for (const auto& host_count : host_counts)
-    hosts.push_back(host_count.first);
-
   // Start precaching.
   precache_fetcher_.reset(new PrecacheFetcher(
-      hosts,
       content::BrowserContext::GetDefaultStoragePartition(browser_context_)->
             GetURLRequestContext(),
       GURL(variations::GetVariationParamValue(
           kPrecacheFieldTrialName, kConfigURLParam)),
       variations::GetVariationParamValue(
           kPrecacheFieldTrialName, kManifestURLPrefixParam),
+      std::move(unfinished_work_),
       this));
   precache_fetcher_->Start();
 }
 
 void PrecacheManager::OnHostsReceivedThenDone(
     const history::TopHostsList& host_counts) {
   OnDone();
 }
 
 }  // namespace precache