Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Data/FIRIAMMessageDefinition.m
T
christibbs 4c776d1f74 Support AB testing of Firebase In-App Messages (#5005)
* Parse out experiment payload for experimental FIAMs and store it on FIRIAMMessageDefinition

* Fix bugs in parsing experimental payload

* Add nullable experiment payload to FIAM message definition. Add method in FIRExperimenmtController to validate running experiments and call this when new messages are fetched from FIAM backend

* Add and document new ABT methods, update FirebaseInAppMessaging.podspec to depend on ABT

* Clean up deprecated public message initializers, add experiment payload to private initializers

* Activate experiment for experimental messages upon impression

* Clean up activateExperiment API

* Add experimental payload to all message definition initializers

* Add unit test coverage for new ABT methods

* Add test coverage for parsing experimental messages

* Verify experiment payload gets passed to message superclass

* Scripts/style.sh

* Update Podfile for UI test app to include AB Testing SDK

* Add back deprecated initializers for now, these are needed for the test app

* Test for non-nil experiment payload

* Use mutable array directly, better memory usage

* Bump ABTesting podspec version, depend on new ABT in FIAM

* Remove mentions of FIREventOrigins.h

* Remove experiment payload from public API, hide it in private

* Scripts/style.sh

* Fix comment indentation, allow for FIAM to depend on minor version updates of ABTesting

* Move ABTExperimentPayload import to private header
2020-03-03 19:46:37 -05:00

107 lines
3.7 KiB
Objective-C

/*
* 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 "FIRIAMMessageDefinition.h"
@implementation FIRIAMMessageRenderData
- (instancetype)initWithMessageID:(NSString *)messageID
messageName:(NSString *)messageName
contentData:(id<FIRIAMMessageContentData>)contentData
renderingEffect:(FIRIAMRenderingEffectSetting *)renderEffect {
if (self = [super init]) {
_contentData = contentData;
_renderingEffectSettings = renderEffect;
_messageID = [messageID copy];
_name = [messageName copy];
}
return self;
}
@end
@implementation FIRIAMMessageDefinition
- (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData
startTime:(NSTimeInterval)startTime
endTime:(NSTimeInterval)endTime
triggerDefinition:(NSArray<FIRIAMDisplayTriggerDefinition *> *)renderTriggers
appData:(nullable NSDictionary *)appData
experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
isTestMessage:(BOOL)isTestMessage {
if (self = [super init]) {
_renderData = renderData;
_renderTriggers = renderTriggers;
_startTime = startTime;
_endTime = endTime;
_isTestMessage = isTestMessage;
_appData = [appData copy];
_experimentPayload = experimentPayload;
}
return self;
}
- (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData
startTime:(NSTimeInterval)startTime
endTime:(NSTimeInterval)endTime
triggerDefinition:(NSArray<FIRIAMDisplayTriggerDefinition *> *)renderTriggers {
return [self initWithRenderData:renderData
startTime:startTime
endTime:endTime
triggerDefinition:renderTriggers
appData:nil
experimentPayload:nil
isTestMessage:NO];
}
- (instancetype)initTestMessageWithRenderData:(FIRIAMMessageRenderData *)renderData
experimentPayload:(nullable ABTExperimentPayload *)experimentPayload {
return [self initWithRenderData:renderData
startTime:0
endTime:0
triggerDefinition:@[]
appData:nil
experimentPayload:experimentPayload
isTestMessage:YES];
}
- (BOOL)messageHasExpired {
return self.endTime < [[NSDate date] timeIntervalSince1970];
}
- (BOOL)messageRenderedOnTrigger:(FIRIAMRenderTrigger)trigger {
for (FIRIAMDisplayTriggerDefinition *nextTrigger in self.renderTriggers) {
if (nextTrigger.triggerType == trigger) {
return YES;
}
}
return NO;
}
- (BOOL)messageRenderedOnAnalyticsEvent:(NSString *)eventName {
for (FIRIAMDisplayTriggerDefinition *nextTrigger in self.renderTriggers) {
if (nextTrigger.triggerType == FIRIAMRenderTriggerOnFirebaseAnalyticsEvent &&
[nextTrigger.firebaseEventName isEqualToString:eventName]) {
return YES;
}
}
return NO;
}
- (BOOL)messageHasStarted {
return self.startTime < [[NSDate date] timeIntervalSince1970];
}
@end