Merge pull request #6145 from vector-im/aringenbach/6144_presence_home_dm_refresh

Presence: fix live updates on Home & DM list

Author: aringenbach

Riot/Modules/Common/PresenceIndicator/PresenceIndicatorListener.swift

@@ -0,0 +1,63 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+/// Dedicated listener object for a user Presence status.
+class PresenceIndicatorListener {
+    // MARK: - Properties
+    private let userId: String
+    private var presence: MXPresence
+    private let onUpdate: (MXPresence) -> Void
+    private var presenceObserver: Any?
+
+    // MARK: - Setup
+    /// Init.
+    ///
+    /// - Parameters:
+    ///   - userId: the user id
+    ///   - presence: initial presence of the user
+    ///   - onUpdate: callback for Presence updates
+    init(userId: String, presence: MXPresence, onUpdate: @escaping (MXPresence) -> Void) {
+        self.userId = userId
+        self.presence = presence
+        self.onUpdate = onUpdate
+
+        NotificationCenter.default.addObserver(forName: .mxkContactManagerMatrixUserPresenceChange,
+                                               object: nil,
+                                               queue: .main) { [weak self] notif in
+            guard let self = self,
+                  self.userId == notif.object as? String,
+                  let presenceString = notif.userInfo?[kMXKContactManagerMatrixPresenceKey] as? String else {
+                return
+            }
+
+            let newPresence = MXTools.presence(presenceString)
+
+            guard self.presence != newPresence else { return }
+
+            self.presence = newPresence
+            self.onUpdate(newPresence)
+        }
+    }
+
+    deinit {
+        if let presenceObserver = presenceObserver {
+            NotificationCenter.default.removeObserver(presenceObserver)
+            self.presenceObserver = nil
+        }
+    }
+}

Riot/Modules/Common/PresenceIndicator/PresenceIndicatorView.swift

@@ -16,6 +16,11 @@
 
 import UIKit
 
+/// Delegate for `PresenceIndicatorView`.
+@objc protocol PresenceIndicatorViewDelegate: AnyObject {
+    func presenceIndicatorViewDidUpdateVisibility(_ presenceIndicatorView: PresenceIndicatorView, isHidden: Bool)
+}
+
 /// `PresenceIndicatorView` is used to display a presence indicator over an avatar.
 @objcMembers
 @IBDesignable
@@ -24,9 +29,24 @@ final class PresenceIndicatorView: UIView {
     @IBInspectable var borderWidth: CGFloat = 0.0
     var borderColor: UIColor = ThemeService.shared().theme.backgroundColor
 
-    // MARK: - Private Properties
+    // MARK: - Properties
+
+    // MARK: Private
     private let borderLayer = CALayer()
-    
+    private var listener: PresenceIndicatorListener?
+
+    // MARK: Internal
+    weak var delegate: PresenceIndicatorViewDelegate?
+
+    // MARK: Override
+    override var isHidden: Bool {
+        didSet {
+            if oldValue != isHidden, let delegate = delegate {
+                delegate.presenceIndicatorViewDidUpdateVisibility(self, isHidden: isHidden)
+            }
+        }
+    }
+
     // MARK: - Private Constants
     private enum Constants {
         static let borderLayerOffset: CGFloat = 1.0
@@ -57,6 +77,34 @@ final class PresenceIndicatorView: UIView {
     }
 
     // MARK: - Internal Methods
+    /// Configures the view and starts listening Presence updates for given user.
+    ///
+    /// - Parameters:
+    ///   - userId: the user id
+    ///   - presence: the initial Presence of the user
+    func configure(userId: String, presence: MXPresence) {
+        setPresence(presence)
+        self.listener = PresenceIndicatorListener(userId: userId,
+                                                  presence: presence) { [weak self] presence in
+            guard let self = self else { return }
+            self.setPresence(presence)
+        }
+    }
+
+    /// Stop listening to Presence updates and hides the indicator.
+    /// This should be called before reuse or if current room moves from direct to non-direct.
+    func stopListeningPresenceUpdates() {
+        self.listener = nil
+        self.isHidden = true
+    }
+}
+    
+// MARK: - Private Methods
+private extension PresenceIndicatorView {
+    func setup() {
+        self.layer.addSublayer(borderLayer)
+    }
+
     /// Updates presence indicator with given `MXPresence`.
     ///
     /// - Parameters:
@@ -66,22 +114,18 @@ final class PresenceIndicatorView: UIView {
         case .online:
             self.backgroundColor = ThemeService.shared().theme.tintColor
             self.borderLayer.borderColor = self.borderColor.cgColor
+            self.isHidden = false
         case .offline, .unavailable:
             self.backgroundColor = ThemeService.shared().theme.tabBarUnselectedItemTintColor
             self.borderLayer.borderColor = self.borderColor.cgColor
+            self.isHidden = false
         default:
             self.backgroundColor = UIColor.clear
             self.borderLayer.borderColor = UIColor.clear.cgColor
+            self.isHidden = true
         }
     }
 }
