feat(notifications): send notifications to admins when an event is autocancelled

- add new model for adminnotifications
- setup socketio for real time notifications
- add query to get all notifications
- add mutation to change the status of notification

[Delivers CON-71]

Author: codinger41

.circleci/config.yml

@@ -191,7 +191,7 @@ jobs:
             ./cc-test-reporter before-build
             . venv/bin/activate
             coverage combine parallel-coverage/ 
-            coverage xml
+            coverage xml -i
             coverage report
             ./cc-test-reporter format-coverage -o ./.coverage -t coverage.py
             ./cc-test-reporter upload-coverage -i .coverage

.codeclimate.yml

@@ -2,4 +2,7 @@ version: "2"
 exclude_patterns:
   - "helpers/auth/authentication.py"
   - "helpers/calendar/events.py"
-  - "alembic/"
+  - "alembic/"
+  - "admin_notifications/__init__.py"
+  - "admin_notifications/helpers/__init__.py"
+  - "admin_notifications/helpers/notification_templates.py"

.coveragerc

@@ -1,11 +1,23 @@
-from flask_socketio import send, emit
 from admin_notifications.models import AdminNotification
-from manage import socketio
+from api.location.models import Location
+from datetime import datetime
 import celery
 
 
-@celery.task(name="create-notification")
+def update_notification(notification_id):
+    notification = AdminNotification.query.filter_by(id=notification_id).first()
+    notification.date_received = datetime.now()
+    notification.save()
+
+
+@celery.task
 def create_notification(title, message, location_id):
+    """
+    Create notifications in the database and emit them to the client
+    """
+    from manage import socketio
+    location = Location.query.filter_by(id=location_id).first()
+    location_name = location.name
     notification = AdminNotification(
         title=title,
         message=message,
@@ -14,4 +26,9 @@ def create_notification(title, message, location_id):
     )
     notification.save()
     new_notification = {"title": title, "message": message}
-    return socketio.emit('notification', {'notification': new_notification}, broadcast=True)
+    return socketio.emit(
+            f"notifications-{location_name}",
+            {'notification': new_notification},
+            broadcast=True,
+            callback=update_notification(notification.id)
+        )

notifications/__init__.py renamed to admin_notifications/__init__.py

@@ -0,0 +1,6 @@
+def event_auto_cancelled_notification(event_name, room_name):
+    return {
+        "title": "Event Auto cancelled.",
+        "message": f"An event {event_name} in {room_name} \
+has been auto cancelled."
+    }

notifications/helpers/__init__.py renamed to admin_notifications/helpers/__init__.py

@@ -15,4 +15,5 @@ class AdminNotification(Base, Utility):
     location_id = Column(
         Integer,
         ForeignKey('locations.id', ondelete="CASCADE"),
-        nullable=True)
+        nullable=True
+    )

admin_notifications/helpers/create_notification.py

@@ -0,0 +1,67 @@
+import graphene
+from graphene_sqlalchemy import SQLAlchemyObjectType
+from graphql import GraphQLError
+from helpers.auth.authentication import Auth
+from datetime import datetime
+from admin_notifications.models import AdminNotification as \
+    AdminNotificationModel
+
+
+class AdminNotifications(SQLAlchemyObjectType):
+    """
+        Returns the admin_notificationspayload
+    """
+    class Meta:
+        model = AdminNotificationModel
+
+
+class NotificationsList(graphene.ObjectType):
+    """
+        Class to return the types for Admin notifications
+        \n- rooms: The rooms data
+    """
+    notifications = graphene.List(AdminNotifications)
+
+
+class Query(graphene.ObjectType):
+    all_unread_notifications = graphene.Field(
+        NotificationsList,
+        description="Returns a list of admin notifications"
+    )
+
+    @Auth.user_roles('Admin')
+    def resolve_all_unread_notifications(self, info):
+        query = AdminNotifications.get_query(info)
+        notifications = query.filter(
+            AdminNotificationModel.status == "unread").all()
+        return NotificationsList(notifications=notifications)
+
+
+class UpdateNotificationStatus(graphene.Mutation):
+    """
+        Class to update the status of a notification
+    """
+
+    class Arguments:
+        notification_id = graphene.Int(required=True)
+    notification = graphene.Field(AdminNotifications)
+
+    @Auth.user_roles('Admin')
+    def mutate(self, info, notification_id):
+        query = AdminNotifications.get_query(info)
+        unread_notifications = query.filter(
+            AdminNotificationModel.status == "unread")
+        notification = unread_notifications.filter(
+            AdminNotificationModel.id == notification_id).first()
+        if not notification:
+            raise GraphQLError("Notification is already read or not found.")
+        notification.status = "read"
+        notification.date_read = datetime.now()
+        notification.save()
+        return UpdateNotificationStatus(notification=notification)
+
+
+class Mutation(graphene.ObjectType):
+    update_notification_status = UpdateNotificationStatus.Field(
+        description="Updates the status od a notification and takes the argument\
+            \n- notification_id: The name of the room[required]")

