We no longer need to move 'payload' element from inside 'content' element. 'customPayload' element is already there on top level.

Author: tapashmajumder

Tests/swift-sdk-swift-tests/InAppHelperTests.swift

@@ -304,102 +304,8 @@ class InAppHelperTests: XCTestCase {
         TestUtils.validateMatch(keyPath: KeyPath("myPayload.var1"), value: "val1", inDictionary: dict, message: "Expected to find val1")
     }
 
-    // This tests payload as we are getting now
-    func testInAppParsingWithCurrentPayload() {
-        let customPayload1 = """
-        {
-            "contentType" : "html",
-            "inAppType" : "default",
-            "channelName" : "channel1"
-        }
-        """
-        let customPayload2 = """
-        {
-            "contentType" : "html",
-            "inAppType" : "inBox",
-            "channelName" : "channel2",
-            "promoteToContent" : {
-                "title" : "title",
-                "subTitle" : "subtitle",
-                "imageUrl" : "http://somewhere.com/something.jpg"
-            }
-        }
-        """
-        
-        let payload = """
-        {
-            "inAppMessages" : [
-                {
-                    "content" : {
-                        "html" : "<a href=\\"http://somewhere.com\\">Click here</a>",
-                        "payload" : \(customPayload1),
-                    },
-                    "messageId" : "messageIdxxx",
-                    "campaignId" : "campaignIdxxx",
-                    "trigger" : {
-                        "type" : "myNewKind",
-                        "myPayload" : {"var1" : "val1"}
-                    }
-                },
-                {
-                    "content" : {
-                        "html" : "<a href=\\"http://somewhere.com\\">Click here</a>",
-                        "payload" : \(customPayload2),
-                    },
-                    "messageId" : "messageIdxxx",
-                    "campaignId" : "campaignIdxxx",
-                    "trigger" : {
-                        "type" : "myNewKind",
-                        "myPayload" : {"var1" : "val1"}
-                    }
-                },
-                {
-                    "content" : {
-                        "html" : "<a href=\\"http://somewhere.com\\">Click here</a>",
-                        "payload" : {
-                        },
-                    },
-                    "messageId" : "messageIdxxx",
-                    "campaignId" : "campaignIdxxx",
-                    "trigger" : {
-                        "type" : "myNewKind",
-                        "myPayload" : {"var1" : "val1"}
-                    }
-                },
-                {
-                    "content" : {
-                        "html" : "<a href=\\"http://somewhere.com\\">Click here</a>"
-                    },
-                    "messageId" : "messageIdxxx",
-                    "campaignId" : "campaignIdxxx",
-                    "trigger" : {
-                        "type" : "myNewKind",
-                        "myPayload" : {"var1" : "val1"}
-                    }
-                }
-            ]
-        }
-        """.toJsonDict()
-        let messages = InAppHelper.inAppMessages(fromPayload: payload, internalApi: IterableAPI.internalImplementation!)
-        
-        XCTAssertEqual(messages.count, 4)
-        let message1 = messages[0]
-        XCTAssertEqual(message1.channelName, "channel1")
-        XCTAssertTrue(TestUtils.areEqual(dict1: message1.extraInfo!, dict2: customPayload1.toJsonDict()))
-
-        let message2 = messages[1]
-        XCTAssertEqual(message2.channelName, "channel2")
-        XCTAssertTrue(TestUtils.areEqual(dict1: message2.extraInfo!, dict2: customPayload2.toJsonDict()))
-
-        let message3 = messages[2]
-        XCTAssertEqual(message3.channelName, "")
-
-        let message4 = messages[3]
-        XCTAssertEqual(message4.channelName, "")
-    }
-
     // This tests payload as we expect to get when backend is fixed
