Set config default and tweak name

Fix notification wording

Fix _changed_info docstring

Use pytestmark in test modules

.devcontainer/.dev_config.yaml

@@ -13,4 +13,4 @@ file_registered_event_topic: internal_file_registry
 file_registered_event_type: file_registered
 iva_events_topic: ivas
 iva_state_changed_event_type: iva_state_changed
-user_data_event_topic: user_events
+user_events_topic: users

README.md

@@ -91,15 +91,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- **`user_data_event_topic`** *(string)*: The name of the topic containing user data events.
-
-
-  Examples:
-
-  ```json
-  "user_data_events"
-  ```
-
+- **`user_events_topic`** *(string)*: The name of the topic containing user events. Default: `"users"`.
 
 - **`access_request_events_topic`** *(string)*: Name of the event topic used to consume access request events.
 

config_schema.json

@@ -36,12 +36,10 @@
       "title": "Notification Event Type",
       "type": "string"
     },
-    "user_data_event_topic": {
-      "description": "The name of the topic containing user data events.",
-      "examples": [
-        "user_data_events"
-      ],
-      "title": "User Data Event Topic",
+    "user_events_topic": {
+      "default": "users",
+      "description": "The name of the topic containing user events.",
+      "title": "User Events Topic",
       "type": "string"
     },
     "access_request_events_topic": {
@@ -223,7 +221,6 @@
     "db_name",
     "notification_event_topic",
     "notification_event_type",
-    "user_data_event_topic",
     "access_request_events_topic",
     "access_request_created_event_type",
     "access_request_allowed_event_type",

example_config.yaml

@@ -23,4 +23,4 @@ notification_event_topic: notification_events
 notification_event_type: notification
 service_instance_id: '1'
 service_name: nos
-user_data_event_topic: user_events
+user_events_topic: users

src/nos/core/notifications.py

@@ -176,7 +176,6 @@ def formatted(self, **kwargs) -> "Notification":
     """
 Your account details were recently updated. The changed details include: {changed_details}.
 
-If you did not make the following changes or have
-please contact the GHGA immediately at {support_email}.
+If you did not make these changes or have questions, please contact the GHGA immediately at {support_email}.
 """,
 )

src/nos/core/orchestrator.py

@@ -330,7 +330,7 @@ async def process_iva_state_change(self, *, user_iva: event_schemas.UserIvaState
     def _changed_info(
         self, existing_user: event_schemas.User, new_user: event_schemas.User
     ) -> str:
-        """Check if critical user information has changed.
+        """Check what critical user information has changed (if any).
 
         Critical information includes the user's email address and name.
         """

src/nos/translators/inbound/event_sub.py

@@ -147,10 +147,9 @@ async def _consume_validated(
 class OutboxSubTranslatorConfig(BaseSettings):
     """Config for the outbox subscriber"""
 
-    user_data_event_topic: str = Field(
-        default=...,
-        description="The name of the topic containing user data events.",
-        examples=["user_data_events"],
+    user_events_topic: str = Field(
+        default="users",
+        description="The name of the topic containing user events.",
     )
 
 
@@ -168,7 +167,7 @@ def __init__(
     ):
         self._config = config
         self._orchestrator = orchestrator
-        self.event_topic = config.user_data_event_topic
+        self.event_topic = config.user_events_topic
 
     async def changed(self, resource_id: str, update: event_schemas.User) -> None:
         """Consume change event (created or updated) for user data."""

tests/fixtures/test_config.yaml

@@ -13,4 +13,4 @@ file_registered_event_topic: internal_file_registry
 file_registered_event_type: file_registered
 iva_events_topic: ivas
 iva_state_changed_event_type: iva_state_changed
-user_data_event_topic: user_events
+user_events_topic: users

tests/test_orchestrator.py

@@ -28,6 +28,7 @@
 from tests.fixtures.joint import JointFixture
 
 DATASET_ID = "dataset1"
+pytestmark = pytest.mark.asyncio()
 
 
 def access_request_payload(user_id: str) -> dict[str, Any]:
@@ -83,7 +84,6 @@ def iva_state_payload(user_id: str, state: event_schemas.IvaState) -> dict[str,
         ),
     ],
 )
-@pytest.mark.asyncio
 async def test_access_request(
     joint_fixture: JointFixture,
     user_notification_content: notifications.Notification,
@@ -159,7 +159,6 @@ async def test_access_request(
         await joint_fixture.event_subscriber.run(forever=False)
 
 
-@pytest.mark.asyncio
 async def test_missing_user_id_access_requests(
     joint_fixture: JointFixture, logot: Logot
 ):
@@ -191,7 +190,6 @@ async def test_missing_user_id_access_requests(
         )
 
 
-@pytest.mark.asyncio
 async def test_missing_user_id_iva_state_changes(
     joint_fixture: JointFixture, logot: Logot
 ):
@@ -228,7 +226,6 @@ async def test_missing_user_id_iva_state_changes(
         )
 
 
-@pytest.mark.asyncio
 async def test_file_registered(joint_fixture: JointFixture):
     """Test that the file registered events are translated into a notification."""
     # Prepare triggering event (the file registration event).
@@ -302,7 +299,6 @@ async def test_file_registered(joint_fixture: JointFixture):
         ),
     ],
 )
-@pytest.mark.asyncio
 async def test_iva_state_change(
     joint_fixture: JointFixture,
     iva_state: event_schemas.IvaState,
@@ -377,7 +373,6 @@ async def test_iva_state_change(
         await joint_fixture.event_subscriber.run(forever=False)
 
 
-@pytest.mark.asyncio
 async def test_all_ivas_reset(joint_fixture: JointFixture):
     """Test that the 'all IVA invalidated' events are translated into a notification."""
     # Prepare triggering event (the IVA state change event).

tests/test_outbox_subscriber.py

@@ -27,9 +27,10 @@
 CHANGE_EVENT_TYPE = "upserted"
 DELETE_EVENT_TYPE = "deleted"
 
+pytestmark = pytest.mark.asyncio()
+
 
 @pytest.mark.parametrize("user_id", ["test_id", "does_not_exist"])
-@pytest.mark.asyncio
 async def test_user_data_deletion(joint_fixture: JointFixture, user_id: str):
     """Ensure that the `delete` function works correctly.
 
@@ -45,7 +46,7 @@ async def test_user_data_deletion(joint_fixture: JointFixture, user_id: str):
     await joint_fixture.kafka.publish_event(
         payload={},
         type_=DELETE_EVENT_TYPE,
-        topic=joint_fixture.config.user_data_event_topic,
+        topic=joint_fixture.config.user_events_topic,
         key=user_id,
     )
 
@@ -73,7 +74,6 @@ async def test_user_data_deletion(joint_fixture: JointFixture, user_id: str):
     ],
     ids=["modified user", "new user"],
 )
