Improve sync error messages displayed to users

Resolves: #216

Author: pixtron

CHANGELOG.md

@@ -14,7 +14,7 @@
 * Show selective sync on separate page in startup wizard #172
 * Remove windows registry entries on uninstall #32
 * New tray behaviour for linux #207
-
+* Improve sync error messages displayed to users #216
 
 ## 1.2.1
 **Maintainer**: balloon-team <[email protected]>\

app/i18n/de-CH.json

@@ -94,13 +94,19 @@
   "status.nav.quota": "Speicher",
 
   "status.activities.waiting": "Ausstehend...",
-  "status.activities.upload": "%s (Upload)",
-  "status.activities.download": "%s (Download)",
-  "status.activities.upload_failed": "%s (Upload fehlgeschlagen)",
-  "status.activities.download_failed": "%s (Download fehlgeschagen)",
+  "status.activities.upload": "%s: Hochgeladen",
+  "status.activities.download": "%s: Heruntergeladen",
+  "status.activities.upload_failed": "%s: Upload fehlgeschlagen",
+  "status.activities.download_failed": "%s: Download fehlgeschagen",
   "status.activities.empty": "Keine Aktivitäten vorhanden.",
   "status.errors.empty": "Gute Arbeit, keine Fehler vorhanden.",
 
+  "status.activities.upload_failed.errors.code.E_BLN_API_REQUEST_QUOTA_FULL": "%s: Upload fehlgeschlagen, kein freier Speicherplatz",
+  "status.activities.upload_failed.errors.code.E_BLN_API_UPLOAD_SRC_NOTEXISTS": "%s: Upload fehlgeschlagen, die Datei existiert nicht mehr",
+  "status.activities.upload_failed.errors.code.E_BLN_API_OUT_OF_RANGE": "%s: Upload fehlgeschlagen, die Datei ist zu gross",
+  "status.activities.upload_failed.errors.code.E_BLN_API_REQUEST_NETWORK": "%s: Upload fehlgeschlagen, der Server ist nicht erreichbar",
+  "status.activities.download_failed.errors.code.E_BLN_API_REQUEST_NETWORK": "%s: Download fehlgeschlagen, der Server ist nicht erreichbar",
+
   "status.quota.used": "Benutzt",
   "status.quota.left": "Frei",
   "status.quota.max": "Gesamt",

app/i18n/en-US.json

@@ -93,13 +93,19 @@
   "status.nav.quota": "Storage",
 
   "status.activities.waiting": "Waiting...",
-  "status.activities.upload": "%s (uploaded)",
-  "status.activities.download": "%s (downloaded)",
-  "status.activities.upload_failed": "%s (upload failed)",
-  "status.activities.download_failed": "%s (download failed)",
+  "status.activities.upload": "%s: uploaded",
+  "status.activities.download": "%s: downloaded",
+  "status.activities.upload_failed": "%s: upload failed",
+  "status.activities.download_failed": "%s: download failed",
   "status.activities.empty": "There is no activity yet.",
   "status.errors.empty": "Good job, there are no errors.",
 
+  "status.activities.upload_failed.errors.code.E_BLN_API_REQUEST_QUOTA_FULL": "%s: upload failed, no free space on the server",
+  "status.activities.upload_failed.errors.code.E_BLN_API_UPLOAD_SRC_NOTEXISTS": "%s: upload failed, the file does not exist anymore",
+  "status.activities.upload_failed.errors.code.E_BLN_API_OUT_OF_RANGE": "%s: upload failed, the file is too big",
+  "status.activities.upload_failed.errors.code.E_BLN_API_REQUEST_NETWORK": "%s: upload failed, the server is not reachable",
+  "status.activities.download_failed.errors.code.E_BLN_API_REQUEST_NETWORK": "%s: download failed, the server is not reachable",
+
   "status.quota.used": "Used",
   "status.quota.left": "Available",
   "status.quota.max": "Total",

app/ui/status/browser.js

@@ -76,6 +76,7 @@ module.exports = function() {
   ipcRenderer.on('transfer-task', function(event, task) {
     if(taskHistory[task.id]) {
       taskHistory[task.id].subtype = task.subtype;
+      taskHistory[task.id].info = task.info;
     } else {
       taskHistory[task.id] = task;
       taskHistory[task.id].percent = 0;
@@ -177,11 +178,7 @@ module.exports = function() {
           dom += '<div class="task-finish">'+i18n.__('status.activities.download', [ta.format(task.datetime)])+'</div>';
         }
       } else if(task.subtype == 'error' || task.subtype == 'aborted') {
-        if(task.type == 'upload') {
-          dom += '<div class="task-finish">'+i18n.__('status.activities.upload_failed', [ta.format(task.datetime)])+'</div>';
-        } else if(task.type == 'download') {
-          dom += '<div class="task-finish">'+i18n.__('status.activities.download_failed', [ta.format(task.datetime)])+'</div>';
-        }
+        dom += '<div class="task-finish">'+getTaskErrorMessage(task)+'</div>';
       } else if(percent == 0) {
           dom += '<div class="task-queued">'+i18n.__('status.activities.waiting')+'</div>';
       } else {
@@ -193,6 +190,31 @@ module.exports = function() {
     return $(dom);
   }
 
+  function getTaskErrorMessage(task) {
+    const type = task.type;
+    const code = task.info ? task.info.code : undefined;
+    const formatedTime =  ta.format(task.datetime);
+    let msg;
+
+    if(code) {
+      const key = `status.activities.${type}_failed.errors.code.${code.toUpperCase()}`
+
+      msg = i18n.__(key, [formatedTime]);
+
+      if(msg === key) msg = undefined;
+    }
+
+    if(!msg) {
+       msg = task.info && task.info.message ? `${formatedTime}: ${task.info.message}` : undefined;
+    }
+
+    if(!msg) {
+      msg = i18n.__(`status.activities.${type}_failed`, [formatedTime])
+    }
+
+    return msg;
+  }
+
   function renderError(error) {
     return $(`<li id="${error.hash}" class="clearfix" >
       <div class="status-error-message">${error.message}</div>