OOPIF support for testRunner.dumpAsText and similar layout dumps.

content/shell/browser/blink_test_controller.cc

 // Copyright 2013 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/shell/browser/blink_test_controller.h"
 
 #include <stddef.h>
 
 #include <iostream>
+#include <utility>
 
 #include "base/base64.h"
 #include "base/callback.h"
 #include "base/command_line.h"
 #include "base/location.h"
+#include "base/logging.h"
 #include "base/run_loop.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
 #include "base/thread_task_runner_handle.h"
 #include "build/build_config.h"
 #include "content/public/browser/devtools_agent_host.h"
 #include "content/public/browser/dom_storage_context.h"
 #include "content/public/browser/gpu_data_manager.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
+#include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/render_widget_host.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/service_worker_context.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/url_constants.h"
 #include "content/shell/browser/layout_test/layout_test_bluetooth_chooser_factory.h"
 #include "content/shell/browser/layout_test/layout_test_devtools_frontend.h"
 #include "content/shell/browser/shell.h"
 #include "content/shell/browser/shell_browser_context.h"
 #include "content/shell/browser/shell_content_browser_client.h"
 #include "content/shell/browser/shell_devtools_frontend.h"
 #include "content/shell/common/shell_messages.h"
 #include "content/shell/common/shell_switches.h"
 #include "content/shell/renderer/layout_test/blink_test_helpers.h"
 #include "ui/gfx/codec/png_codec.h"
 
 namespace content {
 
+namespace {
+
 const int kTestSVGWindowWidthDip = 480;
 const int kTestSVGWindowHeightDip = 360;
 
+void AppendLayoutDumpForFrame(
+    const std::map<int, std::string>& frame_to_layout_dump_map,
+    std::string* stitched_layout_dump,
+    RenderFrameHost* target) {
+  auto it = frame_to_layout_dump_map.find(target->GetFrameTreeNodeId());
+
+  // No match will happen if frames have been added since OnInitiateLayoutDump.
+  if (it == frame_to_layout_dump_map.end())
+    return;
+
+  const std::string& dump = it->second;
+  stitched_layout_dump->append(dump);
+}
+
+}  // namespace
+
 // BlinkTestResultPrinter ----------------------------------------------------
 
 BlinkTestResultPrinter::BlinkTestResultPrinter(std::ostream* output,
                                                std::ostream* error)
     : state_(DURING_TEST),
       capture_text_only_(false),
       encode_binary_data_(false),
       output_(output),
       error_(error) {
 }
@@ skipping 187 matching lines @@
     const base::FilePath& current_working_directory,
     bool enable_pixel_dumping,
     const std::string& expected_pixel_hash) {
   DCHECK(CalledOnValidThread());
   test_phase_ = DURING_TEST;
   current_working_directory_ = current_working_directory;
   enable_pixel_dumping_ = enable_pixel_dumping;
   expected_pixel_hash_ = expected_pixel_hash;
   test_url_ = test_url;
   printer_->reset();
+  frame_to_layout_dump_map_.clear();
   ShellBrowserContext* browser_context =
       ShellContentBrowserClient::Get()->browser_context();
   if (test_url.spec().find("compositing/") != std::string::npos)
     is_compositing_test_ = true;
   initial_size_ = Shell::GetShellDefaultSize();
   // The W3C SVG layout tests use a different size than the other layout tests.
   if (test_url.spec().find("W3C-SVG-1.1") != std::string::npos)
     initial_size_ = gfx::Size(kTestSVGWindowWidthDip, kTestSVGWindowHeightDip);
   if (!main_window_) {
     main_window_ = content::Shell::CreateNewWindow(
@@ skipping 115 matching lines @@
   }
   return nullptr;
 }
 
 bool BlinkTestController::OnMessageReceived(const IPC::Message& message) {
   DCHECK(CalledOnValidThread());
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(BlinkTestController, message)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_PrintMessage, OnPrintMessage)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_TextDump, OnTextDump)
+    IPC_MESSAGE_HANDLER(ShellViewHostMsg_InitiateLayoutDump,
+                        OnInitiateLayoutDump)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_ImageDump, OnImageDump)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_AudioDump, OnAudioDump)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_OverridePreferences,
                         OnOverridePreferences)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_TestFinished, OnTestFinished)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_ClearDevToolsLocalStorage,
                         OnClearDevToolsLocalStorage)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_ShowDevTools, OnShowDevTools)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_CloseDevTools, OnCloseDevTools)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_GoToOffset, OnGoToOffset)
