Format state Event: use disambiguated Display name #2722.

- Rename some parameter and val from `senderDisplayName` (and consort) to `senderDisambiguatedDisplayName`.
- In `InReplyToDetails`, replace `senderDisplayName` and `senderAvatarUrl` by `senderProfile`.

libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/notifications/NotifiableEventResolver.kt

@@ -93,8 +93,8 @@ class NotifiableEventResolver @Inject constructor(
     ): NotifiableEvent? {
         return when (val content = this.content) {
             is NotificationContent.MessageLike.RoomMessage -> {
-                val senderName = getSenderName(content.senderId)
-                val messageBody = descriptionFromMessageContent(content, senderName)
+                val senderDisambiguatedDisplayName = getDisambiguatedDisplayName(content.senderId)
+                val messageBody = descriptionFromMessageContent(content, senderDisambiguatedDisplayName)
                 val notificationBody = if (hasMention) {
                     stringProvider.getString(R.string.notification_mentioned_you_body, messageBody)
                 } else {
@@ -107,7 +107,7 @@ class NotifiableEventResolver @Inject constructor(
                     eventId = eventId,
                     noisy = isNoisy,
                     timestamp = this.timestamp,
-                    senderName = senderName,
+                    senderDisambiguatedDisplayName = senderDisambiguatedDisplayName,
                     body = notificationBody,
                     imageUriString = fetchImageIfPresent(client)?.toString(),
                     roomName = roomDisplayName,
@@ -154,7 +154,7 @@ class NotifiableEventResolver @Inject constructor(
                     eventId = eventId,
                     noisy = isNoisy,
                     timestamp = this.timestamp,
-                    senderName = null,
+                    senderDisambiguatedDisplayName = getDisambiguatedDisplayName(content.senderId),
                     body = stringProvider.getString(CommonStrings.common_call_invite),
                     imageUriString = fetchImageIfPresent(client)?.toString(),
                     roomName = roomDisplayName,
@@ -180,7 +180,7 @@ class NotifiableEventResolver @Inject constructor(
                     eventId = eventId,
                     noisy = isNoisy,
                     timestamp = this.timestamp,
-                    senderName = getSenderName(content.senderId),
+                    senderDisambiguatedDisplayName = getDisambiguatedDisplayName(content.senderId),
                     body = stringProvider.getString(CommonStrings.common_poll_summary, content.question),
                     imageUriString = null,
                     roomName = roomDisplayName,
@@ -244,12 +244,12 @@ class NotifiableEventResolver @Inject constructor(
 
     private fun descriptionFromMessageContent(
         content: NotificationContent.MessageLike.RoomMessage,
-        senderDisplayName: String,
+        senderDisambiguatedDisplayName: String,
     ): String {
         return when (val messageType = content.messageType) {
             is AudioMessageType -> messageType.body
             is VoiceMessageType -> stringProvider.getString(CommonStrings.common_voice_message)
-            is EmoteMessageType -> "* $senderDisplayName ${messageType.body}"
+            is EmoteMessageType -> "* $senderDisambiguatedDisplayName ${messageType.body}"
             is FileMessageType -> messageType.body
             is ImageMessageType -> messageType.body
             is StickerMessageType -> messageType.body
@@ -310,7 +310,7 @@ private fun buildNotifiableMessageEvent(
     canBeReplaced: Boolean = false,
     noisy: Boolean,
     timestamp: Long,
-    senderName: String?,
+    senderDisambiguatedDisplayName: String?,
     body: String?,
     // We cannot use Uri? type here, as that could trigger a
     // NotSerializableException when persisting this to storage
@@ -335,7 +335,7 @@ private fun buildNotifiableMessageEvent(
     canBeReplaced = canBeReplaced,
     noisy = noisy,
     timestamp = timestamp,
-    senderName = senderName,
+    senderDisambiguatedDisplayName = senderDisambiguatedDisplayName,
     body = body,
     imageUriString = imageUriString,
     threadId = threadId,

libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/notifications/RoomGroupMessageCreator.kt

@@ -45,7 +45,7 @@ class RoomGroupMessageCreator @Inject constructor(
         imageLoader: ImageLoader,
     ): RoomNotification.Message {
         val lastKnownRoomEvent = events.last()
-        val roomName = lastKnownRoomEvent.roomName ?: lastKnownRoomEvent.senderName ?: "Room name (${roomId.value.take(8)}…)"
+        val roomName = lastKnownRoomEvent.roomName ?: lastKnownRoomEvent.senderDisambiguatedDisplayName ?: "Room name (${roomId.value.take(8)}…)"
         val roomIsGroup = !lastKnownRoomEvent.roomIsDirect
         val style = NotificationCompat.MessagingStyle(
             Person.Builder()
@@ -60,9 +60,9 @@ class RoomGroupMessageCreator @Inject constructor(
         }
 
         val tickerText = if (roomIsGroup) {
-            stringProvider.getString(R.string.notification_ticker_text_group, roomName, events.last().senderName, events.last().description)
+            stringProvider.getString(R.string.notification_ticker_text_group, roomName, events.last().senderDisambiguatedDisplayName, events.last().description)
         } else {
-            stringProvider.getString(R.string.notification_ticker_text_dm, events.last().senderName, events.last().description)
+            stringProvider.getString(R.string.notification_ticker_text_dm, events.last().senderDisambiguatedDisplayName, events.last().description)
         }
 
         val largeBitmap = getRoomBitmap(events, imageLoader)
@@ -108,7 +108,7 @@ class RoomGroupMessageCreator @Inject constructor(
                 null
             } else {
                 Person.Builder()
-                    .setName(event.senderName?.annotateForDebug(70))
+                    .setName(event.senderDisambiguatedDisplayName?.annotateForDebug(70))
                     .setIcon(bitmapLoader.getUserIcon(event.senderAvatarPath, imageLoader))
                     .setKey(event.senderId.value)
                     .build()
@@ -152,7 +152,7 @@ class RoomGroupMessageCreator @Inject constructor(
     private fun createFirstMessageSummaryLine(event: NotifiableMessageEvent, roomName: String, roomIsDirect: Boolean): CharSequence {
         return if (roomIsDirect) {
             buildSpannedString {
-                event.senderName?.let {
+                event.senderDisambiguatedDisplayName?.let {
                     inSpans(StyleSpan(Typeface.BOLD)) {
                         append(it)
                         append(": ")
@@ -165,7 +165,7 @@ class RoomGroupMessageCreator @Inject constructor(
                 inSpans(StyleSpan(Typeface.BOLD)) {
                     append(roomName)
                     append(": ")
-                    event.senderName?.let {
+                    event.senderDisambiguatedDisplayName?.let {
                         append(it)
                         append(" ")
                     }

libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/notifications/model/NotifiableMessageEvent.kt

@@ -36,7 +36,7 @@ data class NotifiableMessageEvent(
     val senderId: UserId,
     val noisy: Boolean,
     val timestamp: Long,
-    val senderName: String?,
+    val senderDisambiguatedDisplayName: String?,
     val body: String?,
     // We cannot use Uri? type here, as that could trigger a
     // NotSerializableException when persisting this to storage
@@ -55,7 +55,6 @@ data class NotifiableMessageEvent(
 ) : NotifiableEvent {
     val type: String = EventType.MESSAGE
     override val description: String = body ?: ""
-    val title: String = senderName ?: ""
 
     // Example of value:
     // content://io.element.android.x.debug.notifications.fileprovider/downloads/temp/notif/matrix.org/XGItzSDOnSyXjYtOPfiKexDJ

libraries/push/impl/src/test/kotlin/io/element/android/libraries/push/impl/notifications/NotifiableEventResolverTest.kt

@@ -462,7 +462,7 @@ class NotifiableEventResolverTest {
             senderId = A_USER_ID_2,
             noisy = false,
             timestamp = A_TIMESTAMP,
-            senderName = null,
+            senderDisambiguatedDisplayName = null,
             body = "Call in progress (unsupported)",
             imageUriString = null,
             threadId = null,
@@ -586,7 +586,7 @@ class NotifiableEventResolverTest {
             senderId = A_USER_ID_2,
             noisy = false,
             timestamp = A_TIMESTAMP,
-            senderName = "Bob",
+            senderDisambiguatedDisplayName = "Bob",
             body = body,
             imageUriString = null,
             threadId = null,

libraries/push/impl/src/test/kotlin/io/element/android/libraries/push/impl/notifications/fixtures/NotifiableEventFixture.kt

@@ -85,7 +85,7 @@ fun aNotifiableMessageEvent(
     editedEventId = null,
     noisy = false,
     timestamp = timestamp,
-    senderName = "sender-name",
+    senderDisambiguatedDisplayName = "sender-name",
     senderId = UserId("@sending-id:domain.com"),
     body = "message-body",
     roomId = roomId,