Make document.rootScroller work properly across iframes.

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

 // Copyright 2016 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 "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/TopControls.h"
 #include "core/html/HTMLFrameOwnerElement.h"
 #include "core/page/Page.h"
 #include "core/page/scrolling/RootScrollerController.h"
+#include "core/paint/PaintLayerScrollableArea.h"
 #include "platform/testing/URLTestHelpers.h"
 #include "platform/testing/UnitTestHelpers.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebURLLoaderMockFactory.h"
 #include "public/web/WebCache.h"
 #include "public/web/WebConsoleMessage.h"
 #include "public/web/WebScriptSource.h"
 #include "public/web/WebSettings.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "web/WebLocalFrameImpl.h"
@@ skipping 173 matching lines @@
 
     // Content is 1000x1000, WebView size is 400x400 so max scroll is 600px.
     double maximumScroll = 600;
 
     webViewImpl()->handleInputEvent(
         generateEvent(WebInputEvent::GestureScrollBegin));
 
     {
         // Scrolling over the #container DIV should cause the top controls to
         // hide.
-        ASSERT_FLOAT_EQ(1, topControls().shownRatio());
+        EXPECT_FLOAT_EQ(1, topControls().shownRatio());
         webViewImpl()->handleInputEvent(generateEvent(
             WebInputEvent::GestureScrollUpdate, 0, -topControls().height()));
-        ASSERT_FLOAT_EQ(0, topControls().shownRatio());
+        EXPECT_FLOAT_EQ(0, topControls().shownRatio());
     }
 
     {
         // Make sure we're actually scrolling the DIV and not the FrameView.
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollUpdate, 0, -100));
-        ASSERT_FLOAT_EQ(100, container->scrollTop());
-        ASSERT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
+        EXPECT_FLOAT_EQ(100, container->scrollTop());
+        EXPECT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
     }
 
     {
         // Scroll 50 pixels past the end. Ensure we report the 50 pixels as
         // overscroll.
         EXPECT_CALL(m_client,
             didOverscroll(
                 WebFloatSize(0, 50),
                 WebFloatSize(0, 50),
                 WebFloatPoint(100, 100),
                 WebFloatSize()));
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollUpdate, 0, -550));
-        ASSERT_FLOAT_EQ(maximumScroll, container->scrollTop());
-        ASSERT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
+        EXPECT_FLOAT_EQ(maximumScroll, container->scrollTop());
+        EXPECT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
         Mock::VerifyAndClearExpectations(&m_client);
     }
 
     {
         // Continue the gesture overscroll.
         EXPECT_CALL(m_client,
             didOverscroll(
                 WebFloatSize(0, 20),
                 WebFloatSize(0, 70),
                 WebFloatPoint(100, 100),
                 WebFloatSize()));
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollUpdate, 0, -20));
-        ASSERT_FLOAT_EQ(maximumScroll, container->scrollTop());
-        ASSERT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
+        EXPECT_FLOAT_EQ(maximumScroll, container->scrollTop());
+        EXPECT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
         Mock::VerifyAndClearExpectations(&m_client);
     }
 
     webViewImpl()->handleInputEvent(
         generateEvent(WebInputEvent::GestureScrollEnd));
 
     {
         // Make sure a new gesture scroll still won't scroll the frameview and
         // overscrolls.
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollBegin));
 
         EXPECT_CALL(m_client,
             didOverscroll(
                 WebFloatSize(0, 30),
                 WebFloatSize(0, 30),
                 WebFloatPoint(100, 100),
                 WebFloatSize()));
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollUpdate, 0, -30));
-        ASSERT_FLOAT_EQ(maximumScroll, container->scrollTop());
-        ASSERT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
+        EXPECT_FLOAT_EQ(maximumScroll, container->scrollTop());
+        EXPECT_FLOAT_EQ(0, mainFrameView()->scrollPositionDouble().y());
         Mock::VerifyAndClearExpectations(&m_client);
 
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollEnd));
     }
 
     {
         // Scrolling up should show the top controls.
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollBegin));
 
