NXDRIVE-2309: [Direct Transfer] Improve session counts computing on cancellations

This should prevent having a finished session having more uploaded items than
it was supposed to send.

Author: Mickaël Schoentgen

docs/changes/4.5.0.md

@@ -145,21 +145,20 @@ Release date: `2020-xx-xx`
 - Changed `DarwinIntegration.unregister_startup()` return type from `bool` to `None`
 - Removed `mime_type` keyword argument from `DirectTransferUploader.upload()`
 - Added `Engine.cancel_session()`
-- Added `Engine.decrease_session_planned_items()`
 - Added `Engine.resume_session()`
 - Added `Engine.send_metric()`
 - Removed `Engine.directTranferItemsCount`
 - Added `description` keyword argument to `EngineDAO.create_session()`
 - Added `engine_uid` keyword argument to `EngineDAO.create_session()`
 - Added `EngineDAO.change_session_status()`
-- Added `EngineDAO.decrease_session_planned_items()`
 - Added `EngineDAO.get_active_sessions_raw()`
 - Added `chunked` keyword argument to `EngineDAO.get_dt_uploads_raw()`
 - Added `EngineDAO.save_dt_upload()`
 - Added `table` keyword argument to `EngineDAO.get_count()`
 - Added `EngineDAO.get_completed_sessions_raw()`
 - Added `EngineDAO.pause_session()`
 - Added `EngineDAO.sessionUpdated`
+- Removed `EngineDao.decrease_session_total()`. Use `decrease_session_counts()` instead.
 - Changed `Manager.set_auto_start()` return type from `bool` to `None`
 - Added `Options.disallowed_types_for_dt`
 - Removed `mime_type` keyword argument from  `Remote.stream_file()`

nxdrive/engine/dao/sqlite.py

@@ -2528,9 +2528,9 @@ def change_session_status(self, uid: int, status: TransferStatus) -> None:
             )
             self.sessionUpdated.emit()
 
-    def decrease_session_total(self, uid: int) -> Optional[Session]:
+    def decrease_session_counts(self, uid: int) -> Optional[Session]:
         """
-        Decrease the Session *total_items* count.
+        Decrease the Session *total_items* and *planned_items* counts.
         Update the status if all files are uploaded.
         """
         with self.lock:
@@ -2539,37 +2539,34 @@ def decrease_session_total(self, uid: int) -> Optional[Session]:
                 return None
 
             session.total_items = max(0, session.total_items - 1)
+            session.planned_items = max(0, session.planned_items - 1)
             if session.uploaded_items == session.total_items:
                 session.status = (
                     TransferStatus.DONE
                     if session.total_items
                     else TransferStatus.CANCELLED
                 )
-                sql = "UPDATE Sessions SET total = ?, status = ?, completed_on = CURRENT_TIMESTAMP WHERE uid = ?"
+                sql = (
+                    "UPDATE Sessions SET"
+                    " planned_items = ?, total = ?, status = ?, completed_on = CURRENT_TIMESTAMP"
+                    " WHERE uid = ?"
+                )
             else:
-                sql = "UPDATE Sessions SET total = ?, status = ? WHERE uid = ?"
+                sql = "UPDATE Sessions SET planned_items = ?, total = ?, status = ? WHERE uid = ?"
 
             cursor = self._get_write_connection().cursor()
             cursor.execute(
-                sql, (session.total_items, session.status.value, session.uid)
+                sql,
+                (
+                    session.planned_items,
+                    session.total_items,
+                    session.status.value,
+                    session.uid,
+                ),
             )
             self.sessionUpdated.emit()
             return session
 
-    def decrease_session_planned_items(self, uid: int) -> None:
-        """Decrease the Session *planned_items* count."""
-        with self.lock:
-            session = self.get_session(uid)
-            if not session:
-                return None
-
-            session.planned_items = max(0, session.planned_items - 1)
-            cursor = self._get_write_connection().cursor()
-            cursor.execute(
-                "UPDATE Sessions SET planned_items = ? WHERE uid = ?",
-                (session.planned_items, session.uid),
-            )
-
     def get_downloads_with_status(self, status: TransferStatus) -> List[Download]:
         return [d for d in self.get_downloads() if d.status == status]
 

nxdrive/engine/engine.py

@@ -690,16 +690,6 @@ def _manage_staled_transfers(self) -> None:
                     dao.remove_transfer(nature, transfer.path)
                     log.info(f"Removed staled {transfer}")
 
-    def decrease_session_planned_items(self, transfer_uid: int) -> None:
-        """Decrease the linked session planned_items count."""
-        upload = self.dao.get_dt_upload(uid=transfer_uid)
-        if not upload:
-            return
-        doc_pair = self.dao.get_state_from_local(upload.path)
-        if not doc_pair:
-            return
-        self.dao.decrease_session_planned_items(doc_pair.session)
-
     def cancel_upload(self, transfer_uid: int) -> None:
         """Cancel an ongoing Direct Transfer upload and clean the database."""
         log.debug(f"Canceling transfer {transfer_uid}")
@@ -724,7 +714,7 @@ def cancel_upload(self, transfer_uid: int) -> None:
         self.dao.remove_transfer("upload", upload.path, is_direct_transfer=True)
 
         self.dao.remove_state(doc_pair)
-        session = self.dao.decrease_session_total(doc_pair.session)
+        session = self.dao.decrease_session_counts(doc_pair.session)
         self.handle_session_status(session)
 
     def cancel_session(self, uid: int) -> None:

nxdrive/engine/processor.py

@@ -563,7 +563,7 @@ def _direct_transfer_end(
             ):
                 session = self.dao.update_session(doc_pair.session)
             elif cancelled_transfer:
-                session = self.dao.decrease_session_total(doc_pair.session)
+                session = self.dao.decrease_session_counts(doc_pair.session)
             self.engine.handle_session_status(session)
 
         # For analytics

nxdrive/gui/application.py

@@ -870,7 +870,6 @@ def confirm_cancel_transfer(
             engine = self.manager.engines.get(engine_uid)
             if not engine:
                 return
-            engine.decrease_session_planned_items(transfer_uid)
             engine.cancel_upload(transfer_uid)
 
     @pyqtSlot(str, int, str, int, result=bool)