@@ skipping 10 matching lines @@
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_GetBluetoothManualChooserEvents,
                         OnGetBluetoothManualChooserEvents)
     IPC_MESSAGE_HANDLER(ShellViewHostMsg_SendBluetoothManualChooserEvent,
                         OnSendBluetoothManualChooserEvent)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
 
   return handled;
 }
 
+bool BlinkTestController::OnMessageReceived(
+    const IPC::Message& message,
+    RenderFrameHost* render_frame_host) {
+  bool handled = true;
+  IPC_BEGIN_MESSAGE_MAP_WITH_PARAM(BlinkTestController, message,
+                                   render_frame_host)
+    IPC_MESSAGE_HANDLER(ShellViewHostMsg_LayoutDumpResponse,
+                        OnLayoutDumpResponse)
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
 void BlinkTestController::PluginCrashed(const base::FilePath& plugin_path,
                                         base::ProcessId plugin_pid) {
   DCHECK(CalledOnValidThread());
   printer_->AddErrorMessage(
       base::StringPrintf("#CRASHED - plugin (pid %d)", plugin_pid));
   base::ThreadTaskRunnerHandle::Get()->PostTask(
       FROM_HERE,
       base::Bind(base::IgnoreResult(&BlinkTestController::DiscardMainWindow),
                  base::Unretained(this)));
 }
@@ skipping 155 matching lines @@
   printer_->PrintAudioBlock(dump);
   printer_->PrintAudioFooter();
 }
 
 void BlinkTestController::OnTextDump(const std::string& dump) {
   printer_->PrintTextHeader();
   printer_->PrintTextBlock(dump);
   printer_->PrintTextFooter();
 }
 
+void BlinkTestController::OnInitiateLayoutDump(
+    test_runner::LayoutDumpFlags layout_dump_flags) {
+  DCHECK(layout_dump_flags.dump_child_frames);
+  pending_layout_dumps_ = main_window_->web_contents()->SendToAllFrames(
+      new ShellViewMsg_LayoutDumpRequest(MSG_ROUTING_NONE, layout_dump_flags));
+}
+
+void BlinkTestController::OnLayoutDumpResponse(RenderFrameHost* sender,
+                                               const std::string& dump) {
+  // Store the result.
+  auto pair = frame_to_layout_dump_map_.insert(
+      std::make_pair(sender->GetFrameTreeNodeId(), dump));
+  bool insertion_took_place = pair.second;
+  DCHECK(insertion_took_place);
+
+  // See if we need to wait for more responses.
+  pending_layout_dumps_--;
+  DCHECK_LE(0, pending_layout_dumps_);
+  if (pending_layout_dumps_ > 0)
+    return;
+
+  // Stitch the frame-specific results in the right order.
+  // TODO(lukasza): Replace with a for loop similar to crrev.com/1612503003.
+  std::string stitched_layout_dump;
+  main_window_->web_contents()->ForEachFrame(base::Bind(
+      &AppendLayoutDumpForFrame,
+      base::ConstRef(frame_to_layout_dump_map_),
+      &stitched_layout_dump));
+
+  // Continue finishing the test.
+  RenderViewHost* render_view_host =
+      main_window_->web_contents()->GetRenderViewHost();
+  render_view_host->Send(new ShellViewMsg_LayoutDumpCompleted(
+      render_view_host->GetRoutingID(), stitched_layout_dump));
+}
+
 void BlinkTestController::OnPrintMessage(const std::string& message) {
   printer_->AddMessageRaw(message);
 }
 
 void BlinkTestController::OnOverridePreferences(const WebPreferences& prefs) {
   should_override_prefs_ = true;
   prefs_ = prefs;
 }
 
 void BlinkTestController::OnClearDevToolsLocalStorage() {
@@ skipping 159 matching lines @@
   } else {
     printer_->AddErrorMessage(base::StringPrintf(
         "FAIL: Unexpected sendBluetoothManualChooserEvent() event name '%s'.",
         event_name.c_str()));
     return;
   }
   bluetooth_chooser_factory_->SendEvent(event, argument);
 }
 
 }  // namespace content