firebase-ios-sdk/FirebaseRemoteConfig/Tests/Unit/RCNConfigExperimentTest.m

/*
 * 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 <OCMock/OCMock.h>
#import <XCTest/XCTest.h>

#import "FirebaseRemoteConfig/Sources/RCNConfigExperiment.h"

#import "FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h"
#import "FirebaseRemoteConfig/Sources/Public/FirebaseRemoteConfig/FIRRemoteConfig.h"
#import "FirebaseRemoteConfig/Sources/RCNConfigDBManager.h"
#import "FirebaseRemoteConfig/Sources/RCNConfigDefines.h"
#import "FirebaseRemoteConfig/Sources/RCNConfigValue_Internal.h"
#import "FirebaseRemoteConfig/Tests/Unit/RCNTestUtilities.h"

#import "FirebaseABTesting/Sources/Private/FirebaseABTestingInternal.h"

#import "Interop/Analytics/Public/FIRAnalyticsInterop.h"

// Surface the internal FIRExperimentController initializer.
@interface FIRExperimentController ()
- (instancetype)initWithAnalytics:(nullable id<FIRAnalyticsInterop>)analytics;
@end

@interface RCNConfigExperiment ()
@property(nonatomic, copy) NSMutableArray *experimentPayloads;
@property(nonatomic, copy) NSMutableDictionary *experimentMetadata;
@property(nonatomic, copy) NSMutableArray *activeExperimentPayloads;
@property(nonatomic, strong) RCNConfigDBManager *DBManager;
- (NSTimeInterval)updateExperimentStartTime;
- (void)loadExperimentFromTable;
- (void)updateActiveExperimentsInDB;
- (NSMutableSet<NSString *> *_Nonnull)getKeysAffectedByChangedExperiments;
@end

@interface RCNConfigExperimentTest : XCTestCase {
  NSTimeInterval _expectationTimeout;
  FIRExperimentController *_experimentController;
  RCNConfigExperiment *_configExperiment;
  id _DBManagerMock;
  NSArray<NSDictionary<NSString *, id> *> *_payloads;
  NSArray<NSData *> *_payloadsData;
  NSDictionary<NSString *, NSNumber *> *_metadata;
  NSString *_DBPath;
}
@end

@implementation RCNConfigExperimentTest
- (void)setUp {
  [super setUp];
  _expectationTimeout = 1.0;
  _DBPath = [RCNTestUtilities remoteConfigPathForTestDatabase];
  _DBManagerMock = OCMClassMock([RCNConfigDBManager class]);
  OCMStub([_DBManagerMock remoteConfigPathForDatabase]).andReturn(_DBPath);

  // Mock all database operations.
  NSDictionary<NSString *, id> *payload1 = @{@"experimentId" : @"DBValue1"};
  NSDictionary<NSString *, id> *payload2 = @{@"experimentId" : @"DBValue2"};
  _payloads = @[ payload1, payload2 ];
  NSError *error;
  NSData *payloadData1 = [NSJSONSerialization dataWithJSONObject:payload1 options:0 error:&error];
  NSData *payloadData2 = [NSJSONSerialization dataWithJSONObject:payload2 options:0 error:&error];
  _payloadsData = @[ payloadData1, payloadData2 ];
  _metadata = @{@"last_know_start_time" : @12348765};
  NSDictionary<NSString *, id> *mockResults = @{
    @RCNExperimentTableKeyPayload : _payloadsData,
    @RCNExperimentTableKeyMetadata : _metadata,
  };
  OCMStub([_DBManagerMock
      loadExperimentWithCompletionHandler:([OCMArg invokeBlockWithArgs:@YES, mockResults, nil])]);
  OCMStub([_DBManagerMock deleteExperimentTableForKey:[OCMArg any]]).andDo(nil);
  OCMStub([_DBManagerMock insertExperimentTableWithKey:[OCMArg any]
                                                 value:[OCMArg any]
                                     completionHandler:nil])
      .andDo(nil);

  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  _configExperiment = [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                                experimentController:experimentController];
}

- (void)tearDown {
  [super tearDown];
}

- (void)testInitMethod {
  OCMVerify([_DBManagerMock loadExperimentWithCompletionHandler:[OCMArg any]]);
}

- (void)testLoadExperimentFromTable {
  [_configExperiment loadExperimentFromTable];

  int payloadIndex = 0;
  for (NSData *payload in _configExperiment.experimentPayloads) {
    ABTExperimentPayload *experimentPayload = [self deserializeABTData:payload];
    XCTAssertNotNil(experimentPayload);
    XCTAssertEqualObjects(experimentPayload.experimentId,
                          _payloads[payloadIndex++][@"experimentId"]);
  }

  XCTAssertEqualObjects(_payloadsData, _configExperiment.experimentPayloads);
  XCTAssertEqualObjects(_metadata, _configExperiment.experimentMetadata);
}

- (void)testUpdateExperiment {
  NSDictionary<NSString *, NSString *> *payload1 = @{@"experimentId" : @"exp1"};
  NSDictionary<NSString *, NSString *> *payload2 = @{@"experimentId" : @"exp2"};
  NSDictionary<NSString *, NSString *> *payload3 = @{@"experimentId" : @"exp3"};
  NSArray<NSDictionary<NSString *, id> *> *originalPayloads = @[ payload1, payload2, payload3 ];

  NSArray<NSDictionary<NSString *, id> *> *response = @[ payload1, payload2, payload3 ];
  [_configExperiment updateExperimentsWithResponse:response];

  // Serialized proto data.
  int payloadIndex = 0;
  for (NSData *payload in _configExperiment.experimentPayloads) {
    ABTExperimentPayload *experimentPayload = [self deserializeABTData:payload];
    XCTAssertNotNil(experimentPayload);
    XCTAssertEqualObjects(experimentPayload.experimentId,
                          originalPayloads[payloadIndex++][@"experimentId"]);
  }
}

- (void)testUpdateLastExperimentStartTime {
  [_configExperiment updateExperimentStartTime];
  XCTAssertEqualObjects(_configExperiment.experimentMetadata[@"last_experiment_start_time"], @(0));

  NSDictionary<NSString *, NSString *> *payload =
      @{@"experimentStartTime" : @"2019-04-04T21:54:38.555Z"};
  [_configExperiment updateExperimentsWithResponse:@[ payload ]];
  [_configExperiment updateExperimentStartTime];

  int64_t originalTime = [self convertTimeToMillis:@"2019-04-04T21:54:38.555Z"] / 1000;
  int64_t time =
      ([_configExperiment.experimentMetadata[@"last_experiment_start_time"] doubleValue]);
  XCTAssertEqual(time, originalTime);
}

- (void)testMultipleUpdatesToLastExperimentStartTime {
  [_configExperiment updateExperimentStartTime];
  XCTAssertEqualObjects(_configExperiment.experimentMetadata[@"last_experiment_start_time"], @(0));

  NSDictionary<NSString *, NSString *> *payload =
      @{@"experimentStartTime" : @"2019-04-04T21:54:38.555Z"};
  [_configExperiment updateExperimentsWithResponse:@[ payload ]];
  [_configExperiment updateExperimentStartTime];

  int64_t originalTime = [self convertTimeToMillis:@"2019-04-04T21:54:38.555Z"] / 1000;
  int64_t time =
      ([_configExperiment.experimentMetadata[@"last_experiment_start_time"] doubleValue]);
  XCTAssertEqual(time, originalTime);

  // Update start time again.
  payload = @{@"experimentStartTime" : @"2019-04-04T21:55:38.555Z"};
  [_configExperiment updateExperimentsWithResponse:@[ payload ]];
  [_configExperiment updateExperimentStartTime];

  originalTime = [self convertTimeToMillis:@"2019-04-04T21:55:38.555Z"] / 1000;
  time = ([_configExperiment.experimentMetadata[@"last_experiment_start_time"] doubleValue]);
  XCTAssertEqual(time, originalTime);
}

- (void)testUpdateLastExperimentStartTimeInThePast {
  NSDictionary<NSString *, NSString *> *payload =
      @{@"experimentStartTime" : @"2019-04-04T21:55:38.555Z"};
  [_configExperiment updateExperimentsWithResponse:@[ payload ]];
  [_configExperiment updateExperimentStartTime];

  int64_t originalTime = [self convertTimeToMillis:@"2019-04-04T21:55:38.555Z"] / 1000;
  int64_t time =
      ([_configExperiment.experimentMetadata[@"last_experiment_start_time"] doubleValue]);
  XCTAssertEqual(time, originalTime);

  payload = @{@"experimentStartTime" : @"2018-04-04T21:55:38.555Z"};
  [_configExperiment updateExperimentsWithResponse:@[ payload ]];
  [_configExperiment updateExperimentStartTime];

  originalTime = [self convertTimeToMillis:@"2019-04-04T21:55:38.555Z"] / 1000;
  time = ([_configExperiment.experimentMetadata[@"last_experiment_start_time"] doubleValue]);
  XCTAssertEqual(time, originalTime);
}

- (void)testUpdateLastExperimentStartTimeInTheFuture {
  NSDictionary<NSString *, NSString *> *payload =
      @{@"experimentStartTime" : @"2020-04-04T21:55:38.555Z"};
  [_configExperiment updateExperimentsWithResponse:@[ payload ]];
  [_configExperiment updateExperimentStartTime];

  int64_t originalTime = [self convertTimeToMillis:@"2020-04-04T21:55:38.555Z"] / 1000;
  int64_t time =
      ([_configExperiment.experimentMetadata[@"last_experiment_start_time"] doubleValue]);
  XCTAssertEqual(time, originalTime);
}

- (void)testUpdateExperiments {
  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  id mockExperimentController = OCMPartialMock(experimentController);
  RCNConfigExperiment *experiment =
      [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                experimentController:mockExperimentController];

  NSTimeInterval lastStartTime =
      [experiment.experimentMetadata[@"last_experiment_start_time"] doubleValue];
  OCMStub(
      [mockExperimentController
          updateExperimentsWithServiceOrigin:[OCMArg any]
                                      events:[OCMArg any]
                                      policy:
                                          ABTExperimentPayloadExperimentOverflowPolicyDiscardOldest  // NOLINT
                               lastStartTime:lastStartTime
                                    payloads:[OCMArg any]
                           completionHandler:[OCMArg any]])
      .andDo(nil);

  NSData *payloadData = [[self class] payloadDataFromTestFile];

  experiment.experimentPayloads = [@[ payloadData ] mutableCopy];

  [experiment updateExperimentsWithHandler:^(NSError *_Nullable error) {
    XCTAssertNil(error);
    XCTAssertEqualObjects(experiment.experimentMetadata[@"last_experiment_start_time"],
                          @(12345678));
    OCMVerify([experiment updateActiveExperimentsInDB]);
    XCTAssertEqualObjects(experiment.activeExperimentPayloads, @[ payloadData ]);
  }];
}

- (void)testExperimentDiff_addedExperiment {
  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  id mockExperimentController = OCMPartialMock(experimentController);
  RCNConfigExperiment *experiment =
      [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                experimentController:mockExperimentController];

  NSData *payloadData1 = [[self class] payloadDataFromTestFile];
  experiment.activeExperimentPayloads = [@[ payloadData1 ] mutableCopy];

  NSError *dataError;
  NSMutableDictionary *payload =
      [NSJSONSerialization JSONObjectWithData:payloadData1
                                      options:NSJSONReadingMutableContainers
                                        error:&dataError];
  [payload setValue:@"exp_2" forKey:@"experimentId"];
  NSError *jsonError;
  NSData *payloadData2 = [NSJSONSerialization dataWithJSONObject:payload
                                                         options:kNilOptions
                                                           error:&jsonError];
  experiment.experimentPayloads = [@[ payloadData1, payloadData2 ] mutableCopy];

  NSMutableSet<NSString *> *changedKeys = [experiment getKeysAffectedByChangedExperiments];
  XCTAssertTrue([changedKeys containsObject:@"test_key_1"]);
}

- (void)testExperimentDiff_changedExperimentMetadata {
  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  id mockExperimentController = OCMPartialMock(experimentController);
  RCNConfigExperiment *experiment =
      [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                experimentController:mockExperimentController];

  NSData *payloadData1 = [[self class] payloadDataFromTestFile];
  experiment.activeExperimentPayloads = [@[ payloadData1 ] mutableCopy];

  NSError *dataError;
  NSMutableDictionary *payload =
      [NSJSONSerialization JSONObjectWithData:payloadData1
                                      options:NSJSONReadingMutableContainers
                                        error:&dataError];
  [payload setValue:@"var_2" forKey:@"variantId"];
  NSError *jsonError;
  NSData *payloadData2 = [NSJSONSerialization dataWithJSONObject:payload
                                                         options:kNilOptions
                                                           error:&jsonError];
  experiment.experimentPayloads = [@[ payloadData2 ] mutableCopy];

  NSMutableSet<NSString *> *changedKeys = [experiment getKeysAffectedByChangedExperiments];
  XCTAssertTrue([changedKeys containsObject:@"test_key_1"]);
}

- (void)testExperimentDiff_changedExperimentKeys {
  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  id mockExperimentController = OCMPartialMock(experimentController);
  RCNConfigExperiment *experiment =
      [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                experimentController:mockExperimentController];

  NSData *payloadData1 = [[self class] payloadDataFromTestFile];
  experiment.activeExperimentPayloads = [@[ payloadData1 ] mutableCopy];

  NSError *dataError;
  NSMutableDictionary *payload =
      [NSJSONSerialization JSONObjectWithData:payloadData1
                                      options:NSJSONReadingMutableContainers
                                        error:&dataError];
  [payload setValue:@[ @"test_key_1", @"test_key_2" ] forKey:@"affectedParameterKeys"];
  NSError *jsonError;
  NSData *payloadData2 = [NSJSONSerialization dataWithJSONObject:payload
                                                         options:kNilOptions
                                                           error:&jsonError];
  experiment.experimentPayloads = [@[ payloadData2 ] mutableCopy];

  NSMutableSet<NSString *> *changedKeys = [experiment getKeysAffectedByChangedExperiments];
  XCTAssertTrue([changedKeys containsObject:@"test_key_2"]);
}

- (void)testExperimentDiff_deletedExperiment {
  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  id mockExperimentController = OCMPartialMock(experimentController);
  RCNConfigExperiment *experiment =
      [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                experimentController:mockExperimentController];

  NSData *payloadData1 = [[self class] payloadDataFromTestFile];
  experiment.activeExperimentPayloads = [@[ payloadData1 ] mutableCopy];
  experiment.experimentPayloads = [@[] mutableCopy];

  NSMutableSet<NSString *> *changedKeys = [experiment getKeysAffectedByChangedExperiments];
  XCTAssertTrue([changedKeys containsObject:@"test_key_1"]);
}

- (void)testExperimentDiff_noChange {
  FIRExperimentController *experimentController =
      [[FIRExperimentController alloc] initWithAnalytics:nil];
  id mockExperimentController = OCMPartialMock(experimentController);
  RCNConfigExperiment *experiment =
      [[RCNConfigExperiment alloc] initWithDBManager:_DBManagerMock
                                experimentController:mockExperimentController];

  NSData *payloadData1 = [[self class] payloadDataFromTestFile];
  experiment.activeExperimentPayloads = [@[ payloadData1 ] mutableCopy];
  experiment.experimentPayloads = [@[ payloadData1 ] mutableCopy];

  NSMutableSet<NSString *> *changedKeys = [experiment getKeysAffectedByChangedExperiments];
  XCTAssertTrue([changedKeys count] == 0);
}

#pragma mark Helpers.

- (ABTExperimentPayload *)deserializeABTData:(NSData *)payload {
  return [ABTExperimentPayload parseFromData:payload];
}

- (int64_t)convertTimeToMillis:(NSString *)time {
  NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
  [dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"];
  [dateFormatter setTimeZone:[NSTimeZone timeZoneForSecondsFromGMT:0]];
  // Locale needs to be hardcoded. See
  // https://developer.apple.com/library/ios/#qa/qa1480/_index.html for more details.
  [dateFormatter setLocale:[[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"]];
  [dateFormatter setTimeZone:[NSTimeZone timeZoneWithAbbreviation:@"UTC"]];
  NSDate *experimentStartTime = [dateFormatter dateFromString:time];
  return [@([experimentStartTime timeIntervalSince1970] * 1000) longLongValue];
}

+ (NSData *)payloadDataFromTestFile {
#if SWIFT_PACKAGE
  NSBundle *bundle = SWIFTPM_MODULE_BUNDLE;
#else
  NSBundle *bundle = [NSBundle bundleForClass:[self class]];
#endif
  NSString *testJsonDataFilePath = [bundle pathForResource:@"TestABTPayload" ofType:@"txt"];
  NSError *readTextError = nil;
  NSString *fileText = [[NSString alloc] initWithContentsOfFile:testJsonDataFilePath
                                                       encoding:NSUTF8StringEncoding
                                                          error:&readTextError];

  NSData *fileData = [fileText dataUsingEncoding:kCFStringEncodingUTF8];

  NSError *jsonDictionaryError = nil;
  NSMutableDictionary *jsonDictionary =
      [[NSJSONSerialization JSONObjectWithData:fileData
                                       options:kNilOptions
                                         error:&jsonDictionaryError] mutableCopy];
  NSError *jsonDataError = nil;
  return [NSJSONSerialization dataWithJSONObject:jsonDictionary
                                         options:kNilOptions
                                           error:&jsonDataError];
}

@end