Merge pull request #162 from UNLV-CS472-672/chat-feature-improvements

PR 5: Add Seen Status, Typing Indicator, and Chat Creation Popup to Messaging

Author: ashley-arellano

.gitignore

@@ -8,6 +8,8 @@
 /dataSources.local.xml
 
 /.idea/
+node_modules/
+
 
 # file contains very sensitive information. 
 # you do not want this as everybody can see this information and use it to attack the site.

backend/apps/chat/consumers.py

@@ -1,6 +1,3 @@
-# The below code is just for testing purposes (it works!)
-# Tested it using https://websocketking.com/
-# and entered ws://localhost:8000/ws/apps/chat/practice/
 import json
 from channels.generic.websocket import AsyncWebsocketConsumer
 from asgiref.sync import sync_to_async
@@ -33,35 +30,111 @@ async def disconnect(self, close_code):
 
 # This function receive messages from WebSocket.
     async def receive(self, text_data):
+        # Message is received
         text_data_json = json.loads(text_data)
-        message = text_data_json['message']
+        if 'message' in text_data_json:
+            message = text_data_json['message']
 
-        # Create a new message object
-        username = await self.save_message(self.user_id, self.room_name, message)
+            # Create a new message object
+            username, id, timestamp = await self.save_message(self.user_id, self.room_name, message)
 
-        await self.channel_layer.group_send( # sends message to all users in a channel group
-            self.room_group_name,
-            {
-                'type': 'chat_message', # Calls chat_message()
-                'message': message,
-                'username': username
-            }
-        )
+            # Serialize timestamp
+            formatted = timestamp.isoformat()
+
+            await self.channel_layer.group_send( # sends message to all users in a channel group
+                self.room_group_name,
+                {
+                    'type': 'chat_message', # Calls chat_message()
+                    'message': message,
+                    'username': username,
+                    'id': id,
+                    'timestamp': formatted
+                }
+            )
+
+        # Typing status is received
+        elif 'typing' in text_data_json:
+            typing = text_data_json['typing']
+            username = await self.get_username(self.user_id)
+            await self.channel_layer.group_send( # sends message to all users in a channel group
+                self.room_group_name,
+                {
+                    'type': 'typing_status', # Calls typing_status()
+                    'typing': typing,
+                    'username': username
+                }
+            )
+        # Seen status is received
+        elif 'seen' in text_data_json:
+            sender_username, message_ids = await self.mark_as_seen(self.room_name, self.user_id)
+
+            await self.channel_layer.group_send( # sends message to all users in a channel group
+                self.room_group_name,
+                {
+                    'type': 'seen_status', # Calls seen_status()
+                    'username': sender_username,
+                    'ids': message_ids
+                }
+            )
+
+    @sync_to_async
+    def mark_as_seen(self, room_name, user_id):
+        chat = Chat.objects.get(name = room_name)
+        # Get all unseen messages (excluding those from the receiver)
+        unseen_messages = chat.messages.filter(status=Message.NOT_SEEN).exclude(sender_id=user_id).order_by('-timestamp')
+
+        # Get sender (assumes all chats only have 2 people)
+        first_unseen = unseen_messages.first()
+        sender_username = None
+
+        # If there are unseen messages from sender
+        if first_unseen:
+            sender_username = first_unseen.sender.username
+
+        # Get message ids (maintaining order)
+        message_ids = list(unseen_messages.values_list('id', flat=True))
+
+        # Mark unseen messages as seen
+        unseen_messages.update(status=Message.SEEN)
+
+        return sender_username, message_ids
+
+
+    async def seen_status(self, event):
+        await self.send(text_data=json.dumps({
+            'message': 'seen_successful',
+            'ids': event['ids'],
+            'username': event['username']
+        }))
+
+    async def typing_status(self, event):
+        await self.send(text_data=json.dumps({
+            'message': 'successful',
+            'typing': event['typing'],
+            'username': event['username']
+        }))
 
     async def chat_message(self, event):
         await self.send(text_data=json.dumps({
             'message': 'successful',
             'body': event['message'],
-            'username': event['username']
+            'username': event['username'],
+            'id': event['id'],
+            'timestamp': event['timestamp']
         }))
 
+    @sync_to_async
+    def get_username(self, id):
+        user = User.objects.get(id=id)
+        return user.username
+
     @sync_to_async
     def save_message(self, id, room_name, content):
         try:
             user = User.objects.get(id=id)
             chat = Chat.objects.get(name = room_name)
-            Message.objects.create(content=content, chat = chat, sender = user) # Creates and saves message
-            return user.username
+            message = Message.objects.create(content=content, chat = chat, sender = user) # Creates and saves message
+            return user.username, message.id, message.timestamp
         except (Chat.DoesNotExist):
             print(f"Chat room '{room_name}' not found. Message not saved.")
             return "Unknown"

backend/apps/chat/jwt_middleware.py

@@ -25,7 +25,7 @@ def get_token_from_subprotocol(self, scope):
         # WebSocket subprotocols are sent as a list of protocols during the handshake.
 
         subprotocols = scope.get("subprotocols", [])
-        if subprotocols:
+        if len(subprotocols) > 1:
             # Assuming the token is the second protocol (after the real protocol)
             return subprotocols[1]  # The access token is the second subprotocol
         return None

backend/apps/chat/migrations/0007_message_status.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.6 on 2025-04-15 04:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('chat', '0006_chat_name'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='message',
+            name='status',
+            field=models.PositiveSmallIntegerField(choices=[(1, 'Seen'), (2, 'Not seen'), (3, 'Not sent')], default=2),
+        ),
+    ]

backend/apps/chat/models.py

@@ -20,15 +20,24 @@ def __str__(self):
     return f"Chat between {self.user1} and {self.user2}"
 
 class Message(models.Model):
+  SEEN = 1
+  NOT_SEEN = 2
+  NOT_SENT = 3
+  STATUS_CHOICES = (
+    (SEEN, 'Seen'),
+    (NOT_SEEN, 'Not seen'),
+    (NOT_SENT, 'Not sent'),
+  )
   chat = models.ForeignKey(Chat, on_delete=models.CASCADE, related_name="messages")
+  status = models.PositiveSmallIntegerField(choices=STATUS_CHOICES, null=False, blank=False, default=NOT_SEEN)
   sender = models.ForeignKey(User, on_delete=models.CASCADE, related_name="sent_messages")
   content = models.TextField()
   timestamp = models.DateTimeField(default=now)
 
   objects = MessageManager()
 
   class Meta:
-    ordering = ['timestamp']
+      ordering = ['timestamp']
 
   def __str__(self):
     return f"From {self.sender} in Chat {self.chat.id} at {self.timestamp}"

backend/apps/chat/tests.py

@@ -3,6 +3,11 @@
 from rest_framework import status
 from rest_framework.test import APITestCase, APIClient
 from .models import Chat, Message
+from apps.chat.consumers import ChatConsumer
+
+def test_chat_consumer_init():
+    consumer = ChatConsumer()
+    assert consumer is not None
 
 class ChatAPITestCase(APITestCase):
 

backend/codecov.yml

@@ -0,0 +1,14 @@
+coverage:
+  status:
+    project:
+      default:
+        enabled: false
+    patch:
+      default:
+        enabled: false
+
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: false
+  after_n_builds: 1

frontend/src/App.jsx

@@ -3,6 +3,7 @@ import { useEffect } from "react";
 import Header from "./Components/Header.jsx";
 import Footer from "./Components/Footer.jsx";
 import StudentLayout from "./Components/StudentLayout.jsx";
+import '@fortawesome/fontawesome-free/css/all.min.css';
 
 
 // Components