Added a progress tracker to the bug report view (#513)

* created a progress tracker class and passed it in the user notification to be observed by the progress view

* improved the publishing by dispatching it on RunLoop.main

* bug report struct created and progress tracker class moved into the Other folder

* some swiftlint adjustments

* fixed tests

* fixed another test BugReportServiceTests

* changelog 495 - change

* added a mock preview

* fixing some linting suggestions

* no need to use KVO, achieve the same result using a publisher

* some refactors to address PR comments

* some code improvements

* fixed the issue that prevented the avatar of the room to be displayed in the mocks, and updated the tests

* Revert "fixed the issue that prevented the avatar of the room to be displayed in the mocks, and updated the tests"

This reverts commit 113d6091d91a3aac1f9a59ff6c5e07610ed59859.

ElementX/Sources/Other/ProgressTracker.swift

@@ -0,0 +1,39 @@
+//
+// Copyright 2023 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 Foundation
+
+protocol ProgressListener {
+    var progressSubject: CurrentValueSubject<Double, Never> { get }
+}
+
+protocol ProgressPublisher {
+    var publisher: AnyPublisher<Double, Never> { get }
+}
+
+final class ProgressTracker: ProgressListener, ProgressPublisher {
+    let progressSubject: CurrentValueSubject<Double, Never>
+
+    var publisher: AnyPublisher<Double, Never> {
+        progressSubject
+            .eraseToAnyPublisher()
+    }
+
+    init(initialValue: Double = 0.0) {
+        progressSubject = .init(initialValue)
+    }
+}

ElementX/Sources/Other/UserNotifications/UserNotification.swift

@@ -22,9 +22,18 @@ enum UserNotificationType {
 }
 
 struct UserNotification: Equatable, Identifiable {
+    static func == (lhs: UserNotification, rhs: UserNotification) -> Bool {
+        lhs.id == rhs.id &&
+            lhs.type == rhs.type &&
+            lhs.title == rhs.title &&
+            lhs.iconName == rhs.iconName &&
+            lhs.persistent == rhs.persistent
+    }
+
     var id: String = UUID().uuidString
     var type = UserNotificationType.toast
     var title: String
     var iconName: String?
     var persistent = false
+    var progressPublisher: ProgressPublisher?
 }

ElementX/Sources/Other/UserNotifications/UserNotificationModalView.swift

@@ -14,16 +14,22 @@
 // limitations under the License.
 //
 
+import Combine
 import SwiftUI
 
 struct UserNotificationModalView: View {
     let notification: UserNotification
-    
+    @State private var progressFraction: Double?
+
     var body: some View {
         ZStack {
             VStack(spacing: 12.0) {
-                ProgressView()
-                
+                if let progressFraction = progressFraction {
+                    ProgressView(value: progressFraction)
+                } else {
+                    ProgressView()
+                }
+
                 HStack {
                     if let iconName = notification.iconName {
                         Image(systemName: iconName)
@@ -34,10 +40,13 @@ struct UserNotificationModalView: View {
                 }
             }
             .padding()
-            .frame(minWidth: 150.0)
+            .frame(minWidth: 150.0, maxWidth: 250.0)
             .background(Color.element.quinaryContent)
             .clipShape(RoundedCornerShape(radius: 12.0, corners: .allCorners))
             .shadow(color: .black.opacity(0.1), radius: 10.0, y: 4.0)
+            .onReceive(notification.progressPublisher?.publisher ?? Empty().eraseToAnyPublisher()) { progress in
+                progressFraction = progress
+            }
             .transition(.opacity)
         }
         .id(notification.id)
@@ -45,21 +54,22 @@ struct UserNotificationModalView: View {
         .background(.black.opacity(0.1))
         .ignoresSafeArea()
     }
-    
-    private var toastTransition: AnyTransition {
-        AnyTransition
-            .asymmetric(insertion: .move(edge: .top),
-                        removal: .move(edge: .bottom))
-            .combined(with: .opacity)
-    }
 }
 
 struct UserNotificationModalView_Previews: PreviewProvider {
     static var previews: some View {
-        VStack {
+        Group {
             UserNotificationModalView(notification: UserNotification(type: .modal,
                                                                      title: "Successfully logged in",
-                                                                     iconName: "checkmark"))
+                                                                     iconName: "checkmark")
+            )
+            .previewDisplayName("Spinner")
+            UserNotificationModalView(notification: UserNotification(type: .modal,
+                                                                     title: "Successfully logged in",
+                                                                     iconName: "checkmark",
+                                                                     progressPublisher: ProgressTracker(initialValue: 0.5))
+            )
+            .previewDisplayName("Progress Bar")
         }
     }
 }