[Offline Pages] Remove expired requests from the queue.

components/offline_pages/background/request_picker_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_picker.h"
 
 #include "base/bind.h"
 #include "base/test/test_simple_task_runner.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "base/time/time.h"
 #include "components/offline_pages/background/device_conditions.h"
+#include "components/offline_pages/background/offliner_factory.h"
+#include "components/offline_pages/background/offliner_policy.h"
 #include "components/offline_pages/background/request_queue.h"
 #include "components/offline_pages/background/request_queue_in_memory_store.h"
 #include "components/offline_pages/background/save_page_request.h"
 #include "components/offline_pages/offline_page_item.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace offline_pages {
 
 namespace {
 // Data for request 1.
 const int64_t kRequestId1 = 17;
 const GURL kUrl1("https://google.com");
 const ClientId kClientId1("bookmark", "1234");
 // Data for request 2.
 const int64_t kRequestId2 = 42;
 const GURL kUrl2("http://nytimes.com");
 const ClientId kClientId2("bookmark", "5678");
 const bool kUserRequested = true;
 const int kAttemptCount = 1;
 const int kTwoWeeksInSeconds = 60 * 60 * 24 * 7 * 2;
 const int kMaxStartedTries = 5;
 const int kMaxCompletedTries = 1;
 
 // Constants for policy values - These settings represent the default values.
 const bool kPreferUntried = false;
 const bool kPreferEarlier = true;
 const bool kPreferRetryCount = true;
 }  // namespace
 
+class SchedulerStub : public Scheduler {
+ public:
+  SchedulerStub()
+      : schedule_called_(false),
+        unschedule_called_(false),
+        conditions_(false, 0, false) {}
+
+  void Schedule(const TriggerConditions& trigger_conditions) override {
+    schedule_called_ = true;
+    conditions_ = trigger_conditions;
+  }
+
+  // Unschedules the currently scheduled task, if any.
+  void Unschedule() override { unschedule_called_ = true; }
+
+  bool schedule_called() const { return schedule_called_; }
+
+  bool unschedule_called() const { return unschedule_called_; }
+
+  TriggerConditions const* conditions() const { return &conditions_; }
+
+ private:
+  bool schedule_called_;
+  bool unschedule_called_;
+  TriggerConditions conditions_;
+};
+
+class OfflinerStub : public Offliner {
+ public:
+  OfflinerStub()
+      : request_(kRequestId1,
+                 kUrl1,
+                 kClientId1,
+                 base::Time::Now(),
+                 kUserRequested),
+        enable_callback_(false),
+        cancel_called_(false) {}
+
+  bool LoadAndSave(const SavePageRequest& request,
+                   const CompletionCallback& callback) override {
+    callback_ = callback;
+    request_ = request;
+    // Post the callback on the run loop.
+    if (enable_callback_) {
+      base::ThreadTaskRunnerHandle::Get()->PostTask(
+          FROM_HERE,
+          base::Bind(callback, request, Offliner::RequestStatus::SAVED));
+    }
+    return true;
+  }
+
+  void Cancel() override { cancel_called_ = true; }
+
+  void enable_callback(bool enable) { enable_callback_ = enable; }
+
+  bool cancel_called() { return cancel_called_; }
+
+ private:
+  CompletionCallback callback_;
+  SavePageRequest request_;
+  bool enable_callback_;
+  bool cancel_called_;
+};
+
+class OfflinerFactoryStub : public OfflinerFactory {
+ public:
+  OfflinerFactoryStub() : offliner_(nullptr) {}
+
+  Offliner* GetOffliner(const OfflinerPolicy* policy) override {
+    if (offliner_.get() == nullptr) {
+      offliner_.reset(new OfflinerStub());
+    }
+    return offliner_.get();
+  }
+
+ private:
+  std::unique_ptr<OfflinerStub> offliner_;
+};
+
+class RequestCoordinatorStub : public RequestCoordinator {
+ public:
+  RequestCoordinatorStub()
+      : RequestCoordinator(
+            std::unique_ptr<OfflinerPolicy>(new OfflinerPolicy()),
+            std::unique_ptr<OfflinerFactory>(new OfflinerFactoryStub()),
+            std::unique_ptr<RequestQueue>(
+                new RequestQueue(std::unique_ptr<RequestQueueInMemoryStore>(
+                    new RequestQueueInMemoryStore()))),
+            std::unique_ptr<Scheduler>(new SchedulerStub())) {}
+
+  void NotifyRequestsExpired(
+      const std::vector<SavePageRequest>& expired_requests,
+      RequestQueue::UpdateRequestResult result) override {
+    last_request_expiration_result_ = result;
+    last_expired_requests_ = expired_requests;
+  }
+
+  const std::vector<SavePageRequest>& last_expired_requests() {
+    return last_expired_requests_;
+  }
+
+  RequestQueue::UpdateRequestResult last_request_expiration_result() {
+    return last_request_expiration_result_;
+  }
+
+ private:
+  RequestQueue::UpdateRequestResult last_request_expiration_result_;
+  std::vector<SavePageRequest> last_expired_requests_;
+};
+
 class RequestPickerTest : public testing::Test {
  public:
   RequestPickerTest();
 
   ~RequestPickerTest() override;
 
   void SetUp() override;
 
   void PumpLoop();
 
   void AddRequestDone(RequestQueue::AddRequestResult result,
                       const SavePageRequest& request);
 
   void RequestPicked(const SavePageRequest& request);
 
   void RequestQueueEmpty();
 
   void QueueRequestsAndChooseOne(const SavePageRequest& request1,
                                  const SavePageRequest& request2);
 
+  RequestCoordinatorStub* GetCoordinator() { return coordinator_.get(); }
+
  protected:
   // The request queue is simple enough we will use a real queue with a memory
   // store instead of a stub.
   std::unique_ptr<RequestQueue> queue_;
   std::unique_ptr<RequestPicker> picker_;
+  std::unique_ptr<RequestCoordinatorStub> coordinator_;
   std::unique_ptr<SavePageRequest> last_picked_;
   std::unique_ptr<OfflinerPolicy> policy_;
   bool request_queue_empty_called_;
 
  private:
   scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
   base::ThreadTaskRunnerHandle task_runner_handle_;
 };
 
 RequestPickerTest::RequestPickerTest()
     : task_runner_(new base::TestSimpleTaskRunner),
       task_runner_handle_(task_runner_) {}
 
 RequestPickerTest::~RequestPickerTest() {}
 
 void RequestPickerTest::SetUp() {
   std::unique_ptr<RequestQueueInMemoryStore> store(
       new RequestQueueInMemoryStore());
   queue_.reset(new RequestQueue(std::move(store)));
   policy_.reset(new OfflinerPolicy());
-  picker_.reset(new RequestPicker(queue_.get(), policy_.get()));
+  coordinator_.reset(new RequestCoordinatorStub());
+  picker_.reset(
+      new RequestPicker(queue_.get(), policy_.get(), coordinator_.get()));
   request_queue_empty_called_ = false;
 }
 
 void RequestPickerTest::PumpLoop() {
   task_runner_->RunUntilIdle();
 }
 
 void RequestPickerTest::AddRequestDone(RequestQueue::AddRequestResult result,
                                        const SavePageRequest& request) {}
 
