Channel was sometimes marked as read on open (#593)

Author: laevandus

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### 🐞 Fixed
 - Typing users did not update reliably in the message list [#591](https://github.com/GetStream/stream-chat-swiftui/pull/591)
+- Channel was sometimes marked as read when the first unread message was one of the first not visible messages [#593](https://github.com/GetStream/stream-chat-swiftui/pull/593)
 
 # [4.62.0](https://github.com/GetStream/stream-chat-swiftui/releases/tag/4.62.0)
 _August 16, 2024_

Sources/StreamChatSwiftUI/ChatChannel/MessageList/MessageListView.swift

@@ -202,6 +202,7 @@ public struct MessageListView<Factory: ViewFactory>: View, KeyboardReadable {
                         }
                         .id(listId)
                     }
+                    .delayedRendering()
                     .modifier(factory.makeMessageListModifier())
                     .modifier(ScrollTargetLayoutModifier(enabled: loadingNextMessages))
                 }

Sources/StreamChatSwiftUI/CommonViews/DelayedRenderingViewModifier.swift

@@ -0,0 +1,33 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+
+import Foundation
+import SwiftUI
+
+extension View {
+    /// Delays rendering the content to the next run loop.
+    ///
+    /// - Important: This is used to workaround `FB15010770` where pushing a `LazyVStack` to `NavigationStack` causes the `LazyVStack` to load views using the height of the `UIScreen.main`, not the destination height.
+    func delayedRendering() -> some View {
+        modifier(DelayedRenderingViewModifier())
+    }
+}
+
+struct DelayedRenderingViewModifier: ViewModifier {
+    static var isEnabled = true
+    @State private var canShowContent = Self.isEnabled ? false : true
+    
+    func body(content: Content) -> some View {
+        if canShowContent {
+            content
+        } else {
+            Color.clear
+                .onAppear {
+                    Task { @MainActor in
+                        canShowContent = true
+                    }
+                }
+        }
+    }
+}

StreamChatSwiftUI.xcodeproj/project.pbxproj

@@ -9,6 +9,7 @@
 /* Begin PBXBuildFile section */
 		402C54482B6AAC0100672BFB /* StreamChatSwiftUI.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8465FBB52746873A00AF091E /* StreamChatSwiftUI.framework */; };
 		402C54492B6AAC0100672BFB /* StreamChatSwiftUI.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 8465FBB52746873A00AF091E /* StreamChatSwiftUI.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
+		4F077EF82C85E05700F06D83 /* DelayedRenderingViewModifier.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F077EF72C85E05700F06D83 /* DelayedRenderingViewModifier.swift */; };
 		4F198FDD2C0480EC00148F49 /* Publisher+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F198FDC2C0480EC00148F49 /* Publisher+Extensions.swift */; };
 		4F6D83352C0F05040098C298 /* PollCommentsViewModel_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F6D83342C0F05040098C298 /* PollCommentsViewModel_Tests.swift */; };
 		4F6D83512C1079A00098C298 /* AlertBannerViewModifier.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F6D83502C1079A00098C298 /* AlertBannerViewModifier.swift */; };
@@ -573,6 +574,7 @@
 
 /* Begin PBXFileReference section */
 		4A65451E274BA170003C5FA8 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
+		4F077EF72C85E05700F06D83 /* DelayedRenderingViewModifier.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DelayedRenderingViewModifier.swift; sourceTree = "<group>"; };
 		4F198FDC2C0480EC00148F49 /* Publisher+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Publisher+Extensions.swift"; sourceTree = "<group>"; };
 		4F6D83342C0F05040098C298 /* PollCommentsViewModel_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PollCommentsViewModel_Tests.swift; sourceTree = "<group>"; };
 		4F6D83502C1079A00098C298 /* AlertBannerViewModifier.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlertBannerViewModifier.swift; sourceTree = "<group>"; };
@@ -1656,6 +1658,7 @@
 			children = (
 				8465FCFA2746A95600AF091E /* ActionItemView.swift */,
 				4F6D83502C1079A00098C298 /* AlertBannerViewModifier.swift */,
+				4F077EF72C85E05700F06D83 /* DelayedRenderingViewModifier.swift */,
 				84AB7B1C2771F4AA00631A10 /* DiscardButtonView.swift */,
 				84F2908D276B92A40045472D /* GalleryHeaderView.swift */,
 				8465FD4B2746A95600AF091E /* LoadingView.swift */,
