Added possibility to override the message id creation

Author: martinmitrevski

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### ✅ Added
 - Support for channel own capabilities in the UI
+- Added possibility to override the message id creation with `MessageIdBuilder`
 
 ### 🐞 Fixed
 - Renaming of a channel in ChannelInfo not persisting extra data

Sources/StreamChatSwiftUI/ChatChannel/ChatChannelViewModel.swift

@@ -499,18 +499,14 @@ extension ChatMessage: Identifiable {
     }
 
     var messageId: String {
-        var statesId = "empty"
-        if localState != nil {
-            statesId = uploadingStatesId
-        }
-        return baseId + statesId + reactionScoresId + repliesCountId + "\(updatedAt)" + pinStateId
+        InjectedValues[\.utils].messageIdBuilder.makeMessageId(for: self)
     }
 
-    private var baseId: String {
+    var baseId: String {
         isDeleted ? "\(id)-deleted" : id
     }
 
-    private var pinStateId: String {
+    var pinStateId: String {
         pinDetails != nil ? "pinned" : "notPinned"
     }
 

Sources/StreamChatSwiftUI/ChatChannel/MessageList/MessageIdBuilder.swift

@@ -0,0 +1,26 @@
+//
+// Copyright © 2022 Stream.io Inc. All rights reserved.
+//
+
+import StreamChat
+import SwiftUI
+
+public protocol MessageIdBuilder {
+    
+    /// Creates a message id for the provided message.
+    func makeMessageId(for message: ChatMessage) -> String
+}
+
+public class DefaultMessageIdBuilder: MessageIdBuilder {
+    
+    public init() { /* Public init. */ }
+    
+    public func makeMessageId(for message: ChatMessage) -> String {
+        var statesId = "empty"
+        if message.localState != nil {
+            statesId = message.uploadingStatesId
+        }
+        return message.baseId + statesId + message.reactionScoresId
+            + message.repliesCountId + "\(message.updatedAt)" + message.pinStateId
+    }
+}

Sources/StreamChatSwiftUI/Utils.swift

@@ -24,6 +24,7 @@ public class Utils {
     public var composerConfig: ComposerConfig
     public var shouldSyncChannelControllerOnAppear: (ChatChannelController) -> Bool
     public var snapshotCreator: SnapshotCreator
+    public var messageIdBuilder: MessageIdBuilder
 
     var messageCachingUtils = MessageCachingUtils()
     var messageListDateUtils: MessageListDateUtils
@@ -45,6 +46,7 @@ public class Utils {
         channelNamer: @escaping ChatChannelNamer = DefaultChatChannelNamer(),
         chatUserNamer: ChatUserNamer = DefaultChatUserNamer(),
         snapshotCreator: SnapshotCreator = DefaultSnapshotCreator(),
+        messageIdBuilder: MessageIdBuilder = DefaultMessageIdBuilder(),
         shouldSyncChannelControllerOnAppear: @escaping (ChatChannelController) -> Bool = { _ in true }
     ) {
         self.dateFormatter = dateFormatter
@@ -62,6 +64,7 @@ public class Utils {
         self.messageListConfig = messageListConfig
         self.composerConfig = composerConfig
         self.snapshotCreator = snapshotCreator
+        self.messageIdBuilder = messageIdBuilder
         self.shouldSyncChannelControllerOnAppear = shouldSyncChannelControllerOnAppear
         messageListDateUtils = MessageListDateUtils(messageListConfig: messageListConfig)
     }

StreamChatSwiftUI.xcodeproj/project.pbxproj

@@ -315,6 +315,7 @@
 		84E04796284A444E00BAFA17 /* EventBatcherMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 847BA08227E0B9C600ED20C7 /* EventBatcherMock.swift */; };
 		84E04797284A444E00BAFA17 /* WebSocketPingControllerMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 847BA08627E0BACB00ED20C7 /* WebSocketPingControllerMock.swift */; };
 		84E04798284A444E00BAFA17 /* InternetConnectionMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84C94D23275794D3007FE2B9 /* InternetConnectionMock.swift */; };
+		84E4F7CF294C69F300DD4CE3 /* MessageIdBuilder.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84E4F7CE294C69F200DD4CE3 /* MessageIdBuilder.swift */; };
 		84E57C5928103822002213C1 /* TestDataModel2.xcdatamodeld in Sources */ = {isa = PBXBuildFile; fileRef = 84E57C5328103822002213C1 /* TestDataModel2.xcdatamodeld */; };
 		84E57C5B28103822002213C1 /* TestDataModel.xcdatamodeld in Sources */ = {isa = PBXBuildFile; fileRef = 84E57C5728103822002213C1 /* TestDataModel.xcdatamodeld */; };
 		84E6EC23279AEE6B0017207B /* MessageContainerView_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84E6EC22279AEE6B0017207B /* MessageContainerView_Tests.swift */; };
