[Offline Pages] Pick correct request when resuming.

components/offline_pages/core/background/pick_request_task.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/background/pick_request_task.h"
 
 #include "base/bind.h"
 #include "base/logging.h"
 #include "base/time/time.h"
 #include "components/offline_pages/core/background/device_conditions.h"
@@ skipping 17 matching lines @@
 }  // namespace
 
 namespace offline_pages {
 
 PickRequestTask::PickRequestTask(RequestQueueStore* store,
                                  OfflinerPolicy* policy,
                                  RequestPickedCallback picked_callback,
                                  RequestNotPickedCallback not_picked_callback,
                                  RequestCountCallback request_count_callback,
                                  DeviceConditions& device_conditions,
-                                 const std::set<int64_t>& disabled_requests)
+                                 const std::set<int64_t>& disabled_requests,
+                                 std::vector<int64_t>& prioritized_requests)
     : store_(store),
       policy_(policy),
       picked_callback_(picked_callback),
       not_picked_callback_(not_picked_callback),
       request_count_callback_(request_count_callback),
       disabled_requests_(disabled_requests),
+      prioritized_requests_(prioritized_requests),
       weak_ptr_factory_(this) {
   device_conditions_.reset(new DeviceConditions(device_conditions));
 }
 
 PickRequestTask::~PickRequestTask() {}
 
 void PickRequestTask::Run() {
   GetRequests();
 }
 
 void PickRequestTask::GetRequests() {
   // Get all the requests from the queue, we will classify them in the callback.
   store_->GetRequests(
       base::Bind(&PickRequestTask::Choose, weak_ptr_factory_.GetWeakPtr()));
 }
 
 void PickRequestTask::Choose(
     bool success,
     std::vector<std::unique_ptr<SavePageRequest>> requests) {
   // If there is nothing to do, return right away.
   if (requests.empty()) {
     request_count_callback_.Run(requests.size(), 0);
     not_picked_callback_.Run(!kNonUserRequestsFound, !kCleanupNeeded);
     TaskComplete();
     return;
   }
 
-  // Pick the most deserving request for our conditions.
+  // pick the most deserving request for our conditions.

[Pete Williamson, 2017/03/07 19:06:04]

This was better before.  Accidental change?

[romax, 2017/03/07 20:41:45]

Done.

   const SavePageRequest* picked_request = nullptr;
 
   RequestCompareFunction comparator = nullptr;
 
   // Choose which comparison function to use based on policy.
   if (policy_->RetryCountIsMoreImportantThanRecency())
     comparator = &PickRequestTask::RetryCountFirstCompareFunction;
   else
     comparator = &PickRequestTask::RecencyFirstCompareFunction;
 
   // TODO(petewil): Consider replacing this bool with a better named enum.
   bool non_user_requested_tasks_remaining = false;
   bool cleanup_needed = false;
 
+  size_t request_size = requests.size();
   size_t available_request_count = 0;
 
-  // Iterate once through the requests, keeping track of best candidate.
+  std::vector<std::unique_ptr<SavePageRequest>> available_requests;
+
+  // Iterate through the requests, filter out unavailable requests and get other
+  // information (if cleanup is needed and number of non-user-requested
+  // requests).
   for (unsigned i = 0; i < requests.size(); ++i) {
     // If the request is expired or has exceeded the retry count, skip it.
     if (OfflinerPolicyUtils::CheckRequestExpirationStatus(requests[i].get(),
                                                           policy_) !=
         OfflinerPolicyUtils::RequestExpirationStatus::VALID) {
       cleanup_needed = true;
       continue;
     }
-
-    // If the  request is on the disabled list, skip it.
+    // If the request is on the disabled list, skip it.
     auto search = disabled_requests_.find(requests[i]->request_id());
     if (search != disabled_requests_.end())
       continue;
 
     // If there are non-user-requested tasks remaining, we need to make sure
     // that they are scheduled after we run out of user requested tasks. Here we
     // detect if any exist. If we don't find any user-requested tasks, we will
     // inform the "not_picked_callback_" that it needs to schedule a task for
     // non-user-requested items, which have different network and power needs.
     if (!requests[i]->user_requested())
       non_user_requested_tasks_remaining = true;
     if (requests[i]->request_state() ==
         SavePageRequest::RequestState::AVAILABLE) {
       available_request_count++;
     }
-    if (!RequestConditionsSatisfied(requests[i].get()))
-      continue;
-    if (IsNewRequestBetter(picked_request, requests[i].get(), comparator))
-      picked_request = requests[i].get();
+    available_requests.push_back(std::move(requests[i]));
+  }
+  // Report the request queue counts.
+  request_count_callback_.Run(request_size, available_requests.size());
+
+  // Search for and pick the prioritized requests which is not disabled and in

[Pete Williamson, 2017/03/07 19:06:04]

Nit: requests -> request

[romax, 2017/03/07 20:41:45]

Done.

+  // the request queue. An assumption is that requests later in the vector have
+  // higher priority than earlier ones in the vector.
+  while (!picked_request && !prioritized_requests_.empty()) {
+    int64_t id = prioritized_requests_.back();
+    for (unsigned i = 0; i < available_requests.size(); ++i) {
+      if (available_requests[i]->request_id() == id) {
+        picked_request = available_requests[i].get();
+        break;
+      }
+    }
+    // Remove the prioritized requests which are not in request queue.
+    prioritized_requests_.pop_back();

[Pete Williamson, 2017/03/07 19:06:04]

Maybe instead of popping requests off the end of the array, we could just start
at the highest index and iterate down towards 0.

[romax, 2017/03/07 20:41:45]

Done.

   }
 
-  // Report the request queue counts.
-  request_count_callback_.Run(requests.size(), available_request_count);
+  if (!picked_request) {

[Pete Williamson, 2017/03/07 19:06:04]

add comment
// If no request was found from the priority list, then find the best request
according to current policies.

[romax, 2017/03/07 20:41:45]

Done.

+    for (unsigned i = 0; i < available_requests.size(); ++i) {
+      if (!RequestConditionsSatisfied(available_requests[i].get()))
+        continue;
+      if (IsNewRequestBetter(picked_request, available_requests[i].get(),
+                             comparator)) {
+        picked_request = available_requests[i].get();
+      }
+    }
+  }
 
   // If we have a best request to try next, get the request coodinator to
   // start it.  Otherwise return that we have no candidates.
   if (picked_request != nullptr) {
     picked_callback_.Run(*picked_request, cleanup_needed);
   } else {
     not_picked_callback_.Run(non_user_requested_tasks_remaining,
                              cleanup_needed);
   }
 
@@ skipping 113 matching lines @@
   int result = signum(difference.InMilliseconds());
 
   // Flip the direction of comparison if policy prefers fewer retries.
   if (policy_->ShouldPreferEarlierRequests())
     result *= -1;
 
   return result;
 }
 
 }  // namespace offline_pages