feature-9004: Implement backend for additional Rocket Chat rooms (#9014)

* feature-8987 - Implement dedicated Rocket Chat rooms for each video room and make them ready for mobile view

* feature-8987 + feature-9004

* fix python deepsource scan

* fix issue create chat room for disabled location

* fix mutiple migration head

Author: nnhathung

app/api/chat/rocket_chat.py

@@ -9,6 +9,7 @@
 from app.api.helpers.db import get_new_identifier, get_or_create
 from app.models import db
 from app.models.event import Event
+from app.models.microlocation import Microlocation
 from app.models.user import User
 from app.settings import get_settings
 
@@ -96,14 +97,20 @@ def register(
             )
             raise RocketChatException('Error while registration', response=res)
 
-    def get_token(self, user: User, event: Optional[Event] = None, retried=False):
+    def get_token(
+        self,
+        user: User,
+        event: Optional[Event] = None,
+        retried=False,
+        microlocation: Optional[Microlocation] = None,
+    ):
         if user.rocket_chat_token:
             res = requests.post(self.login_url, json=dict(resume=user.rocket_chat_token))
 
             data = res.json()
             if res.status_code == 200:
                 if event:
-                    self.add_in_room(event, data['data']['userId'])
+                    self.add_in_room(event, data['data']['userId'], microlocation)
                 return dict(method='resumed', token=user.rocket_chat_token, res=data)
             elif res.status_code == 401:
                 # Token Expired. Login again
@@ -145,14 +152,18 @@ def check_or_create_bot(self):
 
         return bot_user
 
-    def create_room(self, event: Event, data):
+    def create_room(self, event: Event, microlocation: Optional[Microlocation], data):
         bot_token = data['token']
         bot_id = data['res']['data']['userId']
+        if microlocation:
+            chat_room_name = microlocation.chat_room_name
+        else:
+            chat_room_name = event.chat_room_name
 
         res = requests.post(
             self.api_url + '/api/v1/groups.create',
             json=dict(
-                name=event.chat_room_name,
+                name=chat_room_name,
                 members=[bot_id],
             ),
             headers={
@@ -165,20 +176,31 @@ def create_room(self, event: Event, data):
             raise RocketChatException('Error while creating room', response=res)
         else:
             group_data = res.json()
-            event.chat_room_id = group_data['group']['_id']
-            db.session.add(event)
+            if microlocation:
+                microlocation.chat_room_id = group_data['group']['_id']
+                db.session.add(microlocation)
+            else:
+                event.chat_room_id = group_data['group']['_id']
+                db.session.add(event)
             db.session.commit()
 
-    def add_in_room(self, event: Event, rocket_user_id):
+    def add_in_room(
+        self, event: Event, rocket_user_id, microlocation: Optional[Microlocation] = None
+    ):
         bot = self.check_or_create_bot()
         data = self.get_token(bot)
 
-        if not event.chat_room_id:
-            self.create_room(event, data)
+        if (not event.chat_room_id) or (microlocation and not microlocation.chat_room_id):
+            self.create_room(event=event, microlocation=microlocation, data=data)
+
+        if microlocation is not None:
+            chat_room_id = microlocation.chat_room_id
+        else:
+            chat_room_id = event.chat_room_id
 
         bot_token = data['token']
         bot_id = data['res']['data']['userId']
-        room_info = {'roomId': event.chat_room_id, 'userId': rocket_user_id}
+        room_info = {'roomId': chat_room_id, 'userId': rocket_user_id}
 
         res = requests.post(
             self.api_url + '/api/v1/groups.invite',
@@ -198,15 +220,19 @@ def generate_pass(size=10, chars=string.ascii_lowercase + string.digits):
     return ''.join(random.choice(chars) for _ in range(size))
 
 
-def get_rocket_chat_token(user: User, event: Optional[Event] = None):
+def get_rocket_chat_token(
+    user: User,
+    event: Optional[Event] = None,
+    microlocation: Optional[Microlocation] = None,
+):
     settings = get_settings()
     if not (api_url := settings['rocket_chat_url']):
         raise RocketChatException(
             'Rocket Chat Integration is not enabled', RocketChatException.CODES.DISABLED
         )
 
     rocket_chat = RocketChat(api_url)
-    return rocket_chat.get_token(user, event)
+    return rocket_chat.get_token(user, event, microlocation=microlocation)
 
 
 def rename_rocketchat_room(event: Event):

app/api/events.py

@@ -123,6 +123,45 @@ def get_chat_token(event_id: int):
             )
 
 
+@events_blueprint.route(
+    '/<string:event_identifier>/room/<string:microlocation_id>/chat-token',
+)
+@jwt_required
+@to_event_id
+def get_room_chat_token(event_id: int, microlocation_id: int):
+    """
+    Get room chat token for specific room
+    @param event_id: event identifier
+    @param microlocation_id: microlocation id
+    @return: room chat token
+    """
+    event = Event.query.get_or_404(event_id)
+    microlocation = Microlocation.query.get_or_404(microlocation_id)
+
+    if not VideoStream(event_id=event.id).user_can_access:
+        raise NotFoundError({'source': ''}, 'Video Stream Not Found')
+
+    if not event.is_chat_enabled:
+        raise NotFoundError({'source': ''}, 'Chat Not Enabled')
+
+    if not microlocation.is_chat_enabled and not microlocation.is_global_event_room:
+        raise NotFoundError({'source': ''}, 'Chat Not Enabled For This Room')
+
+    try:
+        data = get_rocket_chat_token(current_user, event, microlocation)
+        return jsonify({'success': True, 'token': data['token']})
+    except RocketChatException as rce:
+        if rce.code == RocketChatException.CODES.DISABLED:
+            return jsonify({'success': False, 'code': rce.code})
+        return jsonify(
+            {
+                'success': False,
+                'code': rce.code,
+                'response': rce.response is not None and rce.response.json(),
+            }
+        )
+
+
 def validate_event(user, data):
     if not user.can_create_event():
         raise ForbiddenError({'source': ''}, "Please verify your Email")

app/api/schema/microlocations.py

@@ -27,6 +27,9 @@ class Meta:
     longitude = fields.Float(validate=lambda n: -180 <= n <= 180, allow_none=True)
     floor = fields.Integer(allow_none=True)
     hidden_in_scheduler = fields.Boolean(default=False)
+    chat_room_name = fields.Str(dump_only=True)
+    is_chat_enabled = fields.Boolean(default=False, allow_none=True)
+    is_global_event_room = fields.Boolean(default=False, allow_none=True)
     position = fields.Integer(allow_none=True, default=0)
     room = fields.Str(allow_none=True)
     sessions = Relationship(

app/models/microlocation.py

@@ -1,3 +1,5 @@
+import re
+
 from app.models import db
 from app.models.base import SoftDeletionModel
 
@@ -14,6 +16,9 @@ class Microlocation(SoftDeletionModel):
     hidden_in_scheduler = db.Column(db.Boolean, default=False, nullable=False)
     position = db.Column(db.Integer, default=0, nullable=False)
     room = db.Column(db.String)
+    is_chat_enabled = db.Column(db.Boolean, default=False, nullable=True)
+    is_global_event_room = db.Column(db.Boolean, default=False, nullable=True)
+    chat_room_id = db.Column(db.String, nullable=True)
     session = db.relationship('Session', backref="microlocation")
     event_id = db.Column(db.Integer, db.ForeignKey('events.id', ondelete='CASCADE'))
     video_stream_id = db.Column(
@@ -38,3 +43,7 @@ def safe_video_stream(self):
     @safe_video_stream.setter
     def safe_video_stream(self, value):
         self.video_stream = value
+
+    @property
+    def chat_room_name(self):
+        return re.sub('[^0-9a-zA-Z!]', '-', self.name) + '-' + str(self.id)

migrations/versions/rev-2023-07-26-16:32:01-c4100d6a5609_.py

@@ -0,0 +1,31 @@
+"""empty message
+
+Revision ID: c4100d6a5609
+Revises: 8bd9e8e80517
+Create Date: 2023-07-26 16:32:01.697408
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'c4100d6a5609'
+down_revision = '8bd9e8e80517'
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('microlocations', sa.Column('is_chat_enabled', sa.Boolean(), nullable=True))
+    op.add_column('microlocations', sa.Column('is_global_event_room', sa.Boolean(), nullable=True))
+    op.add_column('microlocations', sa.Column('chat_room_id', sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('microlocations', 'chat_room_id')
+    op.drop_column('microlocations', 'is_global_event_room')
+    op.drop_column('microlocations', 'is_chat_enabled')
+    # ### end Alembic commands ###