@@ -720,6 +721,7 @@
 		84DEC8E72760EABC00172876 /* ChatChannelDataSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatChannelDataSource.swift; sourceTree = "<group>"; };
 		84DEC8E92761089A00172876 /* MessageThreadHeaderViewModifier.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageThreadHeaderViewModifier.swift; sourceTree = "<group>"; };
 		84DEC8EB27611CAE00172876 /* SendInChannelView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SendInChannelView.swift; sourceTree = "<group>"; };
+		84E4F7CE294C69F200DD4CE3 /* MessageIdBuilder.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageIdBuilder.swift; sourceTree = "<group>"; };
 		84E57C46281037B2002213C1 /* AssertJSONEqual.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AssertJSONEqual.swift; sourceTree = "<group>"; };
 		84E57C47281037B2002213C1 /* AssertResult.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AssertResult.swift; sourceTree = "<group>"; };
 		84E57C48281037B2002213C1 /* AssertAsync.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AssertAsync.swift; sourceTree = "<group>"; };
@@ -1121,6 +1123,7 @@
 				841B2EF3278DB9E500ED619E /* MessageListHelperViews.swift */,
 				84B55F692798154C00B99B01 /* MessageListConfig.swift */,
 				84BB4C4B2841104700CBE004 /* MessageListDateUtils.swift */,
+				84E4F7CE294C69F200DD4CE3 /* MessageIdBuilder.swift */,
 			);
 			path = MessageList;
 			sourceTree = "<group>";
@@ -2009,6 +2012,7 @@
 				846D6564279FF0800094B36E /* ReactionUserView.swift in Sources */,
 				8465FDB12746A95700AF091E /* ChatChannelNamer.swift in Sources */,
 				8465FD9E2746A95700AF091E /* ChatChannelHelpers.swift in Sources */,
+				84E4F7CF294C69F300DD4CE3 /* MessageIdBuilder.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

StreamChatSwiftUITests/Tests/ChatChannel/ChatMessageIDs_Tests.swift

@@ -114,4 +114,27 @@ class ChatMessageIDs_Tests: XCTestCase {
         // Then
         XCTAssert(messageId.contains(expectedId))
     }
+    
+    func test_chatMessage_messageBuilder() {
+        // Given
+        let id: String = .unique
+        let reaction = "like"
+        let expectedId = id + "empty" + "\(reaction)\(3)"
+        let message = ChatMessage.mock(
+            id: id,
+            cid: .unique,
+            text: "test",
+            author: .mock(id: .unique),
+            reactionScores: [
+                MessageReactionType(rawValue: reaction): 3
+            ]
+        )
+        let defaultMessageBuilder = DefaultMessageIdBuilder()
+        
+        // When
+        let messageId = defaultMessageBuilder.makeMessageId(for: message)
+        
+        // Then
+        XCTAssert(messageId.starts(with: expectedId))
+    }
 }