chore: adding tests, refactoring KnockFeedStatus, updates to batchMes…

…sageStatus Updates
knocklabs · May 29, 2024 · 1de224f · 1de224f
1 parent f8a76bf
commit 1de224f
Show file tree

Hide file tree

Showing 9 changed files with 142 additions and 554 deletions.
diff --git a/Sources/Components/Feed/InAppFeedView.swift b/Sources/Components/Feed/InAppFeedView.swift
@@ -122,7 +122,7 @@ extension Knock {
             }
             .onDisappear {
                 Task {
-                    await viewModel.markAllAsSeen()
+                    await viewModel.bulkUpdateMessageEngagementStatus(updatedStatus: .seen)
                 }
             }
         }

diff --git a/Sources/Components/Feed/InAppFeedViewModel.swift b/Sources/Components/Feed/InAppFeedViewModel.swift
diff --git a/Sources/FeedManager.swift b/Sources/FeedManager.swift
@@ -108,11 +108,11 @@ public extension Knock {
             - type: The kind of update
             - options: All the options currently set on the feed to scope as much as possible the bulk update
          */
-        public func makeBulkStatusUpdate(type: KnockMessageStatusBatchUpdateType, options: FeedClientOptions) async throws -> BulkOperation {
+        public func makeBulkStatusUpdate(type: KnockMessageStatusUpdateType, options: FeedClientOptions) async throws -> BulkOperation {
             try await feedModule.makeBulkStatusUpdate(type: type, options: options)
         }
 
-        public func makeBulkStatusUpdate(type: KnockMessageStatusBatchUpdateType, options: FeedClientOptions, completionHandler: @escaping ((Result<BulkOperation, Error>) -> Void)) {
+        public func makeBulkStatusUpdate(type: KnockMessageStatusUpdateType, options: FeedClientOptions, completionHandler: @escaping ((Result<BulkOperation, Error>) -> Void)) {
             Task {
                 do {
                     let operation = try await makeBulkStatusUpdate(type: type, options: options)

diff --git a/Sources/Models/Messages/KnockMessageStatus.swift b/Sources/Models/Messages/KnockMessageStatus.swift
@@ -28,22 +28,13 @@ public extension Knock {
         case archived
     }
 
-    enum KnockMessageStatusUpdateType: String {
+    enum KnockMessageStatusUpdateType: String, Codable {
         case seen
         case read
         case interacted
         case archived
         case unread
         case unseen
-    }
-
-    enum KnockMessageStatusBatchUpdateType: String, Codable {
-        case seen
-        case read
-        case interacted
-        case archived
-        case unseen
-        case unread
         case unarchived
     }
 }
diff --git a/Sources/Modules/FeedModule.swift b/Sources/Modules/FeedModule.swift
@@ -66,7 +66,7 @@ internal class FeedModule {
         }
     }
 
-    func makeBulkStatusUpdate(type: Knock.KnockMessageStatusBatchUpdateType, options: Knock.FeedClientOptions) async throws -> Knock.BulkOperation {
+    func makeBulkStatusUpdate(type: Knock.KnockMessageStatusUpdateType, options: Knock.FeedClientOptions) async throws -> Knock.BulkOperation {
         // TODO: check https://docs.knock.app/reference#bulk-update-channel-message-status
         // older_than: ISO-8601, check milliseconds
         // newer_than: ISO-8601, check milliseconds

diff --git a/Sources/Modules/MessageModule.swift b/Sources/Modules/MessageModule.swift
@@ -43,7 +43,7 @@ internal class MessageModule {
         }
     }
 
-    internal func batchUpdateStatuses(messageIds: [String], status: Knock.KnockMessageStatusBatchUpdateType) async throws -> [Knock.KnockMessage] {
+    internal func batchUpdateStatuses(messageIds: [String], status: Knock.KnockMessageStatusUpdateType) async throws -> [Knock.KnockMessage] {
         do {
             let messages = try await messageService.batchUpdateStatuses(messageIds: messageIds, status: status)
             Knock.shared.log(type: .debug, category: .message, message: "batchUpdateStatuses", status: .success)
@@ -182,11 +182,11 @@ public extension Knock {
 
      *Note:* Knock scopes this batch rate limit by message_ids and status. This allows for 1 update per second per message per status.
      */
-    func batchUpdateStatuses(messageIds: [String], status: KnockMessageStatusBatchUpdateType) async throws -> [KnockMessage] {
+    func batchUpdateStatuses(messageIds: [String], status: KnockMessageStatusUpdateType) async throws -> [KnockMessage] {
         try await self.messageModule.batchUpdateStatuses(messageIds: messageIds, status: status)
     }
 
-    func batchUpdateStatuses(messageIds: [String], status: KnockMessageStatusBatchUpdateType, completionHandler: @escaping ((Result<[KnockMessage], Error>) -> Void)) {
+    func batchUpdateStatuses(messageIds: [String], status: KnockMessageStatusUpdateType, completionHandler: @escaping ((Result<[KnockMessage], Error>) -> Void)) {
         Task {
             do {
                 let messages = try await batchUpdateStatuses(messageIds: messageIds, status: status)
@@ -207,12 +207,12 @@ public extension Knock {
 
      *Note:* Knock scopes this batch rate limit by message_ids and status. This allows for 1 update per second per message per status.
      */
-    func batchUpdateStatuses(messages: [KnockMessage], status: KnockMessageStatusBatchUpdateType) async throws -> [KnockMessage] {
+    func batchUpdateStatuses(messages: [KnockMessage], status: KnockMessageStatusUpdateType) async throws -> [KnockMessage] {
         let messageIds = messages.map{$0.id}
         return try await self.messageModule.batchUpdateStatuses(messageIds: messageIds, status: status)
     }
 
-    func batchUpdateStatuses(messages: [KnockMessage], status: KnockMessageStatusBatchUpdateType, completionHandler: @escaping ((Result<[KnockMessage], Error>) -> Void)) {
+    func batchUpdateStatuses(messages: [KnockMessage], status: KnockMessageStatusUpdateType, completionHandler: @escaping ((Result<[KnockMessage], Error>) -> Void)) {
         Task {
             do {
                 let messages = try await batchUpdateStatuses(messages: messages, status: status)

diff --git a/Sources/Services/FeedService.swift b/Sources/Services/FeedService.swift
@@ -12,7 +12,7 @@ internal class FeedService: KnockAPIService {
         try await get(path: "/users/\(userId)/feeds/\(feedId)", queryItems: queryItems)
     }
 
-    func makeBulkStatusUpdate(feedId: String, type: Knock.KnockMessageStatusBatchUpdateType, body: AnyEncodable?) async throws -> Knock.BulkOperation {
+    func makeBulkStatusUpdate(feedId: String, type: Knock.KnockMessageStatusUpdateType, body: AnyEncodable?) async throws -> Knock.BulkOperation {
         try await post(path: "/channels/\(feedId)/messages/bulk/\(type.rawValue)", body: body)
     }
 

diff --git a/Sources/Services/MessageService.swift b/Sources/Services/MessageService.swift
@@ -21,7 +21,7 @@ internal class MessageService: KnockAPIService {
         try await delete(path: "/messages/\(messageId)/\(status.rawValue)", body: nil)
     }
 
-    internal func batchUpdateStatuses(messageIds: [String], status: Knock.KnockMessageStatusBatchUpdateType) async throws -> [Knock.KnockMessage] {
+    internal func batchUpdateStatuses(messageIds: [String], status: Knock.KnockMessageStatusUpdateType) async throws -> [Knock.KnockMessage] {
         let body = ["message_ids": messageIds]
         return try await post(path: "/messages/batch/\(status.rawValue)", body: body)
     }

diff --git a/Tests/KnockTests/InAppFeedViewModelTests.swift b/Tests/KnockTests/InAppFeedViewModelTests.swift
@@ -11,18 +11,14 @@ import XCTest
 
 final class InAppFeedViewModelTests: XCTestCase {
     var viewModel: Knock.InAppFeedViewModel!
-    var feedManager: Knock.FeedManager!
 
     override func setUp() {
         super.setUp()
-        feedManager = try! Knock.FeedManager(feedId: "")
-        Knock.shared.feedManager = feedManager
         viewModel = Knock.InAppFeedViewModel()
     }
 
     override func tearDown() {
         viewModel = nil
-        feedManager = nil
         super.tearDown()
     }
 
@@ -94,44 +90,38 @@ final class InAppFeedViewModelTests: XCTestCase {
         XCTAssertTrue(viewModel.feed.entries.isEmpty)
     }
 
-    func testOptimisticBulkMarkItemAsRead() async {
+    func testOptimisticBulkMarkItemsAsRead() async {
         let item = generateTestFeedItem(status: .unread)
         let item2 = generateTestFeedItem(status: .seen)
         let item3 = generateTestFeedItem(status: .unread)
         let item4 = generateTestFeedItem(status: .read)
 
         viewModel.feed.entries = [item, item2, item3, item4]
         viewModel.feed.meta.unreadCount = 3
-        await viewModel.optimisticallyBulkUpdateStatus(status: .read)
+        await viewModel.optimisticallyBulkUpdateStatus(updatedStatus: .read)
         XCTAssertTrue(viewModel.feed.entries.first!.read_at != nil)
         XCTAssertTrue(viewModel.feed.meta.unreadCount == 0)
     }
-}
+
+    func testOptimisticBulkMarkItemAsArchived() async {
+        let item = generateTestFeedItem(status: .unread)
+        let item2 = generateTestFeedItem(status: .seen)
+        let item3 = generateTestFeedItem(status: .unread)
+        let item4 = generateTestFeedItem(status: .read)
 
-//class MockFeedManager: FeedManagerProtocol { // Conform to the actual protocol used by Knock.FeedManager
-//    var connectedToFeed = false
-//    var messages = PassthroughSubject<Void, Never>()
-//    
-//    func connectToFeed() {
-//        connectedToFeed = true
-//    }
-//    
-//    func on(eventName: String, handler: @escaping (Any) -> Void) {
-//        messages.sink(receiveValue: { _ in handler(()) }).store(in: &cancellables)
-//    }
-//    
-//    func getUserFeedContent(options: Knock.FeedClientOptions, completion: @escaping (Result<Knock.Feed, Error>) -> Void) {
-//        // Simulate API response
-//        let feed = Knock.Feed(entries: [Knock.FeedItem(id: "1", title: "Test")], pageInfo: Knock.PageInfo(before: nil, after: nil), meta: Knock.FeedMeta())
-//        completion(.success(feed))
-//    }
-//    
-//    func makeBulkStatusUpdate(type: Knock.KnockMessageStatusBatchUpdateType, options: Knock.FeedClientOptions) async throws {
-//        // Simulate bulk update
-//    }
-//}
-//
-//protocol FeedManagerProtocol {
-//    
-//}
+        viewModel.feed.entries = [item, item2, item3, item4]
+        await viewModel.optimisticallyBulkUpdateStatus(updatedStatus: .archived)
+        XCTAssertTrue(viewModel.feed.meta.unreadCount == 0)
+    }
+
+    func testOptimisticBulkMarkItemAsArchivedWithReadScope() async {
+        let item = generateTestFeedItem(status: .unread)
+        let item2 = generateTestFeedItem(status: .unread)
+        let item3 = generateTestFeedItem(status: .unread)
+        let item4 = generateTestFeedItem(status: .read)
 
+        viewModel.feed.entries = [item, item2, item3, item4]
+        await viewModel.optimisticallyBulkUpdateStatus(updatedStatus: .archived, archivedScope: .unread)
+        XCTAssertTrue(viewModel.feed.entries.count == 1)
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -122,7 +122,7 @@ extension Knock { @@
                 }
                 .onDisappear {
                     Task {
-                        await viewModel.markAllAsSeen()
+                        await viewModel.bulkUpdateMessageEngagementStatus(updatedStatus: .seen)
                     }
                 }
             }
@@ Expand Down @@