[ITBL-5239] Make sure we handle the 'old' payload correctly (#57)

* Handle legacy payload with a deep link URL through the delegate

* Remove old code from ITBNotificationServiceExtension

* Remove IterableAction from IterableAppExtensions

* Add a test for legacy payload

* Add braces around if/else statements

Author: vbabenkoru

Iterable-iOS-SDK.xcodeproj/project.pbxproj

@@ -64,8 +64,6 @@
 		9284CA74206DCA6C00404B74 /* IterableAPIResponseTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 9284CA73206DCA6C00404B74 /* IterableAPIResponseTests.m */; };
 		929330902099449F00DAE180 /* IterableAction.h in Headers */ = {isa = PBXBuildFile; fileRef = 9293308E2099449F00DAE180 /* IterableAction.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		929330912099449F00DAE180 /* IterableAction.m in Sources */ = {isa = PBXBuildFile; fileRef = 9293308F2099449F00DAE180 /* IterableAction.m */; };
-		92933092209944AA00DAE180 /* IterableAction.h in Headers */ = {isa = PBXBuildFile; fileRef = 9293308E2099449F00DAE180 /* IterableAction.h */; settings = {ATTRIBUTES = (Public, ); }; };
-		92933093209944AD00DAE180 /* IterableAction.m in Sources */ = {isa = PBXBuildFile; fileRef = 9293308F2099449F00DAE180 /* IterableAction.m */; };
 		92C6325C208FF7AA00A7C216 /* IterableAppIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = 92C6325A208FF7AA00A7C216 /* IterableAppIntegration.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		92C6325D208FF7AA00A7C216 /* IterableAppIntegration.m in Sources */ = {isa = PBXBuildFile; fileRef = 92C6325B208FF7AA00A7C216 /* IterableAppIntegration.m */; };
 		92FB47C020995A0F00DA94DC /* IterableActionRunner.h in Headers */ = {isa = PBXBuildFile; fileRef = 92FB47BE20995A0F00DA94DC /* IterableActionRunner.h */; };
@@ -422,7 +420,6 @@
 			isa = PBXHeadersBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				92933092209944AA00DAE180 /* IterableAction.h in Headers */,
 				9267AA1F20992F9C006AF394 /* IterableAppExtensions.h in Headers */,
 				9267AA2820992FF9006AF394 /* ITBNotificationServiceExtension.h in Headers */,
 			);
