Merge lp:~aacid/unity-2d/addSmallDelayOnQuit_812104 into lp:unity-2d

[Albert Astals Cid]

Wait for the Quit event to be delivered before really quitting

I think this is a problem either in Qt or in gnome-session, but we can "easily" workaround it ourselves, and could not find how to fix it "properly" so this seems like an acceptable workaround to me.

[lp:~aacid/unity-2d/addSmallDelayOnQuit_812104]

845. By Albert Astals Cid on 2012-01-13

Wait for something less arbitrary than 500 msec

[Gerry Boland (gerboland)]

I think it would be a good idea to add a comment in the code to explain why you're doing this.

Also testing: can you write a test for this?

I need to test, but code looks good. This will make lots of people happy :)

[Gerry Boland (gerboland)]

In my tests, this reduces the logout time to about 10 seconds.

These 10 seconds are explained by this Qt4 bug, for which a patch is pending:
https://bugs.launchpad.net/ubuntu/+source/qt4-x11/+bug/912365

Please add a manual test for this bug, IMO this will be very tricky to automatically test.

review: Needs Fixing

[lp:~aacid/unity-2d/addSmallDelayOnQuit_812104]

846. By Albert Astals Cid on 2012-01-18

Add the logout manual test

[Gerry Boland (gerboland)]

Magic, thank you!

review: Approve

=== modified file 'libunity-2d-private/src/gnomesessionclient.cpp'
--- libunity-2d-private/src/gnomesessionclient.cpp	2011-03-23 14:43:45 +0000
+++ libunity-2d-private/src/gnomesessionclient.cpp	2012-01-18 16:01:36 +0000
@@ -50,6 +50,7 @@
     QString m_applicationId;
     QString m_clientPath;
     bool m_waitingForEndSession;
+    bool m_waitingForQuitEvent;
 
     bool sendEndSessionResponse()
     {
@@ -73,8 +74,10 @@
 , d(new GnomeSessionClientPrivate(applicationId))
 {
     d->m_waitingForEndSession = false;
+    d->m_waitingForQuitEvent = true;
     connect(QCoreApplication::instance(), SIGNAL(aboutToQuit()),
         SLOT(waitForEndSession()));
+    QCoreApplication::instance()->installEventFilter(this);
 }
 
 GnomeSessionClient::~GnomeSessionClient()
@@ -99,6 +102,14 @@
         SLOT(slotRegisterClientFinished(QDBusPendingCallWatcher*)));
 }
 
+bool GnomeSessionClient::eventFilter(QObject* watched, QEvent* event)
+{
+    if (event->type() == QEvent::Quit) {
+        d->m_waitingForQuitEvent = false;
+    }
+    return false;
+}
+
 void GnomeSessionClient::slotRegisterClientFinished(QDBusPendingCallWatcher* watcher)
 {
     QDBusPendingReply<QDBusObjectPath> reply = *watcher;
@@ -139,24 +150,22 @@
     UQ_DEBUG;
     d->sendEndSessionResponse();
     d->m_waitingForEndSession = false;
-    QCoreApplication::quit();
 }
 
 void GnomeSessionClient::waitForEndSession()
 {
-    if (!d->m_waitingForEndSession) {
-        return;
-    }
-
     UQ_DEBUG << "Application is about to quit, waiting for gnome-session to call us back";
     QTime watchDog;
     watchDog.start();
-    while (d->m_waitingForEndSession && watchDog.elapsed() < MAX_END_SESSION_WAIT * 1000) {
+    while ((d->m_waitingForEndSession || d->m_waitingForQuitEvent) && watchDog.elapsed() < MAX_END_SESSION_WAIT * 1000) {
         QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
     }
     if (d->m_waitingForEndSession) {
         UQ_WARNING << "gnome-session did not call back after" << MAX_END_SESSION_WAIT << "seconds, leaving";
     }
+    if (d->m_waitingForQuitEvent) {
+        UQ_WARNING << "did not get the Quit event after" << MAX_END_SESSION_WAIT << "seconds, leaving";
+    }
 }
 
 #include "gnomesessionclient.moc"

=== modified file 'libunity-2d-private/src/gnomesessionclient.h'
--- libunity-2d-private/src/gnomesessionclient.h	2011-03-22 09:58:45 +0000
+++ libunity-2d-private/src/gnomesessionclient.h	2012-01-18 16:01:36 +0000
@@ -47,6 +47,8 @@
 
     void connectToSessionManager();
 
+    bool eventFilter(QObject* watched, QEvent* event);
+
 private Q_SLOTS:
     void slotRegisterClientFinished(QDBusPendingCallWatcher* watcher);
     void stop();

=== added file 'tests/manual-tests/other.txt'
--- tests/manual-tests/other.txt	1970-01-01 00:00:00 +0000
+++ tests/manual-tests/other.txt	2012-01-18 16:01:36 +0000
@@ -0,0 +1,4 @@
+----
+ * Logout of a Unity-2d session
+
+-> Logout is "fast", with "fast" meaning it is not 30 seconds (gnome-session timeout) nor 10 (Qt clipboard manager timeout on app shutdown)