Merge lp:~aacid/ubuntu-ui-toolkit/touchRegistryUnity8Fixes into lp:ubuntu-ui-toolkit/staging

[Albert Astals Cid]

Fix Bug caused by candidates getting removed during ownership resolution

Ported from unity8 codebase

Part of http://bazaar.launchpad.net/~unity-team/unity8/trunk/revision/2287

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/344/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2089/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/344/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/564/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2090/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/564/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/318/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2091/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/318/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/576/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2121/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/576/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/203/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/564
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/576
        deb: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/576/artifact/artifacts/*zip*/artifacts.zip
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/344
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/318
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2122/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2090
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2121
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2089
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2091

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/203/rebuild

review: Approve (continuous-integration)

[Zsombor Egri (zsombi)]

Good to go from my side. Nice test!

review: Approve

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/615/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2438/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/615/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/425/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2439/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/425/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/644/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2440/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/644/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/399/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2441/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/399/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Autolanding.
More details in the following jenkins job:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-autolanding/246/
Executed test runs:
    FAILURE: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/615/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/644
    FAILURE: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/425/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/399
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-land-mp/253/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2438
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2440
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2439
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2441

review: Needs Fixing (continuous-integration)

[Timo Jyrinki (timo-jyrinki)]

Re-topapproving MP that was previously topapproved but prevented from going in by CI.

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/673/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2566/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/673/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/454/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2567/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/454/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/640/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2568/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/640/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1909
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/428/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2569/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/428/rebuild

review: Approve (continuous-integration)

=== modified file 'src/Ubuntu/UbuntuGestures/touchregistry.cpp'
--- src/Ubuntu/UbuntuGestures/touchregistry.cpp	2015-11-27 06:16:11 +0000
+++ src/Ubuntu/UbuntuGestures/touchregistry.cpp	2016-03-24 11:28:14 +0000
@@ -507,14 +507,20 @@
     UG_DEBUG << "sending TouchOwnershipEvent(id =" << id
         << " gained) to candidate" << candidates[0].item;
 
+    // need to take a copy of the item list in case
+    // we call back in to remove candidate during the lost ownership event.
+    QList<QPointer<QQuickItem>> items;
+    Q_FOREACH(const CandidateInfo& info, candidates) {
+        items << info.item;
+    }
+
     TouchOwnershipEvent gainedOwnershipEvent(id, true /*gained*/);
-    QCoreApplication::sendEvent(candidates[0].item, &gainedOwnershipEvent);
-
+    QCoreApplication::sendEvent(items[0], &gainedOwnershipEvent);
 
     TouchOwnershipEvent lostOwnershipEvent(id, false /*gained*/);
-    for (int i = 1; i < candidates.count(); ++i) {
-        UG_DEBUG << "sending TouchWonershipEvent(id =" << id << " lost) to candidate"
-            << candidates[i].item;
-        QCoreApplication::sendEvent(candidates[i].item, &lostOwnershipEvent);
+    for (int i = 1; i < items.count(); ++i) {
+        UG_DEBUG << "sending TouchOwnershipEvent(id =" << id << " lost) to candidate"
+            << items[i];
+        QCoreApplication::sendEvent(items[i], &lostOwnershipEvent);
     }
 }

=== modified file 'tests/unit_x11/tst_touchregistry/tst_TouchRegistry.cpp'
--- tests/unit_x11/tst_touchregistry/tst_TouchRegistry.cpp	2016-03-16 17:20:49 +0000
+++ tests/unit_x11/tst_touchregistry/tst_TouchRegistry.cpp	2016-03-24 11:28:14 +0000
@@ -42,6 +42,10 @@
     QSet<int> ownedTouches;
     QSet<int> lostTouches;
     QList<TouchMemento> unownedTouchEvents;
+
+Q_SIGNALS:
+    void gainedOwnership();
+    void lostOwnership();
 };
 
 class tst_TouchRegistry : public QObject
@@ -68,6 +72,7 @@
     void removeOldUndecidedCandidates();
     void interimOwnerWontGetUnownedTouchEvents();
     void candidateVanishes();
+    void candicateOwnershipReentrace();
 
 private:
     TouchRegistry *touchRegistry;
@@ -864,6 +869,57 @@
     QVERIFY(mainCandidate.ownedTouches.contains(0));
 }
 
+/*
+  Regression test for canidate reentrance
+
+  Bug caused by candidates getting removed during ownership resolution
+ */
+void tst_TouchRegistry::candicateOwnershipReentrace()
+{
+    DummyCandidate mainCandidate;
+    DummyCandidate candicate2;
+    DummyCandidate candicate3;
+
+    {
+        QList<QTouchEvent::TouchPoint> touchPoints;
+        touchPoints.append(QTouchEvent::TouchPoint(0));
+        touchPoints[0].setState(Qt::TouchPointPressed);
+        QTouchEvent touchEvent(QEvent::TouchBegin,
+                               0 /* device */,
+                               Qt::NoModifier,
+                               Qt::TouchPointPressed,
+                               touchPoints);
+        touchRegistry->update(&touchEvent);
+    }
+
+    // Re-entrance!
+    connect(&candicate2, &DummyCandidate::lostOwnership, this, [&]() {
+        touchRegistry->removeCandidateOwnerForTouch(0, &candicate2);
+    });
+
+    touchRegistry->addCandidateOwnerForTouch(0, &mainCandidate);
+    touchRegistry->addCandidateOwnerForTouch(0, &candicate2);
+    touchRegistry->addCandidateOwnerForTouch(0, &candicate3);
+
+    {
+        QList<QTouchEvent::TouchPoint> touchPoints;
+        touchPoints.append(QTouchEvent::TouchPoint(0));
+        touchPoints[0].setState(Qt::TouchPointMoved);
+        QTouchEvent touchEvent(QEvent::TouchUpdate,
+                               0 /* device */,
+                               Qt::NoModifier,
+                               Qt::TouchPointMoved,
+                               touchPoints);
+        touchRegistry->update(&touchEvent);
+    }
+
+    touchRegistry->requestTouchOwnership(0, &mainCandidate);
+
+    QCOMPARE(mainCandidate.ownedTouches.count(), 1);
+    QCOMPARE(candicate2.lostTouches.count(), 1);
+    QCOMPARE(candicate3.lostTouches.count(), 1);
+}
+
 ////////////// TouchMemento //////////
 
 TouchMemento::TouchMemento(const QTouchEvent *touchEvent)
@@ -897,8 +953,10 @@
 
         if (touchOwnershipEvent->gained()) {
             ownedTouches.insert(touchOwnershipEvent->touchId());
+            Q_EMIT gainedOwnership();
         } else {
             lostTouches.insert(touchOwnershipEvent->touchId());
+            Q_EMIT lostOwnership();
         }
         return true;
     } else if (e->type() == UnownedTouchEvent::unownedTouchEventType()) {