Merge lp:~nik90/ubuntu-clock-app/fix-alarm-sound-race-issue into lp:ubuntu-clock-app

[Nekhelesh Ramananthan]

Fixes race issue in the edit alarm page caused due to the QML FolderListModel resulting in incorrect alarm sound names sometimes being shown.

In trunk, there is a race issue involved due the 2 QML FolderListModels defaultSoundModel and customSoundModel. The reason it happens is because QML FolderListModel does not have a signal to indicate that it has finished loading. The onComplete() signal is useless here since after it has completed, the count variable still takes another few ms to update.

So some of the file checks we do for custom alarm sound like checking the existence of the file is done *before* the 2 FolderListModels have fully loaded thereby providing incorrect results sometimes.

I have introduced a Timer which introduces a delay of 250ms to ensure that the FolderListModels have fully loaded before performing the file checks.

This seems to have solved the issue.

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:347
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/795/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/140/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/795/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:348
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/796/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/141

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/796/rebuild

review: Approve (continuous-integration)

[Bartosz Kosiorek (gang65)]

It is working for me correctly, except issues which I was described in chat.
I will report bugs for that issues later.

Thanks Nekhelesh.

review: Approve

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Autolanding.
More details in the following jenkins job:
http://91.189.93.70:8080/job/ubuntu-clock-app-autolanding/296/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-autolanding/53/console

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

review: Approve (continuous-integration)

=== modified file 'app/alarm/EditAlarmPage.qml'
--- app/alarm/EditAlarmPage.qml	2015-08-21 21:28:40 +0000
+++ app/alarm/EditAlarmPage.qml	2015-08-21 22:15:48 +0000
@@ -252,33 +252,40 @@
     FolderListModel {
         id: defaultSoundModel
 
+        property bool isModelLoaded: false
+
         showDirs: false
         nameFilters: [ "*.ogg", "*.mp3" ]
         folder: "/usr/share/sounds/ubuntu/ringtones"
-
-        onCountChanged: {
-            if(count > 0) {
-                // When folder model is completely loaded set the alarm sound.
-                if(!pageStack.currentPage.isAlarmSoundPage) {
-                    setAlarmSound()
-                }
-            }
+        Component.onCompleted: {
+            isModelLoaded = true
         }
     }
 
     FolderListModel {
         id: customSoundModel
 
+        property bool isModelLoaded: false
+
         showDirs: false
         folder: customSound.alarmSoundDirectory
+        Component.onCompleted: {
+            isModelLoaded = true
+        }
+    }
 
-        onCountChanged: {
-            if(count > 0) {
-                // When folder model is completely loaded set the alarm sound.
-                if(!pageStack.currentPage.isAlarmSoundPage) {
-                    setAlarmSound()
-                }
-            }
+    /*
+     QML FolderListModel does not provide any signals to indicate that it is fully loaded other
+     than the onCompleted() signal which is not sufficient. This introduces a race-condition where
+     file checks are done *before* the folder models have fully loaded. This timer introduces a
+     delay to workaround that issue.
+    */
+    Timer {
+        id: delaySettingAlarmSoundTimer
+        interval: 100
+        running: defaultSoundModel.isModelLoaded && customSoundModel.isModelLoaded
+        onTriggered: {
+            setAlarmSound()
         }
     }
 
@@ -359,8 +366,7 @@
             id: _alarmSound
             objectName: "alarmSound"
 
-            // Default Alarm Sound for new alarms
-            property string defaultAlarmSound: "Alarm clock"
+            readonly property string defaultAlarmSound: "Alarm clock"
 
             text: i18n.tr("Sound")
             onClicked: pageStack.push(Qt.resolvedUrl("AlarmSound.qml"), {