NXDRIVE-2889: Display system notification for document review

docs/changes/5.5.0.md

@@ -16,6 +16,11 @@ Release date: `2024-xx-xx`
 
 - [NXDRIVE-2](https://jira.nuxeo.com/browse/NXDRIVE-2):
 
+### Task Management
+
+- [NXDRIVE-2889](https://jira.nuxeo.com/browse/NXDRIVE-2889): Display system notification for document review
+- [NXDRIVE-2899](https://jira.nuxeo.com/browse/NXDRIVE-2899): Display new workflow feature on Features tab
+
 ## GUI
 
 - [NXDRIVE-2900](https://jira.nuxeo.com/browse/NXDRIVE-2900): Update license headers for Nuxeo addons

nxdrive/client/workflow/__init__.py

@@ -0,0 +1,68 @@
+from datetime import datetime, timedelta, timezone
+from logging import getLogger
+from typing import TYPE_CHECKING, Dict, List
+
+from nuxeo.models import Task
+
+from nxdrive.engine.engine import Engine
+
+if TYPE_CHECKING:
+    from ..remote_client import Remote  # noqa
+
+log = getLogger(__name__)
+
+
+class Workflow:
+    """Workflow Management for document Review"""
+
+    def __init__(self, remote: "Remote") -> None:
+        self.remote = remote
+
+    def fetch_document(self, tasks_list: Dict, engine: Engine) -> None:
+        """Fetch document details"""
+        first_task = tasks_list[0]
+        doc_id = first_task.targetDocumentIds[0]["id"]
+        task_id = first_task.id
+
+        response = self.remote.documents.get(doc_id)
+        if response:
+            engine.send_task_notification(task_id, response.path)
+        else:
+            log.error("Failed to fetch document details.")
+
+    def get_pending_tasks(self, engine: Engine, initial_run: bool = True) -> List[Task]:  # type: ignore
+        """Get Tasks for document review"""
+        try:
+            options = {"userId": self.remote.user_id}
+            tasks = self.remote.tasks.get(options)
+
+            if tasks:
+                if not initial_run:
+                    tasks = self.filter_tasks(tasks)
+
+                if tasks:
+                    if len(tasks) > 1:
+                        # Send generic notification for multiple tasks
+                        engine.send_task_notification(
+                            tasks[0].targetDocumentIds[0]["id"], ""
+                        )
+                    else:
+                        # Fetch document data
+                        self.fetch_document(tasks, engine)
+                else:
+                    log.info("No Task for processing...")
+            else:
+                log.info("No Task for processing...")
+        except Exception as exec:
+            log.error(f"Exception occurred while Fetching Tasks: {exec}")
+
+    @staticmethod
+    def filter_tasks(tasks: List[Task]) -> List[Task]:
+        """Filter new tasks created within the last hour"""
+        last_hour = datetime.now(tz=timezone.utc) - timedelta(minutes=60)
+        log.info("Filtering tasks created in the last hour.")
+        return [
+            task
+            for task in tasks
+            if datetime.strptime(task.created, "%Y-%m-%dT%H:%M:%S.%f%z") > last_hour
+        ]

nxdrive/data/i18n/i18n.json

@@ -169,6 +169,7 @@
     "FEATURE_DIRECT_EDIT": "Edit any of document’s content from their Summary tab even if they are not synchronized.",
     "FEATURE_S3": "Improve the speed of your uploads by leveraging the AWS infrastructure. Even enabled, this feature will be effective only for Nuxeo Cloud customers and for Nuxeo servers with S3 Direct Upload addon installed and up-to-date.",
     "FEATURE_SYNCHRONIZATION": "Enable or disable the bidirectional synchronization between the local environment and the Nuxeo Platform.\nA restart is needed to apply changes.",
+    "FEATURE_TASKS_MANAGEMENT": "Handle your tasks from Nuxeo Drive and receive notifications and reminders when a new task is assigned to you.",
     "FEEDBACK_LINK": "Something is missing? Share your feedback here.",
     "FILE_ALREADY_EXISTS": "There is already a file named \"%1\" in  this folder. Do you want to replace it with the one you're moving?",
     "FILE_ALREADY_EXISTS_HEADER": "A duplicate file has been found.",
@@ -287,6 +288,7 @@
     "OTHER": "Other",
     "PASSWORD": "Password",
     "PERSONAL_SPACE": "Personal space",
+    "PENDING_DOCUMENT_REVIEWS": "Awaiting document review %1",
     "PROXY": "Proxy",
     "PROXY_APPLIED": "Proxy settings have been updated",
     "PROXY_CHANGE_SETTINGS": "Proxy",

nxdrive/data/qml/Systray.qml

@@ -152,15 +152,27 @@ Rectangle {
                     }
                 }
 
-                // Icon 2: open remote server's URL
+                // Icon 2: Show pending Task list
+                IconLabel {
+                     icon: MdiFont.Icon.minus
+                    Image {
+                        source: "../icons/tasks.svg"
+                        anchors.fill: parent
+                    }
+                    color: "#FFFFFF"
+                    enabled: feat_tasks_management.enabled
+                    opacity: feat_tasks_management.enabled ? 1.0 : 0.2
+                }
+
+                // Icon 3: open remote server's URL
                 IconLabel {
                     icon: MdiFont.Icon.nuxeo
                     iconColor: secondaryIcon
                     onClicked: api.open_remote_server(accountSelect.getRole("uid"))
                     tooltip: api.get_hostname_from_url(accountSelect.getRole("server_url"))
                 }
 
-                // Icon 3: open local sync root folder
+                // Icon 4: open local sync root folder
                 IconLabel {
                     icon: MdiFont.Icon.folder
                     iconColor: secondaryIcon
@@ -170,7 +182,7 @@ Rectangle {
                     opacity: feat_synchronization.enabled ? 1.0 : 0.5
                 }
 
-                // Icon 4: open the Direct Transfer window
+                // Icon 5: open the Direct Transfer window
                 IconLabel {
                     icon: MdiFont.Icon.directTransfert
                     iconColor: secondaryIcon
@@ -180,7 +192,7 @@ Rectangle {
                     opacity: feat_direct_transfer.enabled ? 1.0 : 0.5
                 }
 
-                // Icon 5: sub-menu
+                // Icon 6: sub-menu
                 IconLabel {
                     id: settingsContainer
                     icon: MdiFont.Icon.dotsVertical

nxdrive/engine/engine.py

@@ -116,6 +116,7 @@
     directTransferNewFolderError = pyqtSignal()
     directTransferNewFolderSuccess = pyqtSignal(str)
     directTransferSessionFinished = pyqtSignal(str, str, str)
+    displayPendingTask = pyqtSignal(str, str, str)
 
     type = "NXDRIVE"
     # Folder locker - LocalFolder processor can prevent
@@ -747,6 +748,24 @@
         }
         return urls[self.force_ui or self.wui]
 
+    def get_task_url(self, remote_ref: str, /, *, edit: bool = False) -> str:
+        """
+        Build the task's URL based on the server's UI.
+        Default is Web-UI.  In case of unknown UI, use the default value.
+        :param remote_ref: The task remote reference (UID) of the
+            task we want to show metadata.
+        :param edit: Show the metadata edit page instead of the task.
+        :return: The complete URL.
+        """
+        repo = self.remote.client.repository
+        page = ("view_documents", "view_drive_metadata")[edit]
+
+        urls = {
+            "jsf": f"{self.server_url}tasks/{repo}/{remote_ref}/{page}",
+            "web": f"{self.server_url}ui#!/tasks/{remote_ref}",
+        }
+        return urls[self.force_ui or self.wui]
+
     def is_syncing(self) -> bool:
         return self._sync_started
 
@@ -1581,6 +1600,9 @@
 
         return full_name
 
+    def send_task_notification(self, task_id: str, remote_path: str, /) -> None:
+        self.displayPendingTask.emit(self.uid, task_id, remote_path)
+
 
 @dataclass
 class ServerBindingSettings:

nxdrive/feature.py

@@ -31,6 +31,7 @@
     direct_edit=True,
     direct_transfer=True,
     document_type_selection=False,
+    tasks_management=False,
     s3=False,
 )
 

nxdrive/gui/api.py

@@ -576,7 +576,7 @@
     def _balance_percents(self, result: Dict[str, float], /) -> Dict[str, float]:
         """Return an altered version of the dict in which no value is under a minimum threshold."""
 
-        result = {k: v for k, v in sorted(result.items(), key=lambda item: item[1])}
+        result = dict(sorted(result.items(), key=lambda item: item[1]))
         keys = list(result)
         min_threshold = 10
         data = 0.0
@@ -1108,3 +1108,16 @@
         """Return the URL to a remote document based on its reference."""
         engine = self._manager.engines.get(uid)
         return engine.get_metadata_url(remote_ref) if engine else ""
+
+    @pyqtSlot(str, str, str)
+    def display_pending_task(
+        self, uid: str, remote_ref: str, remote_path: str, /
+    ) -> None:
+        log.info(f"Should open remote document ({remote_path!r})")
+        try:
+            engine = self._manager.engines.get(uid)
+            if engine:
+                url = engine.get_task_url(remote_ref)
+                engine.open_remote(url=url)
+        except Exception as exec:
+            log.exception(f"Remote task cannot be opened: {exec}")

nxdrive/gui/application.py

@@ -11,6 +11,8 @@
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
 from urllib.parse import unquote_plus, urlparse
 
+from nxdrive.client.workflow import Workflow
+
 from ..behavior import Behavior
 from ..constants import (
     APP_NAME,
@@ -216,6 +218,8 @@
         if MAC:
             self._setup_notification_center()
 
+        # Initiate workflow when drive starts if tasks managemnt feature is enable
+        self.workflow = self.init_workflow()
         # Application update
         self.manager.updater.appUpdated.connect(self.quit)
         self.manager.updater.serverIncompatible.connect(self._server_incompatible)
@@ -273,6 +277,7 @@
         self.document_type_selection_feature_model = FeatureModel(
             Feature.document_type_selection
         )
+        self.tasks_management_feature_model = FeatureModel(Feature.tasks_management)
         self.conflicts_model = FileModel(self.translate)
         self.errors_model = FileModel(self.translate)
         self.engine_model = EngineModel(self)
@@ -373,6 +378,15 @@
 
         self.manager.featureUpdate.connect(self._update_feature_state)
 
+    def init_workflow(self) -> Workflow:
+        if not self.manager.engines:
+            return
+        for engine in self.manager.engines.copy().values():
+            self.workflow = Workflow(engine.remote)
+            if Feature.tasks_management:
+                self.workflow.get_pending_tasks(engine)
+        return self.workflow
+
     def _update_feature_state(self, name: str, value: bool, /) -> None:
         """Check if the feature model exists from *name* then update it with *value*."""
         feature = getattr(self, f"{name}_feature_model", None)
@@ -384,6 +398,9 @@
         if feature.restart_needed:
             self.manager.restartNeeded.emit()
 
+        if feature.enabled and feature == self.tasks_management_feature_model:
+            self.init_workflow()
+
     def _center_on_screen(self, window: QQuickView, /) -> None:
         """Display and center the window on the screen."""
         # Display the window
@@ -471,6 +488,9 @@
         context.setContextProperty(
             "feat_document_type_selection", self.document_type_selection_feature_model
         )
+        context.setContextProperty(
+            "feat_tasks_management", self.tasks_management_feature_model
+        )
         context.setContextProperty(
             "feat_synchronization", self.synchronization_feature_model
         )

nxdrive/manager.py

@@ -52,7 +52,12 @@
 from .objects import Binder, EngineDef, Metrics, Session
 from .options import DEFAULT_LOG_LEVEL_FILE, Options
 from .osi import AbstractOSIntegration
-from .poll_workers import DatabaseBackupWorker, ServerOptionsUpdater, SyncAndQuitWorker
+from .poll_workers import (
+    DatabaseBackupWorker,
+    ServerOptionsUpdater,
+    SyncAndQuitWorker,
+    WorkflowWorker,
+)
 from .qt.imports import QT_VERSION_STR, QObject, pyqtSignal, pyqtSlot
 from .updater import updater
 from .updater.constants import Login
@@ -217,6 +222,9 @@ def __init__(self, home: Path, /) -> None:
         # Create the server's configuration getter verification thread
         self._create_db_backup_worker()
 
+        # Create the workflow worker if workflow_managerment feature is enable
+        self._create_workflow_worker()
+
         # Setup analytics tracker
         self.tracker = self.create_tracker()
 
@@ -405,6 +413,11 @@ def _create_db_backup_worker(self) -> None:
         if self.db_backup_worker:
             self.started.connect(self.db_backup_worker.thread.start)
 
+    def _create_workflow_worker(self) -> None:
+        self.workflow_worker = WorkflowWorker(self)
+        if self.workflow_worker:
+            self.started.connect(self.workflow_worker.thread.start)
+
     @if_frozen
     def _create_extension_listener(self) -> None:
         self._extension_listener = self.osi.get_extension_listener()

nxdrive/notification.py

@@ -180,7 +180,6 @@
                 else:
                     self.dao.update_notification(notification)
             self._notifications[notification.uid] = notification
-
         self.newNotification.emit(notification)
 
     def trigger_notification(self, uid: str, /) -> None:
@@ -520,6 +519,32 @@
         )
 
 
+class DisplayPendingTask(Notification):
+    """Display a notification for pending tasks"""
+
+    def __init__(self, engine_uid: str, remote_ref: str, remote_path: str, /) -> None:
+        values = [remote_path]
+        super().__init__(
+            uid="PENDING_DOCUMENT_REVIEWS",
+            title="Review Document",
+            description=Translator.get("PENDING_DOCUMENT_REVIEWS", values=values),
+            level=Notification.LEVEL_INFO,
+            flags=(
+                Notification.FLAG_PERSISTENT
+                | Notification.FLAG_BUBBLE
+                | Notification.FLAG_ACTIONABLE
+                | Notification.FLAG_DISCARD_ON_TRIGGER
+                | Notification.FLAG_REMOVE_ON_DISCARD
+            ),
+            action="display_pending_task",
+            action_args=(
+                engine_uid,
+                remote_ref,
+                remote_path,
+            ),
+        )
+
+
 class DefaultNotificationService(NotificationService):
     def init_signals(self) -> None:
         self._manager.initEngine.connect(self._connect_engine)
@@ -539,6 +564,7 @@
         engine.directTransferSessionFinished.connect(
             self._direct_transfer_session_finshed
         )
+        engine.displayPendingTask.connect(self._display_pending_task)
 
     def _direct_transfer_error(self, file: Path, /) -> None:
         """Display a notification when a Direct Transfer is in error."""
@@ -635,3 +661,8 @@
         engine_uid = self.sender().uid
         notif = InvalidCredentialNotification(engine_uid)
         self.send_notification(notif)
+
+    def _display_pending_task(
+        self, engine_uid: str, remote_ref: str, remote_path: str, /
+    ) -> None:
+        self.send_notification(DisplayPendingTask(engine_uid, remote_ref, remote_path))