Merge pull request #142 from pneumaticapp/backend/templates/44593__noify_performers

44593 backend [ notifications ] Notify All' type notifications

Author: pneumojoseph

backend/docker-compose.yml

@@ -94,6 +94,20 @@ services:
       CIO_WEBHOOK_API_VERSION: ${CIO_WEBHOOK_API_VERSION:-}
       CIO_WEBHOOK_API_KEY: ${CIO_WEBHOOK_API_KEY:-}
       CIO_TRANSACTIONAL_API_KEY: ${CIO_TRANSACTIONAL_API_KEY:-}
+      CIO_TEMPLATE__RESET_PASSWORD: ${CIO_TEMPLATE__RESET_PASSWORD:-}
+      CIO_TEMPLATE__USER_DEACTIVATED: ${CIO_TEMPLATE__USER_DEACTIVATED:-}
+      CIO_TEMPLATE__NEW_TASK: ${CIO_TEMPLATE__NEW_TASK:-}
+      CIO_TEMPLATE__TASK_RETURNED: ${CIO_TEMPLATE__TASK_RETURNED:-}
+      CIO_TEMPLATE__ACCOUNT_VERIFICATION: ${CIO_TEMPLATE__ACCOUNT_VERIFICATION:-}
+      CIO_TEMPLATE__WORKFLOWS_DIGEST: ${CIO_TEMPLATE__WORKFLOWS_DIGEST:-}
+      CIO_TEMPLATE__TASKS_DIGEST: ${CIO_TEMPLATE__TASKS_DIGEST:-}
+      CIO_TEMPLATE__USER_TRANSFER: ${CIO_TEMPLATE__USER_TRANSFER:-}
+      CIO_TEMPLATE__UNREAD_NOTIFICATIONS: ${CIO_TEMPLATE__UNREAD_NOTIFICATIONS:-}
+      CIO_TEMPLATE__GUEST_NEW_TASK: ${CIO_TEMPLATE__GUEST_NEW_TASK:-}
+      CIO_TEMPLATE__OVERDUE_TASK: ${CIO_TEMPLATE__OVERDUE_TASK:-}
+      CIO_TEMPLATE__MENTION: ${CIO_TEMPLATE__MENTION:-}
+      CIO_TEMPLATE__TASK_REMINDER: ${CIO_TEMPLATE__TASK_REMINDER:-}
+      CIO_TEMPLATE__COMPLETE_WORKFLOW: ${CIO_TEMPLATE__COMPLETE_WORKFLOW:-}
       EMAIL_HOST: ${EMAIL_HOST:-}
       EMAIL_PORT: ${EMAIL_PORT:-}
       EMAIL_HOST_USER: ${EMAIL_HOST_USER:-}
@@ -175,6 +189,20 @@ services:
       CIO_WEBHOOK_API_VERSION: ${CIO_WEBHOOK_API_VERSION:-}
       CIO_WEBHOOK_API_KEY: ${CIO_WEBHOOK_API_KEY:-}
       CIO_TRANSACTIONAL_API_KEY: ${CIO_TRANSACTIONAL_API_KEY:-}
