Updated message avatar creation method with additional user data

Author: martinmitrevski

Sources/StreamChatSwiftUI/ChatChannel/MessageList/MessageContainerView.swift

@@ -45,7 +45,7 @@ struct MessageContainerView<Factory: ViewFactory>: View {
                     if messageListConfig.messageDisplayOptions.showAvatars {
                         if showsAllInfo {
                             factory.makeMessageAvatarView(
-                                for: utils.messageCachingUtils.authorImageURL(for: message)
+                                for: utils.messageCachingUtils.authorInfo(from: message)
                             )
                         } else {
                             Color.clear

Sources/StreamChatSwiftUI/ChatChannel/Reactions/ReactionsOverlayView.swift

@@ -6,6 +6,8 @@ import StreamChat
 import SwiftUI
 
 public struct ReactionsOverlayView<Factory: ViewFactory>: View {
+    @Injected(\.utils) private var utils
+    
     @StateObject var viewModel: ReactionsOverlayViewModel
 
     var factory: Factory
@@ -64,11 +66,13 @@ public struct ReactionsOverlayView<Factory: ViewFactory>: View {
                 }
 
             if !messageDisplayInfo.message.isSentByCurrentUser {
-                factory.makeMessageAvatarView(for: messageDisplayInfo.message.author.imageURL)
-                    .offset(
-                        x: paddingValue / 2,
-                        y: originY + messageDisplayInfo.frame.height - paddingValue + 2
-                    )
+                factory.makeMessageAvatarView(
+                    for: utils.messageCachingUtils.authorInfo(from: messageDisplayInfo.message)
+                )
+                .offset(
+                    x: paddingValue / 2,
+                    y: originY + messageDisplayInfo.frame.height - paddingValue + 2
+                )
             }
 
             GeometryReader { reader in

Sources/StreamChatSwiftUI/DefaultViewFactory.swift

@@ -188,8 +188,8 @@ extension ViewFactory {
         }
     }
 
-    public func makeMessageAvatarView(for avatarURL: URL?) -> some View {
-        MessageAvatarView(avatarURL: avatarURL)
+    public func makeMessageAvatarView(for userDisplayInfo: UserDisplayInfo) -> some View {
+        MessageAvatarView(avatarURL: userDisplayInfo.imageURL)
     }
 
     public func makeChannelHeaderViewModifier(

Sources/StreamChatSwiftUI/Utils/MessageCachingUtils.swift

@@ -42,6 +42,15 @@ class MessageCachingUtils {
         return userDisplayInfo.imageURL
     }
 
+    func authorInfo(from message: ChatMessage) -> UserDisplayInfo {
+        if let userDisplayInfo = userDisplayInfo(for: message) {
+            return userDisplayInfo
+        }
+        
+        let userDisplayInfo = saveUserDisplayInfo(for: message)
+        return userDisplayInfo
+    }
+    
     func quotedMessage(for message: ChatMessage) -> ChatMessage? {
         if checkedMessageIds.contains(message.id) {
             return nil
@@ -101,7 +110,8 @@ class MessageCachingUtils {
     }
 }
 
-struct UserDisplayInfo {
+/// Contains display information for the user.
+public struct UserDisplayInfo {
     let id: String
     let name: String
     let imageURL: URL?

Sources/StreamChatSwiftUI/ViewFactory.swift

@@ -170,8 +170,8 @@ public protocol ViewFactory: AnyObject {
 
     associatedtype UserAvatar: View
     /// Creates the message avatar view.
-    /// - Parameter avatarURL: the author's avatar URL..
-    func makeMessageAvatarView(for avatarURL: URL?) -> UserAvatar
+    /// - Parameter userDisplayInfo: the author's display info.
+    func makeMessageAvatarView(for userDisplayInfo: UserDisplayInfo) -> UserAvatar
 
     associatedtype ChatHeaderViewModifier: ChatChannelHeaderViewModifier
     /// Creates the channel header view modifier.

StreamChatSwiftUITests/Tests/Utils/ViewFactory_Tests.swift

@@ -103,9 +103,10 @@ class ViewFactory_Tests: StreamChatTestCase {
     func test_viewFactory_makeMessageAvatarView() {
         // Given
         let viewFactory = DefaultViewFactory.shared
+        let userInfo = UserDisplayInfo(id: .unique, name: .unique, imageURL: URL(string: "https://example.com"))
 
         // When
-        let view = viewFactory.makeMessageAvatarView(for: URL(string: "https://example.com"))
+        let view = viewFactory.makeMessageAvatarView(for: userInfo)
 
         // Then
         XCTAssert(view is MessageAvatarView)

docusaurus/docs/iOS/swiftui/components/custom-avatar.md

@@ -42,11 +42,11 @@ class CustomFactory: ViewFactory {
 
     init() {}
 
-    func makeMessageAvatarView(for avatarURL: URL?) -> some View {
-        CustomUserAvatar(avatarURL: avatarURL)
+    func makeMessageAvatarView(for userDisplayInfo: UserDisplayInfo) -> some View {
+        CustomUserAvatar(avatarURL: userDisplayInfo.avatarURL)
     }
 
 }
 ```
 
-With this, you can have a custom avatar view in the message list view.
+With this, you can have a custom avatar view in the message list view. You can also use the name and the user id from the `UserDisplayInfo`, in case you want to present additional information in the avatar view.