Merge lp:~afrantzis/mir/fix-1462088-update-cursor-on-first-frame-posted into lp:mir

[Alexandros Frantzis]

input: Update cursor when the first frame of a surface is posted

This MP fixes lp:1462088, which occurs when the request for disabling the cursor happens to reach the host server before the first buffer of the nested framebuffer surface. In such a case, when the nested framebuffer surface is first rendered by the host, the cursor is not applied and the test fails.

input: Update cursor when the first frame of a surface is posted

This MP fixes lp:1462088, which occurs when the request for disabling the cursor happens to reach the host server before the first buffer of the nested framebuffer surface. In such a case, when the nested framebuffer surface is first rendered by the host, the cursor is not applied and the test fails.

[Kevin DuBois (kdub)]

could use a test, or at least some comments about which bug will pop up if the non-obvious logic is altered.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2723
http://jenkins.qa.ubuntu.com/job/mir-ci/4256/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/3081
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-wily-amd64-build/602
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/3029
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/412
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/412/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3029
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3029/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/5839
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21667

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

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

> could use a test, or at least some comments about which bug will pop up if the non-obvious logic is altered.

Done

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2724
http://jenkins.qa.ubuntu.com/job/mir-ci/4258/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/3083
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-wily-amd64-build/604
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/3031
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/414
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/414/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3031
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3031/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/5841
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21675

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

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

lgtm

review: Approve

[Daniel van Vugt (vanvugt)]

review: Approve

=== modified file 'src/server/input/cursor_controller.cpp'
--- src/server/input/cursor_controller.cpp	2015-06-17 05:20:42 +0000
+++ src/server/input/cursor_controller.cpp	2015-07-06 13:52:28 +0000
@@ -64,7 +64,14 @@
     }
     void frame_posted(int) override
     {
-        // Frame posting wont trigger a cursor update
+        // The first frame posted will trigger a cursor update, since it
+        // changes the visibility status of the surface, and can thus affect
+        // the cursor.
+        if (!first_frame_posted)
+        {
+            first_frame_posted = true;
+            cursor_controller->update_cursor_image();
+        }
     }
     void alpha_set_to(float) override
     {
@@ -92,6 +99,7 @@
     }
 
     mi::CursorController* const cursor_controller;
+    bool first_frame_posted = false;
 };
 
 struct UpdateCursorOnSceneChanges : ms::Observer

=== modified file 'tests/unit-tests/input/test_cursor_controller.cpp'
--- tests/unit-tests/input/test_cursor_controller.cpp	2015-06-25 03:00:08 +0000
+++ tests/unit-tests/input/test_cursor_controller.cpp	2015-07-06 13:52:28 +0000
@@ -163,6 +163,19 @@
         observers.erase(it);
     }
 
+    void post_frame()
+    {
+        for (auto observer : observers)
+        {
+            observer->frame_posted(1);
+        }
+    }
+
+    void set_cursor_image_without_notifications(std::shared_ptr<mg::CursorImage> const& image)
+    {
+        cursor_image_ = image;
+    }
+
     geom::Rectangle const bounds;
     std::shared_ptr<mg::CursorImage> cursor_image_;
     
@@ -387,3 +400,33 @@
     targets.add_surface(mt::fake_shared(surface1));
     targets.add_surface(mt::fake_shared(surface2));
 }
+
+TEST_F(TestCursorController, updates_cursor_image_when_surface_posts_first_frame)
+{
+    using namespace ::testing;
+
+    StubInputSurface surface{rect_0_0_1_1,
+        std::make_shared<NamedCursorImage>(cursor_name_1)};
+    StubScene targets({mt::fake_shared(surface)});
+
+    // Cursor is set when we first create the controller
+    // because of the existing surface
+    EXPECT_CALL(cursor, show(CursorNamed(cursor_name_1))).Times(1);
+
+    mi::CursorController controller(mt::fake_shared(targets),
+        mt::fake_shared(cursor), default_cursor_image);
+
+    Mock::VerifyAndClearExpectations(&cursor);
+
+    surface.set_cursor_image_without_notifications(
+        std::make_shared<NamedCursorImage>(cursor_name_2));
+
+    // First post should lead to cursor update
+    EXPECT_CALL(cursor, show(CursorNamed(cursor_name_2))).Times(1);
+    surface.post_frame();
+    Mock::VerifyAndClearExpectations(&cursor);
+
+    // Second post should have no effect
+    EXPECT_CALL(cursor, show(_)).Times(0);
+    surface.post_frame();
+}