Allow users to be mentioned via Python API (#235)

* allow users to be mentioned via Python API

* fix mypy errors

Author: dlqqq

python/jupyterlab-chat/jupyterlab_chat/models.py

@@ -38,7 +38,7 @@ class Message:
     attachments: Optional[list[str]] = None
     """ The message attachments, a list of attachment ID """
 
-    mentions: Optional[list[str]] = field(default_factory=list)
+    mentions: list[str] = field(default_factory=list)
     """ Users mentioned in the message """
 
     raw_time: Optional[bool] = None
@@ -75,12 +75,15 @@ class NewMessage:
 class User(JupyterUser):
     """ Object representing a user """
 
-    mention_name: Optional[str] = None
-    """ The string to use as mention in chat """
-
     bot: Optional[bool] = None
     """ Boolean identifying if user is a bot """
 
+    @property
+    def mention_name(self) -> str:
+        name: str = self.display_name or self.name or self.username
+        name = name.replace(" ", "-")
+        return name
+
 
 @dataclass
 class Attachment:

python/jupyterlab-chat/jupyterlab_chat/tests/test_ychat.py

@@ -22,6 +22,11 @@
     display_name="Test user 2"
 )
 
+USER3 = User(
+    username=str(uuid4()),
+    name="Test user 3",
+    display_name="Test user 3"
+)
 
 def create_new_message(body="This is a test message") -> NewMessage:
     return NewMessage(
@@ -43,6 +48,11 @@ def test_add_user():
     assert USER.username in chat._get_users().keys()
     assert chat._get_users()[USER.username] == asdict(USER)
 
+def test_mention_names():
+    assert USER.mention_name == "Test-user"
+    assert USER2.mention_name == "Test-user-2"
+    assert USER3.mention_name == "Test-user-3"
+
 
 def test_get_user_type():
     chat = YChat()
@@ -84,6 +94,22 @@ def test_add_message():
     assert message_dict["sender"] == msg.sender
 
 
+def test_add_message_includes_mentions():
+    chat = YChat()
+    chat.set_user(USER)
+    chat.set_user(USER2)
+    chat.set_user(USER3)
+
+    new_msg = create_new_message(
+        f"@{USER2.mention_name} @{USER3.mention_name} Hello!"
+    )
+    msg_id = chat.add_message(new_msg)
+    msg = chat.get_message(msg_id)
+    assert msg
+
+    assert set(msg.mentions) == set([USER2.username, USER3.username])
+
+
 def test_get_message_should_return_the_message():
     chat = YChat()
     msg = create_new_message()

python/jupyterlab-chat/jupyterlab_chat/ychat.py

@@ -12,6 +12,7 @@
 from typing import Any, Callable, Optional, Set
 from uuid import uuid4
 from pycrdt import Array, ArrayEvent, Map, MapEvent
+import re
 
 from .models import message_asdict_factory, Attachment, Message, NewMessage, User
 
@@ -132,9 +133,19 @@ def add_message(self, new_message: NewMessage) -> str:
         message = Message(
             **asdict(new_message),
             time=timestamp,
-            id=uid
+            id=uid,
         )
 
+        # find all mentioned users and add them as message mentions
+        mention_pattern = re.compile("@([\w-]+):?")
+        mentioned_names: Set[str] = set(re.findall(mention_pattern, message.body))
+        users = self.get_users()
+        mentioned_usernames = []
+        for username, user in users.items():
+            if user.mention_name in mentioned_names and user.username not in mentioned_usernames:
+                mentioned_usernames.append(username)
+        message.mentions = mentioned_usernames
+
         with self._ydoc.transaction():
             index = len(self._ymessages) - next((i for i, v in enumerate(self._get_messages()[::-1]) if v["time"] < timestamp), len(self._ymessages))
             self._ymessages.insert(