Merge lp:~charlesk/indicator-datetime/lp-1306112-query-eds-less-frequently-if-load-is-heavy into lp:indicator-datetime/14.04

[Charles Kerr]

If there's a large batch of EDS events coming in, try to wait until the event storm has passed before running our requery.

If there's a large batch of EDS events coming in, try to wait until the event storm has passed before running our requery.

Previously we re-queried after an interval of 200 msec. This patch progressively widens that window until the event storm subsides, or until a minute has passed, whichever comes first.

Made in collaboration w/Renato.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:339
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/223/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-amd64-ci/103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/103
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/103/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[lp:~charlesk/indicator-datetime/lp-1306112-query-eds-less-frequently-if-load-is-heavy]

340. By Charles Kerr on 2014-04-11

remove some extraneous EDS events on startup

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:340
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/224/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-amd64-ci/104
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/104
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/104/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[lp:~charlesk/indicator-datetime/lp-1306112-query-eds-less-frequently-if-load-is-heavy]

341. By Charles Kerr on 2014-04-15

remove unused field Appointment.is_event

342. By Charles Kerr on 2014-04-15

remove unused field Appointment.is_daily

343. By Charles Kerr on 2014-04-15

sync with lp:~renatofilho/qtorganizer5-eds/fix-1284375's method of storing alarm urls. Happily this supercedes our code that used to call e_cal_client_get_attachment_uris(), so this means fewer round trip calls to EDS

344. By Charles Kerr on 2014-04-15

copyediting: fix indentation/formatting

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:343
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/225/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-amd64-ci/105
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/105
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/105/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:344
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/226/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-amd64-ci/106
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/106
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-trusty-armhf-ci/106/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Bill Filler (bfiller)]

Did you perform an exploratory manual test run of the code change and any related functionality on device or emulator?
yes

Did you successfully run all tests found in your component's Test Plan (https://wiki.ubuntu.com/Process/Merges/TestPlan/<package-name>) on device or emulator?
yes

Did CI run pass? If not, please explain why.
yes

Have you checked that submitter has accurately filled out the submitter checklist and has taken no shortcut?
yes

review: Approve

=== modified file 'include/datetime/appointment.h'
--- include/datetime/appointment.h	2014-01-30 19:00:22 +0000
+++ include/datetime/appointment.h	2014-04-15 16:12:38 +0000
@@ -39,8 +39,6 @@
     std::string summary;
     std::string url;
     std::string uid;
-    bool is_event = false;
-    bool is_daily = false;
     bool has_alarms = false;
     DateTime begin;
     DateTime end;
 
=== modified file 'src/appointment.cpp'
--- src/appointment.cpp	2014-01-30 19:00:22 +0000
+++ src/appointment.cpp	2014-04-15 16:12:38 +0000
@@ -33,7 +33,6 @@
         && (summary==that.summary)
         && (url==that.url)
         && (uid==that.uid)
-        && (is_event==that.is_event)
         && (has_alarms==that.has_alarms)
         && (begin==that.begin)
         && (end==that.end);
 
=== modified file 'src/engine-eds.cpp'
--- src/engine-eds.cpp	2014-03-10 02:08:47 +0000
+++ src/engine-eds.cpp	2014-04-15 16:12:38 +0000
@@ -25,6 +25,7 @@
 #include <libedataserver/libedataserver.h>
 
 #include <algorithm> // std::sort()
+#include <ctime> // time()
 #include <map>
 #include <set>
 
