Remove GenericCallLinkCoordinator, merging it into CallScreen. (#3181)

* Remove incorrect message send call and fix typo.

* Add overlay coordinator presentation to the NavigationRootCoordinator.

* Remove GenericCallLinkCoordinator, merging it into CallScreen.

This will allow for picture in picture on call links when available.

ElementX/Sources/Services/ElementCall/ElementCallConfiguration.swift

@@ -0,0 +1,88 @@
+//
+// Copyright 2024 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+private enum GenericCallLinkQueryParameters {
+    static let appPrompt = "appPrompt"
+    static let confineToRoom = "confineToRoom"
+}
+
+/// Information about how a call should be configured.
+struct ElementCallConfiguration {
+    enum Kind {
+        case genericCallLink(URL)
+        case roomCall(roomProxy: RoomProxyProtocol,
+                      clientProxy: ClientProxyProtocol,
+                      clientID: String,
+                      elementCallBaseURL: URL,
+                      elementCallBaseURLOverride: URL?,
+                      colorScheme: ColorScheme)
+    }
+    
+    /// The type of call being configured i.e. whether it's an external URL or an internal room call.
+    let kind: Kind
+    
+    /// Creates a configuration for an external call URL.
+    init(genericCallLink url: URL) {
+        if var urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: true) {
+            var fragmentQueryItems = urlComponents.fragmentQueryItems ?? []
+            
+            fragmentQueryItems.removeAll { $0.name == GenericCallLinkQueryParameters.appPrompt }
+            fragmentQueryItems.removeAll { $0.name == GenericCallLinkQueryParameters.confineToRoom }
+            
+            fragmentQueryItems.append(.init(name: GenericCallLinkQueryParameters.appPrompt, value: "false"))
+            fragmentQueryItems.append(.init(name: GenericCallLinkQueryParameters.confineToRoom, value: "true"))
+            
+            urlComponents.fragmentQueryItems = fragmentQueryItems
+            
+            if let adjustedURL = urlComponents.url {
+                kind = .genericCallLink(adjustedURL)
+            } else {
+                MXLog.error("Failed adjusting URL with components: \(urlComponents)")
+                kind = .genericCallLink(url)
+            }
+        } else {
+            MXLog.error("Failed constructing URL components for url: \(url)")
+            kind = .genericCallLink(url)
+        }
+    }
+    
+    /// Creates a configuration for an internal room call.
+    init(roomProxy: RoomProxyProtocol,
+         clientProxy: ClientProxyProtocol,
+         clientID: String,
+         elementCallBaseURL: URL,
+         elementCallBaseURLOverride: URL?,
+         colorScheme: ColorScheme) {
+        kind = .roomCall(roomProxy: roomProxy,
+                         clientProxy: clientProxy,
+                         clientID: clientID,
+                         elementCallBaseURL: elementCallBaseURL,
+                         elementCallBaseURLOverride: elementCallBaseURLOverride,
+                         colorScheme: colorScheme)
+    }
+    
+    /// A string representing the call being configured.
+    var callID: String {
+        switch kind {
+        case .genericCallLink(let url):
+            url.absoluteString
+        case .roomCall(let roomProxy, _, _, _, _, _):
+            roomProxy.id
+        }
+    }
+}

ElementX/Sources/Services/ElementCall/ElementCallWidgetDriver.swift

@@ -147,7 +147,7 @@ class ElementCallWidgetDriver: WidgetCapabilitiesProvider, ElementCallWidgetDriv
         return .success(url)
     }
     
-    func sendMessage(_ message: String) async -> Result<Bool, ElementCallWidgetDriverError> {
+    func handleMessage(_ message: String) async -> Result<Bool, ElementCallWidgetDriverError> {
         guard let widgetDriver else {
             return .failure(.driverNotSetup)
         }

ElementX/Sources/Services/ElementCall/ElementCallWidgetDriverProtocol.swift

@@ -40,5 +40,6 @@ protocol ElementCallWidgetDriverProtocol {
     
     func start(baseURL: URL, clientID: String, colorScheme: ColorScheme) async -> Result<URL, ElementCallWidgetDriverError>
     
-    func sendMessage(_ message: String) async -> Result<Bool, ElementCallWidgetDriverError>
+    /// Passes a message from the Widget to the SDK to handle, returning a Bool that represents whether or not the widget driver is still running.
+    func handleMessage(_ message: String) async -> Result<Bool, ElementCallWidgetDriverError>
 }

ElementX/Sources/Services/ElementCall/GenericCallLinkWidgetDriver.swift

@@ -0,0 +1,44 @@
+//
+// Copyright 2024 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Combine
+import SwiftUI
+
+class GenericCallLinkWidgetDriver: ElementCallWidgetDriverProtocol {
+    private let url: URL
+    
+    let widgetID = UUID().uuidString
+    let messagePublisher = PassthroughSubject<String, Never>()
+    
+    private let actionsSubject: PassthroughSubject<ElementCallWidgetDriverAction, Never> = .init()
+    var actions: AnyPublisher<ElementCallWidgetDriverAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(url: URL) {
+        self.url = url
+    }
+    
+    func start(baseURL: URL, clientID: String, colorScheme: ColorScheme) async -> Result<URL, ElementCallWidgetDriverError> {
+        MXLog.error("Nothing to start, use the configuration's URL directly instead.")
+        return .success(url)
+    }
+    
+    func handleMessage(_ message: String) async -> Result<Bool, ElementCallWidgetDriverError> {
+        // The web view doesn't send us messages through the Widget API, so nothing to implement (yet?).
+        .failure(.driverNotSetup)
+    }
+}

ElementX/Sources/Services/Room/RoomProxy.swift

@@ -609,7 +609,7 @@ class RoomProxy: RoomProxyProtocol {
         ElementCallWidgetDriver(room: room, deviceID: deviceID)
     }
     
-    func sendCallNotificationIfNeeeded() async -> Result<Void, RoomProxyError> {
+    func sendCallNotificationIfNeeded() async -> Result<Void, RoomProxyError> {
         do {
             try await room.sendCallNotificationIfNeeded()
             return .success(())

ElementX/Sources/Services/Room/RoomProxyProtocol.swift

@@ -141,7 +141,7 @@ protocol RoomProxyProtocol {
     func canUserJoinCall(userID: String) async -> Result<Bool, RoomProxyError>
     func elementCallWidgetDriver(deviceID: String) -> ElementCallWidgetDriverProtocol
     
-    func sendCallNotificationIfNeeeded() async -> Result<Void, RoomProxyError>
+    func sendCallNotificationIfNeeded() async -> Result<Void, RoomProxyError>
     
     // MARK: - Permalinks