Merge lp:~dandrader/qtmir/surfaceDrawn into lp:qtmir

[Daniel d'Andrada]

Implement MirSurface.drawn property

And no longer hide blank surfaces from shell

* Are there any related MPs required for this MP to build/function as expected? Please list.
https://code.launchpad.net/~dandrader/unity8/surfaceDrawn/+merge/294427
https://code.launchpad.net/~dandrader/unity-api/surfaceDrawn/+merge/294426

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

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

[Unity8 CI Bot (unity8-ci-bot)]

FAILED: Continuous integration, rev:485
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/213/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/1600
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1553
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/1553
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/1553/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/1553/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/1553/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/1553/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/1553/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/1553/console

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/213/rebuild

review: Needs Fixing (continuous-integration)

[Unity8 CI Bot (unity8-ci-bot)]

FAILED: Continuous integration, rev:486
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/214/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/1601
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1555
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/1555
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/1555/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/1555/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/1555/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/1555/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/1555/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/1555/console

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/214/rebuild

review: Needs Fixing (continuous-integration)

[Nick Dedekind (nick-dedekind)]

Code looks fine. Will test when silo built.
https://requests.ci-train.ubuntu.com/#/ticket/1409

review: Approve (code)

[lp:~dandrader/qtmir/surfaceDrawn]

487. By Daniel d'Andrada on 2016-05-16

Implement MirSurface.drawn property

And no longer hide blank surfaces from shell

Unmerged revisions

487. By Daniel d'Andrada on 2016-05-16

Implement MirSurface.drawn property

And no longer hide blank surfaces from shell

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-04-26 07:20:33 +0000
+++ CMakeLists.txt	2016-05-11 20:34:48 +0000
@@ -76,7 +76,7 @@
 pkg_check_modules(GSETTINGS_QT REQUIRED gsettings-qt)
 pkg_check_modules(QTDBUSTEST libqtdbustest-1 REQUIRED)
 pkg_check_modules(QTDBUSMOCK libqtdbusmock-1 REQUIRED)
-pkg_check_modules(APPLICATION_API REQUIRED unity-shell-application=15)
+pkg_check_modules(APPLICATION_API REQUIRED unity-shell-application=16)
 
 include_directories(${APPLICATION_API_INCLUDE_DIRS})
 
 
=== modified file 'debian/control'
--- debian/control	2016-04-28 12:48:42 +0000
+++ debian/control	2016-05-11 20:34:48 +0000
@@ -22,7 +22,7 @@
                libubuntu-app-launch2-dev (>= 0.9),
                libubuntu-application-api-dev (>= 2.1.0),
                libudev-dev,
-               libunity-api-dev (>= 7.110),
+               libunity-api-dev (>= 7.112),
                liburl-dispatcher1-dev,
                libxkbcommon-dev,
                libxrender-dev,
@@ -93,7 +93,7 @@
 Conflicts: libqtmir,
            libunity-mir1,
 Provides: unity-application-impl,
-          unity-application-impl-15,
+          unity-application-impl-16,
 Description: Qt plugin for Unity specific Mir APIs
  QtMir provides Qt/QML bindings for Mir features that are exposed through the
  qtmir-desktop or qtmir-android QPA plugin such as Application management
 
=== modified file 'src/modules/Unity/Application/mirsurface.cpp'
--- src/modules/Unity/Application/mirsurface.cpp	2016-04-26 08:30:26 +0000
+++ src/modules/Unity/Application/mirsurface.cpp	2016-05-11 20:34:48 +0000
@@ -263,7 +263,7 @@
 {
     if (!m_firstFrameDrawn) {
         m_firstFrameDrawn = true;
-        Q_EMIT firstFrameDrawn();
+        Q_EMIT drawnChanged(true);
     }
 
     // restart the frame dropper so that items have enough time to render the next frame.
 
=== modified file 'src/modules/Unity/Application/mirsurface.h'
--- src/modules/Unity/Application/mirsurface.h	2016-04-26 08:30:26 +0000
+++ src/modules/Unity/Application/mirsurface.h	2016-05-11 20:34:48 +0000
@@ -90,6 +90,8 @@
 
     unity::shell::application::MirSurfaceListInterface* promptSurfaceList() override;
 
+    bool drawn() const override { return m_firstFrameDrawn; }
+
     Q_INVOKABLE void requestFocus() override;
     Q_INVOKABLE void close() override;
     Q_INVOKABLE void raise() override;
@@ -99,8 +101,6 @@
 
     void setLive(bool value) override;
 
-    bool isFirstFrameDrawn() const override { return m_firstFrameDrawn; }
-
     void stopFrameDropper() override;
     void startFrameDropper() override;
 
 
=== modified file 'src/modules/Unity/Application/mirsurfaceinterface.h'
--- src/modules/Unity/Application/mirsurfaceinterface.h	2016-04-29 15:41:00 +0000
+++ src/modules/Unity/Application/mirsurfaceinterface.h	2016-05-11 20:34:48 +0000
@@ -44,8 +44,6 @@
 
     virtual void setLive(bool value) = 0;
 
-    virtual bool isFirstFrameDrawn() const = 0;
-
     virtual void stopFrameDropper() = 0;
     virtual void startFrameDropper() = 0;
 
@@ -116,7 +114,6 @@
     void cursorChanged(const QCursor &cursor);
     void raiseRequested();
     void closeRequested();
-    void firstFrameDrawn();
     void framesPosted();
     void isBeingDisplayedChanged();
     void frameDropped();
 
=== modified file 'src/modules/Unity/Application/mirsurfacemanager.cpp'
--- src/modules/Unity/Application/mirsurfacemanager.cpp	2016-04-29 15:41:00 +0000
+++ src/modules/Unity/Application/mirsurfacemanager.cpp	2016-05-11 20:34:48 +0000
@@ -113,18 +113,14 @@
     }
 
     if (session)
-        session->registerSurface(qmlSurface);
+        session->prependSurface(qmlSurface);
 
     if (qmlSurface->type() == Mir::InputMethodType) {
         m_inputMethodSurface = qmlSurface;
         Q_EMIT inputMethodSurfaceChanged();
     }
 
-    // Only notify QML of surface creation once it has drawn its first frame.
-    connect(qmlSurface, &MirSurfaceInterface::firstFrameDrawn, this, [=]() {
-        tracepoint(qtmir, firstFrameDrawn);
-        Q_EMIT surfaceCreated(qmlSurface);
-    });
+    Q_EMIT surfaceCreated(qmlSurface);
 
     // clean up after MirSurface is destroyed
     connect(qmlSurface, &QObject::destroyed, this, [&](QObject *obj) {
 
=== modified file 'src/modules/Unity/Application/session.cpp'
--- src/modules/Unity/Application/session.cpp	2016-04-06 16:52:49 +0000
+++ src/modules/Unity/Application/session.cpp	2016-05-11 20:34:48 +0000
@@ -191,19 +191,6 @@
     Q_EMIT applicationChanged(application);
 }
 
-void Session::registerSurface(MirSurfaceInterface *newSurface)
-{
-    qCDebug(QTMIR_SESSIONS) << "Session::resgisterSurface - session=" << name() << "surface=" << newSurface;
-
-    // Only notify QML of surface creation once it has drawn its first frame.
-    if (newSurface->isFirstFrameDrawn()) {
-        prependSurface(newSurface);
-    } else {
-        connect(newSurface, &MirSurfaceInterface::firstFrameDrawn,
-                this, [this, newSurface]() { this->prependSurface(newSurface); });
-    }
-}
-
 void Session::prependSurface(MirSurfaceInterface *newSurface)
 {
     qCDebug(QTMIR_SESSIONS) << "Session::prependSurface - session=" << name() << "surface=" << newSurface;
 
=== modified file 'src/modules/Unity/Application/session.h'
--- src/modules/Unity/Application/session.h	2016-03-28 18:02:26 +0000
+++ src/modules/Unity/Application/session.h	2016-05-11 20:34:48 +0000
@@ -57,7 +57,7 @@
 
     void setApplication(unity::shell::application::ApplicationInfoInterface* item) override;
 
-    void registerSurface(MirSurfaceInterface* surface) override;
+    void prependSurface(MirSurfaceInterface* surface) override;
 
     void suspend() override;
     void resume() override;
@@ -102,8 +102,6 @@
 
     void stopPromptSessions();
 
-    void prependSurface(MirSurfaceInterface* surface);
-
     std::shared_ptr<mir::scene::Session> m_session;
     Application* m_application;
     MirSurfaceListModel m_surfaceList;
 
=== modified file 'src/modules/Unity/Application/session_interface.h'
--- src/modules/Unity/Application/session_interface.h	2016-04-06 16:52:49 +0000
+++ src/modules/Unity/Application/session_interface.h	2016-05-11 20:34:48 +0000
@@ -77,7 +77,7 @@
 
     // For MirSurface and MirSurfaceManager use
 
-    virtual void registerSurface(MirSurfaceInterface* surface) = 0;
+    virtual void prependSurface(MirSurfaceInterface* surface) = 0;
 
     // For Application use
 
 
=== modified file 'tests/framework/fake_mirsurface.cpp'
--- tests/framework/fake_mirsurface.cpp	2016-04-05 18:58:38 +0000
+++ tests/framework/fake_mirsurface.cpp	2016-05-11 20:34:48 +0000
@@ -91,7 +91,7 @@
     }
 }
 
-bool FakeMirSurface::isFirstFrameDrawn() const
+bool FakeMirSurface::drawn() const
 {
     return m_isFirstFrameDrawn;
 }
@@ -188,7 +188,7 @@
 {
     if (!m_isFirstFrameDrawn) {
         m_isFirstFrameDrawn = true;
-        Q_EMIT firstFrameDrawn();
+        Q_EMIT drawnChanged(true);
     }
 }
 
 
=== modified file 'tests/framework/fake_mirsurface.h'
--- tests/framework/fake_mirsurface.h	2016-04-26 08:30:26 +0000
+++ tests/framework/fake_mirsurface.h	2016-05-11 20:34:48 +0000
@@ -79,6 +79,8 @@
 
     unity::shell::application::MirSurfaceListInterface* promptSurfaceList() override { return &m_promptSurfaceList;}
 
+    bool drawn() const override;
+
     void requestFocus() override {
         Q_EMIT focusRequested();
     }
@@ -94,7 +96,6 @@
     ////
     // qtmir.MirSurfaceInterface
 
-    bool isFirstFrameDrawn() const override;
     void stopFrameDropper() override;
     void startFrameDropper() override;
     void setLive(bool value) override;
 
=== modified file 'tests/framework/fake_session.cpp'
--- tests/framework/fake_session.cpp	2016-03-28 18:02:26 +0000
+++ tests/framework/fake_session.cpp	2016-05-11 20:34:48 +0000
@@ -49,7 +49,7 @@
     return m_session;
 }
 
