Merge lp:~agateau/unity-2d/wait-for-end-session into lp:unity-2d/3.0

[Aurélien Gâteau]

[session] Avoid long delays on logout

Make sure we wait for gnome-session to call us back before we leave the event-loop.

Avoid long delays on logout

Make sure we wait for gnome-session to call us back before we leave the event-loop.

[Bill Filler (bfiller)]

tested and works great. I just made a couple of slight changes that you should consider:
See my branch here for diff
lp:~bfiller/unity-2d/wait-for-end-session

1) in queryEndSession() I set m_waitingForEndSession = true as the first thing and only set it to false if an error occurs sending the response.

2) in endSession() don't set the m_waitingForEndSession = false until after we send response

after merging these changes it's good to go unless you have comments

review: Needs Fixing

[Bob The Builder (bobthebuilder-deactivatedaccount)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Aurélien Gâteau (agateau)]

review: Approve

=== modified file 'libunity-2d-private/src/gnomesessionclient.cpp'
--- libunity-2d-private/src/gnomesessionclient.cpp	2011-02-07 21:55:11 +0000
+++ libunity-2d-private/src/gnomesessionclient.cpp	2011-03-22 15:46:34 +0000
@@ -31,12 +31,16 @@
 #include <QDBusInterface>
 #include <QDBusReply>
 #include <QDBusPendingCallWatcher>
+#include <QTime>
 
 static const char* SM_DBUS_SERVICE          = "org.gnome.SessionManager";
 static const char* SM_DBUS_PATH             = "/org/gnome/SessionManager";
 static const char* SM_DBUS_INTERFACE        = "org.gnome.SessionManager";
 static const char* SM_CLIENT_DBUS_INTERFACE = "org.gnome.SessionManager.ClientPrivate";
 
+// Number of seconds to wait for gnome-session to call us back
+static const int MAX_END_SESSION_WAIT = 5;
+
 struct GnomeSessionClientPrivate
 {
     GnomeSessionClientPrivate(const QString& applicationId)
@@ -45,12 +49,32 @@
 
     QString m_applicationId;
     QString m_clientPath;
+    bool m_waitingForEndSession;
+
+    bool sendEndSessionResponse()
+    {
+        UQ_DEBUG;
+        QDBusInterface iface(
+            SM_DBUS_SERVICE,
+            m_clientPath,
+            SM_CLIENT_DBUS_INTERFACE);
+        QDBusReply<void> reply = iface.call("EndSessionResponse", /* is_okay= */ true, /* reason= */ "");
+        if (reply.isValid()) {
+            return true;
+        } else {
+            UQ_WARNING << "EndSessionResponse failed:" << reply.error().message();
+            return false;
+        }
+    }
 };
 
 GnomeSessionClient::GnomeSessionClient(const QString& applicationId, QObject* parent)
 : QObject(parent)
 , d(new GnomeSessionClientPrivate(applicationId))
 {
+    d->m_waitingForEndSession = false;
+    connect(QCoreApplication::instance(), SIGNAL(aboutToQuit()),
+        SLOT(waitForEndSession()));
 }
 
 GnomeSessionClient::~GnomeSessionClient()
@@ -97,25 +121,43 @@
 
 void GnomeSessionClient::stop()
 {
+    UQ_DEBUG;
     QCoreApplication::quit();
 }
 
 void GnomeSessionClient::queryEndSession()
 {
-    QDBusInterface iface(
-        SM_DBUS_SERVICE,
-        d->m_clientPath,
-        SM_CLIENT_DBUS_INTERFACE);
-    QDBusReply<void> reply = iface.call("EndSessionResponse", /* is_okay= */ true, /* reason= */ "");
-    if (!reply.isValid()) {
-        UQ_WARNING << "EndSessionResponse failed:" << reply.error().message();
+    UQ_DEBUG;
+    d->m_waitingForEndSession = true;
+
+    if (!d->sendEndSessionResponse()) {
+      d->m_waitingForEndSession = false;
     }
 }
 
 void GnomeSessionClient::endSession()
 {
-    queryEndSession();
+    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) {
+        QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
+    }
+    if (d->m_waitingForEndSession) {
+        UQ_WARNING << "gnome-session did not call back 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-02-07 21:55:11 +0000
+++ libunity-2d-private/src/gnomesessionclient.h	2011-03-22 15:46:34 +0000
@@ -52,6 +52,7 @@
     void stop();
     void queryEndSession();
     void endSession();
+    void waitForEndSession();
 
 private:
     GnomeSessionClientPrivate* const d;