Rename WebContentsImpl::GetFrameTree to GetPrimaryFrameTree
Note that the old method is already returning the PrimaryFrameTree so
this patch is just about making that explicit.
Trivial change that renames all test files leaving the production code
for a later patch. That code will need a closer look to make sure that
call sites are really expecting the primary frame tree (note they are
already getting the primary frame tree, so this is just an extra check
for peace of mind).
Keeping the old method around for a while will also prevent this massive
patch from being reverted if an optional try-bot later fails.
Bug: 1251094
Change-Id: Ibc86aedf203013e41e61ede94e6af929f80ee477
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3231330
Reviewed-by: Alexander Timin <[email protected]>
Reviewed-by: Sreeja Kamishetty <[email protected]>
Commit-Queue: Carlos Caballero <[email protected]>
Cr-Commit-Position: refs/heads/main@{#935359}
diff --git a/content/browser/renderer_host/frame_tree_unittest.cc b/content/browser/renderer_host/frame_tree_unittest.cc
index a58a57f..7e11cf9 100644
--- a/content/browser/renderer_host/frame_tree_unittest.cc
+++ b/content/browser/renderer_host/frame_tree_unittest.cc
@@ -118,9 +118,10 @@
log_.append("\n");
}
log_.append(event_name + " -> ");
- AppendTreeNodeState(
- static_cast<WebContentsImpl*>(web_contents())->GetFrameTree()->root(),
- &log_);
+ AppendTreeNodeState(static_cast<WebContentsImpl*>(web_contents())
+ ->GetPrimaryFrameTree()
+ .root(),
+ &log_);
}
void LogWhatHappened(const std::string& event_name, RenderFrameHost* rfh) {
@@ -136,17 +137,16 @@
class FrameTreeTest : public RenderViewHostImplTestHarness {
protected:
// Prints a FrameTree, for easy assertions of the tree hierarchy.
- std::string GetTreeState(FrameTree* frame_tree) {
+ std::string GetTreeState(FrameTree& frame_tree) {
std::string result;
- AppendTreeNodeState(frame_tree->root(), &result);
+ AppendTreeNodeState(frame_tree.root(), &result);
return result;
}
- std::string GetTraversalOrder(FrameTree* frame_tree,
+ std::string GetTraversalOrder(FrameTree& frame_tree,
FrameTreeNode* subtree_to_skip) {
std::string result;
- for (FrameTreeNode* node :
- frame_tree->NodesExceptSubtree(subtree_to_skip)) {
+ for (FrameTreeNode* node : frame_tree.NodesExceptSubtree(subtree_to_skip)) {
if (!result.empty())
result += " ";
result +=
@@ -166,12 +166,12 @@
// Use the FrameTree of the WebContents so that it has all the delegates it
// needs. We may want to consider a test version of this.
- FrameTree* frame_tree = contents()->GetFrameTree();
- FrameTreeNode* root = frame_tree->root();
+ FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
+ FrameTreeNode* root = frame_tree.root();
constexpr auto kOwnerType = blink::FrameOwnerElementType::kIframe;
int process_id = root->current_frame_host()->GetProcess()->GetID();
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id, 14, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -179,7 +179,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id, 15, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -187,7 +187,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id, 16, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -197,7 +197,7 @@
kOwnerType, false);
EXPECT_EQ(3U, root->child_count());
- FrameTree::NodeIterator node_iterator = frame_tree->Nodes().begin();
+ FrameTree::NodeIterator node_iterator = frame_tree.Nodes().begin();
// Before the iterator advances the frame node queue should be empty.
EXPECT_EQ(0U, GetIteratorSize(node_iterator));
@@ -219,8 +219,8 @@
// Use the FrameTree of the WebContents so that it has all the delegates it
// needs. We may want to consider a test version of this.
- FrameTree* frame_tree = contents()->GetFrameTree();
- FrameTreeNode* root = frame_tree->root();
+ FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
+ FrameTreeNode* root = frame_tree.root();
std::string no_children_node("no children node");
std::string deep_subtree("node with deep subtree");
@@ -234,7 +234,7 @@
constexpr auto kOwnerType = blink::FrameOwnerElementType::kIframe;
// Simulate attaching a series of frames to build the frame tree.
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id, 14, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -242,7 +242,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id, 15, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -250,7 +250,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id, 16, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -258,7 +258,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->child_at(0)->current_frame_host(), process_id, 244,
CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -266,7 +266,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->child_at(1)->current_frame_host(), process_id, 255,
CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -274,7 +274,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->child_at(0)->current_frame_host(), process_id, 245,
CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -290,7 +290,7 @@
GetTreeState(frame_tree));
FrameTreeNode* child_16 = root->child_at(2);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_16->current_frame_host(), process_id, 264, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -298,7 +298,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_16->current_frame_host(), process_id, 265, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -306,7 +306,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_16->current_frame_host(), process_id, 266, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -314,7 +314,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_16->current_frame_host(), process_id, 267, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -322,7 +322,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_16->current_frame_host(), process_id, 268, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -332,7 +332,7 @@
kOwnerType, false);
FrameTreeNode* child_267 = child_16->child_at(3);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_267->current_frame_host(), process_id, 365, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -340,7 +340,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_267->child_at(0)->current_frame_host(), process_id, 455,
CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -348,7 +348,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_267->child_at(0)->child_at(0)->current_frame_host(), process_id,
555, CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -356,7 +356,7 @@
false, blink::LocalFrameToken(), base::UnguessableToken::Create(),
blink::FramePolicy(), blink::mojom::FrameOwnerProperties(), false,
kOwnerType, false);
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
child_267->child_at(0)->child_at(0)->child_at(0)->current_frame_host(),
process_id, 655, CreateStubFrameRemote(),
CreateStubBrowserInterfaceBrokerReceiver(),
@@ -400,7 +400,7 @@
EXPECT_EQ("1 14 15 16 244 245 255 264 265 266 267 268 365 455 555 655",
GetTraversalOrder(frame_tree, child_655));
- frame_tree->RemoveFrame(child_555);
+ frame_tree.RemoveFrame(child_555);
EXPECT_EQ(
"1: [14: [244: [], 245: []], "
"15: [255 'no children node': []], "
@@ -409,7 +409,7 @@
"[365: [455: []]], 268: []]]",
GetTreeState(frame_tree));
- frame_tree->RemoveFrame(child_16->child_at(1));
+ frame_tree.RemoveFrame(child_16->child_at(1));
EXPECT_EQ(
"1: [14: [244: [], 245: []], "
"15: [255 'no children node': []], "
@@ -418,7 +418,7 @@
"[365: [455: []]], 268: []]]",
GetTreeState(frame_tree));
- frame_tree->RemoveFrame(root->child_at(1));
+ frame_tree.RemoveFrame(root->child_at(1));
EXPECT_EQ(
"1: [14: [244: [], 245: []], "
"16: [264: [], 266: [], "
@@ -432,8 +432,8 @@
main_test_rfh()->InitializeRenderFrameIfNeeded();
// Add a few child frames to the main frame.
- FrameTree* frame_tree = contents()->GetFrameTree();
- FrameTreeNode* root = frame_tree->root();
+ FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
+ FrameTreeNode* root = frame_tree.root();
constexpr auto kOwnerType = blink::FrameOwnerElementType::kIframe;
main_test_rfh()->OnCreateChildFrame(
@@ -468,29 +468,29 @@
FrameTreeNode* grandchild = child1->child_at(0);
// Ensure they can be found by FTN id.
- EXPECT_EQ(root, frame_tree->FindByID(root->frame_tree_node_id()));
- EXPECT_EQ(child0, frame_tree->FindByID(child0->frame_tree_node_id()));
- EXPECT_EQ(child1, frame_tree->FindByID(child1->frame_tree_node_id()));
- EXPECT_EQ(child2, frame_tree->FindByID(child2->frame_tree_node_id()));
- EXPECT_EQ(grandchild, frame_tree->FindByID(grandchild->frame_tree_node_id()));
- EXPECT_EQ(nullptr, frame_tree->FindByID(-1));
+ EXPECT_EQ(root, frame_tree.FindByID(root->frame_tree_node_id()));
+ EXPECT_EQ(child0, frame_tree.FindByID(child0->frame_tree_node_id()));
+ EXPECT_EQ(child1, frame_tree.FindByID(child1->frame_tree_node_id()));
+ EXPECT_EQ(child2, frame_tree.FindByID(child2->frame_tree_node_id()));
+ EXPECT_EQ(grandchild, frame_tree.FindByID(grandchild->frame_tree_node_id()));
+ EXPECT_EQ(nullptr, frame_tree.FindByID(-1));
// Ensure they can be found by routing id.
int process_id = main_test_rfh()->GetProcess()->GetID();
- EXPECT_EQ(root, frame_tree->FindByRoutingID(process_id,
- main_test_rfh()->GetRoutingID()));
- EXPECT_EQ(child0, frame_tree->FindByRoutingID(process_id, 22));
- EXPECT_EQ(child1, frame_tree->FindByRoutingID(process_id, 23));
- EXPECT_EQ(child2, frame_tree->FindByRoutingID(process_id, 24));
- EXPECT_EQ(grandchild, frame_tree->FindByRoutingID(process_id, 33));
- EXPECT_EQ(nullptr, frame_tree->FindByRoutingID(process_id, 37));
+ EXPECT_EQ(root, frame_tree.FindByRoutingID(process_id,
+ main_test_rfh()->GetRoutingID()));
+ EXPECT_EQ(child0, frame_tree.FindByRoutingID(process_id, 22));
+ EXPECT_EQ(child1, frame_tree.FindByRoutingID(process_id, 23));
+ EXPECT_EQ(child2, frame_tree.FindByRoutingID(process_id, 24));
+ EXPECT_EQ(grandchild, frame_tree.FindByRoutingID(process_id, 33));
+ EXPECT_EQ(nullptr, frame_tree.FindByRoutingID(process_id, 37));
// Ensure they can be found by name, if they have one.
- EXPECT_EQ(root, frame_tree->FindByName(std::string()));
- EXPECT_EQ(child0, frame_tree->FindByName("child0"));
- EXPECT_EQ(child1, frame_tree->FindByName("child1"));
- EXPECT_EQ(grandchild, frame_tree->FindByName("grandchild"));
- EXPECT_EQ(nullptr, frame_tree->FindByName("no such frame"));
+ EXPECT_EQ(root, frame_tree.FindByName(std::string()));
+ EXPECT_EQ(child0, frame_tree.FindByName("child0"));
+ EXPECT_EQ(child1, frame_tree.FindByName("child1"));
+ EXPECT_EQ(grandchild, frame_tree.FindByName("grandchild"));
+ EXPECT_EQ(nullptr, frame_tree.FindByName("no such frame"));
}
// Check that PreviousSibling() and NextSibling() are retrieved correctly.
@@ -499,8 +499,8 @@
constexpr auto kOwnerType = blink::FrameOwnerElementType::kIframe;
// Add a few child frames to the main frame.
- FrameTree* frame_tree = contents()->GetFrameTree();
- FrameTreeNode* root = frame_tree->root();
+ FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
+ FrameTreeNode* root = frame_tree.root();
main_test_rfh()->OnCreateChildFrame(
22, CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -554,8 +554,8 @@
contents()->NavigateAndCommit(GURL("http://www.google.com"));
EXPECT_EQ("RenderFrameCreated(1) -> 1: []", activity.GetLog());
- FrameTree* frame_tree = contents()->GetFrameTree();
- FrameTreeNode* root = frame_tree->root();
+ FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
+ FrameTreeNode* root = frame_tree.root();
constexpr auto kOwnerType = blink::FrameOwnerElementType::kIframe;
// Simulate attaching a series of frames to build the frame tree.
@@ -579,9 +579,9 @@
"RenderFrameCreated(18) -> 1: [14: [], 18: []]\n"
"RenderFrameHostChanged(new)(18) -> 1: [14: [], 18: []]",
activity.GetLog());
- frame_tree->RemoveFrame(root->child_at(0));
+ frame_tree.RemoveFrame(root->child_at(0));
EXPECT_EQ("RenderFrameDeleted(14) -> 1: [18: []]", activity.GetLog());
- frame_tree->RemoveFrame(root->child_at(0));
+ frame_tree.RemoveFrame(root->child_at(0));
EXPECT_EQ("RenderFrameDeleted(18) -> 1: []", activity.GetLog());
}
@@ -628,15 +628,15 @@
// is different than the process of the parent node.
TEST_F(FrameTreeTest, FailAddFrameWithWrongProcessId) {
contents()->NavigateAndCommit(GURL("http://www.google.com"));
- FrameTree* frame_tree = contents()->GetFrameTree();
- FrameTreeNode* root = frame_tree->root();
+ FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
+ FrameTreeNode* root = frame_tree.root();
int process_id = root->current_frame_host()->GetProcess()->GetID();
ASSERT_EQ("1: []", GetTreeState(frame_tree));
// Simulate attaching a frame from mismatched process id.
EXPECT_DEATH_IF_SUPPORTED(
- frame_tree->AddFrame(
+ frame_tree.AddFrame(
root->current_frame_host(), process_id + 1, 1,
CreateStubFrameRemote(), CreateStubBrowserInterfaceBrokerReceiver(),
CreateStubPolicyContainerBindParams(),
@@ -654,7 +654,7 @@
main_test_rfh()->InitializeRenderFrameIfNeeded();
// Add a couple child frames to the main frame.
- FrameTreeNode* root = contents()->GetFrameTree()->root();
+ FrameTreeNode* root = contents()->GetPrimaryFrameTree().root();
constexpr auto kOwnerType = blink::FrameOwnerElementType::kIframe;
main_test_rfh()->OnCreateChildFrame(
