Merge lp:~dandrader/unity8/doubleTapUserMetrics-lp1388359 into lp:unity8

[Daniel d'Andrada]

TouchDispatcher: synthesize MouseButtonDblClick events

+ Adds a regression test for lp:1388359 and refactors tst_SingleGreeter and Infographics as needed

* Are there any related MPs required for this MP to build/function as expected? Please list.
No.

* Did you perform an exploratory manual test run of your code change and any related functionality?
Yes.

* Did you make sure that your branch does not contain spurious tags?
Yes.

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
Not applicable.

* If you changed the UI, has there been a design review?
Not applicable.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1400
http://jenkins.qa.ubuntu.com/job/unity8-ci/4814/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/6409/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/1800
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/1910
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/1908
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/6013/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7661
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7661/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/15356

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/4814/rebuild

review: Needs Fixing (continuous-integration)

[Michael Terry (mterry)]

LGTM

 * Did you perform an exploratory manual test run of the code change and any related functionality?
 Yes

 * Did CI run pass? If not, please explain why.
 TBD

 * Did you make sure that the branch does not contain spurious tags?
 Yes

review: Approve

[Michael Terry (mterry)]

Wait... While you're here, can you fix the typo in Greeter.qml:

enabled: targetITem.enabled

Should be:

enabled: targetItem.enabled (fixed capitalization of 'T')

[lp:~dandrader/unity8/doubleTapUserMetrics-lp1388359]

1401. By Daniel d'Andrada on 2014-11-04

Fix typo

[Daniel d'Andrada (dandrader)]

On 03/11/14 19:40, Michael Terry wrote:
> Wait... While you're here, can you fix the typo in Greeter.qml:
>
> enabled: targetITem.enabled
>
> Should be:
>
> enabled: targetItem.enabled (fixed capitalization of 'T')

Done. Thanks for spotting that.

=== modified file 'libs/UbuntuGestures/DebugHelpers.cpp'
--- libs/UbuntuGestures/DebugHelpers.cpp	2014-10-17 11:01:53 +0000
+++ libs/UbuntuGestures/DebugHelpers.cpp	2014-11-04 11:20:23 +0000
@@ -83,7 +83,7 @@
         message.append("MouseButtonDblClick ");
         break;
     case QEvent::MouseMove:
-        message.append("MouseButtonMove ");
+        message.append("MouseMove ");
         break;
     default:
         message.append("INVALID_MOUSE_EVENT_TYPE ");

=== modified file 'plugins/Ubuntu/Gestures/TouchDispatcher.cpp'
--- plugins/Ubuntu/Gestures/TouchDispatcher.cpp	2014-10-20 14:24:30 +0000
+++ plugins/Ubuntu/Gestures/TouchDispatcher.cpp	2014-11-04 11:20:23 +0000
@@ -16,7 +16,9 @@
 
 #include "TouchDispatcher.h"
 
+#include <QGuiApplication>
 #include <QScopedPointer>
+#include <QStyleHints>
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-pedantic"
@@ -32,6 +34,7 @@
 TouchDispatcher::TouchDispatcher()
     : m_status(NoActiveTouch)
     , m_touchMouseId(-1)
+    , m_touchMousePressTimestamp(0)
 {
 }
 
@@ -148,6 +151,18 @@
             #endif
             m_status = DeliveringMouseEvents;
             m_touchMouseId = targetTouchPoints.at(0).id();
+
+            if (checkIfDoubleClicked(timestamp)) {
+                QScopedPointer<QMouseEvent> doubleClickEvent(
+                        touchToMouseEvent(QEvent::MouseButtonDblClick, targetTouchPoints.at(0), timestamp,
+                                          modifiers, false /* transformNeeded */));
+                #if TOUCHDISPATCHER_DEBUG
+                qDebug() << "[TouchDispatcher] dispatching" << qPrintable(mouseEventToString(doubleClickEvent.data()))
+                        << "to" << m_targetItem.data();
+                #endif
+                QCoreApplication::sendEvent(targetItem, doubleClickEvent.data());
+            }
+
         } else {
             #if TOUCHDISPATCHER_DEBUG
             qDebug() << "[TouchDispatcher] Item rejected the QMouseEvent.";
@@ -322,3 +337,31 @@
     //QGuiApplicationPrivate::setMouseEventSource(me, Qt::MouseEventSynthesizedByQt);
     return me;
 }
+
+/*
+    Copied from qquickwindow.cpp which has:
+    Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies)
+    Under GPL 3.0 license.
+*/
+bool TouchDispatcher::checkIfDoubleClicked(ulong newPressEventTimestamp)
+{
+    bool doubleClicked;
+
+    if (m_touchMousePressTimestamp == 0) {
+        // just initialize the variable
+        m_touchMousePressTimestamp = newPressEventTimestamp;
+        doubleClicked = false;
+    } else {
+        ulong timeBetweenPresses = newPressEventTimestamp - m_touchMousePressTimestamp;
+        ulong doubleClickInterval = static_cast<ulong>(qApp->styleHints()->
+                mouseDoubleClickInterval());
+        doubleClicked = timeBetweenPresses < doubleClickInterval;
+        if (doubleClicked) {
+            m_touchMousePressTimestamp = 0;
+        } else {
+            m_touchMousePressTimestamp = newPressEventTimestamp;
+        }
+    }
+
+    return doubleClicked;
+}

=== modified file 'plugins/Ubuntu/Gestures/TouchDispatcher.h'
--- plugins/Ubuntu/Gestures/TouchDispatcher.h	2014-10-17 11:01:53 +0000
+++ plugins/Ubuntu/Gestures/TouchDispatcher.h	2014-11-04 11:20:23 +0000
@@ -71,6 +71,8 @@
     QMouseEvent *touchToMouseEvent(QEvent::Type type, const QTouchEvent::TouchPoint &p,
             ulong timestamp, Qt::KeyboardModifiers modifiers, bool transformNeeded = true);
 
+    bool checkIfDoubleClicked(ulong newPressEventTimestamp);
+
     QPointer<QQuickItem> m_targetItem;
 
     enum {
@@ -81,6 +83,7 @@
     } m_status;
 
     int m_touchMouseId;
+    ulong m_touchMousePressTimestamp;
 };
 
 #endif // UBUNTU_TOUCH_DISPATCHER_H