-void FakeSession::registerSurface(MirSurfaceInterface *) {}
+void FakeSession::prependSurface(MirSurfaceInterface *) {}
 
 void FakeSession::setApplication(unity::shell::application::ApplicationInfoInterface *app)
 {
 
=== modified file 'tests/framework/fake_session.h'
--- tests/framework/fake_session.h	2016-03-28 18:02:26 +0000
+++ tests/framework/fake_session.h	2016-05-11 20:34:48 +0000
@@ -43,7 +43,7 @@
 
     // For MirSurfaceItem and MirSurfaceManager use
 
-    void registerSurface(MirSurfaceInterface*) override;
+    void prependSurface(MirSurfaceInterface*) override;
 
     // For Application use
 
 
=== modified file 'tests/framework/mock_session.h'
--- tests/framework/mock_session.h	2016-03-28 18:02:26 +0000
+++ tests/framework/mock_session.h	2016-05-11 20:34:48 +0000
@@ -42,7 +42,7 @@
 
     MOCK_CONST_METHOD0(session, std::shared_ptr<mir::scene::Session>());
 
-    MOCK_METHOD1(registerSurface, void(MirSurfaceInterface* surface));
+    MOCK_METHOD1(prependSurface, void(MirSurfaceInterface* surface));
     MOCK_METHOD1(removeSurface, void(MirSurfaceInterface* surface));
 
     MOCK_METHOD1(setApplication, void(unity::shell::application::ApplicationInfoInterface* item));
 
=== modified file 'tests/modules/Application/application_test.cpp'
--- tests/modules/Application/application_test.cpp	2016-04-26 08:56:36 +0000
+++ tests/modules/Application/application_test.cpp	2016-05-11 20:34:48 +0000
@@ -285,7 +285,7 @@
     QSignalSpy spyAppStopped(application.data(), SIGNAL(stopped()));
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
+    session->prependSurface(surface);
     surface->drawFirstFrame();
 
     ASSERT_EQ(Application::InternalState::Running, application->internalState());
@@ -380,7 +380,7 @@
     application->setSession(session);
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
+    session->prependSurface(surface);
     surface->drawFirstFrame();
 
     ASSERT_EQ(Application::InternalState::Running, application->internalState());
@@ -388,7 +388,7 @@
     // Add a second surface to ensure the application doesn't kill itself after it loses
     // one surface.
     FakeMirSurface *secondSurface = new FakeMirSurface;
-    session->registerSurface(secondSurface);
+    session->prependSurface(secondSurface);
     secondSurface->drawFirstFrame();
 
     suspend(application.data());
@@ -437,14 +437,14 @@
     application->setSession(session);
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
+    session->prependSurface(surface);
     surface->drawFirstFrame();
 
     ASSERT_EQ(Application::InternalState::Running, application->internalState());
     ASSERT_EQ(Session::Running, session->state());
 
     FakeMirSurface *secondSurface = new FakeMirSurface;
-    session->registerSurface(secondSurface);
+    session->prependSurface(secondSurface);
     secondSurface->drawFirstFrame();
 
     delete surface;
@@ -488,7 +488,7 @@
     application->setSession(session);
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
+    session->prependSurface(surface);
     surface->drawFirstFrame();
     ASSERT_EQ(Application::InternalState::Running, application->internalState());
 
@@ -532,7 +532,7 @@
     application->setSession(session);
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
+    session->prependSurface(surface);
     surface->drawFirstFrame();
     ASSERT_EQ(Application::InternalState::Running, application->internalState());
 
@@ -570,7 +570,7 @@
     application->setSession(session);
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
+    session->prependSurface(surface);
     surface->drawFirstFrame();
 
     ASSERT_EQ(Application::InternalState::Running, application->internalState());
 
=== modified file 'tests/modules/ApplicationManager/application_manager_test.cpp'
--- tests/modules/ApplicationManager/application_manager_test.cpp	2016-04-26 08:56:36 +0000
+++ tests/modules/ApplicationManager/application_manager_test.cpp	2016-05-11 20:34:48 +0000
@@ -55,7 +55,7 @@
 
         SessionInterface* qmlSession = sessionManager.findSession(mirSession);
         if (qmlSession) {
-            qmlSession->registerSurface(qmlSurface);
+            qmlSession->prependSurface(qmlSurface);
         }
 
         // I assume that applicationManager ignores the mirSurface parameter, so sending
 
=== modified file 'tests/modules/SessionManager/session_test.cpp'
--- tests/modules/SessionManager/session_test.cpp	2016-03-28 18:02:26 +0000
+++ tests/modules/SessionManager/session_test.cpp	2016-05-11 20:34:48 +0000
@@ -43,7 +43,7 @@
     }
 };
 
