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]

.circleci/config.yml

@@ -36,9 +36,9 @@ gcloud_setup: &gcloud_setup
   run:
     name: setup gcloud
     command: |
-      # install 
+      # install
       sudo curl https://dl.google.com/dl/cloudsdk/release/google-cloud-sdk.tar.gz > /tmp/google-cloud-sdk.tar.gz
-      sudo mkdir -p /usr/local/gcloud 
+      sudo mkdir -p /usr/local/gcloud
       sudo tar -C /usr/local/gcloud -xvf /tmp/google-cloud-sdk.tar.gz
       sudo /usr/local/gcloud/google-cloud-sdk/install.sh --quiet
       echo PATH=$PATH:/usr/local/gcloud/google-cloud-sdk/bin >> ~/.bashrc
@@ -190,8 +190,8 @@ jobs:
           command: |
             ./cc-test-reporter before-build
             . venv/bin/activate
-            coverage combine parallel-coverage/ 
-            coverage xml
+            coverage combine parallel-coverage/
+            coverage xml -i
             coverage report
             ./cc-test-reporter format-coverage -o ./.coverage -t coverage.py
             ./cc-test-reporter upload-coverage -i .coverage
@@ -301,13 +301,13 @@ jobs:
           command: |
             if [ "$CIRCLE_BRANCH" == master ] || [ "$CIRCLE_BRANCH" == develop ]; then
               touch google-service-key.json
-              echo $GOOGLE_CREDENTIALS_STAGING | base64 --decode >> google-service-key.json 
+              echo $GOOGLE_CREDENTIALS_STAGING | base64 --decode >> google-service-key.json
               gcloud auth activate-service-account --key-file google-service-key.json
               gcloud --quiet config set project ${GOOGLE_PROJECT_ID_STAGING}
               gcloud --quiet config set compute/zone ${GOOGLE_COMPUTE_ZONE}
             else
               touch google-service-key.json
-              echo $GOOGLE_CREDENTIALS_SANDBOX | base64 --decode >> google-service-key.json 
+              echo $GOOGLE_CREDENTIALS_SANDBOX | base64 --decode >> google-service-key.json
               gcloud auth activate-service-account --key-file google-service-key.json
               gcloud --quiet config set project ${GOOGLE_PROJECT_ID_SANDBOX}
               gcloud --quiet config set compute/zone ${GOOGLE_COMPUTE_ZONE}

.codeclimate.yml

@@ -2,4 +2,6 @@ version: "2"
 exclude_patterns:
   - "helpers/auth/authentication.py"
   - "helpers/calendar/events.py"
-  - "alembic/"
+  - "**/alembic/"
+  - "**/*__init__.py"
+  - "**/tests/"

admin_notifications/helpers/create_notification.py

@@ -1,11 +1,21 @@
-from flask_socketio import send, emit
 from admin_notifications.models import AdminNotification
-from manage import socketio
-import celery
+from api.location.models import Location
+from datetime import datetime
+
+
+def update_notification(notification_id):
+    notification = AdminNotification.query.filter_by(id=notification_id).first()
+    notification.date_received = datetime.now()
+    notification.save()
 
 
-@celery.task(name="create-notification")
 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 +24,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)  # noqa 501
+    return socketio.emit(
+        f"notifications-{location_name}",
+        {'notification': new_notification},
+        broadcast=True,
+        callback=update_notification(notification.id)
+    )

admin_notifications/helpers/device_last_seen.py

@@ -7,7 +7,7 @@
 
 
 @celery.task(name='check-device-last-seen')
-def notify_when_device_is_offline(**kwargs):
+def notify_when_device_is_offline():
     query = DevicesModel.query
     online_devices = query.filter(DevicesModel.activity == "online").all()
     for device in online_devices:
@@ -18,19 +18,13 @@ def notify_when_device_is_offline(**kwargs):
         if duration_offline.days > 1:
             update_entity_fields(device, activity="offline")
             device.save()
-    return online_devices
-
 
-@celery.task(name='notify')
-def notify():
-    query = DevicesModel.query
-    offline_device = query.filter(DevicesModel.activity == "offline").all()
-    for device in offline_device:
-        if device:
             room_name = device.room.name
             room_id = device.room.id
             notification_payload = device_offline_notification(
                 room_name, room_id)
             create_notification(title=notification_payload['title'],
                                 message=notification_payload['message'],
                                 location_id=device.room.location_id)
+
+    return online_devices

admin_notifications/helpers/notification_templates.py

@@ -1,6 +1,4 @@
-def event_auto_cancelled_notification(event_name, room_name):
+def device_offline_notification(room_name, room_id):
     return {
-        "title": "Event Auto cancelled.",
-        "message": f"An event {event_name} in {room_name} \
-          has been auto cancelled."
-    }
+        "title": "Device is offline",
+        "message": f"A device in {room_name} roomid:{room_id} is offline."}

alembic/versions/1b53553ddacf_add_activity_column_to_devices_table.py

@@ -41,7 +41,7 @@ def mutate(self, info, **kwargs):
         room_location = location_join_room().filter(
             RoomModel.id == kwargs['room_id'],
             RoomModel.state == 'active'
-            ).first()
+        ).first()
         if not room_location:
             raise GraphQLError("Room not found")
         user = get_user_from_db()

api/devices/schema.py

@@ -8,15 +8,15 @@
 
 
 app.config.update(
-    CELERY_BROKER_URL='redis://localhost:6379',
-    CELERY_RESULT_BACKEND='redis://localhost:6379',
+    CELERY_BROKER_URL=os.getenv('CELERY_BROKER_URL'),
+    CELERY_RESULT_BACKEND=os.getenv('CELERY_RESULT_BACKEND'),
     CELERY_ACCEPT_CONTENT=['pickle'],
     CELERYBEAT_SCHEDULE=beat_schedule
 )
 
 
 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.device_last_seen', 'admin_notifications.helpers.create_notification'],  # noqa 501
                     backend=app.config['CELERY_BROKER_URL'])
 
     celery.conf.update(app.config)

cworker.py

@@ -5,3 +5,4 @@
 cd /app
 export $(cat .env | xargs)
 celery worker -A cworker.celery --loglevel=info
+celery -A cworker.celery beat -l info

docker/dev/start_redis.sh

@@ -2,3 +2,4 @@
 cd /app
 export $(cat .env | xargs)
 celery worker -A cworker.celery --loglevel=info
+celery -A cworker.celery beat -l info

docker/prod/start_redis.sh

@@ -9,6 +9,7 @@ Flask-JSON==0.3.2
 Flask-Script==2.0.6
 Flask-GraphQL==1.4.1
 Flask-Mail==0.9.1
+Flask-SocketIO==4.1.0
 google-api-python-client==1.6.7
 graphene-sqlalchemy==2.0.0
 graphene==2.1

requirements.txt

@@ -0,0 +1,16 @@
+from tests.base import BaseTestCase
+from fixtures.token.token_fixture import ADMIN_TOKEN
+from fixtures.devices.devices_fixtures import devices_query
+from admin_notifications.helpers.device_last_seen import (
+    notify_when_device_is_offline)
+
+
+class TestDeviceOffline(BaseTestCase):
+    def test_when_device_is_offline(self):
+        """
+        Testing for device creation
+        """
+        headers = {"Authorization": "Bearer" + " " + ADMIN_TOKEN}
+        self.app_test.post(devices_query, headers=headers)
+        res = notify_when_device_is_offline()
+        assert res[0].activity.value == 'offline'

tests/test_admin_notification/__init__.py

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