@@ -2527,6 +2530,7 @@
 				82D64BCE2AD7E5B700C5C79E /* ImageViewExtensions.swift in Sources */,
 				8465FD8C2746A95700AF091E /* ImagePickerView.swift in Sources */,
 				82D64BFB2AD7E5B700C5C79E /* ImageProcessors+Composition.swift in Sources */,
+				4F077EF82C85E05700F06D83 /* DelayedRenderingViewModifier.swift in Sources */,
 				82D64BD32AD7E5B700C5C79E /* FrameStore.swift in Sources */,
 				8465FDB22746A95700AF091E /* InputTextView.swift in Sources */,
 				8465FDB32746A95700AF091E /* NSLayoutConstraint+Extensions.swift in Sources */,

StreamChatSwiftUITests/Tests/ChatChannel/ChatChannelViewDateOverlay_Tests.swift

@@ -24,6 +24,12 @@ class ChatChannelViewDateOverlay_Tests: StreamChatTestCase {
             messageListConfig: MessageListConfig(dateIndicatorPlacement: .messageList)
         )
         streamChat = StreamChat(chatClient: chatClient, utils: utils)
+        DelayedRenderingViewModifier.isEnabled = false
+    }
+    
+    override func tearDown() {
+        super.tearDown()
+        DelayedRenderingViewModifier.isEnabled = true
     }
 
     func test_chatChannelView_snapshot() {

StreamChatSwiftUITests/Tests/ChatChannel/ChatChannelView_Tests.swift

@@ -15,6 +15,12 @@ class ChatChannelView_Tests: StreamChatTestCase {
         super.setUp()
         let utils = Utils(dateFormatter: EmptyDateFormatter())
         streamChat = StreamChat(chatClient: chatClient, utils: utils)
+        DelayedRenderingViewModifier.isEnabled = false
+    }
+    
+    override func tearDown() {
+        super.tearDown()
+        DelayedRenderingViewModifier.isEnabled = true
     }
 
     func test_chatChannelView_snapshot() {

StreamChatSwiftUITests/Tests/ChatChannel/MessageListViewAvatars_Tests.swift

@@ -9,7 +9,16 @@ import StreamSwiftTestHelpers
 import XCTest
 
 class MessageListViewAvatars_Tests: StreamChatTestCase {
-
+    override func setUp() {
+        super.setUp()
+        DelayedRenderingViewModifier.isEnabled = false
+    }
+    
+    override func tearDown() {
+        super.tearDown()
+        DelayedRenderingViewModifier.isEnabled = true
+    }
+    
     func test_messageListView_defaultDMChannel() {
         // Given
         setupConfig(showAvatars: true, showAvatarsInGroups: nil)

StreamChatSwiftUITests/Tests/ChatChannel/MessageListViewLastGroupHeader_Tests.swift

@@ -21,6 +21,12 @@ class MessageListViewLastGroupHeader_Tests: StreamChatTestCase {
         let messageListConfig = MessageListConfig(messageDisplayOptions: messageDisplayOptions)
         let utils = Utils(messageListConfig: messageListConfig)
         streamChat = StreamChat(chatClient: chatClient, utils: utils)
+        DelayedRenderingViewModifier.isEnabled = false
+    }
+    
+    override func tearDown() {
+        super.tearDown()
+        DelayedRenderingViewModifier.isEnabled = true
     }
 
     func test_messageListView_headerOnTop() {

StreamChatSwiftUITests/Tests/ChatChannel/MessageListViewNewMessages_Tests.swift

@@ -16,6 +16,12 @@ final class MessageListViewNewMessages_Tests: StreamChatTestCase {
         let messageListConfig = MessageListConfig(showNewMessagesSeparator: true)
         let utils = Utils(dateFormatter: EmptyDateFormatter(), messageListConfig: messageListConfig)
         streamChat = StreamChat(chatClient: chatClient, utils: utils)
+        DelayedRenderingViewModifier.isEnabled = false
+    }
+    
+    override func tearDown() {
+        super.tearDown()
+        DelayedRenderingViewModifier.isEnabled = true
     }
 
     func test_messageListViewNewMessages_singleMessage() {

StreamChatSwiftUITests/Tests/ChatChannel/MessageListView_Tests.swift

@@ -10,7 +10,16 @@ import SwiftUI
 import XCTest
 
 class MessageListView_Tests: StreamChatTestCase {
-
+    override func setUp() {
+        super.setUp()
+        DelayedRenderingViewModifier.isEnabled = false
+    }
+    
+    override func tearDown() {
+        super.tearDown()
+        DelayedRenderingViewModifier.isEnabled = true
+    }
+    
     func test_messageListView_withReactions() {
         // Given
         let channelConfig = ChannelConfig(reactionsEnabled: true)