move custom payload element from content/payload => customPayload.

tapashmajumder · tapashmajumder · commit aa98bb78350a · 2019-02-14T15:48:11.000-08:00
diff --git a/Tests/swift-sdk-swift-tests/InAppHelperTests.swift b/Tests/swift-sdk-swift-tests/InAppHelperTests.swift
@@ -303,6 +303,193 @@ class InAppHelperTests: XCTestCase {
         let dict = messages[0].trigger.dict as! [String : Any]
         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() {
+        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>"
+                    },
+                    "messageId" : "messageIdxxx",
+                    "campaignId" : "campaignIdxxx",
+                    "trigger" : {
+                        "type" : "myNewKind",
+                        "myPayload" : {"var1" : "val1"}
+                    },
+                    "customPayload" : \(customPayload1)
+                },
+                {
+                    "content" : {
+                        "html" : "<a href=\\"http://somewhere.com\\">Click here</a>"
+                    },
+                    "messageId" : "messageIdxxx",
+                    "campaignId" : "campaignIdxxx",
+                    "trigger" : {
+                        "type" : "myNewKind",
+                        "myPayload" : {"var1" : "val1"}
+                    },
+                    "customPayload" : \(customPayload2)
+                },
+                {
+                    "content" : {
+                        "html" : "<a href=\\"http://somewhere.com\\">Click here</a>"
+                    },
+                    "messageId" : "messageIdxxx",
+                    "campaignId" : "campaignIdxxx",
+                    "trigger" : {
+                        "type" : "myNewKind",
+                        "myPayload" : {"var1" : "val1"}
+                    },
+                    "customPayload" : {}
+                },
+                {
+                    "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, "")
+    }
 
     private func createInAppPayload(withExtraInfo extraInfo: [AnyHashable : Any]) -> [AnyHashable : Any] {
         return [
diff --git a/Tests/swift-sdk-swift-tests/TestUtils.swift b/Tests/swift-sdk-swift-tests/TestUtils.swift
@@ -60,6 +60,10 @@ struct TestUtils {
         return TestHelper.clearTestUserDefaults()
     }
     
+    static func areEqual(dict1: [AnyHashable : Any], dict2: [AnyHashable : Any]) -> Bool {
+        return NSDictionary(dictionary: dict1).isEqual(to: dict2)
+    }
+    
     private static func validateQueryParameters(inUrlComponents urlComponents: URLComponents, queryParams: [(name:String, value:String)]) {
         queryParams.forEach { (name, value) in
             validateQueryParameter(inUrlComponents: urlComponents, withName: name, andValue: value)
diff --git a/swift-sdk/ITBConsts.swift b/swift-sdk/ITBConsts.swift
@@ -156,6 +156,8 @@ 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_PAYLOAD = "payload"
+    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"
 }
 
diff --git a/swift-sdk/Internal/InAppHelper.swift b/swift-sdk/Internal/InAppHelper.swift
@@ -324,9 +324,31 @@ struct InAppHelper {
     
     private static func parseInApps(fromPayload payload: [AnyHashable : Any]) -> [InAppParseResult] {
         return getInAppDicts(fromPayload: payload).map {
-            parseInApp(fromDict: $0)
+            parseInApp(fromDict: preProcess(dict:$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 {
@@ -350,7 +372,7 @@ struct InAppHelper {
             campaignId = ""
         }
 
-        let extraInfo = parseExtraInfo(fromContent: content)
+        let extraInfo = parseCustomPayload(fromPayload: dict)
         
         // this is temporary until we fix backend
         let channelName = extraInfo?["channelName"] as? String ?? ""
@@ -390,8 +412,8 @@ struct InAppHelper {
         return IterableInAppTrigger(dict: element)
     }
     
-    private static func parseExtraInfo(fromContent content: [AnyHashable : Any]) -> [AnyHashable : Any]? {
-        return content[.ITBL_IN_APP_PAYLOAD] as? [AnyHashable : Any]
+    private static func parseCustomPayload(fromPayload payload: [AnyHashable : Any]) -> [AnyHashable : Any]? {
+        return payload[.ITBL_IN_APP_CUSTOM_PAYLOAD] as? [AnyHashable : Any]
     }
     
     private static func toMessage(fromInAppParseResult inAppParseResult: InAppHelper.InAppParseResult, internalApi: IterableAPIInternal) -> IterableInAppMessage? {
diff --git a/swift-sdk/IterableInApp.swift b/swift-sdk/IterableInApp.swift
@@ -144,7 +144,7 @@ public final class IterableInAppMessage : NSObject {
     init(
         messageId: String,
         campaignId: String,
-        channelName: String = "reserved",
+        channelName: String = "",
         contentType: IterableInAppContentType = .html,
         trigger: IterableInAppTrigger = .defaultTrigger,
         expiresAt: Date? = nil,

Original file line number	Diff line number	Diff line change
`@@ -156,6 +156,8 @@ public extension AnyHashable {`
`156`	`156`	`public static let ITBL_IN_APP_HTML = "html"`
`157`	`157`	`public static let ITBL_IN_APP_HREF = "href"`
`158`	`158`	`public static let ITBL_IN_APP_DISPLAY_SETTINGS = "inAppDisplaySettings"`
`159`		`- public static let ITBL_IN_APP_PAYLOAD = "payload"`
	`159`	`+ public static let ITBL_IN_APP_LEGACY_PAYLOAD = "payload"`
	`160`	`+ public static let ITBL_IN_APP_CUSTOM_PAYLOAD = "customPayload"`
	`161`	`+ public static let ITBL_IN_APP_CHANNEL_NAME = "channelName"`
`160`	`162`	`}`
`161`	`163`