-    
-// MARK: - Private Methods
-private extension PresenceIndicatorView {
-    func setup() {
-        self.layer.addSublayer(borderLayer)
-    }
-}
 
 // MARK: - CGRect Helper
 private extension CGRect {

Riot/Modules/Common/Recents/Views/RecentTableViewCell.m

@@ -48,6 +48,7 @@ - (void)customizeTableViewCellRendering
     self.lastEventDescription.textColor = ThemeService.shared.theme.textSecondaryColor;
     self.lastEventDate.textColor = ThemeService.shared.theme.textSecondaryColor;
     self.missedNotifAndUnreadBadgeLabel.textColor = ThemeService.shared.theme.baseTextPrimaryColor;
+    self.presenceIndicatorView.borderColor = ThemeService.shared.theme.backgroundColor;
 
     self.roomAvatar.defaultBackgroundColor = [UIColor clearColor];
 }
@@ -128,18 +129,29 @@ - (void)render:(MXKCellData *)cellData
                                             roomId:roomCellData.roomIdentifier
                                        displayName:roomCellData.roomDisplayname
                                       mediaManager:roomCellData.mxSession.mediaManager];
-        
-        // Presence indicator
-        self.presenceIndicatorView.borderColor = ThemeService.shared.theme.backgroundColor;
-        self.presenceIndicatorView.presence = roomCellData.presence;
-        self.presenceIndicatorView.hidden = roomCellData.presence == MXPresenceUnknown;
+
+        if (roomCellData.directUserId)
+        {
+            [self.presenceIndicatorView configureWithUserId:roomCellData.directUserId presence:roomCellData.presence];
+        }
+        else
+        {
+            [self.presenceIndicatorView stopListeningPresenceUpdates];
+        }
     }
     else
     {
         self.lastEventDescription.text = @"";
     }
 }
 
+- (void)prepareForReuse
+{
+    [super prepareForReuse];
+
+    [self.presenceIndicatorView stopListeningPresenceUpdates];
+}
+
 + (CGFloat)heightForCellData:(MXKCellData *)cellData withMaximumWidth:(CGFloat)maxWidth
 {
     // The height is fixed

Riot/Modules/Home/Views/RoomCollectionViewCell.m

@@ -146,10 +146,15 @@ - (void)render:(MXKCellData *)cellData
                                             roomId:roomCellData.roomIdentifier
                                        displayName:roomCellData.roomDisplayname
                                       mediaManager:roomCellData.mxSession.mediaManager];
-        
-        // Presence indicator
-        self.presenceIndicatorView.presence = roomCellData.presence;
-        self.presenceIndicatorView.hidden = roomCellData.presence == MXPresenceUnknown;
+
+        if (roomCellData.directUserId)
+        {
+            [self.presenceIndicatorView configureWithUserId:roomCellData.directUserId presence:roomCellData.presence];
+        }
+        else
+        {
+            [self.presenceIndicatorView stopListeningPresenceUpdates];
+        }
     }
 }
 
