Resolved merge conflict

Author: David Westgate

.gitignore

@@ -4,4 +4,4 @@ carthage-files/Carthage
 *.xcuserstate
 *.xcuserdatad
 *.DS_Store
-
+*.xcscmblueprint

Branch-SDK/Branch-SDK/BNCConfig.h

@@ -9,7 +9,7 @@
 #ifndef Branch_SDK_Config_h
 #define Branch_SDK_Config_h
 
-#define SDK_VERSION             @"0.12.3"
+#define SDK_VERSION             @"0.12.4"
 
 #define BNC_PROD_ENV
 //#define BNC_STAGE_ENV
@@ -20,7 +20,7 @@
 #endif
 
 #ifdef BNC_STAGE_ENV
-#define BNC_API_BASE_URL        @"http://api.dev.branchmetrics.io"
+#define BNC_API_BASE_URL        @"http://api.dev.branch.io"
 #endif
 
 #define BNC_LINK_URL             @"https://bnc.lt"

Branch-SDK/Branch-SDK/BNCError.h

@@ -13,7 +13,6 @@ FOUNDATION_EXPORT NSString * const BNCErrorDomain;
 enum {
     BNCInitError = 1000,
     BNCDuplicateResourceError,
-    BNCInvalidPromoCodeError,
     BNCRedeemCreditsError,
     BNCBadRequestError,
     BNCServerProblemError,

Branch-SDK/Branch-SDK/BNCPreferenceHelper.h

@@ -14,7 +14,6 @@
 @interface BNCPreferenceHelper : NSObject
 
 @property (strong, nonatomic) NSString *branchKey;
-@property (strong, nonatomic) NSString *appKey;
 @property (strong, nonatomic) NSString *lastRunBranchKey;
 @property (strong, nonatomic) NSDate *lastStrongMatchDate;
 @property (strong, nonatomic) NSString *appVersion;
@@ -28,8 +27,6 @@
 @property (strong, nonatomic) NSString *userIdentity;
 @property (strong, nonatomic) NSString *sessionParams;
 @property (strong, nonatomic) NSString *installParams;
-@property (assign, nonatomic) BOOL explicitlyRequestedReferrable;
-@property (assign, nonatomic) BOOL isReferrable;
 @property (assign, nonatomic) BOOL isDebug;
 @property (assign, nonatomic) BOOL shouldWaitForInit;
 @property (assign, nonatomic) BOOL suppressWarningLogs;
@@ -43,6 +40,8 @@
 
 - (NSString *)getAPIBaseURL;
 - (NSString *)getAPIURL:(NSString *)endpoint;
+- (NSString *)getEndpointFromURL:(NSString *)url;
+
 - (NSString *)getBranchKey:(BOOL)isLive;
 
 - (void)clearUserCreditsAndCounts;
@@ -57,17 +56,16 @@
 - (NSInteger)getCreditCount;
 - (NSInteger)getCreditCountForBucket:(NSString *)bucket;
 
-- (void)setActionTotalCount:(NSString *)action withCount:(NSInteger)count;
-- (void)setActionUniqueCount:(NSString *)action withCount:(NSInteger)count;
-- (NSInteger)getActionTotalCount:(NSString *)action;
-- (NSInteger)getActionUniqueCount:(NSString *)action;
-
 - (void)updateBranchViewCount:(NSString *)branchViewID;
 - (NSInteger)getBranchViewCount:(NSString *)branchViewID;
 
 - (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value;
 - (NSMutableDictionary *)requestMetadataDictionary;
 
+- (void)addInstrumentationDictionaryKey:(NSString *)key value:(NSString *)value;
+- (NSMutableDictionary *)instrumentationDictionary;
+- (void)clearInstrumentationDictionary;
+
 - (void)log:(NSString *)filename line:(int)line message:(NSString *)format, ...;
 - (void)logWarning:(NSString *)message;
 @end

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -18,7 +18,6 @@
 
 NSString * const BRANCH_PREFS_FILE = @"BNCPreferences";
 
-NSString * const BRANCH_PREFS_KEY_APP_KEY = @"bnc_app_key";
 NSString * const BRANCH_PREFS_KEY_APP_VERSION = @"bnc_app_version";
 NSString * const BRANCH_PREFS_KEY_LAST_RUN_BRANCH_KEY = @"bnc_last_run_branch_key";
 NSString * const BRANCH_PREFS_KEY_LAST_STRONG_MATCH_DATE = @"bnc_strong_match_created_date";
@@ -33,17 +32,12 @@
 NSString * const BRANCH_PREFS_KEY_SESSION_PARAMS = @"bnc_session_params";
 NSString * const BRANCH_PREFS_KEY_INSTALL_PARAMS = @"bnc_install_params";
 NSString * const BRANCH_PREFS_KEY_USER_URL = @"bnc_user_url";
-NSString * const BRANCH_PREFS_KEY_IS_REFERRABLE = @"bnc_is_referrable";
 NSString * const BRANCH_PREFS_KEY_BRANCH_UNIVERSAL_LINK_DOMAINS = @"branch_universal_link_domains";
 NSString * const BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI = @"external_intent_uri";
 
 NSString * const BRANCH_PREFS_KEY_CREDITS = @"bnc_credits";
 NSString * const BRANCH_PREFS_KEY_CREDIT_BASE = @"bnc_credit_base_";
 
-NSString * const BRANCH_PREFS_KEY_COUNTS = @"bnc_counts";
-NSString * const BRANCH_PREFS_KEY_TOTAL_BASE = @"bnc_total_base_";
-NSString * const BRANCH_PREFS_KEY_UNIQUE_BASE = @"bnc_unique_base_";
-
 NSString * const BRANCH_PREFS_KEY_BRANCH_VIEW_USAGE_CNT = @"bnc_branch_view_usage_cnt_";
 
 // The name of this key was specified in the account-creation API integration
@@ -52,17 +46,16 @@
 @interface BNCPreferenceHelper ()
 
 @property (strong, nonatomic) NSMutableDictionary *persistenceDict;
-@property (strong, nonatomic) NSMutableDictionary *countsDictionary;
 @property (strong, nonatomic) NSMutableDictionary *creditsDictionary;
 @property (strong, nonatomic) NSMutableDictionary *requestMetadataDictionary;
+@property (strong, nonatomic) NSMutableDictionary *instrumentationDictionary;
 @property (assign, nonatomic) BOOL isUsingLiveKey;
 
 @end
 
 @implementation BNCPreferenceHelper
 
 @synthesize branchKey = _branchKey,
-            appKey = _appKey,
             lastRunBranchKey = _lastRunBranchKey,
             appVersion = _appVersion,
             deviceFingerprintID = _deviceFingerprintID,
@@ -76,7 +69,6 @@ @implementation BNCPreferenceHelper
             installParams = _installParams,
             universalLinkUrl = _universalLinkUrl,
             externalIntentURI = _externalIntentURI,
-            isReferrable = _isReferrable,
             isDebug = _isDebug,
             shouldWaitForInit = _shouldWaitForInit,
             suppressWarningLogs = _suppressWarningLogs,
@@ -85,7 +77,8 @@ @implementation BNCPreferenceHelper
             timeout = _timeout,
             lastStrongMatchDate = _lastStrongMatchDate,
             checkedFacebookAppLinks = _checkedFacebookAppLinks,
-            requestMetadataDictionary = _requestMetadataDictionary;
+            requestMetadataDictionary = _requestMetadataDictionary,
+            instrumentationDictionary = _instrumentationDictionary;
 
 + (BNCPreferenceHelper *)preferenceHelper {
     static BNCPreferenceHelper *preferenceHelper;
@@ -106,8 +99,6 @@ - (id)init {
 
         _isDebug = NO;
         _suppressWarningLogs = NO;
-        _explicitlyRequestedReferrable = NO;
-        _isReferrable = [self readBoolFromDefaults:BRANCH_PREFS_KEY_IS_REFERRABLE];
     }
 
     return self;
@@ -162,24 +153,11 @@ - (NSString *)getAPIURL:(NSString *) endpoint {
     return [[self getAPIBaseURL] stringByAppendingString:endpoint];
 }
 
-#pragma mark - Preference Storage
-
-- (NSString *)appKey {
-    if (!_appKey) {
-        _appKey = [[[NSBundle mainBundle] infoDictionary] objectForKey:BRANCH_PREFS_KEY_APP_KEY];
-    }
-    
-    return _appKey;
-}
-
-- (void)setAppKey:(NSString *)appKey {
-    NSLog(@"Usage of App Key is deprecated, please move toward using a Branch key");
-    
-    if (![_appKey isEqualToString:appKey]) {
-        _appKey = appKey;
-        [self writeObjectToDefaults:BRANCH_PREFS_KEY_APP_KEY value:appKey];
-    }
+- (NSString *)getEndpointFromURL:(NSString *)url {
+    NSUInteger index = BNC_API_BASE_URL.length;
+    return [url substringFromIndex:index];
 }
+#pragma mark - Preference Storage
 
 - (NSString *)getBranchKey:(BOOL)isLive {
     // Already loaded a key, and it's the same state (live/test)
@@ -448,29 +426,8 @@ - (void)setCheckedFacebookAppLinks:(BOOL)checked {
     [self writeBoolToDefaults:BRANCH_PREFS_KEY_CHECKED_FACEBOOK_APP_LINKS value:checked];
 }
 
-- (BOOL)isReferrable {
-    BOOL hasIdentity = self.identityID != nil;
-    
-    // If referrable is set, but they already have an identity, they should only
-    // still be referrable if the dev has explicitly set always referrable.
-    if (_isReferrable && hasIdentity) {
-        return _explicitlyRequestedReferrable;
-    }
-    
-    // If not referrable, or no identity yet, whatever isReferrable has is fine to return.
-    return _isReferrable;
-}
-
-- (void)setIsReferrable:(BOOL)isReferrable {
-    if (_isReferrable != isReferrable) {
-        _isReferrable = isReferrable;
-        [self writeBoolToDefaults:BRANCH_PREFS_KEY_IS_REFERRABLE value:isReferrable];
-    }
-}
-
 - (void)clearUserCreditsAndCounts {
     self.creditsDictionary = [[NSMutableDictionary alloc] init];
-    self.countsDictionary = [[NSMutableDictionary alloc] init];
 }
 
 - (id)getBranchUniversalLinkDomains {
@@ -496,6 +453,26 @@ - (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value {
     }
 }
 
+- (NSMutableDictionary *)instrumentationDictionary {
+    if (!_instrumentationDictionary) {
+        _instrumentationDictionary = [NSMutableDictionary dictionary];
+    }
+    return _instrumentationDictionary;
+}
+
+- (void)addInstrumentationDictionaryKey:(NSString *)key value:(NSString *)value {
+    if (key && value) {
+        [self.instrumentationDictionary setObject:value forKey:key];
+    }
+}
+
+- (void)clearInstrumentationDictionary {
+    NSArray *keys = [_instrumentationDictionary allKeys];
+    for (int i = 0 ; i < [keys count]; i++) {
+        [_instrumentationDictionary removeObjectForKey:keys[i]];
+    }
+}
+
 #pragma mark - Credit Storage
 
 - (NSMutableDictionary *)creditsDictionary {
@@ -552,38 +529,6 @@ - (void)clearUserCredits {
 
 #pragma mark - Count Storage
 
-- (NSMutableDictionary *)countsDictionary {
-    if (!_countsDictionary) {
-        _countsDictionary = [[self readObjectFromDefaults:BRANCH_PREFS_KEY_COUNTS] mutableCopy];
-        
-        if (!_countsDictionary) {
-            _countsDictionary = [[NSMutableDictionary alloc] init];
-        }
-    }
-    
-    return _countsDictionary;
-}
-
-- (void)setActionTotalCount:(NSString *)action withCount:(NSInteger)count {
-    self.countsDictionary[[BRANCH_PREFS_KEY_TOTAL_BASE stringByAppendingString:action]] = @(count);
-    
-    [self writeObjectToDefaults:BRANCH_PREFS_KEY_COUNTS value:self.countsDictionary];
-}
-
-- (void)setActionUniqueCount:(NSString *)action withCount:(NSInteger)count {
-    self.countsDictionary[[BRANCH_PREFS_KEY_UNIQUE_BASE stringByAppendingString:action]] = @(count);
-
-    [self writeObjectToDefaults:BRANCH_PREFS_KEY_COUNTS value:self.countsDictionary];
-}
-
-- (NSInteger)getActionTotalCount:(NSString *)action {
-    return [self.countsDictionary[[BRANCH_PREFS_KEY_TOTAL_BASE stringByAppendingString:action]] integerValue];
-}
-
-- (NSInteger)getActionUniqueCount:(NSString *)action {
-    return [self.countsDictionary[[BRANCH_PREFS_KEY_UNIQUE_BASE stringByAppendingString:action]] integerValue];
-}
-
 - (void)updateBranchViewCount:(NSString *)branchViewID {
     NSInteger currentCount = [self getBranchViewCount:branchViewID] + 1;
     [self writeObjectToDefaults:[BRANCH_PREFS_KEY_BRANCH_VIEW_USAGE_CNT stringByAppendingString:branchViewID] value:@(currentCount)];

Branch-SDK/Branch-SDK/BNCServerInterface.h

@@ -12,11 +12,6 @@
 
 typedef void (^BNCServerCallback)(BNCServerResponse *response, NSError *error);
 
-static NSString *REQ_TAG_DEBUG_CONNECT = @"t_debug_connect";
-static NSString *REQ_TAG_DEBUG_LOG = @"t_debug_log";
-static NSString *REQ_TAG_DEBUG_SCREEN = @"t_debug_screen";
-static NSString *REQ_TAG_DEBUG_DISCONNECT = @"t_debug_disconnect";
-
 @interface BNCServerInterface : NSObject
 
 @property (strong, nonatomic) BNCPreferenceHelper *preferenceHelper;

Branch-SDK/Branch-SDK/BNCServerInterface.m

@@ -13,6 +13,9 @@
 #import "BranchConstants.h"
 #import "BNCDeviceInfo.h"
 
+NSDate *startTime;
+NSString *requestEndpoint;
+
 void (^NSURLSessionCompletionHandler) (NSData *data, NSURLResponse *response, NSError *error);
 void (^NSURLConnectionCompletionHandler) (NSURLResponse *response, NSData *responseData, NSError *error);
 
@@ -59,6 +62,10 @@ - (void)postRequest:(NSDictionary *)post url:(NSString *)url key:(NSString *)key
 - (void)postRequest:(NSDictionary *)post url:(NSString *)url retryNumber:(NSInteger)retryNumber key:(NSString *)key log:(BOOL)log callback:(BNCServerCallback)callback {
     NSDictionary *extendedParams = [self updateDeviceInfoToParams:post];
     NSURLRequest *request = [self preparePostRequest:extendedParams url:url key:key retryNumber:retryNumber log:log];
+    
+    // Instrumentation metrics
+    requestEndpoint = [self.preferenceHelper getEndpointFromURL:url];
+    startTime = [NSDate date];
 
     [self genericHTTPRequest:request retryNumber:retryNumber log:log callback:callback retryHandler:^NSURLRequest *(NSInteger lastRetryNumber) {
         return [self preparePostRequest:post url:url key:key retryNumber:++lastRetryNumber log:log];
@@ -118,7 +125,11 @@ - (void)genericHTTPRequest:(NSURLRequest *)request retryNumber:(NSInteger)retryN
                 error = [NSError errorWithDomain:BNCErrorDomain code:BNCDuplicateResourceError userInfo:@{ NSLocalizedDescriptionKey: @"A resource with this identifier already exists" }];
             }
             else if (status >= 400) {
-                NSString *errorString = [serverResponse.data objectForKey:@"error"] ?: @"The request was invalid.";
+                NSString *errorString = @"The request was invalid.";
+                
+                if ([serverResponse.data objectForKey:@"error"] && [[serverResponse.data objectForKey:@"error"] isKindOfClass:[NSString class]]) {
+                    errorString = [serverResponse.data objectForKey:@"error"];
+                }
 
                 error = [NSError errorWithDomain:BNCErrorDomain code:BNCBadRequestError userInfo:@{ NSLocalizedDescriptionKey: errorString }];
             }
@@ -220,19 +231,16 @@ - (NSDictionary *)prepareParamDict:(NSDictionary *)params key:(NSString *)key re
     [fullParamDict addEntriesFromDictionary:params];
     fullParamDict[@"sdk"] = [NSString stringWithFormat:@"ios%@", SDK_VERSION];
     fullParamDict[@"retryNumber"] = @(retryNumber);
-    
+    fullParamDict[@"branch_key"] = key;
+
     NSMutableDictionary *metadata = [[NSMutableDictionary alloc] init];
     [metadata addEntriesFromDictionary:self.preferenceHelper.requestMetadataDictionary];
     [metadata addEntriesFromDictionary:fullParamDict[BRANCH_REQUEST_KEY_STATE]];
     fullParamDict[BRANCH_REQUEST_KEY_STATE] = metadata;
-    
-    if ([key hasPrefix:@"key_"]) {
-        fullParamDict[@"branch_key"] = key;
-    }
-    else {
-        fullParamDict[@"app_id"] = key;
+    if (self.preferenceHelper.instrumentationDictionary.count) {
+        fullParamDict[BRANCH_REQUEST_KEY_INSTRUMENTATION] = self.preferenceHelper.instrumentationDictionary;
     }
-    
+   
     return fullParamDict;
 }
 
@@ -252,9 +260,18 @@ - (BNCServerResponse *)processServerResponse:(NSURLResponse *)response data:(NSD
         [self.preferenceHelper log:FILE_NAME line:LINE_NUM message:@"returned = %@", serverResponse];
     }
 
+    [self collectInstrumentationMetrics];
     return serverResponse;
 }
 
+- (void) collectInstrumentationMetrics {
+    // multiplying by negative because startTime happened in the past
+    NSTimeInterval elapsedTime = [startTime timeIntervalSinceNow] * -1000.0;
+    NSString *lastRoundTripTime = [[NSNumber numberWithDouble:floor(elapsedTime)] stringValue];
+    NSString * brttKey = [NSString stringWithFormat:@"%@-brtt", requestEndpoint];
+    [self.preferenceHelper clearInstrumentationDictionary];
+    [self.preferenceHelper addInstrumentationDictionaryKey:brttKey value:lastRoundTripTime];
+}
 - (void)updateDeviceInfoToMutableDictionary:(NSMutableDictionary *)dict {
     BNCDeviceInfo *deviceInfo  = [BNCDeviceInfo getInstance];
 

Branch-SDK/Branch-SDK/BNCStrongMatchHelper.m

@@ -100,12 +100,7 @@ - (void)presentSafariVCWithBranchKey:(NSString *)branchKey {
     }
 
     if (branchKey) {
-        if ([branchKey hasPrefix:@"key_"]) {
-            [urlString appendFormat:@"&branch_key=%@", branchKey];
-        }
-        else {
-            [urlString appendFormat:@"&app_id=%@", branchKey];
-        }
+        [urlString appendFormat:@"&branch_key=%@", branchKey];
     }
 
     [urlString appendFormat:@"&sdk=ios%@", SDK_VERSION];

Branch-SDK/Branch-SDK/BNCSystemObserver.m

@@ -27,6 +27,10 @@ + (NSString *)getUniqueHardwareId:(BOOL *)isReal isDebug:(BOOL)debug andType:(NS
         SEL advertisingIdentifierSelector = NSSelectorFromString(@"advertisingIdentifier");
         NSUUID *uuid = ((NSUUID* (*)(id, SEL))[sharedManager methodForSelector:advertisingIdentifierSelector])(sharedManager, advertisingIdentifierSelector);
         uid = [uuid UUIDString];
+        // limit ad tracking is enabled. iOS 10+
+        if ([uid isEqualToString:@"00000000-0000-0000-0000-000000000000"]) {
+            uid = nil;
+        }
         *type = @"idfa";
     }