fix: finalize/ephermalize job when upload finishes when widget not visible

Author: paulmueller

CHANGELOG

@@ -3,6 +3,7 @@
  - fix: missing .rtdc resource files in filter view
  - fix: error handling when connection to server fails on download (#75)
  - fix: '_condensed' suffix for file stem randomly missing in downloads
+ - fix: finalize/ephermalize job when upload finishes when widget not visible
  - enh: display DCOR instance title in search bar
  - enh: make icons "grayer" so they work in dark themes as well
  - enh: add `SQLiteKeyJSONDatabase` for persistent metadata storage

dcoraid/gui/main.py

@@ -109,6 +109,9 @@ def __init__(self, *args, **kwargs):
         self.panel_my_data.request_download.connect(
             self.panel_download.download_resource)
 
+        # Signal for dataset upload or modification
+        self.panel_upload.upload_finished.connect(self.on_dataset_changed)
+
         QtWidgets.QApplication.processEvents(
             QtCore.QEventLoop.ProcessEventsFlag.AllEvents, 300)
 
@@ -295,6 +298,10 @@ def on_action_software(self):
                                           "Software",
                                           sw_text)
 
+    @QtCore.pyqtSlot(dict)
+    def on_dataset_changed(self, ds_dict):
+        self.database.update_dataset(ds_dict)
+
     @QtCore.pyqtSlot()
     def on_wizard(self):
         self.wizard = SetupWizard(self)

dcoraid/gui/panel_uploads/widget_upload.py

@@ -24,7 +24,7 @@
 
 
 class UploadWidget(QtWidgets.QWidget):
-    upload_finished = QtCore.pyqtSignal()
+    upload_finished = QtCore.pyqtSignal(dict)
 
     def __init__(self, *args, **kwargs):
         """Manage running uploads
@@ -369,7 +369,7 @@ def prepare_quit(self):
 
 
 class UploadTableWidget(QtWidgets.QTableWidget):
-    upload_finished = QtCore.pyqtSignal()
+    upload_finished = QtCore.pyqtSignal(dict)
     job_selected = QtCore.pyqtSignal(object)
 
     def __init__(self, *args, **kwargs):
@@ -450,12 +450,25 @@ def on_upload_finished(self, dataset_id):
         if dataset_id not in self._finished_uploads:
             self._finished_uploads.append(dataset_id)
             self.jobs.jobs_eternal.set_job_done(dataset_id)
-            self.upload_finished.emit()
+            api = get_ckan_api()
+            try:
+                ds_dict = api.get("package_show",
+                                  id=dataset_id,
+                                  timeout=3)
+                self.upload_finished.emit(ds_dict)
+            except BaseException:
+                self.logger.error(tb.format_exc())
 
     @QtCore.pyqtSlot()
     def update_job_status(self):
         """Update UI with information from self.jobs (UploadJobList)"""
+        # Let everyone know when a job is done
+        for job in self.jobs:
+            if job.state == "done":
+                self.on_upload_finished(job.dataset_id)
+
         if not self.isVisible() or not self.jobs:
+            # Don't update the UI if nobody is looking anyway.
             return
         # disable updates
         self.setUpdatesEnabled(False)
@@ -471,8 +484,6 @@ def update_job_status(self):
                 self.set_label_item(row, 2, status["state"])
                 self.set_label_item(row, 3, job.get_progress_string())
                 self.set_label_item(row, 4, job.get_rate_string())
-                if status["state"] == "done":
-                    self.on_upload_finished(job.dataset_id)
                 self.set_actions_item(row, 5, job)
 
             # spacing (did not work in __init__)

tests/common.py

@@ -192,7 +192,8 @@ def make_upload_task(task_id=True,  # tester may pass `None` to disable
 
 
 def wait_for_job(upload_queue, dataset_id, wait_time=60,
-                 wait_for_resource_metadata=False):
+                 wait_for_resource_metadata=False,
+                 set_job_done=True):
     uq = upload_queue
     uj = uq.get_job(dataset_id)
     # wait for the upload to finish
@@ -210,7 +211,7 @@ def wait_for_job(upload_queue, dataset_id, wait_time=60,
                     if not complete:
                         break
             if complete:
-                if uq.jobs_eternal:
+                if set_job_done and uq.jobs_eternal:
                     # TODO:
                     # We do this manually here. Actually, a better solution
                     # would be to implement a signal-slot type of workflow

tests/test_gui.py

@@ -237,7 +237,13 @@ def test_gui_upload_simple(mw, qtbot):
     assert dlg.dataset_id is not None
 
     common.wait_for_job(upload_queue=mw.panel_upload.jobs,
-                        dataset_id=dlg.dataset_id)
+                        dataset_id=dlg.dataset_id,
+                        set_job_done=False)
+
+    mw.panel_upload.widget_jobs.update_job_status()
+    QtWidgets.QApplication.processEvents(
+        QtCore.QEventLoop.ProcessEventsFlag.AllEvents, 500)
+    assert mw.database.get_dataset_dictionary(dlg.dataset_id)
 
 
 def test_gui_upload_task(mw, qtbot):