Merge lp:~zsombi/ubuntu-ui-toolkit/20-alarm-model-update into lp:ubuntu-ui-toolkit/staging

[Zsombor Egri]

AlamrModel is no longer reset when individual alarm is changed. This avoids UI flickering in Clock app.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1209
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/891/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/723
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/723
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/723/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/723

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/891/rebuild

review: Approve (continuous-integration)

[lp:~zsombi/ubuntu-ui-toolkit/20-alarm-model-update]

1210. By Zsombor Egri on 2014-08-22

register QOrganizwerItemId comparators for QVariant use

[Cris Dywan (kalikiana)]

Looks sensible.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1210
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/896/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/728
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/728
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/728/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/728

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/896/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

erm I was testing this to see if it causes any regressions in the clock app but it seems it got merged before I could complete?

=== modified file 'modules/Ubuntu/Components/plugin/adapters/alarmsadapter_organizer.cpp'
--- modules/Ubuntu/Components/plugin/adapters/alarmsadapter_organizer.cpp	2014-08-22 09:25:32 +0000
+++ modules/Ubuntu/Components/plugin/adapters/alarmsadapter_organizer.cpp	2014-08-22 14:48:35 +0000
@@ -59,6 +59,9 @@
     , manager(0)
     , fetchRequest(0)
 {
+    // register QOrganizerItemId comparators so QVariant == operator can compare them
+    QMetaType::registerComparators<QOrganizerItemId>();
+
     QString envManager(qgetenv("ALARM_BACKEND"));
     if (envManager.isEmpty())
         envManager = ALARM_MANAGER;
@@ -93,7 +96,7 @@
     // connect to manager to receive changes
     QObject::connect(manager, SIGNAL(dataChanged()), this, SLOT(fetchAlarms()));
     QObject::connect(manager, SIGNAL(itemsAdded(QList<QOrganizerItemId>)), this, SLOT(fetchAlarms()));
-    QObject::connect(manager, SIGNAL(itemsChanged(QList<QOrganizerItemId>)), this, SLOT(fetchAlarms()));
+    QObject::connect(manager, SIGNAL(itemsChanged(QList<QOrganizerItemId>)), this, SLOT(updateAlarms(QList<QOrganizerItemId>)));
     QObject::connect(manager, SIGNAL(itemsRemoved(QList<QOrganizerItemId>)), this, SLOT(fetchAlarms()));
 }
 
@@ -307,6 +310,48 @@
     return adapter->fetch();
 }
 
+void AlarmsAdapter::updateAlarms(QList<QOrganizerItemId> list)
+{
+    if (list.size() < 0) {
+        return;
+    }
+    QList<QVariant> cookies;
+    QSet<QOrganizerItemId> parentId;
+    QOrganizerTodo event;
+    Q_FOREACH(const QOrganizerItemId &id, list) {
+        const QOrganizerItem item = manager->item(id);
+        if (item.type() == QOrganizerItemType::TypeTodoOccurrence) {
+            QOrganizerTodoOccurrence occurrence = static_cast<QOrganizerTodoOccurrence>(item);
+            QOrganizerItemId eventId = occurrence.parentId();
+            if (parentId.contains(eventId)) {
+                continue;
+            }
+            parentId << eventId;
+            event = static_cast<QOrganizerTodo>(manager->item(eventId));
+        } else if (item.type() == QOrganizerItemType::TypeTodo){
+            event = static_cast<QOrganizerTodo>(item);
+        } else {
+            continue;
+        }
+
+        // update alarm data
+        QVariant cookie = QVariant::fromValue<QOrganizerItemId>(event.id());
+        int index = alarmList.indexOfAlarm(cookie);
+        if (index < 0) {
+            qFatal("The Alarm data has been updated with an unregistered item!");
+        }
+        AlarmData data = alarmList[index];
+        if (alarmDataFromOrganizerEvent(event, data) == UCAlarm::NoError) {
+            adjustAlarmOccurrence(event, data);
+        }
+        alarmList[index] = data;
+
+        // register cookie for update
+        cookies << cookie;
+    }
+    Q_EMIT q_ptr->alarmsUpdated(cookies);
+}
+
 void AlarmsAdapter::completeFetchAlarms(const QList<QOrganizerItem> &alarms)
 {
     alarmList.clear();

=== modified file 'modules/Ubuntu/Components/plugin/adapters/alarmsadapter_p.h'
--- modules/Ubuntu/Components/plugin/adapters/alarmsadapter_p.h	2014-02-28 09:02:40 +0000
+++ modules/Ubuntu/Components/plugin/adapters/alarmsadapter_p.h	2014-08-22 14:48:35 +0000
@@ -92,6 +92,7 @@
 
 public Q_SLOTS:
     bool fetchAlarms();
+    void updateAlarms(QList<QOrganizerItemId> list);
 
 protected:
     AlarmRequest *fetchRequest;

=== modified file 'modules/Ubuntu/Components/plugin/alarmmanager_p.cpp'
--- modules/Ubuntu/Components/plugin/alarmmanager_p.cpp	2013-08-29 11:23:22 +0000
+++ modules/Ubuntu/Components/plugin/alarmmanager_p.cpp	2014-08-22 14:48:35 +0000
@@ -53,7 +53,7 @@
     return instance;
 }
 
