API to provide status of save page reqeusts to API.

components/offline_pages/background/request_coordinator_unittest.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 <memory>
 #include <utility>
 #include <vector>
 
@@ skipping 12 matching lines @@
 #include "components/offline_pages/background/request_queue_in_memory_store.h"
 #include "components/offline_pages/background/save_page_request.h"
 #include "components/offline_pages/background/scheduler.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace offline_pages {
 
 namespace {
 // put test constants here
 const GURL kUrl("http://universe.com/everything");
-const ClientId kClientId("bookmark", "42");
+const GURL kUrl2("http://universe.com/nothing");
+const std::string kClientNamespace("bookmark");
+const std::string kId1("42");
+const std::string kId2("life*universe+everything");
+const ClientId kClientId(kClientNamespace, kId1);
+const ClientId kClientId2(kClientNamespace, kId2);
 const int kRequestId(1);
 const long kTestTimeoutSeconds = 1;
 const long kTestTimeBudgetSeconds = 200;
 const int kBatteryPercentageHigh = 75;
 const bool kPowerRequired = true;
 const bool kUserRequested = true;
 const int kAttemptCount = 1;
+const int kAttemptCountTooHigh = 5;
 }  // namespace
 
 class SchedulerStub : public Scheduler {
  public:
   SchedulerStub()
       : schedule_called_(false),
         unschedule_called_(false),
         conditions_(false, 0, false) {}
 
   void Schedule(const TriggerConditions& trigger_conditions) override {
@@ skipping 80 matching lines @@
   void PumpLoop();
 
   RequestCoordinator* coordinator() {
     return coordinator_.get();
   }
 
   bool is_busy() {
     return coordinator_->is_busy();
   }
 
-  // Empty callback function
+  // Empty callback function.
   void EmptyCallbackFunction(bool result) {
   }
 
   // Callback function which releases a wait for it.
   void WaitingCallbackFunction(bool result) {
     waiter_.Signal();
   }
 
-  // Callback for Add requests
+  // Callback for Add requests.
   void AddRequestDone(RequestQueue::AddRequestResult result,
                       const SavePageRequest& request);
 
   // Callback for getting requests.
   void GetRequestsDone(RequestQueue::GetRequestsResult result,
                        const std::vector<SavePageRequest>& requests);
 
+  // Callback for getting request statuses.
+  void GetRequestStatusesDone(const std::vector<RequestStatus>& statuses);
+
   void SendOfflinerDoneCallback(const SavePageRequest& request,
                                 Offliner::RequestStatus status);
 
   RequestQueue::GetRequestsResult last_get_requests_result() const {
     return last_get_requests_result_;
   }
 
   const std::vector<SavePageRequest>& last_requests() const {
     return last_requests_;
   }
 
+  const std::vector<RequestStatus>& last_statuses() const {
+    return last_statuses_;
+  }
+
   void EnableOfflinerCallback(bool enable) {
     offliner_->enable_callback(enable);
   }
 
   void SetOfflinerTimeoutForTest(const base::TimeDelta& timeout) {
     coordinator_->SetOfflinerTimeoutForTest(timeout);
   }
 
   void SetDeviceConditionsForTest(DeviceConditions device_conditions) {
     coordinator_->SetDeviceConditionsForTest(device_conditions);
   }
 
   void WaitForCallback() {
     waiter_.Wait();
   }
 
   void AdvanceClockBy(base::TimeDelta delta) {
     task_runner_->FastForwardBy(delta);
   }
 
   Offliner::RequestStatus last_offlining_status() const {
     return coordinator_->last_offlining_status_;
   }
 
   bool OfflinerWasCanceled() const { return offliner_->cancel_called(); }
 
  private:
   RequestQueue::GetRequestsResult last_get_requests_result_;
   std::vector<SavePageRequest> last_requests_;
+  std::vector<RequestStatus> last_statuses_;
   scoped_refptr<base::TestMockTimeTaskRunner> task_runner_;
   base::ThreadTaskRunnerHandle task_runner_handle_;
   std::unique_ptr<RequestCoordinator> coordinator_;
   OfflinerStub* offliner_;
   base::WaitableEvent waiter_;
 };
 
 RequestCoordinatorTest::RequestCoordinatorTest()
     : last_get_requests_result_(RequestQueue::GetRequestsResult::STORE_FAILURE),
       task_runner_(new base::TestMockTimeTaskRunner),
@@ skipping 23 matching lines @@
   task_runner_->RunUntilIdle();
 }
 
 void RequestCoordinatorTest::GetRequestsDone(
     RequestQueue::GetRequestsResult result,
     const std::vector<SavePageRequest>& requests) {
   last_get_requests_result_ = result;
   last_requests_ = requests;
 }
 
