Use only latest profiles in the room timeline (labs)

Config/BuildSettings.swift

@@ -311,6 +311,7 @@ final class BuildSettings: NSObject {
     static var isRoomScreenEnableMessageBubblesByDefault: Bool {
         return self.roomScreenTimelineDefaultStyleIdentifier == .bubble
     }
+    static let roomScreenUseOnlyLatestProfiles: Bool = false
 
     /// Allow split view detail view stacking    
     static let allowSplitViewDetailsScreenStacking: Bool = true

Riot/Assets/en.lproj/Vector.strings

@@ -619,6 +619,7 @@ Tap the + to start adding people.";
 "settings_labs_enable_ringing_for_group_calls" = "Ring for group calls";
 "settings_labs_enabled_polls" = "Polls";
 "settings_labs_enable_threads" = "Threaded messaging";
+"settings_labs_use_only_latest_profiles" = "Use only latest profiles";
 
 "settings_version" = "Version %@";
 "settings_olm_version" = "Olm Version %@";

Riot/Generated/Strings.swift

@@ -4935,6 +4935,10 @@ public class VectorL10n: NSObject {
   public static var settingsLabsMessageReaction: String { 
     return VectorL10n.tr("Vector", "settings_labs_message_reaction") 
   }
+  /// Use only latest profiles
+  public static var settingsLabsUseOnlyLatestProfiles: String { 
+    return VectorL10n.tr("Vector", "settings_labs_use_only_latest_profiles") 
+  }
   /// LINKS
   public static var settingsLinks: String { 
     return VectorL10n.tr("Vector", "settings_links") 

Riot/Managers/Settings/RiotSettings.swift

@@ -200,10 +200,18 @@ final class RiotSettings: NSObject {
 
     @UserDefault(key: "roomScreenEnableMessageBubbles", defaultValue: BuildSettings.isRoomScreenEnableMessageBubblesByDefault, storage: defaults)
     var roomScreenEnableMessageBubbles
-    
+
     var roomTimelineStyleIdentifier: RoomTimelineStyleIdentifier {
         return self.roomScreenEnableMessageBubbles ? .bubble : .plain
     }
+
+    /// A setting used to display the latest known profile (display name + avatar) in the timeline
+    /// for the sender, rather than the profile at the time of the event.
+    ///
+    /// Note: this is set up from Room perspective, which means that if a user updates their profile after
+    /// leaving a Room, it will show up the latest profile used in the Room rather than the latest overall.
+    @UserDefault(key: "roomScreenUseOnlyLatestProfiles", defaultValue: BuildSettings.roomScreenUseOnlyLatestProfiles, storage: defaults)
+    var roomScreenUseOnlyLatestProfiles
 
     // MARK: - Room Contextual Menu
 

Riot/Modules/MatrixKit/Models/Room/MXKRoomBubbleCellData.m

@@ -26,6 +26,8 @@
 
 #import "MXKTools.h"
 
+#import "GeneratedInterface-Swift.h"
+
 @implementation MXKRoomBubbleCellData
 @synthesize senderId, targetId, roomId, senderDisplayName, senderAvatarUrl, senderAvatarPlaceholder, targetDisplayName, targetAvatarUrl, targetAvatarPlaceholder, isEncryptedRoom, isPaginationFirstBubble, shouldHideSenderInformation, date, isIncoming, isAttachmentWithThumbnail, isAttachmentWithIcon, attachment, senderFlair;
 @synthesize textMessage, attributedTextMessage, attributedTextMessageWithoutPositioningSpace;
@@ -35,12 +37,12 @@ @implementation MXKRoomBubbleCellData
 
 #pragma mark - MXKRoomBubbleCellDataStoring
 
-- (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomState andRoomDataSource:(MXKRoomDataSource *)roomDataSource2
+- (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomState andRoomDataSource:(MXKRoomDataSource *)roomDataSource
 {
     self = [self init];
     if (self)
     {
-        roomDataSource = roomDataSource2;
+        self->roomDataSource = roomDataSource;
 
         // Initialize read receipts
         self.readReceipts = [NSMutableDictionary dictionary];
@@ -55,12 +57,14 @@ - (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomS
             senderId = event.sender;
             targetId = [event.type isEqualToString:kMXEventTypeStringRoomMember] ? event.stateKey : nil;
             roomId = roomDataSource.roomId;
-            senderDisplayName = [roomDataSource.eventFormatter senderDisplayNameForEvent:event withRoomState:roomState];
-            senderAvatarUrl = [roomDataSource.eventFormatter senderAvatarUrlForEvent:event withRoomState:roomState];
+
+            MXRoomState *profileRoomState = RiotSettings.shared.roomScreenUseOnlyLatestProfiles ? roomDataSource.roomState : roomState;
+            [self setRoomState:profileRoomState];
             senderAvatarPlaceholder = nil;
-            targetDisplayName = [roomDataSource.eventFormatter targetDisplayNameForEvent:event withRoomState:roomState];
-            targetAvatarUrl = [roomDataSource.eventFormatter targetAvatarUrlForEvent:event withRoomState:roomState];
             targetAvatarPlaceholder = nil;
+
+            // Encryption status should always rely on the `MXRoomState`
+            // from the event rather than the latest.
             isEncryptedRoom = roomState.isEncrypted;
             isIncoming = ([event.sender isEqualToString:roomDataSource.mxSession.myUser.userId] == NO);
 
@@ -103,6 +107,25 @@ - (void)dealloc
     bubbleComponents = nil;
 }
 
+- (void)setRoomState:(MXRoomState *)roomState;
+{
+    MXEvent* firstEvent = self.events.firstObject;
+
+    if (firstEvent == nil || roomState == nil)
+    {
+        return;
+    }
+
+    senderDisplayName = [roomDataSource.eventFormatter senderDisplayNameForEvent:firstEvent
+                                                                   withRoomState:roomState];
+    senderAvatarUrl = [roomDataSource.eventFormatter senderAvatarUrlForEvent:firstEvent
+                                                               withRoomState:roomState];
+    targetDisplayName = [roomDataSource.eventFormatter targetDisplayNameForEvent:firstEvent
+                                                                   withRoomState:roomState];
+    targetAvatarUrl = [roomDataSource.eventFormatter targetAvatarUrlForEvent:firstEvent
+                                                               withRoomState:roomState];
+}
+
 - (NSUInteger)updateEvent:(NSString *)eventId withEvent:(MXEvent *)event
 {
     NSUInteger count = 0;

Riot/Modules/MatrixKit/Models/Room/MXKRoomBubbleCellDataStoring.h

@@ -231,6 +231,15 @@
  */
 - (instancetype)initWithEvent:(MXEvent*)event andRoomState:(MXRoomState*)roomState andRoomDataSource:(MXKRoomDataSource*)roomDataSource;
 
+/**
+ Sets the `MXRoomState` for a buble cell. This allows to adapt the display
+ of a cell with a different room state than its historical. This won't update critical
+ flag/status, such as `isEncryptedRoom`.
+
+ @param roomState the `MXRoomState` to use for this cell.
+ */
+- (void)setRoomState:(MXRoomState *)roomState;
+
 /**
 Update the event because its sent state changed or it is has been redacted.
 

Riot/Modules/MatrixKit/Models/Room/MXKRoomBubbleCellDataWithAppendingMode.m

@@ -16,15 +16,17 @@
 
 #import "MXKRoomBubbleCellDataWithAppendingMode.h"
 
+#import "GeneratedInterface-Swift.h"
+
 static NSAttributedString *messageSeparator = nil;
 
 @implementation MXKRoomBubbleCellDataWithAppendingMode
 
 #pragma mark - MXKRoomBubbleCellDataStoring
 
-- (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomState andRoomDataSource:(MXKRoomDataSource *)roomDataSource2
+- (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomState andRoomDataSource:(MXKRoomDataSource *)roomDataSource
 {
-    self = [super initWithEvent:event andRoomState:roomState andRoomDataSource:roomDataSource2];
+    self = [super initWithEvent:event andRoomState:roomState andRoomDataSource:roomDataSource];
     if (self)
     {
         // Set default settings
@@ -46,8 +48,9 @@ - (BOOL)addEvent:(MXEvent*)event andRoomState:(MXRoomState*)roomState
         }
 
         // Check sender information
-        NSString *eventSenderName = [roomDataSource.eventFormatter senderDisplayNameForEvent:event withRoomState:roomState];
-        NSString *eventSenderAvatar = [roomDataSource.eventFormatter senderAvatarUrlForEvent:event withRoomState:roomState];
+        MXRoomState *profileRoomState = RiotSettings.shared.roomScreenUseOnlyLatestProfiles ? roomDataSource.roomState : roomState;
+        NSString *eventSenderName = [roomDataSource.eventFormatter senderDisplayNameForEvent:event withRoomState:profileRoomState];
+        NSString *eventSenderAvatar = [roomDataSource.eventFormatter senderAvatarUrlForEvent:event withRoomState:profileRoomState];
         if ((self.senderDisplayName || eventSenderName) &&
             ([self.senderDisplayName isEqualToString:eventSenderName] == NO))
         {

Riot/Modules/MatrixKit/Models/Room/MXKRoomDataSource.m

@@ -34,6 +34,8 @@
 #import "MXKSendReplyEventStringLocalizer.h"
 #import "MXKSlashCommands.h"
 
+#import "GeneratedInterface-Swift.h"
+
 const BOOL USE_THREAD_TIMELINE = YES;
 
 #pragma mark - Constant definitions
@@ -1009,6 +1011,11 @@ - (void)refreshEventListeners:(NSArray *)liveEventTypesFilterForMessages
         liveEventsListener = [_timeline listenToEventsOfTypes:liveEventTypesFilterForMessages onEvent:^(MXEvent *event, MXTimelineDirection direction, MXRoomState *roomState) {
 
             MXStrongifyAndReturnIfNil(self);
+
+            if (event.eventType == MXEventTypeRoomMember && event.isUserProfileChange)
+            {
+                [self refreshProfilesIfNeeded];
+            }
 
             if (MXTimelineDirectionForwards == direction)
             {
@@ -4321,4 +4328,23 @@ - (void)virtualRoomsDidChange:(NSNotification *)notification
     self.secondaryRoomId = [self.mxSession virtualRoomOf:self.roomId];
 }
 
+#pragma mark - Use Only Latest Profiles
+
+/**
+ Refreshes the avatars and display names if needed. This has no effect
+ if `roomScreenUseOnlyLatestProfiles` is disabled.
+ */
+- (void)refreshProfilesIfNeeded
+{
+    if (RiotSettings.shared.roomScreenUseOnlyLatestProfiles)
+    {
+        @synchronized (bubbles) {
+            for (id<MXKRoomBubbleCellDataStoring> bubble in bubbles)
+            {
+                [bubble setRoomState:self.roomState];
+            }
+        }
+    }
+}
+
 @end

Riot/Modules/Room/CellData/RoomBubbleCellData.m

@@ -60,9 +60,9 @@ - (instancetype)init
     return self;
 }
 
-- (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomState andRoomDataSource:(MXKRoomDataSource *)roomDataSource2
+- (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomState andRoomDataSource:(MXKRoomDataSource *)roomDataSource
 {
-    self = [super initWithEvent:event andRoomState:roomState andRoomDataSource:roomDataSource2];
+    self = [super initWithEvent:event andRoomState:roomState andRoomDataSource:roomDataSource];
 
     if (self)
     {

Riot/Modules/Room/Search/DataSources/RoomSearchDataSource.m

@@ -33,12 +33,12 @@ @interface RoomSearchDataSource ()
 
 @implementation RoomSearchDataSource
 
-- (instancetype)initWithRoomDataSource:(MXKRoomDataSource *)roomDataSource2
+- (instancetype)initWithRoomDataSource:(MXKRoomDataSource *)roomDataSource
 {
-    self = [super initWithMatrixSession:roomDataSource2.mxSession];
+    self = [super initWithMatrixSession:roomDataSource.mxSession];
     if (self)
     {
-        roomDataSource = roomDataSource2;
+        self->roomDataSource = roomDataSource;
 
         // The messages search is limited to the room data.
         self.roomEventFilter.rooms = @[roomDataSource.roomId];

Riot/Modules/Settings/SettingsViewController.m

@@ -159,7 +159,8 @@ typedef NS_ENUM(NSUInteger, LABS_ENABLE)
 {
     LABS_ENABLE_RINGING_FOR_GROUP_CALLS_INDEX = 0,
     LABS_ENABLE_THREADS_INDEX,
-    LABS_ENABLE_MESSAGE_BUBBLES_INDEX
+    LABS_ENABLE_MESSAGE_BUBBLES_INDEX,
+    LABS_USE_ONLY_LATEST_PROFILES_INDEX
 };
 
 typedef NS_ENUM(NSUInteger, SECURITY)
@@ -572,6 +573,7 @@ - (void)updateSections
         [sectionLabs addRowWithTag:LABS_ENABLE_RINGING_FOR_GROUP_CALLS_INDEX];
         [sectionLabs addRowWithTag:LABS_ENABLE_THREADS_INDEX];
         [sectionLabs addRowWithTag:LABS_ENABLE_MESSAGE_BUBBLES_INDEX];
+        [sectionLabs addRowWithTag:LABS_USE_ONLY_LATEST_PROFILES_INDEX];
         sectionLabs.headerTitle = [VectorL10n settingsLabs];
         if (sectionLabs.hasAnyRows)
         {
@@ -2462,6 +2464,18 @@ - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(N
         {
             cell = [self buildMessageBubblesCellForTableView:tableView atIndexPath:indexPath];
         }
+        else if (row == LABS_USE_ONLY_LATEST_PROFILES_INDEX)
+        {
+            MXKTableViewCellWithLabelAndSwitch *labelAndSwitchCell = [self getLabelAndSwitchCell:tableView forIndexPath:indexPath];
+
+            labelAndSwitchCell.mxkLabel.text = VectorL10n.settingsLabsUseOnlyLatestProfiles;
+            labelAndSwitchCell.mxkSwitch.on = RiotSettings.shared.roomScreenUseOnlyLatestProfiles;
+            labelAndSwitchCell.mxkSwitch.onTintColor = ThemeService.shared.theme.tintColor;
+
+            [labelAndSwitchCell.mxkSwitch addTarget:self action:@selector(toggleUseOnlyLatestProfiles:) forControlEvents:UIControlEventTouchUpInside];
+
+            cell = labelAndSwitchCell;
+        }
     }
     else if (section == SECTION_TAG_FLAIR)
     {
@@ -3244,6 +3258,11 @@ - (void)toggleCommunityFlair:(UISwitch *)sender
     }
 }
 
+- (void)toggleUseOnlyLatestProfiles:(UISwitch *)sender
+{
+    RiotSettings.shared.roomScreenUseOnlyLatestProfiles = sender.isOn;
+}
+
 - (void)markAllAsRead:(id)sender
 {
     // Feedback: disable button and run activity indicator

Riot/Utils/EventFormatter.m

@@ -425,10 +425,12 @@ - (NSString*)senderAvatarUrlForEvent:(MXEvent*)event withRoomState:(MXRoomState*
 
     // Check whether this avatar url is updated by the current event (This happens in case of new joined member)
     NSString* membership = event.content[@"membership"];
-    if (membership && [membership isEqualToString:@"join"] && [event.content[@"avatar_url"] length])
+    NSString* eventAvatarUrl = event.content[@"avatar_url"];
+    NSString* prevEventAvatarUrl = event.prevContent[@"avatar_url"];
+    if (membership && [membership isEqualToString:@"join"] && [eventAvatarUrl length] && ![eventAvatarUrl isEqualToString:prevEventAvatarUrl])
     {
         // Use the actual avatar
-        senderAvatarUrl = event.content[@"avatar_url"];
+        senderAvatarUrl = eventAvatarUrl;
     }
 
     // We ignore non mxc avatar url (The identicons are removed here).

changelog.d/5726.change

@@ -0,0 +1 @@
+Labs/Room: Add a setting to use only latest sender profiles