[Enhancement]Handle video property on VoIP push notification

DocumentationTests/DocumentationTests/DocumentationTests/06-advanced/03-callkit-integration.swift

@@ -160,7 +160,12 @@ fileprivate func content() {
                                     callType: .default,
                                     callId: UUID().uuidString,
                                     members: [.init(userId: name)],
-                                    ring: true
+                                    ring: true,
+
+                                    // hasVideo: A boolean indicating if the call
+                                    // will be video or only audio. Still requires
+                                    // appropriate setting of ``CallSettings`.`
+                                    hasVideo: true
                                 )
                             }
                         }

Sources/StreamVideo/Call.swift

@@ -225,6 +225,8 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
     ///   - maxDuration: An optional integer representing the maximum duration of the call in seconds.
     ///   - maxParticipants: An optional integer representing the maximum number of participants allowed in the call.
     ///   - backstage: An optional backstage request.
+    ///   - hasVideo: A boolean indicating if the call will be video or only audio. Still requires appropriate
+    ///   setting of ``CallSettings`.`
     /// - Returns: A `CallResponse` object representing the created call.
     /// - Throws: An error if the call creation fails.
     @discardableResult
@@ -238,7 +240,8 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
         notify: Bool = false,
         maxDuration: Int? = nil,
         maxParticipants: Int? = nil,
-        backstage: BackstageSettingsRequest? = nil
+        backstage: BackstageSettingsRequest? = nil,
+        hasVideo: Bool? = nil
     ) async throws -> CallResponse {
         var membersRequest = [MemberRequest]()
         memberIds?.forEach {
@@ -268,7 +271,8 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
                 members: membersRequest,
                 settingsOverride: settingsOverride,
                 startsAt: startsAt,
-                team: team
+                team: team,
+                video: hasVideo
             ),
             notify: notify,
             ring: ring

Sources/StreamVideo/CallKit/CallKitPushNotificationAdapter.swift

@@ -15,22 +15,26 @@ open class CallKitPushNotificationAdapter: NSObject, PKPushRegistryDelegate, Obs
         case displayName = "call_display_name"
         case createdByName = "created_by_display_name"
         case createdById = "created_by_id"
+        case video
     }
 
     /// Represents the content of a VoIP push notification.
     public struct Content {
         var cid: String
         var localizedCallerName: String
         var callerId: String
+        var hasVideo: Bool?
 
         public init(
             cid: String,
             localizedCallerName: String,
-            callerId: String
+            callerId: String,
+            hasVideo: Bool? = nil
         ) {
             self.cid = cid
             self.localizedCallerName = localizedCallerName
             self.callerId = callerId
+            self.hasVideo = hasVideo
         }
     }
 
@@ -107,6 +111,7 @@ open class CallKitPushNotificationAdapter: NSObject, PKPushRegistryDelegate, Obs
             content.cid,
             localizedCallerName: content.localizedCallerName,
             callerId: content.callerId,
+            hasVideo: content.hasVideo,
             completion: { error in
                 if let error {
                     log.error(error)
@@ -148,10 +153,13 @@ open class CallKitPushNotificationAdapter: NSObject, PKPushRegistryDelegate, Obs
             fallback: defaultCallText
         )
 
+        let hasVideo = streamDict[PayloadKey.video.rawValue] as? Bool
+
         return .init(
             cid: cid,
             localizedCallerName: localizedCallerName,
-            callerId: callerId
+            callerId: callerId,
+            hasVideo: hasVideo
         )
     }
 }

Sources/StreamVideo/CallKit/CallKitService.swift

