Implement auto-close creatives on nav away

Example/CreativeUITest/CreativeUITest.m

@@ -52,6 +52,7 @@ - (void)testLoadCreative_clickClose_closesCreative {
 
 - (void)testLoadCreative_fillOutFormAndSubmit_launchesSmsAppWithPrePopulatedText {
   [self launchAppWithMode:@"production"];
+  [app.buttons[@"Push me to clear the User!"] tap];
   [app.buttons[@"Push me for Creative!"] tap];
 
   // Fill in the email
@@ -90,9 +91,22 @@ - (void)testLoadCreative_clickPrivacyLink_opensPrivacyPageInWebApp {
   XCTAssertTrue([app.webViews.links[@"Privacy"] waitForExistenceWithTimeout:5.0]);
   [app.webViews.links[@"Privacy"] tap];
 
-  // Verify that the privacy page is visible in the external browser
-  XCUIApplication *safariApp = [[XCUIApplication alloc] initWithBundleIdentifier:@"com.apple.mobilesafari"];
-  XCTAssertTrue([safariApp.staticTexts[@"Privacy Policy"] waitForExistenceWithTimeout:5.0]);
+  // Wait for a moment to allow the app to react
+  sleep(5);
+
+  // Check if the app is no longer active
+  XCTAssertFalse([app.webViews.links[@"Privacy"] waitForExistenceWithTimeout:5.0]);
+
+  // AWS Device Farm doesn't always acknowledge separate apps, leading to flakiness here
+  NSString *envHost = [[[NSProcessInfo processInfo] environment] objectForKey:@"COM_ATTENTIVE_EXAMPLE_HOST"];
+  if ([envHost isEqualToString:@"local"]) {
+    // Verify that the privacy page is visible in the external browser
+    XCUIApplication *safariApp = [[XCUIApplication alloc] initWithBundleIdentifier:@"com.apple.mobilesafari"];
+    BOOL privacyPolicyExists = [safariApp.staticTexts[@"Privacy Policy"] waitForExistenceWithTimeout:5.0];
+    BOOL messagingPrivacyPolicyExists = [safariApp.staticTexts[@"Messaging Privacy Policy"] waitForExistenceWithTimeout:5.0];
+
+    XCTAssertTrue(privacyPolicyExists || messagingPrivacyPolicyExists);
+  }
 }
 
 
@@ -104,6 +118,22 @@ - (void)testLoadCreative_inDebugMode_showsDebugMessage {
   XCTAssertTrue([app.staticTexts[@"Debug output JSON"] waitForExistenceWithTimeout:5.0]);
 }
 
+- (void)testLoadCreative_clickProductPage_closesCreative {
+  [self launchAppWithMode:@"production"];
+  [app.buttons[@"Push me for Creative!"] tap];
+
+  // Click privacy link
+  XCTAssertTrue([app.webViews.links[@"Privacy"] waitForExistenceWithTimeout:5.0]);
+  [app.tabBars.buttons[@"Product"] tap];
+
+  // Verify that the product page is visible
+  XCTAssertTrue([app.buttons[@"Add To Cart"] waitForExistenceWithTimeout:5.0]);
+
+  // Nav back, and verify the creative is closed
+  [app.tabBars.buttons[@"Main"] tap];
+  XCTAssertTrue([app.buttons[@"Push me for Creative!"] waitForExistenceWithTimeout:5.0]);
+}
+
 
 + (void)clearCookies {
   NSLog(@"Clearing cookies!");
@@ -119,7 +149,7 @@ + (void)clearCookies {
 
 + (void)resetUserDefaults {
   // Reset user defaults for example app, not the test runner
-  [[NSUserDefaults standardUserDefaults] removePersistentDomainForName:@"com.attentive.Example"];
+  [[NSUserDefaults standardUserDefaults] removePersistentDomainForName:@"com.attentive.ExampleTest"];
 }
 
 

Example/Example.xcodeproj/project.pbxproj

@@ -438,6 +438,7 @@
 				INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 				INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
 				INFOPLIST_KEY_UIMainStoryboardFile = Main;
+				INFOPLIST_KEY_UIStatusBarStyle = "";
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
@@ -468,6 +469,7 @@
 				INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 				INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
 				INFOPLIST_KEY_UIMainStoryboardFile = Main;
+				INFOPLIST_KEY_UIStatusBarStyle = "";
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 				IPHONEOS_DEPLOYMENT_TARGET = 13.0;

Example/Example/ProductViewController.m

@@ -21,9 +21,15 @@ - (void)viewDidLoad {
   ATTNProductViewEvent* productView = [[ATTNProductViewEvent alloc] initWithItems:@[ item ]];
 
   [[ATTNEventTracker sharedInstance] recordEvent:productView];
+}
+
+- (void)viewDidAppear:(BOOL)animated {
+  [super viewDidAppear:animated];
+
   [self showToast:@"Product View event sent"];
 }
 
+
 - (IBAction)addToCartButtonPressed:(id)sender {
   ATTNItem* item = [self buildItem];
   ATTNAddToCartEvent* addToCart = [[ATTNAddToCartEvent alloc] initWithItems:@[ item ]];

Example/Example/ViewController.m

@@ -2,6 +2,7 @@
 #import "ImportAttentiveSDK.h"
 
 @interface ViewController ()
+@property (weak, nonatomic) IBOutlet UIScrollView *scrollView;
 @property (weak, nonatomic) IBOutlet UIButton *creativeButton;
 @property (weak, nonatomic) IBOutlet UIButton *sendIdentifiersButton;
 @property (weak, nonatomic) IBOutlet UIButton *clearUserButton;
@@ -22,6 +23,23 @@ - (void)viewDidLoad {
   [super viewDidLoad];
   self.view.backgroundColor = [UIColor systemGray3Color];
 
+  CGFloat contentWidth = self.scrollView.bounds.size.width;
+  CGFloat contentHeight = self.scrollView.bounds.size.height * 3;
+  self.scrollView.contentSize = CGSizeMake(contentWidth, contentHeight);
+
+  CGFloat subviewHeight = (CGFloat)120;
+  CGFloat currentViewOffset = (CGFloat)600;
+
+  while (currentViewOffset < contentHeight) {
+    CGRect frame = CGRectInset(CGRectMake(0, currentViewOffset, contentWidth, subviewHeight), 5, 5);
+    CGFloat hue = currentViewOffset / contentHeight;
+    UIView *subview = [[UIView alloc] initWithFrame:frame];
+    subview.backgroundColor = [UIColor colorWithHue:hue saturation:1 brightness:1 alpha:1];
+    [self.scrollView addSubview:subview];
+
+    currentViewOffset += subviewHeight;
+  }
+
   // Replace with your Attentive domain to test with your Attentive account
   _domain = @"YOUR_ATTENTIVE_DOMAIN";
   _mode = @"production";
@@ -89,6 +107,8 @@ - (void)clearCookies {
 }
 
 - (IBAction)clearUserButtonPressed:(id)sender {
+
+  NSLog(@"Clear user button pressed!");
   [sdk clearUser];
 }
 

Sources/ATTNAPI.m

@@ -162,7 +162,7 @@ - (void)sendEventInternalForRequest:(EventRequest*)request userIdentity:(ATTNUse
                                                 } else {
                                                   // The response is an HTTP response because the URL had an HTTPS scheme
                                                   NSHTTPURLResponse* httpResponse = (NSHTTPURLResponse*)response;
-                                                  if ([httpResponse statusCode] != 200) {
+                                                  if ([httpResponse statusCode] > 400) {
                                                     message = [NSString stringWithFormat:@"Error sending the event. Incorrect status code: '%ld'", (long)[httpResponse statusCode]];
                                                   } else {
                                                     message = [NSString stringWithFormat:@"Successfully sent event of type '%@'", request.eventNameAbbreviation];
@@ -349,7 +349,7 @@ - (void)sendUserIdentityInternal:(ATTNUserIdentity*)userIdentity domain:(NSStrin
                                                 } else {
                                                   // The response is an HTTP response because the URL had an HTTPS scheme
                                                   NSHTTPURLResponse* httpResponse = (NSHTTPURLResponse*)response;
-                                                  if ([httpResponse statusCode] != 200) {
+                                                  if ([httpResponse statusCode] > 400) {
                                                     message = [NSString stringWithFormat:@"Error sending the event. Incorrect status code: '%ld'", (long)[httpResponse statusCode]];
                                                   } else {
                                                     message = @"Successfully sent user identity event";
@@ -510,7 +510,11 @@ + (NSString* _Nullable)extractDomainFromTag:(NSString*)tag {
     return nil;
   }
 
-  return [tag substringWithRange:domainRange];
+  NSString* regionalizedDomain = [tag substringWithRange:domainRange];
+
+  NSLog(@"Identified regionalized attentive domain: %@", regionalizedDomain);
+
+  return regionalizedDomain;
 }
 
 // For testing only

Sources/ATTNSDK.h

@@ -19,6 +19,8 @@ extern NSString * const CREATIVE_TRIGGER_STATUS_CLOSED;
 extern NSString * const CREATIVE_TRIGGER_STATUS_NOT_OPENED;
 extern NSString * const CREATIVE_TRIGGER_STATUS_NOT_CLOSED;
 
+extern NSString * const SDK_VERSION;
+
 typedef void (^ATTNCreativeTriggerCompletionHandler)(NSString * triggerStatus);
 
 

Sources/ATTNSDK.m

@@ -24,7 +24,8 @@
 // Status passed to the ATTNCreativeTriggerCompletionHandler when the Creative is not closed due to an unknown
 // exception
 NSString *const CREATIVE_TRIGGER_STATUS_NOT_CLOSED = @"CREATIVE_TRIGGER_STATUS_NOT_CLOSED";
-NSString *const SDK_VERSION = @"0.4.3-beta.0";
+
+NSString *const visibilityEvent = @"document-visibility:";
 
 @implementation ATTNSDK {
   UIView *_parentView;
@@ -35,6 +36,8 @@ @implementation ATTNSDK {
   ATTNCreativeTriggerCompletionHandler _triggerHandler;
 }
 
+static BOOL isCreativeOpen = NO;
+
 - (id)initWithDomain:(NSString *)domain {
   NSLog(@"init attentive_ios_sdk v%@", SDK_VERSION);
   return [self initWithDomain:domain mode:@"production"];
@@ -100,9 +103,10 @@ - (void)trigger:(UIView *)theView handler:(ATTNCreativeTriggerCompletionHandler)
 
   [[wkWebViewConfiguration userContentController] addScriptMessageHandler:self name:@"log"];
 
-  NSString *userScriptWithEventListener = @"window.addEventListener('message', (event) => {if (event.data && event.data.__attentive && event.data.__attentive.action === 'CLOSE') {window.webkit.messageHandlers.log.postMessage(event.data.__attentive.action);}}, false);";
+  NSString *userScriptWithEventListener = [NSString stringWithFormat:@"window.addEventListener('message', (event) => {if (event.data && event.data.__attentive) {window.webkit.messageHandlers.log.postMessage(event.data.__attentive.action);}}, false);window.addEventListener('visibilitychange', (event) => {window.webkit.messageHandlers.log.postMessage(`%@ ${document.hidden}`);}, false);", visibilityEvent];
 
   WKUserScript *wkUserScript = [[WKUserScript alloc] initWithSource:userScriptWithEventListener injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:FALSE];
+
   [[wkWebViewConfiguration userContentController] addUserScript:wkUserScript];
 
   _webView = [[WKWebView alloc] initWithFrame:theView.frame configuration:wkWebViewConfiguration];
@@ -180,18 +184,18 @@ - (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigat
 
 - (void)userContentController:(WKUserContentController *)userContentController
       didReceiveScriptMessage:(WKScriptMessage *)message {
+  NSLog(@"web event message: %@", message.body);
   if ([message.body isEqualToString:@"CLOSE"]) {
-    @try {
-      [_webView removeFromSuperview];
-      if (self->_triggerHandler != nil) {
-        self->_triggerHandler(CREATIVE_TRIGGER_STATUS_CLOSED);
-      }
-    } @catch (NSException *e) {
-      NSLog(@"Exception when closing creative: %@", e.reason);
-      if (self->_triggerHandler != nil) {
-        self->_triggerHandler(CREATIVE_TRIGGER_STATUS_NOT_CLOSED);
-      }
-    }
+
+    [self closeCreative];
+  } else if ([message.body isEqualToString:@"IMPRESSION"]) {
+
+    NSLog(@"Creative opened and generated impression event");
+    isCreativeOpen = YES;
+  } else if ([message.body isEqualToString:[NSString stringWithFormat:@"%@ true", visibilityEvent]] && isCreativeOpen == YES) {
+    NSLog(@"Nav away from creative, closing");
+
+    [self closeCreative];
   }
 }
 
@@ -216,6 +220,28 @@ - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigati
   }
 }
 
+- (void)closeCreative {
+  NSLog(@"Closing creative");
+  @try {
+    [_webView removeFromSuperview];
+    isCreativeOpen = NO;
+    if (self->_triggerHandler != nil) {
+      self->_triggerHandler(CREATIVE_TRIGGER_STATUS_CLOSED);
+    }
+
+    NSLog(@"Successfully closed creative");
+  } @catch (NSException *e) {
+    NSLog(@"Exception when closing creative: %@", e.reason);
+    if (self->_triggerHandler != nil) {
+      self->_triggerHandler(CREATIVE_TRIGGER_STATUS_NOT_CLOSED);
+    }
+  }
+}
+
+- (NSString *)documentHiddenJavascriptCode {
+  return @"`Document Hidden: ${document.hidden}`";
+}
+
 - (ATTNAPI *)getApi {
   return _api;
 }

Sources/Internal/ATTNVersion.h

@@ -10,6 +10,6 @@
 
 // This should match the Podspec version
 // If there's a way to define the version in one place and use it both here and the Podspec then we should do it - I don't know of a way
-static NSString* const SDK_VERSION = @"0.4.3-beta.0";
+NSString* const SDK_VERSION = @"0.4.3-beta.1";
 
 #endif /* ATTNVersion_h */

attentive-ios-sdk.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'attentive-ios-sdk'
-  s.version          = '0.4.3-beta.0'
+  s.version          = '0.4.3-beta.1'
   s.summary          = 'Attentive IOS SDK'
 
 # This description is used to generate tags and improve search results.