[Feature]Disconnection timeout during call

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### ✅ Added
 - You can now provide the incoming video quality setting for some or all participants [#571](https://github.com/GetStream/stream-video-swift/pull/571)
+- You can now set the time a user can remain in the call - after their connection disrupted - while waiting for their network connection to recover [#573](https://github.com/GetStream/stream-video-swift/pull/573)
 
 # [1.13.0](https://github.com/GetStream/stream-video-swift/releases/tag/1.13.0)
 _October 08, 2024_

DemoApp/Sources/AppDelegate.swift

@@ -99,7 +99,7 @@ class AppDelegate: NSObject, UIApplicationDelegate, UNUserNotificationCenterDele
             .current()
             .requestAuthorization(options: [.alert, .sound, .badge]) { granted, _ in
                 if granted {
-                    DispatchQueue.main.async {
+                    Task { @MainActor in
                         UIApplication.shared.registerForRemoteNotifications()
                     }
                 }

DemoApp/Sources/Components/AppEnvironment.swift

@@ -442,3 +442,36 @@ extension AppEnvironment {
 
     static var autoLeavePolicy: AutoLeavePolicy = .default
 }
+
+extension AppEnvironment {
+
+    enum DisconnectionTimeout: Hashable, Debuggable {
+        case never
+        case twoMinutes
+        case custom(TimeInterval)
+
+        var title: String {
+            switch self {
+            case .never:
+                return "Never"
+            case .twoMinutes:
+                return "2'"
+            case let .custom(value):
+                return "\(value)\""
+            }
+        }
+
+        var duration: TimeInterval {
+            switch self {
+            case .never:
+                return 0
+            case .twoMinutes:
+                return 2 * 60
+            case let .custom(value):
+                return value
+            }
+        }
+    }
+
+    static var disconnectionTimeout: DisconnectionTimeout = .never
+}

DemoApp/Sources/Components/Feedback/DemoFeedbackView.swift

@@ -16,6 +16,7 @@ struct DemoFeedbackView: View {
     @State private var comment: String = ""
     @State private var rating: Int = 5
     @State private var isSubmitting = false
+    @State private var toast: Toast?
 
     private weak var call: Call?
     private var dismiss: () -> Void
@@ -121,6 +122,20 @@ struct DemoFeedbackView: View {
             .padding(.horizontal)
         }
         .withModalNavigationBar(title: "", closeAction: dismiss)
+        .toastView(toast: $toast)
+        .onAppear { checkIfDisconnectionErrorIsAvailable() }
+    }
+
+    // MARK: - Private helpers
+
+    @MainActor
+    func checkIfDisconnectionErrorIsAvailable() {
+        if call?.state.disconnectionError is ClientError.NetworkNotAvailable {
+            toast = .init(
+                style: .error,
+                message: "Your call was ended because it seems your internet connection is down."
+            )
+        }
     }
 }
 

DemoApp/Sources/Views/CallView/CallingView/DemoCallingViewModifier.swift

@@ -72,6 +72,7 @@ struct DemoCallingViewModifier: ViewModifier {
             }
             .onReceive(appState.$activeCall) { call in
                 viewModel.setActiveCall(call)
+                call?.setDisconnectionTimeout(AppEnvironment.disconnectionTimeout.duration)
             }
             .onReceive(appState.$userState) { userState in
                 if userState == .notLoggedIn {

DemoApp/Sources/Views/Login/DebugMenu.swift

@@ -76,6 +76,10 @@ struct DebugMenu: View {
         didSet { AppEnvironment.callExpiration = callExpiration }
     }
 
+    @State private var disconnectionTimeout: AppEnvironment.DisconnectionTimeout = AppEnvironment.disconnectionTimeout {
+        didSet { AppEnvironment.disconnectionTimeout = disconnectionTimeout }
+    }
+
     @State private var isLogsViewerVisible: Bool = false
 
     @State private var presentsCustomEnvironmentSetup: Bool = false
@@ -86,6 +90,9 @@ struct DebugMenu: View {
     @State private var customTokenExpirationValue: Int = 0
     @State private var presentsCustomTokenExpiration: Bool = false
 
+    @State private var customDisconnectionTimeoutValue: TimeInterval = 0
+    @State private var presentsCustomDisconnectionTimeout: Bool = false
+
     @State private var autoLeavePolicy: AppEnvironment.AutoLeavePolicy = AppEnvironment.autoLeavePolicy {
         didSet { AppEnvironment.autoLeavePolicy = autoLeavePolicy }
     }
@@ -149,6 +156,13 @@ struct DebugMenu: View {
                 label: "Auto Leave policy"
             ) { self.autoLeavePolicy = $0 }
 
+            makeMenu(
+                for: [.never, .twoMinutes],
+                currentValue: disconnectionTimeout,
+                additionalItems: { customDisconnectionTimeoutView },
+                label: "Disconnection Timeout"
+            ) { self.disconnectionTimeout = $0 }
+
             makeMenu(
                 for: [.visible, .hidden],
                 currentValue: performanceTrackerVisibility,
@@ -213,6 +227,14 @@ struct DebugMenu: View {
             transformer: { Int($0) ?? 0 },
             action: { self.tokenExpiration = .custom(customTokenExpirationValue) }
         )
+        .alertWithTextField(
+            title: "Enter disconnection timeout in seconds",
+            placeholder: "Interval",
+            presentationBinding: $presentsCustomDisconnectionTimeout,
+            valueBinding: $customDisconnectionTimeoutValue,
+            transformer: { TimeInterval($0) ?? 0 },
+            action: { self.disconnectionTimeout = .custom(customDisconnectionTimeoutValue) }
+        )
     }
 
     @ViewBuilder
@@ -290,6 +312,31 @@ struct DebugMenu: View {
         }
     }
 
+    @ViewBuilder
+    private var customDisconnectionTimeoutView: some View {
+        if case let .custom(value) = AppEnvironment.disconnectionTimeout {
+            Button {
+                presentsCustomDisconnectionTimeout = true
+            } label: {
+                Label {
+                    Text("Custom (\(value)\")")
+                } icon: {
+                    Image(systemName: "checkmark")
+                }
+            }
+        } else {
+            Button {
+                presentsCustomDisconnectionTimeout = true
+            } label: {
+                Label {
+                    Text("Custom")
+                } icon: {
+                    EmptyView()
+                }
+            }
+        }
+    }
+
     @ViewBuilder
     private func makeMenu<Item: Debuggable>(
         for items: [Item],

DocumentationTests/DocumentationTests/DocumentationTests.xcodeproj/project.pbxproj

@@ -16,10 +16,11 @@
 		400D91D12B63DEA200EBA47D /* 04-camera-and-microphone.swift in Sources */ = {isa = PBXBuildFile; fileRef = 400D91D02B63DEA200EBA47D /* 04-camera-and-microphone.swift */; };
 		400D91D32B63DFA500EBA47D /* 06-querying-calls.swift in Sources */ = {isa = PBXBuildFile; fileRef = 400D91D22B63DFA500EBA47D /* 06-querying-calls.swift */; };
 		400D91D52B63E27300EBA47D /* 07-dependency-injection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 400D91D42B63E27300EBA47D /* 07-dependency-injection.swift */; };
-		4029E95E2CB94EAE00E1D571 /* 21-manual-quality-selection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4029E95D2CB94EA700E1D571 /* 21-manual-quality-selection.swift */; };
+		4029E95E2CB94EAE00E1D571 /* 22-manual-quality-selection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4029E95D2CB94EA700E1D571 /* 22-manual-quality-selection.swift */; };
 		404CAED82B8E3874007087BC /* 06-apply-video-filters.swift in Sources */ = {isa = PBXBuildFile; fileRef = 404CAED72B8E3874007087BC /* 06-apply-video-filters.swift */; };
 		4068C1252B67C056006B0BEE /* 03-callkit-integration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4068C1242B67C056006B0BEE /* 03-callkit-integration.swift */; };
 		408CE0F52BD91B490052EC3A /* 19-transcriptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 408CE0F42BD91B490052EC3A /* 19-transcriptions.swift */; };
+		409774B02CC19F5500E0D3EE /* 23-network-disruption.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409774AF2CC19F4900E0D3EE /* 23-network-disruption.swift */; };
 		409C39692B67CC5C0090044C /* 04-screensharing.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409C39682B67CC5C0090044C /* 04-screensharing.swift */; };
 		409C396B2B67CD0B0090044C /* 05-picture-in-picture.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409C396A2B67CD0B0090044C /* 05-picture-in-picture.swift */; };
 		409C396D2B67CD780090044C /* 08-recording.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409C396C2B67CD780090044C /* 08-recording.swift */; };
