[Offline pages] Update background loader to override the WebContentsObserver methods expected

components/offline_pages/core/snapshot_controller.cc

 // 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.
 
 #include "components/offline_pages/core/snapshot_controller.h"
 
 #include "base/bind.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/time/time.h"
 #include "components/offline_pages/core/offline_page_feature.h"
 
 namespace {
 // Default delay, in milliseconds, between the main document parsed event and
 // snapshot. Note: this snapshot might not occur if the OnLoad event and
 // OnLoad delay elapses first to trigger a final snapshot.
-const int64_t kDefaultDelayAfterDocumentAvailableMs = 7000;
+const int64_t kDefaultDelayAfterDocumentLoadedMs = 7000;
 
 // Default delay, in milliseconds, between the main document OnLoad event and
 // snapshot.
-const int64_t kDelayAfterDocumentOnLoadCompletedMs = 1000;
+const int64_t kDelayAfterLoadCompletedMs = 1000;

[Pete Williamson, 2017/04/05 00:26:21]

Shouldn't this be 2000?

I was thinking all along it was 2000, and the extra time helps us to not be busy
rearranging the DOM when we snapshot.

[chili, 2017/04/05 00:34:33]

This is the default number.  Both offliners pass in 2000.  I think the
RecentTabHelper is using 1000, but RTH is also using DocumentOnLoadCompleted
rather than DidStopLoading.

 
 // Delay for testing to keep polling times reasonable.
 const int64_t kDelayForTests = 0;
 
 }  // namespace
 
 namespace offline_pages {
 
 SnapshotController::SnapshotController(
     const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
     SnapshotController::Client* client)
     : SnapshotController(task_runner,
                          client,
-                         kDefaultDelayAfterDocumentAvailableMs,
-                         kDelayAfterDocumentOnLoadCompletedMs) {}
+                         kDefaultDelayAfterDocumentLoadedMs,
+                         kDelayAfterLoadCompletedMs) {}
 
 SnapshotController::SnapshotController(
     const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
     SnapshotController::Client* client,
-    int64_t delay_after_document_available_ms,
-    int64_t delay_after_document_on_load_completed_ms)
+    int64_t delay_after_document_loaded_ms,
+    int64_t delay_after_load_completed_ms)
     : task_runner_(task_runner),
       client_(client),
       state_(State::READY),
-      delay_after_document_available_ms_(delay_after_document_available_ms),
-      delay_after_document_on_load_completed_ms_(
-          delay_after_document_on_load_completed_ms),
+      delay_after_document_loaded_ms_(delay_after_document_loaded_ms),
+      delay_after_load_completed_ms_(delay_after_load_completed_ms),
       weak_ptr_factory_(this) {
   if (offline_pages::ShouldUseTestingSnapshotDelay()) {
-    delay_after_document_available_ms_ = kDelayForTests;
-    delay_after_document_on_load_completed_ms_ = kDelayForTests;
+    delay_after_document_loaded_ms_ = kDelayForTests;
+    delay_after_load_completed_ms_ = kDelayForTests;
   }
 }
 
 SnapshotController::~SnapshotController() {}
 
 void SnapshotController::Reset() {
   // Cancel potentially delayed tasks that relate to the previous 'session'.
   weak_ptr_factory_.InvalidateWeakPtrs();
   state_ = State::READY;
   current_page_quality_ = PageQuality::POOR;
 }
 
 void SnapshotController::Stop() {
   state_ = State::STOPPED;
 }
 
 void SnapshotController::PendingSnapshotCompleted() {
   // Unless the controller is "stopped", enable the subsequent snapshots.
   // Stopped state prevents any further snapshots form being started.
   if (state_ == State::STOPPED)
     return;
   state_ = State::READY;
 }
 
-void SnapshotController::DocumentAvailableInMainFrame() {
+void SnapshotController::DocumentLoadedInMainFrame() {
   DCHECK_EQ(PageQuality::POOR, current_page_quality_);
   // Post a delayed task to snapshot.
   task_runner_->PostDelayedTask(
-      FROM_HERE, base::Bind(&SnapshotController::MaybeStartSnapshot,
-                            weak_ptr_factory_.GetWeakPtr(),
-                            PageQuality::FAIR_AND_IMPROVING),
-      base::TimeDelta::FromMilliseconds(delay_after_document_available_ms_));
+      FROM_HERE,
+      base::Bind(&SnapshotController::MaybeStartSnapshot,
+                 weak_ptr_factory_.GetWeakPtr(),
+                 PageQuality::FAIR_AND_IMPROVING),
+      base::TimeDelta::FromMilliseconds(delay_after_document_loaded_ms_));
+}
+
+void SnapshotController::DidStopLoading() {
+  // Post a delayed task to snapshot and then stop this controller.
+  task_runner_->PostDelayedTask(
+      FROM_HERE,
+      base::Bind(&SnapshotController::MaybeStartSnapshotThenStop,
+                 weak_ptr_factory_.GetWeakPtr()),
+      base::TimeDelta::FromMilliseconds(delay_after_load_completed_ms_));
+}
+
+void SnapshotController::DocumentAvailableInMainFrame() {
+  // Maps to DocumentLoadedInMainFrame for now.
+  DocumentLoadedInMainFrame();
 }
 
 void SnapshotController::DocumentOnLoadCompletedInMainFrame() {
-  // Post a delayed task to snapshot and then stop this controller.
-  task_runner_->PostDelayedTask(
-      FROM_HERE, base::Bind(&SnapshotController::MaybeStartSnapshotThenStop,
-                            weak_ptr_factory_.GetWeakPtr()),
-      base::TimeDelta::FromMilliseconds(
-          delay_after_document_on_load_completed_ms_));
+  // Maps to DidStopLoading for now.
+  DidStopLoading();
 }
 
 void SnapshotController::MaybeStartSnapshot(PageQuality updated_page_quality) {
   if (state_ != State::READY)
     return;
   DCHECK_LT(current_page_quality_, updated_page_quality);
   current_page_quality_ = updated_page_quality;
   state_ = State::SNAPSHOT_PENDING;
   client_->StartSnapshot();
 }
 
 void SnapshotController::MaybeStartSnapshotThenStop() {
   MaybeStartSnapshot(PageQuality::HIGH);
   Stop();
 }
 
-int64_t SnapshotController::GetDelayAfterDocumentAvailableForTest() {
-  return delay_after_document_available_ms_;
+int64_t SnapshotController::GetDelayAfterDocumentLoadedForTest() {
+  return delay_after_document_loaded_ms_;
 }
 
-int64_t SnapshotController::GetDelayAfterDocumentOnLoadCompletedForTest() {
-  return delay_after_document_on_load_completed_ms_;
+int64_t SnapshotController::GetDelayAfterLoadCompletedForTest() {
+  return delay_after_load_completed_ms_;
 }
 
 }  // namespace offline_pages