OverscrollGlow for mainThread-{BLINK CHANGES}

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 134 matching lines @@
         EXPECT_EQ(expected.x(), actual.x()); \
         EXPECT_EQ(expected.y(), actual.y()); \
     } while (false)
 
 #define EXPECT_FLOAT_POINT_EQ(expected, actual) \
     do { \
         EXPECT_FLOAT_EQ(expected.x(), actual.x()); \
         EXPECT_FLOAT_EQ(expected.y(), actual.y()); \
     } while (false)
 
+#define EXPECT_WEB_FLOAT_SIZE_EQ(expected, actual) \
+    do { \
+        EXPECT_FLOAT_EQ(expected.width, actual.width); \
+        EXPECT_FLOAT_EQ(expected.height, actual.height); \
+    } while (false)
+
 class WebFrameTest : public ::testing::Test {
 protected:
     WebFrameTest()
         : m_baseURL("http://internal.test/")
         , m_notBaseURL("http://external.test/")
         , m_chromeURL("chrome://")
     {
     }
 
     virtual ~WebFrameTest()
@@ skipping 7265 matching lines @@
     EXPECT_EQ(fourthFrame, parent->lastChild());
 
     EXPECT_EQ(parent, firstFrame->parent());
     EXPECT_EQ(parent, secondFrame->parent());
     EXPECT_EQ(parent, thirdFrame->parent());
     EXPECT_EQ(parent, fourthFrame->parent());
 
     view->close();
 }
 
+class OverscrollWebViewClient : public FrameTestHelpers::TestWebViewClient {
+public:
+    virtual void didOverscroll(const WebFloatSize& unusedDelta, const WebFloatSize& accumulatedRootOverScroll, const WebFloatPoint& position, const WebFloatSize& velocity) override
+    {
+        m_unusedDelta = unusedDelta;
+        m_accumulatedRootOverScroll = accumulatedRootOverScroll;
+    }
+
+    WebFloatSize m_unusedDelta;
+    WebFloatSize m_accumulatedRootOverScroll;
+};
+
+class WebFrameOverscrollTest : public WebFrameTest {
+protected:
+    WebGestureEvent generateEvent(WebInputEvent::Type type, int deltaX = 0, int deltaY = 0)
+    {
+        WebGestureEvent event;
+        event.type = type;
+        event.x = 100;
+        event.y = 100;
+        if (type == WebInputEvent::GestureScrollUpdate) {
+            event.data.scrollUpdate.deltaX = deltaX;
+            event.data.scrollUpdate.deltaY = deltaY;
+        }
+        return event;
+    }
+
+    void ScrollBegin(FrameTestHelpers::WebViewHelper* webViewHelper)
+    {
+        webViewHelper->webViewImpl()->handleInputEvent(generateEvent(WebInputEvent::GestureScrollBegin));
+    }
+
+    void ScrollUpdate(FrameTestHelpers::WebViewHelper* webViewHelper, float deltaX, float deltaY)
+    {
+        webViewHelper->webViewImpl()->handleInputEvent(generateEvent(WebInputEvent::GestureScrollUpdate, deltaX, deltaY));
+    }
+
+    void ScrollEnd(FrameTestHelpers::WebViewHelper* webViewHelper)
+    {
+        webViewHelper->webViewImpl()->handleInputEvent(generateEvent(WebInputEvent::GestureScrollEnd));
+    }
+};
+
+TEST_F(WebFrameOverscrollTest, AccumulatedRootOverscrollAndUnsedDeltaValuesOnOverscroll)
+{
+    OverscrollWebViewClient client;
+    registerMockedHttpURLLoad("overscroll/overscroll.html");
+    FrameTestHelpers::WebViewHelper webViewHelper;
+    WebViewImpl* webViewImpl = webViewHelper.initializeAndLoad(m_baseURL + "overscroll/overscroll.html", true, 0, &client, configureAndroid);
+    webViewImpl->layout();

[bokan, 2015/06/04 14:45:44]

Nit: I don't think you need these layout calls.

[MuVen, 2015/06/04 17:58:56]

Done.

+
+    // Calculation of accumulatedRootOverscroll and unusedDelta on multiple scrollUpdate.
+    ScrollBegin(&webViewHelper);
+    ScrollUpdate(&webViewHelper, -308, -316);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);

[bokan, 2015/06/04 14:45:44]

Shouldn't these be non-0 now that the unusedDelta isn't reset in
resetOverscroll()? Is it because the test page actually has exactly 308, 316
amount of scrolling? In that case, add style:

body,html { padding: 0px; margin: 0px }

