Merge pull request #31 from oisinBates/error-handling

Stop Tasks and include exception message
czue · Apr 27, 2020 · 34e3023 · 34e3023
2 parents f85c2df + 2813db8
commit 34e3023
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,18 @@ def my_task(self, seconds):
     return result
 ```
 
+You can add an optional progress description like this:
+
+```python
+  progress_recorder.set_progress(i + 1, seconds, description='my progress description')
+```
+
+You can stop your task with an exception message like this:
+
+```python
+  progress_recorder.stop_task(i + 1, seconds, 'my exception message')
+```
+
 ### Displaying progress
 
 In the view where you call the task you need to get the task ID like so:

diff --git a/celery_progress/backend.py b/celery_progress/backend.py
@@ -68,7 +68,7 @@ def get_info(self):
                     'complete': True,
                     'success': success,
                     'progress': _get_completed_progress(),
-                    'result': self.result.get(self.task_id) if success else None,
+                    'result': self.result.get(self.task_id) if success else str(self.result.info),
                 }
         elif self.result.state == PROGRESS_STATE:
             return {

diff --git a/celery_progress/static/celery_progress/celery_progress.js b/celery_progress/static/celery_progress/celery_progress.js
@@ -10,9 +10,9 @@ var CeleryProgressBar = (function () {
         }
     }
 
-    function onErrorDefault(progressBarElement, progressBarMessageElement) {
+    function onErrorDefault(progressBarElement, progressBarMessageElement, excMessage) {
         progressBarElement.style.backgroundColor = '#dc4f63';
-        progressBarMessageElement.innerHTML = "Uh-Oh, something went wrong!";
+        progressBarMessageElement.innerHTML = "Uh-Oh, something went wrong! " + excMessage;
     }
 
     function onProgressDefault(progressBarElement, progressBarMessageElement, progress) {
@@ -48,7 +48,7 @@ var CeleryProgressBar = (function () {
                     if (data.success) {
                         onSuccess(progressBarElement, progressBarMessageElement, data.result);
                     } else {
-                        onError(progressBarElement, progressBarMessageElement);
+                        onError(progressBarElement, progressBarMessageElement, data.result);
                     }
                     if (data.result) {
                         onResult(resultElement, data.result);

diff --git a/celery_progress/static/celery_progress/websockets.js b/celery_progress/static/celery_progress/websockets.js
@@ -7,8 +7,8 @@ var CeleryWebSocketProgressBar = (function () {
         CeleryProgressBar.onResultDefault(resultElement, result);
     }
 
-    function onErrorDefault(progressBarElement, progressBarMessageElement) {
-        CeleryProgressBar.onErrorDefault(progressBarElement, progressBarMessageElement);
+    function onErrorDefault(progressBarElement, progressBarMessageElement, excMessage) {
+        CeleryProgressBar.onErrorDefault(progressBarElement, progressBarMessageElement, excMessage);
     }
 
     function onProgressDefault(progressBarElement, progressBarMessageElement, progress) {
@@ -45,7 +45,7 @@ var CeleryWebSocketProgressBar = (function () {
                 if (data.success) {
                     onSuccess(progressBarElement, progressBarMessageElement, data.result);
                 } else {
-                    onError(progressBarElement, progressBarMessageElement);
+                    onError(progressBarElement, progressBarMessageElement, data.result);
                 }
                 if (data.result) {
                     onResult(resultElement, data.result);