@@ -94,10 +95,11 @@
 		400D91D02B63DEA200EBA47D /* 04-camera-and-microphone.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "04-camera-and-microphone.swift"; sourceTree = "<group>"; };
 		400D91D22B63DFA500EBA47D /* 06-querying-calls.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "06-querying-calls.swift"; sourceTree = "<group>"; };
 		400D91D42B63E27300EBA47D /* 07-dependency-injection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "07-dependency-injection.swift"; sourceTree = "<group>"; };
-		4029E95D2CB94EA700E1D571 /* 21-manual-quality-selection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "21-manual-quality-selection.swift"; sourceTree = "<group>"; };
+		4029E95D2CB94EA700E1D571 /* 22-manual-quality-selection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "22-manual-quality-selection.swift"; sourceTree = "<group>"; };
 		404CAED72B8E3874007087BC /* 06-apply-video-filters.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "06-apply-video-filters.swift"; sourceTree = "<group>"; };
 		4068C1242B67C056006B0BEE /* 03-callkit-integration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "03-callkit-integration.swift"; sourceTree = "<group>"; };
 		408CE0F42BD91B490052EC3A /* 19-transcriptions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "19-transcriptions.swift"; sourceTree = "<group>"; };
+		409774AF2CC19F4900E0D3EE /* 23-network-disruption.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "23-network-disruption.swift"; sourceTree = "<group>"; };
 		409C39682B67CC5C0090044C /* 04-screensharing.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "04-screensharing.swift"; sourceTree = "<group>"; };
 		409C396A2B67CD0B0090044C /* 05-picture-in-picture.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "05-picture-in-picture.swift"; sourceTree = "<group>"; };
 		409C396C2B67CD780090044C /* 08-recording.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "08-recording.swift"; sourceTree = "<group>"; };
@@ -274,7 +276,8 @@
 				408CE0F42BD91B490052EC3A /* 19-transcriptions.swift */,
 				40F18B8F2BEBC97F00ADF76E /* 18-call-quality-rating.swift */,
 				40F290AC2BDFB3CA00DCF136 /* 20-noise-cancellation.swift */,
