Expose the reason parameter in the flag endpoint (#3173)

Author: testableapple

CHANGELOG.md

@@ -4,10 +4,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 # Upcoming
 
 ## StreamChat
-### 🔄 Changed
-- Replace message update request to partial update on message pinning [#3166](https://github.com/GetStream/stream-chat-swift/pull/3166)
+### ✅ Added
+- Add `reason` parameter to `flagMessage()` [#3173](https://github.com/GetStream/stream-chat-swift/issues/3173)
 ### 🐞 Fixed
 - Reset managed object contexts before removing all the data on logout [#3170](https://github.com/GetStream/stream-chat-swift/pull/3170)
+### 🔄 Changed
+- Replace message update request to partial update on message pinning [#3166](https://github.com/GetStream/stream-chat-swift/pull/3166)
 
 ## StreamChatUI
 ### ✅ Added

Sources/StreamChat/APIClient/Endpoints/ModerationEndpoints.swift

@@ -71,14 +71,21 @@ extension Endpoint {
 extension Endpoint {
     static func flagMessage(
         _ flag: Bool,
-        with messageId: MessageId
+        with messageId: MessageId,
+        reason: String? = nil
     ) -> Endpoint<FlagMessagePayload> {
-        .init(
+        var body: [String: AnyEncodable] = ["target_message_id": AnyEncodable(messageId)]
+        
+        if let reason = reason {
+            body["reason"] = AnyEncodable(reason)
+        }
+            
+        return .init(
             path: .flagMessage(flag),
             method: .post,
             queryItems: nil,
             requiresConnectionId: false,
-            body: ["target_message_id": messageId]
+            body: body
         )
     }
 }

Sources/StreamChat/Controllers/MessageController/MessageController.swift

@@ -569,10 +569,12 @@ public class ChatMessageController: DataController, DelegateCallable, DataStoreP
 
     /// Flags the message this controller manages.
     ///
-    /// - Parameter completion: The completion. Will be called on a **callbackQueue** when the network request is finished.
+    /// - Parameters:
+    ///   - reason: The flag reason.
+    ///   - completion: The completion. Will be called on a **callbackQueue** when the network request is finished.
     ///
-    public func flag(completion: ((Error?) -> Void)? = nil) {
-        messageUpdater.flagMessage(true, with: messageId, in: cid) { error in
+    public func flag(reason: String? = nil, completion: ((Error?) -> Void)? = nil) {
+        messageUpdater.flagMessage(true, with: messageId, in: cid, reason: reason) { error in
             self.callback {
                 completion?(error)
             }

Sources/StreamChat/Workers/MessageUpdater.swift

@@ -331,18 +331,26 @@ class MessageUpdater: Worker {
     /// If the message doesn't exist locally it will be fetched and saved locally first first.
     ///
     /// - Parameters:
-    ///   - flag: The indicator saying whether the messageId should be flagged or unflagged.
-    ///   - messageId: The identifier of a messageId that should be flagged or unflagged.
+    ///   - flag: The indicator saying whether the message should be flagged or unflagged.
+    ///   - messageId: The identifier of a message that should be flagged or unflagged.
+    ///   - cid: The identifier of the channel the message belongs to.
+    ///   - reason: The flag reason.
     ///   - completion: Called when the API call is finished. Called with `Error` if the remote update fails.
     ///
-    func flagMessage(_ flag: Bool, with messageId: MessageId, in cid: ChannelId, completion: ((Error?) -> Void)? = nil) {
+    func flagMessage(
+        _ flag: Bool,
+        with messageId: MessageId,
+        in cid: ChannelId,
+        reason: String? = nil,
+        completion: ((Error?) -> Void)? = nil
+    ) {
         fetchAndSaveMessageIfNeeded(messageId, cid: cid) { error in
             guard error == nil else {
                 completion?(error)
                 return
             }
 
-            let endpoint: Endpoint<FlagMessagePayload> = .flagMessage(flag, with: messageId)
+            let endpoint: Endpoint<FlagMessagePayload> = .flagMessage(flag, with: messageId, reason: reason)
             self.apiClient.request(endpoint: endpoint) { result in
                 switch result {
                 case let .success(payload):

TestTools/StreamChatTestTools/Mocks/StreamChat/Workers/MessageUpdater_Mock.swift

@@ -53,6 +53,7 @@ final class MessageUpdater_Mock: MessageUpdater {
     @Atomic var flagMessage_flag: Bool?
     @Atomic var flagMessage_messageId: MessageId?
     @Atomic var flagMessage_cid: ChannelId?
+    @Atomic var flagMessage_reason: String?
     @Atomic var flagMessage_completion: ((Error?) -> Void)?
 
     @Atomic var addReaction_type: MessageReactionType?
@@ -141,6 +142,7 @@ final class MessageUpdater_Mock: MessageUpdater {
         flagMessage_flag = nil
         flagMessage_messageId = nil
         flagMessage_cid = nil
+        flagMessage_reason = nil
         flagMessage_completion = nil
 
         addReaction_type = nil
@@ -280,10 +282,17 @@ final class MessageUpdater_Mock: MessageUpdater {
         }
     }
 
-    override func flagMessage(_ flag: Bool, with messageId: MessageId, in cid: ChannelId, completion: ((Error?) -> Void)? = nil) {
+    override func flagMessage(
+        _ flag: Bool,
+        with messageId: MessageId,
+        in cid: ChannelId,
+        reason: String? = nil,
+        completion: ((Error?) -> Void)? = nil
+    ) {
         flagMessage_flag = flag
         flagMessage_messageId = messageId
         flagMessage_cid = cid
+        flagMessage_reason = reason
         flagMessage_completion = completion
     }
 

Tests/StreamChatTests/APIClient/Endpoints/ModerationEndpoints_Tests.swift

@@ -136,17 +136,21 @@ final class ModerationEndpoints_Tests: XCTestCase {
 
         for (flag, path) in testCases {
             let messageId: MessageId = .unique
+            let reason = "Test"
 
             let expectedEndpoint = Endpoint<FlagMessagePayload>(
                 path: path,
                 method: .post,
                 queryItems: nil,
                 requiresConnectionId: false,
-                body: ["target_message_id": messageId]
+                body: [
+                    "target_message_id": messageId,
+                    "reason": reason
+                ]
             )
 
             // Build endpoint.
-            let endpoint: Endpoint<FlagMessagePayload> = .flagMessage(flag, with: messageId)
+            let endpoint: Endpoint<FlagMessagePayload> = .flagMessage(flag, with: messageId, reason: reason)
 
             // Assert endpoint is built correctly.
             XCTAssertEqual(AnyEndpoint(expectedEndpoint), AnyEndpoint(endpoint))

Tests/StreamChatTests/Controllers/MessageController/MessageController_Tests.swift

@@ -1011,14 +1011,17 @@ final class MessageController_Tests: XCTestCase {
 
     func test_flag_callsUpdater_withCorrectValues() {
         // Simulate `flag` call.
-        controller.flag()
+        let reason = "Test"
+        controller.flag(reason: reason)
 
         // Assert updater is called with correct `flag`.
         XCTAssertEqual(env.messageUpdater.flagMessage_flag, true)
         // Assert updater is called with correct `messageId`.
         XCTAssertEqual(env.messageUpdater.flagMessage_messageId, controller.messageId)
         // Assert updater is called with correct `cid`.
         XCTAssertEqual(env.messageUpdater.flagMessage_cid, controller.cid)
+        // Assert updater is called with correct `reason`.
+        XCTAssertEqual(env.messageUpdater.flagMessage_reason, reason)
     }
 
     func test_flag_keepsControllerAlive() {
@@ -1090,6 +1093,8 @@ final class MessageController_Tests: XCTestCase {
         XCTAssertEqual(env.messageUpdater.flagMessage_messageId, controller.messageId)
         // Assert updater is called with correct `cid`.
         XCTAssertEqual(env.messageUpdater.flagMessage_cid, controller.cid)
+        // Assert updater is called with correct `reason`.
+        XCTAssertEqual(env.messageUpdater.flagMessage_reason, nil)
     }
 
     // MARK: - Create new reply

Tests/StreamChatTests/Workers/MessageUpdater_Tests.swift

@@ -1207,6 +1207,7 @@ final class MessageUpdater_Tests: XCTestCase {
         let currentUserId: UserId = .unique
         let messageId: MessageId = .unique
         let cid: ChannelId = .unique
+        let reason = "Test"
 
         // Create current user in the database
         try database.createCurrentUser(id: currentUserId)
@@ -1222,13 +1223,13 @@ final class MessageUpdater_Tests: XCTestCase {
 
         // Simulate `flagMessage` call.
         let expectation = self.expectation(description: "Flag message completion")
-        messageUpdater.flagMessage(true, with: messageId, in: cid) { error in
+        messageUpdater.flagMessage(true, with: messageId, in: cid, reason: reason) { error in
             XCTAssertNil(error)
             expectation.fulfill()
         }
 
         // Assert flag endpoint is called.
-        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId)
+        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId, reason: reason)
         AssertAsync.willBeEqual(apiClient.request_endpoint, AnyEndpoint(flagEndpoint))
 
         // Add it to DB as it is as expected after a successful getMessage call
@@ -1290,13 +1291,14 @@ final class MessageUpdater_Tests: XCTestCase {
     func test_flagMessage_propagatesError() {
         let messageId: MessageId = .unique
         let cid: ChannelId = .unique
+        let reason = "Test"
 
         let networkError = TestError()
         messageRepository.getMessageResult = .failure(networkError)
 
         // Simulate `flagMessage` call and catch the error.
         var completionCalledError: Error?
-        messageUpdater.flagMessage(true, with: messageId, in: cid) {
+        messageUpdater.flagMessage(true, with: messageId, in: cid, reason: reason) {
             completionCalledError = $0
         }
 
@@ -1307,18 +1309,19 @@ final class MessageUpdater_Tests: XCTestCase {
     func test_flagMessage_propagatesFlagNetworkError() throws {
         let messageId: MessageId = .unique
         let cid: ChannelId = .unique
+        let reason = "Test"
 
         // Save message to the database.
         try database.createMessage(id: messageId)
 
         // Simulate `flagMessage` call and catch the error.
         var completionCalledError: Error?
-        messageUpdater.flagMessage(true, with: messageId, in: cid) {
+        messageUpdater.flagMessage(true, with: messageId, in: cid, reason: reason) {
             completionCalledError = $0
         }
 
         // Assert flag endpoint is called.
-        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId)
+        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId, reason: reason)
         AssertAsync.willBeEqual(apiClient.request_endpoint, AnyEndpoint(flagEndpoint))
 
         // Simulate flag API response with failure.
@@ -1333,6 +1336,7 @@ final class MessageUpdater_Tests: XCTestCase {
         let currentUserId: UserId = .unique
         let messageId: MessageId = .unique
         let cid: ChannelId = .unique
+        let reason = "Test"
 
         // Save message to the database.
         try database.createMessage(id: messageId)
@@ -1343,12 +1347,12 @@ final class MessageUpdater_Tests: XCTestCase {
 
         // Simulate `flagMessage` call and catch the error.
         var completionCalledError: Error?
-        messageUpdater.flagMessage(true, with: messageId, in: cid) {
+        messageUpdater.flagMessage(true, with: messageId, in: cid, reason: reason) {
             completionCalledError = $0
         }
 
         // Assert flag endpoint is called.
-        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId)
+        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId, reason: reason)
         AssertAsync.willBeEqual(apiClient.request_endpoint, AnyEndpoint(flagEndpoint))
 
         // Simulate flag API response with success.
@@ -1366,18 +1370,19 @@ final class MessageUpdater_Tests: XCTestCase {
         let currentUserId: UserId = .unique
         let messageId: MessageId = .unique
         let cid: ChannelId = .unique
+        let reason = "Test"
 
         // Save message to the database.
         try database.createMessage(id: messageId)
 
         // Simulate `flagMessage` call and catch the error.
         var completionCalledError: Error?
-        messageUpdater.flagMessage(true, with: messageId, in: cid) {
+        messageUpdater.flagMessage(true, with: messageId, in: cid, reason: reason) {
             completionCalledError = $0
         }
 
         // Assert flag endpoint is called.
-        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId)
+        let flagEndpoint: Endpoint<FlagMessagePayload> = .flagMessage(true, with: messageId, reason: reason)
         AssertAsync.willBeEqual(apiClient.request_endpoint, AnyEndpoint(flagEndpoint))
 
         // Delete the message from the database.