Replicating LayoutDumpFlags across OOPIFs.

content/shell/renderer/layout_test/blink_test_runner.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/shell/renderer/layout_test/blink_test_runner.h"
 
 #include <stddef.h>
 #include <algorithm>
 #include <clocale>
 #include <cmath>
 #include <utility>
 
 #include "base/base64.h"
 #include "base/command_line.h"
 #include "base/compiler_specific.h"
 #include "base/debug/debugger.h"
 #include "base/files/file_path.h"
+#include "base/guid.h"
 #include "base/location.h"
 #include "base/macros.h"
 #include "base/md5.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/thread_task_runner_handle.h"
 #include "base/time/time.h"
 #include "build/build_config.h"
 #include "components/plugins/renderer/plugin_placeholder.h"
 #include "components/test_runner/app_banner_client.h"
 #include "components/test_runner/gamepad_controller.h"
 #include "components/test_runner/layout_dump.h"
 #include "components/test_runner/layout_dump_flags.h"
 #include "components/test_runner/mock_screen_orientation_client.h"
 #include "components/test_runner/test_interfaces.h"
+#include "components/test_runner/tracked_dictionary.h"
 #include "components/test_runner/web_task.h"
 #include "components/test_runner/web_test_interfaces.h"
 #include "components/test_runner/web_test_proxy.h"
 #include "components/test_runner/web_test_runner.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/common/web_preferences.h"
 #include "content/public/renderer/media_stream_api.h"
 #include "content/public/renderer/render_frame.h"
 #include "content/public/renderer/render_view.h"
@@ skipping 198 matching lines @@
 
 }  // namespace
 
 BlinkTestRunner::BlinkTestRunner(RenderView* render_view)
     : RenderViewObserver(render_view),
       RenderViewObserverTracker<BlinkTestRunner>(render_view),
       proxy_(NULL),
       focused_view_(NULL),
       is_main_window_(false),
       focus_on_next_commit_(false),
-      leak_detector_(new LeakDetector(this)) {
-}
+      leak_detector_(new LeakDetector(this)),
+      guid_(base::GenerateGUID()) {}
 
 BlinkTestRunner::~BlinkTestRunner() {
 }
 
 // WebTestDelegate  -----------------------------------------------------------
 
 void BlinkTestRunner::ClearEditCommand() {
   render_view()->ClearEditCommands();
 }
 
@@ skipping 336 matching lines @@
     result = result.substr(0, strlen("file:///")) +
              result.substr(strlen("file:////"));
   }
   return RewriteLayoutTestsURL(result).string().utf8();
 }
 
 void BlinkTestRunner::SetLocale(const std::string& locale) {
   setlocale(LC_ALL, locale.c_str());
 }
 