+void RequestCoordinatorTest::GetRequestStatusesDone(
+    const std::vector<RequestStatus>& statuses)  {
+  last_statuses_ = statuses;
+  waiter_.Signal();
+}
+
 void RequestCoordinatorTest::AddRequestDone(
     RequestQueue::AddRequestResult result,
     const SavePageRequest& request) {}
 
 void RequestCoordinatorTest::SendOfflinerDoneCallback(
     const SavePageRequest& request, Offliner::RequestStatus status) {
   // Using the fact that the test class is a friend, call to the callback
   coordinator_->OfflinerDoneCallback(request, status);
 }
 
@@ skipping 258 matching lines @@
   // which won't time out immediately, so the watchdog thread doesn't kill valid
   // tasks too soon.
   WaitForCallback();
   PumpLoop();
 
   EXPECT_TRUE(OfflinerWasCanceled());
   EXPECT_EQ(Offliner::RequestStatus::REQUEST_COORDINATOR_CANCELED,
             last_offlining_status());
 }
 
-
 TEST_F(RequestCoordinatorTest, TimeBudgetExceeded) {
-  // Build a request to use with the pre-renderer, and put it on the queue.
+  // Build two requests to use with the pre-renderer, and put it on the queue.
   offline_pages::SavePageRequest request1(
       kRequestId, kUrl, kClientId, base::Time::Now(), kUserRequested);
   offline_pages::SavePageRequest request2(
       kRequestId + 1, kUrl, kClientId, base::Time::Now(), kUserRequested);
   request2.set_attempt_count(kAttemptCount);
   coordinator()->queue()->AddRequest(
       request1,
       base::Bind(&RequestCoordinatorTest::AddRequestDone,
                  base::Unretained(this)));
     coordinator()->queue()->AddRequest(
-      request1,
+        request1,  // TODO: This is a bug, should be request2, fix it later.

[fgorski, 2016/08/02 04:18:12]

nit: TODO(whom)

[Pete Williamson, 2016/08/03 00:24:32]

Done.

       base::Bind(&RequestCoordinatorTest::AddRequestDone,
                  base::Unretained(this)));
   PumpLoop();
 
   // Set up for the call to StartProcessing.
   DeviceConditions device_conditions(
       !kPowerRequired, kBatteryPercentageHigh,
       net::NetworkChangeNotifier::CONNECTION_3G);
   base::Callback<void(bool)> callback =
       base::Bind(&RequestCoordinatorTest::WaitingCallbackFunction,
@@ skipping 13 matching lines @@
   // Verify the request gets removed from the queue, and wait for callbacks.
   coordinator()->queue()->GetRequests(
       base::Bind(&RequestCoordinatorTest::GetRequestsDone,
                  base::Unretained(this)));
   PumpLoop();
 
   // We should find one request in the queue.
   EXPECT_EQ(1UL, last_requests().size());
 }
 
+TEST_F(RequestCoordinatorTest, GetRequestStatuses) {
+  // Add two requests to the queue.
+  offline_pages::SavePageRequest request1(
+      kRequestId, kUrl, kClientId, base::Time::Now(), kUserRequested);
+  offline_pages::SavePageRequest request2(
+      kRequestId + 1, kUrl2, kClientId2, base::Time::Now(), kUserRequested);
+  // TODO(petewil): Use SetRequestStatus instead once it is available.
+  request2.set_attempt_count(kAttemptCountTooHigh);
+  coordinator()->queue()->AddRequest(
+      request1,
+      base::Bind(&RequestCoordinatorTest::AddRequestDone,
+                 base::Unretained(this)));
+    coordinator()->queue()->AddRequest(
+      request2,
+      base::Bind(&RequestCoordinatorTest::AddRequestDone,
+                 base::Unretained(this)));
+  PumpLoop();
+
+  // Start the async status fetching.
+  coordinator()->GetRequestStatuses(
+      kClientNamespace,
+      base::Bind(&RequestCoordinatorTest::GetRequestStatusesDone,
+                 base::Unretained(this)));
+  PumpLoop();
+
+  // Wait for async get to finish.
+  WaitForCallback();
+  PumpLoop();
+
+  // Check that the statuses found in the callback match what we expect.
+  EXPECT_EQ(2UL, last_statuses().size());
+  EXPECT_EQ(SavePageRequest::Status::PENDING, last_statuses().at(0).status);
+  EXPECT_EQ(kId1, last_statuses().at(0).client_id);
+

[fgorski, 2016/08/02 04:18:12]

nit: remove empty line

Question: Do you intend to verify the second request some other time, or is this
an omission? (please add a TODO in former case, or fix the code in the latter.)

[Pete Williamson, 2016/08/03 00:24:32]

Done.

+}
+
 }  // namespace offline_pages