-QList<AlarmData> AlarmManager::alarms() const
+AlarmList AlarmManager::alarms() const
 {
     Q_D(const AlarmManager);
     return d->alarmList;

=== modified file 'modules/Ubuntu/Components/plugin/alarmmanager_p.h'
--- modules/Ubuntu/Components/plugin/alarmmanager_p.h	2014-08-06 14:22:14 +0000
+++ modules/Ubuntu/Components/plugin/alarmmanager_p.h	2014-08-22 14:48:35 +0000
@@ -123,6 +123,24 @@
     bool enabled;
 };
 
+// list of alarms
+class AlarmList: public QList<AlarmData>
+{
+public:
+    AlarmList(){}
+
+    // returns the index of the alarm matching a cookie, -1 on error
+    inline int indexOfAlarm(const QVariant &cookie)
+    {
+        for (int i = 0; i < size(); i++) {
+            if (at(i).cookie == cookie) {
+                return i;
+            }
+        }
+        return -1;
+    }
+};
+
 class AlarmRequest;
 class AlarmManagerPrivate;
 class AlarmManager : public QObject
@@ -139,10 +157,11 @@
 
     static AlarmManager &instance();
 
-    QList<AlarmData> alarms() const;
+    AlarmList alarms() const;
 
 Q_SIGNALS:
     void alarmsChanged();
+    void alarmsUpdated(const QList<QVariant> &cookies);
 
 private:
     explicit AlarmManager(QObject *parent = 0);

=== modified file 'modules/Ubuntu/Components/plugin/alarmmanager_p_p.h'
--- modules/Ubuntu/Components/plugin/alarmmanager_p_p.h	2013-08-23 11:01:37 +0000
+++ modules/Ubuntu/Components/plugin/alarmmanager_p_p.h	2014-08-22 14:48:35 +0000
@@ -39,7 +39,7 @@
     }
 
     AlarmManager *q_ptr;
-    QList<AlarmData> alarmList;
+    AlarmList alarmList;
     bool completed:1;
 
     virtual bool fetchAlarms() = 0;

=== modified file 'modules/Ubuntu/Components/plugin/ucalarmmodel.cpp'
--- modules/Ubuntu/Components/plugin/ucalarmmodel.cpp	2014-08-10 14:27:09 +0000
+++ modules/Ubuntu/Components/plugin/ucalarmmodel.cpp	2014-08-22 14:48:35 +0000
@@ -21,6 +21,7 @@
 #include "ucalarm_p.h"
 #include "alarmmanager_p.h"
 #include <QtQml/QQmlPropertyMap>
+#include <QtQml/QQmlInfo>
 
 /*!
  * \qmltype AlarmModel
@@ -132,6 +133,8 @@
     // the delegates may cause the model data to be invalid (released) as some
     // backends may do the refresh/element removals synchronously
     connect(&AlarmManager::instance(), SIGNAL(alarmsChanged()), this, SLOT(refresh()), Qt::QueuedConnection);
+    // get individual alarm data updates
+    connect(&AlarmManager::instance(), SIGNAL(alarmsUpdated(QList<QVariant>)), this, SLOT(update(QList<QVariant>)), Qt::QueuedConnection);
     // fetch alarms
     refresh();
     m_ready = true;
@@ -243,7 +246,7 @@
     }
 
     clear();
-    QList<AlarmData> alarms = AlarmManager::instance().alarms();
+    AlarmList alarms = AlarmManager::instance().alarms();
     Q_FOREACH(const AlarmData &data, alarms) {
         UCAlarm *alarm = new UCAlarm(this);
         UCAlarmPrivate *pAlarm = UCAlarmPrivate::get(alarm);
@@ -256,3 +259,28 @@
         endResetModel();
     }
 }
+
+/*!
+ * \internal
+ * Slot updating individual alarms' data.
+ */
+void UCAlarmModel::update(const QList<QVariant> cookies)
+{
+    AlarmList alarms = AlarmManager::instance().alarms();
+    Q_FOREACH(const QVariant &cookie, cookies) {
+        int alarmIndex = alarms.indexOfAlarm(cookie);
+        AlarmData data = alarms[alarmIndex];
+
+        // the index of the m_alarm must be in sync with teh index of the alarms
+        UCAlarmPrivate *pAlarm = UCAlarmPrivate::get(m_alarms[alarmIndex]);
+        if (pAlarm->rawData.cookie != cookie) {
+            qmlInfo(this) << "Updated alarm cookies differ!" << cookie.toString() << pAlarm->rawData.cookie.toString();
+        } else {
+            pAlarm->rawData = data;
+
+            // create index and emit dataUpdate()
+            QModelIndex modelIndex = createIndex(alarmIndex, 0);
+            Q_EMIT dataChanged(modelIndex, modelIndex);
+        }
+    }
+}

