Allow asynchronous deferral in NavigationSimulator

content/public/test/navigation_simulator.h

 // Copyright 2017 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.
 
 #ifndef CONTENT_PUBLIC_TEST_NAVIGATION_SIMULATOR_H_
 #define CONTENT_PUBLIC_TEST_NAVIGATION_SIMULATOR_H_
 
 #include <memory>
 
+#include "base/callback.h"
+#include "base/optional.h"
+#include "content/public/browser/navigation_throttle.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/referrer.h"
 #include "content/public/test/navigation_simulator.h"
 #include "ui/base/page_transition_types.h"
 
 class GURL;
 
 namespace content {
 
 class NavigationHandleImpl;
@@ skipping 58 matching lines @@
   //   for (GURL redirect_url : redirects)
   //     simulator->Redirect(redirect_url);
   //   simulator->Fail(net::ERR_TIMED_OUT);
   //   simulator->CommitErrorPage();
   //
   // Example of usage for a same-page renderer-initiated navigation:
   //   unique_ptr<NavigationSimulator> simulator =
   //       NavigationSimulator::CreateRendererInitiated(
   //           original_url, render_frame_host);
   //   simulator->CommitSamePage();
+  //
+  // Example of usage for a renderer-initiated navigation which is cancelled by
+  // a throttle upon redirecting. Note that registering the throttle is done
+  // elsewhere:
+  //   unique_ptr<NavigationSimulator> simulator =
+  //       NavigationSimulator::CreateRendererInitiated(
+  //           original_url, render_frame_host);
+  //   simulator->SetTransition(ui::PAGE_TRANSITION_LINK);
+  //   simulator->Start();
+  //   simulator->Redirect(redirect_url);
+  //   EXPECT_EQ(NavigationThrottle::CANCEL,
+  //             simulator->GetLastThrottleCheckResult());
 
   // Simulates the start of the navigation.
   virtual void Start();
 
   // Simulates a redirect to |new_url| for the navigation.
   virtual void Redirect(const GURL& new_url);
 
   // Simulates the commit of the navigation in the RenderFrameHost.
   virtual void Commit();
 
@@ skipping 17 matching lines @@
   // The following parameters are constant during the navigation and may only be
   // specified before calling |Start|.
   virtual void SetTransition(ui::PageTransition transition);
 
   // The following parameters can change during redirects. They should be
   // specified before calling |Start| if they need to apply to the navigation to
   // the original url. Otherwise, they should be specified before calling
   // |Redirect|.
   virtual void SetReferrer(const Referrer& referrer);
 
+  // Gets the last throttle check result computed by the navigation throttles.
+  // It is an error to call this before Start() is called.
+  virtual NavigationThrottle::ThrottleCheckResult GetLastThrottleCheckResult();
+
  private:
   // WebContentsObserver:
   void DidStartNavigation(NavigationHandle* navigation_handle) override;
   void DidRedirectNavigation(NavigationHandle* navigation_handle) override;
   void ReadyToCommitNavigation(NavigationHandle* navigation_handle) override;
   void DidFinishNavigation(NavigationHandle* navigation_handle) override;
 
   void OnWillStartRequest();
   void OnWillRedirectRequest();
   void OnWillProcessResponse();
 
+  // This method will block waiting for throttle checks to complete.
+  void WaitForThrottleChecksComplete();
+
+  // Sets |last_throttle_check_result_| and calls
+  // |throttle_checks_wait_closure_|.
+  void OnThrottleChecksComplete(NavigationThrottle::ThrottleCheckResult result);
+
+  // Helper method to set the OnThrottleChecksComplete callback on the
+  // NavigationHandle.
+  void PrepareCompleteCallbackOnHandle();
+
   enum State {
     INITIALIZATION,
     STARTED,
     FAILED,
     FINISHED,
   };
 
   State state_ = INITIALIZATION;
 
   // The renderer associated with this navigation.
   TestRenderFrameHost* render_frame_host_;
 
   // The NavigationHandle associated with this navigation.
   NavigationHandleImpl* handle_;
 
   GURL navigation_url_;
   Referrer referrer_;
   ui::PageTransition transition_ = ui::PAGE_TRANSITION_LINK;
 
   // These are used to sanity check the content/public/ API calls emitted as
   // part of the navigation.
   int num_did_start_navigation_called_ = 0;
   int num_will_start_request_called_ = 0;
   int num_will_redirect_request_called_ = 0;
   int num_did_redirect_navigation_called_ = 0;
   int num_will_process_response_called_ = 0;
   int num_ready_to_commit_called_ = 0;
   int num_did_finish_navigation_called_ = 0;
 
+  // Holds the last ThrottleCheckResult calculated by the navigation's
+  // throttles. Will be unset before WillStartRequest is finished. Will be unset
+  // while throttles are being run, but before they finish.
+  base::Optional<NavigationThrottle::ThrottleCheckResult>
+      last_throttle_check_result_;
+
+  // Closure that is set when WaitForThrottleChecksComplete is called.
+  base::Closure throttle_checks_wait_closure_;
+
   base::WeakPtrFactory<NavigationSimulator> weak_factory_;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_TEST_NAVIGATION_SIMULATOR_H_