=== modified file 'qml/Greeter/Greeter.qml'
--- qml/Greeter/Greeter.qml	2014-10-17 11:01:53 +0000
+++ qml/Greeter/Greeter.qml	2014-11-04 11:20:23 +0000
@@ -132,7 +132,7 @@
     TouchGate {
         targetItem: dragHandle
         anchors.fill: targetItem
-        enabled: targetITem.enabled
+        enabled: targetItem.enabled
     }
 
     Loader {

=== modified file 'qml/Greeter/Infographics.qml'
--- qml/Greeter/Infographics.qml	2014-07-29 13:47:33 +0000
+++ qml/Greeter/Infographics.qml	2014-11-04 11:20:23 +0000
@@ -26,8 +26,15 @@
 
     property int animDuration: 10
 
-    property bool __useDotAnimation: true
-    property int __circleModifier: __useDotAnimation ? 1 : 2
+    QtObject {
+        id: d
+        objectName: "infographicPrivate"
+        property bool useDotAnimation: true
+        property int circleModifier: useDotAnimation ? 1 : 2
+        property bool animating: dotHideAnimTimer.running
+                              || dotShowAnimTimer.running
+                              || circleChangeAnimTimer.running
+    }
 
     Connections {
         target: model
@@ -46,7 +53,7 @@
         dotHideAnimTimer.stop()
         notification.hideAnim.stop()
 
-        if (__useDotAnimation) {
+        if (d.useDotAnimation) {
             dotShowAnimTimer.startFromBeginning()
         }
         notification.showAnim.start()
@@ -57,7 +64,7 @@
         circleChangeAnimTimer.stop()
         notification.showAnim.stop()
 
-        if (__useDotAnimation) {
+        if (d.useDotAnimation) {
             dotHideAnimTimer.startFromBeginning()
         } else {
             circleChangeAnimTimer.startFromBeginning()
@@ -148,21 +155,21 @@
                                 property: "opacity"
                                 to: pastCircle.circleOpacity
                                 easing.type: Easing.OutCurve
-                                duration: circleChangeAnimTimer.interval * __circleModifier
+                                duration: circleChangeAnimTimer.interval * d.circleModifier
                             }
                             PropertyAnimation {
                                 target: pastCircle
                                 property: "scale"
                                 to: modelData
                                 easing.type: Easing.OutCurve
-                                duration: circleChangeAnimTimer.interval * __circleModifier
+                                duration: circleChangeAnimTimer.interval * d.circleModifier
                             }
                             ColorAnimation {
                                 target: pastCircle
                                 property: "color"
                                 to: Gradient.threeColorByIndex(index, count, infographic.model.secondColor)
                                 easing.type: Easing.OutCurve
-                                duration: circleChangeAnimTimer.interval * __circleModifier
+                                duration: circleChangeAnimTimer.interval * d.circleModifier
                             }
                         }
                     }
@@ -209,21 +216,21 @@
                                 property: "opacity"
                                 to: presentCircle.circleOpacity
                                 easing.type: Easing.OutCurve
-                                duration: circleChangeAnimTimer.interval * __circleModifier
+                                duration: circleChangeAnimTimer.interval * d.circleModifier
                             }
                             PropertyAnimation {
                                 target: presentCircle
                                 property: "scale"
                                 to: modelData
                                 easing.type: Easing.OutCurve
-                                duration: circleChangeAnimTimer.interval * __circleModifier
+                                duration: circleChangeAnimTimer.interval * d.circleModifier
                             }
                             ColorAnimation {
                                 target: presentCircle
                                 property: "color"
                                 to: Gradient.threeColorByIndex(index, infographic.model.currentDay, infographic.model.firstColor)
                                 easing.type: Easing.OutCurve
-                                duration: circleChangeAnimTimer.interval * __circleModifier
+                                duration: circleChangeAnimTimer.interval * d.circleModifier
                             }
                         }
                     }