To the test files as appropriate so that it's easy to tell at a glance how much
scrolling there is on the page.

[MuVen, 2015/06/04 17:58:56]

Done.

+
+    ScrollUpdate(&webViewHelper, 0, -13);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 13), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 13), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, -20, -13);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 13), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 26), client.m_accumulatedRootOverScroll);
+
+    // Overscroll is not reported due to which OverscrollWebViewClient retains last
+    // UnusedDelta and AccumulatedRootOverscroll values.

[bokan, 2015/06/04 14:45:44]

We should use the GMock in these tests, it'll make the expectations more
explicit and easier to read IMO. See
https://code.google.com/p/googlemock/wiki/ForDummies for documentation. Don't
worry, it's actually surprisingly easy

In summary:

OverscrollWebViewClient's didOverscroll method should be replaced by

MOCK_METHOD4(didOverscroll, void(const WebFloatSize& unusedDelta, /*...etc*/));

And you can remove the members, GMock will keep track of the argument values.

Then, if your ScrollUpdate causes an overscroll of (1, 2), before the
ScrollUpdate call you'd add the expectation:

EXPECT_CALL(client, didOverscroll(1, 2))

Before the next ScrollUpdate you'll want to call
Mock::VerifyAndClearExpectations(&client) to check and clear that expectation,
otherwise in the next call it'll trigger that condition again, think it got
called twice, and fail.

To say "didOverscroll should not be called":

EXPECT_CALL(client, didOverscroll(_, _)).Times(0);

See PinchViewportTest for some examples.

[MuVen, 2015/06/04 17:58:56]

Done.

+    ScrollUpdate(&webViewHelper, 0, 1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 13), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 26), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 1, 0);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 13), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 26), client.m_accumulatedRootOverScroll);
+

[bokan, 2015/06/04 14:45:44]

I would add another overscroll here to make sure the accumulated value is
actually cleared.

[MuVen, 2015/06/04 17:58:56]

Done.

+    ScrollEnd(&webViewHelper);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 13), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(20, 26), client.m_accumulatedRootOverScroll);
+}
+
+TEST_F(WebFrameOverscrollTest, AccumulatedOverscrollAndUnusedDeltaValuesOnDifferentAxesOverscroll)
+{
+    OverscrollWebViewClient client;
+    registerMockedHttpURLLoad("overscroll/div-overscroll.html");
+    FrameTestHelpers::WebViewHelper webViewHelper;
+    WebViewImpl* webViewImpl = webViewHelper.initializeAndLoad(m_baseURL + "overscroll/div-overscroll.html", true, 0, &client, configureAndroid);
+    webViewImpl->layout();
+
+    ScrollBegin(&webViewHelper);
+
+    // Scroll the Div to the end.
+    ScrollUpdate(&webViewHelper, 0, -316);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    // Now On Scrolling DIV, scroll is bubbled and root layer is over-scrolled.
+    ScrollUpdate(&webViewHelper, 0, -50);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_accumulatedRootOverScroll);

[bokan, 2015/06/04 14:45:44]

