spm/firebase-ios-sdk
1
0 Fork 0
mirror of https://github.com/firebase/firebase-ios-sdk synced 2026-11-09 22:36:01 +05:45
Code Issues Packages Projects Releases Wiki Activity
Files
main
firebase-ios-sdk/FirebaseInAppMessaging/Tests/Unit/FIRIAMDisplayExecutorTests.m
T

1230 lines
57 KiB
Objective-C
Raw Permalink Blame History

/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <OCMock/OCMock.h>
#import <XCTest/XCTest.h>
#import "FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageContentData.h"
#import "FirebaseInAppMessaging/Sources/Private/DisplayTrigger/FIRIAMDisplayTriggerDefinition.h"
#import "FirebaseInAppMessaging/Sources/Private/Flows/FIRIAMDisplayExecutor.h"
#import "FirebaseInAppMessaging/Sources/Private/Runtime/FIRIAMActionURLFollower.h"
#import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessaging.h"
#import "FirebaseInAppMessaging/Sources/RenderingObjects/FIRInAppMessagingRenderingPrivate.h"
#import "FirebaseABTesting/Sources/Private/ABTExperimentPayload.h"
// A class implementing protocol FIRIAMMessageContentData to be used for unit testing
@interface FIRIAMMessageContentDataForTesting : NSObject <FIRIAMMessageContentData>
@property(nonatomic, readwrite, nonnull) NSString *titleText;
@property(nonatomic, readwrite, nonnull) NSString *bodyText;
@property(nonatomic, nullable) NSString *actionButtonText;
@property(nonatomic, nullable) NSString *secondaryActionButtonText;
@property(nonatomic, nullable) NSURL *actionURL;
@property(nonatomic, nullable) NSURL *secondaryActionURL;
@property(nonatomic, nullable) NSURL *imageURL;
@property(nonatomic, nullable) NSURL *landscapeImageURL;
@property BOOL errorEncountered;
@property BOOL loadImagesAsynchronously;
- (instancetype)initWithMessageTitle:(NSString *)title
messageBody:(NSString *)body
actionButtonText:(nullable NSString *)actionButtonText
secondaryActionButtonText:(nullable NSString *)secondaryActionButtonText
actionURL:(nullable NSURL *)actionURL
secondaryActionURL:(nullable NSURL *)secondaryActionURL
imageURL:(nullable NSURL *)imageURL
landscapeImageURL:(nullable NSURL *)landscapeImageURL
hasImageError:(BOOL)hasImageError
loadImagesAsynchronously:(BOOL)loadImagesAsynchronously;
@end
@implementation FIRIAMMessageContentDataForTesting
- (instancetype)initWithMessageTitle:(NSString *)title
messageBody:(NSString *)body
actionButtonText:(nullable NSString *)actionButtonText
secondaryActionButtonText:(nullable NSString *)secondaryActionButtonText
actionURL:(nullable NSURL *)actionURL
secondaryActionURL:(nullable NSURL *)secondaryActionURL
imageURL:(nullable NSURL *)imageURL
landscapeImageURL:(nullable NSURL *)landscapeImageURL
hasImageError:(BOOL)hasImageError
loadImagesAsynchronously:(BOOL)loadImagesAsynchronously {
if (self = [super init]) {
_titleText = title;
_bodyText = body;
_imageURL = imageURL;
_landscapeImageURL = landscapeImageURL;
_actionButtonText = actionButtonText;
_secondaryActionButtonText = secondaryActionButtonText;
_actionURL = actionURL;
_secondaryActionURL = secondaryActionURL;
_errorEncountered = hasImageError;
_loadImagesAsynchronously = loadImagesAsynchronously;
}
return self;
}
- (void)loadImageDataWithBlock:(void (^)(NSData *_Nullable imageData,
NSData *_Nullable landscapeImageData,
NSError *_Nullable error))block {
if (self.errorEncountered) {
NSError *error = [NSError errorWithDomain:@"image error" code:0 userInfo:nil];
if (_loadImagesAsynchronously) {
[self performOnMainQueueAfterDelay:0.01
block:^{
block(nil, nil, error);
}];
} else {
block(nil, nil, error);
}
} else {
NSData *imageData =
self.imageURL ? [@"image data" dataUsingEncoding:NSUTF8StringEncoding] : nil;
NSData *landscapeImageData =
self.landscapeImageURL ? [@"landscape image data" dataUsingEncoding:NSUTF8StringEncoding]
: nil;
if (_loadImagesAsynchronously) {
[self performOnMainQueueAfterDelay:0.01
block:^{
block(imageData, landscapeImageData, nil);
}];
} else {
block(imageData, landscapeImageData, nil);
}
}
}
- (void)performOnMainQueueAfterDelay:(NSTimeInterval)delay block:(void (^)(void))block {
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, delay * NSEC_PER_SEC), dispatch_get_main_queue(),
^{
block();
});
}
@end
// Defines how the message display component triggers the delegate in unit testing.
typedef NS_ENUM(NSInteger, FIRInAppMessagingDelegateInteraction) {
// Message display component triggers messageDismissedWithType:.
FIRInAppMessagingDelegateInteractionDismiss,
// Message display component triggers messageClicked:.
FIRInAppMessagingDelegateInteractionClick,
// Message display component triggers displayErrorEncountered:.
FIRInAppMessagingDelegateInteractionError,
// Message has finished a valid impression, but it's not getting closed by the user.
FIRInAppMessagingDelegateInteractionImpressionDetected,
};
// A class implementing protocol FIRInAppMessagingDisplay to be used for unit testing
@interface FIRIAMMessageDisplayForTesting : NSObject <FIRInAppMessagingDisplay>
@property FIRInAppMessagingDelegateInteraction delegateInteraction;
@property(nonatomic, nullable, copy) FIRInAppMessagingAction *action;
// used for interaction verification
@property FIRInAppMessagingDisplayMessage *message;
- (instancetype)initWithDelegateInteraction:(FIRInAppMessagingDelegateInteraction)interaction
action:(nullable FIRInAppMessagingAction *)actionURL;
- (instancetype)initWithDelegateInteraction:(FIRInAppMessagingDelegateInteraction)interaction;
@end
@implementation FIRIAMMessageDisplayForTesting
- (instancetype)initWithDelegateInteraction:(FIRInAppMessagingDelegateInteraction)interaction
action:(nullable FIRInAppMessagingAction *)action {
if (self = [super init]) {
_delegateInteraction = interaction;
_action = action;
}
return self;
}
- (instancetype)initWithDelegateInteraction:(FIRInAppMessagingDelegateInteraction)interaction {
return [self initWithDelegateInteraction:interaction action:nil];
}
- (void)displayMessage:(FIRInAppMessagingDisplayMessage *)messageForDisplay
displayDelegate:(id<FIRInAppMessagingDisplayDelegate>)displayDelegate {
self.message = messageForDisplay;
switch (self.delegateInteraction) {
case FIRInAppMessagingDelegateInteractionClick:
[displayDelegate messageClicked:messageForDisplay withAction:self.action];
break;
case FIRInAppMessagingDelegateInteractionDismiss:
[displayDelegate messageDismissed:messageForDisplay
dismissType:FIRInAppMessagingDismissTypeAuto];
break;
case FIRInAppMessagingDelegateInteractionError:
[displayDelegate displayErrorForMessage:messageForDisplay
error:[NSError errorWithDomain:NSURLErrorDomain
code:0
userInfo:nil]];
break;
case FIRInAppMessagingDelegateInteractionImpressionDetected:
[displayDelegate impressionDetectedForMessage:messageForDisplay];
break;
}
}
@end
@interface FIRInAppMessagingDisplayTestDelegate : NSObject <FIRInAppMessagingDisplayDelegate>
@property(nonatomic) BOOL receivedMessageErrorCallback;
@property(nonatomic) BOOL receivedMessageImpressionCallback;
@property(nonatomic) BOOL receivedMessageClickedCallback;
@property(nonatomic) BOOL receivedMessageDismissedCallback;
@end
@implementation FIRInAppMessagingDisplayTestDelegate
- (void)displayErrorForMessage:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage
error:(nonnull NSError *)error {
self.receivedMessageErrorCallback = YES;
}
- (void)impressionDetectedForMessage:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage {
self.receivedMessageImpressionCallback = YES;
}
- (void)messageClicked:(FIRInAppMessagingDisplayMessage *)inAppMessage
withAction:(FIRInAppMessagingAction *)action {
self.receivedMessageClickedCallback = YES;
}
- (void)messageDismissed:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage
dismissType:(FIRInAppMessagingDismissType)dismissType {
self.receivedMessageDismissedCallback = YES;
}
@end
@interface FIRIAMDisplayExecutor (Testing)
- (FIRInAppMessagingDisplayMessage *)
displayMessageWithMessageDefinition:(FIRIAMMessageDefinition *)definition
imageData:(FIRInAppMessagingImageData *)imageData
landscapeImageData:(nullable FIRInAppMessagingImageData *)landscapeImageData
triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType;
- (BOOL)shouldTrackConversionsOnImpressionForCurrentInAppMessage:
(FIRIAMMessageDefinition *)inAppMessage;
@end
@interface FIRIAMDisplayExecutorTests : XCTestCase
@property(nonatomic) FIRIAMDisplaySetting *displaySetting;
@property FIRIAMMessageClientCache *clientMessageCache;
@property id<FIRIAMBookKeeper> mockBookkeeper;
@property id<FIRIAMTimeFetcher> mockTimeFetcher;
@property FIRIAMDisplayExecutor *displayExecutor;
@property FIRIAMActivityLogger *mockActivityLogger;
@property FIRInAppMessaging *mockInAppMessaging;
@property id<FIRIAMAnalyticsEventLogger> mockAnalyticsEventLogger;
@property FIRIAMActionURLFollower *mockActionURLFollower;
@property id<FIRInAppMessagingDisplay> mockMessageDisplayComponent;
// Pre-defined messages
@property FIRIAMMessageDefinition *m1, *m2, *m3, *m4, *m5, *m6;
@end
@implementation FIRIAMDisplayExecutorTests
- (void)setupMessageTexture {
// startTime, endTime here ensures messages with them are active
NSTimeInterval activeStartTime = 0;
NSTimeInterval activeEndTime = [[NSDate date] timeIntervalSince1970] + 10000;
// m1 & m3 will be of contextual trigger
FIRIAMDisplayTriggerDefinition *contextualTriggerDefinition =
[[FIRIAMDisplayTriggerDefinition alloc] initWithFirebaseAnalyticEvent:@"test_event"];
// m2, m4, m5, and m6 will be of app open trigger
FIRIAMDisplayTriggerDefinition *appOpentriggerDefinition =
[[FIRIAMDisplayTriggerDefinition alloc] initForAppForegroundTrigger];
FIRIAMMessageContentDataForTesting *m1ContentData = [[FIRIAMMessageContentDataForTesting alloc]
initWithMessageTitle:@"m1 title"
messageBody:@"message body"
actionButtonText:nil
secondaryActionButtonText:nil
actionURL:[NSURL URLWithString:@"http://google.com"]
secondaryActionURL:nil
imageURL:[NSURL URLWithString:@"https://google.com/image"]
landscapeImageURL:nil
hasImageError:NO
loadImagesAsynchronously:NO];
FIRIAMRenderingEffectSetting *renderSetting1 =
[FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
renderSetting1.viewMode = FIRIAMRenderAsBannerView;
FIRIAMMessageRenderData *renderData1 =
[[FIRIAMMessageRenderData alloc] initWithMessageID:@"m1"
messageName:@"name"
contentData:m1ContentData
renderingEffect:renderSetting1];
self.m1 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData1
startTime:activeStartTime
endTime:activeEndTime
triggerDefinition:@[ contextualTriggerDefinition ]];
FIRIAMMessageContentDataForTesting *m2ContentData = [[FIRIAMMessageContentDataForTesting alloc]
initWithMessageTitle:@"m2 title"
messageBody:@"message body"
actionButtonText:nil
secondaryActionButtonText:nil
actionURL:[NSURL URLWithString:@"http://google.com"]
secondaryActionURL:nil
imageURL:[NSURL URLWithString:@"https://unsplash.it/300/400"]
landscapeImageURL:nil
hasImageError:NO
loadImagesAsynchronously:NO];
FIRIAMRenderingEffectSetting *renderSetting2 =
[FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
renderSetting2.viewMode = FIRIAMRenderAsModalView;
FIRIAMMessageRenderData *renderData2 =
[[FIRIAMMessageRenderData alloc] initWithMessageID:@"m2"
messageName:@"name"
contentData:m2ContentData
renderingEffect:renderSetting2];
self.m2 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData2
startTime:activeStartTime
endTime:activeEndTime
triggerDefinition:@[ appOpentriggerDefinition ]];
FIRIAMMessageContentDataForTesting *m3ContentData = [[FIRIAMMessageContentDataForTesting alloc]
initWithMessageTitle:@"m3 title"
messageBody:@"message body"
actionButtonText:nil
secondaryActionButtonText:nil
actionURL:[NSURL URLWithString:@"http://google.com"]
secondaryActionURL:nil
imageURL:[NSURL URLWithString:@"https://google.com/image"]
landscapeImageURL:nil
hasImageError:NO
loadImagesAsynchronously:NO];
FIRIAMRenderingEffectSetting *renderSetting3 =
[FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
renderSetting3.viewMode = FIRIAMRenderAsImageOnlyView;
FIRIAMMessageRenderData *renderData3 =
[[FIRIAMMessageRenderData alloc] initWithMessageID:@"m3"
messageName:@"name"
contentData:m3ContentData
renderingEffect:renderSetting3];
self.m3 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData3
startTime:activeStartTime
endTime:activeEndTime
triggerDefinition:@[ contextualTriggerDefinition ]];
FIRIAMMessageContentDataForTesting *m4ContentData = [[FIRIAMMessageContentDataForTesting alloc]
initWithMessageTitle:@"m4 title"
messageBody:@"message body"
actionButtonText:nil
secondaryActionButtonText:nil
actionURL:[NSURL URLWithString:@"http://google.com"]
secondaryActionURL:nil
imageURL:[NSURL URLWithString:@"https://google.com/image"]
landscapeImageURL:nil
hasImageError:NO
loadImagesAsynchronously:NO];
FIRIAMRenderingEffectSetting *renderSetting4 =
[FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
renderSetting4.viewMode = FIRIAMRenderAsImageOnlyView;
FIRIAMMessageRenderData *renderData4 =
[[FIRIAMMessageRenderData alloc] initWithMessageID:@"m4"
messageName:@"name"
contentData:m4ContentData
renderingEffect:renderSetting4];
NSDictionary *experimentPayloadDictionary = @{
@"experimentId" : @"_exp_1",
@"experimentStartTimeMillis" : @1582143484729,
@"overflowPolicy" : @"DISCARD_OLDEST",
@"timeToLiveMillis" : @15552000000,
@"triggerTimeoutMillis" : @15552000000,
@"variantId" : @"1"
};
ABTExperimentPayload *experimentPayload =
[[ABTExperimentPayload alloc] initWithDictionary:experimentPayloadDictionary];
self.m4 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData4
startTime:activeStartTime
endTime:activeEndTime
triggerDefinition:@[ appOpentriggerDefinition ]
appData:@{@"a" : @"b", @"up" : @"dog"}
experimentPayload:experimentPayload
isTestMessage:NO];
FIRIAMMessageContentDataForTesting *m5ContentData = [[FIRIAMMessageContentDataForTesting alloc]
initWithMessageTitle:nil
messageBody:nil
actionButtonText:nil
secondaryActionButtonText:nil
actionURL:nil
secondaryActionURL:nil
imageURL:[NSURL URLWithString:@"https://google.com/image"]
landscapeImageURL:nil
hasImageError:NO
loadImagesAsynchronously:NO];
FIRIAMRenderingEffectSetting *renderSetting5 =
[FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
renderSetting5.viewMode = FIRIAMRenderAsImageOnlyView;
FIRIAMMessageRenderData *renderData5 =
[[FIRIAMMessageRenderData alloc] initWithMessageID:@"m5"
messageName:@"name"
contentData:m5ContentData
renderingEffect:renderSetting5];
self.m5 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData5
startTime:activeStartTime
endTime:activeEndTime
triggerDefinition:@[ appOpentriggerDefinition ]
appData:nil
experimentPayload:nil
isTestMessage:NO];
FIRIAMMessageContentDataForTesting *m6ContentData = [[FIRIAMMessageContentDataForTesting alloc]
initWithMessageTitle:@"m6 title"
messageBody:@"message body"
actionButtonText:nil
secondaryActionButtonText:nil
actionURL:[NSURL URLWithString:@"http://google.com"]
secondaryActionURL:nil
imageURL:[NSURL URLWithString:@"https://google.com/image"]
landscapeImageURL:nil
hasImageError:NO
loadImagesAsynchronously:YES];
FIRIAMRenderingEffectSetting *renderSetting6 =
[FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
renderSetting6.viewMode = FIRIAMRenderAsCardView;
FIRIAMMessageRenderData *renderData6 =
[[FIRIAMMessageRenderData alloc] initWithMessageID:@"m6"
messageName:@"name"
contentData:m6ContentData
renderingEffect:renderSetting6];
self.m6 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData6
startTime:activeStartTime
endTime:activeEndTime
triggerDefinition:@[ appOpentriggerDefinition ]];
}
NSTimeInterval DISPLAY_MIN_INTERVALS = 1;
- (void)setUp {
[super setUp];
[self setupMessageTexture];
self.displaySetting = [[FIRIAMDisplaySetting alloc] init];
self.displaySetting.displayMinIntervalInMinutes = DISPLAY_MIN_INTERVALS;
self.mockBookkeeper = OCMProtocolMock(@protocol(FIRIAMBookKeeper));
FIRIAMFetchResponseParser *parser =
[[FIRIAMFetchResponseParser alloc] initWithTimeFetcher:[[FIRIAMTimerWithNSDate alloc] init]];
self.clientMessageCache = [[FIRIAMMessageClientCache alloc] initWithBookkeeper:self.mockBookkeeper
usingResponseParser:parser];
self.mockTimeFetcher = OCMProtocolMock(@protocol(FIRIAMTimeFetcher));
self.mockActivityLogger = OCMClassMock([FIRIAMActivityLogger class]);
self.mockAnalyticsEventLogger = OCMProtocolMock(@protocol(FIRIAMAnalyticsEventLogger));
self.mockInAppMessaging = OCMClassMock([FIRInAppMessaging class]);
self.mockActionURLFollower = OCMClassMock([FIRIAMActionURLFollower class]);
self.displayExecutor =
[[FIRIAMDisplayExecutor alloc] initWithInAppMessaging:self.mockInAppMessaging
setting:self.displaySetting
messageCache:self.clientMessageCache
timeFetcher:self.mockTimeFetcher
bookKeeper:self.mockBookkeeper
actionURLFollower:self.mockActionURLFollower
activityLogger:self.mockActivityLogger
analyticsEventLogger:self.mockAnalyticsEventLogger];
OCMStub([self.mockBookkeeper recordNewImpressionForMessage:[OCMArg any]
withStartTimestampInSeconds:1000]);
}
- (void)testRegularMessageAvailableCase {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
XCTAssertEqual(1, remainingMsgCount);
// Verify that the message content handed to display component is expected
XCTAssertEqualObjects(self.m2.renderData.messageID, display.message.campaignInfo.messageID);
}
- (void)testFollowingActionURL {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
FIRInAppMessagingAction *testAction =
[[FIRInAppMessagingAction alloc] initWithActionText:@"test"
actionURL:self.m2.renderData.contentData.actionURL];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick
action:testAction];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2 ]];
// not expecting triggering analytics recording
OCMExpect([self.mockActionURLFollower
followActionURL:[OCMArg isEqual:self.m2.renderData.contentData.actionURL]
withCompletionBlock:[OCMArg any]]);
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockActionURLFollower);
}
- (void)testFollowingActionURLForTestMessage {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
FIRIAMMessageDefinition *testMessage =
[[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m1.renderData
appData:nil
experimentPayload:nil];
FIRInAppMessagingAction *testAction = [[FIRInAppMessagingAction alloc]
initWithActionText:@"test"
actionURL:testMessage.renderData.contentData.actionURL];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick
action:testAction];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ testMessage ]];
// not expecting triggering analytics recording
OCMExpect([self.mockActionURLFollower
followActionURL:[OCMArg isEqual:testMessage.renderData.contentData.actionURL]
withCompletionBlock:[OCMArg any]]);
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockActionURLFollower);
}
- (void)testClientTestMessageAvailableCase {
// When test message is present in cache, even if the display time interval has not been
// reached, we still render.
// 10 seconds is less than DISPLAY_MIN_INTERVALS minutes, so we have not reached
// minimal display time interval yet.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andReturn(10);
FIRIAMMessageDefinition *testMessage =
[[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m1.renderData
appData:nil
experimentPayload:nil];
[self.clientMessageCache setMessageData:@[ self.m2, testMessage, self.m4 ]];
// We have test message in the cache now.
XCTAssertTrue([self.clientMessageCache hasTestMessage]);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// No more test message in the cache now.
XCTAssertFalse([self.clientMessageCache hasTestMessage]);
}
// If a message is still being displayed, we won't try to display a second one on top of it
- (void)testNoDualDisplay {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// This display component only detects a valid impression, but does not end the rendering
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionImpressionDetected];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// m2 is being rendered
XCTAssertEqualObjects(self.m2.renderData.messageID, display.message.campaignInfo.messageID);
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
XCTAssertEqual(1, remainingMsgCount);
// try to display again when the in-display flag is already turned on (and not turned off yet)
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// Verify that the message in display component is still m2
XCTAssertEqualObjects(self.m2.renderData.messageID, display.message.campaignInfo.messageID);
// message in cache remain unchanged for the second checkAndDisplayNext call
remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
XCTAssertEqual(1, remainingMsgCount);
}
// this test case contracts testNoAnalyticsTrackingOnTestMessage to cover both positive
// and negative cases
- (void)testDoesAnalyticsTrackingOnNonTestMessage {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// not expecting triggering analytics recording
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m2 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testDoesAnalyticsTrackingOnDisplayError {
// 1000 seconds is larger than DISPLAY_MIN_INTERVALS minutes
// last display time is set to 0 by default
OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andReturn(1000);
// not expecting triggering analytics recording
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventImageFetchError
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m2 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionError];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingOnMessageDismissCase {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// not expecting triggering analytics recording
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageDismissAuto
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
// Make sure we don't log the url follow event.
OCMReject([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventActionURLFollow
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m2 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionDismiss];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingOnMessageClickCase {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// We expect two analytics events for a click action:
// An impression event and an action URL follow event
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventActionURLFollow
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m2 ]];
FIRInAppMessagingAction *m2Action = [[FIRInAppMessagingAction alloc]
initWithActionText:self.m2.renderData.contentData.actionButtonText
actionURL:self.m2.renderData.contentData.actionURL];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick
action:m2Action];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingOnMessageClickCaseWithNoActionURL {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// We expect two analytics events for a click action:
// An impression event and an action URL follow event
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
forCampaignID:[OCMArg isEqual:self.m5.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m5 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick
action:nil];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingOnTestMessageClickCase {
// 1000 seconds is larger than DISPLAY_MIN_INTERVALS minutes
// last display time is set to 0 by default
OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andReturn(1000);
// We expect two analytics events for a click action:
// An test message impression event and a test message click event
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventTestMessageImpression
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventTestMessageClick
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
FIRIAMMessageDefinition *testMessage =
[[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m2.renderData
appData:nil
experimentPayload:nil];
[self.clientMessageCache setMessageData:@[ testMessage ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingOnTestMessageDismissCase {
// 1000 seconds is larger than DISPLAY_MIN_INTERVALS minutes
// last display time is set to 0 by default
OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andReturn(1000);
// We expect a test message impression
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventTestMessageImpression
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
// No click event
OCMReject([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventTestMessageClick
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
FIRIAMMessageDefinition *testMessage =
[[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m2.renderData
appData:nil
experimentPayload:nil];
[self.clientMessageCache setMessageData:@[ testMessage ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionDismiss];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingImpressionOnValidImpressionDetectedCaseWithActionURL {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// not expecting triggering analytics recording
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
forCampaignID:[OCMArg isEqual:self.m2.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m2 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionImpressionDetected];
self.displayExecutor.messageDisplayComponent = display;
// M2 has an action URL. Conversion shouldn't be tracked yet.
XCTAssertFalse(
[self.displayExecutor shouldTrackConversionsOnImpressionForCurrentInAppMessage:self.m2]);
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testAnalyticsTrackingImpressionOnValidImpressionDetectedCaseWithoutActionURL {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
// not expecting triggering analytics recording
OCMExpect([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
forCampaignID:[OCMArg isEqual:self.m5.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ self.m5 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionImpressionDetected];
self.displayExecutor.messageDisplayComponent = display;
// M5 has no action URL. Conversion should be tracked after impression.
OCMExpect([self.mockAnalyticsEventLogger
logConversionTrackingEventForCampaignID:[OCMArg isEqual:self.m5.renderData.messageID]]);
XCTAssertTrue(
[self.displayExecutor shouldTrackConversionsOnImpressionForCurrentInAppMessage:self.m5]);
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testNoAnalyticsTrackingOnTestMessage {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
FIRIAMMessageDefinition *testMessage =
[[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m1.renderData
appData:nil
experimentPayload:nil];
// not expecting triggering analytics recording
OCMReject([self.mockAnalyticsEventLogger
logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
forCampaignID:[OCMArg isEqual:self.m1.renderData.messageID]
withCampaignName:[OCMArg any]
eventTimeInMs:[OCMArg any]
completion:[OCMArg any]]);
[self.clientMessageCache setMessageData:@[ testMessage ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
OCMVerifyAll((id)self.mockAnalyticsEventLogger);
}
- (void)testNoMessageAvailableCase {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// No display has happened so the message stored in the display component should be nil
XCTAssertNil(display.message);
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
XCTAssertEqual(0, remainingMsgCount);
}
- (void)testIntervalBetweenOnAppOpenDisplays {
self.displaySetting.displayMinIntervalInMinutes = 10;
// last display time is set to 0 by default
// 10 seconds is not long enough for satisfying the 10-min internal requirement
OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andReturn(10);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m1 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
// No display has happened so the message stored in the display component should be nil
XCTAssertNil(display.message);
// still got one in the queue
XCTAssertEqual(1, remainingMsgCount);
}
// making sure that we match on the event names for analytics based events
- (void)testOnFirebaseAnalyticsEventDisplayMessages {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
// m1 and m3 are messages triggered by 'test_event' analytics events
[self.clientMessageCache setMessageData:@[ self.m1, self.m3 ]];
[self.displayExecutor checkAndDisplayNextContextualMessageForAnalyticsEvent:@"different event"];
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
// No message matching event "different event", so no message is nil
XCTAssertNil(display.message);
// still got 2 in the queue
XCTAssertEqual(2, remainingMsgCount);
// now trigger it with 'test_event' and we would expect one message to be displayed and removed
// from cache
[self.displayExecutor checkAndDisplayNextContextualMessageForAnalyticsEvent:@"test_event"];
// Expecting the m1 being used for display
XCTAssertEqualObjects(self.m1.renderData.messageID, display.message.campaignInfo.messageID);
remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
// Now only one message remaining in the queue
XCTAssertEqual(1, remainingMsgCount);
}
// no regular message rendering if suppress message display flag is turned on
- (void)testNoRenderingIfMessageDisplayIsSuppressed {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
self.displayExecutor.suppressMessageDisplay = YES;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// no message display has happened
XCTAssertNil(display.message);
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
// no message is removed from the cache
XCTAssertEqual(2, remainingMsgCount);
// now allow message rendering again
self.displayExecutor.suppressMessageDisplay = NO;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
NSInteger remainingMsgCount2 = [self.clientMessageCache allRegularMessages].count;
// one message was rendered and removed from the cache
XCTAssertEqual(1, remainingMsgCount2);
}
- (void)testNoRenderingIfMessageDisplayIsSuppressedDuringImageLoading {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
[self.clientMessageCache setMessageData:@[ self.m6 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
self.displayExecutor.suppressMessageDisplay = YES;
XCTestExpectation *expectation = [[XCTestExpectation alloc] init];
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 0.05 * NSEC_PER_SEC), dispatch_get_main_queue(),
^{
// no message display has happened
XCTAssertNil(display.message);
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
// no message is removed from the cache
XCTAssertEqual(1, remainingMsgCount);
[expectation fulfill];
});
[self waitForExpectations:@[ expectation ] timeout:0.1];
}
// No contextual message rendering if suppress message display flag is turned on
- (void)testNoContextualMsgRenderingIfMessageDisplayIsSuppressed {
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
[self.clientMessageCache setMessageData:@[ self.m1, self.m3 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
self.displayExecutor.suppressMessageDisplay = YES;
[self.displayExecutor checkAndDisplayNextContextualMessageForAnalyticsEvent:@"test_event"];
// no message display has happened
XCTAssertNil(display.message);
NSInteger remainingMsgCount = [self.clientMessageCache allRegularMessages].count;
// No message is removed from the cache.
XCTAssertEqual(2, remainingMsgCount);
// now re-enable message rendering again
self.displayExecutor.suppressMessageDisplay = NO;
[self.displayExecutor checkAndDisplayNextContextualMessageForAnalyticsEvent:@"test_event"];
NSInteger remainingMsgCount2 = [self.clientMessageCache allRegularMessages].count;
// one message was rendered and removed from the cache
XCTAssertEqual(1, remainingMsgCount2);
}
- (void)testMessageClickedCallback {
FIRInAppMessagingDisplayTestDelegate *delegate =
[[FIRInAppMessagingDisplayTestDelegate alloc] init];
self.mockInAppMessaging.delegate = delegate;
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
OCMStub(self.mockInAppMessaging.delegate).andReturn(delegate);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
XCTAssertTrue(delegate.receivedMessageClickedCallback);
}
- (void)testMessageImpressionCallback {
FIRInAppMessagingDisplayTestDelegate *delegate =
[[FIRInAppMessagingDisplayTestDelegate alloc] init];
self.mockInAppMessaging.delegate = delegate;
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
OCMStub(self.mockInAppMessaging.delegate).andReturn(delegate);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionImpressionDetected];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// Verify that the message content handed to display component is expected
XCTAssertTrue(delegate.receivedMessageImpressionCallback);
}
- (void)testMessageErrorCallback {
FIRInAppMessagingDisplayTestDelegate *delegate =
[[FIRInAppMessagingDisplayTestDelegate alloc] init];
self.mockInAppMessaging.delegate = delegate;
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
OCMStub(self.mockInAppMessaging.delegate).andReturn(delegate);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionError];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// Verify that the message content handed to display component is expected
XCTAssertTrue(delegate.receivedMessageErrorCallback);
}
- (void)testMessageDismissedCallback {
FIRInAppMessagingDisplayTestDelegate *delegate =
[[FIRInAppMessagingDisplayTestDelegate alloc] init];
self.mockInAppMessaging.delegate = delegate;
// This setup allows next message to be displayed from display interval perspective.
OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
.andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
OCMStub(self.mockInAppMessaging.delegate).andReturn(delegate);
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionDismiss];
self.displayExecutor.messageDisplayComponent = display;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
// Verify that the message content handed to display component is expected
XCTAssertTrue(delegate.receivedMessageDismissedCallback);
}
- (void)testCardWithoutImageDoesNotBlockNextMessage {
__block NSTimeInterval timestamp = 1000;
OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andDo(^(NSInvocation *invocation) {
[invocation setReturnValue:&timestamp];
});
OCMStub([self.mockBookkeeper getMessageIDsFromImpressions]).andReturn(@[]);
self.m2.renderData.renderingEffectSettings.viewMode = FIRIAMRenderAsCardView;
FIRIAMMessageContentDataForTesting *content =
(FIRIAMMessageContentDataForTesting *)self.m2.renderData.contentData;
content.imageURL = nil;
content.landscapeImageURL = nil;
[self.clientMessageCache setMessageData:@[ self.m2, self.m4 ]];
FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionDismiss];
self.displayExecutor.messageDisplayComponent = display;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
XCTAssertNil(display.message);
XCTAssertEqual(self.clientMessageCache.allRegularMessages.count, 1);
// The failed construction still advances lastDisplayTime. Exercise the display
// gate after the ordinary display interval, rather than failing its rate limit.
timestamp += self.displaySetting.displayMinIntervalInMinutes * 60;
[self.displayExecutor checkAndDisplayNextAppForegroundMessage];
XCTAssertNotNil(display.message);
XCTAssertEqualObjects(display.message.campaignInfo.messageID, self.m4.renderData.messageID);
}
- (void)testMessageWithDataBundle {
FIRInAppMessagingDisplayMessage *displayMessage = [self.displayExecutor
displayMessageWithMessageDefinition:self.m4
imageData:nil
landscapeImageData:nil
triggerType:FIRInAppMessagingDisplayTriggerTypeOnAppForeground];
XCTAssertEqual(displayMessage.appData.count, 2);
XCTAssertEqualObjects(displayMessage.appData[@"a"], @"b");
XCTAssertEqualObjects(displayMessage.appData[@"up"], @"dog");
}
- (void)testMessageWithoutDataBundle {
FIRInAppMessagingDisplayMessage *displayMessage = [self.displayExecutor
displayMessageWithMessageDefinition:self.m3
imageData:nil
landscapeImageData:nil
triggerType:FIRInAppMessagingDisplayTriggerTypeOnAppForeground];
XCTAssertNil(displayMessage.appData);
}
- (void)testMessageWithExperimentPayload {
FIRInAppMessagingDisplayMessage *displayMessage = [self.displayExecutor
displayMessageWithMessageDefinition:self.m4
imageData:nil
landscapeImageData:nil
triggerType:FIRInAppMessagingDisplayTriggerTypeOnAppForeground];
XCTAssertNotNil(displayMessage.campaignInfo.experimentPayload);
}
- (void)testMessageDisplayTypes {
FIRInAppMessagingImageData *imageData =
[[FIRInAppMessagingImageData alloc] initWithImageURL:@"https://www.google.com"
imageData:[NSData data]];
FIRInAppMessagingDisplayTriggerType analyticsTriggerType =
FIRInAppMessagingDisplayTriggerTypeOnAnalyticsEvent;
FIRInAppMessagingDisplayMessage *bannerMessage =
[self.displayExecutor displayMessageWithMessageDefinition:self.m1
imageData:imageData
landscapeImageData:nil
triggerType:analyticsTriggerType];
FIRInAppMessagingDisplayMessage *imageOnlyMessage =
[self.displayExecutor displayMessageWithMessageDefinition:self.m3
imageData:imageData
landscapeImageData:nil
triggerType:analyticsTriggerType];
FIRInAppMessagingDisplayMessage *modalMessage =
[self.displayExecutor displayMessageWithMessageDefinition:self.m2
imageData:imageData
landscapeImageData:nil
triggerType:analyticsTriggerType];
FIRInAppMessagingDisplayMessage *cardMessage =
[self.displayExecutor displayMessageWithMessageDefinition:self.m6
imageData:imageData
landscapeImageData:nil
triggerType:analyticsTriggerType];
XCTAssertEqual(bannerMessage.type, FIRInAppMessagingDisplayMessageTypeBanner);
XCTAssertEqual(imageOnlyMessage.type, FIRInAppMessagingDisplayMessageTypeImageOnly);
XCTAssertEqual(modalMessage.type, FIRInAppMessagingDisplayMessageTypeModal);
XCTAssertEqual(cardMessage.type, FIRInAppMessagingDisplayMessageTypeCard);
}
@end
Reference in new issue View Git Blame Copy Permalink