@@ -172,7 +177,9 @@ + (CGSize)defaultCellSize
 - (void)prepareForReuse
 {
     [super prepareForReuse];
-    
+
+    [self.presenceIndicatorView stopListeningPresenceUpdates];
+
     // Remove all gesture recognizers
     while (self.gestureRecognizers.count)
     {

Riot/Modules/MatrixKit/Models/RoomList/MXKRecentCellData.m

@@ -93,6 +93,11 @@ - (NSString *)avatarUrl
     return roomSummary.avatar;
 }
 
+- (NSString *)directUserId
+{
+    return self.roomSummary.directUserId;
+}
+
 - (MXPresence)presence
 {
     if (self.roomSummary.isDirect)

Riot/Modules/MatrixKit/Models/RoomList/MXKRecentCellDataStoring.h

@@ -44,6 +44,7 @@
 @property (nonatomic, readonly) NSString *roomIdentifier;
 @property (nonatomic, readonly) NSString *roomDisplayname;
 @property (nonatomic, readonly) NSString *avatarUrl;
+@property (nonatomic, readonly) NSString *directUserId;
 @property (nonatomic, readonly) MXPresence presence;
 @property (nonatomic, readonly) NSString *lastEventTextMessage;
 @property (nonatomic, readonly) NSString *lastEventDate;

Riot/Modules/Room/RoomInfo/RoomInfoList/RoomInfoListViewModel.swift

@@ -45,6 +45,7 @@ final class RoomInfoListViewModel: NSObject, RoomInfoListViewModelType {
                                                       encryptionImage: encryptionImage,
                                                       isEncrypted: room.summary.isEncrypted,
                                                       isDirect: room.isDirect,
+                                                      directUserId: room.directUserId,
                                                       directUserPresence: directUserPresence)
 
         return RoomInfoListViewData(numberOfMembers: Int(room.summary.membersCount.joined),
@@ -58,12 +59,10 @@ final class RoomInfoListViewModel: NSObject, RoomInfoListViewModelType {
         self.room = room
         super.init()
         startObservingSummaryChanges()
-        startObservingPresenceChanges()
     }
 
     deinit {
         stopObservingSummaryChanges()
-        stopObservingPresenceChanges()
     }
 
     // MARK: - Public
@@ -91,27 +90,11 @@ final class RoomInfoListViewModel: NSObject, RoomInfoListViewModelType {
         NotificationCenter.default.removeObserver(self, name: .mxRoomSummaryDidChange, object: nil)
     }
 
-    private func startObservingPresenceChanges() {
-        NotificationCenter.default.addObserver(self, selector: #selector(presenceUpdated(_:)), name: .mxkContactManagerMatrixUserPresenceChange, object: nil)
-    }
-    
-    private func stopObservingPresenceChanges() {
-        NotificationCenter.default.removeObserver(self, name: .mxkContactManagerMatrixUserPresenceChange, object: nil)
-    }
-    
     @objc private func roomSummaryUpdated(_ notification: Notification) {
         //  force update view
         self.update(viewState: .loaded(viewData: viewData))
     }
 
-    @objc private func presenceUpdated(_ notification: NSNotification) {
-        guard let updatedUserId = notification.object as? String, updatedUserId == room.directUserId else {
-            return
-        }
-        
-        self.update(viewState: .loaded(viewData: viewData))
-    }
-    
     private func loadData() {
         self.update(viewState: .loaded(viewData: viewData))
     }

Riot/Modules/Room/RoomInfo/RoomInfoList/Views/RoomInfoBasicView.swift

@@ -30,7 +30,11 @@ class RoomInfoBasicView: UIView {
     @IBOutlet private weak var avatarContainerView: UIView!
     @IBOutlet private weak var avatarImageView: MXKImageView!
     @IBOutlet private weak var badgeImageView: UIImageView!
-    @IBOutlet private weak var presenceIndicatorView: PresenceIndicatorView!
+    @IBOutlet private weak var presenceIndicatorView: PresenceIndicatorView! {
+        didSet {
+            presenceIndicatorView.delegate = self
+        }
+    }
     @IBOutlet private weak var roomNameStackView: UIStackView!
     @IBOutlet private weak var roomNameLabel: UILabel!
     @IBOutlet private weak var roomAddressLabel: UILabel!
@@ -98,20 +102,23 @@ class RoomInfoBasicView: UIView {
             VectorL10n.roomParticipantsSecurityInformationRoomEncryptedForDm :
             VectorL10n.roomParticipantsSecurityInformationRoomEncrypted
         securityContainerView.isHidden = !viewData.isEncrypted
-        presenceIndicatorView.setPresence(viewData.directUserPresence)
-        updateBadgeImageViewPosition(with: viewData.encryptionImage, presence: viewData.directUserPresence)
+        if let directUserId = viewData.directUserId {
+            presenceIndicatorView.configure(userId: directUserId, presence: viewData.directUserPresence)
+        } else {
+            presenceIndicatorView.stopListeningPresenceUpdates()
+        }
+        updateBadgeImageViewPosition(isPresenceDisplayed: viewData.directUserPresence != .unknown)
     }
 
-    private func updateBadgeImageViewPosition(with encryptionImage: UIImage?, presence: MXPresence) {
-        guard encryptionImage != nil else {
+    private func updateBadgeImageViewPosition(isPresenceDisplayed: Bool) {
+        guard badgeImageView.image != nil else {
             badgeImageView.isHidden = true
             return
         }
 
         badgeImageView.isHidden = false
         // Update badge position if it doesn't match expectation.
         // If presence is displayed, badge should be in the name stack.
-        let isPresenceDisplayed = presence != .unknown
         let isBadgeInRoomNameStackView = roomNameStackView.arrangedSubviews.contains(badgeImageView)
         switch (isPresenceDisplayed, isBadgeInRoomNameStackView) {
         case (true, false):
@@ -167,3 +174,9 @@ extension RoomInfoBasicView: Themable {
     }
 
 }
+
+extension RoomInfoBasicView: PresenceIndicatorViewDelegate {
+    func presenceIndicatorViewDidUpdateVisibility(_ presenceIndicatorView: PresenceIndicatorView, isHidden: Bool) {
+        updateBadgeImageViewPosition(isPresenceDisplayed: !isHidden)
+    }
+}

Riot/Modules/Room/RoomInfo/RoomInfoList/Views/RoomInfoBasicViewData.swift

@@ -27,5 +27,6 @@ struct RoomInfoBasicViewData {
     let encryptionImage: UIImage?
     let isEncrypted: Bool
     let isDirect: Bool
+    let directUserId: String?
     let directUserPresence: MXPresence
 }

Riot/Modules/Room/Views/Title/RoomTitleView.h

@@ -21,6 +21,7 @@
 // We add here a protocol to handle tap gesture in title view.
 @class RoomTitleView;
 @class PresenceIndicatorView;
+@protocol PresenceIndicatorViewDelegate;
 @protocol RoomTitleViewTapGestureDelegate <NSObject>
 
 /**
@@ -33,7 +34,7 @@
 
 @end
 
-@interface RoomTitleView : MXKRoomTitleView <UIGestureRecognizerDelegate>
+@interface RoomTitleView : MXKRoomTitleView <UIGestureRecognizerDelegate, PresenceIndicatorViewDelegate>
 
 @property (weak, nonatomic) IBOutlet UIView *titleMask;
 @property (weak, nonatomic) IBOutlet UIImageView *badgeImageView;