@@ -144,16 +145,29 @@
     {
         auto self = static_cast<Impl*>(gself);
         self->m_rebuild_tag = 0;
+        self->m_rebuild_deadline = 0;
         self->set_dirty_now();
         return G_SOURCE_REMOVE;
     }
 
     void set_dirty_soon()
     {
-        static const int ARBITRARY_BATCH_MSEC = 200;
-
-        if (m_rebuild_tag == 0)
-            m_rebuild_tag = g_timeout_add(ARBITRARY_BATCH_MSEC, set_dirty_now_static, this);
+        static constexpr int MIN_BATCH_SEC = 1;
+        static constexpr int MAX_BATCH_SEC = 60;
+        static_assert(MIN_BATCH_SEC <= MAX_BATCH_SEC, "bad boundaries");
+
+        const auto now = time(nullptr);
+
+        if (m_rebuild_deadline == 0) // first pass
+        {
+            m_rebuild_deadline = now + MAX_BATCH_SEC;
+            m_rebuild_tag = g_timeout_add_seconds(MIN_BATCH_SEC, set_dirty_now_static, this);
+        }
+        else if (now < m_rebuild_deadline)
+        {
+            g_source_remove (m_rebuild_tag);
+            m_rebuild_tag = g_timeout_add_seconds(MIN_BATCH_SEC, set_dirty_now_static, this);
+        }
     }
 
     static void on_source_registry_ready(GObject* /*source*/, GAsyncResult* res, gpointer gself)
@@ -272,6 +286,7 @@
         if (e_cal_client_get_view_finish (E_CAL_CLIENT(client), res, &view, &error))
         {
             // add the view to our collection
+            e_cal_client_view_set_flags(view, E_CAL_CLIENT_VIEW_FLAGS_NONE, NULL);
             e_cal_client_view_start(view, &error);
             g_debug("got a view for %s", e_cal_client_get_local_attachment_store(E_CAL_CLIENT(client)));
             auto self = static_cast<Impl*>(gself);
@@ -386,14 +401,6 @@
         }
     };
 
