Fixes element-hq/element-meta/issues/2525 - Display a warning when a user's pinned identity changes

ElementX/Sources/Services/Room/JoinedRoomProxy.swift

@@ -58,6 +58,8 @@ class JoinedRoomProxy: JoinedRoomProxyProtocol {
     private var roomInfoObservationToken: TaskHandle?
     // periphery:ignore - required for instance retention in the rust codebase
     private var typingNotificationObservationToken: TaskHandle?
+    // periphery:ignore - required for instance retention in the rust codebase
+    private var identityStatusChangesObservationToken: TaskHandle?
     
     private var subscribedForUpdates = false
 
@@ -70,6 +72,11 @@ class JoinedRoomProxy: JoinedRoomProxyProtocol {
     var typingMembersPublisher: CurrentValuePublisher<[String], Never> {
         typingMembersSubject.asCurrentValuePublisher()
     }
+    
+    private let identityStatusChangesSubject = CurrentValueSubject<[IdentityStatusChange], Never>([])
+    var identityStatusChangesPublisher: CurrentValuePublisher<[IdentityStatusChange], Never> {
+        identityStatusChangesSubject.asCurrentValuePublisher()
+    }
         
     private let actionsSubject = PassthroughSubject<JoinedRoomProxyAction, Never>()
     var actionsPublisher: AnyPublisher<JoinedRoomProxyAction, Never> {
@@ -193,6 +200,8 @@ class JoinedRoomProxy: JoinedRoomProxyProtocol {
         
         subscribeToRoomInfoUpdates()
         
+        subscribeToIdentityStatusChanges()
+        
         subscribeToTypingNotifications()
     }
     
@@ -708,6 +717,16 @@ class JoinedRoomProxy: JoinedRoomProxyProtocol {
             typingMembersSubject.send(typingMembers)
         })
     }
+    
+    private func subscribeToIdentityStatusChanges() {
+        identityStatusChangesObservationToken = room.subscribeToIdentityStatusChanges(listener: RoomIdentityStatusChangeListener { [weak self] changes in
+            guard let self else { return }
+            
+            MXLog.info("Received identity status changes: \(changes)")
+            
+            identityStatusChangesSubject.send(changes)
+        })
+    }
 }
 
 private final class RoomInfoUpdateListener: RoomInfoListener {
@@ -733,3 +752,15 @@ private final class RoomTypingNotificationUpdateListener: TypingNotificationsLis
         onUpdateClosure(typingUserIds)
     }
 }
+
+private final class RoomIdentityStatusChangeListener: IdentityStatusChangeListener {
+    private let onUpdateClosure: ([IdentityStatusChange]) -> Void
+    
+    init(_ onUpdateClosure: @escaping ([IdentityStatusChange]) -> Void) {
+        self.onUpdateClosure = onUpdateClosure
+    }
+    
+    func call(identityStatusChange: [IdentityStatusChange]) {
+        onUpdateClosure(identityStatusChange)
+    }
+}

ElementX/Sources/Services/Room/RoomMember/RoomMemberProxy.swift

@@ -16,12 +16,24 @@ final class RoomMemberProxy: RoomMemberProxyProtocol {
     }
     
     var userID: String { member.userId }
+    
     var displayName: String? { member.displayName }
+    
+    var disambiguatedDisplayName: String? {
+        guard let displayName else {
+            return nil
+        }
+        
+        return member.isNameAmbiguous ? "\(displayName) (\(userID))" : displayName
+    }
+    
     var avatarURL: URL? { member.avatarUrl.flatMap(URL.init(string:)) }
     
     var membership: MembershipState { member.membership }
+    
     var isIgnored: Bool { member.isIgnored }
     
     var powerLevel: Int { Int(member.powerLevel) }
+    
     var role: RoomMemberRole { member.suggestedRoleForPowerLevel }
 }

ElementX/Sources/Services/Room/RoomMember/RoomMemberProxyProtocol.swift

@@ -11,13 +11,18 @@ import MatrixRustSDK
 // sourcery: AutoMockable
 protocol RoomMemberProxyProtocol: AnyObject {
     var userID: String { get }
+    
     var displayName: String? { get }
+    var disambiguatedDisplayName: String? { get }
+    
     var avatarURL: URL? { get }
     
     var membership: MembershipState { get }
+    
     var isIgnored: Bool { get }
     
     var powerLevel: Int { get }
+    
     var role: RoomMemberRole { get }
 }
 

ElementX/Sources/Services/Room/RoomProxyProtocol.swift

@@ -56,7 +56,7 @@ protocol InvitedRoomProxyProtocol: RoomProxyProtocol {
     func acceptInvitation() async -> Result<Void, RoomProxyError>
 }
 
-enum JoinedRoomProxyAction {
+enum JoinedRoomProxyAction: Equatable {
     case roomInfoUpdate
 }
 
@@ -73,6 +73,8 @@ protocol JoinedRoomProxyProtocol: RoomProxyProtocol {
     
     var typingMembersPublisher: CurrentValuePublisher<[String], Never> { get }
     
+    var identityStatusChangesPublisher: CurrentValuePublisher<[IdentityStatusChange], Never> { get }
+    
     var actionsPublisher: AnyPublisher<JoinedRoomProxyAction, Never> { get }
     
     var timeline: TimelineProxyProtocol { get }