Merge lp:~vanvugt/mir/fix-1372300 into lp:mir

[Daniel van Vugt]

Fix jerky/stuttering event delivery that could happen inside
nested servers sometimes (LP: #1372300)

Waiting significantly longer than a frame before consuming previously
batched events is too dangerous in slow raw-event environments
(nested servers or very slow input devices). It causes frame skipping.

[Daniel van Vugt (vanvugt)]

If you decide to do any manual testing, beware of bug 1372850, which is technically unrelated.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1933
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/2789/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1848
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1855
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/1821/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/1311
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/1311/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/758
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/758/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/2852/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/13582

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/2789/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1934
http://jenkins.qa.ubuntu.com/job/mir-0.8-ci/1/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-0.8-utopic-amd64-ci/1
        deb: http://jenkins.qa.ubuntu.com/job/mir-0.8-utopic-amd64-ci/1/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1863
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1870
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/1835
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/772
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/772/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/2864
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/13645

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-0.8-ci/1/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1934
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/2800/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1865
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1872
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/1836
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/1322
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/1322/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/773
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/773/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/2866
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/13647

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/2800/rebuild

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

Confirming this fixes the issue.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1934
http://jenkins.qa.ubuntu.com/job/mir-ci/1697/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1864
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1871
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-utopic-amd64-ci/35
        deb: http://jenkins.qa.ubuntu.com/job/mir-utopic-amd64-ci/35/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-utopic-armhf-ci/35
        deb: http://jenkins.qa.ubuntu.com/job/mir-utopic-armhf-ci/35/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-autolanding/1098/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1895
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1902
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/1861/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-autolanding/482
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-autolanding/482/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/798/console

review: Needs Fixing (continuous-integration)

=== modified file 'src/common/input/android/android_input_receiver.cpp'
--- src/common/input/android/android_input_receiver.cpp	2014-09-11 05:51:44 +0000
+++ src/common/input/android/android_input_receiver.cpp	2014-09-24 07:21:12 +0000
@@ -134,23 +134,11 @@
     }
 
     auto reduced_timeout = timeout;
-    if (input_consumer->hasDeferredEvent())
+    if (input_consumer->hasDeferredEvent() || input_consumer->hasPendingBatch())
     {
         // consume() didn't finish last time. Retry it immediately.
         reduced_timeout = std::chrono::milliseconds::zero();
     }
-    else if (input_consumer->hasPendingBatch())
-    {
-        /*
-         * A batch is pending and must be completed or else the client could
-         * be starved of events. But don't hurry. A continuous motion gesture
-         * will wake us up much sooner than 50ms. This timeout is only reached
-         * in the case that motion has ended (fingers lifted).
-         */
-        std::chrono::milliseconds const motion_idle_timeout(50);
-        if (timeout.count() < 0 || timeout > motion_idle_timeout)
-            reduced_timeout = motion_idle_timeout;
-    }
 
     auto result = looper->pollOnce(reduced_timeout.count());
     if (result == ALOOPER_POLL_WAKE)

=== modified file 'tests/unit-tests/client/input/test_android_input_receiver.cpp'
--- tests/unit-tests/client/input/test_android_input_receiver.cpp	2014-09-11 05:51:44 +0000
+++ tests/unit-tests/client/input/test_android_input_receiver.cpp	2014-09-24 07:21:12 +0000
@@ -204,6 +204,51 @@
     EXPECT_FALSE(receiver.next_event(std::chrono::milliseconds(1), ev)); // Minimal timeout needed for valgrind
 }
 
+TEST_F(AndroidInputReceiverSetup, slow_raw_input_doesnt_cause_frameskipping)
+{   // Regression test for LP: #1372300
+    using namespace testing;
+    using namespace std::chrono;
+
+    nsecs_t t = 0;
+
+    mircva::InputReceiver receiver(
+        client_fd, std::make_shared<mircv::NullInputReceiverReport>(),
+        [&t](int) { return t; }
+        );
+    TestingInputProducer producer(server_fd);
+
+    nsecs_t const one_millisecond = 1000000ULL;
+    nsecs_t const one_second = 1000 * one_millisecond;
+    nsecs_t const one_frame = one_second / 60;
+
+    MirEvent ev;
+
+    producer.produce_a_motion_event(123, 456, t);
+    producer.produce_a_key_event();
+    flush_channels();
+
+    std::chrono::milliseconds const max_timeout(1000);
+
+    // Key events don't get resampled. Will be reported first.
+    ASSERT_TRUE(receiver.next_event(max_timeout, ev));
+    ASSERT_EQ(mir_event_type_key, ev.type);
+
+    // The motion is still too new. Won't be reported yet, but is batched.
+    auto start = high_resolution_clock::now();
+    ASSERT_FALSE(receiver.next_event(max_timeout, ev));
+    auto end = high_resolution_clock::now();
+    auto duration = end - start;
+
+    // Verify we timed out in under a frame (LP: #1372300)
+    // Sadly using real time as droidinput::Looper doesn't use a mocked clock.
+    ASSERT_LT(duration_cast<nanoseconds>(duration).count(), one_frame);
+
+    // But later in a frame or so, the motion will be reported:
+    t += one_frame;
+    ASSERT_TRUE(receiver.next_event(max_timeout, ev));
+    ASSERT_EQ(mir_event_type_motion, ev.type);
+}
+
 TEST_F(AndroidInputReceiverSetup, rendering_does_not_lag_behind_input)
 {
     using namespace testing;