-    struct UrlSubtask
-    {
-        std::shared_ptr<Task> task;
-        Appointment appointment;
-        UrlSubtask(const std::shared_ptr<Task>& task_in, const Appointment& appointment_in):
-            task(task_in), appointment(appointment_in) {}
-    };
-
     static gboolean
     my_get_appointments_foreach(ECalComponent* component,
                                 time_t         begin,
@@ -405,89 +412,68 @@
 
         if ((vtype == E_CAL_COMPONENT_EVENT) || (vtype == E_CAL_COMPONENT_TODO))
         {
-          const gchar* uid = nullptr;
-          e_cal_component_get_uid(component, &uid);
-
-          auto status = ICAL_STATUS_NONE;
-          e_cal_component_get_status(component, &status);
-
-          if ((uid != nullptr) &&
-              (status != ICAL_STATUS_COMPLETED) &&
-              (status != ICAL_STATUS_CANCELLED))
-          {
-              Appointment appointment;
-
-              /* Determine whether this is a recurring event.
-                 NB: icalrecurrencetype supports complex recurrence patterns;
-                 however, since design only allows daily recurrence,
-                 that's all we support here. */
-              GSList * recur_list;
-              e_cal_component_get_rrule_list(component, &recur_list);
-              for (auto l=recur_list; l!=nullptr; l=l->next)
-              {
-                  const auto recur = static_cast<struct icalrecurrencetype*>(l->data);
-                  appointment.is_daily |= ((recur->freq == ICAL_DAILY_RECURRENCE)
-                                             && (recur->interval == 1));
-              }
-              e_cal_component_free_recur_list(recur_list);
-
-              ECalComponentText text;
-              text.value = nullptr;
-              e_cal_component_get_summary(component, &text);
-              if (text.value)
-                  appointment.summary = text.value;
-
-              appointment.begin = DateTime(begin);
-              appointment.end = DateTime(end);
-              appointment.color = subtask->color;
-              appointment.is_event = vtype == E_CAL_COMPONENT_EVENT;
-              appointment.uid = uid;
-
-              GList * alarm_uids = e_cal_component_get_alarm_uids(component);
-              appointment.has_alarms = alarm_uids != nullptr;
-              cal_obj_uid_list_free(alarm_uids);
-
-              e_cal_client_get_attachment_uris(subtask->client,
-                                               uid,
-                                               nullptr,
-                                               subtask->task->p->m_cancellable,
-                                               on_appointment_uris_ready,
-                                               new UrlSubtask(subtask->task, appointment));
+            const gchar* uid = nullptr;
+            e_cal_component_get_uid(component, &uid);
+
+            auto status = ICAL_STATUS_NONE;
+            e_cal_component_get_status(component, &status);
+
+            if ((uid != nullptr) &&
+                (status != ICAL_STATUS_COMPLETED) &&
+                (status != ICAL_STATUS_CANCELLED))
+            {
+                Appointment appointment;
+
+                ECalComponentText text;
+                text.value = nullptr;
+                e_cal_component_get_summary(component, &text);
+                if (text.value)
+                    appointment.summary = text.value;
+
+                appointment.begin = DateTime(begin);
+                appointment.end = DateTime(end);
+                appointment.color = subtask->color;
+                appointment.uid = uid;
+
+                // if the component has display alarms that have a url,
+                // use the first one as our Appointment.url
+                auto alarm_uids = e_cal_component_get_alarm_uids(component);
+                appointment.has_alarms = alarm_uids != nullptr;
+                for(auto walk=alarm_uids; appointment.url.empty() && walk!=nullptr; walk=walk->next)
+                {
+                    auto alarm = e_cal_component_get_alarm(component, static_cast<const char*>(walk->data));
+
+                    ECalComponentAlarmAction action;
+                    e_cal_component_alarm_get_action(alarm, &action);
+                    if (action == E_CAL_COMPONENT_ALARM_DISPLAY)
+                    {
+                        icalattach* attach = nullptr;
+                        e_cal_component_alarm_get_attach(alarm, &attach);
+                        if (attach != nullptr)
+                        {
+                            if (icalattach_get_is_url (attach))
+                            {
+                                const char* url = icalattach_get_url(attach);
+                                if (url != nullptr)
+                                    appointment.url = url;
+                            }
+
+                            icalattach_unref(attach);
+                        }
+                    }
+
+                    e_cal_component_alarm_free(alarm);
+                }
+                cal_obj_uid_list_free(alarm_uids);
+
+                g_debug("adding appointment '%s' '%s'", appointment.summary.c_str(), appointment.url.c_str());
+                subtask->task->appointments.push_back(appointment);
             }
         }
-
+ 
         return G_SOURCE_CONTINUE;
     }
-
-    static void on_appointment_uris_ready(GObject* client, GAsyncResult* res, gpointer gsubtask)
-    {
-        auto subtask = static_cast<UrlSubtask*>(gsubtask);
-
-        GSList * uris = nullptr;
-        GError * error = nullptr;
-        e_cal_client_get_attachment_uris_finish(E_CAL_CLIENT(client), res, &uris, &error);
-        if (error != nullptr)
-        {
-            if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED) &&
-                !g_error_matches(error, E_CLIENT_ERROR, E_CLIENT_ERROR_NOT_SUPPORTED))
-            {
-                g_warning("Error getting appointment uris: %s", error->message);
-            }
-
-            g_error_free(error);
-        }
-        else if (uris != nullptr)
-        {
-            subtask->appointment.url = (const char*) uris->data; // copy the first URL
-            g_debug("found url '%s' for appointment '%s'", subtask->appointment.url.c_str(), subtask->appointment.summary.c_str());
-            e_client_util_free_string_slist(uris);
-        }
-
-        g_debug("adding appointment '%s' '%s'", subtask->appointment.summary.c_str(), subtask->appointment.url.c_str());
-        subtask->task->appointments.push_back(subtask->appointment);
-        delete subtask;
-    }
-
+ 
     EdsEngine& m_owner;
     core::Signal<> m_changed;
     std::set<ESource*> m_sources;
@@ -496,6 +482,7 @@
     GCancellable* m_cancellable = nullptr;
     ESourceRegistry* m_source_registry = nullptr;
     guint m_rebuild_tag = 0;
+    time_t m_rebuild_deadline = 0;
 };
 
 /***
 
=== modified file 'tests/manual-test-snap.cpp'
--- tests/manual-test-snap.cpp	2014-02-04 19:00:22 +0000
+++ tests/manual-test-snap.cpp	2014-04-15 16:12:38 +0000
@@ -36,8 +36,6 @@
     a.summary = "Alarm";
     a.url = "alarm:///hello-world";
     a.uid = "D4B57D50247291478ED31DED17FF0A9838DED402";
-    a.is_event = false;
-    a.is_daily = false;
     a.has_alarms = true;
     auto begin = g_date_time_new_local(2014,12,25,0,0,0);
     auto end = g_date_time_add_full(begin,0,0,1,0,0,-1);