CON-72-story(notifications): admin receives notification when device is not seen in a while

- setup queue manager for when notifications are sent
- implement notifications when device is not seen in a while

[Delivers CON-72]

Author: [Arusey]

admin_notifications/helpers/create_notification.py

@@ -0,0 +1,17 @@
+from flask_socketio import send, emit
+from admin_notifications.models import AdminNotification
+from manage import socketio
+import celery
+
+
+@celery.task(name="create-notification")
+def create_notification(title, message, location_id):
+    notification = AdminNotification(
+        title=title,
+        message=message,
+        location_id=location_id,
+        status="unread"
+    )
+    notification.save()
+    new_notification = {"title": title, "message": message}
+    return socketio.emit('notification', {'notification': new_notification}, broadcast=True)

admin_notifications/helpers/device_last_seen.py

@@ -0,0 +1,26 @@
+from datetime import datetime
+from api.devices.models import Devices as DevicesModel
+from utilities.utility import update_entity_fields
+import celery
+
+
+@celery.task(name='check-device-last-seen')
+def notify_when_device_is_offline(**kwargs):
+    query = DevicesModel.query
+    online_devices = query.filter(DevicesModel.activity == "online").all()
+    for device in online_devices:
+        device_last_seen = device.last_seen
+        current_time = datetime.now()
+        duration_offline = current_time - device_last_seen
+
+        if duration_offline.days > 1:
+            update_entity_fields(device, activity="offline")
+            device.save()
+    return online_devices
+
+
+def notify(**kwargs):
+    query = DevicesModel.query
+    offline_device = query.filter(DevicesModel.activity == "offline").first()
+    if offline_device:
+        pass

admin_notifications/helpers/queue_manager.py

@@ -0,0 +1,7 @@
+from datetime import timedelta
+beat_schedule = {
+    'run-check-device-last-seen-hourly': {
+        'task': 'check-device-last-seen',
+        'schedule': timedelta(seconds=5)
+    }
+}

admin_notifications/models.py

@@ -1,6 +1,4 @@
 from sqlalchemy import (Column, String, Enum, Integer, ForeignKey)
-from sqlalchemy.schema import Sequence
-from utilities.validations import validate_empty_fields
 from helpers.database import Base
 from utilities.utility import Utility, StatusType
 
@@ -17,6 +15,4 @@ class AdminNotification(Base, Utility):
     location_id = Column(
         Integer,
         ForeignKey('locations.id', ondelete="CASCADE"),
-        nullable=True
-    )
-    
+        nullable=True)

alembic/versions/1b53553ddacf_add_activity_column_to_devices_table.py

@@ -0,0 +1,34 @@
+"""add activity column to devices table
+
+Revision ID: 1b53553ddacf
+Revises: c65718cd4ed8
+Create Date: 2019-06-22 12:59:24.591339
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+
+# revision identifiers, used by Alembic.
+revision = '1b53553ddacf'
+down_revision = 'c65718cd4ed8'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    activitytype = postgresql.ENUM('online', 'offline', name='activitytype')
+    activitytype.create(op.get_bind())
+    op.add_column('devices', sa.Column('activity', sa.Enum(
+        'online', 'offline', name='activitytype'), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('devices', 'activity')
+    op.execute("DROP TYPE activitytype;")
+    # ### end Alembic commands ###

api/devices/models.py

@@ -1,22 +1,23 @@
-from sqlalchemy import (Column, String, Integer, DateTime, ForeignKey)
+from sqlalchemy import (Column, String, Integer, DateTime, ForeignKey, Enum)
 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
+from utilities.utility import Utility, ActivityType
 
 
 class Devices(Base, Utility):
     __tablename__ = 'devices'
-    id = Column(Integer, Sequence('devices_id_seq', start=1, increment=1), primary_key=True) # noqa
+    id = Column(Integer, Sequence('devices_id_seq', start=1, increment=1), primary_key=True)  # noqa
     name = Column(String, nullable=False)
     device_type = Column(String, nullable=False)
     date_added = Column(DateTime, nullable=False)
     last_seen = Column(DateTime, nullable=False)
     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)

cworker.py

@@ -1,16 +1,26 @@
 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()
 
 
+app.config.update(
+    CELERY_BROKER_URL='redis://localhost:6379',
+    CELERY_RESULT_BACKEND='redis://localhost:6379',
+    CELERY_ACCEPT_CONTENT=['pickle'],
+    CELERYBEAT_SCHEDULE=beat_schedule
+)
+
+
 def make_celery(app):
-    celery = Celery(app.name, broker=app.config['CELERY_BROKER_URL'])
+    celery = Celery(app.name, broker=app.config['CELERY_BROKER_URL'], include=['admin_notifications.helpers.device_last_seen', 'admin_notifications.helpers.create_notification'], # noqa 501
+                    backend=app.config['CELERY_BROKER_URL'])
+
     celery.conf.update(app.config)
+    celery.conf.enable_utc = False
     TaskBase = celery.Task
 
     class ContextTask(TaskBase):
@@ -24,3 +34,5 @@ def __call__(self, *args, **kwargs):
 
 
 celery = make_celery(app)
+celery_scheduler = Celery(app.name, broker=app.config['CELERY_BROKER_URL'])
+celery_scheduler.conf.update(app.config)

helpers/email/email_setup.py

@@ -30,7 +30,7 @@ def __init__(
             html=self.template,
             sender=self.sender)
 
-    @celery.task
+    @celery.task(name='asynchronous-email-notifications')
     def send_async_email(msg_dict):
         mail = Mail()
         msg = Message()

utilities/utility.py

@@ -89,6 +89,12 @@ class QuestionType(enum.Enum):
     missingitem = "missing_items"
 
 
+
 class StatusType(enum.Enum):
     read = "read"
     unread = "unread"
+
+
+class ActivityType(enum.Enum):
+    online = "online"
+    offline = "offline"