admin_notifications/helpers/device_last_seen.py

@@ -45,7 +45,7 @@
 from api.response.models import Response
 from api.tag.models import Tag
 from api.structure.models import Structure
-
+from admin_notifications.models import AdminNotification
 
 target_metadata = Base.metadata
 

admin_notifications/helpers/notification_templates.py

@@ -0,0 +1,39 @@
+"""add admin notifications table
+
+Revision ID: f0873fb8edb3
+Revises: 50173cb0491f
+Create Date: 2019-06-27 13:31:19.694650
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'f0873fb8edb3'
+down_revision = '50173cb0491f'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.execute('DROP TYPE statustype;')
+    op.create_table('admin_notifications',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('title', sa.String(), nullable=True),
+    sa.Column('message', sa.String(), nullable=True),
+    sa.Column('date_received', sa.String(), nullable=True),
+    sa.Column('date_read', sa.String(), nullable=True),
+    sa.Column('status', sa.Enum('read', 'unread', name='statustype'), nullable=True),
+    sa.Column('location_id', sa.Integer(), nullable=True),
+    sa.ForeignKeyConstraint(['location_id'], ['locations.id'], ondelete='CASCADE'),
+    sa.PrimaryKeyConstraint('id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('admin_notifications')
+    # ### end Alembic commands ###

admin_notifications/helpers/queue_manager.py

@@ -1,10 +1,10 @@
-from sqlalchemy import (Column, String, Integer, DateTime, ForeignKey, Enum)
+from sqlalchemy import (Column, String, Integer, DateTime, ForeignKey)
 from sqlalchemy.schema import Sequence
 from sqlalchemy.orm import relationship
 
 from helpers.database import Base
 from utilities.validations import validate_empty_fields
-from utilities.utility import Utility, ActivityType
+from utilities.utility import Utility
 
 
 class Devices(Base, Utility):
@@ -17,7 +17,6 @@ class Devices(Base, Utility):
     location = Column(String, nullable=False)
     room_id = Column(Integer, ForeignKey('rooms.id', ondelete="CASCADE"))
     room = relationship('Room')
-    activity = Column(Enum(ActivityType), default="active")
 
     def __init__(self, **kwargs):
         validate_empty_fields(**kwargs)

admin_notifications/models.py

@@ -15,6 +15,9 @@
 import pytz
 from dateutil import parser
 from datetime import datetime, timedelta
+from admin_notifications.helpers.create_notification import create_notification
+from admin_notifications.helpers.notification_templates import (
+    event_auto_cancelled_notification)
 
 
 class Events(SQLAlchemyObjectType):
@@ -104,6 +107,15 @@ def mutate(self, info, **kwargs):
                                                     kwargs['event_id']
                                                 )
         event_reject_reason = 'after 10 minutes'
+        notification_payload = event_auto_cancelled_notification(
+            event_name=event.event_title,
+            room_name=event.room.name
+        )
+        create_notification(
+            title=notification_payload['title'],
+            message=notification_payload['message'],
+            location_id=event.room.location_id
+        )
         if not notification.event_cancellation_notification(
                                                             calendar_event,
                                                             room_id,

admin_notifications/schema.py

@@ -3,7 +3,6 @@
 from flask_graphql import GraphQLView
 from flask_cors import CORS
 from flask_json import FlaskJSON
-from flask_socketio import SocketIO
 
 from flask_mail import Mail
 from config import config
@@ -12,15 +11,13 @@
 from healthcheck_schema import healthcheck_schema
 from helpers.auth.authentication import Auth
 from api.analytics.analytics_request import AnalyticsRequest
-
 mail = Mail()
 
 
 def create_app(config_name):
     app = Flask(__name__)
     CORS(app)
     FlaskJSON(app)
-    SocketIO(app)
     app.config.from_object(config[config_name])
     config[config_name].init_app(app)
     mail.init_app(app)

alembic/env.py

@@ -1,7 +1,7 @@
 import os
 from celery import Celery
 from app import create_app
-from admin_notifications.helpers.queue_manager import beat_schedule
+
 
 app = create_app(os.getenv('APP_SETTINGS') or 'default')
 app.app_context().push()
@@ -10,13 +10,12 @@
 app.config.update(
     CELERY_BROKER_URL='redis://localhost:6379',
     CELERY_RESULT_BACKEND='redis://localhost:6379',
-    CELERY_ACCEPT_CONTENT=['pickle'],
-    CELERYBEAT_SCHEDULE=beat_schedule
+    CELERY_ACCEPT_CONTENT=['pickle']
 )
 
 
 def make_celery(app):
-    celery = Celery(app.name, broker=app.config['CELERY_BROKER_URL'], include=['admin_notifications.helpers.device_last_seen', 'admin_notifications.helpers.create_notification'], # noqa 501
+    celery = Celery(app.name, broker=app.config['CELERY_BROKER_URL'], include=['admin_notifications.helpers.create_notification'], # noqa 501
                     backend=app.config['CELERY_BROKER_URL'])
 
     celery.conf.update(app.config)