Merge lp:~charlesk/indicator-datetime/lp-1434637-make-alarms-use-less-battery into lp:indicator-datetime/15.04

[Charles Kerr]

Reduce the forced screen-on time for alarms to reduce battery consumption. Also, lower the default alarm duration from 30 minutes to 10 minutes.

== Description of change

1. Change the default alarm duration from 30 minutes to 10 minutes.

2. Force the screen on when an alarm goes off, but release the force so that, if the phone is not touched, it will dim after 30 seconds and turn off after 60 seconds, just like it would if you'd woken it up yourself.

== Checklist

> Are there any related MPs required for this MP to build/function as expected? Please list.

No

> Is your branch in sync with latest trunk? (e.g. bzr pull lp:trunk -> no changes)

Yes

> Did the code build without warnings?

Yes

> Did the tests run successfully?

Yes

> 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

> What device (or emulator) has your component test plan been executed successfully on?

mako vivid r150

> What manual tests are relevant for this MP?

indicator-datetime/new-alarm-wakeup

> Did you include a link to the MR Review Checklist Template to make your reviewer's life easier?

https://wiki.ubuntu.com/Process/Merges/Checklists/indicator-datetime

[Ted Gould (ted)]

Looks Good. Got a bit confused on the C++ object being called self :-)

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:409
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/303/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-vivid-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-vivid-armhf-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-vivid-armhf-ci/17/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/indicator-datetime-ci/303/rebuild

review: Approve (continuous-integration)

=== modified file 'data/com.canonical.indicator.datetime.gschema.xml.in'
--- data/com.canonical.indicator.datetime.gschema.xml.in	2014-09-02 15:37:03 +0000
+++ data/com.canonical.indicator.datetime.gschema.xml.in	2015-03-31 19:43:30 +0000
@@ -148,7 +148,7 @@
 		</key>
 		<key name="alarm-duration-minutes" type="u">
 			<range min="1" max="60"/>
-			<default>30</default>
+			<default>10</default>
 			<_summary>The alarm's duration.</_summary>
 			<_description>
 			  How long the alarm's sound will be looped if its snap decision is not dismissed by the user.

=== modified file 'src/awake.cpp'
--- src/awake.cpp	2014-07-27 16:01:30 +0000
+++ src/awake.cpp	2015-03-31 19:43:30 +0000
@@ -48,10 +48,16 @@
         g_cancellable_cancel (m_cancellable);
         g_object_unref (m_cancellable);
 
+        if (m_display_on_timer)
+        {
+            g_source_remove (m_display_on_timer);
+            m_display_on_timer = 0;
+        }
+
         if (m_system_bus != nullptr)
         {
             unforce_awake ();
-            unforce_screen ();
+            remove_display_on_request ();
             g_object_unref (m_system_bus);
         } 
     }
@@ -106,7 +112,7 @@
                                     G_DBUS_CALL_FLAGS_NONE,
                                     -1,
                                     self->m_cancellable,
-                                    on_force_screen_response,
+                                    on_keep_display_on_response,
                                     self);
 
             g_object_unref (system_bus);
@@ -146,9 +152,9 @@
         }
     }
 
-    static void on_force_screen_response (GObject      * connection,
-                                          GAsyncResult * res,
-                                          gpointer       gself)
+    static void on_keep_display_on_response (GObject      * connection,
+                                             GAsyncResult * res,
+                                             gpointer       gself)
     {
         GError * error;
         GVariant * args;
@@ -171,14 +177,29 @@
         {
             auto self = static_cast<Impl*>(gself);
 
-            self->m_screen_cookie = NO_SCREEN_COOKIE;
-            g_variant_get (args, "(i)", &self->m_screen_cookie);
-            g_debug ("m_screen_cookie is now '%d'", self->m_screen_cookie);
+            self->m_display_on_cookie = NO_DISPLAY_ON_COOKIE;
+            g_variant_get (args, "(i)", &self->m_display_on_cookie);
+            g_debug ("m_display_on_cookie is now '%d'", self->m_display_on_cookie);
+
+            self->m_display_on_timer = g_timeout_add_seconds (self->m_display_on_seconds,
+                                                              on_display_on_timer,
+                                                              gself);
  
             g_variant_unref (args);
         }
     }
 
+    static gboolean on_display_on_timer (gpointer gself)
+    {
+        auto self = static_cast<Impl*>(gself);
+
+        self->m_display_on_timer = 0;
+        self->remove_display_on_request();
+
+        return G_SOURCE_REMOVE;
+    }
+
+
     void unforce_awake ()
     {
         g_return_if_fail (G_IS_DBUS_CONNECTION(m_system_bus));
@@ -202,18 +223,18 @@
         }
     }
 
-    void unforce_screen ()
+    void remove_display_on_request ()
     {
         g_return_if_fail (G_IS_DBUS_CONNECTION(m_system_bus));
 
-        if (m_screen_cookie != NO_SCREEN_COOKIE)
+        if (m_display_on_cookie != NO_DISPLAY_ON_COOKIE)
         {
             g_dbus_connection_call (m_system_bus,
                                     BUS_SCREEN_NAME,
                                     BUS_SCREEN_PATH,
                                     BUS_SCREEN_INTERFACE,
                                     "removeDisplayOnRequest",
-                                    g_variant_new("(i)", m_screen_cookie),
+                                    g_variant_new("(i)", m_display_on_cookie),
                                     nullptr,
                                     G_DBUS_CALL_FLAGS_NONE,
                                     -1,
@@ -221,7 +242,7 @@
                                     nullptr,
                                     nullptr);
 
-            m_screen_cookie = NO_SCREEN_COOKIE;
+            m_display_on_cookie = NO_DISPLAY_ON_COOKIE;
         }
     }
 
@@ -229,9 +250,21 @@
     GCancellable * m_cancellable = nullptr;
     GDBusConnection * m_system_bus = nullptr;
     char * m_awake_cookie = nullptr;
-    int32_t m_screen_cookie = NO_SCREEN_COOKIE;
-
-    static constexpr int32_t NO_SCREEN_COOKIE { std::numeric_limits<int32_t>::min() };
+
+    /**
+     * As described by bug #1434637, alarms should have the display turn on,
+     * dim, and turn off "just like it would if you'd woken it up yourself".
+     * USC may be adding an intent-based bus API to handle this use case,
+     * e.g. turnDisplayOnTemporarily(intent), but there's no timeframe for it.
+     *
+     * Until that's avaialble, we can get close to Design's specs by
+     * requesting a display-on cookie and then releasing the cookie
+     * a moment later. */
+    const guint m_display_on_seconds = 1;
+    guint m_display_on_timer = 0;
+    int32_t m_display_on_cookie = NO_DISPLAY_ON_COOKIE;
+
+    static constexpr int32_t NO_DISPLAY_ON_COOKIE { std::numeric_limits<int32_t>::min() };
 };
 
 /***
@@ -239,7 +272,7 @@
 ***/
 
 Awake::Awake(const std::string& app_name):
-    impl(new Impl (app_name))
+    impl(new Impl(app_name))
 {
 }
 

=== modified file 'tests/test-exporter.cpp'
--- tests/test-exporter.cpp	2014-09-17 16:51:51 +0000
+++ tests/test-exporter.cpp	2015-03-31 19:43:30 +0000
@@ -222,7 +222,7 @@
     g_clear_pointer (&haptic, g_free);
 
     /***
-    **** Try chaning the DBus properties -- do the Settings change to match it?
+    **** Try changing the DBus properties -- do the Settings change to match it?
     ***/
 
     expected_volume = 100;