[MOB-8113] adds placement ids array to sync messages

swift-sdk/Core/Protocols/IterableEmbeddedManagerProtocol.swift

@@ -11,6 +11,7 @@ public protocol IterableEmbeddedManagerProtocol {
     func removeUpdateListener(_ listener: IterableEmbeddedUpdateDelegate)
 
     func syncMessages(completion: @escaping () -> Void)
+    func syncMessages(placementIds: [Int]?, completion: @escaping () -> Void)
     func handleEmbeddedClick(message: IterableEmbeddedMessage, buttonIdentifier: String?, clickedUrl: String)
     func reset()
 }

swift-sdk/Internal/EmptyEmbeddedManager.swift

@@ -25,6 +25,10 @@
 
     }
 
+    func syncMessages(placementIds: [Int]?, completion: @escaping () -> Void) {
+
+    }
+
     public func handleEmbeddedClick(message: IterableEmbeddedMessage, buttonIdentifier: String?, clickedUrl: String) {
 
     }

swift-sdk/Internal/IterableEmbeddedManager.swift

@@ -161,8 +161,8 @@ class IterableEmbeddedManager: NSObject, IterableInternalEmbeddedManagerProtocol
         syncMessages { }
     }
 
-    private func retrieveEmbeddedMessages(completion: @escaping () -> Void) {
-        apiClient.getEmbeddedMessages()
+    private func retrieveEmbeddedMessages(placementIds: [Int]?, completion: @escaping () -> Void) {
+        apiClient.getEmbeddedMessages(placementIds: placementIds ?? [])
             .onCompletion(
                 receiveValue: { embeddedMessagesPayload in
                     let placements = embeddedMessagesPayload.placements
@@ -245,8 +245,13 @@ class IterableEmbeddedManager: NSObject, IterableInternalEmbeddedManagerProtocol
 
 extension IterableEmbeddedManager: EmbeddedNotifiable {
     public func syncMessages(completion: @escaping () -> Void) {
+        syncMessages(placementIds: nil, completion: completion)
+
+    }
+
+    public func syncMessages(placementIds: [Int]?, completion: @escaping () -> Void) {
         if (enableEmbeddedMessaging) {
-            retrieveEmbeddedMessages(completion: completion)
+            retrieveEmbeddedMessages(placementIds: placementIds, completion: completion)
         }
     }
 }

swift-sdk/Internal/api-client/ApiClient.swift

@@ -220,7 +220,11 @@
     // MARK: - Embedded Messaging
 
     func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError> {
-        let result = createRequestCreator().flatMap { $0.createGetEmbeddedMessagesRequest() }
+        return getEmbeddedMessages(placementIds: [])
+    }
+
+    func getEmbeddedMessages(placementIds: [Int]?) -> Pending<PlacementsPayload, SendRequestError> {
+        let result = createRequestCreator().flatMap { $0.createGetEmbeddedMessagesRequest(placementIds: placementIds ?? []) }
         return send(iterableRequestResult: result)
     }
 

swift-sdk/Internal/api-client/ApiClientProtocol.swift

@@ -47,6 +47,7 @@ protocol ApiClientProtocol: AnyObject {
     func getRemoteConfiguration() -> Pending<RemoteConfiguration, SendRequestError>
 
     func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError>
+    func getEmbeddedMessages(placementIds: [Int]?) -> Pending<PlacementsPayload, SendRequestError>
 
     @discardableResult func track(embeddedMessageReceived message: IterableEmbeddedMessage) -> Pending<SendRequestValue, SendRequestError>
 

swift-sdk/Internal/api-client/Request/RequestCreator.swift

@@ -424,6 +424,10 @@
     // MARK: - Embedded Messaging Request Calls
 
     func createGetEmbeddedMessagesRequest() -> Result<IterableRequest, IterableError> {
+        return createGetEmbeddedMessagesRequest(placementIds: [])
+    }
+
+    func createGetEmbeddedMessagesRequest(placementIds: [Int]) -> Result<IterableRequest, IterableError> {
         if case .none = auth.emailOrUserId {
             ITBError(Self.authMissingMessage)
             return .failure(IterableError.general(description: Self.authMissingMessage))
@@ -437,6 +441,10 @@
             args[JsonKey.Embedded.packageName] = packageName
         }
 
+        if !placementIds.isEmpty {
+            args["placementIds"] = placementIds
+        }
+
         setCurrentUser(inDict: &args)
 
         return .success(.get(createGetRequest(forPath: Const.Path.getEmbeddedMessages, withArgs: args as! [String: String])))

tests/unit-tests/BlankApiClient.swift

@@ -83,6 +83,10 @@ class BlankApiClient: ApiClientProtocol {
         Pending()
     }
 
+    func getEmbeddedMessages(placementIds: [Int]?) -> Pending<PlacementsPayload, SendRequestError> {
+        return Pending()
+    }
+
     func track(embeddedMessageReceived message: IterableEmbeddedMessage) -> Pending<SendRequestValue, SendRequestError> {
         Pending()
     }

tests/unit-tests/EmbeddedManagerTests.swift

@@ -69,7 +69,7 @@ final class EmbeddedManagerTests: XCTestCase {
             XCTAssertEqual(message.metadata.placementId, 2, "Fetched message should have placementId 2")
         }
     }
-
+    
     // syncMessages
     func testSyncMessagesSuccessful() {
         let syncMessagesExpectation = expectation(description: "syncMessages should complete")
@@ -105,6 +105,40 @@ final class EmbeddedManagerTests: XCTestCase {
         wait(for: [syncMessagesExpectation, delegateExpectation], timeout: 2)
     }
 
+    func testSyncMessagesForSpecifiedPlacement() {
+        let mockApiClient = MockApiClient()
+        mockApiClient.populateMessages([
+            1: [IterableEmbeddedMessage(messageId: "1", placementId: 1)],
+            2: [IterableEmbeddedMessage(messageId: "2", placementId: 2),
+                IterableEmbeddedMessage(messageId: "3", placementId: 2)],
+            3: [IterableEmbeddedMessage(messageId: "4", placementId: 3)],
+        ])
+        let manager = IterableEmbeddedManager(apiClient: mockApiClient,
+                                          urlDelegate: nil,
+                                          customActionDelegate: nil,
+                                          urlOpener: MockUrlOpener(),
+                                          allowedProtocols: [],
+                                          enableEmbeddedMessaging: true)
+
+        // Sync only placement 2
+        manager.syncMessages(placementIds: [2]) { }
+
+        // Verify we got updated messages for placement 2
+        let messagesForPlacement2 = manager.getMessages(for: 2)
+        XCTAssertEqual(messagesForPlacement2.count, 2, "Should have 2 messages for placementId 2")
+        for message in messagesForPlacement2 {
+            XCTAssertEqual(message.metadata.placementId, 2, "Fetched message should have placementId 2")
+        }
+
+        // Verify other placements are not synced
+        let messagesForPlacement1 = manager.getMessages(for: 1)
+        XCTAssertEqual(messagesForPlacement1.count, 0, "Should have no messages for placementId 1")
+
+        let messagesForPlacement3 = manager.getMessages(for: 3)
+        XCTAssertEqual(messagesForPlacement3.count, 0, "Should have no messages for placementId 3")
+    }
+
+
     func testManagerReset() {
         let syncMessagesExpectation = expectation(description: "syncMessages should complete")
 
@@ -352,7 +386,8 @@ final class EmbeddedManagerTests: XCTestCase {
         private var newMessages = false
         private var invalidApiKey = false
         private var mockMessages: [Int: [IterableEmbeddedMessage]] = [:]
-
+        private var lastRequestedPlacementIds: [Int]?
+
         func haveNewEmbeddedMessages() {
             newMessages = true
         }
@@ -367,13 +402,24 @@ final class EmbeddedManagerTests: XCTestCase {
         }
 
         override func getEmbeddedMessages() -> IterableSDK.Pending<IterableSDK.PlacementsPayload, IterableSDK.SendRequestError> {
+            return getEmbeddedMessages(placementIds: nil)
+        }
+
+        override func getEmbeddedMessages(placementIds: [Int]?) -> IterableSDK.Pending<IterableSDK.PlacementsPayload, IterableSDK.SendRequestError> {
+            lastRequestedPlacementIds = placementIds
+
             if invalidApiKey {
                 return FailPending(error: IterableSDK.SendRequestError(reason: "Invalid API Key"))
             }
 
             if newMessages {
+                var filteredMessages = mockMessages
+                if let placementIds = placementIds, !placementIds.isEmpty {
+                    filteredMessages = mockMessages.filter { placementIds.contains($0.key) }
+                }
+
                 var placements: [Placement] = []
-                for (placementId, messages) in mockMessages {
+                for (placementId, messages) in filteredMessages {
                     let placement = Placement(placementId: placementId, embeddedMessages: messages)
                     placements.append(placement)
                 }