+      CIO_TEMPLATE__RESET_PASSWORD: ${CIO_TEMPLATE__RESET_PASSWORD:-}
+      CIO_TEMPLATE__USER_DEACTIVATED: ${CIO_TEMPLATE__USER_DEACTIVATED:-}
+      CIO_TEMPLATE__NEW_TASK: ${CIO_TEMPLATE__NEW_TASK:-}
+      CIO_TEMPLATE__TASK_RETURNED: ${CIO_TEMPLATE__TASK_RETURNED:-}
+      CIO_TEMPLATE__ACCOUNT_VERIFICATION: ${CIO_TEMPLATE__ACCOUNT_VERIFICATION:-}
+      CIO_TEMPLATE__WORKFLOWS_DIGEST: ${CIO_TEMPLATE__WORKFLOWS_DIGEST:-}
+      CIO_TEMPLATE__TASKS_DIGEST: ${CIO_TEMPLATE__TASKS_DIGEST:-}
+      CIO_TEMPLATE__USER_TRANSFER: ${CIO_TEMPLATE__USER_TRANSFER:-}
+      CIO_TEMPLATE__UNREAD_NOTIFICATIONS: ${CIO_TEMPLATE__UNREAD_NOTIFICATIONS:-}
+      CIO_TEMPLATE__GUEST_NEW_TASK: ${CIO_TEMPLATE__GUEST_NEW_TASK:-}
+      CIO_TEMPLATE__OVERDUE_TASK: ${CIO_TEMPLATE__OVERDUE_TASK:-}
+      CIO_TEMPLATE__MENTION: ${CIO_TEMPLATE__MENTION:-}
+      CIO_TEMPLATE__TASK_REMINDER: ${CIO_TEMPLATE__TASK_REMINDER:-}
+      CIO_TEMPLATE__COMPLETE_WORKFLOW: ${CIO_TEMPLATE__COMPLETE_WORKFLOW:-}
       EMAIL_HOST: ${EMAIL_HOST:-}
       EMAIL_PORT: ${EMAIL_PORT:-}
       EMAIL_HOST_USER: ${EMAIL_HOST_USER:-}

backend/src/accounts/enums.py

@@ -3,17 +3,21 @@
 
 class NotificationType:
 
+    # TODO Union with the NotificationMethod
+
     SYSTEM = 'system'
     COMMENT = 'comment'
     MENTION = 'mention'
     URGENT = 'urgent'
     NOT_URGENT = 'not_urgent'
     OVERDUE_TASK = 'overdue_task'
+    REMINDER_TASK = 'reminder_task'
     DELAY_WORKFLOW = 'snooze_workflow'
     RESUME_WORKFLOW = 'resume_workflow'
     DUE_DATE_CHANGED = 'due_date_changed'
     REACTION = 'reaction'
     COMPLETE_TASK = 'complete_task'
+    COMPLETE_WORKFLOW = 'complete_workflow'
 
     URGENT_TYPES = (
         URGENT,
@@ -27,11 +31,13 @@ class NotificationType:
         (URGENT, 'urgent'),
         (NOT_URGENT, 'not urgent'),
         (OVERDUE_TASK, 'overdue task'),
+        (REMINDER_TASK, 'reminder task'),
         (DELAY_WORKFLOW, 'snooze workflow'),
         (RESUME_WORKFLOW, 'resume workflow'),
         (DUE_DATE_CHANGED, 'due date changed'),
         (REACTION, 'reaction'),
         (COMPLETE_TASK, 'complete task'),
+        (COMPLETE_WORKFLOW, 'complete workflow'),
     )
 
 

backend/src/accounts/models.py

@@ -555,6 +555,8 @@ class Notification(
     AccountBaseMixin,
 ):
 
