Add the ability to cancel prerender reqeusts and tests

components/offline_pages/background/request_coordinator.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/background/request_coordinator.h"
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/logging.h"
 #include "components/offline_pages/background/offliner_factory.h"
 #include "components/offline_pages/background/offliner_policy.h"
 #include "components/offline_pages/background/request_picker.h"
 #include "components/offline_pages/background/save_page_request.h"
 #include "components/offline_pages/background/scheduler.h"
 #include "components/offline_pages/offline_page_item.h"
 
 namespace offline_pages {
 
 RequestCoordinator::RequestCoordinator(std::unique_ptr<OfflinerPolicy> policy,
                                        std::unique_ptr<OfflinerFactory> factory,
                                        std::unique_ptr<RequestQueue> queue,
                                        std::unique_ptr<Scheduler> scheduler)
-    : policy_(std::move(policy)),
+    : offliner_(nullptr),
+      policy_(std::move(policy)),
       factory_(std::move(factory)),
       queue_(std::move(queue)),
       scheduler_(std::move(scheduler)),
       last_offlining_status_(Offliner::RequestStatus::UNKNOWN),
       weak_ptr_factory_(this) {
   DCHECK(policy_ != nullptr);
   picker_.reset(new RequestPicker(queue_.get()));
 }
 
 RequestCoordinator::~RequestCoordinator() {}
@@ skipping 45 matching lines @@
 void RequestCoordinator::RequestQueueEmpty() {
   // Clear the outstanding "safety" task in the scheduler.
   scheduler_->Unschedule();
   // Return control to the scheduler when there is no more to do.
   scheduler_callback_.Run(true);
 }
 
 bool RequestCoordinator::StartProcessing(
     const DeviceConditions& device_conditions,
     const base::Callback<void(bool)>& callback) {
+  started_ = false;
+  cancelled_ = false;

[Pete Williamson, 2016/06/22 22:53:22]

FYI - there may be some overlap with the is_busy_ flag in another changelist
(2078113002), I will be merging before this changelist gets submitted.

[chili, 2016/06/23 05:42:06]

nit - we seem to have different spellings of cancelled everywhere, though the
concensus appears to be 'canceled'....

It was confusing with ArchiverResult::CANCELED and then
SavePageResult::CANCELLED

[Pete Williamson, 2016/06/23 16:46:13]

When I checked with a dictionary, both were legit, so I changed mine to
'canceled' for consistency with other code.

   scheduler_callback_ = callback;
   // TODO(petewil): Check existing conditions (should be passed down from
   // BackgroundTask)
 
+  GetOffliner();
+  if (!offliner_) {
+    DVLOG(0) << "Unable to create Offliner. "
+             << "Cannot background offline page.";
+    return false;
+  }
+
   TryNextRequest();
 
   // TODO(petewil): Should return true if the caller should expect a
   // callback.  Return false if there is already a request running.
   // Probably best to do this when I prevent multiple instances from
   // running at the same time.
   return true;
 }
 
 void RequestCoordinator::TryNextRequest() {
   // Choose a request to process that meets the available conditions.
   // This is an async call, and returns right away.
   picker_->ChooseNextRequest(
       base::Bind(&RequestCoordinator::RequestPicked,
                  weak_ptr_factory_.GetWeakPtr()),
       base::Bind(&RequestCoordinator::RequestQueueEmpty,
                  weak_ptr_factory_.GetWeakPtr()));
 }
 
 void RequestCoordinator::StopProcessing() {
+  cancelled_ = true;
+  if (offliner_ && started_)
+    offliner_->Cancel();
 }
 
 void RequestCoordinator::SendRequestToOffliner(const SavePageRequest& request) {
-  // TODO(petewil): Ensure only one offliner at a time is used.
-  // TODO(petewil): When we have multiple offliners, we need to pick one.
-  Offliner* offliner = factory_->GetOffliner(policy_.get());
-  if (!offliner) {
+  if (cancelled_)
+    return;
+  started_ = true;
+
+  GetOffliner();
+  if (!offliner_) {
     DVLOG(0) << "Unable to create Offliner. "
              << "Cannot background offline page.";
     return;
   }
 
   // Start the load and save process in the offliner (Async).
-  offliner->LoadAndSave(request,
-                        base::Bind(&RequestCoordinator::OfflinerDoneCallback,
-                                   weak_ptr_factory_.GetWeakPtr()));
+  offliner_->LoadAndSave(request,
+                         base::Bind(&RequestCoordinator::OfflinerDoneCallback,
+                                    weak_ptr_factory_.GetWeakPtr()));
 }
 
 void RequestCoordinator::OfflinerDoneCallback(const SavePageRequest& request,
                                               Offliner::RequestStatus status) {
   DVLOG(2) << "offliner finished, saved: "
-           << (status == Offliner::RequestStatus::SAVED) << ", "
-           << __FUNCTION__;
+           << (status == Offliner::RequestStatus::SAVED) << ", status: "
+           << (int) status << ", " << __FUNCTION__;
   last_offlining_status_ = status;
+  started_ = false;
 
   // If the request succeeded, remove it from the Queue and maybe schedule
   // another one.
   if (status == Offliner::RequestStatus::SAVED) {
     queue_->RemoveRequest(request.request_id(),
                           base::Bind(&RequestCoordinator::UpdateRequestCallback,
                                      weak_ptr_factory_.GetWeakPtr()));
 
     // TODO(petewil): Check time budget. Return to the scheduler if we are out.
 
     // Start another request if we have time.
     TryNextRequest();
   }
 }
 
+void RequestCoordinator::GetOffliner() {
+    if (!offliner_) {
+      offliner_ = factory_->GetOffliner(policy_.get());
+    }
+}
+
 }  // namespace offline_pages