Factor out upload progress handling from AsyncResourceHandler

content/browser/loader/async_resource_handler.cc

 // Copyright (c) 2012 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 "content/browser/loader/async_resource_handler.h"
 
 #include <algorithm>
 #include <vector>
 
 #include "base/command_line.h"
 #include "base/containers/hash_tables.h"
 #include "base/debug/alias.h"
 #include "base/feature_list.h"
 #include "base/logging.h"
 #include "base/macros.h"
 #include "base/memory/shared_memory.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/time/time.h"
 #include "content/browser/loader/netlog_observer.h"
 #include "content/browser/loader/resource_buffer.h"
 #include "content/browser/loader/resource_dispatcher_host_impl.h"
 #include "content/browser/loader/resource_message_filter.h"
 #include "content/browser/loader/resource_request_info_impl.h"
+#include "content/browser/loader/upload_progress_tracker.h"
 #include "content/common/resource_messages.h"
 #include "content/common/resource_request_completion_status.h"
 #include "content/common/view_messages.h"
 #include "content/public/browser/resource_controller.h"
 #include "content/public/browser/resource_dispatcher_host_delegate.h"
 #include "content/public/common/content_features.h"
 #include "content/public/common/resource_response.h"
 #include "ipc/ipc_message_macros.h"
 #include "net/base/io_buffer.h"
 #include "net/base/load_flags.h"
 #include "net/url_request/redirect_info.h"
 
 using base::TimeDelta;
 using base::TimeTicks;
 
 namespace content {
 namespace {
 
 static int kBufferSize = 1024 * 512;
 static int kMinAllocationSize = 1024 * 4;
 static int kMaxAllocationSize = 1024 * 32;
-// The interval for calls to ReportUploadProgress.
-static int kUploadProgressIntervalMsec = 100;
 
 // Used when kOptimizeLoadingIPCForSmallResources is enabled.
 // Small resource typically issues two Read call: one for the content itself
 // and another for getting zero response to detect EOF.
 // Inline these two into the IPC message to avoid allocating an expensive
 // SharedMemory for small resources.
 const int kNumLeadingChunk = 2;
 const int kInlinedLeadingChunkSize = 2048;
 
 void GetNumericArg(const std::string& name, int* result) {
   const std::string& value =
       base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(name);
   if (!value.empty())
     base::StringToInt(value, result);
 }
 
 void InitializeResourceBufferConstants() {
   static bool did_init = false;
   if (did_init)
     return;
   did_init = true;
 
   GetNumericArg("resource-buffer-size", &kBufferSize);
   GetNumericArg("resource-buffer-min-allocation-size", &kMinAllocationSize);
   GetNumericArg("resource-buffer-max-allocation-size", &kMaxAllocationSize);
 }
 
+void SendUploadProgress(base::WeakPtr<ResourceMessageFilter> filter,
+                        int request_id,
+                        int64_t current_position,
+                        int64_t total_size) {
+  if (filter) {
+    filter->Send(new ResourceMsg_UploadProgress(request_id, current_position,
+                                                total_size));
+  }
+}
+
 }  // namespace
 
 // Used when kOptimizeLoadingIPCForSmallResources is enabled.
 // The instance hooks the buffer allocation of AsyncResourceHandler, and
 // determine if we should use SharedMemory or should inline the data into
 // the IPC message.
 class AsyncResourceHandler::InliningHelper {
  public:
 
   InliningHelper() {}
@@ skipping 112 matching lines @@
     : ResourceHandler(request),
       ResourceMessageDelegate(request),
       rdh_(rdh),
       pending_data_count_(0),
       allocation_size_(0),
       did_defer_(false),
       has_checked_for_sufficient_resources_(false),
       sent_received_response_msg_(false),
       sent_data_buffer_msg_(false),
       inlining_helper_(new InliningHelper),
-      last_upload_position_(0),
-      waiting_for_upload_progress_ack_(false),
       reported_transfer_size_(0) {
   DCHECK(GetRequestInfo()->requester_info()->IsRenderer());
   InitializeResourceBufferConstants();
 }
 
 AsyncResourceHandler::~AsyncResourceHandler() {
   if (has_checked_for_sufficient_resources_)
     rdh_->FinishedWithResourcesForRequest(request());
 }
 
@@ skipping 21 matching lines @@
   if (pending_data_count_) {
     --pending_data_count_;
 
     buffer_->RecycleLeastRecentlyAllocated();
     if (buffer_->CanAllocate())
       ResumeIfDeferred();
   }
 }
 
 void AsyncResourceHandler::OnUploadProgressACK(int request_id) {
-  waiting_for_upload_progress_ack_ = false;
-}
-
-void AsyncResourceHandler::ReportUploadProgress() {
-  DCHECK(GetRequestInfo()->is_upload_progress_enabled());
-  if (waiting_for_upload_progress_ack_)
-    return;  // Send one progress event at a time.
-
-  net::UploadProgress progress = request()->GetUploadProgress();
-  if (!progress.size())
-    return;  // Nothing to upload.
-
-  if (progress.position() == last_upload_position_)
-    return;  // No progress made since last time.
-
-  const uint64_t kHalfPercentIncrements = 200;
-  const TimeDelta kOneSecond = TimeDelta::FromMilliseconds(1000);
-
-  uint64_t amt_since_last = progress.position() - last_upload_position_;
-  TimeDelta time_since_last = TimeTicks::Now() - last_upload_ticks_;
-
-  bool is_finished = (progress.size() == progress.position());
-  bool enough_new_progress =
-      (amt_since_last > (progress.size() / kHalfPercentIncrements));
-  bool too_much_time_passed = time_since_last > kOneSecond;
-
-  if (is_finished || enough_new_progress || too_much_time_passed) {
-    ResourceMessageFilter* filter = GetFilter();
-    if (filter) {
-      filter->Send(
-        new ResourceMsg_UploadProgress(GetRequestID(),
-                                       progress.position(),
-                                       progress.size()));
-    }
-    waiting_for_upload_progress_ack_ = true;
-    last_upload_ticks_ = TimeTicks::Now();
-    last_upload_position_ = progress.position();
-  }
+  if (upload_progress_tracker_)
+    upload_progress_tracker_->OnAckReceived();
 }
 
 bool AsyncResourceHandler::OnRequestRedirected(
     const net::RedirectInfo& redirect_info,
     ResourceResponse* response,
     bool* defer) {
   ResourceMessageFilter* filter = GetFilter();
   if (!filter)
     return false;
 
@@ skipping 16 matching lines @@
 bool AsyncResourceHandler::OnResponseStarted(ResourceResponse* response,
                                              bool* defer) {
   // For changes to the main frame, inform the renderer of the new URL's
   // per-host settings before the request actually commits.  This way the
   // renderer will be able to set these precisely at the time the
   // request commits, avoiding the possibility of e.g. zooming the old content
   // or of having to layout the new content twice.
 
   response_started_ticks_ = base::TimeTicks::Now();
 
-  progress_timer_.Stop();
-  ResourceMessageFilter* filter = GetFilter();
-  if (!filter)
-    return false;
-
-  const ResourceRequestInfoImpl* info = GetRequestInfo();
   // We want to send a final upload progress message prior to sending the
   // response complete message even if we're waiting for an ack to to a
   // previous upload progress message.
-  if (info->is_upload_progress_enabled()) {
-    waiting_for_upload_progress_ack_ = false;
-    ReportUploadProgress();
+  if (upload_progress_tracker_) {
+    upload_progress_tracker_->ForceReportUploadProgress();
+    upload_progress_tracker_ = nullptr;
   }
 
+  const ResourceRequestInfoImpl* info = GetRequestInfo();
   if (rdh_->delegate()) {
     rdh_->delegate()->OnResponseStarted(request(), info->GetContext(),
                                         response);
   }
 
+  ResourceMessageFilter* filter = GetFilter();
+  if (!filter)
+    return false;
+
   NetLogObserver::PopulateResponseInfo(request(), response);
   response->head.encoded_data_length = request()->raw_header_size();
 
   // If the parent handler downloaded the resource to a file, grant the child
   // read permissions on it.
   if (!response->head.download_file_path.empty()) {
     rdh_->RegisterDownloadedTempFile(
         info->GetChildID(), info->GetRequestID(),
         response->head.download_file_path);
   }
 
   response->head.request_start = request()->creation_time();
   response->head.response_start = TimeTicks::Now();
   filter->Send(
       new ResourceMsg_ReceivedResponse(GetRequestID(), response->head));
   sent_received_response_msg_ = true;
 
   if (request()->response_info().metadata.get()) {
     std::vector<char> copy(request()->response_info().metadata->data(),
                            request()->response_info().metadata->data() +
                                request()->response_info().metadata->size());
     filter->Send(new ResourceMsg_ReceivedCachedMetadata(GetRequestID(), copy));
   }
 
   inlining_helper_->OnResponseReceived(*response);
   return true;
 }
 
 bool AsyncResourceHandler::OnWillStart(const GURL& url, bool* defer) {
+  ResourceMessageFilter* filter = GetFilter();
+  if (!filter)
+    return false;
+
   if (GetRequestInfo()->is_upload_progress_enabled() &&
       request()->has_upload()) {
-    ReportUploadProgress();
-    progress_timer_.Start(
-        FROM_HERE,
-        base::TimeDelta::FromMilliseconds(kUploadProgressIntervalMsec),
-        this,
-        &AsyncResourceHandler::ReportUploadProgress);
+    upload_progress_tracker_ = base::MakeUnique<UploadProgressTracker>(
+        FROM_HERE, base::BindRepeating(&SendUploadProgress,
+                                       filter->GetWeakPtr(), GetRequestID()),
+        request());
+    upload_progress_tracker_->ForceReportUploadProgress();
   }
   return true;
 }
 
 bool AsyncResourceHandler::OnWillRead(scoped_refptr<net::IOBuffer>* buf,
                                       int* buf_size,
                                       int min_size) {
   DCHECK_EQ(-1, min_size);
 
   if (!CheckForSufficientResource())
@@ skipping 10 matching lines @@
   DCHECK(buffer_->CanAllocate());
   char* memory = buffer_->Allocate(&allocation_size_);
   CHECK(memory);
 
   *buf = new DependentIOBuffer(buffer_.get(), memory);
   *buf_size = allocation_size_;
 
   return true;
 }
 
 bool AsyncResourceHandler::OnReadCompleted(int bytes_read, bool* defer) {

[yhirano, 2016/12/02 09:17:52]

Is it good to nullify upload_progress_tracker_ in this function?

[tzik, 2016/12/05 08:00:06]

OnResponseStarted should clear it before OnReadComplete. Let me add a DCHECK
here for that.

[yhirano, 2016/12/07 13:50:03]

Oops, sorry, I wanted to comment at OnResponseCompleted, not OnReadCompleted.
You don't have to put a DCHECK here. OnResponseCompleted can be called without
OnResponseStarted call, and nullify upload_progress_tracker_ there may be good,
I think.

[tzik, 2016/12/08 05:57:54]

That makes sense. Done.

   DCHECK_GE(bytes_read, 0);
 
   if (!bytes_read)
     return true;
 
   ResourceMessageFilter* filter = GetFilter();
   if (!filter)
     return false;
 
   int encoded_data_length = CalculateEncodedDataLengthToReport();
@@ skipping 154 matching lines @@
   } else {
     UMA_HISTOGRAM_CUSTOM_COUNTS(
         "Net.ResourceLoader.ResponseStartToEnd.Over_512kB",
         elapsed_time, 1, 100000, 100);
   }
 
   inlining_helper_->RecordHistogram(elapsed_time);
 }
 
 }  // namespace content