tests: update models

Author: giancarloromeo

packages/models-library/src/models_library/rpc/notifications/messages.py

@@ -1,28 +1,29 @@
 from abc import ABC
-from typing import Annotated, Any, TypeAlias
+from typing import Any, Literal
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, EmailStr
 
 
-class BaseRecipient(BaseModel, ABC):
+class Channel(BaseModel, ABC):
     type: str
 
+    model_config = ConfigDict(
+        frozen=True,
+    )
 
-class SMSRecipient(BaseRecipient):
-    type: Annotated[str, Field(frozen=True)] = "sms"
-    phone_number: str
 
+class EmailChannel(Channel):
+    type: Literal["email"] = "email"
+    to: EmailStr
+    reply_to: EmailStr | None = None
 
-class EmailRecipient(BaseRecipient):
-    type: Annotated[str, Field(frozen=True)] = "email"
-    address: str
 
-
-Recipient: TypeAlias = Annotated[
-    EmailRecipient | SMSRecipient, Field(discriminator="type")
-]
+class SMSChannel(Channel):
+    type: Literal["sms"] = "sms"
+    phone_number: str  # Consider using phone number validation library here
 
 
 class NotificationMessage(BaseModel):
-    event: str
-    context: dict[str, Any] | None = None
+    event_type: str  # e.g. "account.registered"
+    channel: Channel
+    context: dict[str, Any] | None = None  # Additional context for the notification

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/notifications/messages.py

@@ -2,7 +2,7 @@
 
 from models_library.api_schemas_notifications import NOTIFICATIONS_RPC_NAMESPACE
 from models_library.rabbitmq_basic_types import RPCMethodName
-from models_library.rpc.notifications.messages import NotificationMessage, Recipient
+from models_library.rpc.notifications.messages import NotificationMessage
 from pydantic import NonNegativeInt, TypeAdapter
 
 from ... import RabbitMQRPCClient
@@ -14,12 +14,10 @@ async def send_notification_message(
     rabbitmq_rpc_client: RabbitMQRPCClient,
     *,
     message: NotificationMessage,
-    recipients: list[Recipient],
 ) -> None:
     await rabbitmq_rpc_client.request(
         NOTIFICATIONS_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("send_notification_message"),
         timeout_s=_DEFAULT_TIMEOUT_S,
         message=message,
-        recipients=recipients,
     )

services/notifications/src/simcore_service_notifications/api/rpc/_notifications.py

@@ -1,4 +1,4 @@
-from models_library.rpc.notifications.messages import NotificationMessage, Recipient
+from models_library.rpc.notifications.messages import NotificationMessage
 from servicelib.celery.task_manager import TaskManager
 from servicelib.rabbitmq import RPCRouter
 
@@ -12,10 +12,8 @@ async def send_notification_message(
     task_manager: TaskManager,
     *,
     message: NotificationMessage,
-    recipients: list[Recipient],
 ) -> None:
     await notifications_service.send_notification_message(
         task_manager,
         message=message,
-        recipients=recipients,
     )

services/notifications/src/simcore_service_notifications/clients/celery.py

@@ -7,9 +7,9 @@
 from fastapi import FastAPI
 from fastapi_lifespan_manager import State
 from models_library.rpc.notifications.messages import (
-    EmailRecipient,
+    EmailChannel,
     NotificationMessage,
-    SMSRecipient,
+    SMSChannel,
 )
 from settings_library.celery import CelerySettings
 
@@ -28,7 +28,7 @@ async def celery_lifespan(app: FastAPI) -> AsyncIterator[State]:
         )
 
         register_celery_types()
-        register_pydantic_types(NotificationMessage, EmailRecipient, SMSRecipient)
+        register_pydantic_types(NotificationMessage, EmailChannel, SMSChannel)
     yield {}
 
 

services/notifications/src/simcore_service_notifications/modules/celery/_email_tasks.py

@@ -2,11 +2,8 @@
 
 import logging
 
-from celery import Task  # type: ignore[import-untyped]
-from models_library.rpc.notifications.messages import (
-    EmailRecipient,
-    NotificationMessage,
-)
+from celery import Task
+from models_library.rpc.notifications.messages import EmailChannel, NotificationMessage
 from servicelib.celery.models import TaskID
 
 _logger = logging.getLogger(__name__)
@@ -18,8 +15,7 @@ async def send_email(
     task: Task,
     task_id: TaskID,
     message: NotificationMessage,
-    recipient: EmailRecipient,
 ) -> None:
-    # TODO: render email template with message and recipient details
-    #       and send the email using an email service
-    _logger.info("Sending email notification to %s", recipient.address)
+    assert isinstance(message.channel, EmailChannel)  # nosec
+
+    _logger.info("Sending email notification to %s", message.channel.to)

services/notifications/src/simcore_service_notifications/modules/celery/tasks.py

@@ -5,9 +5,9 @@
 from celery_library.task import register_task
 from celery_library.types import register_celery_types, register_pydantic_types
 from models_library.rpc.notifications.messages import (
-    EmailRecipient,
+    EmailChannel,
     NotificationMessage,
-    SMSRecipient,
+    SMSChannel,
 )
 from servicelib.logging_utils import log_context
 
@@ -25,7 +25,7 @@ class TaskQueue(StrEnum):
 
 def setup_worker_tasks(app: Celery) -> None:
     register_celery_types()
-    register_pydantic_types(NotificationMessage, EmailRecipient, SMSRecipient)
+    register_pydantic_types(NotificationMessage, EmailChannel, SMSChannel)
 
     with log_context(_logger, logging.INFO, msg="worker tasks registration"):
         register_task(

services/notifications/src/simcore_service_notifications/services/notifications_service.py

@@ -1,6 +1,6 @@
 import logging
 
-from models_library.rpc.notifications.messages import NotificationMessage, Recipient
+from models_library.rpc.notifications.messages import NotificationMessage
 from servicelib.celery.models import TaskContext
 from servicelib.celery.task_manager import TaskManager
 
@@ -13,13 +13,10 @@ async def send_notification_message(
     task_manager: TaskManager,
     *,
     message: NotificationMessage,
-    recipients: list[Recipient],
 ) -> None:
-    for recipient in recipients:
-        await task_manager.send_task(
-            name=f"notifications.{recipient.type}",
-            context=TaskContext(),  # TODO: TaskFilter
-            queue=TaskQueue.DEFAULT,
-            message=message,
-            recipient=recipient,
-        )
+    await task_manager.send_task(
+        name=f"notifications.{message.event_type}",
+        context=TaskContext(),  # TODO: TaskFilter
+        queue=TaskQueue.DEFAULT,
+        message=message,
+    )

services/notifications/tests/unit/test_tasks.py

@@ -4,7 +4,7 @@
 from servicelib.rabbitmq.rpc_interfaces.notifications.messages import (
     send_notification_message,
 )
-from simcore_service_notifications.clients.celery import EmailRecipient
+from simcore_service_notifications.clients.celery import EmailChannel
 
 pytest_simcore_core_services_selection = [
     "rabbit",
@@ -23,8 +23,8 @@ async def test_send_email(
     await send_notification_message(
         notifications_rabbitmq_rpc_client,
         message=NotificationMessage(
-            event="test_event",
+            event_type="on_account_requested",
+            channel=EmailChannel(to="[email protected]"),
             context={"key": "value"},
         ),
-        recipients=[EmailRecipient(address="[email protected]")],
     )