[Improve]Default participants ordering (#515)

GetStream · Sep 9, 2024 · 6e12656 · 6e12656
1 parent 663bafa
commit 6e12656
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 # Upcoming
 
 ### 🔄 Changed
+- Updated the default sorting for Participants during a call to minimize the movement of already visible tiles [#515](https://github.com/GetStream/stream-video-swift/pull/515)
 
 # [1.10.0](https://github.com/GetStream/stream-video-swift/releases/tag/1.10.0)
 _August 29, 2024_

diff --git a/Sources/StreamVideo/Utils/Sorting.swift b/Sources/StreamVideo/Utils/Sorting.swift
@@ -17,10 +17,13 @@ public typealias StreamSortComparator<Value> = (Value, Value) -> ComparisonResul
 public let defaultComparators: [StreamSortComparator<CallParticipant>] = [
     pinned,
     screensharing,
-    dominantSpeaker,
-    ifInvisible(isSpeaking),
-    ifInvisible(publishingVideo),
-    ifInvisible(publishingAudio),
+    ifInvisible(combineComparators([
+        dominantSpeaker,
+        isSpeaking,
+        isSpeaking,
+        publishingVideo,
+        publishingAudio
+    ])),
     ifInvisible(userId)
 ]
 

diff --git a/StreamVideoTests/Utils/Sorting_Tests.swift b/StreamVideoTests/Utils/Sorting_Tests.swift
@@ -702,6 +702,76 @@ final class Sorting_Tests: XCTestCase {
         )
     }
 
+    func test_defaultComparators_someSpeakingWhileDominantSpeakerIsVisible_orderDoesNotChange() {
+        let combined = combineComparators(defaultComparators)
+
+        assertSort(
+            [
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: false
+                ),
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: false
+                ),
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: false
+                ),
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: true
+                )
+            ],
+            comparator: combined,
+            expectedTransformer: { [$0[0], $0[1], $0[2], $0[3]] }
+        )
+    }
+
+    func test_defaultComparators_someSpeakingWhileDominantSpeakerIsInisible_orderChanges() {
+        let combined = combineComparators(defaultComparators)
+
+        assertSort(
+            [
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: false
+                ),
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: false
+                ),
+                .dummy(
+                    hasAudio: true,
+                    showTrack: true,
+                    isSpeaking: true,
+                    isDominantSpeaker: false
+                ),
+                .dummy(
+                    hasAudio: true,
+                    showTrack: false,
+                    isSpeaking: true,
+                    isDominantSpeaker: true
+                )
+            ],
+            comparator: combined,
+            expectedTransformer: { [$0[3], $0[0], $0[1], $0[2]] }
+        )
+    }
+
     // MARK: - Private Helpers
 
     private func assertSort(