Merge pull request #880 from Iterable/feature/MOB-9233-in-app-json-only

sumeruchat · web-flow · commit 16b8864c3796 · 2025-01-09T18:23:06.000+01:00
MOB-9233 Support for In App JSON Only Messages
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+tab_width = 4
diff --git a/swift-sdk/Core/Constants.swift b/swift-sdk/Core/Constants.swift
@@ -253,6 +253,7 @@ enum JsonKey {
         static let packageName = "packageName"
         static let sdkVersion = "SDKVersion"
         static let content = "content"
+        static let jsonOnly = "jsonOnly"
     }
     
     enum Payload {
diff --git a/swift-sdk/Core/Models/IterableInAppMessage.swift b/swift-sdk/Core/Models/IterableInAppMessage.swift
@@ -51,6 +51,9 @@ import Foundation
     
     /// the urgency level of this message (nil will be treated as `unassigned` when displaying this message)
     public var priorityLevel: Double
+	
+    /// Whether this message is a JSON-only message
+    public let jsonOnly: Bool
     
     // MARK: - Private/Internal
     
@@ -64,7 +67,8 @@ import Foundation
          inboxMetadata: IterableInboxMetadata? = nil,
          customPayload: [AnyHashable: Any]? = nil,
          read: Bool = false,
-         priorityLevel: Double = Const.PriorityLevel.unassigned) {
+         priorityLevel: Double = Const.PriorityLevel.unassigned,
+         jsonOnly: Bool = false) {
         self.messageId = messageId
         self.campaignId = campaignId
         self.trigger = trigger
@@ -76,5 +80,6 @@ import Foundation
         self.customPayload = customPayload
         self.read = read
         self.priorityLevel = priorityLevel
+        self.jsonOnly = jsonOnly
     }
 }
diff --git a/swift-sdk/Internal/in-app/InAppManager+Functions.swift b/swift-sdk/Internal/in-app/InAppManager+Functions.swift
@@ -6,7 +6,7 @@ import Foundation
 
 enum MessagesProcessorResult {
     case show(message: IterableInAppMessage, messagesMap: OrderedDictionary<String, IterableInAppMessage>)
-    case noShow(messagesMap: OrderedDictionary<String, IterableInAppMessage>)
+    case noShow(message: IterableInAppMessage?, messagesMap: OrderedDictionary<String, IterableInAppMessage>)
 }
 
 struct MessagesProcessor {
@@ -30,14 +30,18 @@ struct MessagesProcessor {
         case let .skip(message):
             updateMessage(message, didProcessTrigger: true)
             return processMessages()
+        case let .skipAndConsume(message):
+            updateMessage(message, didProcessTrigger: true, consumed: true)
+            return .noShow(message: message, messagesMap: messagesMap)
         case .none, .wait:
-            return .noShow(messagesMap: messagesMap)
+            return .noShow(message: nil, messagesMap: messagesMap)
         }
     }
     
     private enum ProcessNextMessageResult {
         case show(IterableInAppMessage)
         case skip(IterableInAppMessage)
+        case skipAndConsume(IterableInAppMessage)
         case none
         case wait
     }
