Capture decryption errors (PSG-1023)

MatrixSDK/MXSession.h

@@ -302,6 +302,14 @@ FOUNDATION_EXPORT NSString *const kMXSessionDidUpdateGroupUsersNotification;
  */
 FOUNDATION_EXPORT NSString *const kMXSessionDidUpdatePublicisedGroupsForUsersNotification;
 
+/**
+ Posted when MXSession fails to decrypt a list of events.
+
+ The passed userInfo dictionary contains:
+ - `kMXSessionNotificationEventsArrayKey` the list of the events the session fails to decrypt.
+ */
+FOUNDATION_EXPORT NSString *const kMXSessionDidFailToDecryptEventsNotification;
+
 #pragma mark - Notifications keys
 /**
  The key in notification userInfo dictionary representating the roomId.
@@ -339,6 +347,11 @@ FOUNDATION_EXPORT NSString *const kMXSessionNotificationErrorKey;
  */
 FOUNDATION_EXPORT NSString *const kMXSessionNotificationUserIdsArrayKey;
 
+/**
+ The key in notification userInfo dictionary representating a list of events.
+ */
+FOUNDATION_EXPORT NSString *const kMXSessionNotificationEventsArrayKey;
+
 
 #pragma mark - Other constants
 /**

MatrixSDK/MXSession.m

@@ -71,6 +71,7 @@
 NSString *const kMXSessionDidUpdateGroupRoomsNotification = @"kMXSessionDidUpdateGroupRoomsNotification";
 NSString *const kMXSessionDidUpdateGroupUsersNotification = @"kMXSessionDidUpdateGroupUsersNotification";
 NSString *const kMXSessionDidUpdatePublicisedGroupsForUsersNotification = @"kMXSessionDidUpdatePublicisedGroupsForUsersNotification";
+NSString *const kMXSessionDidFailToDecryptEventsNotification = @"kMXSessionDidFailToDecryptEventsNotification";
 
 NSString *const kMXSessionNotificationRoomIdKey = @"roomId";
 NSString *const kMXSessionNotificationGroupKey = @"group";
@@ -79,6 +80,7 @@
 NSString *const kMXSessionNotificationSyncResponseKey = @"syncResponse";
 NSString *const kMXSessionNotificationErrorKey = @"error";
 NSString *const kMXSessionNotificationUserIdsArrayKey = @"userIds";
+NSString *const kMXSessionNotificationEventsArrayKey = @"events";
 
 NSString *const kMXSessionNoRoomTag = @"m.recent";  // Use the same value as matrix-react-sdk
 
@@ -5000,6 +5002,12 @@ - (void)decryptEvents:(NSArray<MXEvent*> *)events
                 }
             }
 
+            if (failedEvents.count > 0) {
+                [NSNotificationCenter.defaultCenter postNotificationName:kMXSessionDidFailToDecryptEventsNotification
+                                                                  object:self
+                                                                userInfo:@{ kMXSessionNotificationEventsArrayKey: failedEvents }];
+            }
+
             onComplete(failedEvents);
         }];
     }

MatrixSDK/Room/Polls/PollAggregator.swift

@@ -52,6 +52,7 @@ public class PollAggregator {
 
     private var events: [MXEvent] = []
     private var hasBeenEdited = false
+    private var relatedUndecryptableEvents: Set<String> = []
 
     public private(set) var poll: PollProtocol! {
         didSet {
@@ -77,8 +78,31 @@ public class PollAggregator {
         self.pollStartEventId = pollStartEventId
         self.pollBuilder = PollBuilder()
 
-        NotificationCenter.default.addObserver(self, selector: #selector(handleRoomDataFlush), name: NSNotification.Name.mxRoomDidFlushData, object: self.room)
+        NotificationCenter.default.addObserver(self, selector: #selector(handleRoomDataFlush), name: .mxRoomDidFlushData, object: self.room)
+        setupEditListener()
+        try buildPollStartContent()
+    }
+
+    public func handleErroredRelatedEventsIds(_ ids: Set<String>?, to parentEvent: String) {
+        guard parentEvent == pollStartEventId else {
+            return
+        }
+
+        let newUndecryptableEvents = ids ?? []
+        guard relatedUndecryptableEvents != newUndecryptableEvents else {
+            return
+        }
 
+        relatedUndecryptableEvents = newUndecryptableEvents
+
+        self.poll = pollBuilder.build(pollStartEventContent: pollStartEventContent,
+                                      events: events,
+                                      currentUserIdentifier: session.myUserId,
+                                      hasBeenEdited: hasBeenEdited,
+                                      hasDecryptionError: hasDecryptionError)
+    }
+
+    private func setupEditListener() {
         editEventsListener = session.aggregations.listenToEditsUpdate(inRoom: self.room.roomId) { [weak self] event in
             guard let self = self,
                   self.pollStartEventId == event.relatesTo.eventId
@@ -92,8 +116,6 @@ public class PollAggregator {
                 self.delegate?.pollAggregator(self, didFailWithError: PollAggregatorError.invalidPollStartEvent)
             }
         }
-
-        try buildPollStartContent()
     }
 
     private func buildPollStartContent() throws {
@@ -111,7 +133,8 @@ public class PollAggregator {
         poll = pollBuilder.build(pollStartEventContent: eventContent,
                                  events: events,
                                  currentUserIdentifier: session.myUserId,
-                                 hasBeenEdited: hasBeenEdited)
+                                 hasBeenEdited: hasBeenEdited,
+                                 hasDecryptionError: hasDecryptionError)
 
         reloadPollData()
     }
@@ -149,13 +172,15 @@ public class PollAggregator {
                 self.poll = self.pollBuilder.build(pollStartEventContent: self.pollStartEventContent,
                                                    events: self.events,
                                                    currentUserIdentifier: self.session.myUserId,
-                                                   hasBeenEdited: self.hasBeenEdited)
+                                                   hasBeenEdited: self.hasBeenEdited,
+                                                   hasDecryptionError: self.hasDecryptionError)
             } as Any
 
             self.poll = self.pollBuilder.build(pollStartEventContent: self.pollStartEventContent,
                                                events: self.events,
                                                currentUserIdentifier: self.session.myUserId,
-                                               hasBeenEdited: self.hasBeenEdited)
+                                               hasBeenEdited: self.hasBeenEdited,
+                                               hasDecryptionError: self.hasDecryptionError)
 
             self.delegate?.pollAggregatorDidEndLoading(self)
 
@@ -167,4 +192,8 @@ public class PollAggregator {
             self.delegate?.pollAggregator(self, didFailWithError: error)
         }
     }
+
+    private var hasDecryptionError: Bool {
+        relatedUndecryptableEvents.isEmpty == false
+    }
 }

MatrixSDK/Room/Polls/PollBuilder.swift

@@ -22,10 +22,11 @@ struct PollBuilder {
         static let maxAnswerOptionCount = 20
     }
 
-    func build(pollStartEventContent: MXEventContentPollStart, events: [MXEvent], currentUserIdentifier: String, hasBeenEdited: Bool = false) -> PollProtocol {
+    func build(pollStartEventContent: MXEventContentPollStart, events: [MXEvent], currentUserIdentifier: String, hasBeenEdited: Bool = false, hasDecryptionError: Bool = false) -> PollProtocol {
 
         let poll = Poll()
         poll.hasBeenEdited = hasBeenEdited
+        poll.hasDecryptionError = hasDecryptionError
 
         poll.text = pollStartEventContent.question
         poll.maxAllowedSelections = max(1, pollStartEventContent.maxSelections.uintValue)

MatrixSDK/Room/Polls/PollModels.swift

@@ -37,6 +37,7 @@ public protocol PollProtocol {
     var isClosed: Bool { get }
     var totalAnswerCount: UInt { get }
     var hasBeenEdited: Bool { get }
+    var hasDecryptionError: Bool { get }
 }
 
 class PollAnswerOption: PollAnswerOptionProtocol {
@@ -56,6 +57,7 @@ class Poll: PollProtocol {
     var maxAllowedSelections: UInt = 1
     var isClosed: Bool = false
     var hasBeenEdited: Bool = false
+    var hasDecryptionError: Bool = false
 
     var totalAnswerCount: UInt {
         return self.answerOptions.reduce(0) { $0 + $1.count}

MatrixSDKTests/MXPollAggregatorTests.swift

@@ -155,6 +155,38 @@ class MXPollAggregatorTest: XCTestCase {
         }
     }
 
+    func testErrorsAreIgnoredForOtherPolls() {
+        createScenarioForBobAndAlice { bobSession, aliceSession, bobRoom, aliceRoom, pollStartEvent, expectation in
+            self.pollAggregator = try! PollAggregator(session: bobSession, room: bobRoom, pollStartEventId: pollStartEvent.eventId)
+            self.pollAggregator.handleErroredRelatedEventsIds(["A", "B"], to: "someId")
+            XCTAssertFalse(self.pollAggregator.poll.hasDecryptionError)
+            expectation.fulfill()
+        }
+    }
+
+    func testNoErrorsAreIgnored() {
+        createScenarioForBobAndAlice { bobSession, aliceSession, bobRoom, aliceRoom, pollStartEvent, expectation in
+            self.pollAggregator = try! PollAggregator(session: bobSession, room: bobRoom, pollStartEventId: pollStartEvent.eventId)
+            self.pollAggregator.handleErroredRelatedEventsIds([], to: pollStartEvent.eventId)
+            XCTAssertFalse(self.pollAggregator.poll.hasDecryptionError)
+            expectation.fulfill()
+        }
+    }
+
+    func testErrorsAreConsideredWhenRelatedToThisPoll() {
+        createScenarioForBobAndAlice { bobSession, aliceSession, bobRoom, aliceRoom, pollStartEvent, expectation in
+            self.pollAggregator = try! PollAggregator(session: bobSession, room: bobRoom, pollStartEventId: pollStartEvent.eventId)
+
+            self.pollAggregator.delegate = PollAggregatorBlockWrapper(dataUpdateCallback: {
+                XCTAssertTrue(self.pollAggregator.poll.hasDecryptionError)
+                expectation.fulfill()
+                self.pollAggregator.delegate = nil
+            })
+
+            self.pollAggregator.handleErroredRelatedEventsIds(["A", "B"], to: pollStartEvent.eventId)
+        }
+    }
+
     // MARK: - Private
 
     func createScenarioForBobAndAlice(_ readyToTest: @escaping (MXSession, MXSession, MXRoom, MXRoom, MXEvent, XCTestExpectation) -> Void) {

MatrixSDKTests/MXSessionTests.m

@@ -1509,6 +1509,31 @@ - (void)testMXSDKOptionsWellknownDomainUrl
     }];
 }
 
+#pragma mark Failing decryption
+
+-(void)testNotificationIsCorrectAfterDecryptionFailure
+{
+    MXEvent* fakeEncryptedEvent = [MXEvent modelFromJSON:@{
+        @"event_id": @"abc",
+        @"type": kMXEventTypeStringRoomEncrypted,
+        @"content": @{ @"garbage": @"0000" }
+    }];
+
+    [matrixSDKTestsData doMXSessionTestWithBob:self readyToTest:^(MXSession *mxSession, XCTestExpectation *expectation) {
+        [NSNotificationCenter.defaultCenter addObserverForName:kMXSessionDidFailToDecryptEventsNotification object:mxSession queue:nil usingBlock:^(NSNotification * _Nonnull notification) {
+            XCTAssertTrue(mxSession == notification.object);
+            NSArray* events = notification.userInfo[kMXSessionNotificationEventsArrayKey];
+            XCTAssertTrue(fakeEncryptedEvent == events.firstObject);
+            [expectation fulfill];
+        }];
+
+        [mxSession enableCrypto:YES
+                        success:^{ [mxSession decryptEvents:@[fakeEncryptedEvent] inTimeline:nil onComplete:^(NSArray<MXEvent *> *failedEvents) {}]; }
+                        failure:^(NSError *error) { XCTFail();}
+        ];
+    }];
+}
+
 #pragma mark Account Data tests
 
 -(void)testAccountDataIsDeletedLocally

changelog.d/pr-1673.change

@@ -0,0 +1 @@
+Polls: handle decryption errors.