+    # TODO Move to the "notifications" module
+
     author = models.ForeignKey(
         User,
         on_delete=models.CASCADE,

backend/src/accounts/tokens.py

@@ -112,7 +112,7 @@ class UnsubscribeEmailToken(BaseToken):
     lifetime = timedelta(days=settings.UNSUBSCRIBE_TOKEN_IN_DAYS)
 
     @classmethod
-    def create_token(cls, user_id: int, email_type: MailoutType):
+    def create_token(cls, user_id: int, email_type: MailoutType.LITERALS):
         token = cls.for_user_id(user_id)
         token.payload.update({'email_type': MailoutType.MAP[email_type]})
         return token

backend/src/analysis/enums.py

@@ -1,3 +1,4 @@
+from typing_extensions import Literal
 
 
 class MailoutType:
@@ -35,3 +36,13 @@ class MailoutType:
     CUSTOMERIO_TYPES = {
         NEWSLETTER,
     }
+
+    LITERALS = Literal[
+        NEWSLETTER,
+        OFFER,
+        COMMENTS,
+        NEW_TASK,
+        WF_DIGEST,
+        TASKS_DIGEST,
+        COMPLETE_TASK,
+    ]

backend/src/generics/mixins/queries.py

@@ -94,3 +94,26 @@ def dereferenced_performers():
                 AND ptp.user_id = %(user_id)s
               )
         """
+
+    @staticmethod
+    def all_dereferenced_performers():
+
+        """ Convert group performers to users and return it (for any user) """
+
+        return f"""
+            SELECT DISTINCT ON (user_id, ptp.task_id)
+              (
+                CASE
+                  WHEN ptp.type = '{PerformerType.GROUP}' THEN g.user_id
+                  ELSE ptp.user_id
+                END
+              ) AS user_id,
+              ptp.task_id,
+              ptp.is_completed
+            FROM processes_taskperformer ptp
+            LEFT JOIN accounts_usergroup_users g
+              ON g.usergroup_id = ptp.group_id
+            WHERE
+              ptp.is_deleted IS FALSE
+              AND ptp.directly_status != '{DirectlyStatus.DELETED}'
+        """

backend/src/notifications/clients/smtp.py

@@ -12,6 +12,7 @@
 
 class SMTPEmailClient(EmailClient):
 
+    DEFAULT_TEMPLATE_WORKFLOWS = 'workflows.html'
     DEFAULT_TEMPLATE_TASKS = 'tasks.html'
     DEFAULT_TEMPLATE_AUTH = 'auth.html'
     DEFAULT_TEMPLATE_DIGESTS = 'digests.html'
@@ -30,6 +31,8 @@ class SMTPEmailClient(EmailClient):
         EmailType.WORKFLOWS_DIGEST: DEFAULT_TEMPLATE_DIGESTS,
         EmailType.TASKS_DIGEST: DEFAULT_TEMPLATE_DIGESTS,
         EmailType.INVITE: DEFAULT_TEMPLATE_AUTH,
+        EmailType.COMPLETE_WORKFLOW: DEFAULT_TEMPLATE_WORKFLOWS,
+        EmailType.TASK_REMINDER: DEFAULT_TEMPLATE_AUTH,
     }
 
     def __init__(self, account_id: int):
@@ -127,6 +130,7 @@ def _get_default_subject(
 
         subjects = {
             EmailType.NEW_TASK: 'New Task Assigned',
+            EmailType.INVITE: 'Join your team',
             EmailType.TASK_RETURNED: 'Task Returned',
             EmailType.OVERDUE_TASK: 'Task Overdue',
             EmailType.GUEST_NEW_TASK: 'New Task Assigned',
@@ -140,15 +144,18 @@ def _get_default_subject(
             EmailType.UNREAD_NOTIFICATIONS: (
                 'You have unread notifications on Pneumatic'
             ),
-            EmailType.INVITE: 'Join your team 👥',
+            EmailType.COMPLETE_WORKFLOW: 'Workflow completed',
+            EmailType.TASK_REMINDER: (
+                'Reminder: you have unfinished tasks in Pneumatic'
+            ),
         }
 
         return subjects.get(template_code, f'Pneumatic - {template_code}')
 
     def _get_fallback_template(
-            self,
-            template_code: EmailType.LITERALS,
-            message_data: Dict[str, Any],
+        self,
+        template_code: EmailType.LITERALS,
+        message_data: Dict[str, Any],
     ) -> Tuple[str, str]:
         """Get simple fallback template when no file template exists."""
         subject = self._get_default_subject(template_code, message_data)

backend/src/notifications/enums.py

@@ -9,13 +9,15 @@ class NotificationMethod:
     new_task_websocket = 'new_task_websocket'
     returned_task = 'returned_task'
     removed_task = 'removed_task'
+    task_reminder = 'task_reminder'
     overdue_task = 'overdue_task'
     complete_task = 'complete_task'
     mention = 'mention'
     comment = 'comment'
     delay_workflow = 'delay_workflow'
     guest_new_task = 'guest_new_task'
     resume_workflow = 'resume_workflow'
+    complete_workflow = 'complete_workflow'
     unread_notifications = 'unread_notifications'
     due_date_changed = 'due_date_changed'
     system = 'system'
@@ -42,13 +44,15 @@ class NotificationMethod:
         new_task_websocket,
         returned_task,
         removed_task,
+        task_reminder,
         overdue_task,
         complete_task,
         mention,
         comment,
         delay_workflow,
         guest_new_task,
         resume_workflow,
+        complete_workflow,
         unread_notifications,
         due_date_changed,
         system,
@@ -89,6 +93,7 @@ class EmailType:
     USER_DEACTIVATED = 'user_deactivated'
     NEW_TASK = 'new_task'
     TASK_RETURNED = 'task_returned'
+    TASK_REMINDER = 'task_reminder'
     ACCOUNT_VERIFICATION = 'account_verification'
     WORKFLOWS_DIGEST = 'digest'
     TASKS_DIGEST = 'tasks_digest'
@@ -98,12 +103,14 @@ class EmailType:
     OVERDUE_TASK = 'overdue_task'
     MENTION = 'mention'
     INVITE = 'invite'
+    COMPLETE_WORKFLOW = 'complete_workflow'
 
     LITERALS = Literal[
         RESET_PASSWORD,
         USER_DEACTIVATED,
         NEW_TASK,
         TASK_RETURNED,
+        TASK_REMINDER,
         ACCOUNT_VERIFICATION,
         WORKFLOWS_DIGEST,
         TASKS_DIGEST,
@@ -113,13 +120,15 @@ class EmailType:
         OVERDUE_TASK,
         MENTION,
         INVITE,
+        COMPLETE_WORKFLOW,
     ]
 
     CHOICES = [
         (RESET_PASSWORD, 'Reset Password'),
         (USER_DEACTIVATED, 'User Deactivated'),
         (NEW_TASK, 'New Task'),
         (TASK_RETURNED, 'Task Returned'),
+        (TASK_REMINDER, 'Task Reminder'),
         (ACCOUNT_VERIFICATION, 'Account Verification'),
         (WORKFLOWS_DIGEST, 'Workflows Digest'),
         (TASKS_DIGEST, 'Tasks Digest'),
@@ -129,6 +138,7 @@ class EmailType:
         (OVERDUE_TASK, 'Overdue Task'),
         (MENTION, 'Mention'),
         (INVITE, 'Invite'),
+        (COMPLETE_WORKFLOW, 'Complete Workflow'),
     ]
 
 
@@ -137,6 +147,7 @@ class EmailType:
     EmailType.USER_DEACTIVATED: env.get('CIO_TEMPLATE__USER_DEACTIVATED'),
     EmailType.NEW_TASK: env.get('CIO_TEMPLATE__NEW_TASK'),
     EmailType.TASK_RETURNED: env.get('CIO_TEMPLATE__TASK_RETURNED'),
+    EmailType.TASK_REMINDER: env.get('CIO_TEMPLATE__TASK_REMINDER'),
     EmailType.ACCOUNT_VERIFICATION: env.get(
         'CIO_TEMPLATE__ACCOUNT_VERIFICATION',
     ),
@@ -149,6 +160,7 @@ class EmailType:
     EmailType.GUEST_NEW_TASK: env.get('CIO_TEMPLATE__GUEST_NEW_TASK'),
     EmailType.OVERDUE_TASK: env.get('CIO_TEMPLATE__OVERDUE_TASK'),
     EmailType.MENTION: env.get('CIO_TEMPLATE__MENTION'),
+    EmailType.COMPLETE_WORKFLOW: env.get('CIO_TEMPLATE__COMPLETE_WORKFLOW'),
 }
 
 email_titles = {
@@ -169,4 +181,8 @@ class EmailType:
     NotificationMethod.invite: (
         "✅ You've been invited to join your team in Pneumatic"
     ),
+    NotificationMethod.complete_workflow: 'Workflow completed',
+    NotificationMethod.task_reminder: (
+        'Reminder: you have unfinished tasks in Pneumatic'
+    ),
 }

backend/src/notifications/messages.py

@@ -26,3 +26,10 @@
 MSG_NF_0018 = _('Send workflows digest')
 MSG_NF_0019 = _('Send tasks digest')
 MSG_NF_0020 = _('Join your team')
+MSG_NF_0021 = _('Workflow was completed')
+MSG_NF_0022 = _('Reminder')
+MSG_NF_0023 = _('You have unfinished task in Pneumatic')
+MSG_NF_0024 = lambda count: format_lazy(
+    _('You have {count} unfinished tasks in Pneumatic'),
+    count=count,
+)

backend/src/notifications/queries.py

@@ -2,7 +2,9 @@
 
 from django.contrib.auth import get_user_model
 
-from src.accounts.enums import NotificationType
+from src.accounts.enums import NotificationType, UserStatus
+from src.generics.mixins.queries import DereferencedPerformersMixin
+from src.notifications.enums import NotificationMethod
 from src.processes.enums import (
     DirectlyStatus,
     TaskStatus,
@@ -17,13 +19,6 @@
 
 class UsersWithOverdueTaskQuery(SqlQueryObject):
 
-    def __init__(self):
-        self.params = {
-            'workflow_status': WorkflowStatus.RUNNING,
-            'directly_status': DirectlyStatus.DELETED,
-            'notification_type': NotificationType.OVERDUE_TASK,
-        }
-
     def get_sql(self) -> Tuple[str, dict]:
         return f"""
         SELECT DISTINCT ON (user_id, task_id)