-    func testInAppParsingWithFuturePayload() {
+    func testInAppPayloadParsing() {
         let customPayload1 = """
         {
             "contentType" : "html",
@@ -497,10 +403,10 @@ class InAppHelperTests: XCTestCase {
                 "content" : [
                     "html" : "<a href='href1'>Click Here</a>",
                     "inAppDisplaySettings" : ["backgroundAlpha" : 0.5, "left" : ["percentage" : 60], "right" : ["percentage" : 60], "bottom" : ["displayOption" : "AutoExpand"], "top" : ["displayOption" : "AutoExpand"]],
-                    "payload" : extraInfo
                 ],
                 "messageId" : "messageIdxxx",
                 "campaignId" : "campaignIdxxx",
+                "customPayload" : extraInfo
             ]]
         ]
     }

Tests/swift-sdk-swift-tests/TestInAppPayloadGenerator.swift

@@ -81,10 +81,10 @@ struct TestInAppPayloadGenerator {
             "content" : [
                 "html" : "<a href='\(href)'>Click Here</a>",
                 "inAppDisplaySettings" : ["backgroundAlpha" : 0.5, "left" : ["percentage" : 60], "right" : ["percentage" : 60], "bottom" : ["displayOption" : "AutoExpand"], "top" : ["displayOption" : "AutoExpand"]],
-                "payload" : ["channelName" : "inBox", "title" : "Product 1 Available", "date" : "2018-11-14T14:00:00:00.32Z"]
             ],
             "messageId" : getMessageId(index: index),
-            "campaignId" : getCampaignId(index: index)
+            "campaignId" : getCampaignId(index: index),
+            "customPayload" : ["channelName" : "inBox", "title" : "Product 1 Available", "date" : "2018-11-14T14:00:00:00.32Z"]
         ]
     }
 

swift-sdk/ITBConsts.swift

@@ -156,7 +156,6 @@ public extension AnyHashable {
     public static let ITBL_IN_APP_HTML = "html"
     public static let ITBL_IN_APP_HREF = "href"
     public static let ITBL_IN_APP_DISPLAY_SETTINGS = "inAppDisplaySettings"
-    public static let ITBL_IN_APP_LEGACY_PAYLOAD = "payload"
     public static let ITBL_IN_APP_CUSTOM_PAYLOAD = "customPayload"
     public static let ITBL_IN_APP_CHANNEL_NAME = "channelName"
 }

swift-sdk/Internal/InAppHelper.swift

@@ -324,32 +324,10 @@ struct InAppHelper {
 
     private static func parseInApps(fromPayload payload: [AnyHashable : Any]) -> [InAppParseResult] {
         return getInAppDicts(fromPayload: payload).map {
-            parseInApp(fromDict: preProcess(dict:$0))
+            parseInApp(fromDict: $0)
         }
     }
 
-    // Change the in-app payload coming from the server to one that we expect it to be like
-    // This is temporary until we fix the backend to do the right thing.
-    // 1. Move 'payload' from inside 'content' to top level 'customPayload'
-    // 2. form this 'customPayload' move elements to top level making sure not to
-    // override 'messageId' etc. Moving elements to top level will help us simulate when we add these
-    // elements later in backend
-    #warning("Remove when we have backend support")
-    private static func preProcess(dict: [AnyHashable : Any]) -> [AnyHashable : Any] {
-        var result = dict
-        guard let contentDict = dict[.ITBL_IN_APP_CONTENT] as? [AnyHashable : Any], let legacyPayloadDict = contentDict[.ITBL_IN_APP_LEGACY_PAYLOAD] as? [AnyHashable : Any] else {
-            return result
-        }
-
-        var newContentDict = contentDict
-        newContentDict[.ITBL_IN_APP_LEGACY_PAYLOAD] = nil
-        result[.ITBL_IN_APP_CONTENT] = newContentDict
-        
-        result[.ITBL_IN_APP_CUSTOM_PAYLOAD] = legacyPayloadDict
-        
-        return result
-    }
-
     private static func parseInApp(fromDict dict: [AnyHashable : Any]) -> InAppParseResult {
         guard let content = dict[.ITBL_IN_APP_CONTENT] as? [AnyHashable : Any] else {
             return .failure(reason: "no message", messageId: nil)