Merge pull request #4231 from element-hq/feature/bma/incomingCallAvatar

bmarty · web-flow · commit 6362e0165053 · 2025-02-04T17:07:24.000+01:00
Update incoming call notification content to "📹 Incoming call"
diff --git a/features/call/api/src/main/kotlin/io/element/android/features/call/api/ElementCallEntryPoint.kt b/features/call/api/src/main/kotlin/io/element/android/features/call/api/ElementCallEntryPoint.kt
@@ -30,6 +30,7 @@ interface ElementCallEntryPoint {
      * @param avatarUrl The avatar url of the room or DM.
      * @param timestamp The timestamp of the event that started the call.
      * @param notificationChannelId The id of the notification channel to use for the call notification.
+     * @param textContent The text content of the notification. If null the default content from the system will be used.
      */
     fun handleIncomingCall(
         callType: CallType.RoomCall,
@@ -40,5 +41,6 @@ interface ElementCallEntryPoint {
         avatarUrl: String?,
         timestamp: Long,
         notificationChannelId: String,
+        textContent: String?,
     )
 }
diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/DefaultElementCallEntryPoint.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/DefaultElementCallEntryPoint.kt
@@ -43,6 +43,7 @@ class DefaultElementCallEntryPoint @Inject constructor(
         avatarUrl: String?,
         timestamp: Long,
         notificationChannelId: String,
+        textContent: String?,
     ) {
         val incomingCallNotificationData = CallNotificationData(
             sessionId = callType.sessionId,
@@ -54,6 +55,7 @@ class DefaultElementCallEntryPoint @Inject constructor(
             avatarUrl = avatarUrl,
             timestamp = timestamp,
             notificationChannelId = notificationChannelId,
+            textContent = textContent,
         )
         activeCallManager.registerIncomingCall(notificationData = incomingCallNotificationData)
     }
diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/notifications/CallNotificationData.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/notifications/CallNotificationData.kt
@@ -25,4 +25,5 @@ data class CallNotificationData(
     val avatarUrl: String?,
     val notificationChannelId: String,
     val timestamp: Long,
+    val textContent: String?,
 ) : Parcelable
diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/notifications/RingingCallNotificationCreator.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/notifications/RingingCallNotificationCreator.kt
@@ -63,6 +63,7 @@ class RingingCallNotificationCreator @Inject constructor(
         roomAvatarUrl: String?,
         notificationChannelId: String,
         timestamp: Long,
+        textContent: String?,
     ): Notification? {
         val matrixClient = matrixClientProvider.getOrRestore(sessionId).getOrNull() ?: return null
         val imageLoader = imageLoaderHolder.get(matrixClient)
@@ -84,7 +85,8 @@ class RingingCallNotificationCreator @Inject constructor(
             senderName = senderDisplayName,
             avatarUrl = roomAvatarUrl,
             notificationChannelId = notificationChannelId,
-            timestamp = timestamp
+            timestamp = timestamp,
+            textContent = textContent,
         )
 
         val declineIntent = PendingIntentCompat.getBroadcast(
@@ -120,6 +122,10 @@ class RingingCallNotificationCreator @Inject constructor(
             .setOngoing(true)
             .setShowWhen(false)
             .apply {
+                if (textContent != null) {
+                    setContentText(textContent)
+                    // Else the content text is set by the style (will be "Incoming call")
+                }
                 if (ringtoneUri != null) {
                     setSound(ringtoneUri, AudioManager.STREAM_RING)
                 }
diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/ui/IncomingCallScreen.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/ui/IncomingCallScreen.kt
@@ -173,6 +173,7 @@ internal fun IncomingCallScreenPreview() = ElementPreview {
             avatarUrl = null,
             notificationChannelId = "incoming_call",
             timestamp = 0L,
+            textContent = null,
         ),
         onAnswer = {},
         onCancel = {},
diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/ActiveCallManager.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/ActiveCallManager.kt
@@ -160,7 +160,8 @@ class DefaultActiveCallManager @Inject constructor(
             senderDisplayName = notificationData.senderName ?: notificationData.senderId.value,
             roomAvatarUrl = notificationData.avatarUrl,
             notificationChannelId = notificationData.notificationChannelId,
-            timestamp = notificationData.timestamp
+            timestamp = notificationData.timestamp,
+            textContent = notificationData.textContent,
         ) ?: return
         runCatching {
             notificationManagerCompat.notify(
diff --git a/features/call/impl/src/test/kotlin/io/element/android/features/call/DefaultElementCallEntryPointTest.kt b/features/call/impl/src/test/kotlin/io/element/android/features/call/DefaultElementCallEntryPointTest.kt
@@ -54,6 +54,7 @@ class DefaultElementCallEntryPointTest {
             avatarUrl = "avatarUrl",
             timestamp = 0,
             notificationChannelId = "notificationChannelId",
+            textContent = "textContent",
         )
 
         registerIncomingCallLambda.assertions().isCalledOnce()
diff --git a/features/call/impl/src/test/kotlin/io/element/android/features/call/notifications/RingingCallNotificationCreatorTest.kt b/features/call/impl/src/test/kotlin/io/element/android/features/call/notifications/RingingCallNotificationCreatorTest.kt
@@ -73,6 +73,7 @@ class RingingCallNotificationCreatorTest {
         roomAvatarUrl = "https://example.com/avatar.jpg",
         notificationChannelId = "channelId",
         timestamp = 0L,
+        textContent = "textContent",
     )
 
     private fun createRingingCallNotificationCreator(
diff --git a/features/call/test/build.gradle.kts b/features/call/test/build.gradle.kts
@@ -22,4 +22,5 @@ dependencies {
     implementation(projects.features.call.impl)
     implementation(projects.libraries.matrix.api)
     implementation(projects.libraries.matrix.test)
+    implementation(projects.tests.testutils)
 }
diff --git a/features/call/test/src/main/kotlin/io/element/android/features/call/test/CallNotificationData.kt b/features/call/test/src/main/kotlin/io/element/android/features/call/test/CallNotificationData.kt
@@ -30,6 +30,7 @@ fun aCallNotificationData(
     avatarUrl: String? = AN_AVATAR_URL,
     notificationChannelId: String = "channel_id",
     timestamp: Long = 0L,
+    textContent: String? = null,
 ): CallNotificationData = CallNotificationData(
     sessionId = sessionId,
     roomId = roomId,
@@ -40,4 +41,5 @@ fun aCallNotificationData(
     avatarUrl = avatarUrl,
     notificationChannelId = notificationChannelId,
     timestamp = timestamp,
+    textContent = textContent,
 )
diff --git a/features/call/test/src/main/kotlin/io/element/android/features/call/test/FakeElementCallEntryPoint.kt b/features/call/test/src/main/kotlin/io/element/android/features/call/test/FakeElementCallEntryPoint.kt
@@ -11,10 +11,20 @@ import io.element.android.features.call.api.CallType
 import io.element.android.features.call.api.ElementCallEntryPoint
 import io.element.android.libraries.matrix.api.core.EventId
 import io.element.android.libraries.matrix.api.core.UserId
+import io.element.android.tests.testutils.lambda.lambdaError
 
 class FakeElementCallEntryPoint(
-    var startCallResult: (CallType) -> Unit = {},
-    var handleIncomingCallResult: (CallType.RoomCall, EventId, UserId, String?, String?, String?, String) -> Unit = { _, _, _, _, _, _, _ -> }
+    var startCallResult: (CallType) -> Unit = { lambdaError() },
+    var handleIncomingCallResult: (
+        CallType.RoomCall,
+        EventId,
+        UserId,
+        String?,
+        String?,
+        String?,
+        String,
+        String?,
+    ) -> Unit = { _, _, _, _, _, _, _, _ -> lambdaError() }
 ) : ElementCallEntryPoint {
     override fun startCall(callType: CallType) {
         startCallResult(callType)
@@ -28,8 +38,18 @@ class FakeElementCallEntryPoint(
         senderName: String?,
         avatarUrl: String?,
         timestamp: Long,
-        notificationChannelId: String
+        notificationChannelId: String,
+        textContent: String?,
     ) {
-        handleIncomingCallResult(callType, eventId, senderId, roomName, senderName, avatarUrl, notificationChannelId)
+        handleIncomingCallResult(
+            callType,
+            eventId,
+            senderId,
+            roomName,
+            senderName,
+            avatarUrl,
+            notificationChannelId,
+            textContent,
+        )
     }
 }
diff --git a/libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/push/DefaultPushHandler.kt b/libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/push/DefaultPushHandler.kt
@@ -129,6 +129,7 @@ class DefaultPushHandler @Inject constructor(
             avatarUrl = notifiableEvent.roomAvatarUrl,
             timestamp = notifiableEvent.timestamp,
             notificationChannelId = notificationChannels.getChannelForIncomingCall(ring = true),
+            textContent = notifiableEvent.description,
         )
     }
 }
diff --git a/libraries/push/impl/src/test/kotlin/io/element/android/libraries/push/impl/push/DefaultPushHandlerTest.kt b/libraries/push/impl/src/test/kotlin/io/element/android/libraries/push/impl/push/DefaultPushHandlerTest.kt
@@ -238,7 +238,17 @@ class DefaultPushHandlerTest {
             unread = 0,
             clientSecret = A_SECRET,
         )
-        val handleIncomingCallLambda = lambdaRecorder<CallType.RoomCall, EventId, UserId, String?, String?, String?, String, Unit> { _, _, _, _, _, _, _ -> }
+        val handleIncomingCallLambda = lambdaRecorder<
+            CallType.RoomCall,
+            EventId,
+            UserId,
+            String?,
+            String?,
+            String?,
+            String,
+            String?,
+            Unit,
+            > { _, _, _, _, _, _, _, _ -> }
         val elementCallEntryPoint = FakeElementCallEntryPoint(handleIncomingCallResult = handleIncomingCallLambda)
         val onNotifiableEventReceived = lambdaRecorder<NotifiableEvent, Unit> {}
         val defaultPushHandler = createDefaultPushHandler(
@@ -266,7 +276,17 @@ class DefaultPushHandlerTest {
             clientSecret = A_SECRET,
         )
         val onNotifiableEventReceived = lambdaRecorder<NotifiableEvent, Unit> {}
-        val handleIncomingCallLambda = lambdaRecorder<CallType.RoomCall, EventId, UserId, String?, String?, String?, String, Unit> { _, _, _, _, _, _, _ -> }
+        val handleIncomingCallLambda = lambdaRecorder<
+            CallType.RoomCall,
+            EventId,
+            UserId,
+            String?,
+            String?,
+            String?,
+            String,
+            String?,
+            Unit,
+            > { _, _, _, _, _, _, _, _ -> }
         val elementCallEntryPoint = FakeElementCallEntryPoint(handleIncomingCallResult = handleIncomingCallLambda)
         val defaultPushHandler = createDefaultPushHandler(
             elementCallEntryPoint = elementCallEntryPoint,
@@ -294,7 +314,17 @@ class DefaultPushHandlerTest {
             clientSecret = A_SECRET,
         )
         val onNotifiableEventReceived = lambdaRecorder<NotifiableEvent, Unit> {}
-        val handleIncomingCallLambda = lambdaRecorder<CallType.RoomCall, EventId, UserId, String?, String?, String?, String, Unit> { _, _, _, _, _, _, _ -> }
+        val handleIncomingCallLambda = lambdaRecorder<
+            CallType.RoomCall,
+            EventId,
+            UserId,
+            String?,
+            String?,
+            String?,
+            String,
+            String?,
+            Unit,
+            > { _, _, _, _, _, _, _, _ -> }
         val elementCallEntryPoint = FakeElementCallEntryPoint(handleIncomingCallResult = handleIncomingCallLambda)
         val defaultPushHandler = createDefaultPushHandler(
             elementCallEntryPoint = elementCallEntryPoint,
diff --git a/tests/testutils/src/main/kotlin/io/element/android/tests/testutils/lambda/LambdaRecorder.kt b/tests/testutils/src/main/kotlin/io/element/android/tests/testutils/lambda/LambdaRecorder.kt
@@ -83,6 +83,13 @@ inline fun <reified T1, reified T2, reified T3, reified T4, reified T5, reified
     return LambdaSevenParamsRecorder(ensureNeverCalled, block)
 }
 
+inline fun <reified T1, reified T2, reified T3, reified T4, reified T5, reified T6, reified T7, reified T8, reified R> lambdaRecorder(
+    ensureNeverCalled: Boolean = false,
+    noinline block: (T1, T2, T3, T4, T5, T6, T7, T8) -> R
+): LambdaEightParamsRecorder<T1, T2, T3, T4, T5, T6, T7, T8, R> {
+    return LambdaEightParamsRecorder(ensureNeverCalled, block)
+}
+
 inline fun <reified R> lambdaAnyRecorder(
     ensureNeverCalled: Boolean = false,
     noinline block: (List<Any?>) -> R

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ interface ElementCallEntryPoint {`
`30`	`30`	`* @param avatarUrl The avatar url of the room or DM.`
`31`	`31`	`* @param timestamp The timestamp of the event that started the call.`
`32`	`32`	`* @param notificationChannelId The id of the notification channel to use for the call notification.`
	`33`	`+ * @param textContent The text content of the notification. If null the default content from the system will be used.`
`33`	`34`	`*/`
`34`	`35`	`fun handleIncomingCall(`
`35`	`36`	`callType: CallType.RoomCall,`
`@@ -40,5 +41,6 @@ interface ElementCallEntryPoint {`
`40`	`41`	`avatarUrl: String?,`
`41`	`42`	`timestamp: Long,`
`42`	`43`	`notificationChannelId: String,`
	`44`	`+ textContent: String?,`
`43`	`45`	`)`
`44`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ class DefaultElementCallEntryPointTest {`
`54`	`54`	`avatarUrl = "avatarUrl",`
`55`	`55`	`timestamp = 0,`
`56`	`56`	`notificationChannelId = "notificationChannelId",`
	`57`	`+ textContent = "textContent",`
`57`	`58`	`)`
`58`	`59`
`59`	`60`	`registerIncomingCallLambda.assertions().isCalledOnce()`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ class RingingCallNotificationCreatorTest {`
`73`	`73`	`roomAvatarUrl = "https://example.com/avatar.jpg",`
`74`	`74`	`notificationChannelId = "channelId",`
`75`	`75`	`timestamp = 0L,`
	`76`	`+ textContent = "textContent",`
`76`	`77`	`)`
`77`	`78`
`78`	`79`	`private fun createRingingCallNotificationCreator(`
Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,5 @@ dependencies {`
`22`	`22`	`implementation(projects.features.call.impl)`
`23`	`23`	`implementation(projects.libraries.matrix.api)`
`24`	`24`	`implementation(projects.libraries.matrix.test)`
	`25`	`+ implementation(projects.tests.testutils)`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ class DefaultPushHandler @Inject constructor(`
`129`	`129`	`avatarUrl = notifiableEvent.roomAvatarUrl,`
`130`	`130`	`timestamp = notifiableEvent.timestamp,`
`131`	`131`	`notificationChannelId = notificationChannels.getChannelForIncomingCall(ring = true),`
	`132`	`+ textContent = notifiableEvent.description,`
`132`	`133`	`)`
`133`	`134`	`}`
`134`	`135`	`}`