Unit test for IAM lifecycle delegate methods

Author: emawby

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -984,7 +984,7 @@ - (void)testIAMClickedLaunchesClickHandlerSendDirectOutcomeV2Request {
 
     let firstTrigger = [OSTrigger customTriggerWithProperty:@"testProp" withOperator:OSTriggerOperatorTypeExists withValue:nil];
 
-    OSInAppMessageInternal * message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
+    OSInAppMessageInternal *message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
 
     [self initOneSignalWithInAppMessage:message];
 
@@ -1027,7 +1027,7 @@ - (void)testIAMClickedLaunchesClickHandlerDismissIAMSendIndirectOutcomeV2Request
 
     let firstTrigger = [OSTrigger customTriggerWithProperty:@"testProp" withOperator:OSTriggerOperatorTypeExists withValue:nil];
 
-    OSInAppMessageInternal * message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
+    OSInAppMessageInternal *message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
 
     [self initOneSignalWithInAppMessage:message];
 
@@ -1593,6 +1593,50 @@ - (void)testInAppMessageDisplayMultipleTimesSessionDurationTrigger {
     XCTAssertEqual(secondDisplayQuantity, 2);
 }
 
+- (void)testIAMLifecyleEventsFired {
+    let firstTrigger = [OSTrigger customTriggerWithProperty:@"testProp" withOperator:OSTriggerOperatorTypeExists withValue:nil];
+
+    OSInAppMessageInternal *message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
+
+    [self initOneSignalWithInAppMessage:message];
+    
+    OSInAppMessageTestDelegate *iamDelegate = [OSInAppMessageTestDelegate new];
+    [OneSignal setInAppMessageDelegate:iamDelegate];
+
+    XCTAssertEqual(0, OSMessagingControllerOverrider.messageDisplayQueue.count);
+
+    XCTAssertNil(iamDelegate->lastMessageWillDisplay);
+    XCTAssertNil(iamDelegate->lastMessageDidDisplay);
+    XCTAssertNil(iamDelegate->lastMessageWillDismiss);
+    XCTAssertNil(iamDelegate->lastMessageDidDismiss);
+    [OneSignal addTrigger:@"testProp" withValue:@2];
+    [UnitTestCommonMethods runBackgroundThreads];
+    
+    [OSMessagingController.sharedInstance onWillDisplayInAppMessage:message];
+    XCTAssertNotNil(iamDelegate->lastMessageWillDisplay);
+    XCTAssertNil(iamDelegate->lastMessageDidDisplay);
+    XCTAssertNil(iamDelegate->lastMessageWillDismiss);
+    XCTAssertNil(iamDelegate->lastMessageDidDismiss);
+    
+    [OSMessagingController.sharedInstance onDidDisplayInAppMessage:message];
+    XCTAssertNotNil(iamDelegate->lastMessageWillDisplay);
+    XCTAssertNotNil(iamDelegate->lastMessageDidDisplay);
+    XCTAssertNil(iamDelegate->lastMessageWillDismiss);
+    XCTAssertNil(iamDelegate->lastMessageDidDismiss);
+    
+    [OSMessagingController.sharedInstance onWillDismissInAppMessage:message];
+    XCTAssertNotNil(iamDelegate->lastMessageWillDisplay);
+    XCTAssertNotNil(iamDelegate->lastMessageDidDisplay);
+    XCTAssertNotNil(iamDelegate->lastMessageWillDismiss);
+    XCTAssertNil(iamDelegate->lastMessageDidDismiss);
+    
+    [OSMessagingController.sharedInstance onDidDismissInAppMessage:message];
+    XCTAssertNotNil(iamDelegate->lastMessageWillDisplay);
+    XCTAssertNotNil(iamDelegate->lastMessageDidDisplay);
+    XCTAssertNotNil(iamDelegate->lastMessageWillDismiss);
+    XCTAssertNotNil(iamDelegate->lastMessageDidDismiss);
+}
+
 /*
  Helper method that adds an OSInAppMessage to the IAM messageDisplayQueue
  Mock response JSON and initializes the OneSignal SDK

iOS_SDK/OneSignalSDK/UnitTests/Shadows/OSMessagingControllerOverrider.h

@@ -53,7 +53,10 @@ NS_ASSUME_NONNULL_BEGIN
 - (NSArray<OSInAppMessageInternal *> *)getInAppMessages;
 - (NSMutableDictionary <NSString *, OSInAppMessageInternal *> *)getRedisplayedInAppMessages;
 - (NSMutableArray<OSInAppMessageInternal *> *)getDisplayedMessages;
-
+- (void)onWillDisplayInAppMessage:(OSInAppMessageInternal *)message;
+- (void)onDidDisplayInAppMessage:(OSInAppMessageInternal *)message;
+- (void)onWillDismissInAppMessage:(OSInAppMessageInternal *)message;
+- (void)onDidDismissInAppMessage:(OSInAppMessageInternal *)message;
 @end
 
 NS_ASSUME_NONNULL_END

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.h

@@ -123,4 +123,12 @@ withNotificationWillShowInForegroundHandler:(OSNotificationWillShowInForegroundB
 - (void)onOSSMSSubscriptionChanged:(OSSMSSubscriptionStateChanges *)stateChanges;
 @end
 
+@interface OSInAppMessageTestDelegate : NSObject<OSInAppMessageDelegate> {
+    @package OSInAppMessage *lastMessageWillDisplay;
+    @package OSInAppMessage *lastMessageDidDisplay;
+    @package OSInAppMessage *lastMessageWillDismiss;
+    @package OSInAppMessage *lastMessageDidDismiss;
+}
+@end
+
 // END - Observers

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.m

@@ -480,3 +480,21 @@ - (void)onOSSMSSubscriptionChanged:(OSSMSSubscriptionStateChanges *)stateChanges
     fireCount++;
 }
 @end
+
+@implementation OSInAppMessageTestDelegate
+- (void)onWillDisplayInAppMessage:(OSInAppMessage *)message {
+    lastMessageWillDisplay = message;
+}
+
+- (void)onDidDisplayInAppMessage:(OSInAppMessage *)message {
+    lastMessageDidDisplay = message;
+}
+
+- (void)onWillDismissInAppMessage:(OSInAppMessage *)message {
+    lastMessageWillDismiss = message;
+}
+
+- (void)onDidDismissInAppMessage:(OSInAppMessage *)message {
+    lastMessageDidDismiss = message;
+}
+@end