-				4029E95D2CB94EA700E1D571 /* 21-manual-quality-selection.swift */,
+				4029E95D2CB94EA700E1D571 /* 22-manual-quality-selection.swift */,
+				409774AF2CC19F4900E0D3EE /* 23-network-disruption.swift */,
 			);
 			path = "05-ui-cookbook";
 			sourceTree = "<group>";
@@ -465,12 +468,13 @@
 				4068C1252B67C056006B0BEE /* 03-callkit-integration.swift in Sources */,
 				40FFDC762B63F7D6004DA7A2 /* ChatGloballyUsedVariables.swift in Sources */,
 				84BA15AE2CA2EF420018DC51 /* 07-querying-call-members.swift in Sources */,
+				409774B02CC19F5500E0D3EE /* 23-network-disruption.swift in Sources */,
 				40FFDC672B63F430004DA7A2 /* 04-connection-quality-indicator.swift in Sources */,
 				40B468982B67B6DF009B5B3E /* 01-deeplinking.swift in Sources */,
 				40FFDC3B2B63E493004DA7A2 /* 10-view-slots.swift in Sources */,
 				40FFDC442B63E95D004DA7A2 /* 14-swiftui-vs-uikit.swift in Sources */,
 				40FFDC872B63FEAE004DA7A2 /* 05-incoming-call.swift in Sources */,
-				4029E95E2CB94EAE00E1D571 /* 21-manual-quality-selection.swift in Sources */,
+				4029E95E2CB94EAE00E1D571 /* 22-manual-quality-selection.swift in Sources */,
 				40FFDC942B6401CC004DA7A2 /* 07-video-fallback.swift in Sources */,
 				400D91C72B63D96800EBA47D /* 03-quickstart.swift in Sources */,
 				40FFDC9E2B64063D004DA7A2 /* 12-connection-unstable.swift in Sources */,

DocumentationTests/DocumentationTests/DocumentationTests/05-ui-cookbook/23-network-disruption.swift

