Fix the ActiveLiveLocationsEndTimeTracker not triggering an UI Update

Author: nuno-vieira

Sources/StreamChat/Workers/Background/ActiveLiveLocationsEndTimeTracker.swift

@@ -73,10 +73,17 @@ class ActiveLiveLocationsEndTimeTracker: Worker {
         queue.asyncAfter(deadline: .now() + endAtTime, execute: workItem)
     }
 
+    /// It sets the location as inactive in the database and removes it from the active live locations.
+    ///
+    /// The update of `updatedAt` is needed for the UI to be updated.
+    /// The reason is because otherwise the `Equatable` of `SharedLocation` won't have any effect.
+    /// Since the `endAt` is not changed, and the `isLiveSharingActive` property is a computed one.
+    /// Which means, that when the `Equatable` is checked, it will return `true` and the UI won't update.
     private func setInactiveLocation(for messageId: String) {
         database.write { session in
             let message = session.message(id: messageId)
             message?.isActiveLiveLocation = false
+            message?.location?.updatedAt = DBDate() // This is need for the UI to be updated.
             if let location = message?.location {
                 message?.channel?.activeLiveLocations.remove(location)
             }

Tests/StreamChatTests/Workers/Background/ActiveLiveLocationsEndTimeTracker_Tests.swift

@@ -127,6 +127,7 @@ final class ActiveLiveLocationsEndTimeTracker_Tests: XCTestCase {
         let messageId: MessageId = .unique
         let currentUserId: UserId = .unique
         let endAt = Date().addingTimeInterval(100)
+        let updatedAt = Date.unique
 
         // Create current user and channel
         try database.createCurrentUser(id: currentUserId)
@@ -144,7 +145,7 @@ final class ActiveLiveLocationsEndTimeTracker_Tests: XCTestCase {
                 latitude: 10.0,
                 longitude: 20.0,
                 createdAt: Date(),
-                updatedAt: Date(),
+                updatedAt: updatedAt,
                 endAt: endAt,
                 createdByDeviceId: .unique
             )
@@ -162,6 +163,9 @@ final class ActiveLiveLocationsEndTimeTracker_Tests: XCTestCase {
 
         // Verify work item is removed
         AssertAsync.willBeEqual(tracker.workItems.count, 0)
+        let newUpdatedAt = try XCTUnwrap(database.viewContext.message(id: messageId)?.updatedAt)
+        // The updateAt should be updated especially to trigger an UI Update.
+        XCTAssertNotEqual(String(newUpdatedAt.timeIntervalSince1970), String(updatedAt.timeIntervalSince1970))
     }
 
     func test_trackerDoesNotScheduleWorkItem_forMessageWithoutEndTime() throws {