♻️(email) use full name instead of email

If the full name is available,
we will use it to identify the user in the email
instead of the email address.

src/backend/core/api/viewsets.py

@@ -576,8 +576,12 @@ class DocumentAccessViewSet(
         """Add a new access to the document and send an email to the new added user."""
         access = serializer.save()
         language = self.request.headers.get("Content-Language", "en-us")
+
         access.document.email_invitation(
-            language, access.user.email, access.role, self.request.user.email
+            language,
+            access.user.email,
+            access.role,
+            self.request.user,
         )
 
 
@@ -778,6 +782,7 @@ class InvitationViewset(
         invitation = serializer.save()
 
         language = self.request.headers.get("Content-Language", "en-us")
+
         invitation.document.email_invitation(
-            language, invitation.email, invitation.role, self.request.user.email
+            language, invitation.email, invitation.role, self.request.user
         )

src/backend/core/models.py

@@ -520,15 +520,18 @@ class Document(BaseModel):
             "versions_retrieve": can_get_versions,
         }
 
-    def email_invitation(self, language, email, role, username_sender):
+    def email_invitation(self, language, email, role, sender):
         """Send email invitation."""
 
+        sender_name = sender.full_name or sender.email
         domain = Site.objects.get_current().domain
 
         try:
             with override(language):
-                title = _("%(username)s shared a document with you: %(document)s") % {
-                    "username": username_sender,
+                title = _(
+                    "%(sender_name)s shared a document with you: %(document)s"
+                ) % {
+                    "sender_name": sender_name,
                     "document": self.title,
                 }
                 template_vars = {
@@ -536,7 +539,10 @@ class Document(BaseModel):
                     "domain": domain,
                     "document": self,
                     "link": f"{domain}/docs/{self.id}/",
-                    "username": username_sender,
+                    "sender_name": sender_name,
+                    "sender_name_email": f"{sender.full_name} ({sender.email})"
+                    if sender.full_name
+                    else sender.email,
                     "role": RoleChoices(role).label.lower(),
                 }
                 msg_html = render_to_string("mail/html/invitation.html", template_vars)

src/backend/core/tests/documents/test_api_document_accesses_create.py

@@ -171,7 +171,10 @@ def test_api_document_accesses_create_authenticated_administrator(via, mock_user
     email = mail.outbox[0]
     assert email.to == [other_user["email"]]
     email_content = " ".join(email.body.split())
-    assert f"{user.email} shared a document with you: {document.title}" in email_content
+    assert (
+        f"{user.full_name} shared a document with you: {document.title}"
+        in email_content
+    )
     assert "docs/" + str(document.id) + "/" in email_content
 
 
@@ -225,5 +228,8 @@ def test_api_document_accesses_create_authenticated_owner(via, mock_user_teams):
     email = mail.outbox[0]
     assert email.to == [other_user["email"]]
     email_content = " ".join(email.body.split())
-    assert f"{user.email} shared a document with you: {document.title}" in email_content
+    assert (
+        f"{user.full_name} shared a document with you: {document.title}"
+        in email_content
+    )
     assert "docs/" + str(document.id) + "/" in email_content

src/backend/core/tests/documents/test_api_document_invitations.py

@@ -119,7 +119,7 @@ def test_api_document_invitations__create__privileged_members(
         assert email.to == ["guest@example.com"]
         email_content = " ".join(email.body.split())
         assert (
-            f"{user.email} shared a document with you: {document.title}"
+            f"{user.full_name} shared a document with you: {document.title}"
             in email_content
         )
     else:
@@ -162,7 +162,7 @@ def test_api_document_invitations__create__email_from_content_language():
 
     email_content = " ".join(email.body.split())
     assert (
-        f"{user.email} a partagé un document avec vous: {document.title}"
+        f"{user.full_name} a partagé un document avec vous: {document.title}"
         in email_content
     )
 
@@ -201,8 +201,52 @@ def test_api_document_invitations__create__email_from_content_language_not_suppo
 
     assert email.to == ["guest@example.com"]
 
+    email_content = " ".join(email.body.split())
+    assert (
+        f"{user.full_name} shared a document with you: {document.title}"
+        in email_content
+    )
+
+
+def test_api_document_invitations__create__email__full_name_empty():
+    """
+    If the full name of the user is empty, it will display the email address.
+    """
+    user = factories.UserFactory(full_name="")
+    document = factories.DocumentFactory()
+    factories.UserDocumentAccessFactory(document=document, user=user, role="owner")
+
+    invitation_values = {
+        "email": "guest@example.com",
+        "role": "reader",
+    }
+
+    assert len(mail.outbox) == 0
+
+    client = APIClient()
+    client.force_login(user)
+    response = client.post(
+        f"/api/v1.0/documents/{document.id}/invitations/",
+        invitation_values,
+        format="json",
+        headers={"Content-Language": "not-supported"},
+    )
+
+    assert response.status_code == status.HTTP_201_CREATED
+    assert response.json()["email"] == "guest@example.com"
+    assert models.Invitation.objects.count() == 1
+    assert len(mail.outbox) == 1
+
+    email = mail.outbox[0]
+
+    assert email.to == ["guest@example.com"]
+
     email_content = " ".join(email.body.split())
     assert f"{user.email} shared a document with you: {document.title}" in email_content
+    assert (
+        f'{user.email} invited you with the role "reader" on the '
+        f"following document : {document.title}" in email_content
+    )
 
 
 def test_api_document_invitations__create__issuer_and_document_override():

src/backend/core/tests/test_models_documents.py

@@ -363,8 +363,9 @@ def test_models_documents__email_invitation__success():
     # pylint: disable-next=no-member
     assert len(mail.outbox) == 0
 
+    sender = factories.UserFactory(full_name="Test Sender", email="sender@example.com")
     document.email_invitation(
-        "en", "guest@example.com", models.RoleChoices.EDITOR, "sender@example.com"
+        "en", "guest@example.com", models.RoleChoices.EDITOR, sender
     )
 
     # pylint: disable-next=no-member
@@ -377,8 +378,8 @@ def test_models_documents__email_invitation__success():
     email_content = " ".join(email.body.split())
 
     assert (
-        f"sender@example.com invited you as an editor on the following document : {document.title}"
-        in email_content
+        f'Test Sender (sender@example.com) invited you with the role "editor" '
+        f"on the following document : {document.title}" in email_content
     )
     assert f"docs/{document.id}/" in email_content
 
@@ -392,8 +393,14 @@ def test_models_documents__email_invitation__success_fr():
     # pylint: disable-next=no-member
     assert len(mail.outbox) == 0
 
+    sender = factories.UserFactory(
+        full_name="Test Sender2", email="sender2@example.com"
+    )
     document.email_invitation(
-        "fr-fr", "guest2@example.com", models.RoleChoices.OWNER, "sender2@example.com"
+        "fr-fr",
+        "guest2@example.com",
+        models.RoleChoices.OWNER,
+        sender,
     )
 
     # pylint: disable-next=no-member
@@ -406,7 +413,7 @@ def test_models_documents__email_invitation__success_fr():
     email_content = " ".join(email.body.split())
 
     assert (
-        f"sender2@example.com vous a invité en tant que propriétaire "
+        f'Test Sender2 (sender2@example.com) vous a invité avec le rôle "propriétaire" '
         f"sur le document suivant : {document.title}" in email_content
     )
     assert f"docs/{document.id}/" in email_content
@@ -424,8 +431,12 @@ def test_models_documents__email_invitation__failed(mock_logger, _mock_send_mail
     # pylint: disable-next=no-member
     assert len(mail.outbox) == 0
 
+    sender = factories.UserFactory()
     document.email_invitation(
-        "en", "guest3@example.com", models.RoleChoices.ADMIN, "sender3@example.com"
+        "en",
+        "guest3@example.com",
+        models.RoleChoices.ADMIN,
+        sender,
     )
 
     # No email has been sent