@@ -385,7 +392,7 @@
                 from: notification.baseOpacity
                 to: 0.0
                 duration: notification.duration * dots.count
-                onStopped: if (!__useDotAnimation) infographic.model.readyForDataChange()
+                onStopped: if (!d.useDotAnimation) infographic.model.readyForDataChange()
             }
         }
     }
@@ -394,10 +401,8 @@
         anchors.fill: dataCircle
 
         onDoubleClicked: {
-            if (!dotHideAnimTimer.running &&
-                    !dotShowAnimTimer.running &&
-                    !circleChangeAnimTimer.running) {
-                __useDotAnimation = false
+            if (!d.animating) {
+                d.useDotAnimation = false
                 infographic.model.nextDataSource()
             }
         }

=== modified file 'tests/plugins/Ubuntu/Gestures/GestureTest.cpp'
--- tests/plugins/Ubuntu/Gestures/GestureTest.cpp	2014-10-17 11:01:53 +0000
+++ tests/plugins/Ubuntu/Gestures/GestureTest.cpp	2014-11-04 11:20:23 +0000
@@ -90,6 +90,7 @@
     mousePressEventHandler = defaultMouseEventHandler;
     mouseMoveEventHandler = defaultMouseEventHandler;
     mouseReleaseEventHandler = defaultMouseEventHandler;
+    mouseDoubleClickEventHandler = defaultMouseEventHandler;
 }
 
 void DummyItem::touchEvent(QTouchEvent *event)
@@ -113,6 +114,11 @@
     mouseReleaseEventHandler(event);
 }
 
