Various notifications fixes (#844)

- Fix: log distinct usernames
- Ditchline break and separate usernames with commas
- Better type hints
- Reuse an unused CRUD to get usernames by topic
- Use `send_each` to get a `BatchResponse` when sending to a topic (not
so useful unfortunately)

Author: Marc-Andrieu

app/core/notification/cruds_notification.py

@@ -231,16 +231,19 @@ async def get_topic_membership_by_user_id_and_topic_id(
     return result.scalars().first()
 
 
-async def get_user_ids_by_topic_id(
+async def get_usernames_by_topic_id(
     topic_id: UUID,
     db: AsyncSession,
 ) -> list[str]:
     result = await db.execute(
-        select(models_notification.TopicMembership.user_id).where(
-            models_notification.TopicMembership.topic_id == topic_id,
-        ),
+        select(models_users.CoreUser)
+        .join(
+            models_notification.TopicMembership,
+            models_users.CoreUser.id == models_notification.TopicMembership.user_id,
+        )
+        .where(models_notification.TopicMembership.topic_id == topic_id),
     )
-    return list(result.scalars().all())
+    return [f"{u.firstname} {u.name}" for u in list(result.scalars().all())]
 
 
 async def get_firebase_tokens_by_user_ids(
@@ -265,6 +268,7 @@ async def get_usernames_by_firebase_tokens(
             models_notification.FirebaseDevice,
             models_users.CoreUser.id == models_notification.FirebaseDevice.user_id,
         )
-        .where(models_notification.FirebaseDevice.firebase_device_token.in_(tokens)),
+        .where(models_notification.FirebaseDevice.firebase_device_token.in_(tokens))
+        .distinct(),
     )
     return [f"{u.firstname} {u.name}" for u in list(result.scalars().all())]

app/utils/communication/notifications.py

@@ -81,16 +81,13 @@ async def _manage_firebase_batch_response(
                     db=db,
                 )
                 hyperion_error_logger.error(
-                    """
-                        Firebase: SenderId mismatch for notification '%s' (%s module) for %s/%s tokens (%s users) :
-                        %s
-                    """,
+                    "Firebase: SenderId mismatch for notification '%s' (%s module) for %s/%s tokens (%s users) : %s",
                     message_content.title,
                     message_content.action_module,
                     len(mismatching_tokens),
                     response.success_count + response.failure_count,
                     len(usernames),
-                    "\n".join(usernames),
+                    ", ".join(usernames),
                 )
             hyperion_error_logger.info(
                 f"{response.failure_count} messages failed to be send, removing their tokens from the database.",
@@ -140,7 +137,7 @@ async def _send_firebase_push_notification_by_tokens(
                 ),
             )
 
-            result = messaging.send_each_for_multicast(message)
+            result: messaging.BatchResponse = messaging.send_each_for_multicast(message)
         except Exception:
             hyperion_error_logger.exception(
                 "Notification: Unable to send firebase notification to tokens",
@@ -166,22 +163,34 @@ def _send_firebase_push_notification_by_topic(
         if not self.use_firebase:
             return
 
-        topic = str(topic_id)
-        message = messaging.Message(
-            topic=topic,
-            notification=messaging.Notification(
-                title=message_content.title,
-                body=message_content.content,
-            ),
-        )
         try:
-            messaging.send(message)
-        except messaging.FirebaseError:
+            topic = str(topic_id)
+            message = messaging.Message(
+                topic=topic,
+                data={"action_module": message_content.action_module},
+                notification=messaging.Notification(
+                    title=message_content.title,
+                    body=message_content.content,
+                ),
+            )
+
+            result: messaging.BatchResponse = messaging.send_each([message])
+        except Exception:
             hyperion_error_logger.exception(
                 f"Notification: Unable to send firebase notification for topic {topic}",
             )
             raise
 
+        if result.failure_count > 0:
+            hyperion_error_logger.error(
+                "Firebase: Failed to send notification '%s' for topic %s (%s module) for %s/%s tokens",
+                message_content.title,
+                topic,
+                message_content.action_module,
+                result.failure_count,
+                result.success_count + result.failure_count,
+            )
+
     async def subscribe_tokens_to_topic(
         self,
         topic_id: UUID,
@@ -197,7 +206,10 @@ async def subscribe_tokens_to_topic(
             return
 
         topic = str(topic_id)
-        response = messaging.subscribe_to_topic(tokens, topic)
+        response: messaging.TopicManagementResponse = messaging.subscribe_to_topic(
+            tokens,
+            topic,
+        )
         if response.failure_count > 0:
             hyperion_error_logger.info(
                 f"Notification: Failed to subscribe to topic {topic} due to {[error.reason for error in response.errors]}",