Initial touch-action main thread implementation

Source/web/tests/TouchActionTest.cpp

+/*
+ * Copyright (C) 2013 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
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+
+#include "FrameTestHelpers.h"
+#include "RuntimeEnabledFeatures.h"
+#include "URLTestHelpers.h"
+#include "WebDocument.h"
+#include "WebFrame.h"
+#include "WebInputEvent.h"
+#include "WebView.h"
+#include "WebViewClient.h"
+#include "WebViewImpl.h"
+#include "core/dom/ClientRect.h"
+#include "core/dom/ClientRectList.h"
+#include "core/dom/Document.h"
+#include "core/dom/Element.h"
+#include "core/dom/shadow/ShadowRoot.h"
+#include "core/frame/Frame.h"
+#include "core/frame/FrameView.h"
+#include "core/page/EventHandler.h"
+#include "core/rendering/HitTestResult.h"
+#include "core/rendering/RenderTreeAsText.h"
+#include "public/platform/Platform.h"
+#include "public/platform/WebUnitTestSupport.h"
+#include "public/web/WebHitTestResult.h"
+#include "public/web/WebTouchAction.h"
+#include "public/web/WebWidgetClient.h"
+
+#include <gtest/gtest.h>
+
+using namespace blink;
+using blink::FrameTestHelpers::runPendingTasks;
+
+namespace {
+
+class TouchActionTrackingWebViewClient : public WebViewClient {
+public:
+    TouchActionTrackingWebViewClient() :
+        m_actionSetCount(0),
+        m_action(WebTouchActionAuto)
+    {
+    }
+
+    // WebWidgetClient methods
+    virtual void setTouchAction(WebTouchAction touchAction)
+    {
+        m_actionSetCount++;
+        m_action = touchAction;
+    }
+
+    // Local methods
+    void reset()
+    {
+        m_actionSetCount = 0;
+        m_action = WebTouchActionAuto;
+    }
+
+    int touchActionSetCount()
+    {
+        return m_actionSetCount;
+    }
+
+    WebTouchAction lastTouchAction()
+    {
+        return m_action;
+    }
+
+private:
+    int m_actionSetCount;
+    WebTouchAction m_action;
+};
+
+const int kfakeTouchId = 7;
+
+class TouchActionTest : public testing::Test {
+public:
+    TouchActionTest()
+        : m_baseURL("http://www.test.com/")
+    {
+        URLTestHelpers::registerMockedURLFromBaseURL(WebString::fromUTF8(m_baseURL), "touch-action-tests.css");
+        URLTestHelpers::registerMockedURLFromBaseURL(WebString::fromUTF8(m_baseURL), "touch-action-tests.js");
+        WebCore::RuntimeEnabledFeatures::setCSSTouchActionEnabled(true);
+    }
+
+    virtual void TearDown()
+    {
+        Platform::current()->unitTestSupport()->unregisterAllMockedURLs();
+    }
+
+protected:
+    void runTouchActionTest(std::string file);
+    void runShadowDOMTest(std::string file);
+    void sendTouchEvent(WebView*, WebInputEvent::Type, WebCore::IntPoint clientPoint);
+    WebView* setupTest(std::string file, TouchActionTrackingWebViewClient&);
+    void runTestOnTree(WebCore::Node* root, WebView*, TouchActionTrackingWebViewClient&);
+
+    std::string m_baseURL;
+    FrameTestHelpers::WebViewHelper m_webViewHelper;
+};
+
+void TouchActionTest::runTouchActionTest(std::string file)
+{
+    TouchActionTrackingWebViewClient client;
+
+    WebView* webView = setupTest(file, client);
+
+    RefPtr<WebCore::Document> document = static_cast<PassRefPtr<WebCore::Document> >(webView->mainFrame()->document());
+    runTestOnTree(document.get(), webView, client);
+}
+
+void TouchActionTest::runShadowDOMTest(std::string file)
+{
+    TouchActionTrackingWebViewClient client;
+
+    WebView* webView = setupTest(file, client);
+
+    WebCore::TrackExceptionState es;
+    RefPtr<WebCore::Document> document = static_cast<PassRefPtr<WebCore::Document> >(webView->mainFrame()->document());
+    RefPtr<WebCore::NodeList> hostNodes = document->querySelectorAll("[shadow-host]", es);
+    ASSERT_FALSE(es.hadException());
+    ASSERT_GE(hostNodes->length(), 1u);
+
+    for (unsigned index = 0; index < hostNodes->length(); index++) {
+        WebCore::ShadowRoot* shadowRoot = WebCore::toElement(hostNodes->item(index))->shadowRoot();
+        runTestOnTree(shadowRoot, webView, client);
+    }
+
+    // Projections show up in the main document.
+    runTestOnTree(document.get(), webView, client);
+}
+
+WebView* TouchActionTest::setupTest(std::string file, TouchActionTrackingWebViewClient& client)
+{
+    URLTestHelpers::registerMockedURLFromBaseURL(WebString::fromUTF8(m_baseURL), WebString::fromUTF8(file));
+    // Note that JavaScript must be enabled for shadow DOM tests.
+    WebView* webView = m_webViewHelper.initializeAndLoad(m_baseURL + file, true, 0, &client);
+
+    // Set size to enable hit testing, and avoid line wrapping for consistency with browser.
+    webView->resize(WebSize(700, 1000));
+
+    // Scroll to verify the code properly transforms windows to client co-ords.
+    const int kScrollOffset = 100;
+    RefPtr<WebCore::Document> document = static_cast<PassRefPtr<WebCore::Document> >(webView->mainFrame()->document());
+    document->frame()->view()->setScrollOffset(WebCore::IntPoint(0, kScrollOffset));
+
+    return webView;
+}
+
+void TouchActionTest::runTestOnTree(WebCore::Node* root, WebView* webView, TouchActionTrackingWebViewClient& client)
+{
+    // Find all elements to test the touch-action of in the document.
+    WebCore::TrackExceptionState es;
+    RefPtr<WebCore::NodeList> nodes = root->querySelectorAll("[expected-action]", es);
+    ASSERT_FALSE(es.hadException());
+
+    for (unsigned index = 0; index < nodes->length(); index++) {
+        WebCore::Element* element = toElement(nodes->item(index));
+        element->scrollIntoViewIfNeeded();
+        ASSERT_TRUE(nodes->item(index)->isElementNode());
+
+        std::string failureContext("Test case: ");
+        if (element->hasID()) {
+            failureContext.append(element->getIdAttribute().string().ascii().data());
+        } else if (element->firstChild()) {
+            failureContext.append("\"");
+            failureContext.append(element->firstChild()->textContent(false).stripWhiteSpace().ascii().data());
+            failureContext.append("\"");
+        } else {
+            failureContext += "<missing ID>";
+        }
+
+        // Run each test three times at different positions in the element.
+        // Note that we don't want the bounding box because our tests sometimes have elements with
+        // multiple border boxes with other elements in between. Use the first border box (which
+        // we can easily visualize in a browser for debugging).
+        RefPtr<WebCore::ClientRectList> rects = element->getClientRects();
+        ASSERT_GE(rects->length(), 0u) << failureContext;
+        RefPtr<WebCore::ClientRect> r = rects->item(0);
+        WebCore::FloatRect clientFloatRect = WebCore::FloatRect(r->left(), r->top(), r->width(), r->height());
+        WebCore::IntRect clientRect =  enclosedIntRect(clientFloatRect);
+        for (int locIdx = 0; locIdx < 3; locIdx++) {
+            WebCore::IntPoint clientPoint;
+            std::stringstream contextStream;
+            contextStream << failureContext << " (";
+            switch (locIdx) {
+            case 0:
+                clientPoint = clientRect.center();
+                contextStream << "center";
+                break;
+            case 1:
+                clientPoint = clientRect.location();
+                contextStream << "top-left";
+                break;
+            case 2:
+                clientPoint = clientRect.maxXMaxYCorner();
+                clientPoint.move(-1, -1);
+                contextStream << "bottom-right";
+                break;
+            default:
+                FAIL() << "Invalid location index.";
+            }
+            contextStream << "=" << clientPoint.x() << "," << clientPoint.y() << ").";
+            std::string failureContextPos = contextStream.str();
+
+            WebCore::Frame* frame = root->document().frame();
+            WebCore::FrameView* frameView = frame->view();
+            WebCore::IntRect visibleRect = frameView->windowClipRect();
+            ASSERT_TRUE(visibleRect.contains(clientPoint)) << failureContextPos
+                << " Test point not contained in visible area: " << visibleRect.x() << "," << visibleRect.y()
+                << "-" << visibleRect.maxX() << "," << visibleRect.maxY();
+
+            // First validate that a hit test at this point will really hit the element
+            // we intended. This is the easiest way for a test to be broken, but has nothing really
+            // to do with touch action.
+            // Note that we can't use WebView's hit test API because it doesn't look into shadow DOM.
+            WebCore::IntPoint docPoint(frameView->windowToContents(clientPoint));
+            WebCore::HitTestResult result = frame->eventHandler().hitTestResultAtPoint(docPoint, WebCore::HitTestRequest::ReadOnly | WebCore::HitTestRequest::Active);
+            ASSERT_EQ(element, result.innerElement()) << "Unexpected hit test result " << failureContextPos
+                << "  Got element: \"" << result.innerElement()->outerHTML().stripWhiteSpace().left(80).ascii().data() << "\""
+                << std::endl << "Document render tree:" << std::endl << externalRepresentation(root->document().frame()).utf8().data();
+
+            // Now send the touch event and check any touch action result.
+            sendTouchEvent(webView, WebInputEvent::TouchStart, clientPoint);
+
+            AtomicString expectedAction = element->getAttribute("expected-action");
+            if (expectedAction == "auto") {
+                // Auto is the default - no action set.
+                EXPECT_EQ(0, client.touchActionSetCount()) << failureContextPos;
+                EXPECT_EQ(WebTouchActionAuto, client.lastTouchAction()) << failureContextPos;
+            } else {
+                // Should have received exactly one touch action.
+                EXPECT_EQ(1, client.touchActionSetCount()) << failureContextPos;
+                if (client.touchActionSetCount()) {
+                    if (expectedAction == "none") {
+                        EXPECT_EQ(WebTouchActionNone, client.lastTouchAction()) << failureContextPos;
+                    } else {
+                        FAIL() << "Unrecognized expected-action \"" << expectedAction.string().ascii().data()
+                            << "\" " << failureContextPos;
+                    }
+                }
+            }
+
+            // Reset webview touch state.
+            client.reset();
+            sendTouchEvent(webView, WebInputEvent::TouchCancel, clientPoint);
+            EXPECT_EQ(0, client.touchActionSetCount());
+        }
+    }
+}
+void TouchActionTest::sendTouchEvent(WebView* webView, WebInputEvent::Type type, WebCore::IntPoint clientPoint)
+{
+    ASSERT_TRUE(type == WebInputEvent::TouchStart || type == WebInputEvent::TouchCancel);
+
+    WebTouchEvent webTouchEvent;
+    webTouchEvent.type = type;
+    webTouchEvent.touchesLength = 1;
+    webTouchEvent.touches[0].state = (type == WebInputEvent::TouchStart ?
+        WebTouchPoint::StatePressed :
+        WebTouchPoint::StateCancelled);
+    webTouchEvent.touches[0].id = kfakeTouchId;
+    webTouchEvent.touches[0].screenPosition.x = clientPoint.x();
+    webTouchEvent.touches[0].screenPosition.y = clientPoint.y();
+    webTouchEvent.touches[0].position.x = clientPoint.x();
+    webTouchEvent.touches[0].position.y = clientPoint.y();
+    webTouchEvent.touches[0].radiusX = 10;
+    webTouchEvent.touches[0].radiusY = 10;
+
+    webView->handleInputEvent(webTouchEvent);
+    runPendingTasks();
+}
+
+TEST_F(TouchActionTest, Simple)
+{
+    runTouchActionTest("touch-action-simple.html");
+}
+
+TEST_F(TouchActionTest, Overflow)
+{
+    runTouchActionTest("touch-action-overflow.html");
+}
+
+TEST_F(TouchActionTest, ShadowDOM)
+{
+    runShadowDOMTest("touch-action-shadow-dom.html");
+}
+
+}