This is tested in the below test. You should keep the test cases as specific as
possible so if the test fails, its easier to determine what's breaking. I'd
remove all the checks except the ones specific to checking that scrolling
between different axes works as expected (only test what's in the test name)

[MuVen, 2015/06/04 17:58:56]

Done.

+
+    // Overscroll is not reported, so client retains last UnusedDelta and AccumulatedRootOverscroll values.
+    ScrollUpdate(&webViewHelper, 0, 1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_accumulatedRootOverScroll);
+
+    // Overscroll is reported.
+    ScrollUpdate(&webViewHelper, 0, -2);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 1), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 1), client.m_accumulatedRootOverScroll);
+
+    // Now On Scrolling DIV, scroll is bubbled and root layer is over-scrolled.
+    ScrollUpdate(&webViewHelper, 0, -100);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 100), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 101), client.m_accumulatedRootOverScroll);
+
+    // Page scrolls vertically, but over-scrolls horizontally.
+    ScrollUpdate(&webViewHelper, 100, 50);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-100, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-100, 0), client.m_accumulatedRootOverScroll);
+
+    // Scrolling up, Overscroll is not reported, so client retains last UnusedDelta and AccumulatedRootOverscroll values.
+    ScrollUpdate(&webViewHelper, 0, -50);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-100, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-100, 0), client.m_accumulatedRootOverScroll);
+
+    // Page scrolls horizontally, but over-scrolls vertically.
+    ScrollUpdate(&webViewHelper, -100, -100);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 100), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 100), client.m_accumulatedRootOverScroll);
+}
+
+TEST_F(WebFrameOverscrollTest, RootLayerOverscrolledOnInnerDivOverScroll)
+{
+    OverscrollWebViewClient client;
+    registerMockedHttpURLLoad("overscroll/div-overscroll.html");
+    FrameTestHelpers::WebViewHelper webViewHelper;
+    WebViewImpl* webViewImpl = webViewHelper.initializeAndLoad(m_baseURL + "overscroll/div-overscroll.html", true, 0, &client, configureAndroid);
+    webViewImpl->layout();
+
+    ScrollBegin(&webViewHelper);
+
+    // Scroll the Div to the end.
+    ScrollUpdate(&webViewHelper, 0, -316);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    // Now On Scrolling DIV, scroll is bubbled and root layer is over-scrolled.
+    ScrollUpdate(&webViewHelper, 0, -50);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_accumulatedRootOverScroll);
+}
+
+TEST_F(WebFrameOverscrollTest, RootLayerOverscrolledOnInnerIFrameOverScroll)
+{
+    OverscrollWebViewClient client;
+    registerMockedHttpURLLoad("overscroll/iframe-overscroll.html");
+    registerMockedHttpURLLoad("overscroll/scrollable-iframe.html");
+    FrameTestHelpers::WebViewHelper webViewHelper;
+    WebViewImpl* webViewImpl = webViewHelper.initializeAndLoad(m_baseURL + "overscroll/iframe-overscroll.html", true, 0, &client, configureAndroid);
+    webViewImpl->layout();
+
+    ScrollBegin(&webViewHelper);
+
+    // Scroll the IFrame to the end.
+    ScrollUpdate(&webViewHelper, 0, -320);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    // Now On Scrolling IFrame, scroll is bubbled and root layer is over-scrolled.
+    ScrollUpdate(&webViewHelper, 0, -50);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 50), client.m_accumulatedRootOverScroll);
+}
+
+TEST_F(WebFrameOverscrollTest, NoOverscrollOnNonScrollableaxes)
+{
+    OverscrollWebViewClient client;
+    registerMockedHttpURLLoad("overscroll/no-overscroll-on-nonscrollable-axes.html");
+    FrameTestHelpers::WebViewHelper webViewHelper;
+    WebViewImpl* webViewImpl = webViewHelper.initializeAndLoad(m_baseURL + "overscroll/no-overscroll-on-nonscrollable-axes.html", true, 0, &client, configureAndroid);
+    webViewImpl->layout();
+
+    // Overscroll is not reported in all the directions.
+    ScrollBegin(&webViewHelper);
+    ScrollUpdate(&webViewHelper, 0, -1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 0, 1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 1, 0);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, -1, 0);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 1, 1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, -1, 1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 1, -1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, -1, -1);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+
+    ScrollEnd(&webViewHelper);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, 0), client.m_accumulatedRootOverScroll);
+}
+
+TEST_F(WebFrameOverscrollTest, ScaledPageRootLayerOverscrolled)

[bokan, 2015/06/04 14:45:43]

Awesome, thanks for testing under page scale :)

[MuVen, 2015/06/04 17:58:56]

Thanks to majidvp :)

+{
+    OverscrollWebViewClient client;
+    registerMockedHttpURLLoad("overscroll/overscroll.html");
+    FrameTestHelpers::WebViewHelper webViewHelper;
+    WebViewImpl* webViewImpl = webViewHelper.initializeAndLoad(m_baseURL + "overscroll/overscroll.html", true, 0, &client, configureAndroid);
+    webViewImpl->setPageScaleFactor(3.f);
+    webViewImpl->layout();
+
+    // Calculation of accumulatedRootOverscroll and unusedDelta on scaled page.
+    ScrollBegin(&webViewHelper);
+    ScrollUpdate(&webViewHelper, 0, 30);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, -10), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, -10), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 0, 30);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, -10), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(0, -20), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 30, 30);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-10, -10), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-10, -30), client.m_accumulatedRootOverScroll);
+
+    ScrollUpdate(&webViewHelper, 30, 0);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-10, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-20, -30), client.m_accumulatedRootOverScroll);
+
+    // Overscroll is not reported, so client retains last UnusedDelta and AccumulatedRootOverscroll values.
+    ScrollEnd(&webViewHelper);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-10, 0), client.m_unusedDelta);
+    EXPECT_WEB_FLOAT_SIZE_EQ(WebFloatSize(-20, -30), client.m_accumulatedRootOverScroll);
+}
+
 } // namespace blink