Always use the WebFrameWidget when attaching the root graphics

third_party/WebKit/Source/web/tests/WebFrameTest.cpp

 /*
  * Copyright (C) 2010 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 1587 matching lines @@
     WebView* view = WebView::create(&viewClient);
     view->settings()->setJavaScriptEnabled(true);
     view->setMainFrame(remoteClient.frame());
     WebRemoteFrame* root = view->mainFrame()->toWebRemoteFrame();
     root->setReplicatedOrigin(SecurityOrigin::createUnique());
 
     WebFrameOwnerProperties properties;
     properties.marginWidth = 11;
     properties.marginHeight = 22;
     WebLocalFrame* localFrame = FrameTestHelpers::createLocalChild(root, "frameName", nullptr, nullptr, properties);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, localFrame);

[dcheng, 2016/06/08 00:10:17]

I wonder if we can make this simpler for test code by storing the WebFrameWidget
on TestWebFrameClient? FrameTestHelpers::createLocalChild() can be responsible
for setting this up. Obviously we'll need something a bit different for the main
frame eventually, but that seems like it should make it easier for test code to
avoid duplicating so much boilerplate. WDYT?

[lfg, 2016/06/08 21:09:47]

I think that's doable, but there's one test that needs to override the client
(GestureEventTestWebWidgetClient). What do you think of having an optional
argument in createLocalChild for the client, with a default of nullptr which
would give you the default TestWebWidgetClient? We would also need to add code
to TestWebWidgetClient to destroy itself, since we won't be closing
widget->close(), but I think that can be done similarly to how RenderWidget
destroys itself.

[dcheng, 2016/06/09 04:43:51]

That seems reasonable to me.

 
     registerMockedHttpURLLoad("frame_owner_properties.html");
     FrameTestHelpers::loadFrame(localFrame, m_baseURL + "frame_owner_properties.html");
 
     // Check if the LocalFrame has seen the marginwidth and marginheight
     // properties.
     Document* childDocument = toWebLocalFrameImpl(localFrame)->frame()->document();
     EXPECT_EQ(11, childDocument->firstBodyElement()->getIntegralAttribute(HTMLNames::marginwidthAttr));
     EXPECT_EQ(22, childDocument->firstBodyElement()->getIntegralAttribute(HTMLNames::marginheightAttr));
 
     FrameView* frameView = toWebLocalFrameImpl(localFrame)->frameView();
     // Expect scrollbars to be enabled by default.
     EXPECT_NE(nullptr, frameView->horizontalScrollbar());
     EXPECT_NE(nullptr, frameView->verticalScrollbar());
 
+    widget->close();
     view->close();
 }
 
 TEST_F(WebFrameTest, FrameOwnerPropertiesScrolling)
 {
     FrameTestHelpers::TestWebViewClient viewClient;
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     WebView* view = WebView::create(&viewClient);
     view->settings()->setJavaScriptEnabled(true);
     view->setMainFrame(remoteClient.frame());
     WebRemoteFrame* root = view->mainFrame()->toWebRemoteFrame();
     root->setReplicatedOrigin(SecurityOrigin::createUnique());
 
     WebFrameOwnerProperties properties;
     // Turn off scrolling in the subframe.
     properties.scrollingMode = WebFrameOwnerProperties::ScrollingMode::AlwaysOff;
     WebLocalFrame* localFrame = FrameTestHelpers::createLocalChild(root, "frameName", nullptr, nullptr, properties);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, localFrame);
 
     registerMockedHttpURLLoad("frame_owner_properties.html");
     FrameTestHelpers::loadFrame(localFrame, m_baseURL + "frame_owner_properties.html");
 
     Document* childDocument = toWebLocalFrameImpl(localFrame)->frame()->document();
     EXPECT_EQ(0, childDocument->firstBodyElement()->getIntegralAttribute(HTMLNames::marginwidthAttr));
     EXPECT_EQ(0, childDocument->firstBodyElement()->getIntegralAttribute(HTMLNames::marginheightAttr));
 
     FrameView* frameView = static_cast<WebLocalFrameImpl*>(localFrame)->frameView();
     EXPECT_EQ(nullptr, frameView->horizontalScrollbar());
     EXPECT_EQ(nullptr, frameView->verticalScrollbar());
 
+    widget->close();
     view->close();
 }
 
 
 TEST_P(ParameterizedWebFrameTest, SetForceZeroLayoutHeightWorksAcrossNavigations)
 {
     registerMockedHttpURLLoad("200-by-300.html");
     registerMockedHttpURLLoad("large-div.html");
 
     FixedLayoutTestWebViewClient client;
@@ skipping 5466 matching lines @@
     FrameTestHelpers::WebViewHelper m_webViewHelper;
 };
 
 TEST_F(WebFrameSwapTest, SwapMainFrame)
 {
     WebRemoteFrame* remoteFrame = WebRemoteFrame::create(WebTreeScopeType::Document, nullptr);
     mainFrame()->swap(remoteFrame);
 
     FrameTestHelpers::TestWebFrameClient client;
     WebLocalFrame* localFrame = WebLocalFrame::createProvisional(&client, remoteFrame, WebSandboxFlags::None);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, localFrame);
     remoteFrame->swap(localFrame);
 
     // Finally, make sure an embedder triggered load in the local frame swapped
     // back in works.
     FrameTestHelpers::loadFrame(localFrame, m_baseURL + "subframe-hello.html");
 
     std::string content = WebFrameContentDumper::dumpWebViewAsText(webView(), 1024).utf8();
     EXPECT_EQ("hello", content);
 
+    widget->close();
+
     // Manually reset to break WebViewHelper's dependency on the stack allocated
     // TestWebFrameClient.
     reset();
     remoteFrame->close();
 }
 
 TEST_F(WebFrameSwapTest, ValidateSizeOnRemoteToLocalMainFrameSwap)
 {
     WebSize size(111, 222);
 
@@ skipping 335 matching lines @@
 TEST_F(WebFrameSwapTest, FramesOfRemoteParentAreIndexable)
 {
     v8::HandleScope scope(v8::Isolate::GetCurrent());
 
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     WebRemoteFrame* remoteParentFrame = remoteClient.frame();
     mainFrame()->swap(remoteParentFrame);
     remoteParentFrame->setReplicatedOrigin(SecurityOrigin::createUnique());
 
     WebLocalFrame* childFrame = FrameTestHelpers::createLocalChild(remoteParentFrame);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, childFrame);
     FrameTestHelpers::loadFrame(childFrame, m_baseURL + "subframe-hello.html");
 
     v8::Local<v8::Value> window = childFrame->executeScriptAndReturnValue(WebScriptSource("window"));
     v8::Local<v8::Value> childOfRemoteParent = childFrame->executeScriptAndReturnValue(WebScriptSource("parent.frames[0]"));
     EXPECT_TRUE(childOfRemoteParent->IsObject());
     EXPECT_TRUE(window->StrictEquals(childOfRemoteParent));
 
     v8::Local<v8::Value> windowLength = childFrame->executeScriptAndReturnValue(WebScriptSource("parent.frames.length"));
     ASSERT_TRUE(windowLength->IsInt32());
     EXPECT_EQ(1, windowLength.As<v8::Int32>()->Value());
 
+    widget->close();
+
     // Manually reset to break WebViewHelper's dependency on the stack allocated clients.
     reset();
 }
 
 // Check that frames with a remote parent don't crash while accessing window.frameElement.
 TEST_F(WebFrameSwapTest, FrameElementInFramesWithRemoteParent)
 {
     v8::HandleScope scope(v8::Isolate::GetCurrent());
 
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     WebRemoteFrame* remoteParentFrame = remoteClient.frame();
     mainFrame()->swap(remoteParentFrame);
     remoteParentFrame->setReplicatedOrigin(SecurityOrigin::createUnique());
 
     WebLocalFrame* childFrame = FrameTestHelpers::createLocalChild(remoteParentFrame);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, childFrame);
     FrameTestHelpers::loadFrame(childFrame, m_baseURL + "subframe-hello.html");
 
     v8::Local<v8::Value> frameElement = childFrame->executeScriptAndReturnValue(WebScriptSource("window.frameElement"));
     // frameElement should be null if cross-origin.
     ASSERT_FALSE(frameElement.IsEmpty());
     EXPECT_TRUE(frameElement->IsNull());
 
+    widget->close();
+
     // Manually reset to break WebViewHelper's dependency on the stack allocated clients.
     reset();
 }
 
 class RemoteToLocalSwapWebFrameClient : public FrameTestHelpers::TestWebFrameClient {
 public:
     explicit RemoteToLocalSwapWebFrameClient(WebRemoteFrame* remoteFrame)
         : m_historyCommitType(WebHistoryInertCommit)
         , m_remoteFrame(remoteFrame)
     {
@@ skipping 290 matching lines @@
 {
     FrameTestHelpers::TestWebViewClient viewClient;
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     WebView* view = WebView::create(&viewClient);
     view->setMainFrame(remoteClient.frame());
     remoteClient.frame()->setReplicatedOrigin(WebSecurityOrigin::createFromString(WebString::fromUTF8(m_baseURL)));
 
     // If an iframe has a remote main frame, ensure the inital commit is correctly identified as WebInitialCommitInChildFrame.
     CommitTypeWebFrameClient childFrameClient;
     WebLocalFrame* childFrame = FrameTestHelpers::createLocalChild(view->mainFrame()->toWebRemoteFrame(), "frameName", &childFrameClient);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, childFrame);
     registerMockedHttpURLLoad("foo.html");
     FrameTestHelpers::loadFrame(childFrame, m_baseURL + "foo.html");
     EXPECT_EQ(WebInitialCommitInChildFrame, childFrameClient.historyCommitType());
+    widget->close();
     view->close();
 }
 
-class GestureEventTestWebViewClient : public FrameTestHelpers::TestWebViewClient {
+class GestureEventTestWebWidgetClient : public FrameTestHelpers::TestWebWidgetClient {
 public:
-    GestureEventTestWebViewClient() : m_didHandleGestureEvent(false) { }
+    GestureEventTestWebWidgetClient() : m_didHandleGestureEvent(false) { }
     void didHandleGestureEvent(const WebGestureEvent& event, bool eventCancelled) override { m_didHandleGestureEvent = true; }
     bool didHandleGestureEvent() const { return m_didHandleGestureEvent; }
 
 private:
     bool m_didHandleGestureEvent;
 };
 
 TEST_P(ParameterizedWebFrameTest, FrameWidgetTest)
 {
     FrameTestHelpers::TestWebViewClient viewClient;
     WebView* view = WebView::create(&viewClient);
 
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     view->setMainFrame(remoteClient.frame());
 
     WebLocalFrame* childFrame = FrameTestHelpers::createLocalChild(view->mainFrame()->toWebRemoteFrame());
 
-    GestureEventTestWebViewClient childViewClient;
-    WebFrameWidget* widget = WebFrameWidget::create(childViewClient.widgetClient(), childFrame);
+    GestureEventTestWebWidgetClient childWidgetClient;
+    WebFrameWidget* widget = WebFrameWidget::create(&childWidgetClient, childFrame);
 
     view->resize(WebSize(1000, 1000));
 
     widget->handleInputEvent(fatTap(20, 20));
-    EXPECT_TRUE(childViewClient.didHandleGestureEvent());
+    EXPECT_TRUE(childWidgetClient.didHandleGestureEvent());
 
     widget->close();
     view->close();
 }
 
 class MockDocumentThreadableLoaderClient : public DocumentThreadableLoaderClient {
 public:
     MockDocumentThreadableLoaderClient() : m_failed(false) { }
     void didFail(const ResourceError&) override { m_failed = true;}
 
@@ skipping 203 matching lines @@
 {
     FrameTestHelpers::TestWebViewClient viewClient;
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     WebView* view = WebView::create(&viewClient);
     view->settings()->setJavaScriptEnabled(true);
     view->setMainFrame(remoteClient.frame());
     WebRemoteFrame* root = view->mainFrame()->toWebRemoteFrame();
     root->setReplicatedOrigin(SecurityOrigin::createUnique());
 
     WebLocalFrame* localFrame = FrameTestHelpers::createLocalChild(root);
+    FrameTestHelpers::TestWebWidgetClient widgetClient;
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, localFrame);
 
     // Finally, make sure an embedder triggered load in the local frame swapped
     // back in works.
     registerMockedHttpURLLoad("send_beacon.html");
     registerMockedHttpURLLoad("reload_post.html"); // url param to sendBeacon()
     FrameTestHelpers::loadFrame(localFrame, m_baseURL + "send_beacon.html");
 
+    widget->close();
     view->close();
 }
 
 // See https://crbug.com/525285.
 TEST_P(ParameterizedWebFrameTest, RemoteToLocalSwapOnMainFrameInitializesCoreFrame)
 {
     FrameTestHelpers::TestWebViewClient viewClient;
     FrameTestHelpers::TestWebRemoteFrameClient remoteClient;
     WebView* view = WebView::create(&viewClient);
     view->setMainFrame(remoteClient.frame());
     WebRemoteFrame* remoteRoot = view->mainFrame()->toWebRemoteFrame();
     remoteRoot->setReplicatedOrigin(SecurityOrigin::createUnique());
 
     FrameTestHelpers::createLocalChild(remoteRoot);
 
     // Do a remote-to-local swap of the top frame.
     FrameTestHelpers::TestWebFrameClient localClient;
     WebLocalFrame* localRoot = WebLocalFrame::createProvisional(&localClient, remoteRoot, WebSandboxFlags::None);
+    FrameTestHelpers::TestWebViewWidgetClient widgetClient(&viewClient);
+    WebWidget* widget = WebFrameWidget::create(&widgetClient, view, localRoot);
     remoteRoot->swap(localRoot);
 
     // Load a page with a child frame in the new root to make sure this doesn't
     // crash when the child frame invokes setCoreFrame.
     registerMockedHttpURLLoad("single_iframe.html");
     registerMockedHttpURLLoad("visible_iframe.html");
     FrameTestHelpers::loadFrame(localRoot, m_baseURL + "single_iframe.html");
 
+    widget->close();
     view->close();
 }
 
 class OverscrollWebViewClient : public FrameTestHelpers::TestWebViewClient {
 public:
     MOCK_METHOD4(didOverscroll, void(const WebFloatSize&, const WebFloatSize&, const WebFloatPoint&, const WebFloatSize&));
 };
 
 class WebFrameOverscrollTest : public WebFrameTest, public ::testing::WithParamInterface<blink::WebGestureDevice> {
 protected:
@@ skipping 540 matching lines @@
     WebLocalFrame* mainFrame = helper.webView()->mainFrame()->toWebLocalFrame();
     v8::HandleScope scope(v8::Isolate::GetCurrent());
     mainFrame->executeScript(WebScriptSource("hello = 'world';"));
     FrameTestHelpers::loadFrame(mainFrame, "data:text/html,new page");
     v8::Local<v8::Value> result = mainFrame->executeScriptAndReturnValue(WebScriptSource("hello"));
     ASSERT_TRUE(result->IsString());
     EXPECT_EQ("world", toCoreString(result->ToString(mainFrame->mainWorldScriptContext()).ToLocalChecked()));
 }
 
 } // namespace blink