@@ -78,17 +73,60 @@ def get_sql(self) -> Tuple[str, dict]:
             LEFT JOIN accounts_notification an
               ON an.task_id = pt.id
               AND an.user_id = ptp.user_id
-              AND an.type = %(notification_type)s
+              AND an.type = '{NotificationType.OVERDUE_TASK}'
             WHERE pt.is_deleted is FALSE
-              AND pw.status = %(workflow_status)s
+              AND pw.status = '{WorkflowStatus.RUNNING}'
               AND pt.due_date IS NOT NULL
               AND pt.due_date <= NOW()
               AND ptp.is_completed IS FALSE
-              AND ptp.directly_status != %(directly_status)s
+              AND ptp.directly_status != '{DirectlyStatus.DELETED}'
+              AND au.status = '{UserStatus.ACTIVE}'
         ) result INNER JOIN accounts_user au
           ON au.id = result.workflow_starter_id
         INNER JOIN accounts_account aa
           ON aa.id = au.account_id
         WHERE notification is NULL
         ORDER BY user_id, task_id, account_id
-        """, self.params
+        """, {}
+
+
+class UsersWithRemainderTaskQuery(SqlQueryObject, DereferencedPerformersMixin):
+
+    def get_sql(self) -> Tuple[str, dict]:
+        result = f"""
+        SELECT
+          au.id AS user_id,
+          au.first_name AS user_first_name,
+          au.email AS user_email,
+          au.type AS user_type,
+          MIN(pt.id) AS task_id,
+          aa.id AS account_id,
+          aa.logo_lg,
+          aa.log_api_requests AS logging,
+          '{NotificationMethod.task_reminder}' AS method_name,
+          TRUE as sync,
+          COUNT(pt.id) AS count
+        FROM processes_workflow pw
+          INNER JOIN processes_task pt
+            ON pt.workflow_id = pw.id
+        INNER JOIN (
+          {self.all_dereferenced_performers()}
+        ) dereferenced_performers
+            ON pt.id = dereferenced_performers.task_id
+          INNER JOIN accounts_user au
+            ON au.id = dereferenced_performers.user_id
+          INNER JOIN accounts_account aa
+            ON au.account_id = aa.id
+        WHERE
+          pw.is_deleted = FALSE
+          AND pw.status = '{WorkflowStatus.RUNNING}'
+          AND pw.reminder_notification = TRUE
+          AND pw.is_deleted = FALSE
+          AND pt.is_deleted = FALSE
+          AND pt.status = '{TaskStatus.ACTIVE}'
+          AND dereferenced_performers.is_completed IS FALSE
+          AND au.status = '{UserStatus.ACTIVE}'
+        GROUP BY au.id, aa.id
+        ORDER BY au.id
+        """
+        return result, {}