-@pytest.mark.asyncio
 async def test_user_data_upsert(
     joint_fixture: JointFixture,
     user: event_schemas.User,
@@ -94,14 +94,14 @@ async def test_user_data_upsert(
     await joint_fixture.kafka.publish_event(
         payload=user.model_dump(),
         type_=CHANGE_EVENT_TYPE,
-        topic=joint_fixture.config.user_data_event_topic,
+        topic=joint_fixture.config.user_events_topic,
         key=user.user_id,
     )
 
     # Run the outbox subscriber.
     await joint_fixture.outbox_subscriber.run(forever=False)
 
-    # 4. Check that the user data is found.
+    # Check that the user data is found.
     result = await joint_fixture.user_dao.get_by_id(user.user_id)
     assert result == user
 
@@ -116,7 +116,6 @@ async def test_user_data_upsert(
     ],
     ids=["name", "email", "both", "neither"],
 )
-@pytest.mark.asyncio
 async def test_user_reregistration_notifications(
     joint_fixture: JointFixture,
     changed_details: dict[str, str],
@@ -133,7 +132,7 @@ async def test_user_reregistration_notifications(
     await joint_fixture.kafka.publish_event(
         payload=user.model_dump(),
         type_=CHANGE_EVENT_TYPE,
-        topic=joint_fixture.config.user_data_event_topic,
+        topic=joint_fixture.config.user_events_topic,
         key=user.user_id,
     )