@@ -0,0 +1,147 @@
+import StreamVideo
+import StreamVideoSwiftUI
+import SwiftUI
+import Combine
+
+@MainActor
+fileprivate func content() {
+    container {
+        let call = streamVideo.call(callType: "default", callId: callId)
+
+        // Set the disconnection timeout to 60 seconds
+        call.setDisconnectionTimeout(60)
+    }
+
+    container {
+        struct DemoFeedbackView: View {
+
+            @Environment(\.openURL) private var openURL
+            @Injected(\.appearance) private var appearance
+
+            @State private var email: String = ""
+            @State private var comment: String = ""
+            @State private var rating: Int = 5
+            @State private var isSubmitting = false
+            @State private var toast: Toast?
+
+            private weak var call: Call?
+            private var dismiss: () -> Void
+            private var isSubmitEnabled: Bool { !email.isEmpty && !isSubmitting }
+
+            init(_ call: Call, dismiss: @escaping () -> Void) {
+                self.call = call
+                self.dismiss = dismiss
+            }
+
+            var body: some View {
+                ScrollView {
+                    VStack(spacing: 32) {
+                        Image("feedbackLogo")
+
+                        VStack(spacing: 8) {
+                            Text("How is your call going?")
+                                .font(appearance.fonts.headline)
+                                .foregroundColor(appearance.colors.text)
+                                .lineLimit(1)
+
+                            Text("All feedback is celebrated!")
+                                .font(appearance.fonts.subheadline)
+                                .foregroundColor(.init(appearance.colors.textLowEmphasis))
+                                .lineLimit(2)
+                        }
+                        .frame(maxWidth: .infinity, alignment: .center)
+                        .multilineTextAlignment(.center)
+
+                        VStack(spacing: 27) {
+                            VStack(spacing: 16) {
+                                TextField(
+                                    "Email Address *",
+                                    text: $email
+                                )
+                                .textFieldStyle(DemoTextfieldStyle())
+
+                                DemoTextEditor(text: $comment, placeholder: "Message")
+                            }
+
+                            HStack {
+                                Text("Rate Quality")
+                                    .font(appearance.fonts.body)
+                                    .foregroundColor(.init(appearance.colors.textLowEmphasis))
+                                    .frame(maxWidth: .infinity, alignment: .leading)
+
+                                DemoStarRatingView(rating: $rating)
+                            }
+                        }
+
+                        HStack {
+                            Button {
+                                resignFirstResponder()
+                                openURL(.init(string: "https://getstream.io/video/#contact")!)
+                            } label: {
+                                Text("Contact Us")
+                            }
+                            .frame(maxWidth: .infinity)
+                            .foregroundColor(appearance.colors.text)
+                            .padding(.vertical, 4)
+                            .clipShape(Capsule())
+                            .overlay(Capsule().stroke(Color(appearance.colors.textLowEmphasis), lineWidth: 1))
+
+                            Button {
+                                resignFirstResponder()
+                                isSubmitting = true
+                                Task {
+                                    do {
+                                        try await call?.collectUserFeedback(
+                                            rating: rating,
+                                            reason: """
+                                            \(email)
+                                            \(comment)
+                                            """
+                                        )
+                                        Task { @MainActor in
+                                            dismiss()
+                                        }
+                                        isSubmitting = false
+                                    } catch {
+                                        log.error(error)
+                                        dismiss()
+                                        isSubmitting = false
+                                    }
+                                }
+                            } label: {
+                                if isSubmitting {
+                                    ProgressView()
+                                } else {
+                                    Text("Submit")
+                                }
+                            }
+                            .frame(maxWidth: .infinity)
+                            .foregroundColor(appearance.colors.text)
+                            .padding(.vertical, 4)
+                            .background(isSubmitEnabled ? appearance.colors.accentBlue : appearance.colors.lightGray)
+                            .disabled(!isSubmitEnabled)
+                            .clipShape(Capsule())
+                        }
+
+                        Spacer()
+                    }
+                    .padding(.horizontal)
+                }
+                .toastView(toast: $toast)
+                .onAppear { checkIfDisconnectionErrorIsAvailable() }
+            }
+
+            // MARK: - Private helpers
+
+            @MainActor
+            func checkIfDisconnectionErrorIsAvailable() {
+                if call?.state.disconnectionError is ClientError.NetworkNotAvailable {
+                    toast = .init(
+                        style: .error,
+                        message: "Your call was ended because it seems your internet connection is down."
+                    )
+                }
+            }
+        }
+    }
+}