New timeline items (#424)

* Cleanup session verification state machine configuration * Add support for new timeline items: loading indicators, stickers and invalid/unsupported events * Add sticker accessibility label, fix session verification ones * Add support for the new TimelineStart timeline item and new pagination API. Remove identifiers from individual timeline items and only set them in the TimelineTableViewController * Add changelog
element-hq · Jan 10, 2023 · cc20e7e · cc20e7e
1 parent 069d379
commit cc20e7e
Show file tree

Hide file tree

Showing 56 changed files with 766 additions and 292 deletions.
diff --git a/ElementX/Resources/Localizations/en.lproj/Untranslated.strings b/ElementX/Resources/Localizations/en.lproj/Untranslated.strings
@@ -9,6 +9,7 @@
 
 "settings_appearance" = "Appearance";
 "settings_timeline_style" = "Timeline Style";
+
 "room_timeline_style_plain_long_description" = "Plain Timeline";
 "room_timeline_style_bubbled_long_description" = "Bubbled Timeline";
 
@@ -21,6 +22,8 @@
 
 "room_timeline_context_menu_retry_decryption" = "Retry decryption";
 
+"room_timeline_item_unsupported" = "Unsupported event";
+
 "session_verification_banner_title" = "Help keep your messages secure";
 "session_verification_banner_message" = "Looks like you’re using a new device. Verify its you.";
 

diff --git a/ElementX/Sources/Generated/Strings+Untranslated.swift b/ElementX/Sources/Generated/Strings+Untranslated.swift
@@ -36,6 +36,8 @@ extension ElementL10n {
   public static let roomTimelineContextMenuRetryDecryption = ElementL10n.tr("Untranslated", "room_timeline_context_menu_retry_decryption")
   /// Editing
   public static let roomTimelineEditing = ElementL10n.tr("Untranslated", "room_timeline_editing")
+  /// Unsupported event
+  public static let roomTimelineItemUnsupported = ElementL10n.tr("Untranslated", "room_timeline_item_unsupported")
   /// Failed creating the permalink
   public static let roomTimelinePermalinkCreationFailure = ElementL10n.tr("Untranslated", "room_timeline_permalink_creation_failure")
   /// Replying to %@

diff --git a/ElementX/Sources/Screens/BugReport/View/BugReportScreen.swift b/ElementX/Sources/Screens/BugReport/View/BugReportScreen.swift
@@ -88,7 +88,8 @@ struct BugReportScreen: View {
                 Toggle(ElementL10n.sendBugReportIncludeLogs, isOn: $context.sendingLogsEnabled)
                     .toggleStyle(ElementToggleStyle())
                     .accessibilityIdentifier("sendLogsToggle")
-                Text(ElementL10n.sendBugReportIncludeLogs).accessibilityIdentifier("sendLogsText")
+                Text(ElementL10n.sendBugReportIncludeLogs)
+                    .accessibilityIdentifier("sendLogsText")
             }
             .onTapGesture {
                 context.send(viewAction: .toggleSendLogs)

diff --git a/ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift b/ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift
@@ -21,6 +21,7 @@ typealias RoomScreenViewModelType = StateStoreViewModel<RoomScreenViewState, Roo
 
 class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol {
     private enum Constants {
+        static let backPaginationEventLimit: UInt = 20
         static let backPaginationPageSize: UInt = 50
         static let toastErrorID = "RoomScreenToastError"
     }
@@ -122,7 +123,7 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
     // MARK: - Private
 
     private func paginateBackwards() async {
-        switch await timelineController.paginateBackwards(Constants.backPaginationPageSize) {
+        switch await timelineController.paginateBackwards(requestSize: Constants.backPaginationEventLimit, untilNumberOfItems: Constants.backPaginationPageSize) {
         case .failure:
             displayError(.toast(ElementL10n.roomTimelineBackpaginationFailure))
         default:

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Style/TimelineItemBubbledStylerView.swift b/ElementX/Sources/Screens/RoomScreen/View/Style/TimelineItemBubbledStylerView.swift
@@ -98,7 +98,7 @@ struct TimelineItemBubbledStylerView<Content: View>: View {
 
     @ViewBuilder
     var styledContentOutgoing: some View {
-        let topPadding: CGFloat? = timelineItem.inGroupState == .single || timelineItem.inGroupState == .beginning ? 8 : 0
+        let topPadding: CGFloat? = timelineItem.groupState == .single || timelineItem.groupState == .beginning ? 8 : 0
 
         if shouldAvoidBubbling {
             content()

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Supplementary/TimelineDeliveryStatusView.swift b/ElementX/Sources/Screens/RoomScreen/View/Supplementary/TimelineDeliveryStatusView.swift
@@ -16,7 +16,7 @@
 
 import SwiftUI
 struct TimelineDeliveryStatusView: View {
-    let deliveryStatus: MessageTimelineItemDeliveryStatus
+    let deliveryStatus: TimelineItemDeliveryStatus
 
     @State var showDeliveryStatus: Bool
 
@@ -29,7 +29,7 @@ struct TimelineDeliveryStatusView: View {
         }
     }
 
-    init(deliveryStatus: MessageTimelineItemDeliveryStatus) {
+    init(deliveryStatus: TimelineItemDeliveryStatus) {
         self.deliveryStatus = deliveryStatus
 
         switch deliveryStatus {

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/EmoteRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/EmoteRoomTimelineView.swift
@@ -31,7 +31,6 @@ struct EmoteRoomTimelineView: View {
                 }
             }
         }
-        .id(timelineItem.id)
     }
 }
 
@@ -57,7 +56,7 @@ struct EmoteRoomTimelineView_Previews: PreviewProvider {
         EmoteRoomTimelineItem(id: UUID().uuidString,
                               text: text,
                               timestamp: timestamp,
-                              inGroupState: .single,
+                              groupState: .single,
                               isOutgoing: false,
                               isEditable: false,
                               senderId: senderId)

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/EncryptedRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/EncryptedRoomTimelineView.swift
@@ -26,20 +26,19 @@ struct EncryptedRoomTimelineView: View {
             Button {
                 showEncryptionInfo = !showEncryptionInfo
             } label: {
-                HStack(alignment: .top) {
-                    Image(systemName: "lock.shield")
-                        .foregroundColor(.red)
-                        .padding(.top, 1.0)
+                Label {
                     if showEncryptionInfo {
                         FormattedBodyText(text: encryptionDetails)
                     } else {
                         FormattedBodyText(text: timelineItem.text)
                     }
+                } icon: {
+                    Image(systemName: "lock.shield")
+                        .foregroundColor(.red)
                 }
                 .animation(nil, value: showEncryptionInfo)
             }
         }
-        .id(timelineItem.id)
     }
 
     private var encryptionDetails: String {
@@ -79,7 +78,7 @@ struct EncryptedRoomTimelineView_Previews: PreviewProvider {
                                   text: text,
                                   encryptionType: .unknown,
                                   timestamp: timestamp,
-                                  inGroupState: .single,
+                                  groupState: .single,
                                   isOutgoing: isOutgoing,
                                   isEditable: false,
                                   senderId: senderId)

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/FileRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/FileRoomTimelineView.swift
@@ -30,7 +30,6 @@ struct FileRoomTimelineView: View {
             .padding(.vertical, 12)
             .padding(.horizontal, 6)
         }
-        .id(timelineItem.id)
     }
 }
 
@@ -45,7 +44,7 @@ struct FileRoomTimelineView_Previews: PreviewProvider {
             FileRoomTimelineView(timelineItem: FileRoomTimelineItem(id: UUID().uuidString,
                                                                     text: "document.pdf",
                                                                     timestamp: "Now",
-                                                                    inGroupState: .single,
+                                                                    groupState: .single,
                                                                     isOutgoing: false,
                                                                     isEditable: false,
                                                                     senderId: "Bob",
@@ -55,7 +54,7 @@ struct FileRoomTimelineView_Previews: PreviewProvider {
             FileRoomTimelineView(timelineItem: FileRoomTimelineItem(id: UUID().uuidString,
                                                                     text: "document.docx",
                                                                     timestamp: "Now",
-                                                                    inGroupState: .single,
+                                                                    groupState: .single,
                                                                     isOutgoing: false,
                                                                     isEditable: false,
                                                                     senderId: "Bob",
@@ -65,7 +64,7 @@ struct FileRoomTimelineView_Previews: PreviewProvider {
             FileRoomTimelineView(timelineItem: FileRoomTimelineItem(id: UUID().uuidString,
                                                                     text: "document.txt",
                                                                     timestamp: "Now",
-                                                                    inGroupState: .single,
+                                                                    groupState: .single,
                                                                     isOutgoing: false,
                                                                     isEditable: false,
                                                                     senderId: "Bob",

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/ImageRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/ImageRoomTimelineView.swift
@@ -44,7 +44,6 @@ struct ImageRoomTimelineView: View {
                 .aspectRatio(timelineItem.aspectRatio, contentMode: .fit)
             }
         }
-        .id(timelineItem.id)
         .animation(.elementDefault, value: timelineItem.image)
     }
 }
@@ -60,7 +59,7 @@ struct ImageRoomTimelineView_Previews: PreviewProvider {
             ImageRoomTimelineView(timelineItem: ImageRoomTimelineItem(id: UUID().uuidString,
                                                                       text: "Some image",
                                                                       timestamp: "Now",
-                                                                      inGroupState: .single,
+                                                                      groupState: .single,
                                                                       isOutgoing: false,
                                                                       isEditable: false,
                                                                       senderId: "Bob",
@@ -70,7 +69,7 @@ struct ImageRoomTimelineView_Previews: PreviewProvider {
             ImageRoomTimelineView(timelineItem: ImageRoomTimelineItem(id: UUID().uuidString,
                                                                       text: "Some other image",
                                                                       timestamp: "Now",
-                                                                      inGroupState: .single,
+                                                                      groupState: .single,
                                                                       isOutgoing: false,
                                                                       isEditable: false,
                                                                       senderId: "Bob",
@@ -80,7 +79,7 @@ struct ImageRoomTimelineView_Previews: PreviewProvider {
             ImageRoomTimelineView(timelineItem: ImageRoomTimelineItem(id: UUID().uuidString,
                                                                       text: "Blurhashed image",
                                                                       timestamp: "Now",
-                                                                      inGroupState: .single,
+                                                                      groupState: .single,
                                                                       isOutgoing: false,
                                                                       isEditable: false,
                                                                       senderId: "Bob",

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/NoticeRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/NoticeRoomTimelineView.swift
@@ -31,7 +31,6 @@ struct NoticeRoomTimelineView: View {
                 }
             }
         }
-        .id(timelineItem.id)
     }
 }
 
@@ -57,7 +56,7 @@ struct NoticeRoomTimelineView_Previews: PreviewProvider {
         NoticeRoomTimelineItem(id: UUID().uuidString,
                                text: text,
                                timestamp: timestamp,
-                               inGroupState: .single,
+                               groupState: .single,
                                isOutgoing: false,
                                isEditable: false,
                                senderId: senderId)

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/PaginationIndicatorRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/PaginationIndicatorRoomTimelineView.swift
@@ -0,0 +1,33 @@
+//
+// Copyright 2022 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
+
+struct PaginationIndicatorRoomTimelineView: View {
+    let timelineItem: PaginationIndicatorRoomTimelineItem
+
+    var body: some View {
+        ProgressView()
+            .frame(maxWidth: .infinity)
+    }
+}
+
+struct PaginationIndicatorRoomTimelineView_Previews: PreviewProvider {
+    static var previews: some View {
+        let item = PaginationIndicatorRoomTimelineItem()
+        PaginationIndicatorRoomTimelineView(timelineItem: item)
+    }
+}
diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/ReadMarkerRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/ReadMarkerRoomTimelineView.swift
@@ -24,7 +24,6 @@ struct ReadMarkerRoomTimelineView: View {
         VStack {
             Spacer(minLength: 4.0)
             Divider()
-                .id(timelineItem.id)
                 .frame(maxWidth: .infinity)
                 .overlay(Color.element.accent)
         }
@@ -33,7 +32,7 @@ struct ReadMarkerRoomTimelineView: View {
 
 struct ReadMarkerRoomTimelineView_Previews: PreviewProvider {
     static var previews: some View {
-        let item = ReadMarkerRoomTimelineItem(id: UUID().uuidString)
+        let item = ReadMarkerRoomTimelineItem()
         ReadMarkerRoomTimelineView(timelineItem: item)
     }
 }
diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/RedactedRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/RedactedRoomTimelineView.swift
@@ -27,7 +27,6 @@ struct RedactedRoomTimelineView: View {
                 FormattedBodyText(text: timelineItem.text)
             }
         }
-        .id(timelineItem.id)
     }
 }
 
@@ -44,7 +43,7 @@ struct RedactedRoomTimelineView_Previews: PreviewProvider {
         RedactedRoomTimelineItem(id: UUID().uuidString,
                                  text: text,
                                  timestamp: timestamp,
-                                 inGroupState: .single,
+                                 groupState: .single,
                                  isOutgoing: false,
                                  isEditable: false,
                                  senderId: senderId)

diff --git a/ElementX/Sources/Screens/RoomScreen/View/Timeline/SeparatorRoomTimelineView.swift b/ElementX/Sources/Screens/RoomScreen/View/Timeline/SeparatorRoomTimelineView.swift
@@ -14,7 +14,6 @@
 // limitations under the License.
 //
 
-import Foundation
 import SwiftUI
 
 struct SeparatorRoomTimelineView: View {
@@ -24,15 +23,14 @@ struct SeparatorRoomTimelineView: View {
         Text(timelineItem.text)
             .font(.element.footnote)
             .foregroundColor(.element.secondaryContent)
-            .id(timelineItem.id)
             .padding(.vertical, 24)
             .frame(maxWidth: .infinity)
     }
 }
 
 struct SeparatorRoomTimelineView_Previews: PreviewProvider {
     static var previews: some View {
-        let item = SeparatorRoomTimelineItem(id: UUID().uuidString, text: "This is a separator")
+        let item = SeparatorRoomTimelineItem(text: "This is a separator")
         SeparatorRoomTimelineView(timelineItem: item)
     }
 }