Add support for showing the native OS incoming call screen when starting new Element Calls

ElementX/Sources/Screens/CallScreen/CallScreenCoordinator.swift

@@ -18,10 +18,9 @@ import Combine
 import SwiftUI
 
 struct CallScreenCoordinatorParameters {
+    let elementCallService: ElementCallServiceProtocol
     let roomProxy: RoomProxyProtocol
-    /// Which Element Call instance should be used
     let callBaseURL: URL
-    /// A way to identify the current client against Element Call
     let clientID: String
 }
 
@@ -39,7 +38,8 @@ final class CallScreenCoordinator: CoordinatorProtocol {
     }
     
     init(parameters: CallScreenCoordinatorParameters) {
-        viewModel = CallScreenViewModel(roomProxy: parameters.roomProxy,
+        viewModel = CallScreenViewModel(elementCallService: parameters.elementCallService,
+                                        roomProxy: parameters.roomProxy,
                                         callBaseURL: parameters.callBaseURL,
                                         clientID: parameters.clientID)
     }

ElementX/Sources/Screens/CallScreen/CallScreenViewModel.swift

@@ -14,7 +14,6 @@
 // limitations under the License.
 //
 
-import AVFoundation
 import CallKit
 import Combine
 import SwiftUI
@@ -22,33 +21,31 @@ import SwiftUI
 typealias CallScreenViewModelType = StateStoreViewModel<CallScreenViewState, CallScreenViewAction>
 
 class CallScreenViewModel: CallScreenViewModelType, CallScreenViewModelProtocol {
+    private let elementCallService: ElementCallServiceProtocol
     private let roomProxy: RoomProxyProtocol
     
     private let widgetDriver: ElementCallWidgetDriverProtocol
     
-    private let callController = CXCallController()
-    // periphery: ignore - call kit magic do not remove
-    private let callProvider = CXProvider(configuration: .init())
-    
-    private let callID = UUID()
-    
     private let actionsSubject: PassthroughSubject<CallScreenViewModelAction, Never> = .init()
     var actions: AnyPublisher<CallScreenViewModelAction, Never> {
         actionsSubject.eraseToAnyPublisher()
     }
     
     deinit {
-        tearDownVoIPSession(callID: callID)
+        elementCallService.tearDownCallSession()
     }
     
     /// Designated initialiser
     /// - Parameters:
+    ///   - elementCallService: service responsible for setting up CallKit
     ///   - roomProxy: The room in which the call should be created
     ///   - callBaseURL: Which Element Call instance should be used
     ///   - clientID: Something to identify the current client on the Element Call side
-    init(roomProxy: RoomProxyProtocol,
+    init(elementCallService: ElementCallServiceProtocol,
+         roomProxy: RoomProxyProtocol,
          callBaseURL: URL,
          clientID: String) {
+        self.elementCallService = elementCallService
         self.roomProxy = roomProxy
         
         widgetDriver = roomProxy.elementCallWidgetDriver()
@@ -109,11 +106,9 @@ class CallScreenViewModel: CallScreenViewModelType, CallScreenViewModelProtocol
                 return
             }
             
-            do {
-                try await setupVoIPSession(callID: callID)
-            } catch {
-                MXLog.error("Failed setting up VoIP session with error: \(error)")
-            }
+            await elementCallService.setupCallSession(title: roomProxy.roomTitle)
+            
+            let _ = await roomProxy.sendCallNotificationIfNeeeded()
         }
     }
     
@@ -125,20 +120,6 @@ class CallScreenViewModel: CallScreenViewModelType, CallScreenViewModelProtocol
         }
     }
     
-    // MARK: - CXCallObserverDelegate
-    
-    // periphery: ignore - call kit magic do not remove
-    func callObserver(_ callObserver: CXCallObserver, callChanged call: CXCall) {
-        MXLog.info("Call changed: \(call)")
-    }
-    
-    // MARK: - CXProviderDelegate
-    
-    // periphery: ignore - call kit magic do not remove
-    func providerDidReset(_ provider: CXProvider) {
-        MXLog.info("Call provider did reset: \(provider)")
-    }
-    
     // MARK: - Private
 
     private static let eventHandlerName = "elementx"
@@ -160,34 +141,4 @@ class CallScreenViewModel: CallScreenViewModelType, CallScreenViewModelProtocol
           );
         """
     }
-    
-    private func setupVoIPSession(callID: UUID) async throws {
-        try AVAudioSession.sharedInstance().setCategory(.playAndRecord, mode: .videoChat, options: [])
-        try AVAudioSession.sharedInstance().setActive(true, options: .notifyOthersOnDeactivation)
-        
-        let handle = CXHandle(type: .generic, value: roomProxy.roomTitle)
-        let startCallAction = CXStartCallAction(call: callID, handle: handle)
-        startCallAction.isVideo = true
-        
-        let transaction = CXTransaction(action: startCallAction)
-        
-        try await callController.request(transaction)
-    }
-    
-    private nonisolated func tearDownVoIPSession(callID: UUID?) {
-        guard let callID else {
-            return
-        }
-        
-        try? AVAudioSession.sharedInstance().setActive(false)
-            
-        let endCallAction = CXEndCallAction(call: callID)
-        let transaction = CXTransaction(action: endCallAction)
-        
-        callController.request(transaction) { error in
-            if let error {
-                MXLog.error("Failed transaction with error: \(error)")
-            }
-        }
-    }
 }

ElementX/Sources/Screens/CallScreen/View/CallScreen.swift

@@ -167,7 +167,8 @@ struct CallScreen_Previews: PreviewProvider {
         
         roomProxy.elementCallWidgetDriverReturnValue = widgetDriver
         
-        return CallScreenViewModel(roomProxy: roomProxy,
+        return CallScreenViewModel(elementCallService: ElementCallServiceMock(),
+                                   roomProxy: roomProxy,
                                    callBaseURL: "https://call.element.io",
                                    clientID: "io.element.elementx")
     }()