-        ASSERT_FLOAT_EQ(0, topControls().shownRatio());
+        EXPECT_FLOAT_EQ(0, topControls().shownRatio());
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollUpdate, 0, 30));
-        ASSERT_FLOAT_EQ(0.6, topControls().shownRatio());
+        EXPECT_FLOAT_EQ(0.6, topControls().shownRatio());
 
         webViewImpl()->handleInputEvent(
             generateEvent(WebInputEvent::GestureScrollEnd));
     }
 }
 
 // Tests that removing the element that is the root scroller from the DOM tree
 // doesn't remove it as the root scroller but it does change the effective root
 // scroller.
 TEST_F(RootScrollerTest, TestRemoveRootScrollerFromDom)
 {
     initialize("root-scroller.html");
 
     ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
 
     Element* container = mainFrame()->document()->getElementById("container");
     TrackExceptionState exceptionState;
     mainFrame()->document()->setRootScroller(container, exceptionState);
 
-    ASSERT_EQ(container, mainFrame()->document()->rootScroller());
-    ASSERT_EQ(container, effectiveRootScroller(mainFrame()->document()));
+    EXPECT_EQ(container, mainFrame()->document()->rootScroller());
+    EXPECT_EQ(container, effectiveRootScroller(mainFrame()->document()));
 
     mainFrame()->document()->body()->removeChild(container);
     mainFrameView()->updateAllLifecyclePhases();
 
-    ASSERT_EQ(container, mainFrame()->document()->rootScroller());
-    ASSERT_NE(container, effectiveRootScroller(mainFrame()->document()));
+    EXPECT_EQ(container, mainFrame()->document()->rootScroller());
+    EXPECT_NE(container, effectiveRootScroller(mainFrame()->document()));
 }
 
 // Tests that setting an element that isn't a valid scroller as the root
 // scroller doesn't change the effective root scroller.
 TEST_F(RootScrollerTest, TestSetRootScrollerOnInvalidElement)
 {
     initialize("root-scroller.html");
 
     {
         // Set to a non-block element. Should be rejected and a console message
         // logged.
         Element* element = mainFrame()->document()->getElementById("nonBlock");
         TrackExceptionState exceptionState;
         mainFrame()->document()->setRootScroller(element, exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
-        ASSERT_EQ(element, mainFrame()->document()->rootScroller());
-        ASSERT_NE(element, effectiveRootScroller(mainFrame()->document()));
+        EXPECT_EQ(element, mainFrame()->document()->rootScroller());
+        EXPECT_NE(element, effectiveRootScroller(mainFrame()->document()));
     }
 
     {
         // Set to an element with no size.
         Element* element = mainFrame()->document()->getElementById("empty");
         TrackExceptionState exceptionState;
         mainFrame()->document()->setRootScroller(element, exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
-        ASSERT_EQ(element, mainFrame()->document()->rootScroller());
-        ASSERT_NE(element, effectiveRootScroller(mainFrame()->document()));
+        EXPECT_EQ(element, mainFrame()->document()->rootScroller());
+        EXPECT_NE(element, effectiveRootScroller(mainFrame()->document()));
     }
 }
 
 // Test that the effective root scroller resets to the default element when the
 // current root scroller element becomes invalid as a scroller.
 TEST_F(RootScrollerTest, TestRootScrollerBecomesInvalid)
 {
     initialize("root-scroller.html");
 
     Element* htmlElement = mainFrame()->document()->documentElement();
     Element* container = mainFrame()->document()->getElementById("container");
     TrackExceptionState exceptionState;
 
     ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
     ASSERT_EQ(htmlElement, effectiveRootScroller(mainFrame()->document()));
 
     {
         mainFrame()->document()->setRootScroller(container, exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(container, mainFrame()->document()->rootScroller());
-        ASSERT_EQ(container, effectiveRootScroller(mainFrame()->document()));
+        EXPECT_EQ(container, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(container, effectiveRootScroller(mainFrame()->document()));
 
         executeScript(
             "document.querySelector('#container').style.display = 'inline'");
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(container, mainFrame()->document()->rootScroller());
-        ASSERT_EQ(htmlElement,
+        EXPECT_EQ(container, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(htmlElement,
             effectiveRootScroller(mainFrame()->document()));
     }
 
     executeScript(
         "document.querySelector('#container').style.display = 'block'");
     mainFrame()->document()->setRootScroller(nullptr, exceptionState);
     mainFrameView()->updateAllLifecyclePhases();
-    ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
-    ASSERT_EQ(htmlElement, effectiveRootScroller(mainFrame()->document()));
+    EXPECT_EQ(nullptr, mainFrame()->document()->rootScroller());
+    EXPECT_EQ(htmlElement, effectiveRootScroller(mainFrame()->document()));
 
     {
         mainFrame()->document()->setRootScroller(container, exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(container, mainFrame()->document()->rootScroller());
-        ASSERT_EQ(container, effectiveRootScroller(mainFrame()->document()));
+        EXPECT_EQ(container, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(container, effectiveRootScroller(mainFrame()->document()));
 
         executeScript(
             "document.querySelector('#container').style.width = '98%'");
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(container, mainFrame()->document()->rootScroller());
-        ASSERT_EQ(htmlElement,
+        EXPECT_EQ(container, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(htmlElement,
             effectiveRootScroller(mainFrame()->document()));
     }
 }
 
 // Tests that setting the root scroller of the top document to an element that
 // belongs to a nested document works.
 TEST_F(RootScrollerTest, TestSetRootScrollerOnElementInIframe)
 {
     initialize("root-scroller-iframe.html");
 
     ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
 
     {
         // Trying to set an element from a nested document should fail.
         HTMLFrameOwnerElement* iframe = toHTMLFrameOwnerElement(
             mainFrame()->document()->getElementById("iframe"));
         Element* innerContainer =
             iframe->contentDocument()->getElementById("container");
 
         TrackExceptionState exceptionState;
         mainFrame()->document()->setRootScroller(
             innerContainer,
             exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(innerContainer, mainFrame()->document()->rootScroller());
-        ASSERT_EQ(innerContainer,
+        EXPECT_EQ(innerContainer, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(innerContainer,
             effectiveRootScroller(mainFrame()->document()));
     }
 
     {
         // Setting the iframe itself should also work.
         HTMLFrameOwnerElement* iframe = toHTMLFrameOwnerElement(
             mainFrame()->document()->getElementById("iframe"));
 
         TrackExceptionState exceptionState;
         mainFrame()->document()->setRootScroller(iframe, exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(iframe, mainFrame()->document()->rootScroller());
-        ASSERT_EQ(iframe, effectiveRootScroller(mainFrame()->document()));
+        EXPECT_EQ(iframe, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(iframe, effectiveRootScroller(mainFrame()->document()));
     }
 }
 
 // Tests that setting a valid element as the root scroller on a document within
 // an iframe works as expected.
 TEST_F(RootScrollerTest, TestRootScrollerWithinIframe)
 {
     initialize("root-scroller-iframe.html");
 
     ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
 
     {
         HTMLFrameOwnerElement* iframe = toHTMLFrameOwnerElement(
             mainFrame()->document()->getElementById("iframe"));
 
-        ASSERT_EQ(iframe->contentDocument()->documentElement(),
+        EXPECT_EQ(iframe->contentDocument()->documentElement(),
             effectiveRootScroller(iframe->contentDocument()));
 
         Element* innerContainer =
             iframe->contentDocument()->getElementById("container");
         TrackExceptionState exceptionState;
         iframe->contentDocument()->setRootScroller(
             innerContainer,
             exceptionState);
         mainFrameView()->updateAllLifecyclePhases();
 
-        ASSERT_EQ(innerContainer, iframe->contentDocument()->rootScroller());
-        ASSERT_EQ(innerContainer,
+        EXPECT_EQ(innerContainer, iframe->contentDocument()->rootScroller());
+        EXPECT_EQ(innerContainer,
             effectiveRootScroller(iframe->contentDocument()));
     }
 }
 
+// Tests that setting an iframe as the root scroller makes the iframe the
+// effective root scroller in the parent frame.
+TEST_F(RootScrollerTest, SetRootScrollerIframeBecomesEffective)
+{
+    initialize("root-scroller-iframe.html");
+    ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
+
+    {
+        NonThrowableExceptionState nonThrow;
+
+        // Try to set the root scroller in the main frame to be the iframe
+        // element.
+        HTMLFrameOwnerElement* iframe = toHTMLFrameOwnerElement(
+            mainFrame()->document()->getElementById("iframe"));
+
+        mainFrame()->document()->setRootScroller(iframe, nonThrow);
+
+        EXPECT_EQ(iframe, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(iframe,
+            mainFrame()->document()->rootScrollerController()
+                ->effectiveRootScroller());
+
+        Element* container =
+            iframe->contentDocument()->getElementById("container");
+
+        iframe->contentDocument()->setRootScroller(container, nonThrow);
+
+        EXPECT_EQ(container, iframe->contentDocument()->rootScroller());
+        EXPECT_EQ(container,
+            iframe->contentDocument()->rootScrollerController()
+                ->effectiveRootScroller());
+        EXPECT_EQ(iframe, mainFrame()->document()->rootScroller());
+        EXPECT_EQ(iframe,
+            mainFrame()->document()->rootScrollerController()
+                ->effectiveRootScroller());
+    }
+}
+
+// Tests that the global root scroller is correctly calculated when getting the
+// root scroller layer and that the viewport apply scroll is set on it.
+TEST_F(RootScrollerTest, SetRootScrollerIframeUsesCorrectLayerAndCallback)
+{
+    initialize("root-scroller-iframe.html");
+    ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
+
+    HTMLFrameOwnerElement* iframe = toHTMLFrameOwnerElement(
+        mainFrame()->document()->getElementById("iframe"));
+    Element* container =
+        iframe->contentDocument()->getElementById("container");
+
+    RootScrollerController* mainController =
+        mainFrame()->document()->rootScrollerController();
+
+    NonThrowableExceptionState nonThrow;
+
+    // No root scroller set, the documentElement should be the effective root
+    // and the main FrameView's scroll layer should be the layer to use.
+    {
+        EXPECT_EQ(
+            mainController->rootScrollerLayer(),
+            mainFrameView()->layerForScrolling());
+        EXPECT_TRUE(mainController->isViewportScrollCallback(
+            mainFrame()->document()->documentElement()->getApplyScroll()));
+    }
+
+    // Set a root scroller in the iframe. Since the main document didn't set a
+    // root scroller, the global root scroller shouldn't change.
+    {
+
+        iframe->contentDocument()->setRootScroller(container, nonThrow);
+
+        EXPECT_EQ(
+            mainController->rootScrollerLayer(),
+            mainFrameView()->layerForScrolling());
+        EXPECT_TRUE(mainController->isViewportScrollCallback(
+            mainFrame()->document()->documentElement()->getApplyScroll()));
+    }
+
+    // Setting the iframe as the root scroller in the main frame should now
+    // link the root scrollers so the container should now be the global root
+    // scroller.
+    {
+        mainFrame()->document()->setRootScroller(iframe, nonThrow);
+
+        ScrollableArea* containerScroller =
+            static_cast<PaintInvalidationCapableScrollableArea*>(
+                toLayoutBox(container->layoutObject())->getScrollableArea());
+
+        EXPECT_EQ(
+            mainController->rootScrollerLayer(),
+            containerScroller->layerForScrolling());
+        EXPECT_FALSE(mainController->isViewportScrollCallback(
+            mainFrame()->document()->documentElement()->getApplyScroll()));
+        EXPECT_TRUE(mainController->isViewportScrollCallback(
+            container->getApplyScroll()));
+    }
+
+    // Unsetting the root scroller in the iframe should reset its effective
+    // root scroller to the iframe's documentElement and thus the iframe's
+    // documentElement becomes the global root scroller.
+    {
+        iframe->contentDocument()->setRootScroller(nullptr, nonThrow);
+        EXPECT_EQ(
+            mainController->rootScrollerLayer(),
+            iframe->contentDocument()->view()->layerForScrolling());
+        EXPECT_FALSE(mainController->isViewportScrollCallback(
+            container->getApplyScroll()));
+        EXPECT_FALSE(mainController->isViewportScrollCallback(
+            mainFrame()->document()->documentElement()->getApplyScroll()));
+        EXPECT_TRUE(mainController->isViewportScrollCallback(
+            iframe->contentDocument()->documentElement()->getApplyScroll()));
+    }
+
+    // Finally, unsetting the main frame's root scroller should reset it to the
+    // documentElement and corresponding layer.
+    {
+        mainFrame()->document()->setRootScroller(nullptr, nonThrow);
+        EXPECT_EQ(
+            mainController->rootScrollerLayer(),
+            mainFrameView()->layerForScrolling());
+        EXPECT_TRUE(mainController->isViewportScrollCallback(
+            mainFrame()->document()->documentElement()->getApplyScroll()));
+        EXPECT_FALSE(mainController->isViewportScrollCallback(
+            container->getApplyScroll()));
+        EXPECT_FALSE(mainController->isViewportScrollCallback(
+            iframe->contentDocument()->documentElement()->getApplyScroll()));
+    }
+}
+
+TEST_F(RootScrollerTest, TestSetRootScrollerCausesViewportLayerChange)
+{
+    // TODO(bokan): Need a test that changing root scrollers actually sets the
+    // outer viewport layer on the compositor, even in the absence of other
+    // compositing changes. crbug.com/505516
+}
+
+
 // Tests that trying to set an element as the root scroller of a document inside
 // an iframe fails when that element belongs to the parent document.
 // TODO(bokan): Recent changes mean this is now possible but should be fixed.
 TEST_F(RootScrollerTest, DISABLED_TestSetRootScrollerOnElementFromOutsideIframe)
 {
     initialize("root-scroller-iframe.html");
 
     ASSERT_EQ(nullptr, mainFrame()->document()->rootScroller());
     {
         // Try to set the the root scroller of the child document to be the
         // <iframe> element in the parent document.
         HTMLFrameOwnerElement* iframe = toHTMLFrameOwnerElement(
             mainFrame()->document()->getElementById("iframe"));
         NonThrowableExceptionState nonThrow;
         Element* body =
             mainFrame()->document()->querySelector("body", nonThrow);
 
-        ASSERT_EQ(nullptr, iframe->contentDocument()->rootScroller());
+        EXPECT_EQ(nullptr, iframe->contentDocument()->rootScroller());
 
         TrackExceptionState exceptionState;
         iframe->contentDocument()->setRootScroller(
             iframe,
             exceptionState);
 
-        ASSERT_EQ(iframe, iframe->contentDocument()->rootScroller());
+        EXPECT_EQ(iframe, iframe->contentDocument()->rootScroller());
 
         // Try to set the root scroller of the child document to be the
         // <body> element of the parent document.
         iframe->contentDocument()->setRootScroller(
             body,
             exceptionState);
 
-        ASSERT_EQ(body, iframe->contentDocument()->rootScroller());
+        EXPECT_EQ(body, iframe->contentDocument()->rootScroller());
     }
 }
 
 } // namespace
 
 } // namespace blink