=== modified file 'modules/Ubuntu/Components/plugin/ucalarmmodel.h'
--- modules/Ubuntu/Components/plugin/ucalarmmodel.h	2013-08-23 05:19:46 +0000
+++ modules/Ubuntu/Components/plugin/ucalarmmodel.h	2014-08-22 14:48:35 +0000
@@ -47,6 +47,7 @@
     
 private Q_SLOTS:
     void refresh();
+    void update(const QList<QVariant> cookies);
 
 private:
     bool m_ready;

=== modified file 'tests/unit/tst_alarms/tst_alarms.cpp'
--- tests/unit/tst_alarms/tst_alarms.cpp	2014-08-06 14:22:14 +0000
+++ tests/unit/tst_alarms/tst_alarms.cpp	2014-08-22 14:48:35 +0000
@@ -69,7 +69,7 @@
     bool containsAlarm(UCAlarm *alarm, bool trace = false)
     {
         UCAlarmPrivate *pAlarm = UCAlarmPrivate::get(alarm);
-        QList<AlarmData> alarms = AlarmManager::instance().alarms();
+        AlarmList alarms = AlarmManager::instance().alarms();
         Q_FOREACH(AlarmData i, alarms) {
             if (trace && (alarm->message() == i.message)) {
                 qDebug() << "----------------------";
@@ -94,7 +94,7 @@
 
     bool findAlarm(const QString &message, UCAlarm &result)
     {
-        QList<AlarmData> alarms = AlarmManager::instance().alarms();
+        AlarmList alarms = AlarmManager::instance().alarms();
         Q_FOREACH(AlarmData i, alarms) {
             if (i.message == message) {
                 UCAlarmPrivate::get(&result)->rawData = i;

=== modified file 'tests/unit_x11/tst_components/tst_alarms.qml'
--- tests/unit_x11/tst_components/tst_alarms.qml	2014-04-23 08:50:20 +0000
+++ tests/unit_x11/tst_components/tst_alarms.qml	2014-08-22 14:48:35 +0000
@@ -52,6 +52,17 @@
         name: "AlarmAPI"
         when: windowShown
 
+        SignalSpy {
+            id: dataChangedSpy
+            signalName: "onDataChanged"
+            target: testModel
+        }
+        SignalSpy {
+            id: beginResetModelSpy
+            signalName: "onBeginResetModel"
+            target: testModel
+        }
+
         function clean() {
             var i = 0;
             while (i < testModel.count) {
@@ -74,6 +85,11 @@
             clean();
         }
 
+        function init() {
+            dataChangedSpy.clear();
+            beginResetModelSpy.clear();
+        }
+
         function test_createOneTimeFail() {
             testAlarm.reset();
             testAlarm.date = new Date();
@@ -169,20 +185,32 @@
             compare(testAlarm.error, Alarm.NoError, "alarm canceled");
         }
 
-        function test_updateAlarm_sameType() {
+        function test_updateAlarm_sameType_data() {
+            var date = new Date();
+            date.setMinutes(date.getMinutes() + 10);
+            return [
+                {tag: "LaterDate", referenceDate: date, addMinutes: 10},
+                {tag: "EarlierDate", referenceDate: date, addMinutes: -5},
+            ];
+        }
+        function test_updateAlarm_sameType(data) {
+            var date = data.referenceDate;
             testAlarm.reset();
             testAlarm.message = "test";
             testAlarm.type = Alarm.OneTime;
-            var dt = new Date();
-            dt.setMinutes(dt.getMinutes() + 10);
-            testAlarm.date = dt;
+            testAlarm.date = date;
 
             testAlarm.save();
             compare(testAlarm.error, Alarm.NoError, "fist alarm added");
+            compare(dataChangedSpy.count, 0, "No dataChanged() should be emitted");
+            compare(beginResetModelSpy.count, 0, "No beginResetModel() should be emitted");
 
-            dt.setDate(dt.getDate() + 2);
-            testAlarm.date = dt;
+            date.setMinutes(date.getMinutes() + data.addMinutes);
+            testAlarm.date = date;
+            testAlarm.save();
             compare(testAlarm.error, Alarm.NoError, "updated alarm");
+            compare(beginResetModelSpy.count, 0, "No beginResetModel() should be emitted");
+            dataChangedSpy.wait();
         }
 
         function test_updateAlarm_differentType() {
@@ -195,8 +223,14 @@
 
             testAlarm.save();
             compare(testAlarm.error, Alarm.NoError, "fist alarm added");
+            compare(dataChangedSpy.count, 0, "No dataChanged() should be emitted");
+            compare(beginResetModelSpy.count, 0, "No beginResetModel() should be emitted");
+
             testAlarm.type = Alarm.Repeating;
+            testAlarm.save();
             compare(testAlarm.error, Alarm.NoError, "updated alarm");
+            compare(beginResetModelSpy.count, 0, "No beginResetModel() should be emitted");
+            dataChangedSpy.wait();
         }
 
         function test_modelRoles() {