Merge lp:~zsombi/ubuntu-ui-toolkit/alarm-date-fix into lp:ubuntu-ui-toolkit

[Zsombor Egri]

Fix for alarm dates to occur in the same time in all timezones.

Fix for alarm dates to occur in the same time in all timezones.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:975
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1872/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3809
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/3394
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/820
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/820
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/820/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3346
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3827
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3827/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3396
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3396/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5762
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4654

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/1872/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:976
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1873/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3810
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/3395
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/821
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/821
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/821/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3347
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3828
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3828/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3397
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3397/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5763
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4655

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/1873/rebuild

review: Approve (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

So on testing this MP using the ubuntu-clock-app, I have the following observations.

1. Alarms created in the local tz are saved and properly triggered at the correct time. The correct time is also displayed in the indicator-datetime. Hence one can say that the bug #1283236 is fixed.

2. If I switch from UTC+1 (netherlands) to UTC (london) using the system settings app and then create an alarm for say 11:00 AM, it gets saved as 10:00 AM in the clock app. The indicator also shows the alarm as 10:00 AM. The alarm does *not* trigger at 10:00 AM however.

3. If I perform observation #2 but restart the phone after changing the locale, then things work as expected meaning an alarm saved at 11:00 AM gets triggered at 11:00 AM, shown in the indicator as 11:00 AM as well.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:977
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1966/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4336
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/3935
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/914
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/914
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/914/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3759
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4435
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4435/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3937
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3937/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6216
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5349

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/1966/rebuild

review: Approve (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

I tested this MP since it also includes the MP at https://code.launchpad.net/~zsombi/ubuntu-ui-toolkit/alarm-fetch-fix/+merge/208749. On testing it, here are my observations.

1. Bug #1283236 is fixed. Alarms saved in local tz are triggered in local tz.

2. Bug #1283859 is not fixed. Editing and saving alarms (both single and recurring) doesn't update the alarm time shown in the indicator. The alarm also rings at the original time and not at the updated time.

3. Bug #1285958 Recurring alarms can now be saved on sundays :)

[Zsombor Egri (zsombi)]

> I tested this MP since it also includes the MP at
> https://code.launchpad.net/~zsombi/ubuntu-ui-toolkit/alarm-fetch-
> fix/+merge/208749. On testing it, here are my observations.
>
> 1. Bug #1283236 is fixed. Alarms saved in local tz are triggered in local tz.
>
> 2. Bug #1283859 is not fixed. Editing and saving alarms (both single and
> recurring) doesn't update the alarm time shown in the indicator. The alarm
> also rings at the original time and not at the updated time.

Removed attach to the bug as it doesn't seem to be related to Alarm API.

>
> 3. Bug #1285958 Recurring alarms can now be saved on sundays :)

[Cris Dywan (kalikiana)]

Should be a good idea to have a small test case for transcodeDate, even if it's internal, to be sure it works as expected.

review: Needs Fixing

[Zsombor Egri (zsombi)]

> Should be a good idea to have a small test case for transcodeDate, even if
> it's internal, to be sure it works as expected.

Test case added.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:979
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1974/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4393
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/3988
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/922
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/922
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/922/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3805
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4494
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4494/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4009
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4009/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6258
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5449

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/1974/rebuild

review: Approve (continuous-integration)

[Cris Dywan (kalikiana)]

Thanks!

review: Approve

[lp:~zsombi/ubuntu-ui-toolkit/alarm-date-fix]

980. By Zsombor Egri on 2014-04-02

prereq merge

981. By Zsombor Egri on 2014-04-10

prereq merge

982. By Zsombor Egri on 2014-04-10

prereq merge

983. By Zsombor Egri on 2014-04-16

staging merge

Unmerged revisions

=== modified file 'modules/Ubuntu/Components/plugin/adapters/alarmsadapter_organizer.cpp'
--- modules/Ubuntu/Components/plugin/adapters/alarmsadapter_organizer.cpp	2014-04-10 09:53:40 +0000
+++ modules/Ubuntu/Components/plugin/adapters/alarmsadapter_organizer.cpp	2014-04-10 09:53:40 +0000
@@ -119,7 +119,7 @@
 
         int type, days;
         in >> alarm.message >> alarm.date >> alarm.sound >> type >> days >> alarm.enabled;
-        alarm.originalDate = alarm.date;
+        alarm.originalDate = alarm.date = AlarmData::transcodeDate(alarm.date, Qt::LocalTime);
         alarm.type = static_cast<UCAlarm::AlarmType>(type);
         alarm.days = static_cast<UCAlarm::DaysOfWeek>(days);
 
@@ -148,7 +148,7 @@
 
     Q_FOREACH(const AlarmData &alarm, alarmList) {
         out << alarm.message
-            << alarm.originalDate
+            << AlarmData::transcodeDate(alarm.originalDate, Qt::UTC)
             << alarm.sound
             << alarm.type
             << alarm.days
@@ -162,7 +162,7 @@
 {
     event.setCollectionId(collection.id());
     event.setAllDay(false);
-    event.setStartDateTime(alarm.date);
+    event.setStartDateTime(AlarmData::transcodeDate(alarm.date, Qt::UTC));
     event.setDisplayLabel(alarm.message);
 
     if (alarm.enabled) {
@@ -229,7 +229,7 @@
 
     alarm.cookie = QVariant::fromValue<QOrganizerItemId>(event.id());
     alarm.message = event.displayLabel();
-    alarm.date = AlarmData::normalizeDate(event.startDateTime());
+    alarm.date = AlarmData::transcodeDate(event.startDateTime().toUTC(), Qt::LocalTime);
     alarm.sound = QUrl(event.description());
     alarm.originalDate = alarm.date;
 
@@ -355,6 +355,10 @@
         endDate = startDate.addDays(8);
     }
 
+    // transcode both dates
+    startDate = AlarmData::transcodeDate(startDate, Qt::UTC);
+    endDate = AlarmData::transcodeDate(endDate, Qt::UTC);
+
     QList<QOrganizerItem> occurrences = manager->itemOccurrences(event, startDate, endDate, 10);
     // get the first occurrence and use the date from it
     if ((occurrences.length() > 0) && (occurrences[0].type() == QOrganizerItemType::TypeTodoOccurrence)) {
@@ -364,7 +368,7 @@
             // check if the date is after the current datetime
             // the first occurrence is the one closest to the currentDate, therefore we can safely
             // set that startDate to the alarm
-            alarm.date = occurrence.startDateTime();
+            alarm.date = AlarmData::transcodeDate(occurrence.startDateTime().toUTC(), Qt::LocalTime);
             if (alarm.date > currentDate) {
                 // we have the proper date set, leave
                 break;

=== modified file 'modules/Ubuntu/Components/plugin/alarmmanager_p.h'
--- modules/Ubuntu/Components/plugin/alarmmanager_p.h	2014-04-10 09:53:40 +0000
+++ modules/Ubuntu/Components/plugin/alarmmanager_p.h	2014-04-10 09:53:40 +0000
@@ -101,6 +101,14 @@
         return QDateTime(dt.date(), time, dt.timeSpec());
     }
 
+    // the function normalizes and transcodes the date into UTC/LocalTime equivalent
+    static QDateTime transcodeDate(const QDateTime &dt, Qt::TimeSpec targetSpec) {
+        if (dt.timeSpec() == targetSpec) {
+            return normalizeDate(dt);
+        }
+        return QDateTime(dt.date(), normalizeDate(dt).time(), targetSpec);
+    }
+
     unsigned int changes;
     QVariant cookie;
 

=== modified file 'tests/unit/tst_alarms/tst_alarms.cpp'
--- tests/unit/tst_alarms/tst_alarms.cpp	2014-04-10 09:53:40 +0000
+++ tests/unit/tst_alarms/tst_alarms.cpp	2014-04-10 09:53:40 +0000
@@ -31,6 +31,7 @@
 #include <QtCore/QDebug>
 #include <QtTest/QTest>
 #include <QtTest/QSignalSpy>
+#include <QtCore/QTimeZone>
 
 class tst_UCAlarms : public QObject
 {
@@ -126,7 +127,7 @@
     }
 
     void test_singleShotAlarmPass() {
-        UCAlarm alarm(QDateTime::currentDateTime().addSecs(10), "test_singleShotAlarmPass");
+        UCAlarm alarm(QDateTime::currentDateTime().addSecs(4), "test_singleShotAlarmPass");
         alarm.save();
         waitForRequest(&alarm);
         QCOMPARE(alarm.error(), (int)UCAlarm::NoError);
@@ -424,6 +425,37 @@
         QVERIFY(containsAlarm(&nextAlarm));
     }
 
+    void test_transcodeDate_data()
+    {
+        QTest::addColumn<QDateTime>("date");
+        QTest::addColumn<int>("srcSpec");
+        QTest::addColumn<int>("dstSpec");
+        QTest::addColumn<bool>("xfail");
+
+        QDateTime now = QDateTime::currentDateTime();
+        QTest::newRow("Local to Local") << now << (int)Qt::LocalTime << (int)Qt::LocalTime << true;
+        QTest::newRow("Local to UTC") << now << (int)Qt::LocalTime << (int)Qt::UTC << false;
+        QTest::newRow("UTC to UTC") << now << (int)Qt::UTC << (int)Qt::UTC << true;
+        QTest::newRow("UTC to Local") << now << (int)Qt::UTC << (int)Qt::LocalTime << false;
+    }
+
+    void test_transcodeDate()
+    {
+        QFETCH(QDateTime, date);
+        QFETCH(int, srcSpec);
+        QFETCH(int, dstSpec);
+        QFETCH(bool, xfail);
+
+        QDateTime srcDate = AlarmData::normalizeDate(QDateTime(date.date(), date.time(), (Qt::TimeSpec)srcSpec));
+        QDateTime dstDate(AlarmData::transcodeDate(srcDate, (Qt::TimeSpec)dstSpec));
+        QCOMPARE(srcDate.date(), dstDate.date());
+        QCOMPARE(srcDate.time(), dstDate.time());
+        if (xfail) {
+            QEXPECT_FAIL("", "Similar timespec set, expect fail", Continue);
+        }
+        QVERIFY(srcDate.timeZone() != dstDate.timeZone());
+    }
+
 };
 
 QTEST_MAIN(tst_UCAlarms)