-TEST_F(SessionTests, FromStartingToRunningOnceSurfaceDrawsFirstFrame)
+TEST_F(SessionTests, FromStartingToRunningOnceFirstSurfaceAppears)
 {
     using namespace testing;
 
@@ -58,12 +58,8 @@
     EXPECT_EQ(Session::Starting, session->state());
 
     FakeMirSurface *surface = new FakeMirSurface;
-    session->registerSurface(surface);
-
-    // Still on Starting as the surface hasn't drawn its first frame yet
-    EXPECT_EQ(Session::Starting, session->state());
-
-    surface->drawFirstFrame();
+    session->prependSurface(surface);
+
     EXPECT_EQ(Session::Running, session->state());
 }
 
@@ -221,7 +217,7 @@
     auto session = std::make_shared<qtmir::Session>(mirSession, mirServer->the_prompt_session_manager());
     {
         FakeMirSurface *surface = new FakeMirSurface;
-        session->registerSurface(surface);
+        session->prependSurface(surface);
         surface->drawFirstFrame();
     }
     EXPECT_EQ(Session::Running, session->state());
@@ -252,7 +248,7 @@
     auto session = std::make_shared<qtmir::Session>(mirSession, promptSessionManager);
     {
         FakeMirSurface *surface = new FakeMirSurface;
-        session->registerSurface(surface);
+        session->prependSurface(surface);
         surface->drawFirstFrame();
     }
     EXPECT_EQ(Session::Running, session->state());
@@ -297,7 +293,7 @@
     auto session = std::make_shared<SessionTestClass>(mirSession, mirServer->the_prompt_session_manager());
     {
         FakeMirSurface *surface = new FakeMirSurface;
-        session->registerSurface(surface);
+        session->prependSurface(surface);
         surface->drawFirstFrame();
     }
     EXPECT_EQ(Session::Running, session->state());