+void DummyItem::mouseDoubleClickEvent(QMouseEvent *event)
+{
+    mouseDoubleClickEventHandler(event);
+}
+
 void DummyItem::defaultTouchEventHandler(QTouchEvent *event)
 {
     event->accept();

=== modified file 'tests/plugins/Ubuntu/Gestures/GestureTest.h'
--- tests/plugins/Ubuntu/Gestures/GestureTest.h	2014-10-17 11:01:53 +0000
+++ tests/plugins/Ubuntu/Gestures/GestureTest.h	2014-11-04 11:20:23 +0000
@@ -52,12 +52,14 @@
     std::function<void(QMouseEvent*)> mousePressEventHandler;
     std::function<void(QMouseEvent*)> mouseMoveEventHandler;
     std::function<void(QMouseEvent*)> mouseReleaseEventHandler;
+    std::function<void(QMouseEvent*)> mouseDoubleClickEventHandler;
 protected:
     void touchEvent(QTouchEvent *event) override;
 
     void mousePressEvent(QMouseEvent *event) override;
     void mouseMoveEvent(QMouseEvent *event) override;
     void mouseReleaseEvent(QMouseEvent *event) override;
+    void mouseDoubleClickEvent(QMouseEvent *event) override;
 private:
     static void defaultTouchEventHandler(QTouchEvent *event);
     static void defaultMouseEventHandler(QMouseEvent *event);

=== modified file 'tests/plugins/Ubuntu/Gestures/tst_TouchDispatcher.cpp'
--- tests/plugins/Ubuntu/Gestures/tst_TouchDispatcher.cpp	2014-10-17 11:01:53 +0000
+++ tests/plugins/Ubuntu/Gestures/tst_TouchDispatcher.cpp	2014-11-04 11:20:23 +0000
@@ -16,6 +16,7 @@
 
 #include <QtTest>
 #include <QQuickView>
+#include <QStyleHints>
 
 #include "GestureTest.h"
 
@@ -29,6 +30,8 @@
 private Q_SLOTS:
     void sendMouseEventIfTouchIgnored_data();
     void sendMouseEventIfTouchIgnored();
+    void mouseDoubleClick_data();
+    void mouseDoubleClick();
 };
 
 tst_TouchDispatcher::tst_TouchDispatcher()
@@ -85,6 +88,62 @@
     QCOMPARE(gotMousePressEvent, shouldGetMousePress);
 }
 
+void tst_TouchDispatcher::mouseDoubleClick_data()
+{
+    QTest::addColumn<ulong>("timeBetweenClicks");
+    QTest::addColumn<bool>("shouldSendDoubleClick");
+
+    QTest::newRow("double click") << static_cast<ulong>(qApp->styleHints()->mouseDoubleClickInterval() / 10) << true;
+    QTest::newRow("two separate clicks") << static_cast<ulong>(qApp->styleHints()->mouseDoubleClickInterval() * 2) << false;
+}
+
+void tst_TouchDispatcher::mouseDoubleClick()
+{
+    QFETCH(ulong, timeBetweenClicks);
+    QFETCH(bool, shouldSendDoubleClick);
+    DummyItem *dummyItem = new DummyItem(m_view->rootObject());
+    dummyItem->setAcceptedMouseButtons(Qt::LeftButton);
+
+    TouchDispatcher touchDispatcher;
+    touchDispatcher.setTargetItem(dummyItem);
+
+    bool gotDoubleClickEvent = false;
+    dummyItem->mouseDoubleClickEventHandler = [&](QMouseEvent *event) {
+        gotDoubleClickEvent = true;
+        event->accept();
+    };
+
+    dummyItem->touchEventHandler = [&](QTouchEvent *event) {
+        event->ignore();
+    };
+
+    ulong doubleClickInterval = static_cast<ulong>(qApp->styleHints()->mouseDoubleClickInterval());
+
+    QList<QTouchEvent::TouchPoint> touchPoints;
+    {
+        QTouchEvent::TouchPoint touchPoint;
+        touchPoint.setId(0);
+        touchPoint.setState(Qt::TouchPointPressed);
+        touchPoints.append(touchPoint);
+    }
+    ulong timestamp = 12345;
+
+    touchDispatcher.dispatch(QEvent::TouchBegin, m_device, Qt::NoModifier, touchPoints, m_view, timestamp);
+
+    touchPoints[0].setState(Qt::TouchPointReleased);
+    timestamp += doubleClickInterval / 10;
+
+    touchDispatcher.dispatch(QEvent::TouchEnd, m_device, Qt::NoModifier, touchPoints, m_view, timestamp);
+
+    touchPoints[0].setId(1);
+    touchPoints[0].setState(Qt::TouchPointPressed);
+    timestamp += timeBetweenClicks;
+
+    touchDispatcher.dispatch(QEvent::TouchBegin, m_device, Qt::NoModifier, touchPoints, m_view, timestamp);
+
+    QCOMPARE(gotDoubleClickEvent, shouldSendDoubleClick);
+}
+
 QTEST_MAIN(tst_TouchDispatcher)
 
 #include "tst_TouchDispatcher.moc"

