Fix: Refreshing the poll when receiving pollEnd can break the chronological order in the store.

MatrixSDK/Aggregations/MXAggregations.m

@@ -315,8 +315,6 @@ - (void)registerListener
                     [self.beaconAggregations handleBeaconWithEvent:event];
                 }
                 break;
-            case MXEventTypePollEnd:
-                [self.aggregatedPollsUpdater refreshPollAfter:event];
             default:
                 break;
         }

MatrixSDK/Room/Polls/PollAggregator.swift

@@ -54,7 +54,7 @@ public class PollAggregator {
     private var events: [MXEvent] = []
     private var hasBeenEdited = false
 
-    public private(set) var poll: PollProtocol! {
+    public private(set) var poll: PollProtocol? {
         didSet {
             delegate?.pollAggregatorDidUpdateData(self)
         }
@@ -88,10 +88,10 @@ public class PollAggregator {
             throw PollAggregatorError.invalidPollStartEvent
         }
 
-        try self.init(session: session, room: room, pollStartEventId: pollStartEventId, delegate: delegate)
+        self.init(session: session, room: room, pollStartEventId: pollStartEventId, delegate: delegate)
     }
 
-    public init(session: MXSession, room: MXRoom, pollStartEventId: String, delegate: PollAggregatorDelegate? = nil) throws {
+    public init(session: MXSession, room: MXRoom, pollStartEventId: String, delegate: PollAggregatorDelegate? = nil) {
         self.session = session
         self.room = room
         self.pollStartEventId = pollStartEventId
@@ -100,9 +100,11 @@ public class PollAggregator {
 
         NotificationCenter.default.addObserver(self, selector: #selector(handleRoomDataFlush), name: .mxRoomDidFlushData, object: self.room)
         setupEditListener()
-        try buildPollStartContent()
+        try? buildPollStartContent()
+
+        reloadPollData()
     }
-
+        
     private func setupEditListener() {
         editEventsListener = session.aggregations.listenToEditsUpdate(inRoom: self.room.roomId) { [weak self] event in
             guard let self = self,
@@ -111,11 +113,7 @@ public class PollAggregator {
                 return
             }
 
-            do {
-                try self.buildPollStartContent()
-            } catch {
-                self.delegate?.pollAggregator(self, didFailWithError: PollAggregatorError.invalidPollStartEvent)
-            }
+            try? self.buildPollStartContent()
         }
     }
 
@@ -137,10 +135,8 @@ public class PollAggregator {
                                  events: events,
                                  currentUserIdentifier: session.myUserId,
                                  hasBeenEdited: hasBeenEdited)
-
-        reloadPollData()
     }
-
+        
     @objc private func handleRoomDataFlush(sender: Notification) {
         guard let room = sender.object as? MXRoom, room == self.room else {
             return
@@ -153,7 +149,23 @@ public class PollAggregator {
         delegate?.pollAggregatorDidStartLoading(self)
 
         session.aggregations.referenceEvents(forEvent: pollStartEventId, inRoom: room.roomId, from: nil, limit: -1) { [weak self] response in
-            guard let self = self else {
+            guard let self else {
+                return
+            }
+
+            guard let event = response.originalEvent else {
+                // we didn't found the start event
+                self.delegate?.pollAggregator(self, didFailWithError: PollAggregatorError.invalidPollStartEvent)
+                return
+            }
+
+            if let pollStartEventContent = MXEventContentPollStart(fromJSON: event.content), pollStartEventContent.answerOptions.count >= Constants.minAnswerOptionCount {
+                pollStartedEvent = event
+                self.pollStartEventContent = pollStartEventContent
+                hasBeenEdited = (event.unsignedData.relations?.replace != nil)
+            } else {
+                // we were not able to decrypt the start event content
+                self.delegate?.pollAggregator(self, didFailWithError: PollAggregatorError.invalidPollStartEvent)
                 return
             }
 
@@ -179,7 +191,7 @@ public class PollAggregator {
                                                    currentUserIdentifier: self.session.myUserId,
                                                    hasBeenEdited: self.hasBeenEdited)
             } as Any
-            
+
             self.poll = self.pollBuilder.build(pollStartEventContent: self.pollStartEventContent,
                                                pollStartEvent: self.pollStartedEvent,
                                                events: self.events,

changelog.d/pr-1776.bugfix

@@ -0,0 +1 @@
+Poll: Refreshing the poll when receiving pollEnd can break the chronological order in the store.