feat: add update and delete messages

Author: giancarloromeo

services/web/server/src/simcore_service_webserver/conversations/_conversation_message_service.py

@@ -1,6 +1,5 @@
 # pylint: disable=unused-argument
 
-import asyncio
 import logging
 
 from aiohttp import web
@@ -15,33 +14,28 @@
 from models_library.projects import ProjectID
 from models_library.rest_ordering import OrderBy, OrderDirection
 from models_library.rest_pagination import PageTotalCount
-from models_library.socketio import SocketMessageDict
 from models_library.users import UserID
 
 from ..projects._groups_repository import list_project_groups
 
 # Import or define SocketMessageDict
-from ..socketio.messages import (
-    SOCKET_IO_PROJECT_CONVERSATION_MESSAGE_CREATED_EVENT,
-    send_message_to_standard_group,
-)
 from ..users.api import get_user_primary_group_id
 from . import _conversation_message_repository
+from ._socketio import (
+    notify_conversation_message_created,
+    notify_conversation_message_deleted,
+    notify_conversation_message_updated,
+)
 
 _logger = logging.getLogger(__name__)
 
 
-def _make_project_conversation_message_created_message(
-    project_id: ProjectID,
-    conversation_message: ConversationMessageGetDB,
-) -> SocketMessageDict:
-    return SocketMessageDict(
-        event_type=SOCKET_IO_PROJECT_CONVERSATION_MESSAGE_CREATED_EVENT,
-        data={
-            "project_id": project_id,
-            **conversation_message.model_dump(mode="json"),
-        },
-    )
+async def _get_recipients(app, project_id):
+    return [
+        project_to_group.gid
+        for project_to_group in await list_project_groups(app, project_id=project_id)
+        if project_to_group.read
+    ]
 
 
 async def create_message(
@@ -64,20 +58,11 @@ async def create_message(
         type_=type_,
     )
 
-    notification_recipients = [
-        project_to_group.gid
-        for project_to_group in await list_project_groups(app, project_id=project_id)
-        if project_to_group.read
-    ]
-
-    notification_message = _make_project_conversation_message_created_message(
-        project_id, created_message
-    )
-    await asyncio.gather(
-        *[
-            send_message_to_standard_group(app, recipient, notification_message)
-            for recipient in notification_recipients
-        ]
+    await notify_conversation_message_created(
+        app,
+        recipients=await _get_recipients(app, project_id),
+        project_id=project_id,
+        conversation_message=created_message,
     )
 
     return created_message
@@ -97,22 +82,33 @@ async def get_message(
 async def update_message(
     app: web.Application,
     *,
+    project_id: ProjectID,
     conversation_id: ConversationID,
     message_id: ConversationMessageID,
     # Update attributes
     updates: ConversationMessagePatchDB,
 ) -> ConversationMessageGetDB:
-    return await _conversation_message_repository.update(
+    updated_message = await _conversation_message_repository.update(
         app,
         conversation_id=conversation_id,
         message_id=message_id,
         updates=updates,
     )
 
+    await notify_conversation_message_updated(
+        app,
+        recipients=await _get_recipients(app, project_id),
+        project_id=project_id,
+        conversation_message=updated_message,
+    )
+
+    return updated_message
+
 
 async def delete_message(
     app: web.Application,
     *,
+    project_id: ProjectID,
     conversation_id: ConversationID,
     message_id: ConversationMessageID,
 ) -> None:
@@ -122,6 +118,14 @@ async def delete_message(
         message_id=message_id,
     )
 
+    await notify_conversation_message_deleted(
+        app,
+        recipients=await _get_recipients(app, project_id),
+        project_id=project_id,
+        conversation_id=conversation_id,
+        message_id=message_id,
+    )
+
 
 async def list_messages_for_conversation(
     app: web.Application,

services/web/server/src/simcore_service_webserver/conversations/_socketio.py

@@ -0,0 +1,112 @@
+import asyncio
+import datetime
+from typing import Final
+
+from aiohttp import web
+from models_library.conversations import (
+    ConversationID,
+    ConversationMessageGetDB,
+    ConversationMessageID,
+)
+from models_library.groups import GroupID
+from models_library.projects import ProjectID
+from models_library.socketio import SocketMessageDict
+from pydantic import BaseModel
+
+from ..socketio.messages import send_message_to_standard_group
+
+SOCKET_IO_CONVERSATION_MESSAGE_CREATED_EVENT: Final[str] = "conversationMessageCreated"
+
+SOCKET_IO_CONVERSATION_MESSAGE_DELETED_EVENT: Final[str] = "conversationMessageDeleted"
+
+SOCKET_IO_CONVERSATION_MESSAGE_UPDATED_EVENT: Final[str] = "conversationMessageUpdated"
+
+
+class ConversationMessage(BaseModel):
+    conversation_id: ConversationID
+    message_id: ConversationMessageID
+
+
+class ConversationMessageCreated(ConversationMessage):
+    content: str
+    created: datetime.datetime
+
+
+class ConversationMessageUpdated(ConversationMessage):
+    content: str
+    modified: datetime.datetime
+
+
+class ConversationMessageDeleted(ConversationMessage): ...
+
+
+async def _send_message_to_recipients(app, recipients, notification_message):
+    await asyncio.gather(
+        *[
+            send_message_to_standard_group(app, recipient, notification_message)
+            for recipient in recipients
+        ]
+    )
+
+
+async def notify_conversation_message_created(
+    app: web.Application,
+    *,
+    recipients: list[GroupID],
+    project_id: ProjectID,
+    conversation_message: ConversationMessageGetDB,
+) -> None:
+    notification_message = SocketMessageDict(
+        event_type=SOCKET_IO_CONVERSATION_MESSAGE_CREATED_EVENT,
+        data={
+            "project_id": project_id,
+            **ConversationMessageCreated(
+                **conversation_message.model_dump()
+            ).model_dump(mode="json"),
+        },
+    )
+
+    await _send_message_to_recipients(app, recipients, notification_message)
+
+
+async def notify_conversation_message_updated(
+    app: web.Application,
+    *,
+    recipients: list[GroupID],
+    project_id: ProjectID,
+    conversation_message: ConversationMessageGetDB,
+) -> None:
+
+    notification_message = SocketMessageDict(
+        event_type=SOCKET_IO_CONVERSATION_MESSAGE_UPDATED_EVENT,
+        data={
+            "project_id": project_id,
+            **ConversationMessageUpdated(
+                **conversation_message.model_dump()
+            ).model_dump(mode="json"),
+        },
+    )
+
+    await _send_message_to_recipients(app, recipients, notification_message)
+
+
+async def notify_conversation_message_deleted(
+    app: web.Application,
+    *,
+    recipients: list[GroupID],
+    project_id: ProjectID,
+    conversation_id: ConversationID,
+    message_id: ConversationMessageID,
+) -> None:
+
+    notification_message = SocketMessageDict(
+        event_type=SOCKET_IO_CONVERSATION_MESSAGE_DELETED_EVENT,
+        data={
+            "project_id": project_id,
+            **ConversationMessageDeleted(
+                conversation_id=conversation_id, message_id=message_id
+            ).model_dump(mode="json"),
+        },
+    )
+
+    await _send_message_to_recipients(app, recipients, notification_message)

services/web/server/src/simcore_service_webserver/projects/_conversations_service.py

@@ -222,6 +222,7 @@ async def update_project_conversation_message(
     )
     return await conversations_service.update_message(
         app,
+        project_id=project_uuid,
         conversation_id=conversation_id,
         message_id=message_id,
         updates=ConversationMessagePatchDB(content=content),
@@ -245,7 +246,10 @@ async def delete_project_conversation_message(
         permission="read",
     )
     await conversations_service.delete_message(
-        app, conversation_id=conversation_id, message_id=message_id
+        app,
+        project_id=project_uuid,
+        conversation_id=conversation_id,
+        message_id=message_id,
     )
 
 

services/web/server/src/simcore_service_webserver/socketio/messages.py

@@ -28,9 +28,6 @@
 
 SOCKET_IO_NODE_UPDATED_EVENT: Final[str] = "nodeUpdated"
 
-SOCKET_IO_PROJECT_CONVERSATION_MESSAGE_CREATED_EVENT: Final[str] = (
-    "projectConversationMessageCreated"
-)
 SOCKET_IO_PROJECT_UPDATED_EVENT: Final[str] = "projectStateUpdated"
 
 SOCKET_IO_WALLET_OSPARC_CREDITS_UPDATED_EVENT: Final[str] = "walletOsparcCreditsUpdated"

services/web/server/tests/unit/with_dbs/02/test_projects_conversations_handlers.py

@@ -10,6 +10,7 @@
 from unittest.mock import MagicMock
 
 import pytest
+import simcore_service_webserver.conversations._conversation_message_service
 import sqlalchemy as sa
 from aiohttp.test_utils import TestClient
 from models_library.api_schemas_webserver.projects_conversations import (
@@ -31,11 +32,32 @@
 
 
 @pytest.fixture
-def mocked_notify_project_conversation_message_created(
+def mocked_notify_conversation_message_created(
     mocker: MockerFixture,
 ) -> MagicMock:
-    return mocker.patch(
-        "simcore_service_webserver.conversations._conversation_message_service._make_project_conversation_message_created_message",
+    return mocker.patch.object(
+        simcore_service_webserver.conversations._conversation_message_service,
+        "notify_conversation_message_created",
+    )
+
+
+@pytest.fixture
+def mocked_notify_conversation_message_updated(
+    mocker: MockerFixture,
+) -> MagicMock:
+    return mocker.patch.object(
+        simcore_service_webserver.conversations._conversation_message_service,
+        "notify_conversation_message_updated",
+    )
+
+
+@pytest.fixture
+def mocked_notify_conversation_message_deleted(
+    mocker: MockerFixture,
+) -> MagicMock:
+    return mocker.patch.object(
+        simcore_service_webserver.conversations._conversation_message_service,
+        "notify_conversation_message_deleted",
     )
 
 
@@ -174,7 +196,9 @@ async def test_project_conversation_messages_full_workflow(
     user_project: ProjectDict,
     expected: HTTPStatus,
     postgres_db: sa.engine.Engine,
-    mocked_notify_project_conversation_message_created: MagicMock,
+    mocked_notify_conversation_message_created: MagicMock,
+    mocked_notify_conversation_message_updated: MagicMock,
+    mocked_notify_conversation_message_deleted: MagicMock,
 ):
     base_project_url = client.app.router["list_project_conversations"].url_for(
         project_id=user_project["uuid"]
@@ -203,12 +227,11 @@ async def test_project_conversation_messages_full_workflow(
     assert ConversationMessageRestGet.model_validate(data)
     _first_message_id = data["messageId"]
 
-    assert mocked_notify_project_conversation_message_created.call_count == 1
-    args = mocked_notify_project_conversation_message_created.call_args
+    assert mocked_notify_conversation_message_created.call_count == 1
+    kwargs = mocked_notify_conversation_message_created.await_args[1]
 
-    assert user_project["uuid"] == f"{args[0][0]}"
-    assert args[0][1].content == "My first message"
-    assert args[0][1].type == "MESSAGE"
+    assert f"{kwargs['project_id']}" == user_project["uuid"]
+    assert kwargs["conversation_message"].content == "My first message"
 
     # Now we will add second message
     body = {"content": "My second message", "type": "MESSAGE"}
@@ -220,12 +243,11 @@ async def test_project_conversation_messages_full_workflow(
     assert ConversationMessageRestGet.model_validate(data)
     _second_message_id = data["messageId"]
 
-    assert mocked_notify_project_conversation_message_created.call_count == 2
-    args = mocked_notify_project_conversation_message_created.call_args
+    assert mocked_notify_conversation_message_created.call_count == 2
+    kwargs = mocked_notify_conversation_message_created.await_args[1]
 
-    assert user_project["uuid"] == f"{args[0][0]}"
-    assert args[0][1].content == "My second message"
-    assert args[0][1].type == "MESSAGE"
+    assert user_project["uuid"] == f"{kwargs['project_id']}"
+    assert kwargs["conversation_message"].content == "My second message"
 
     # Now we will list all message for the project conversation
     resp = await client.get(f"{base_project_conversation_url}")
@@ -253,6 +275,12 @@ async def test_project_conversation_messages_full_workflow(
         expected,
     )
 
+    assert mocked_notify_conversation_message_updated.call_count == 1
+    kwargs = mocked_notify_conversation_message_updated.await_args[1]
+
+    assert user_project["uuid"] == f"{kwargs['project_id']}"
+    assert kwargs["conversation_message"].content == updated_content
+
     # Get the second message
     resp = await client.get(f"{base_project_conversation_url}/{_second_message_id}")
     data, _ = await assert_status(
@@ -283,6 +311,13 @@ async def test_project_conversation_messages_full_workflow(
         status.HTTP_204_NO_CONTENT,
     )
 
+    assert mocked_notify_conversation_message_deleted.call_count == 1
+    kwargs = mocked_notify_conversation_message_deleted.await_args[1]
+
+    assert f"{kwargs['project_id']}" == user_project["uuid"]
+    assert f"{kwargs['conversation_id']}" == _conversation_id
+    assert f"{kwargs['message_id']}" == _second_message_id
+
     # Now we will list all message for the project conversation
     resp = await client.get(f"{base_project_conversation_url}")
     data, _, meta = await assert_status(resp, expected, include_meta=True)
@@ -373,3 +408,10 @@ async def test_project_conversation_messages_full_workflow(
             resp,
             status.HTTP_204_NO_CONTENT,
         )
+
+        assert mocked_notify_conversation_message_deleted.call_count == 2
+        kwargs = mocked_notify_conversation_message_deleted.await_args[1]
+
+        assert f"{kwargs['project_id']}" == user_project["uuid"]
+        assert f"{kwargs['conversation_id']}" == _conversation_id
+        assert f"{kwargs['message_id']}" == _first_message_id