=== modified file 'tests/qmltests/Greeter/tst_SingleGreeter.qml'
--- tests/qmltests/Greeter/tst_SingleGreeter.qml	2014-10-01 13:20:32 +0000
+++ tests/qmltests/Greeter/tst_SingleGreeter.qml	2014-11-04 11:20:23 +0000
@@ -27,50 +27,72 @@
     width: units.gu(60)
     height: units.gu(80)
 
-    Greeter {
-        id: greeter
-        width: parent.width
-        height: parent.height
-        x: 0; y: 0
-
-        property int minX: 0
-
-        onXChanged: {
-            if (x < minX) {
-                minX = x;
-            }
-        }
-    }
-
-    Component {
-        id: greeterComponent
-        Greeter {
-            SignalSpy {
-                objectName: "selectedSpy"
-                target: parent
-                signalName: "selected"
+    Loader {
+        id: greeterLoader
+        anchors.fill: parent
+
+        property bool itemDestroyed: false
+
+        sourceComponent: Component {
+            Greeter {
+                anchors.fill: greeterLoader
+
+                property int minX: 0
+
+                onXChanged: {
+                    if (x < minX) {
+                        minX = x;
+                    }
+                }
+
+                Component.onDestruction: {
+                    greeterLoader.itemDestroyed = true;
+                }
+                SignalSpy {
+                    objectName: "selectedSpy"
+                    target: parent
+                    signalName: "selected"
+                }
             }
         }
     }
 
     SignalSpy {
         id: unlockSpy
-        target: greeter
+        target: greeterLoader.item
         signalName: "unlocked"
     }
 
     SignalSpy {
         id: teaseSpy
-        target: greeter
+        target: greeterLoader.item
         signalName: "tease"
     }
 
+    SignalSpy {
+        id: infographicDataChangedSpy
+        target: LightDM.Infographic
+        signalName: "dataChanged"
+    }
+
     UT.UnityTestCase {
         name: "SingleGreeter"
         when: windowShown
 
+        property Greeter greeter: greeterLoader.item
+
         function cleanup() {
             AccountsService.statsWelcomeScreen = true
+
+            // force a reload so that we get a fresh Greeter for the next test
+            greeterLoader.itemDestroyed = false;
+            greeterLoader.active = false;
+            tryCompare(greeterLoader, "itemDestroyed", true);
+
+            unlockSpy.clear();
+            teaseSpy.clear();
+
+            greeterLoader.active = true;
         }
 
         function test_properties() {
@@ -103,11 +125,32 @@
         }
 
         function test_initial_selected_signal() {
-            var greeterObj = greeterComponent.createObject(this)
-            var spy = findChild(greeterObj, "selectedSpy")
-            spy.wait()
-            tryCompare(spy, "count", 1)
-            greeterObj.destroy()
+            var selectedSpy = findChild(greeter, "selectedSpy");
+            selectedSpy.wait();
+            tryCompare(selectedSpy, "count", 1);
+        }
+
+        /*
+            Regression test for https://bugs.launchpad.net/ubuntu/+source/unity8/+bug/1388359
+            "User metrics can no longer be changed by double tap"
+        */
+        function test_doubleTapSwitchesToNextInfographic() {
+            infographicDataChangedSpy.clear();
+
+            var infographicPrivate = findInvisibleChild(greeter, "infographicPrivate");
+            verify(infographicPrivate);
+
+            // wait for the UI to settle down before double tapping it
+            tryCompare(infographicPrivate, "animating", false);
+
+            var dataCircle = findChild(greeter, "dataCircle");
+            verify(dataCircle);
+
+            tap(dataCircle);
+            wait(1);
+            tap(dataCircle);
+
+            tryCompare(infographicDataChangedSpy, "count", 1);
         }
     }
 }