+void BlinkTestRunner::OnLayoutDumpFlagsChanged(
+    test_runner::LayoutDumpFlags* layout_dump_flags) {
+  // Ignore changes that happen before we got the initial, accumulated
+  // layout flag changes in ShellViewMsg_ReplicateTestConfiguration.
+  if (!is_main_window_)
+    return;
+
+  const base::DictionaryValue& changed_values =
+      layout_dump_flags->tracked_dictionary().changed_values();
+  Send(new ShellViewHostMsg_LayoutDumpFlagsChanged(routing_id(), changed_values,
+                                                   guid_));
+  layout_dump_flags->tracked_dictionary().ResetChangeTracking();
+}
+
 void BlinkTestRunner::TestFinished() {
   if (!is_main_window_ || !render_view()->GetMainRenderFrame()) {
     Send(new ShellViewHostMsg_TestFinishedInSecondaryRenderer(routing_id()));
     return;
   }
   test_runner::WebTestInterfaces* interfaces =
       LayoutTestRenderProcessObserver::GetInstance()->test_interfaces();
   interfaces->SetTestIsRunning(false);
   if (interfaces->TestRunner()->ShouldDumpBackForwardList()) {
     SyncNavigationStateVisitor visitor;
@@ skipping 266 matching lines @@
 
   const test_runner::LayoutDumpFlags& layout_dump_flags =
       interfaces->TestRunner()->GetLayoutDumpFlags();
   if (!layout_dump_flags.dump_child_frames()) {
     std::string layout_dump = DumpLayout(
         render_view()->GetMainRenderFrame()->GetWebFrame(), layout_dump_flags);
     OnLayoutDumpCompleted(layout_dump);
     return;
   }
 
-  Send(
-      new ShellViewHostMsg_InitiateLayoutDump(routing_id(), layout_dump_flags));
+  Send(new ShellViewHostMsg_InitiateLayoutDump(routing_id()));
   // OnLayoutDumpCompleted will be eventually called by an IPC from the browser.
 }
 
 void BlinkTestRunner::OnLayoutDumpCompleted(std::string completed_layout_dump) {
   test_runner::WebTestInterfaces* interfaces =
       LayoutTestRenderProcessObserver::GetInstance()->test_interfaces();
   if (interfaces->TestRunner()->ShouldDumpBackForwardList()) {
     completed_layout_dump.append(proxy()->DumpBackForwardLists());
   }
 
@@ skipping 51 matching lines @@
 
 void BlinkTestRunner::CaptureDumpComplete() {
   render_view()->GetWebView()->mainFrame()->stopLoading();
 
   base::ThreadTaskRunnerHandle::Get()->PostTask(
       FROM_HERE, base::Bind(base::IgnoreResult(&BlinkTestRunner::Send),
                             base::Unretained(this),
                             new ShellViewHostMsg_TestFinished(routing_id())));
 }
 
-void BlinkTestRunner::OnReplicateTestConfiguration(
+void BlinkTestRunner::SetTestConfiguration(
     const ShellTestConfiguration& params) {
   test_config_ = params;
   is_main_window_ = true;
 
   test_runner::WebTestInterfaces* interfaces =
       LayoutTestRenderProcessObserver::GetInstance()->test_interfaces();
   interfaces->SetTestIsRunning(true);
   interfaces->ConfigureForTestWithURL(params.test_url,
                                       params.enable_pixel_dumping);
 }
 
+void BlinkTestRunner::OnReplicateTestConfiguration(
+    const ShellTestConfiguration& params,
+    const base::DictionaryValue& accumulated_layout_dump_flags_changes) {
+  SetTestConfiguration(params);
+  LayoutTestRenderProcessObserver::GetInstance()
+      ->test_interfaces()
+      ->TestRunner()
+      ->ReplicateLayoutDumpFlagsChanges(accumulated_layout_dump_flags_changes);
+}
+
 void BlinkTestRunner::OnSetTestConfiguration(
     const ShellTestConfiguration& params) {
-  OnReplicateTestConfiguration(params);
+  SetTestConfiguration(params);
 
   ForceResizeRenderView(
       render_view(),
       WebSize(params.initial_size.width(), params.initial_size.height()));
   SetFocus(proxy_, true);
 }
 
+void BlinkTestRunner::OnReplicateLayoutDumpFlagsChanges(
+    const base::DictionaryValue& changed_layout_dump_flags,
+    const std::string& change_originator_guid) {
+  if (change_originator_guid == guid_)
+    return;

[Łukasz Anforowicz, 2016/03/03 21:46:34]

We want to avoid consuming change notification broadcasts in the renderer that
originated the change (otherwise the broadcast can clobber subsequent changes in
the originator).  This is done via |change_originator_guid| in the CL.

This results in 1 avoidable IPC from browser to renderer (but then
correctness>performance + this is just test code?).  Plus, I don’t know how to
do things more efficiently or cleanly:

- I don’t know how the browser can identify RPH associated with the sender (this
might be doable if the notification was a RFH rather than RVH message, but
renderer side inherently gets change notifications at RV level [AFAICT some flag
changes cannot be attributed to a specific frame]).

- I don’t know how the renderer could send its RPH->GetID in the payload (there
is no RP::GetID method).

+
+  LayoutTestRenderProcessObserver::GetInstance()
+      ->test_interfaces()
+      ->TestRunner()
+      ->ReplicateLayoutDumpFlagsChanges(changed_layout_dump_flags);
+}
+
 void BlinkTestRunner::OnSessionHistory(
     const std::vector<int>& routing_ids,
     const std::vector<std::vector<PageState>>& session_histories,
     const std::vector<unsigned>& current_entry_indexes) {
   routing_ids_ = routing_ids;
   session_histories_ = session_histories;
   current_entry_indexes_ = current_entry_indexes;
   CaptureDump();
 }
 
@@ skipping 29 matching lines @@
   get_bluetooth_events_callbacks_.pop_front();
   callback.Run(events);
 }
 
 void BlinkTestRunner::ReportLeakDetectionResult(
     const LeakDetectionResult& report) {
   Send(new ShellViewHostMsg_LeakDetectionDone(routing_id(), report));
 }
 
 }  // namespace content