@@ skipping 39 matching lines @@
       &conditions);
 
   // Pump the loop again to give the async queue the opportunity to return
   // results from the Get operation, and for the picker to call the "QueueEmpty"
   // callback.
   PumpLoop();
 
   EXPECT_TRUE(request_queue_empty_called_);
 }
 
+TEST_F(RequestPickerTest, ChooseNonExpiredRequest) {
+  base::Time creation_time = base::Time::Now();
+  base::Time expired_time =
+      creation_time -
+      base::TimeDelta::FromSeconds(kRequestExpirationTimeInSeconds + 60);
+  SavePageRequest request1(kRequestId1, kUrl1, kClientId1, creation_time,
+                           kUserRequested);
+  SavePageRequest request2(kRequestId2, kUrl2, kClientId2, expired_time,
+                           kUserRequested);
+
+  QueueRequestsAndChooseOne(request1, request2);
+
+  PumpLoop();
+
+  EXPECT_EQ(kRequestId1, last_picked_->request_id());
+  EXPECT_FALSE(request_queue_empty_called_);
+  EXPECT_EQ(kRequestId2,
+            GetCoordinator()->last_expired_requests()[0].request_id());
+  EXPECT_EQ(RequestQueue::UpdateRequestResult::SUCCESS,
+            GetCoordinator()->last_request_expiration_result());
+}
+
 TEST_F(RequestPickerTest, ChooseRequestWithHigherRetryCount) {
   policy_.reset(new OfflinerPolicy(kPreferUntried, kPreferEarlier,
                                    kPreferRetryCount, kMaxStartedTries,
                                    kMaxCompletedTries + 1));
   picker_.reset(new RequestPicker(queue_.get(), policy_.get()));
 
   base::Time creation_time = base::Time::Now();
   SavePageRequest request1(
       kRequestId1, kUrl1, kClientId1, creation_time, kUserRequested);
   SavePageRequest request2(
@@ skipping 19 matching lines @@
 
   EXPECT_EQ(kRequestId1, last_picked_->request_id());
   EXPECT_FALSE(request_queue_empty_called_);
 }
 
 TEST_F(RequestPickerTest, ChooseEarlierRequest) {
   // We need a custom policy object prefering recency to retry count.
   policy_.reset(new OfflinerPolicy(kPreferUntried, kPreferEarlier,
                                    !kPreferRetryCount, kMaxStartedTries,
                                    kMaxCompletedTries));
-  picker_.reset(new RequestPicker(queue_.get(), policy_.get()));
+  picker_.reset(
+      new RequestPicker(queue_.get(), policy_.get(), coordinator_.get()));
 
   base::Time creation_time1 =
       base::Time::Now() - base::TimeDelta::FromSeconds(10);
   base::Time creation_time2 = base::Time::Now();
   SavePageRequest request1(kRequestId1, kUrl1, kClientId1, creation_time1,
                            kUserRequested);
   SavePageRequest request2(kRequestId2, kUrl2, kClientId2, creation_time2,
                            kUserRequested);
   request2.set_completed_attempt_count(kAttemptCount);
 
   QueueRequestsAndChooseOne(request1, request2);
 
   EXPECT_EQ(kRequestId1, last_picked_->request_id());
   EXPECT_FALSE(request_queue_empty_called_);
 }
 
 TEST_F(RequestPickerTest, ChooseSameTimeRequestWithHigherRetryCount) {
   // We need a custom policy object preferring recency to retry count.
   policy_.reset(new OfflinerPolicy(kPreferUntried, kPreferEarlier,
                                    !kPreferRetryCount, kMaxStartedTries,
                                    kMaxCompletedTries + 1));
-  picker_.reset(new RequestPicker(queue_.get(), policy_.get()));
+  picker_.reset(
+      new RequestPicker(queue_.get(), policy_.get(), coordinator_.get()));
 
   base::Time creation_time = base::Time::Now();
   SavePageRequest request1(kRequestId1, kUrl1, kClientId1, creation_time,
                            kUserRequested);
   SavePageRequest request2(kRequestId2, kUrl2, kClientId2, creation_time,
                            kUserRequested);
   request2.set_completed_attempt_count(kAttemptCount);
 
   QueueRequestsAndChooseOne(request1, request2);
 
   EXPECT_EQ(kRequestId2, last_picked_->request_id());
   EXPECT_FALSE(request_queue_empty_called_);
 }
 
 TEST_F(RequestPickerTest, ChooseRequestWithLowerRetryCount) {
   // We need a custom policy object preferring lower retry count.
   policy_.reset(new OfflinerPolicy(!kPreferUntried, kPreferEarlier,
                                    kPreferRetryCount, kMaxStartedTries,
                                    kMaxCompletedTries + 1));
-  picker_.reset(new RequestPicker(queue_.get(), policy_.get()));
+  picker_.reset(
+      new RequestPicker(queue_.get(), policy_.get(), coordinator_.get()));
 
   base::Time creation_time = base::Time::Now();
   SavePageRequest request1(kRequestId1, kUrl1, kClientId1, creation_time,
                            kUserRequested);
   SavePageRequest request2(kRequestId2, kUrl2, kClientId2, creation_time,
                            kUserRequested);
   request2.set_completed_attempt_count(kAttemptCount);
 
   QueueRequestsAndChooseOne(request1, request2);
 
   EXPECT_EQ(kRequestId1, last_picked_->request_id());
   EXPECT_FALSE(request_queue_empty_called_);
 }
 
 TEST_F(RequestPickerTest, ChooseLaterRequest) {
   // We need a custom policy preferring recency over retry, and later requests.
   policy_.reset(new OfflinerPolicy(kPreferUntried, !kPreferEarlier,
                                    !kPreferRetryCount, kMaxStartedTries,
                                    kMaxCompletedTries));
-  picker_.reset(new RequestPicker(queue_.get(), policy_.get()));
+  picker_.reset(
+      new RequestPicker(queue_.get(), policy_.get(), coordinator_.get()));
 
   base::Time creation_time1 =
       base::Time::Now() - base::TimeDelta::FromSeconds(10);
   base::Time creation_time2 = base::Time::Now();
   SavePageRequest request1(kRequestId1, kUrl1, kClientId1, creation_time1,
                            kUserRequested);
   SavePageRequest request2(kRequestId2, kUrl2, kClientId2, creation_time2,
                            kUserRequested);
 
   QueueRequestsAndChooseOne(request1, request2);
@@ skipping 48 matching lines @@
   // With default policy settings, we should choose the earlier request.
   // However, we will make the earlier reqeust exceed the limit.
   request1.set_completed_attempt_count(policy_->GetMaxCompletedTries());
 
   QueueRequestsAndChooseOne(request1, request2);
 
   EXPECT_EQ(kRequestId2, last_picked_->request_id());
   EXPECT_FALSE(request_queue_empty_called_);
 }
 }  // namespace offline_pages