@@ -773,7 +770,6 @@
 			buildActionMask = 2147483647;
 			files = (
 				9267AA2920992FF9006AF394 /* ITBNotificationServiceExtension.m in Sources */,
-				92933093209944AD00DAE180 /* IterableAction.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

Iterable-iOS-SDK/IterableActionRunner.m

@@ -24,6 +24,10 @@ + (void)executeAction:(IterableAction *)action {
 }
 
 + (void)openURL:(NSURL *)url action:(IterableAction *)action {
+    if (url == nil) {
+        return;
+    }
+    
     if ([[IterableAPI sharedInstance].urlDelegate handleIterableURL:url fromAction:action]) {
         return;
     }

Iterable-iOS-SDK/IterableAppIntegration.m

@@ -45,8 +45,14 @@ + (void)performDefaultNotificationAction:(NSDictionary *)userInfo api:(IterableA
         itbl = userInfo;
     }
 #endif
-    IterableAction *action = [IterableAction actionFromDictionary:itbl[ITBL_PAYLOAD_DEFAULT_ACTION]];
+    
+    IterableAction *action = nil;
     NSDictionary *dataFields = @{ ITBL_KEY_ACTION_IDENTIFIER: ITBL_VALUE_DEFAULT_PUSH_OPEN_ACTION_ID };
+    if (itbl[ITBL_PAYLOAD_DEFAULT_ACTION] != nil) {
+        action = [IterableAction actionFromDictionary:itbl[ITBL_PAYLOAD_DEFAULT_ACTION]];
+    } else {
+        action = [self legacyDefaultActionFromPayload:userInfo];
+    }
 
     // Track push open
     [api trackPushOpen:userInfo dataFields:dataFields];
@@ -72,7 +78,11 @@ + (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNoti
 
     if ([response.actionIdentifier isEqualToString:UNNotificationDefaultActionIdentifier]) {
         dataFields[ITBL_KEY_ACTION_IDENTIFIER] = ITBL_VALUE_DEFAULT_PUSH_OPEN_ACTION_ID;
-        action = [IterableAction actionFromDictionary:itbl[ITBL_PAYLOAD_DEFAULT_ACTION]];
+        if (itbl[ITBL_PAYLOAD_DEFAULT_ACTION] != nil) {
+            action = [IterableAction actionFromDictionary:itbl[ITBL_PAYLOAD_DEFAULT_ACTION]];
+        } else {
+            action = [self legacyDefaultActionFromPayload:userInfo];
+        }
     }
     else if ([response.actionIdentifier isEqualToString:UNNotificationDismissActionIdentifier]) {
         // We don't track dismiss actions yet
@@ -100,8 +110,17 @@ + (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNoti
     //Execute the action
     [IterableActionRunner executeAction:action];
 
-    if (completionHandler)
+    if (completionHandler) {
         completionHandler();
+    }
+}
+
++ (IterableAction *)legacyDefaultActionFromPayload:(NSDictionary *)userInfo {
+    if (userInfo[ITBL_PAYLOAD_DEEP_LINK_URL] != nil) {
+        return [IterableAction actionFromDictionary:@{@"type": IterableActionTypeOpenUrl, @"data": userInfo[ITBL_PAYLOAD_DEEP_LINK_URL]}];
+    } else {
+        return nil;
+    }
 }
 
 @end

Iterable-iOS-SDK/IterableConstants.h

@@ -83,6 +83,7 @@ extern NSString *const ITBL_DEVICE_USER_INTERFACE;
 //Push Payload
 #define ITBL_PAYLOAD_METADATA @"itbl"
 #define ITBL_PAYLOAD_MESSAGE_ID @"messageId"
+#define ITBL_PAYLOAD_DEEP_LINK_URL @"url"
 #define ITBL_PAYLOAD_ATTACHMENT_URL @"attachment-url"
 #define ITBL_PAYLOAD_ACTION_BUTTONS @"actionButtons"
 #define ITBL_PAYLOAD_DEFAULT_ACTION @"defaultAction"

Iterable-iOS-SDKTests/IterableNotificationResponseTests.m

@@ -295,4 +295,33 @@ - (void)testAppLaunchPushActionBeforeiOS10 {
     }
 }
 
+- (void)testLegacyDeepLinkPayload {
+    if (@available(iOS 10, *)) {
+        id actionRunnerMock = OCMClassMock([IterableActionRunner class]);
+        NSString *messageId = [[NSUUID UUID] UUIDString];
+        
+        NSDictionary *userInfo = @{
+                                   @"itbl": @{
+                                           @"campaignId": @1234,
+                                           @"templateId": @4321,
+                                           @"isGhostPush": @NO,
+                                           @"messageId": messageId
+                                           },
+                                   @"url": @"https://example.com"
+                                   };
+        
+        UNNotificationResponse *response = [self notificationResponseWithUserInfo:userInfo actionIdentifier:UNNotificationDefaultActionIdentifier];
+        
+        [IterableAppIntegration userNotificationCenter:nil didReceiveNotificationResponse:response withCompletionHandler:nil];
+        
+        OCMVerify([actionRunnerMock executeAction:[OCMArg checkWithBlock:^BOOL(IterableAction *action) {
+            XCTAssertEqual(action.type, @"openUrl");
+            XCTAssertEqual(action.data, @"https://example.com");
+            return YES;
+        }]]);
+        
+        [actionRunnerMock stopMocking];
+    }
+}
+
 @end

IterableAppExtensions.podspec

@@ -85,7 +85,7 @@ Pod::Spec.new do |s|
   #  Not including the public_header_files will make all headers public.
   #
 
-  s.source_files  = "IterableAppExtensions/*.{h,m}", "Iterable-iOS-SDK/IterableAction.{h,m}", "Iterable-iOS-SDK/IterableConstants.{h,m}"
+  s.source_files  = "IterableAppExtensions/*.{h,m}", "Iterable-iOS-SDK/IterableConstants.h"
   # s.exclude_files = "Classes/Exclude"
 
   # s.public_header_files = "Classes/**/*.h"

IterableAppExtensions/ITBNotificationServiceExtension.m

@@ -1,6 +1,5 @@
 
 #import "ITBNotificationServiceExtension.h"
-#import "IterableAction.h"
 #import "IterableConstants.h"
 
 NSString *const IterableButtonTypeDefault      = @"default";
@@ -16,9 +15,6 @@ @interface ITBNotificationServiceExtension ()
 
 @implementation ITBNotificationServiceExtension
 
-volatile int displayElements;
-volatile int count;
-
 UNNotificationCategory* messageCategory;
 
 - (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
@@ -64,14 +60,10 @@ - (BOOL)loadAttachment:(NSDictionary *) itblDictionary {
 
                 }
             }
-            count++;
-            //NSLog(@"url: %@",currentUrl);
-            if (count >= displayElements) {
-                [[NSOperationQueue mainQueue] addOperationWithBlock:^{
-                    self.contentHandler(self.bestAttemptContent);
-                }];
-            }
-
+            [[NSOperationQueue mainQueue] addOperationWithBlock:^{
+                self.contentHandler(self.bestAttemptContent);
+            }];
+            
         }] resume];
 
         return YES;