🔧Added placement IDs as list

Author: joaodordio

swift-sdk/Core/Constants.swift

@@ -316,6 +316,7 @@ enum JsonKey {
     enum Embedded {
         static let packageName = "packageName"
         static let sdkVersion = "SDKVersion"
+        static let placementIds = "placementIds"
     }
 
     enum Header {

swift-sdk/Core/Protocols/IterableEmbeddedManagerProtocol.swift

@@ -10,7 +10,13 @@ public protocol IterableEmbeddedManagerProtocol {
     func addUpdateListener(_ listener: IterableEmbeddedUpdateDelegate)
     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()
 }
+
+public extension IterableEmbeddedManagerProtocol {
+    func syncMessages(completion: @escaping () -> Void) {
+        syncMessages(placementIds: nil, completion: completion)
+    }
+}

swift-sdk/Internal/EmptyEmbeddedManager.swift

@@ -23,6 +23,10 @@ class EmptyEmbeddedManager: IterableInternalEmbeddedManagerProtocol {
 
     func syncMessages(completion: @escaping () -> Void) {
 
+    }
+
+    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
@@ -172,7 +172,18 @@ class IterableEmbeddedManager: NSObject, IterableInternalEmbeddedManagerProtocol
                         fetchedMessagesDict[placement.placementId!] = placement.embeddedMessages
                     }
 
-                    let processor = EmbeddedMessagingProcessor(currentMessages: self.messages,
+                    let currentMessagesSnapshot: [Int: [IterableEmbeddedMessage]] = self.messageProcessingQueue.sync {
+                        self.messages
+                    }
+                    
+                    if let placementIds, !placementIds.isEmpty {
+                        let requestedPlacementIds = Set(placementIds)
+                        for (placementId, currentMessages) in currentMessagesSnapshot where !requestedPlacementIds.contains(placementId) {
+                            fetchedMessagesDict[placementId] = currentMessages
+                        }
+                    }
+                    
+                    let processor = EmbeddedMessagingProcessor(currentMessages: currentMessagesSnapshot,
                                                                fetchedMessages: fetchedMessagesDict)
 
                     self.setMessages(processor)
@@ -245,8 +256,12 @@ class IterableEmbeddedManager: NSObject, IterableInternalEmbeddedManagerProtocol
 
 extension IterableEmbeddedManager: EmbeddedNotifiable {
     public func syncMessages(completion: @escaping () -> Void) {
-        if (enableEmbeddedMessaging) {
-            retrieveEmbeddedMessages(completion: completion)
+        syncMessages(placementIds: nil, completion: completion)
+    }
+
+    public func syncMessages(placementIds: [Int]?, completion: @escaping () -> Void) {
+        if enableEmbeddedMessaging {
+            retrieveEmbeddedMessages(placementIds: placementIds, completion: completion)
         }
     }
 }

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

@@ -300,8 +300,8 @@ extension ApiClient: ApiClientProtocol {
 
     // MARK: - Embedded Messaging
 
-    func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError> {
-        let result = createRequestCreator().flatMap { $0.createGetEmbeddedMessagesRequest() }
+    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

@@ -60,7 +60,7 @@ protocol ApiClientProtocol: AnyObject {
 
     func trackConsent(consentTimestamp: Int64, email: String?, userId: String?, isUserKnown: Bool) -> Pending<SendRequestValue, SendRequestError>
 
-    func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError>
+    func getEmbeddedMessages(placementIds: [Int]?) -> Pending<PlacementsPayload, SendRequestError>
 
     @discardableResult func track(embeddedMessageReceived message: IterableEmbeddedMessage) -> Pending<SendRequestValue, SendRequestError>
 
@@ -72,3 +72,9 @@ protocol ApiClientProtocol: AnyObject {
 
     @discardableResult func track(embeddedSession: IterableEmbeddedSession) -> Pending<SendRequestValue, SendRequestError>
 }
+
+extension ApiClientProtocol {
+    func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError> {
+        getEmbeddedMessages(placementIds: nil)
+    }
+}

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

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

tests/unit-tests/BlankApiClient.swift

@@ -114,7 +114,7 @@ class BlankApiClient: ApiClientProtocol {
         Pending()
     }
 
-    func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError> {
+    func getEmbeddedMessages(placementIds: [Int]?) -> Pending<PlacementsPayload, SendRequestError> {
         Pending()
     }
 

tests/unit-tests/EmbeddedManagerTests.swift

@@ -366,16 +366,19 @@ final class EmbeddedManagerTests: XCTestCase {
             invalidApiKey = true
         }
 
-        override func getEmbeddedMessages() -> IterableSDK.Pending<IterableSDK.PlacementsPayload, IterableSDK.SendRequestError> {
+        override func getEmbeddedMessages(placementIds: [Int]?) -> IterableSDK.Pending<IterableSDK.PlacementsPayload, IterableSDK.SendRequestError> {
             if invalidApiKey {
                 return FailPending(error: IterableSDK.SendRequestError(reason: "Invalid API Key"))
             }
 
             if newMessages {
                 var placements: [Placement] = []
+                let requested = Set(placementIds ?? [])
                 for (placementId, messages) in mockMessages {
-                    let placement = Placement(placementId: placementId, embeddedMessages: messages)
-                    placements.append(placement)
+                    if placementIds == nil || requested.contains(placementId) {
+                        let placement = Placement(placementId: placementId, embeddedMessages: messages)
+                        placements.append(placement)
+                    }
                 }
 
                 let payload = PlacementsPayload(placements: placements)