@@ -109,18 +109,22 @@ open class CallKitService: NSObject, CXProviderDelegate, @unchecked Sendable {
     ///   - cid: The call ID.
     ///   - localizedCallerName: The localized caller name.
     ///   - callerId: The caller's identifier.
+    ///   - hasVideo: Indicator if call is video or audio. If nil we default to the value of `supportsVideo`
     ///   - completion: A closure to be called upon completion.
     @MainActor
     open func reportIncomingCall(
         _ cid: String,
         localizedCallerName: String,
         callerId: String,
+        hasVideo: Bool? = nil,
         completion: @escaping (Error?) -> Void
     ) {
+        let hasVideo = hasVideo ?? supportsVideo
         let (callUUID, callUpdate) = buildCallUpdate(
             cid: cid,
             localizedCallerName: localizedCallerName,
-            callerId: callerId
+            callerId: callerId,
+            hasVideo: hasVideo
         )
 
         callProvider.reportNewIncomingCall(
@@ -136,6 +140,7 @@ open class CallKitService: NSObject, CXProviderDelegate, @unchecked Sendable {
             cid:\(cid)
             callerId:\(callerId)
             callerName:\(localizedCallerName)
+            hasVideo: \(hasVideo)
             """
         )
 
@@ -573,7 +578,8 @@ open class CallKitService: NSObject, CXProviderDelegate, @unchecked Sendable {
     private func buildCallUpdate(
         cid: String,
         localizedCallerName: String,
-        callerId: String
+        callerId: String,
+        hasVideo: Bool
     ) -> (UUID, CXCallUpdate) {
         let update = CXCallUpdate()
         let idComponents = cid.components(separatedBy: ":")
@@ -589,7 +595,7 @@ open class CallKitService: NSObject, CXProviderDelegate, @unchecked Sendable {
 
         update.localizedCallerName = localizedCallerName
         update.remoteHandle = CXHandle(type: .generic, value: callerId)
-        update.hasVideo = supportsVideo
+        update.hasVideo = hasVideo
         update.supportsDTMF = false
 
         if supportsHolding {

Sources/StreamVideoSwiftUI/CallViewModel.swift

@@ -328,6 +328,8 @@ open class CallViewModel: ObservableObject {
     ///  - maxParticipants: An optional integer representing the maximum number of participants allowed in the call.
     ///  - startsAt: An optional date when the call starts.
     ///  - backstage: An optional request for setting up backstage.
+    ///  - hasVideo: A boolean indicating if the call will be video or only audio. Still requires appropriate
+    ///   setting of ``CallSettings`.`
     public func startCall(
         callType: String,
         callId: String,
@@ -337,7 +339,8 @@ open class CallViewModel: ObservableObject {
         maxParticipants: Int? = nil,
         startsAt: Date? = nil,
         backstage: BackstageSettingsRequest? = nil,
-        customData: [String: RawJSON]? = nil
+        customData: [String: RawJSON]? = nil,
+        hasVideo: Bool? = nil
     ) {
         outgoingCallMembers = members
         callingState = ring ? .outgoing : .joining
@@ -368,7 +371,8 @@ open class CallViewModel: ObservableObject {
                         custom: customData,
                         ring: ring,
                         maxDuration: maxDuration,
-                        maxParticipants: maxParticipants
+                        maxParticipants: maxParticipants,
+                        hasVideo: hasVideo
                     )
                     let timeoutSeconds = TimeInterval(
                         callData.settings.ring.autoCancelTimeoutMs / 1000

StreamVideoTests/CallKit/CallKitPushNotificationAdapterTests.swift

@@ -98,7 +98,20 @@ final class CallKitPushNotificationAdapterTests: XCTestCase {
             .init(
                 cid: "123",
                 localizedCallerName: "TestUser",
-                callerId: "test_user"
+                callerId: "test_user",
+                hasVideo: false
+            )
+        )
+    }
+
+    @MainActor
+    func test_pushRegistryDidReceiveIncomingPush_typeIsVoIP_hasVideoIsNil_reportIncomingCallWasCalledAsExpected() {
+        assertDidReceivePushNotification(
+            .init(
+                cid: "123",
+                localizedCallerName: "TestUser",
+                callerId: "test_user",
+                hasVideo: nil
             )
         )
     }
@@ -109,7 +122,8 @@ final class CallKitPushNotificationAdapterTests: XCTestCase {
             .init(
                 cid: "123",
                 localizedCallerName: "TestUser",
-                callerId: "test_user"
+                callerId: "test_user",
+                hasVideo: false
             ),
             displayName: "Stream Group Call"
         )
@@ -132,7 +146,7 @@ final class CallKitPushNotificationAdapterTests: XCTestCase {
     ) {
         let pushPayload = MockPKPushPayload()
         pushPayload.stubType = contentType
-        pushPayload.stubDictionaryPayload = content.map { [
+        var payload: [String: Any] = content.map { [
             "stream": [
                 "call_cid": $0.cid,
                 "call_display_name": displayName,
@@ -141,6 +155,13 @@ final class CallKitPushNotificationAdapterTests: XCTestCase {
             ]
         ] } ?? [:]
 
+        if let hasVideo = content?.hasVideo, var streamPayload = payload["stream"] as? [String: Any] {
+            streamPayload["video"] = hasVideo
+            payload["stream"] = streamPayload
+        }
+
+        pushPayload.stubDictionaryPayload = payload
+
         let completionWasCalledExpectation = expectation(description: "Completion was called.")
         completionWasCalledExpectation.isInverted = content == nil
         subject.pushRegistry(
@@ -169,6 +190,12 @@ final class CallKitPushNotificationAdapterTests: XCTestCase {
                 file: file,
                 line: line
             )
+            XCTAssertEqual(
+                callKitService.reportIncomingCallWasCalled?.hasVideo,
+                content.hasVideo,
+                file: file,
+                line: line
+            )
             callKitService.reportIncomingCallWasCalled?.completion(nil)
         } else {
             XCTAssertNil(