Convert BlinkTestHostMsg_ResetDone to Mojo in blink test IPC message

This CL migrate the legacy ResetDone IPC message to the new Mojo
in BlinkTestClient interface.

This CL adds a |is_secondary_window_| flag to WebTestRenderFrameObserver
to avoid calling ResetDone twice when a secondary window exists. Then,
it's passed to BlinkTestRunner::DidCommitNavigationInMainFrame to avoid
calling ResetDone twice. Because twice calls of ResetDone can cause a
crash during the web test.

Bug: 1039247
Change-Id: Ia992616449ec54d1e28d2a6804f907cfac404cf7
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2009595Reviewed-by: Mike West <mkwst@chromium.org>
Reviewed-by: Dave Tapuska <dtapuska@chromium.org>
Commit-Queue: Gyuyoung Kim <gyuyoung@igalia.com>
Cr-Commit-Position: refs/heads/master@{#738004}

content/shell/browser/web_test/blink_test_client_impl.cc

@@ -25,6 +25,10 @@ void BlinkTestClientImpl::InitiateLayoutDump() {
   BlinkTestController::Get()->OnInitiateLayoutDump();
 }
 
+void BlinkTestClientImpl::ResetDone() {
+  BlinkTestController::Get()->OnResetDone();
+}
+
 void BlinkTestClientImpl::PrintMessageToStderr(const std::string& message) {
   BlinkTestController::Get()->OnPrintMessageToStderr(message);
 }

content/shell/browser/web_test/blink_test_client_impl.h

@@ -23,6 +23,7 @@ class BlinkTestClientImpl : public mojom::BlinkTestClient {
  private:
   // BlinkTestClient implementation.
   void InitiateLayoutDump() override;
+  void ResetDone() override;
   void PrintMessageToStderr(const std::string& message) override;
   void Reload() override;
   void OverridePreferences(

content/shell/browser/web_test/blink_test_controller.cc

@@ -804,7 +804,6 @@ bool BlinkTestController::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(BlinkTestController, message)
     IPC_MESSAGE_HANDLER(BlinkTestHostMsg_PrintMessage, OnPrintMessage)
-    IPC_MESSAGE_HANDLER(BlinkTestHostMsg_ResetDone, OnResetDone)
     IPC_MESSAGE_HANDLER(WebTestHostMsg_BlockThirdPartyCookies,
                         OnBlockThirdPartyCookies)
     IPC_MESSAGE_UNHANDLED(handled = false)
@@ -1019,18 +1018,18 @@ void BlinkTestController::OnTestFinished() {
 }
 
 void BlinkTestController::OnCleanupFinished() {
-  if (main_window_) {
-    main_window_->web_contents()->Stop();
-    GetBlinkTestControlRemote(
-        main_window_->web_contents()->GetRenderViewHost()->GetMainFrame())
-        ->Reset();
-  }
   if (secondary_window_) {
     secondary_window_->web_contents()->Stop();
     GetBlinkTestControlRemote(
         secondary_window_->web_contents()->GetRenderViewHost()->GetMainFrame())
         ->Reset();
   }
+  if (main_window_) {
+    main_window_->web_contents()->Stop();
+    GetBlinkTestControlRemote(
+        main_window_->web_contents()->GetRenderViewHost()->GetMainFrame())
+        ->Reset();
+  }
 }
 
 void BlinkTestController::OnCaptureDumpCompleted(mojom::BlinkTestDumpPtr dump) {

content/shell/common/blink_test.mojom

@@ -96,6 +96,9 @@ interface BlinkTestClient {
   // BlinkTestMsg_LayoutDumpCompleted.
   InitiateLayoutDump();
 
+  // Notify the browser process the reset was done.
+  ResetDone();
+
   // Add a message to stderr (not saved to expected output files, for debugging
   // only).
   PrintMessageToStderr(string message);

content/shell/common/web_test/blink_test_messages.h

@@ -15,8 +15,6 @@
 
 #define IPC_MESSAGE_START BlinkTestMsgStart
 
-IPC_MESSAGE_ROUTED0(BlinkTestHostMsg_ResetDone)
-
 // WebTestDelegate related.
 IPC_MESSAGE_ROUTED1(BlinkTestHostMsg_PrintMessage, std::string /* message */)
 

content/shell/renderer/web_test/blink_test_runner.cc

@@ -716,15 +716,22 @@ void BlinkTestRunner::CaptureDump(
   CaptureDumpComplete();
 }
 
-void BlinkTestRunner::DidCommitNavigationInMainFrame() {
+void BlinkTestRunner::DidCommitNavigationInMainFrame(bool is_secondary_window) {
   WebFrame* main_frame = render_view()->GetWebView()->MainFrame();
   if (!waiting_for_reset_ || !main_frame->IsWebLocalFrame())
     return;
   GURL url = main_frame->ToWebLocalFrame()->GetDocumentLoader()->GetUrl();
   if (!url.IsAboutBlank())
     return;
+
+  // Avoid a situation where ResetDone is called twice, because
+  // ResetDone should be called once if a secondary renderer exists.
+  if (is_secondary_window)
+    return;
+
   waiting_for_reset_ = false;
-  Send(new BlinkTestHostMsg_ResetDone(routing_id()));
+
+  GetBlinkTestClientRemote().ResetDone();
 }
 
 // Private methods  -----------------------------------------------------------

content/shell/renderer/web_test/blink_test_runner.h

@@ -152,7 +152,7 @@ class BlinkTestRunner : public RenderViewObserver,
   void OnReplicateTestConfiguration(mojom::ShellTestConfigurationPtr params);
   void OnSetupSecondaryRenderer();
   void CaptureDump(mojom::BlinkTestControl::CaptureDumpCallback callback);
-  void DidCommitNavigationInMainFrame();
+  void DidCommitNavigationInMainFrame(bool is_secondary_window);
   void OnReset();
   void OnTestFinishedInSecondaryRenderer();
   void OnLayoutDumpCompleted(std::string completed_layout_dump);

content/shell/renderer/web_test/web_test_render_frame_observer.cc

@@ -64,7 +64,7 @@ void WebTestRenderFrameObserver::DidCommitProvisionalLoad(
         render_frame()->GetWebFrame());
   }
   BlinkTestRunner::Get(render_frame()->GetRenderView())
-      ->DidCommitNavigationInMainFrame();
+      ->DidCommitNavigationInMainFrame(is_secondary_window_);
 }
 
 void WebTestRenderFrameObserver::DidFailProvisionalLoad() {
@@ -114,6 +114,7 @@ void WebTestRenderFrameObserver::SetTestConfiguration(
 void WebTestRenderFrameObserver::SetupSecondaryRenderer() {
   BlinkTestRunner::Get(render_frame()->GetRenderView())
       ->OnSetupSecondaryRenderer();
+  is_secondary_window_ = true;
 }
 
 void WebTestRenderFrameObserver::Reset() {

content/shell/renderer/web_test/web_test_render_frame_observer.h

@@ -47,6 +47,7 @@ class WebTestRenderFrameObserver : public RenderFrameObserver,
 
   mojo::AssociatedReceiver<mojom::BlinkTestControl> receiver_{this};
   bool focus_on_next_commit_ = false;
+  bool is_secondary_window_ = false;
   DISALLOW_COPY_AND_ASSIGN(WebTestRenderFrameObserver);
 };