@@ -59,7 +63,11 @@ struct MessagesProcessor {
         
         ITBDebug("isOkToShowNow")
         
-        if inAppDelegate.onNew(message: message) == .show {
+        let returnValue = inAppDelegate.onNew(message: message)
+        if message.isJsonOnly {
+            return .skipAndConsume(message)
+        }
+        if returnValue == .show {
             ITBDebug("delegate returned show")
             return .show(message)
         } else {
diff --git a/swift-sdk/Internal/in-app/InAppManager.swift b/swift-sdk/Internal/in-app/InAppManager.swift
@@ -286,7 +286,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
     
     private func getMessagesMap(fromMessagesProcessorResult messagesProcessorResult: MessagesProcessorResult) -> OrderedDictionary<String, IterableInAppMessage> {
         switch messagesProcessorResult {
-        case let .noShow(messagesMap: messagesMap):
+        case let .noShow(message: _, messagesMap: messagesMap):
             return messagesMap
         case .show(message: _, messagesMap: let messagesMap):
             return messagesMap
@@ -308,6 +308,13 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
         let messagesProcessorResult = processor.processMessages()
         self.messagesMap = getMessagesMap(fromMessagesProcessorResult: messagesProcessorResult)
         
+        if case let .noShow(message, _) = messagesProcessorResult,
+            let message = message, message.isJsonOnly {
+            requestHandler?.inAppConsume(message.messageId,
+                                       onSuccess: nil,
+                                       onFailure: nil)
+        }
+        
         showMessage(fromMessagesProcessorResult: messagesProcessorResult)
     }
     
@@ -316,6 +323,10 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
                               callback: ITBURLCallback? = nil) {
         ITBInfo()
         
+        guard !message.isJsonOnly else {
+            return
+        }
+        
         guard Thread.isMainThread else {
             ITBError("This must be called from the main thread")
             return
diff --git a/swift-sdk/Internal/in-app/InAppMessageParser.swift b/swift-sdk/Internal/in-app/InAppMessageParser.swift
@@ -81,41 +81,79 @@ struct InAppMessageParser {
             return .failure(.parseFailed(reason: "no messageId", messageId: nil))
         }
         
-        guard let contentDict = json[JsonKey.InApp.content] as? [AnyHashable: Any] else {
-            return .failure(.parseFailed(reason: "no content in json payload", messageId: messageId))
-        }
-        
-        let content: IterableInAppContent
+        // Check if the jsonOnly key is present and is set to 1 (true)
+        let jsonOnly = (json[JsonKey.InApp.jsonOnly] as? Int ?? 0) == 1
+        var customPayload = parseCustomPayload(fromPayload: json)
         
-        switch InAppContentParser.parse(contentDict: contentDict) {
-        case let .success(parsedContent):
-            content = parsedContent
-        case let .failure(reason):
-            return .failure(.parseFailed(reason: reason, messageId: messageId))
+        if jsonOnly && customPayload == nil {
+            customPayload = [:]
         }
         
+        // For non-JSON-only messages, we require content
+        if !jsonOnly {
+            guard let contentDict = json[JsonKey.InApp.content] as? [AnyHashable: Any] else {
+                return .failure(.parseFailed(reason: "no content in json payload", messageId: messageId))
+            }
+            
+            let content: IterableInAppContent
+            switch InAppContentParser.parse(contentDict: contentDict) {
+            case let .success(parsedContent):
+                content = parsedContent
+            case let .failure(reason):
+                return .failure(.parseFailed(reason: reason, messageId: messageId))
+            }
+            
+            return .success(createMessage(
+                messageId: messageId,
+                json: json,
+                content: content,
+                customPayload: customPayload,
+                jsonOnly: jsonOnly
+            ))
+        } else {
+            // For JSON-only messages, use default HTML content
+            let content = IterableHtmlInAppContent(edgeInsets: .zero, html: "")
+            
+            return .success(createMessage(
+                messageId: messageId,
+                json: json,
+                content: content,
+                customPayload: customPayload,
+                jsonOnly: jsonOnly
+            ))
+        }
+    }
+    
+    private static func createMessage(
+        messageId: String,
+        json: [AnyHashable: Any],
+        content: IterableInAppContent,
+        customPayload: [AnyHashable: Any]?,
+        jsonOnly: Bool
+    ) -> IterableInAppMessage {
         let campaignId = json[JsonKey.campaignId] as? NSNumber
-        
-        let saveToInbox = json[JsonKey.saveToInbox] as? Bool ?? false
+        let saveToInbox = (json[JsonKey.saveToInbox] as? Bool ?? false) && !jsonOnly // Force false for JSON-only
         let inboxMetadata = parseInboxMetadata(fromPayload: json)
         let trigger = parseTrigger(fromTriggerElement: json[JsonKey.InApp.trigger] as? [AnyHashable: Any])
-        let customPayload = parseCustomPayload(fromPayload: json)
         let createdAt = parseTime(withKey: JsonKey.inboxCreatedAt, fromJson: json)
         let expiresAt = parseTime(withKey: JsonKey.inboxExpiresAt, fromJson: json)
         let read = json[JsonKey.read] as? Bool ?? false
         let priorityLevel = json[JsonKey.priorityLevel] as? Double ?? Const.PriorityLevel.unassigned
         
-        return .success(IterableInAppMessage(messageId: messageId,
-                                             campaignId: campaignId,
-                                             trigger: trigger,
-                                             createdAt: createdAt,
-                                             expiresAt: expiresAt,
-                                             content: content,
-                                             saveToInbox: saveToInbox,
-                                             inboxMetadata: inboxMetadata,
-                                             customPayload: customPayload,
-                                             read: read,
-                                             priorityLevel: priorityLevel))
+        return IterableInAppMessage(
+            messageId: messageId,
+            campaignId: campaignId,
+            trigger: trigger,
+            createdAt: createdAt,
+            expiresAt: expiresAt,
+            content: content,
+            saveToInbox: saveToInbox,
+            inboxMetadata: inboxMetadata,
+            customPayload: customPayload,
+            read: read,
+            priorityLevel: priorityLevel,
+            jsonOnly: jsonOnly
+        )
     }
     
     private static func parseTime(withKey key: AnyHashable, fromJson json: [AnyHashable: Any]) -> Date? {
diff --git a/swift-sdk/Internal/in-app/InAppPersistence.swift b/swift-sdk/Internal/in-app/InAppPersistence.swift
@@ -235,6 +235,7 @@ extension IterableInAppMessage: Codable {
         case trigger
         case content
         case priorityLevel
+        case jsonOnly
     }
     
     enum ContentCodingKeys: String, CodingKey {
@@ -252,20 +253,26 @@ extension IterableInAppMessage: Codable {
             return
         }
         
+        let jsonOnly = (try? container.decode(Int.self, forKey: .jsonOnly)) ?? 0
+        let customPayloadData = try? container.decode(Data.self, forKey: .customPayload)
+        var customPayload = IterableInAppMessage.deserializeCustomPayload(withData: customPayloadData)
+        
+        if jsonOnly == 1 && customPayload == nil {
+            customPayload = [:]
+        }
+        
         let saveToInbox = (try? container.decode(Bool.self, forKey: .saveToInbox)) ?? false
         let inboxMetadata = (try? container.decode(IterableInboxMetadata.self, forKey: .inboxMetadata))
         let messageId = (try? container.decode(String.self, forKey: .messageId)) ?? ""
         let campaignId = (try? container.decode(Int.self, forKey: .campaignId)).map { NSNumber(value: $0) }
         let createdAt = (try? container.decode(Date.self, forKey: .createdAt))
         let expiresAt = (try? container.decode(Date.self, forKey: .expiresAt))
-        let customPayloadData = try? container.decode(Data.self, forKey: .customPayload)
-        let customPayload = IterableInAppMessage.deserializeCustomPayload(withData: customPayloadData)
         let didProcessTrigger = (try? container.decode(Bool.self, forKey: .didProcessTrigger)) ?? false
         let consumed = (try? container.decode(Bool.self, forKey: .consumed)) ?? false
         let read = (try? container.decode(Bool.self, forKey: .read)) ?? false
         
         let trigger = (try? container.decode(IterableInAppTrigger.self, forKey: .trigger)) ?? .undefinedTrigger
-        let content = IterableInAppMessage.decodeContent(from: container)
+        let content = IterableInAppMessage.decodeContent(from: container, isJsonOnly: jsonOnly == 1)
         let priorityLevel = (try? container.decode(Double.self, forKey: .priorityLevel)) ?? Const.PriorityLevel.unassigned
         
         self.init(messageId: messageId,
@@ -274,21 +281,29 @@ extension IterableInAppMessage: Codable {
                   createdAt: createdAt,
                   expiresAt: expiresAt,
                   content: content,
-                  saveToInbox: saveToInbox,
+                  saveToInbox: saveToInbox && jsonOnly != 1,
                   inboxMetadata: inboxMetadata,
                   customPayload: customPayload,
                   read: read,
-                  priorityLevel: priorityLevel)
+                  priorityLevel: priorityLevel,
+                  jsonOnly: jsonOnly == 1)
         
         self.didProcessTrigger = didProcessTrigger
         self.consumed = consumed
     }
     
+    var isJsonOnly: Bool {
+        return jsonOnly
+    }
+    
     public func encode(to encoder: Encoder) {
         var container = encoder.container(keyedBy: CodingKeys.self)
         
+        // Encode jsonOnly first
+        try? container.encode(isJsonOnly ? 1 : 0, forKey: .jsonOnly)
+        
         try? container.encode(trigger, forKey: .trigger)
-        try? container.encode(saveToInbox, forKey: .saveToInbox)
+        try? container.encode(saveToInbox && !isJsonOnly, forKey: .saveToInbox)
         try? container.encode(messageId, forKey: .messageId)
         try? container.encode(campaignId as? Int, forKey: .campaignId)
         try? container.encode(createdAt, forKey: .createdAt)
@@ -303,7 +318,10 @@ extension IterableInAppMessage: Codable {
             try? container.encode(inboxMetadata, forKey: .inboxMetadata)
         }
         
-        IterableInAppMessage.encode(content: content, inContainer: &container)
+        // Only encode content if not JSON-only
+        if !isJsonOnly {
+            IterableInAppMessage.encode(content: content, inContainer: &container)
+        }
     }
     
     private static func createDefaultContent() -> IterableInAppContent {
@@ -328,7 +346,11 @@ extension IterableInAppMessage: Codable {
         return deserialized as? [AnyHashable: Any]
     }
     
-    private static func decodeContent(from container: KeyedDecodingContainer<IterableInAppMessage.CodingKeys>) -> IterableInAppContent {
+    private static func decodeContent(from container: KeyedDecodingContainer<IterableInAppMessage.CodingKeys>, isJsonOnly: Bool) -> IterableInAppContent {
+        if isJsonOnly {
+            return createDefaultContent()
+        }
+
         guard let contentContainer = try? container.nestedContainer(keyedBy: ContentCodingKeys.self, forKey: .content) else {
             ITBError()
             
@@ -357,6 +379,7 @@ extension IterableInAppMessage: Codable {
             }
         }
     }
+    
 }
 
 protocol InAppPersistenceProtocol {
diff --git a/tests/endpoint-tests/scripts/run_test.sh b/tests/endpoint-tests/scripts/run_test.sh
@@ -23,5 +23,5 @@ sed -e "s/\(apiKey = \).*$/\1\"$api_key\"/" \
 xcodebuild -project swift-sdk.xcodeproj \
            -scheme endpoint-tests \
            -sdk iphonesimulator \
-           -destination 'platform=iOS Simulator,name=iPhone 16 Pro' \
+           -destination 'platform=iOS Simulator,OS=18.1,name=iPhone 16 Pro' \
            test | xcpretty
diff --git a/tests/unit-tests/InAppPersistenceTests.swift b/tests/unit-tests/InAppPersistenceTests.swift
diff --git a/tests/unit-tests/InAppTests.swift b/tests/unit-tests/InAppTests.swift

Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,7 @@ enum JsonKey {`
`253`	`253`	`static let packageName = "packageName"`
`254`	`254`	`static let sdkVersion = "SDKVersion"`
`255`	`255`	`static let content = "content"`
	`256`	`+ static let jsonOnly = "jsonOnly"`
`256`	`257`	`}`
`257`	`258`
`258`	`259`	`enum Payload {`