-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
FIRExperimentController.m
337 lines (291 loc) · 14.7 KB
/
FIRExperimentController.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
// Copyright 2019 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 <FirebaseABTesting/FIRExperimentController.h>
#import <FirebaseABTesting/ABTExperimentPayload.h>
#import <FirebaseABTesting/FIRLifecycleEvents.h>
#import "FirebaseABTesting/Sources/ABTConditionalUserPropertyController.h"
#import "FirebaseABTesting/Sources/ABTConstants.h"
#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
#import "Interop/Analytics/Public/FIRAnalyticsInterop.h"
#ifndef FIRABTesting_VERSION
#error "FIRABTesting_VERSION is not defined: \
add -DFIRABTesting_VERSION=... to the build invocation"
#endif
// The following two macros supply the incantation so that the C
// preprocessor does not try to parse the version as a floating
// point number. See
// https://www.guyrutenberg.com/2008/12/20/expanding-macros-into-string-constants-in-c/
#define STR(x) STR_EXPAND(x)
#define STR_EXPAND(x) #x
/// Default experiment overflow policy.
const ABTExperimentPayloadExperimentOverflowPolicy FIRDefaultExperimentOverflowPolicy =
ABTExperimentPayloadExperimentOverflowPolicyDiscardOldest;
/// Deserialize the experiment payloads.
ABTExperimentPayload *ABTDeserializeExperimentPayload(NSData *payload) {
// Verify that we have a JSON object.
NSError *error;
id JSONObject = [NSJSONSerialization JSONObjectWithData:payload options:kNilOptions error:&error];
if (JSONObject == nil) {
FIRLogError(kFIRLoggerABTesting, @"I-ABT000001", @"Failed to parse experiment payload: %@",
error.debugDescription);
}
return [ABTExperimentPayload parseFromData:payload];
}
/// Returns a list of experiments to be set given the payloads and current list of experiments from
/// Firebase Analytics. If an experiment is in payloads but not in experiments, it should be set to
/// Firebase Analytics.
NSArray<ABTExperimentPayload *> *ABTExperimentsToSetFromPayloads(
NSArray<NSData *> *payloads,
NSArray<NSDictionary<NSString *, NSString *> *> *experiments,
id<FIRAnalyticsInterop> _Nullable analytics) {
NSArray<NSData *> *payloadsCopy = [payloads copy];
NSArray *experimentsCopy = [experiments copy];
NSMutableArray *experimentsToSet = [[NSMutableArray alloc] init];
ABTConditionalUserPropertyController *controller =
[ABTConditionalUserPropertyController sharedInstanceWithAnalytics:analytics];
// Check if the experiment is in payloads but not in experiments.
for (NSData *payload in payloadsCopy) {
ABTExperimentPayload *experimentPayload = ABTDeserializeExperimentPayload(payload);
if (!experimentPayload) {
FIRLogInfo(kFIRLoggerABTesting, @"I-ABT000002",
@"Either payload is not set or it cannot be deserialized.");
continue;
}
BOOL isExperimentSet = NO;
for (id experiment in experimentsCopy) {
if ([controller isExperiment:experiment theSameAsPayload:experimentPayload]) {
isExperimentSet = YES;
break;
}
}
if (!isExperimentSet) {
[experimentsToSet addObject:experimentPayload];
}
}
return [experimentsToSet copy];
}
/// Returns a list of experiments to be cleared given the payloads and current list of
/// experiments from Firebase Analytics. If an experiment is in experiments but not in payloads, it
/// should be cleared in Firebase Analytics.
NSArray *ABTExperimentsToClearFromPayloads(
NSArray<NSData *> *payloads,
NSArray<NSDictionary<NSString *, NSString *> *> *experiments,
id<FIRAnalyticsInterop> _Nullable analytics) {
NSMutableArray *experimentsToClear = [[NSMutableArray alloc] init];
ABTConditionalUserPropertyController *controller =
[ABTConditionalUserPropertyController sharedInstanceWithAnalytics:analytics];
// Check if the experiment is in experiments but not payloads.
for (id experiment in experiments) {
BOOL doesExperimentNoLongerExist = YES;
for (NSData *payload in payloads) {
ABTExperimentPayload *experimentPayload = ABTDeserializeExperimentPayload(payload);
if (!experimentPayload) {
FIRLogInfo(kFIRLoggerABTesting, @"I-ABT000002",
@"Either payload is not set or it cannot be deserialized.");
continue;
}
if ([controller isExperiment:experiment theSameAsPayload:experimentPayload]) {
doesExperimentNoLongerExist = NO;
}
}
if (doesExperimentNoLongerExist) {
[experimentsToClear addObject:experiment];
}
}
return experimentsToClear;
}
// ABT doesn't provide any functionality to other components,
// so it provides a private, empty protocol that it conforms to and use it for registration.
@protocol FIRABTInstanceProvider
@end
@interface FIRExperimentController () <FIRABTInstanceProvider, FIRLibrary>
@property(nonatomic, readwrite, strong) id<FIRAnalyticsInterop> _Nullable analytics;
@end
@implementation FIRExperimentController
+ (void)load {
[FIRApp registerInternalLibrary:(Class<FIRLibrary>)self
withName:@"fire-abt"
withVersion:[NSString stringWithUTF8String:STR(FIRABTesting_VERSION)]];
}
+ (nonnull NSArray<FIRComponent *> *)componentsToRegister {
FIRDependency *analyticsDep = [FIRDependency dependencyWithProtocol:@protocol(FIRAnalyticsInterop)
isRequired:NO];
FIRComponentCreationBlock creationBlock =
^id _Nullable(FIRComponentContainer *container, BOOL *isCacheable) {
// Ensure it's cached so it returns the same instance every time ABTesting is called.
*isCacheable = YES;
id<FIRAnalyticsInterop> analytics = FIR_COMPONENT(FIRAnalyticsInterop, container);
return [[FIRExperimentController alloc] initWithAnalytics:analytics];
};
FIRComponent *abtProvider = [FIRComponent componentWithProtocol:@protocol(FIRABTInstanceProvider)
instantiationTiming:FIRInstantiationTimingLazy
dependencies:@[ analyticsDep ]
creationBlock:creationBlock];
return @[ abtProvider ];
}
- (instancetype)initWithAnalytics:(nullable id<FIRAnalyticsInterop>)analytics {
self = [super init];
if (self != nil) {
_analytics = analytics;
}
return self;
}
+ (FIRExperimentController *)sharedInstance {
FIRApp *defaultApp = [FIRApp defaultApp]; // Missing configure will be logged here.
id<FIRABTInstanceProvider> instance = FIR_COMPONENT(FIRABTInstanceProvider, defaultApp.container);
// We know the instance coming from the container is a FIRExperimentController instance, cast it.
return (FIRExperimentController *)instance;
}
- (void)updateExperimentsWithServiceOrigin:(NSString *)origin
events:(FIRLifecycleEvents *)events
policy:(ABTExperimentPayloadExperimentOverflowPolicy)policy
lastStartTime:(NSTimeInterval)lastStartTime
payloads:(NSArray<NSData *> *)payloads
completionHandler:
(nullable void (^)(NSError *_Nullable error))completionHandler {
FIRExperimentController *__weak weakSelf = self;
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0), ^{
FIRExperimentController *strongSelf = weakSelf;
[strongSelf updateExperimentConditionalUserPropertiesWithServiceOrigin:origin
events:events
policy:policy
lastStartTime:lastStartTime
payloads:payloads
completionHandler:completionHandler];
});
}
- (void)updateExperimentsWithServiceOrigin:(NSString *)origin
events:(FIRLifecycleEvents *)events
policy:(ABTExperimentPayloadExperimentOverflowPolicy)policy
lastStartTime:(NSTimeInterval)lastStartTime
payloads:(NSArray<NSData *> *)payloads {
[self updateExperimentsWithServiceOrigin:origin
events:events
policy:policy
lastStartTime:lastStartTime
payloads:payloads
completionHandler:nil];
}
- (void)
updateExperimentConditionalUserPropertiesWithServiceOrigin:(NSString *)origin
events:(FIRLifecycleEvents *)events
policy:
(ABTExperimentPayloadExperimentOverflowPolicy)
policy
lastStartTime:(NSTimeInterval)lastStartTime
payloads:(NSArray<NSData *> *)payloads
completionHandler:
(nullable void (^)(NSError *_Nullable error))
completionHandler {
ABTConditionalUserPropertyController *controller =
[ABTConditionalUserPropertyController sharedInstanceWithAnalytics:_analytics];
// Get the list of expriments from Firebase Analytics.
NSArray *experiments = [controller experimentsWithOrigin:origin];
if (!experiments) {
NSString *errorDescription =
@"Failed to get conditional user properties from Firebase Analytics.";
FIRLogInfo(kFIRLoggerABTesting, @"I-ABT000003", @"%@", errorDescription);
if (completionHandler) {
completionHandler([NSError
errorWithDomain:kABTErrorDomain
code:kABTInternalErrorFailedToFetchConditionalUserProperties
userInfo:@{NSLocalizedDescriptionKey : errorDescription}]);
}
return;
}
NSArray<ABTExperimentPayload *> *experimentsToSet =
ABTExperimentsToSetFromPayloads(payloads, experiments, _analytics);
NSArray<NSDictionary<NSString *, NSString *> *> *experimentsToClear =
ABTExperimentsToClearFromPayloads(payloads, experiments, _analytics);
for (id experiment in experimentsToClear) {
NSString *experimentID = [controller experimentIDOfExperiment:experiment];
NSString *variantID = [controller variantIDOfExperiment:experiment];
[controller clearExperiment:experimentID
variantID:variantID
withOrigin:origin
payload:nil
events:events];
}
for (ABTExperimentPayload *experimentPayload in experimentsToSet) {
if (experimentPayload.experimentStartTimeMillis > lastStartTime * ABT_MSEC_PER_SEC) {
[controller setExperimentWithOrigin:origin
payload:experimentPayload
events:events
policy:policy];
FIRLogInfo(kFIRLoggerABTesting, @"I-ABT000008",
@"Set Experiment ID %@, variant ID %@ to Firebase Analytics.",
experimentPayload.experimentId, experimentPayload.variantId);
} else {
FIRLogInfo(kFIRLoggerABTesting, @"I-ABT000009",
@"Not setting experiment ID %@, variant ID %@ due to the last update time %lld.",
experimentPayload.experimentId, experimentPayload.variantId,
(long)lastStartTime * ABT_MSEC_PER_SEC);
}
}
if (completionHandler) {
completionHandler(nil);
}
}
- (NSTimeInterval)latestExperimentStartTimestampBetweenTimestamp:(NSTimeInterval)timestamp
andPayloads:(NSArray<NSData *> *)payloads {
for (NSData *payload in [payloads copy]) {
ABTExperimentPayload *experimentPayload = ABTDeserializeExperimentPayload(payload);
if (!experimentPayload) {
FIRLogInfo(kFIRLoggerABTesting, @"I-ABT000002",
@"Either payload is not set or it cannot be deserialized.");
continue;
}
if (experimentPayload.experimentStartTimeMillis > timestamp * ABT_MSEC_PER_SEC) {
timestamp = (double)(experimentPayload.experimentStartTimeMillis / ABT_MSEC_PER_SEC);
}
}
return timestamp;
}
- (void)validateRunningExperimentsForServiceOrigin:(NSString *)origin
runningExperimentPayloads:(NSArray<ABTExperimentPayload *> *)payloads {
ABTConditionalUserPropertyController *controller =
[ABTConditionalUserPropertyController sharedInstanceWithAnalytics:_analytics];
FIRLifecycleEvents *lifecycleEvents = [[FIRLifecycleEvents alloc] init];
// Get the list of experiments from Firebase Analytics.
NSArray<NSDictionary<NSString *, NSString *> *> *activeExperiments =
[controller experimentsWithOrigin:origin];
NSMutableSet *runningExperimentIDs = [NSMutableSet setWithCapacity:payloads.count];
for (ABTExperimentPayload *payload in payloads) {
[runningExperimentIDs addObject:payload.experimentId];
}
for (NSDictionary<NSString *, NSString *> *activeExperimentDictionary in activeExperiments) {
NSString *experimentID = activeExperimentDictionary[@"name"];
if (![runningExperimentIDs containsObject:experimentID]) {
NSString *variantID = activeExperimentDictionary[@"value"];
[controller clearExperiment:experimentID
variantID:variantID
withOrigin:origin
payload:nil
events:lifecycleEvents];
}
}
}
- (void)activateExperiment:(ABTExperimentPayload *)experimentPayload
forServiceOrigin:(NSString *)origin {
ABTConditionalUserPropertyController *controller =
[ABTConditionalUserPropertyController sharedInstanceWithAnalytics:_analytics];
FIRLifecycleEvents *lifecycleEvents = [[FIRLifecycleEvents alloc] init];
// Ensure that trigger event is nil, which will immediately set the experiment to active.
[experimentPayload clearTriggerEvent];
[controller setExperimentWithOrigin:origin
payload:experimentPayload
events:lifecycleEvents
policy:experimentPayload.overflowPolicy];
}
@end