Implement Firebase Cloud Messaging support

Author: hellcp

requirements.txt

@@ -2,6 +2,7 @@ apscheduler==3.6.0
 certifi==2018.11.29
 chardet==3.0.4
 Click==7.0
+firebase-admin==7.1.0
 Flask==1.0.2
 Flask-SQLAlchemy==2.3.2
 Flask-Migrate==2.1.1

timeline_sync/api.py

@@ -2,6 +2,7 @@
 import secrets
 import uuid
 import requests
+import firebase_admin
 from .models import db, SandboxToken, TimelinePin, UserTimeline
 from .utils import get_uid, api_error, pin_valid
 from .settings import config
@@ -10,6 +11,8 @@
 
 api = Blueprint('api', __name__)
 
+default_app = firebase_admin.initialize_app()
+
 
 def get_locker_info(user_token):
     if user_token is None:
@@ -28,6 +31,27 @@ def get_locker_info(user_token):
         beeline.add_context_field('app_uuid', locker_info['app_uuid'])
         return locker_info['user_id'], locker_info['app_uuid'], f"uuid:{locker_info['app_uuid']}"
 
+def send_fcm_message(user_id, data):
+    if user_id is None:
+        raise ValueError
+
+    fcm_tokens = db.session.query(FcmToken).filter_by(user_id=user_id)
+    tokens = [fcm_token.token for fcm_token in fcm_tokens]
+
+    message = firebase_admin.messaging.Message(
+        data=data,
+        tokens=tokens,
+    )
+
+    response = firebase_admin.messaging.send_each_for_multicast(message)
+
+    if response.failure_count > 0:
+        responses = response.responses
+        for idx, resp in enumerate(responses):
+            if not resp.success:
+                FcmToken.query.filter_by(user_id=user_id, token=tokens[idx]).delete()
+
+
 
 @api.route('/tokens/sandbox/<app_uuid>')
 def get_sandbox_token(app_uuid):
@@ -68,6 +92,29 @@ def sync():
     }
     return jsonify(result)
 
+@api.route('/user/fcm_token/<token>')
+def fcm_token():
+    user_id = get_uid()
+
+    if request.method == 'PUT':
+        fcm_token_json = request.json
+
+        fcm_token = FcmToken.query.filter_by(user_id=user_id, token=token).one_or_none()
+        if fcm_token is None:
+            fcm_token = FcmToken.from_json(fcm_token_json, token, user_id)
+            if fcm_token is None:
+                return api_error(400)
+
+            db.session.add(fcm_token)
+            db.session.commit()
+
+    elif request.method == 'DELETE':
+        fcm_token = FcmToken.query.filter_by(user_id=user_id, token=token).first_or_404()
+        fcm_token.delete()
+
+        db.session.commit()
+    return 'OK'
+
 
 @api.route('/user/pins/<pin_id>', methods=['PUT', 'DELETE'])
 def user_pin(pin_id):
@@ -96,6 +143,8 @@ def user_pin(pin_id):
             db.session.add(pin)
             db.session.add(user_timeline)
             db.session.commit()
+
+            send_fcm_message(user_id, user_timeline.to_json())
         else:  # update pin
             try:
                 pin.update_from_json(pin_json)
@@ -111,6 +160,8 @@ def user_pin(pin_id):
                 db.session.add(pin)
                 db.session.add(user_timeline)
                 db.session.commit()
+
+                send_fcm_message(user_id, user_timeline.to_json())
             except (KeyError, ValueError):
                 beeline.add_context_field('timeline.failure.cause', 'update_pin')
                 return api_error(400)
@@ -127,6 +178,8 @@ def user_pin(pin_id):
                                      pin=pin)
         db.session.add(user_timeline)
         db.session.commit()
+
+        send_fcm_message(user_id, user_timeline.to_json())
     return 'OK'
 
 

timeline_sync/models.py

@@ -20,6 +20,28 @@ class SandboxToken(db.Model):
 
 db.Index('sandbox_token_uid_appuuid_index', SandboxToken.user_id, SandboxToken.app_uuid, unique=True)
 
+class FcmToken(db.Model):
+    __tablename__ = 'fcm_tokens'
+    token = db.Column(db.String, primary_key=True)
+    user_id = db.Column(db.Integer)
+    device_id = db.Column(db.String)
+    platform = db.Column(db.String)
+
+    @classmethod
+    def from_json(cls, fcm_token_json, token, user_id):
+        try:
+            fcm_token = cls(
+                token=token,
+                device_id=fcm_token_json['device_id'],
+                platform=fcm_token_json['platform'],
+                user_id=user_id,
+            )
+            return fcm_token
+        except (KeyError, ValueError):
+            return None
+
+
+db.Index('fcm_token_uid_token_index', FcmToken.user_id, FcmToken.token, unique=True)
 
 class TimelinePin(db.Model):
     __tablename__ = 'timeline_pins'