WEBRTC-2550: Prevent socket disconnection when minimized and fix notification handling (#460)

* WEBRTC-2550: Prevent socket disconnection when app is minimized during active call

* fix: disconnection on notification tap through onStop on MainActivity

* chore: bump androidx_core

* WEBRTC-2550: Implement CallNotification integration

- Created CallNotificationService using NotificationCompat.CallStyle API
- Created CallNotificationReceiver to handle notification actions
- Updated MyFirebaseMessagingService to use the new CallNotificationService
- Updated NotificationsService to support both legacy and modern notification styles
- Updated AndroidManifest.xml files to register the new receiver

* fix: import ComponentName and adjust notificationManager declaration

* chore: update manifest to allow for full screen intent (required for call permissions)

* WEBRTC-2550: Implement CallForegroundService to keep audio alive when minimized

* feat: use correct callerName and callerNumber and handle call cancellation better

* fix: catch better exceptions and remove magic number

* chore: add service type as phone call

* chore: add microphone permission

* WEBRTC-2550: Fix socket disconnects when minimized during active calls

- Added static flag in CallForegroundService to track if service is already running\n- Added method to check if service is running using both flag and system service check\n- Updated TelnyxViewModel to check if service is already running before starting it\n- Improved error handling in startForeground method to gracefully fall back to PHONE_CALL only if MICROPHONE permission fails\n- Added proper cleanup of service flag in onCreate, onStartCommand, and onDestroy

* feat: startCallService before the app goes into the background

* feat: catch specific exceptions and use singleTask to only open existing Activity

* feat: catch non generic exceptions

* WEBRTC-2550: Fix background activity launch blocked issue and make notification click accept call

* Revert "WEBRTC-2550: Fix background activity launch blocked issue and make notification click accept call"

This reverts commit 6875ade.

* chore: add requiresAPI calls and adjust manifest for XML app

* WEBRTC-2550: Fix background activity launch blocked issue and make notification click accept call

* Revert "WEBRTC-2550: Fix background activity launch blocked issue and make notification click accept call"

This reverts commit bf479af.

* feat: use pending intent with activities instead of notification receiver

* fix: rejection from push notification no longer starts call service

* chore: bump up wait time for tests for slow connections

* feat: more reliable form of call service start / stop (based on current call)

* fix: set _handling push to false whenever a call ends - even if it wasn't true before just in case

* fix: if device is locked, don't use full screen intent (as it attempts to launch activity)

* feat: stop service when disconnecting if one is running

* chore: clearer documentation on notification broadcast receiver usage

* fix: ignore local candidates during negotiation, use shared mediaConstraints and adjust changelog for 1.5.1 release

* fix: use IceTransportsType as NOHOST

* chore: remove duplicate import logger

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: Oliver Zimmerman <oezimmerman@gmail.com>

Author: 3 people

.gitignore

@@ -92,3 +92,4 @@ connection_service_app/google-services.json
 
 # system
 .DS_Store
+/platform-samples/

compose_app/src/androidTest/java/org/telnyx/webrtc/compose_app/MainActivityTest.kt

@@ -62,7 +62,7 @@ class MainActivityTest {
         composeTestRule.waitForIdle()
         composeTestRule.onNodeWithText(context.getString(R.string.connect)).performClick()
 
-        composeTestRule.waitUntil(10000) {
+        composeTestRule.waitUntil(15000) {
             composeTestRule.onNodeWithText(context.getString(R.string.disconnect)).isDisplayed()
         }
 
@@ -76,7 +76,7 @@ class MainActivityTest {
 
         composeTestRule.waitForIdle()
 
-        composeTestRule.waitUntil(30000) {
+        composeTestRule.waitUntil(40000) {
             composeTestRule.onNodeWithTag("callActiveView").isDisplayed()
         }
 

compose_app/src/main/AndroidManifest.xml

@@ -4,7 +4,10 @@
     <uses-permission android:name="android.permission.RECORD_AUDIO"/>
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE_PHONE_CALL"/>
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
     <uses-permission android:name="android.permission.MANAGE_OWN_CALLS"/>
+    <uses-permission android:name="android.permission.USE_FULL_SCREEN_INTENT" />
+
 
     <application
         android:allowBackup="true"
@@ -17,6 +20,7 @@
         <activity
             android:name=".MainActivity"
             android:exported="true"
+            android:launchMode="singleTask"
             android:theme="@style/Theme.TelnyxAndroidWebRTCSDK">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
@@ -50,6 +54,18 @@
                 android:name="activity_class_name"
                 android:value="org.telnyx.webrtc.compose_app.MainActivity" />
         </service>
+
+        <service android:name="com.telnyx.webrtc.common.service.CallForegroundService"
+            android:enabled="true"
+            android:exported="true"
+            android:foregroundServiceType="phoneCall|microphone"
+            android:permission="android.permission.FOREGROUND_SERVICE_PHONE_CALL"
+            android:process=":call_service" />
+        
+        <receiver
+            android:name="com.telnyx.webrtc.common.notification.CallNotificationReceiver"
+            android:enabled="true"
+            android:exported="false" />
     </application>
 
 </manifest>

compose_app/src/main/java/org/telnyx/webrtc/compose_app/MainActivity.kt

@@ -96,36 +96,45 @@ class MainActivity : ComponentActivity(), DefaultLifecycleObserver {
     }
 
     private fun checkPermission() {
+        // Create a mutable list of permissions that will always be needed.
+        val permissions = mutableListOf(
+            android.Manifest.permission.RECORD_AUDIO
+        )
+
+        // Conditionally add permissions based on the API level.
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-            Dexter.withContext(this)
-                .withPermissions(
-                    android.Manifest.permission.POST_NOTIFICATIONS,
-                    android.Manifest.permission.RECORD_AUDIO
-                )
-                .withListener(object : MultiplePermissionsListener {
-                    override fun onPermissionsChecked(report: MultiplePermissionsReport?) {
-                        report?.let {
-                            if (report.areAllPermissionsGranted()) {
-                                // All permissions are granted
-                            } else {
-                                // Some permissions are denied
-                                Toast.makeText(
-                                    this@MainActivity,
-                                    getString(R.string.notification_permission_text),
-                                    Toast.LENGTH_LONG
-                                ).show()
-                            }
+            permissions.add(android.Manifest.permission.POST_NOTIFICATIONS)
+        }
+        if (Build.VERSION.SDK_INT >= 34) { // Only available on Android 14 and above.
+            permissions.add(android.Manifest.permission.FOREGROUND_SERVICE_MICROPHONE)
+        }
+
+        // Now use Dexter to check the permissions.
+        Dexter.withContext(this)
+            .withPermissions(*permissions.toTypedArray())
+            .withListener(object : MultiplePermissionsListener {
+                override fun onPermissionsChecked(report: MultiplePermissionsReport?) {
+                    report?.let {
+                        if (report.areAllPermissionsGranted()) {
+                            // All permissions are granted.
+                        } else {
+                            // Some permissions are denied.
+                            Toast.makeText(
+                                this@MainActivity,
+                                getString(R.string.notification_permission_text),
+                                Toast.LENGTH_LONG
+                            ).show()
                         }
                     }
+                }
 
-                    override fun onPermissionRationaleShouldBeShown(
-                        permissions: MutableList<PermissionRequest>?,
-                        token: PermissionToken?
-                    ) {
-                        token?.continuePermissionRequest()
-                    }
-                }).check()
-        }
+                override fun onPermissionRationaleShouldBeShown(
+                    permissions: MutableList<PermissionRequest>?,
+                    token: PermissionToken?
+                ) {
+                    token?.continuePermissionRequest()
+                }
+            }).check()
     }
 }
 

compose_app/src/main/java/org/telnyx/webrtc/compose_app/ui/screens/HomeScreen.kt

@@ -109,7 +109,7 @@ fun HomeScreen(navController: NavHostController, telnyxViewModel: TelnyxViewMode
     Scaffold(modifier = Modifier.padding(Dimens.mediumSpacing),
         topBar = {
             Column(
-                verticalArrangement = Arrangement.spacedBy(Dimens.mediumSpacing),
+                verticalArrangement = Arrangement.spacedBy(Dimens.smallSpacing),
             ) {
                 Spacer(modifier = Modifier.size(Dimens.mediumSpacing))
 
@@ -162,10 +162,10 @@ fun HomeScreen(navController: NavHostController, telnyxViewModel: TelnyxViewMode
                 bottom = it.calculateBottomPadding(),
                 top = it.calculateTopPadding()
             ),
-            verticalArrangement = Arrangement.spacedBy(Dimens.mediumSpacing),
+            verticalArrangement = Arrangement.spacedBy(Dimens.smallSpacing),
         ) {
 
-            Spacer(modifier = Modifier.size(Dimens.mediumSpacing))
+            Spacer(modifier = Modifier.size(Dimens.smallSpacing))
 
             NavHost(navController = navController, startDestination = LoginScreenNav) {
                 composable<LoginScreenNav> {
@@ -556,15 +556,15 @@ fun ProfileSwitcher(profileName: String, onProfileSwitch: () -> Unit = {}) {
 
 @Composable
 fun SessionItem(sessionId: String) {
-    Column(verticalArrangement = Arrangement.spacedBy(Dimens.extraSmallSpacing)) {
+    Column(verticalArrangement = Arrangement.spacedBy(Dimens.spacing4dp)) {
         RegularText(text = stringResource(id = R.string.session_id))
         RegularText(text = sessionId)
     }
 }
 
 @Composable
 fun ConnectionState(state: Boolean) {
-    Column(verticalArrangement = Arrangement.spacedBy(Dimens.extraSmallSpacing)) {
+    Column(verticalArrangement = Arrangement.spacedBy(Dimens.spacing4dp)) {
         RegularText(text = stringResource(id = R.string.socket))
         Row(
             horizontalArrangement = Arrangement.spacedBy(Dimens.extraSmallSpacing),
@@ -590,7 +590,7 @@ fun ConnectionState(state: Boolean) {
 @Composable
 fun CurrentCallState(state: CallState) {
     if (state == CallState.DONE) return
-    Column(verticalArrangement = Arrangement.spacedBy(Dimens.extraSmallSpacing)) {
+    Column(verticalArrangement = Arrangement.spacedBy(Dimens.spacing4dp)) {
         RegularText(text = stringResource(id = R.string.call_state))
         RegularText(text = state.name)
     }

compose_app/src/main/res/values/strings.xml

@@ -37,7 +37,7 @@
     <string name="off">Off</string>
     <string name="on">On</string>
     <string name="audio_settings">Audio Output Device</string>
-    <string name="call_state">Call State:</string>
+    <string name="call_state">Call State</string>
     <string name="show_wsmessages">WsMessages</string>
     <string name="clear_wsmessages">Clear WsMessages</string>
     <string name="share_wsmessages">Share WsMessages</string>

telnyx_common/src/main/AndroidManifest.xml

@@ -2,5 +2,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
 
-
 </manifest>

telnyx_common/src/main/java/com/telnyx/webrtc/common/TelnyxCommon.kt

@@ -3,10 +3,14 @@ package com.telnyx.webrtc.common
 import android.content.Context
 import android.content.SharedPreferences
 import androidx.lifecycle.Observer
+import com.telnyx.webrtc.common.service.CallForegroundService
 import com.telnyx.webrtc.sdk.Call
 import com.telnyx.webrtc.sdk.TelnyxClient
+import com.telnyx.webrtc.sdk.model.PushMetaData
+import com.telnyx.webrtc.sdk.verto.receive.InviteResponse
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
+import timber.log.Timber
 import java.util.*
 
 /**
@@ -19,7 +23,9 @@ class TelnyxCommon private constructor() {
     private var sharedPreferences: SharedPreferences? = null
     private val sharedPreferencesKey = "TelnyxCommonSharedPreferences"
 
-    private var telnyxClient: TelnyxClient? = null
+    private var _telnyxClient: TelnyxClient? = null
+    val telnyxClient
+        get() = _telnyxClient
 
     private var _currentCall: Call? = null
     val currentCall
@@ -31,6 +37,10 @@ class TelnyxCommon private constructor() {
 
     private val holdStatusObservers: MutableMap<Call, Observer<Boolean>> = mutableMapOf()
 
+    private var _handlingPush = false
+    val handlingPush
+        get() = _handlingPush
+
     companion object {
         @Volatile
         private var instance: TelnyxCommon? = null
@@ -47,18 +57,24 @@ class TelnyxCommon private constructor() {
         }
     }
 
-    internal fun setCurrentCall(call: Call?) {
+    internal fun setCurrentCall(context: Context, call: Call?) {
         call?.let { newCall ->
             telnyxClient?.getActiveCalls()?.get(newCall.callId)?.let {
                 _currentCall = it
+                // Start the CallForegroundService - if one is not already running
+                startCallService(context, it)
             }
         } ?: run {
             _currentCall = null
+            // if we have no active call, stop the CallForegroundService
+            stopCallService(context)
+            // reset handling push flag, even if we were not previously handling push
+            _handlingPush = false
         }
     }
 
     internal fun registerCall(call: Call) {
-        val holdStatusObserver = Observer<Boolean> { value ->
+        val holdStatusObserver = Observer<Boolean> { _ ->
             updateHoldedCalls()
         }
         holdStatusObservers[call] = holdStatusObserver
@@ -71,16 +87,52 @@ class TelnyxCommon private constructor() {
         }
     }
 
+    private fun startCallService(viewContext: Context, call: Call?) {
+        // Check if the service is already running
+        if (CallForegroundService.isServiceRunning(viewContext)) {
+            Timber.d("CallForegroundService is already running, not starting again")
+            return
+        }
+
+        val pushMetaData = PushMetaData(
+            callerName = call?.inviteResponse?.callerIdName ?: "Active Call",
+            callerNumber =  call?.inviteResponse?.callerIdNumber ?: "",
+            callId =  call?.callId.toString(),
+        )
+
+        try {
+            // Start the foreground service
+            CallForegroundService.startService(viewContext, pushMetaData)
+            Timber.d("Started CallForegroundService for ongoing call")
+        } catch (e: IllegalStateException) {
+            Timber.e(e, "Failed to start CallForegroundService: ${e.message}")
+        }
+    }
+
+    internal fun stopCallService(context: Context) {
+        try {
+            context.let {
+                if (CallForegroundService.isServiceRunning(it)) {
+                    CallForegroundService.stopService(it)
+                    Timber.d("Stopped CallForegroundService after call ended by remote party")
+                }
+            }
+        } catch (e: IllegalStateException) {
+            Timber.e(e, "Failed to stop CallForegroundService: ${e.message}")
+        }
+    }
+
     internal fun getTelnyxClient(context: Context): TelnyxClient {
-        return telnyxClient ?: synchronized(this) {
-            telnyxClient ?: TelnyxClient(context.applicationContext).also { telnyxClient = it }
+        return _telnyxClient ?: synchronized(this) {
+            _telnyxClient ?: TelnyxClient(context.applicationContext).also { _telnyxClient = it }
         }
     }
 
     internal fun resetTelnyxClient() {
-        telnyxClient = null
+        _telnyxClient = null
     }
 
+
     internal fun getSharedPreferences(context: Context): SharedPreferences {
         return sharedPreferences ?: synchronized(this) {
             sharedPreferences ?: context.getSharedPreferences(
@@ -90,6 +142,10 @@ class TelnyxCommon private constructor() {
         }
     }
 
+    internal fun setHandlingPush(value: Boolean) {
+        _handlingPush = value
+    }
+
     private fun updateHoldedCalls() {
         _holdedCalls.value = telnyxClient?.getActiveCalls()?.entries?.filter { it.value.getIsOnHoldStatus().value == true }?.map { it.value } ?: emptyList()
     }