Refactor ResourceHandler API.

content/browser/loader/throttling_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/throttling_resource_handler.h"
 
 #include <utility>
 
 #include "content/browser/loader/resource_controller.h"
 #include "content/public/common/resource_response.h"
@@ skipping 14 matching lines @@
     throttles_[i]->set_delegate(this);
     // Throttles must have a name, as otherwise, bugs where a throttle fails
     // to resume a request can be very difficult to debug.
     DCHECK(throttles_[i]->GetNameForLogging());
   }
 }
 
 ThrottlingResourceHandler::~ThrottlingResourceHandler() {
 }
 
-bool ThrottlingResourceHandler::OnRequestRedirected(
+void ThrottlingResourceHandler::OnRequestRedirected(
     const net::RedirectInfo& redirect_info,
     ResourceResponse* response,
-    bool* defer) {
+    std::unique_ptr<ResourceController> controller) {
+  DCHECK(!has_controller());
   DCHECK(!cancelled_by_resource_throttle_);
-  DCHECK(!*defer);
 
+  set_controller(std::move(controller));
   while (next_index_ < throttles_.size()) {
     int index = next_index_;
-    throttles_[index]->WillRedirectRequest(redirect_info, defer);
+    bool defer = false;
+    throttles_[index]->WillRedirectRequest(redirect_info, &defer);

[Randy Smith (Not in Mondays), 2016/12/31 22:00:25]

Is it your plan to push the API change into the throttles?  If so, is there a
reason to do RH->RT rather than the reverse?  (I don't have an opinion, just
wanted to make sure I understand the plan and its motivations.)

[mmenke, 2017/01/06 18:46:58]

I'm not currently planning on changing the API here, though may want to either
ban OOB-cancels from them or do sync destruction in that case.  Since RH's are
mostly loader-implemented, and RT's are embedded-implemented, I think we want to
bend over backwards a bit to make the RT API dead simple, and separating out
cancel types seems to go against that.

I do want to clean up this class (And maybe the API as well), but I'm thinking
that should be done after OOB-cancellation becomes synchronous.  I've also kinda
forgotten just how I was thinking on cleaning this class up...

     next_index_++;
     if (cancelled_by_resource_throttle_)
-      return false;
-    if (*defer) {
+      return;
+
+    if (defer) {
       OnRequestDeferred(index);
       deferred_stage_ = DEFERRED_REDIRECT;
       deferred_redirect_ = redirect_info;
       deferred_response_ = response;
-      return true;  // Do not cancel.
+      return;
     }
   }
 
   next_index_ = 0;  // Reset for next time.
 
-  return next_handler_->OnRequestRedirected(redirect_info, response, defer);
+  next_handler_->OnRequestRedirected(redirect_info, response, TakeController());
 }
 
-bool ThrottlingResourceHandler::OnWillStart(const GURL& url, bool* defer) {
+void ThrottlingResourceHandler::OnWillStart(
+    const GURL& url,
+    std::unique_ptr<ResourceController> controller) {
   DCHECK(!cancelled_by_resource_throttle_);
-  DCHECK(!*defer);
+  DCHECK(!has_controller());
 
+  set_controller(std::move(controller));
   while (next_index_ < throttles_.size()) {
     int index = next_index_;
-    throttles_[index]->WillStartRequest(defer);
+    bool defer = false;
+    throttles_[index]->WillStartRequest(&defer);
     next_index_++;
     if (cancelled_by_resource_throttle_)
-      return false;
-    if (*defer) {
+      return;
+    if (defer) {
       OnRequestDeferred(index);
       deferred_stage_ = DEFERRED_START;
       deferred_url_ = url;
-      return true;  // Do not cancel.
+      return;
     }
   }
 
   next_index_ = 0;  // Reset for next time.
 
-  return next_handler_->OnWillStart(url, defer);
+  return next_handler_->OnWillStart(url, TakeController());
 }
 
-bool ThrottlingResourceHandler::OnResponseStarted(ResourceResponse* response,
-                                                  bool* defer) {
+void ThrottlingResourceHandler::OnResponseStarted(
+    ResourceResponse* response,
+    std::unique_ptr<ResourceController> controller) {
   DCHECK(!cancelled_by_resource_throttle_);
-  DCHECK(!*defer);
+  DCHECK(!has_controller());
 
+  set_controller(std::move(controller));
   while (next_index_ < throttles_.size()) {
     int index = next_index_;
-    throttles_[index]->WillProcessResponse(defer);
+    bool defer = false;
+    throttles_[index]->WillProcessResponse(&defer);
     next_index_++;
     if (cancelled_by_resource_throttle_)
-      return false;
-    if (*defer) {
+      return;
+    if (defer) {
       OnRequestDeferred(index);
       deferred_stage_ = DEFERRED_RESPONSE;
       deferred_response_ = response;
-      return true;  // Do not cancel.
+      return;
     }
   }
 
   next_index_ = 0;  // Reset for next time.
 
-  return next_handler_->OnResponseStarted(response, defer);
+  return next_handler_->OnResponseStarted(response, TakeController());
 }
 
 void ThrottlingResourceHandler::Cancel() {
-  cancelled_by_resource_throttle_ = true;
-  controller()->Cancel();
+  CancelWithError(net::ERR_ABORTED);
 }
 
 void ThrottlingResourceHandler::CancelAndIgnore() {
+  if (!has_controller()) {
+    OutOfBandCancel(net::ERR_ABORTED, false);
+    return;
+  }
   cancelled_by_resource_throttle_ = true;
-  controller()->CancelAndIgnore();
+  ResourceHandler::CancelAndIgnore();
 }
 
 void ThrottlingResourceHandler::CancelWithError(int error_code) {
+  if (!has_controller()) {
+    OutOfBandCancel(error_code, false);
+    return;
+  }
   cancelled_by_resource_throttle_ = true;
-  controller()->CancelWithError(error_code);
+  ResourceHandler::CancelWithError(error_code);
 }
 
 void ThrottlingResourceHandler::Resume() {
   // Throttles expect to be able to cancel requests out-of-band, so just do
   // nothing if one request resumes after another cancels. Can't even recognize
   // out-of-band cancels and for synchronous teardown, since don't know if the
   // currently active throttle called Cancel() or if it was another one.
   if (cancelled_by_resource_throttle_)
     return;
 
+  DCHECK(has_controller());
+
   DeferredStage last_deferred_stage = deferred_stage_;
   deferred_stage_ = DEFERRED_NONE;
   // Clear information about the throttle that delayed the request.
   request()->LogUnblocked();
   switch (last_deferred_stage) {
     case DEFERRED_NONE:
       NOTREACHED();
       break;
     case DEFERRED_START:
       ResumeStart();
       break;
     case DEFERRED_REDIRECT:
       ResumeRedirect();
       break;
     case DEFERRED_RESPONSE:
       ResumeResponse();
       break;
   }
 }
 
 void ThrottlingResourceHandler::ResumeStart() {
   DCHECK(!cancelled_by_resource_throttle_);
+  DCHECK(has_controller());
 
   GURL url = deferred_url_;
   deferred_url_ = GURL();
 
-  bool defer = false;
-  if (!OnWillStart(url, &defer)) {
-    controller()->Cancel();
-  } else if (!defer) {
-    controller()->Resume();
-  }
+  OnWillStart(url, TakeController());
 }
 
 void ThrottlingResourceHandler::ResumeRedirect() {
   DCHECK(!cancelled_by_resource_throttle_);
+  DCHECK(has_controller());
 
   net::RedirectInfo redirect_info = deferred_redirect_;
   deferred_redirect_ = net::RedirectInfo();
   scoped_refptr<ResourceResponse> response;
   deferred_response_.swap(response);
 
-  bool defer = false;
-  if (!OnRequestRedirected(redirect_info, response.get(), &defer)) {
-    controller()->Cancel();
-  } else if (!defer) {
-    controller()->Resume();
-  }
+  OnRequestRedirected(redirect_info, response.get(), TakeController());
 }
 
 void ThrottlingResourceHandler::ResumeResponse() {
   DCHECK(!cancelled_by_resource_throttle_);
+  DCHECK(has_controller());
 
   scoped_refptr<ResourceResponse> response;
   deferred_response_.swap(response);
 
-  bool defer = false;
-  if (!OnResponseStarted(response.get(), &defer)) {
-    controller()->Cancel();
-  } else if (!defer) {
-    controller()->Resume();
-  }
+  OnResponseStarted(response.get(), TakeController());
 }
 
 void ThrottlingResourceHandler::OnRequestDeferred(int throttle_index) {
   request()->LogBlockedBy(throttles_[throttle_index]->GetNameForLogging());
 }
 
 }  // namespace content