Added support for custom reactions sorting

Author: martinmitrevski

CHANGELOG.md

@@ -3,7 +3,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 # Upcoming
 
-### 🔄 Changed
+### ✅ Added
+- Possibility to customize message reactions top padding (for grid-based reaction containers)
+- Custom sorting of reactions
 
 # [4.26.0](https://github.com/GetStream/stream-chat-swiftui/releases/tag/4.26.0)
 _January 16, 2023_

Sources/StreamChatSwiftUI/ChatChannel/Reactions/ReactionsOverlayContainer.swift

@@ -6,6 +6,7 @@ import StreamChat
 import SwiftUI
 
 struct ReactionsOverlayContainer: View {
+    @Injected(\.utils) private var utils
     @Injected(\.colors) private var colors
     @Injected(\.images) private var images
 
@@ -48,9 +49,7 @@ struct ReactionsOverlayContainer: View {
     private var reactions: [MessageReactionType] {
         images.availableReactions.keys
             .map { $0 }
-            .sorted(by: { lhs, rhs in
-                lhs.rawValue < rhs.rawValue
-            })
+            .sorted(by: utils.sortReactions)
     }
 
     private var reactionsSize: CGFloat {

Sources/StreamChatSwiftUI/ChatChannel/Reactions/ReactionsView.swift

@@ -6,6 +6,7 @@ import StreamChat
 import SwiftUI
 
 struct ReactionsContainer: View {
+    @Injected(\.utils) var utils
     let message: ChatMessage
     var useLargeIcons = false
     var onTapGesture: () -> Void
@@ -43,9 +44,7 @@ struct ReactionsContainer: View {
         message.reactionScores.keys.filter { reactionType in
             (message.reactionScores[reactionType] ?? 0) > 0
         }
-        .sorted(by: { lhs, rhs in
-            lhs.rawValue < rhs.rawValue
-        })
+        .sorted(by: utils.sortReactions)
     }
 
     private var reactionsSize: CGFloat {

Sources/StreamChatSwiftUI/Utils.swift

@@ -25,6 +25,7 @@ public class Utils {
     public var shouldSyncChannelControllerOnAppear: (ChatChannelController) -> Bool
     public var snapshotCreator: SnapshotCreator
     public var messageIdBuilder: MessageIdBuilder
+    public var sortReactions: (MessageReactionType, MessageReactionType) -> Bool
 
     var messageCachingUtils = MessageCachingUtils()
     var messageListDateUtils: MessageListDateUtils
@@ -47,6 +48,7 @@ public class Utils {
         chatUserNamer: ChatUserNamer = DefaultChatUserNamer(),
         snapshotCreator: SnapshotCreator = DefaultSnapshotCreator(),
         messageIdBuilder: MessageIdBuilder = DefaultMessageIdBuilder(),
+        sortReactions: @escaping (MessageReactionType, MessageReactionType) -> Bool = Utils.defaultSortReactions,
         shouldSyncChannelControllerOnAppear: @escaping (ChatChannelController) -> Bool = { _ in true }
     ) {
         self.dateFormatter = dateFormatter
@@ -66,6 +68,11 @@ public class Utils {
         self.snapshotCreator = snapshotCreator
         self.messageIdBuilder = messageIdBuilder
         self.shouldSyncChannelControllerOnAppear = shouldSyncChannelControllerOnAppear
+        self.sortReactions = sortReactions
         messageListDateUtils = MessageListDateUtils(messageListConfig: messageListConfig)
     }
+    
+    public static var defaultSortReactions: (MessageReactionType, MessageReactionType) -> Bool {
+        { $0.rawValue < $1.rawValue }
+    }
 }

StreamChatSwiftUI.xcodeproj/project.pbxproj

@@ -316,6 +316,7 @@
 		84E04797284A444E00BAFA17 /* WebSocketPingControllerMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 847BA08627E0BACB00ED20C7 /* WebSocketPingControllerMock.swift */; };
 		84E04798284A444E00BAFA17 /* InternetConnectionMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84C94D23275794D3007FE2B9 /* InternetConnectionMock.swift */; };
 		84E1D8262976B3F100060491 /* MessageViewMultiRowReactions_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84E1D8252976B3F100060491 /* MessageViewMultiRowReactions_Tests.swift */; };
+		84E1D8282976CCB000060491 /* SortReactions_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84E1D8272976CCAF00060491 /* SortReactions_Tests.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 */; };
@@ -723,6 +724,7 @@
 		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>"; };
 		84E1D8252976B3F100060491 /* MessageViewMultiRowReactions_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageViewMultiRowReactions_Tests.swift; sourceTree = "<group>"; };
+		84E1D8272976CCAF00060491 /* SortReactions_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SortReactions_Tests.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>"; };
@@ -1476,6 +1478,7 @@
 				84C94D5F275A45D2007FE2B9 /* ViewFactory_Tests.swift */,
 				84C94D61275A5BB7007FE2B9 /* ChatChannelNamer_Tests.swift */,
 				91B79FD8284E7E9C005B6E4F /* ChatUserNamer_Tests.swift */,
+				84E1D8272976CCAF00060491 /* SortReactions_Tests.swift */,
 			);
 			path = Utils;
 			sourceTree = "<group>";
@@ -2047,6 +2050,7 @@
 				84C94D442757C704007FE2B9 /* MoreChannelActionsViewModel_Tests.swift in Sources */,
 				84C94D5127591DE2007FE2B9 /* ChatMessageIDs_Tests.swift in Sources */,
 				84F73F8728699FD7006A39C3 /* InstantCommandsView_Tests.swift in Sources */,
+				84E1D8282976CCB000060491 /* SortReactions_Tests.swift in Sources */,
 				847305BD28243D25004AC770 /* WebView_Tests.swift in Sources */,
 				84E04789284A444E00BAFA17 /* AnyEndpoint.swift in Sources */,
 				84E57C5928103822002213C1 /* TestDataModel2.xcdatamodeld in Sources */,

StreamChatSwiftUITests/Tests/Utils/SortReactions_Tests.swift

@@ -0,0 +1,54 @@
+//
+// Copyright © 2023 Stream.io Inc. All rights reserved.
+//
+
+import StreamChat
+@testable import StreamChatSwiftUI
+import XCTest
+
+final class SortReactions_Tests: StreamChatTestCase {
+    
+    @Injected(\.utils) var utils
+    @Injected(\.images) var images
+
+    func test_utils_defaultSorting() {
+        // Given
+        let reactions = images.availableReactions.keys
+            .map { $0 }
+        let expected: [MessageReactionType] = [
+            .init(rawValue: "haha"),
+            .init(rawValue: "like"),
+            .init(rawValue: "love"),
+            .init(rawValue: "sad"),
+            .init(rawValue: "wow")
+        ]
+        
+        // When
+        let sorted = reactions.sorted(by: utils.sortReactions)
+        
+        // Then
+        XCTAssert(sorted == expected)
+    }
+    
+    func test_utils_customSorting() {
+        // Given
+        let reactions = images.availableReactions.keys
+            .map { $0 }
+        let expected: [MessageReactionType] = [
+            .init(rawValue: "wow"),
+            .init(rawValue: "sad"),
+            .init(rawValue: "love"),
+            .init(rawValue: "like"),
+            .init(rawValue: "haha")
+        ]
+        utils.sortReactions = { lhs, rhs in
+            lhs.rawValue > rhs.rawValue
+        }
+        
+        // When
+        let sorted = reactions.sorted(by: utils.sortReactions)
+        
+        // Then
+        XCTAssert(sorted == expected)
+    }
+}