Automatically retry decryptions in the active room when the app becomes active again just in case the NSE received keys we're not aware of (#3628)

ElementX/Sources/Mocks/Generated/GeneratedMocks.swift

@@ -14150,15 +14150,15 @@ class TimelineProxyMock: TimelineProxyProtocol {
     }
     //MARK: - retryDecryption
 
-    var retryDecryptionForUnderlyingCallsCount = 0
+    var retryDecryptionSessionIDsUnderlyingCallsCount = 0
-    var retryDecryptionForCallsCount: Int {
+    var retryDecryptionSessionIDsCallsCount: Int {
         get {
             if Thread.isMainThread {
-                return retryDecryptionForUnderlyingCallsCount
+                return retryDecryptionSessionIDsUnderlyingCallsCount
             } else {
                 var returnValue: Int? = nil
                 DispatchQueue.main.sync {
-                    returnValue = retryDecryptionForUnderlyingCallsCount
+                    returnValue = retryDecryptionSessionIDsUnderlyingCallsCount
                 }
 
                 return returnValue!
@@ -14166,28 +14166,28 @@ class TimelineProxyMock: TimelineProxyProtocol {
         }
         set {
             if Thread.isMainThread {
-                retryDecryptionForUnderlyingCallsCount = newValue
+                retryDecryptionSessionIDsUnderlyingCallsCount = newValue
             } else {
                 DispatchQueue.main.sync {
-                    retryDecryptionForUnderlyingCallsCount = newValue
+                    retryDecryptionSessionIDsUnderlyingCallsCount = newValue
                 }
             }
         }
     }
-    var retryDecryptionForCalled: Bool {
+    var retryDecryptionSessionIDsCalled: Bool {
-        return retryDecryptionForCallsCount > 0
+        return retryDecryptionSessionIDsCallsCount > 0
     }
-    var retryDecryptionForReceivedSessionID: String?
+    var retryDecryptionSessionIDsReceivedSessionIDs: [String]?
-    var retryDecryptionForReceivedInvocations: [String] = []
+    var retryDecryptionSessionIDsReceivedInvocations: [[String]?] = []
-    var retryDecryptionForClosure: ((String) async -> Void)?
+    var retryDecryptionSessionIDsClosure: (([String]?) async -> Void)?
 
-    func retryDecryption(for sessionID: String) async {
+    func retryDecryption(sessionIDs: [String]?) async {
-        retryDecryptionForCallsCount += 1
+        retryDecryptionSessionIDsCallsCount += 1
-        retryDecryptionForReceivedSessionID = sessionID
+        retryDecryptionSessionIDsReceivedSessionIDs = sessionIDs
         DispatchQueue.main.async {
-            self.retryDecryptionForReceivedInvocations.append(sessionID)
+            self.retryDecryptionSessionIDsReceivedInvocations.append(sessionIDs)
         }
-        await retryDecryptionForClosure?(sessionID)
+        await retryDecryptionSessionIDsClosure?(sessionIDs)
     }
     //MARK: - paginateBackwards
 

ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift

@@ -196,6 +196,14 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
             .throttle(for: .milliseconds(100), scheduler: DispatchQueue.main, latest: true)
             .weakAssign(to: \.state.unseenKnockRequests, on: self)
             .store(in: &cancellables)
+        
+        NotificationCenter.default.publisher(for: UIApplication.didBecomeActiveNotification)
+            .sink { [weak self] _ in
+                Task {
+                    await self?.roomProxy.timeline.retryDecryption()
+                }
+            }
+            .store(in: &cancellables)
     }
     
     private func processIdentityStatusChanges(_ changes: [IdentityStatusChange]) async {

ElementX/Sources/Screens/Timeline/TimelineInteractionHandler.swift

@@ -157,8 +157,6 @@ class TimelineInteractionHandler {
             let debugInfo = timelineController.debugInfo(for: eventTimelineItem.id)
             MXLog.info("Showing debug info for \(eventTimelineItem.id)")
             actionsSubject.send(.showDebugInfo(debugInfo))
-        case .retryDecryption(let sessionID):
-            Task { await timelineController.retryDecryption(for: sessionID) }
         case .report:
             actionsSubject.send(.displayReportContent(itemID: itemID, senderID: eventTimelineItem.sender.id))
         case .react:

ElementX/Sources/Screens/Timeline/View/ItemMenu/TimelineItemMenuAction.swift

@@ -67,7 +67,6 @@ enum TimelineItemMenuAction: Identifiable, Hashable {
     case reply(isThread: Bool)
     case forward(itemID: TimelineItemIdentifier)
     case viewSource
-    case retryDecryption(sessionID: String)
     case report
     case react
     case toggleReaction(key: String)
@@ -164,8 +163,6 @@ enum TimelineItemMenuAction: Identifiable, Hashable {
             Label(L10n.actionRemoveMessage, icon: \.delete)
         case .viewSource:
             Label(L10n.actionViewSource, icon: \.code)
-        case .retryDecryption:
-            Label(L10n.actionRetryDecryption, systemImage: "arrow.down.message")
         case .report:
             Label(L10n.actionReportContent, icon: \.chatProblem)
         case .react:

ElementX/Sources/Screens/Timeline/View/ItemMenu/TimelineItemMenuActionProvider.swift

@@ -137,13 +137,6 @@ struct TimelineItemMenuActionProvider {
             actions.append(.viewSource)
         }
                 
-        switch encryptedItem.encryptionType {
-        case .megolmV1AesSha2(let sessionID, _):
-            secondaryActions.append(.retryDecryption(sessionID: sessionID))
-        default:
-            break
-        }
-        
         return .init(isReactable: false,
                      actions: actions,
                      secondaryActions: secondaryActions,

ElementX/Sources/Services/Timeline/TimelineController/MockRoomTimelineController.swift

@@ -139,8 +139,6 @@ class MockRoomTimelineController: RoomTimelineControllerProtocol {
         nil
     }
         
-    func retryDecryption(for sessionID: String) async { }
-        
     func eventTimestamp(for itemID: TimelineItemIdentifier) -> Date? {
         timelineItemsTimestamp[itemID] ?? .now
     }

ElementX/Sources/Services/Timeline/TimelineController/RoomTimelineController.swift

@@ -356,10 +356,6 @@ class RoomTimelineController: RoomTimelineControllerProtocol {
         return nil
     }
     
-    func retryDecryption(for sessionID: String) async {
-        await activeTimeline.retryDecryption(for: sessionID)
-    }
-    
     // MARK: - Private
     
     /// The cancellable used to update the timeline items.

ElementX/Sources/Services/Timeline/TimelineController/RoomTimelineControllerProtocol.swift

@@ -82,7 +82,5 @@ protocol RoomTimelineControllerProtocol {
     
     func sendHandle(for itemID: TimelineItemIdentifier) -> SendHandleProxy?
     
-    func retryDecryption(for sessionID: String) async
-    
     func eventTimestamp(for itemID: TimelineItemIdentifier) -> Date?
 }

ElementX/Sources/Services/Timeline/TimelineProxy.swift

@@ -155,12 +155,14 @@ final class TimelineProxy: TimelineProxyProtocol {
         }
     }
     
-    func retryDecryption(for sessionID: String) async {
+    func retryDecryption(sessionIDs: [String]?) async {
-        MXLog.info("Retrying decryption for sessionID: \(sessionID)")
+        let sessionIDs = sessionIDs ?? []
+        
+        MXLog.info("Retrying decryption for sessionIDs: \(sessionIDs)")
         
         await Task.dispatch(on: .global()) { [weak self] in
-            self?.timeline.retryDecryption(sessionIds: [sessionID])
+            self?.timeline.retryDecryption(sessionIds: sessionIDs)
-            MXLog.info("Finished retrying decryption for sessionID: \(sessionID)")
+            MXLog.info("Finished retrying decryption for sessionID: \(sessionIDs)")
         }
     }
     

ElementX/Sources/Services/Timeline/TimelineProxyProtocol.swift

@@ -35,7 +35,7 @@ protocol TimelineProxyProtocol {
     
     func messageEventContent(for timelineItemID: TimelineItemIdentifier) async -> RoomMessageEventContentWithoutRelation?
     
-    func retryDecryption(for sessionID: String) async
+    func retryDecryption(sessionIDs: [String]?) async
     
     func paginateBackwards(requestSize: UInt16) async -> Result<Void, TimelineProxyError>
     func paginateForwards(requestSize: UInt16) async -> Result<Void, TimelineProxyError>
@@ -113,3 +113,9 @@ protocol TimelineProxyProtocol {
                                 html: String?,
                                 intentionalMentions: Mentions) -> RoomMessageEventContentWithoutRelation
 }
+
+extension TimelineProxyProtocol {
+    func retryDecryption() async {
+        await retryDecryption(sessionIDs: nil)
+    }
+}