Merge pull request #32 from Iterable/bugfix/mob-33

[MOB-33] - No need to call createUserForUserId anymore

Author: tapashmajumder

Tests/swift-sdk-swift-tests/IterableAutoRegistrationTests.swift

@@ -89,41 +89,7 @@ class IterableAutoRegistrationTests: XCTestCase {
         wait(for: [expectation1], timeout: testExpectationTimeout)
     }
 
-    func testDoNotCallRegisterIfCreateUserFails() {
-        let expectation0 = expectation(description: "Call create user")
-        let expectation1 = expectation(description: "Call registerToken API endpoint")
-        expectation1.isInverted = true
-        
-        let networkSession = MockNetworkSession(statusCode: 501)
-        let config = IterableConfig()
-        config.pushIntegrationName = "my-push-integration"
-        let notificationStateProvider = MockNotificationStateProvider(enabled: true)
-        
-        IterableAPI.initialize(apiKey: IterableAutoRegistrationTests.apiKey,
-                               config: config,
-                               networkSession: networkSession,
-                               notificationStateProvider: notificationStateProvider)
-        IterableAPI.userId = "userId1"
-        let token = "zeeToken".data(using: .utf8)!
-        networkSession.callback = {(_, _, _) in
-            expectation0.fulfill()
-            TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_CREATE_USER, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
-            let body = networkSession.getRequestBody() as! [String : Any]
-            TestUtils.validateElementPresent(withName: AnyHashable.ITBL_KEY_USER_ID, andValue: "userId1", inDictionary: body)
-            networkSession.callback = {(_, _, _) in
-                // first call back will be called on register
-                expectation1.fulfill()
-                TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_REGISTER_DEVICE_TOKEN, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
-            }
-        }
-        IterableAPI.register(token: token)
-        
-        // only wait for small time, supposed to error out
-        wait(for: [expectation0, expectation1], timeout: 1.0)
-    }
-    
     func testDoNotCallRegisterForRemoteNotificationsWhenNotificationsAreDisabled() {
-        let expectation0 = expectation(description: "Call create user")
         let expectation1 = expectation(description: "Call registerToken API endpoint")
         let expectation2 = expectation(description: "Disable API endpoint called")
         let expectation3 = expectation(description: "do not call registerForRemoteNotifications")
@@ -141,31 +107,26 @@ class IterableAutoRegistrationTests: XCTestCase {
         IterableAPI.userId = "userId1"
         let token = "zeeToken".data(using: .utf8)!
         networkSession.callback = {(_, _, _) in
-            expectation0.fulfill()
-            TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_CREATE_USER, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
-            let body = networkSession.getRequestBody() as! [String : Any]
-            TestUtils.validateElementPresent(withName: AnyHashable.ITBL_KEY_USER_ID, andValue: "userId1", inDictionary: body)
+            // first call back will be called on register
+            expectation1.fulfill()
+            TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_REGISTER_DEVICE_TOKEN, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
+            TestUtils.validateMatch(keyPath: KeyPath(AnyHashable.ITBL_KEY_PREFER_USER_ID), value: true, inDictionary: networkSession.getRequestBody() as! [String : Any], message: "Expected to find preferUserId set to true")
             networkSession.callback = {(_, _, _) in
-                // second call back will be called on register
-                expectation1.fulfill()
-                TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_REGISTER_DEVICE_TOKEN, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
-                networkSession.callback = {(_, _, _) in
-                    // third call back is for disable when we set new user id
-                    TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_DISABLE_DEVICE, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
-                    let body = networkSession.getRequestBody() as! [String : Any]
-                    TestUtils.validateElementPresent(withName: AnyHashable.ITBL_KEY_TOKEN, andValue: (token as NSData).iteHexadecimalString(), inDictionary: body)
-                    TestUtils.validateElementPresent(withName: AnyHashable.ITBL_KEY_USER_ID, andValue: "userId1", inDictionary: body)
-                    expectation2.fulfill()
-                }
-                IterableAPI.userId = "userId2"
+                // second call back is for disable when we set new user id
+                TestUtils.validate(request: networkSession.request!, requestType: .post, apiEndPoint: .ITBL_ENDPOINT_API, path: .ITBL_PATH_DISABLE_DEVICE, queryParams: [(name: AnyHashable.ITBL_KEY_API_KEY, value: IterableAutoRegistrationTests.apiKey)])
+                let body = networkSession.getRequestBody() as! [String : Any]
+                TestUtils.validateElementPresent(withName: AnyHashable.ITBL_KEY_TOKEN, andValue: (token as NSData).iteHexadecimalString(), inDictionary: body)
+                TestUtils.validateElementPresent(withName: AnyHashable.ITBL_KEY_USER_ID, andValue: "userId1", inDictionary: body)
+                expectation2.fulfill()
             }
+            IterableAPI.userId = "userId2"
         }
         IterableAPI.register(token: token)
 
         // only wait for small time, supposed to error out
-        wait(for: [expectation0, expectation1, expectation2, expectation3], timeout: 1.0)
+        wait(for: [expectation1, expectation2, expectation3], timeout: 1.0)
     }
-    
+
     func testDoNotCallDisableOrEnableWhenAutoPushIsOff() {
         let expectation1 = expectation(description: "do not call register for remote")
         expectation1.isInverted = true

swift-sdk/ITBConsts.swift

@@ -26,7 +26,6 @@ public extension String {
     public static let ITBL_PATH_TRACK_INAPP_CLICK = "events/trackInAppClick"
     public static let ITBL_PATH_TRACK_INAPP_OPEN = "events/trackInAppOpen"
     public static let ITBL_PATH_TRACK_PUSH_OPEN = "events/trackPushOpen"
-    public static let ITBL_PATH_CREATE_USER = "users/createUserForUserId"
     public static let ITBL_PATH_UPDATE_USER = "users/update"
     public static let ITBL_PATH_UPDATE_EMAIL = "users/updateEmail"
     public static let ITBL_PATH_UPDATE_SUBSCRIPTIONS = "users/updateSubscriptions"
@@ -60,6 +59,7 @@ public extension AnyHashable {
     public static let ITBL_KEY_USER_ID = "userId"
     public static let ITBL_KEY_ACTION_IDENTIFIER = "actionIdentifier"
     public static let ITBL_KEY_USER_TEXT = "userText"
+    public static let ITBL_KEY_PREFER_USER_ID = "preferUserId"
 }
 
 // More Keys

swift-sdk/Internal/IterableAPIInternal.swift

@@ -110,22 +110,7 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
             return
         }
 
-        if let userId = userId {
-            // if we are using userId, then create a user first, then register
-            createUser(withUserId: userId).flatMap({ (_)  in
-                return self.register(token: token, appName: appName, pushServicePlatform: self.config.pushPlatform)
-            }).onSuccess { (json) in
-                onSuccess?(json)
-            }.onError { (error) in
-                if let sendError = error as? SendRequestError {
-                    onFailure?(sendError.reason, sendError.data)
-                } else {
-                    onFailure?("failed to create user", nil)
-                }
-            }
-        } else {
-            register(token: token, appName: appName, pushServicePlatform: config.pushPlatform, onSuccess: onSuccess, onFailure: onFailure)
-        }
+        register(token: token, appName: appName, pushServicePlatform: config.pushPlatform, onSuccess: onSuccess, onFailure: onFailure)
     }
 
     @discardableResult private func register(token: Data, appName: String, pushServicePlatform: PushServicePlatform, onSuccess: OnSuccessHandler? = nil, onFailure: OnFailureHandler? = nil) -> Future<SendRequestValue> {
@@ -175,6 +160,10 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
         args[.ITBL_KEY_DEVICE] = deviceDictionary
         addEmailOrUserId(args: &args)
 
+        if email == nil && userId != nil {
+            args[.ITBL_KEY_PREFER_USER_ID] = true
+        }
+        
         ITBInfo("sending registerToken request with args \(args)")
         return
             createPostRequest(forPath: .ITBL_PATH_REGISTER_DEVICE_TOKEN, withBody: args)
@@ -236,15 +225,6 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
         }
     }
 
-    private func createUser(withUserId userId: String) -> Future<SendRequestValue> {
-        var args = [AnyHashable : Any]()
-        args[.ITBL_KEY_USER_ID] = userId
-        
-        return createPostRequest(forPath: .ITBL_PATH_CREATE_USER, withBody: args).map {
-            sendRequest($0)
-        } ?? SendRequestError.createErroredFuture(reason: "Could not create createUser Reqeust")
-    }
-
     func trackPurchase(_ total: NSNumber, items: [CommerceItem]) {
         trackPurchase(total, items: items, dataFields: nil)
     }