Show/Hide RenderWidgetHostViews under an OOPIF when its Frame Owner becomes Visible/Hidden
Right now changing the visibility state of a cross-origin iframe will
lead to calls to RenderWidgetHostView::Show/Hide on its corresponding
view. Therefore, when hiding a frame the RenderWidget will stop
generating compositor frames.
However, when the iframe itself has nested cross-origin frames, the
current calls to Hide() and Show() are not replicated for their views.
This CL adds the missing code to inform the subviews about changes in
the visibility state.
The CL also modifies the existing test for visibility change a test to
further verify that hiding a cross origin iframe will also hide any
child view nested within it.
Bug: 628704
Cq-Include-Trybots: master.tryserver.chromium.linux:linux_site_isolation
Change-Id: I3589d1e90ae7ee8bfdb654625c451cc0e6704785
Reviewed-on: https://chromium-review.googlesource.com/599006
Commit-Queue: Ehsan Karamad <[email protected]>
Reviewed-by: Alex Moshchuk <[email protected]>
Reviewed-by: Ken Buchanan <[email protected]>
Reviewed-by: Lucas Gadani <[email protected]>
Cr-Commit-Position: refs/heads/master@{#495861}diff --git a/content/browser/frame_host/cross_process_frame_connector.cc b/content/browser/frame_host/cross_process_frame_connector.cc
index bf3d30ff..26d257a 100644
--- a/content/browser/frame_host/cross_process_frame_connector.cc
+++ b/content/browser/frame_host/cross_process_frame_connector.cc
@@ -385,4 +385,11 @@
return is_hidden_;
}
+void CrossProcessFrameConnector::SetVisibilityForChildViews(
+ bool visible) const {
+ frame_proxy_in_parent_renderer_->frame_tree_node()
+ ->current_frame_host()
+ ->SetVisibilityForChildViews(visible);
+}
+
} // namespace content
diff --git a/content/browser/frame_host/cross_process_frame_connector.h b/content/browser/frame_host/cross_process_frame_connector.h
index e690274..c14b061 100644
--- a/content/browser/frame_host/cross_process_frame_connector.h
+++ b/content/browser/frame_host/cross_process_frame_connector.h
@@ -99,6 +99,10 @@
bool IsInert() const override;
bool IsHidden() const override;
+ // Set the visibility of immediate child views, i.e. views whose parent view
+ // is |view_|.
+ void SetVisibilityForChildViews(bool visible) const override;
+
// Exposed for tests.
RenderWidgetHostViewBase* GetRootRenderWidgetHostViewForTesting() {
return GetRootRenderWidgetHostView();
diff --git a/content/browser/frame_host/render_frame_host_impl.cc b/content/browser/frame_host/render_frame_host_impl.cc
index 444a009..05c00fb 100644
--- a/content/browser/frame_host/render_frame_host_impl.cc
+++ b/content/browser/frame_host/render_frame_host_impl.cc
@@ -5,6 +5,7 @@
#include "content/browser/frame_host/render_frame_host_impl.h"
#include <algorithm>
+#include <queue>
#include <utility>
#include "base/bind.h"
@@ -4263,4 +4264,33 @@
}
#endif
+void RenderFrameHostImpl::ForEachImmediateLocalRoot(
+ const base::Callback<void(RenderFrameHostImpl*)>& callback) {
+ if (!frame_tree_node_->child_count())
+ return;
+
+ std::queue<FrameTreeNode*> queue;
+ for (size_t index = 0; index < frame_tree_node_->child_count(); ++index)
+ queue.push(frame_tree_node_->child_at(index));
+ while (queue.size()) {
+ FrameTreeNode* current = queue.front();
+ queue.pop();
+ if (current->current_frame_host()->is_local_root()) {
+ callback.Run(current->current_frame_host());
+ } else {
+ for (size_t index = 0; index < current->child_count(); ++index)
+ queue.push(current->child_at(index));
+ }
+ }
+}
+
+void RenderFrameHostImpl::SetVisibilityForChildViews(bool visible) {
+ ForEachImmediateLocalRoot(base::Bind(
+ [](bool is_visible, RenderFrameHostImpl* frame_host) {
+ if (auto* view = frame_host->GetView())
+ return is_visible ? view->Show() : view->Hide();
+ },
+ visible));
+}
+
} // namespace content
diff --git a/content/browser/frame_host/render_frame_host_impl.h b/content/browser/frame_host/render_frame_host_impl.h
index eae28864..53464c7 100644
--- a/content/browser/frame_host/render_frame_host_impl.h
+++ b/content/browser/frame_host/render_frame_host_impl.h
@@ -642,6 +642,11 @@
service_manager::InterfaceProvider* GetJavaInterfaces() override;
#endif
+ // Propagates the visibility state along the immediate local roots by calling
+ // RenderWidgetHostViewChildFrame::Show()/Hide(). Calling this on a pending
+ // or speculative RenderFrameHost (that has not committed) should be avoided.
+ void SetVisibilityForChildViews(bool visible);
+
// Returns an unguessable token for this RFHI. This provides a temporary way
// to identify a RenderFrameHost that's compatible with IPC. Else, one needs
// to send pid + RoutingID, but one cannot send pid. One can get it from the
@@ -692,6 +697,7 @@
WebUIJavascriptDisallowedAfterSwapOut);
FRIEND_TEST_ALL_PREFIXES(RenderFrameHostManagerTest, LastCommittedOrigin);
FRIEND_TEST_ALL_PREFIXES(SitePerProcessBrowserTest, CrashSubframe);
+ FRIEND_TEST_ALL_PREFIXES(SitePerProcessBrowserTest, FindImmediateLocalRoots);
FRIEND_TEST_ALL_PREFIXES(SitePerProcessBrowserTest,
RenderViewHostIsNotReusedAfterDelayedSwapOutACK);
FRIEND_TEST_ALL_PREFIXES(SitePerProcessBrowserTest,
@@ -970,6 +976,28 @@
// can be released.
void OnStreamHandleConsumed(const GURL& stream_url);
+ // TODO(ekaramad): One major purpose behind the API is to traverse the frame
+ // tree top-down to visit the RenderWidgetHostViews of interest in the most
+ // efficient way. We might want to revisit this API, remove it from RFHImpl,
+ // and perhaps consolidate it with some of the existing ones such as
+ // WebContentsImpl::GetRenderWidgetHostViewsInTree() into a new more
+ // appropriate API for dealing with (virtual) RenderWidgetHost(View) tree.
+ // (see https://crbug.com/754726).
+ // Runs |callback| for all the local roots immediately under this frame, i.e.
+ // local roots which are under this frame and their first ancestor which is a
+ // local root is either this frame or this frame's local root. For instance,
+ // in a frame tree such as:
+ // A0
+ // / | \
+ // B A1 E
+ // / / \ \
+ // D A2 C F
+ // RFHs at nodes B, E, D, C, and F are all local roots in the given frame tree
+ // under the root at A0, but only B, C, and E are considered immediate local
+ // roots of A0. Note that this will exclude any speculative or pending RFHs.
+ void ForEachImmediateLocalRoot(
+ const base::Callback<void(RenderFrameHostImpl*)>& callback);
+
// For now, RenderFrameHosts indirectly keep RenderViewHosts alive via a
// refcount that calls Shutdown when it reaches zero. This allows each
// RenderFrameHostManager to just care about RenderFrameHosts, while ensuring
diff --git a/content/browser/renderer_host/frame_connector_delegate.h b/content/browser/renderer_host/frame_connector_delegate.h
index 533371d..d35cd38 100644
--- a/content/browser/renderer_host/frame_connector_delegate.h
+++ b/content/browser/renderer_host/frame_connector_delegate.h
@@ -139,6 +139,10 @@
// RenderWidgetHostView::Hide() is called on the current view.
virtual bool IsHidden() const;
+ // Called by RenderWidgetHostViewChildFrame to update the visibility of any
+ // nested child RWHVCFs inside it.
+ virtual void SetVisibilityForChildViews(bool visible) const {}
+
protected:
virtual ~FrameConnectorDelegate() {}
diff --git a/content/browser/renderer_host/render_widget_host_view_child_frame.cc b/content/browser/renderer_host/render_widget_host_view_child_frame.cc
index b1ef369..2bee7be 100644
--- a/content/browser/renderer_host/render_widget_host_view_child_frame.cc
+++ b/content/browser/renderer_host/render_widget_host_view_child_frame.cc
@@ -217,12 +217,18 @@
return;
host_->WasShown(ui::LatencyInfo());
+
+ if (frame_connector_)
+ frame_connector_->SetVisibilityForChildViews(true);
}
void RenderWidgetHostViewChildFrame::Hide() {
if (host_->is_hidden())
return;
host_->WasHidden();
+
+ if (frame_connector_)
+ frame_connector_->SetVisibilityForChildViews(false);
}
bool RenderWidgetHostViewChildFrame::IsShowing() {
diff --git a/content/browser/renderer_host/render_widget_host_view_child_frame_unittest.cc b/content/browser/renderer_host/render_widget_host_view_child_frame_unittest.cc
index 646a317..1f9161a3 100644
--- a/content/browser/renderer_host/render_widget_host_view_child_frame_unittest.cc
+++ b/content/browser/renderer_host/render_widget_host_view_child_frame_unittest.cc
@@ -169,6 +169,12 @@
}
TEST_F(RenderWidgetHostViewChildFrameTest, VisibilityTest) {
+ // Calling show and hide also needs to be propagated to child frame by the
+ // |frame_connector_| which itself requires a |frame_proxy_in_parent_renderer|
+ // (set to nullptr for MockFrameConnectorDelegate). To avoid crashing the test
+ // |frame_connector_| is to set to nullptr.
+ view_->SetFrameConnectorDelegate(nullptr);
+
view_->Show();
ASSERT_TRUE(view_->IsShowing());
diff --git a/content/browser/site_per_process_browsertest.cc b/content/browser/site_per_process_browsertest.cc
index 32591af..421f6907 100644
--- a/content/browser/site_per_process_browsertest.cc
+++ b/content/browser/site_per_process_browsertest.cc
@@ -7352,43 +7352,131 @@
EXPECT_TRUE(watcher.did_exit_normally());
}
-IN_PROC_BROWSER_TEST_F(SitePerProcessBrowserTest, VisibilityChanged) {
- GURL main_url(
- embedded_test_server()->GetURL("a.com", "/page_with_iframe.html"));
+// TODO(ekaramad): Move this test out of this file when addressing
+// https://crbug.com/754726.
+// This test verifies that RFHImpl::ForEachImmediateLocalRoot works as expected.
+// The frame tree used in the test is:
+// A0
+// / | \
+// A1 B1 A2
+// / \ | / \
+// B2 A3 B3 A4 C2
+// / / / \ \
+// D1 D2 C3 C4 C5
+//
+// As an example, the expected set of immediate local roots for the root node A0
+// should be {B1, B2, C2, D2, C5}. Note that the order is compatible with that
+// of a BFS traversal from root node A0.
+IN_PROC_BROWSER_TEST_F(SitePerProcessBrowserTest, FindImmediateLocalRoots) {
+ GURL main_url(embedded_test_server()->GetURL(
+ "a.com",
+ "/cross_site_iframe_factory.html?a(a(b(d),a(d)),b(b(c,c)),a(a(c),c))"));
EXPECT_TRUE(NavigateToURL(shell(), main_url));
- EXPECT_EQ(shell()->web_contents()->GetLastCommittedURL(), main_url);
- GURL cross_site_url =
- embedded_test_server()->GetURL("oopif.com", "/title1.html");
+ // Each entry is of the frame "LABEL:ILR1ILR2..." where ILR stands for
+ // immediate local root.
+ std::string immediate_local_roots[] = {
+ "A0:B1B2C2D2C5", "A1:B2D2", "B1:C3C4", "A2:C2C5", "B2:D1",
+ "A3:D2", "B3:C3C4", "A4:C5", "C2:", "D1:",
+ "D2:", "C3:", "C4:", "C5:"};
- FrameTreeNode* root = web_contents()->GetFrameTree()->root();
+ std::map<RenderFrameHostImpl*, std::string>
+ frame_to_immediate_local_roots_map;
+ std::map<RenderFrameHostImpl*, std::string> frame_to_label_map;
+ size_t index = 0;
+ // Map each RenderFrameHostImpl to its label and set of immediate local roots.
+ for (auto* ftn : web_contents()->GetFrameTree()->Nodes()) {
+ std::string roots = immediate_local_roots[index++];
+ frame_to_immediate_local_roots_map[ftn->current_frame_host()] = roots;
+ frame_to_label_map[ftn->current_frame_host()] = roots.substr(0, 2);
+ }
- TestNavigationObserver observer(shell()->web_contents());
+ // For each frame in the tree, verify that ForEachImmediateLocalRoot properly
+ // visits each and only each immediate local root in a BFS traversal order.
+ for (auto* ftn : web_contents()->GetFrameTree()->Nodes()) {
+ RenderFrameHostImpl* current_frame_host = ftn->current_frame_host();
+ std::list<RenderFrameHostImpl*> frame_list;
+ current_frame_host->ForEachImmediateLocalRoot(
+ base::Bind([](std::list<RenderFrameHostImpl*>* ilr_list,
+ RenderFrameHostImpl* rfh) { ilr_list->push_back(rfh); },
+ &frame_list));
- NavigateFrameToURL(root->child_at(0), cross_site_url);
- EXPECT_EQ(cross_site_url, observer.last_navigation_url());
- EXPECT_TRUE(observer.last_navigation_succeeded());
+ std::string result = frame_to_label_map[current_frame_host];
+ result.append(":");
+ for (auto* ilr_ptr : frame_list)
+ result.append(frame_to_label_map[ilr_ptr]);
+ EXPECT_EQ(frame_to_immediate_local_roots_map[current_frame_host], result);
+ }
+}
- RenderWidgetHostImpl* render_widget_host =
- root->child_at(0)->current_frame_host()->GetRenderWidgetHost();
- EXPECT_FALSE(render_widget_host->is_hidden());
+// This test verifies that changing the CSS visibility of a cross-origin
+// <iframe> is forwarded to its corresponding RenderWidgetHost and all other
+// RenderWidgetHosts corresponding to the nested cross-origin frame.
+IN_PROC_BROWSER_TEST_F(SitePerProcessBrowserTest, CSSVisibilityChanged) {
+ GURL main_url(embedded_test_server()->GetURL(
+ "a.com", "/cross_site_iframe_factory.html?a(b(b(c(d(d(a))))))"));
+ EXPECT_TRUE(NavigateToURL(shell(), main_url));
+
+ // Find all child RenderWidgetHosts.
+ std::vector<RenderWidgetHostImpl*> child_widget_hosts;
+ FrameTreeNode* first_cross_process_child =
+ web_contents()->GetFrameTree()->root()->child_at(0);
+ for (auto* ftn : web_contents()->GetFrameTree()->SubtreeNodes(
+ first_cross_process_child)) {
+ RenderFrameHostImpl* frame_host = ftn->current_frame_host();
+ if (!frame_host->is_local_root())
+ continue;
+
+ child_widget_hosts.push_back(frame_host->GetRenderWidgetHost());
+ }
+
+ // Ignoring the root, there is exactly 4 local roots and hence 5
+ // RenderWidgetHosts on the page.
+ EXPECT_EQ(4U, child_widget_hosts.size());
+
+ // Initially all the RenderWidgetHosts should be visible.
+ for (size_t index = 0; index < child_widget_hosts.size(); ++index) {
+ EXPECT_FALSE(child_widget_hosts[index]->is_hidden())
+ << "The RWH at distance " << index + 1U
+ << " from root RWH should not be hidden.";
+ }
std::string show_script =
"document.querySelector('iframe').style.visibility = 'visible';";
std::string hide_script =
"document.querySelector('iframe').style.visibility = 'hidden';";
- // Verify that hiding leads to a notification from RenderWidgetHost.
- RenderWidgetHostVisibilityObserver hide_observer(
- root->child_at(0)->current_frame_host()->GetRenderWidgetHost(), false);
- EXPECT_TRUE(ExecuteScript(shell(), hide_script));
- EXPECT_TRUE(hide_observer.WaitUntilSatisfied());
+ // Define observers for notifications about hiding child RenderWidgetHosts.
+ std::vector<std::unique_ptr<RenderWidgetHostVisibilityObserver>>
+ hide_widget_host_observers(child_widget_hosts.size());
+ for (size_t index = 0U; index < child_widget_hosts.size(); ++index) {
+ hide_widget_host_observers[index].reset(
+ new RenderWidgetHostVisibilityObserver(child_widget_hosts[index],
+ false));
+ }
- // Verify showing leads to a notification as well.
- RenderWidgetHostVisibilityObserver show_observer(
- root->child_at(0)->current_frame_host()->GetRenderWidgetHost(), true);
+ EXPECT_TRUE(ExecuteScript(shell(), hide_script));
+ for (size_t index = 0U; index < child_widget_hosts.size(); ++index) {
+ EXPECT_TRUE(hide_widget_host_observers[index]->WaitUntilSatisfied())
+ << "Expected RenderWidgetHost at distance " << index + 1U
+ << " from root RenderWidgetHost to become hidden.";
+ }
+
+ // Define observers for notifications about showing child RenderWidgetHosts.
+ std::vector<std::unique_ptr<RenderWidgetHostVisibilityObserver>>
+ show_widget_host_observers(child_widget_hosts.size());
+ for (size_t index = 0U; index < child_widget_hosts.size(); ++index) {
+ show_widget_host_observers[index].reset(
+ new RenderWidgetHostVisibilityObserver(child_widget_hosts[index],
+ true));
+ }
+
EXPECT_TRUE(ExecuteScript(shell(), show_script));
- EXPECT_TRUE(show_observer.WaitUntilSatisfied());
+ for (size_t index = 0U; index < child_widget_hosts.size(); ++index) {
+ EXPECT_TRUE(show_widget_host_observers[index]->WaitUntilSatisfied())
+ << "Expected RenderWidgetHost at distance " << index + 1U
+ << " from root RenderWidgetHost to become shown.";
+ }
}
// A class which counts the number of times a RenderWidgetHostViewChildFrame
diff --git a/content/browser/web_contents/web_contents_impl.cc b/content/browser/web_contents/web_contents_impl.cc
index 6de094e..76f98143 100644
--- a/content/browser/web_contents/web_contents_impl.cc
+++ b/content/browser/web_contents/web_contents_impl.cc
@@ -1498,13 +1498,16 @@
void WebContentsImpl::WasShown() {
controller_.SetActive(true);
- for (RenderWidgetHostView* view : GetRenderWidgetHostViewsInTree()) {
+ if (auto* view = GetRenderWidgetHostView()) {
view->Show();
#if defined(OS_MACOSX)
view->SetActive(true);
#endif
}
+ if (!ShowingInterstitialPage())
+ SetVisibilityForChildViews(true);
+
SendPageMessage(new PageMsg_WasShown(MSG_ROUTING_NONE));
last_active_time_ = base::TimeTicks::Now();
@@ -1525,9 +1528,12 @@
// removes the |GetRenderViewHost()|; then when we actually destroy the
// window, OnWindowPosChanged() notices and calls WasHidden() (which
// calls us).
- for (RenderWidgetHostView* view : GetRenderWidgetHostViewsInTree())
+ if (auto* view = GetRenderWidgetHostView())
view->Hide();
+ if (!ShowingInterstitialPage())
+ SetVisibilityForChildViews(true);
+
SendPageMessage(new PageMsg_WasHidden(MSG_ROUTING_NONE));
}
@@ -6018,4 +6024,8 @@
observer.MediaMutedStatusChanged(id, muted);
}
+void WebContentsImpl::SetVisibilityForChildViews(bool visible) {
+ GetMainFrame()->SetVisibilityForChildViews(visible);
+}
+
} // namespace content
diff --git a/content/browser/web_contents/web_contents_impl.h b/content/browser/web_contents/web_contents_impl.h
index 08c587d..afb4a704 100644
--- a/content/browser/web_contents/web_contents_impl.h
+++ b/content/browser/web_contents/web_contents_impl.h
@@ -1317,6 +1317,10 @@
static DownloadUrlParameters::RequestHeadersType ParseDownloadHeaders(
const std::string& headers);
+ // Sets the visibility of immediate child views, i.e. views whose parent view
+ // is that of the main frame.
+ void SetVisibilityForChildViews(bool visible);
+
// Data for core operation ---------------------------------------------------
// Delegate for notifying our owner about stuff. Not owned by us.
