Merge lp:~vanvugt/mir/fix-missing-vsync into lp:mir

[Daniel van Vugt]

Fix missing vsync in clients that create windows with custom streams
in the creation spec (i.e. nested servers like Unity8).
Fixes LP: #1661128 and LP: #1661072

The problem didn't show up in manual testing because our demo servers are an order of magnitude faster than Unity8, so appeared to be smooth even when not in sync. But it was easy to see the problem using MIR_CLIENT_PERF_REPORT=log on a nested server (with a frame dropping client).

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:4006
https://mir-jenkins.ubuntu.com/job/mir-ci/2924/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/3859
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3938
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3928
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3928
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3928
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3886
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3886/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3886
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3886/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3886
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3886/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3886
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3886/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3886
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3886/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3886
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3886/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2924/rebuild

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

lgtm

review: Approve

[Alberto Aguirre (albaguirre)]

Ok.

review: Approve

[Mir CI Bot (mir-ci-bot)]

FAILED: Autolanding.
More details in the following jenkins job:
https://mir-jenkins.ubuntu.com/job/mir-autolanding/1063/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3866/console
    None: https://mir-jenkins.ubuntu.com/job/generic-land-mp/1121/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3945
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3935
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3935
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3935
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3893/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3893
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3893/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3893
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3893/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3893
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3893/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3893
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3893/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3893
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3893/artifact/output/*zip*/output.zip

review: Needs Fixing (continuous-integration)

[Cemil Azizoglu (cemil-azizoglu)]

^^ lp:1661187

=== modified file 'src/client/mir_surface.cpp'
--- src/client/mir_surface.cpp	2017-01-18 05:00:05 +0000
+++ src/client/mir_surface.cpp	2017-02-02 09:31:49 +0000
@@ -144,11 +144,23 @@
       output_id(spec.output_id.is_set() ? spec.output_id.value() : static_cast<uint32_t>(mir_display_output_id_invalid))
 {
     if (default_stream)
-    {
         streams.insert(default_stream);
-        default_stream->adopted_by(this);
+
+    if (spec.streams.is_set())
+    {
+        auto& map = connection_->connection_surface_map();
+        auto const& spec_streams = spec.streams.value();
+        for (auto& ci : spec_streams)
+        {
+            mir::frontend::BufferStreamId id(ci.stream_id);
+            if (auto bs = map->stream(id))
+                streams.insert(bs);
+        }
     }
 
+    for (auto& s : streams)
+        s->adopted_by(this);
+
     for(int i = 0; i < surface_proto.attributes_size(); i++)
     {
         auto const& attrib = surface_proto.attributes(i);

=== modified file 'tests/unit-tests/client/test_client_mir_surface.cpp'
--- tests/unit-tests/client/test_client_mir_surface.cpp	2017-01-30 05:18:36 +0000
+++ tests/unit-tests/client/test_client_mir_surface.cpp	2017-02-02 09:31:49 +0000
@@ -441,7 +441,43 @@
     EXPECT_EQ(adopted_by, unadopted_by);
 }
 
-TEST_F(MirClientSurfaceTest, adopts_custom_streams_if_set)
+TEST_F(MirClientSurfaceTest, adopts_custom_streams_set_before_construction)
+{   // Regression test for nested server bugs LP: #1661128, LP: #1661072
+    using namespace ::testing;
+
+    mir::frontend::BufferStreamId const mock_stream_id(777888);
+    auto mock_input_platform = std::make_shared<MockClientInputPlatform>();
+    auto mock_stream = std::make_shared<mtd::MockMirBufferStream>(); 
+
+    MirWindow* adopted_by = nullptr;
+    MirWindow* unadopted_by = nullptr;
+    ON_CALL(*mock_stream, rpc_id())
+        .WillByDefault(Return(mock_stream_id));
+    EXPECT_CALL(*mock_stream, adopted_by(_))
+        .WillOnce(SaveArg<0>(&adopted_by));
+    EXPECT_CALL(*mock_stream, unadopted_by(_))
+        .WillOnce(SaveArg<0>(&unadopted_by));
+
+    surface_map->insert(mock_stream_id, mock_stream);
+
+    {
+        MirWindowSpec spec;
+        std::vector<ContentInfo> replacements
+        {
+            {geom::Displacement{0,0}, mock_stream_id.as_value(), geom::Size{1,1}}
+        };
+        spec.streams = replacements;
+        MirWindow win{connection.get(), *client_comm_channel, nullptr,
+            nullptr, mock_input_platform, spec, surface_proto, wh};
+        ASSERT_EQ(&win,    adopted_by);
+        ASSERT_EQ(nullptr, unadopted_by);
+    }
+
+    EXPECT_NE(nullptr,    unadopted_by);
+    EXPECT_EQ(adopted_by, unadopted_by);
+}
+
+TEST_F(MirClientSurfaceTest, adopts_custom_streams_set_after_construction)
 {
     using namespace testing;