Configurable API endpoint (#488)

* Initial testing

* Rewrite ApiConfig
Persist api host changes
Add unit test for changing api host

* Rename servlet to path
Fix tests

* Update socket host and reconnect

* Remove old files

* Clean up

* Move userId and deviceId to User

* Move params to constants

* rename dispatch once

* small fixes

* Make the host part of the network operation
Small fixes

* Remove unused

* Prevent retry loop

Author: nzagorchev

LeanplumSDK/LeanplumSDK.xcodeproj/project.pbxproj

@@ -33,7 +33,6 @@
 #import "LPMessageTemplates.h"
 #import "LPRequestFactory.h"
 #import "LPRequestSender.h"
-#import "LPAPIConfig.h"
 #import "LPCountAggregator.h"
 
 #import <objc/runtime.h>

LeanplumSDK/LeanplumSDK/Classes/Features/Actions/LPActionManager.m

@@ -34,9 +34,9 @@
 #import "LPUtils.h"
 #import "LPRequestFactory.h"
 #import "LPRequestSender.h"
-#import "LPAPIConfig.h"
 #import "LPCountAggregator.h"
 #import "LPFileTransferManager.h"
+#import <Leanplum/Leanplum-Swift.h>
 
 @interface LPVarCache()
 @property (strong, nonatomic) NSRegularExpression *varNameRegex;
@@ -431,10 +431,10 @@ - (void)loadDiffs
             BOOL loggingEnabled = [unarchiver decodeBoolForKey:LP_KEY_LOGGING_ENABLED];
             localCaps = [unarchiver decodeObjectForKey:LEANPLUM_DEFAULTS_LOCAL_CAPS_KEY];
             if (deviceId) {
-                [[LPAPIConfig sharedConfig] setDeviceId:deviceId];
+                [[Leanplum user] setDeviceId:deviceId];
             }
             if (userId) {
-                [[LPAPIConfig sharedConfig] setUserId:userId];
+                [[Leanplum user] setUserId:userId];
             }
             if (loggingEnabled) {
                 [LPConstantsState sharedState].loggingEnabled = YES;
@@ -476,8 +476,8 @@ - (void)saveDiffs
         [archiver encodeObject:self.variantDebugInfo forKey:LP_KEY_VARIANT_DEBUG_INFO];
         [archiver encodeObject:self.regions forKey:LP_KEY_REGIONS];
         [archiver encodeObject:[LPConstantsState sharedState].sdkVersion forKey:LP_PARAM_SDK_VERSION];
-        [archiver encodeObject:[LPAPIConfig sharedConfig].deviceId forKey:LP_PARAM_DEVICE_ID];
-        [archiver encodeObject:[LPAPIConfig sharedConfig].userId forKey:LP_PARAM_USER_ID];
+        [archiver encodeObject:[[Leanplum user] deviceId] forKey:LP_PARAM_DEVICE_ID];
+        [archiver encodeObject:[[Leanplum user] userId] forKey:LP_PARAM_USER_ID];
         [archiver encodeBool:[LPConstantsState sharedState].loggingEnabled forKey:LP_KEY_LOGGING_ENABLED];
         [archiver encodeObject:self.varsJson forKey:LEANPLUM_DEFAULTS_VARS_JSON_KEY];
         [archiver encodeObject:self.varsSignature forKey:LEANPLUM_DEFAULTS_VARS_SIGNATURE_KEY];
@@ -740,7 +740,7 @@ - (NSMutableDictionary *)userAttributes
 {
     if (!_userAttributes) {
         @try {
-            NSString *token = [[LPAPIConfig sharedConfig] token];
+            NSString *token = [[ApiConfig shared] token];
             if (token) {
                 NSData *encryptedValue = [[NSUserDefaults standardUserDefaults] dataForKey:LEANPLUM_DEFAULTS_ATTRIBUTES_KEY];
                 if (encryptedValue) {

LeanplumSDK/LeanplumSDK/Classes/Features/Variables/LPVarCache.m

@@ -70,11 +70,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 NS_SWIFT_NAME(Leanplum.Constants)
 @interface LPConstantsState : NSObject {
-    NSString *_apiHostName;
-    NSString *_apiServlet;
-    BOOL _apiSSL;
-    NSString *_socketHost;
-    int _socketPort;
     int _networkTimeoutSeconds;
     int _networkTimeoutSecondsForDownloads;
     int _syncNetworkTimeoutSeconds;
@@ -89,16 +84,11 @@ NS_SWIFT_NAME(Leanplum.Constants)
     int _userCodeBlocks;
 }
 
-@property(strong, nonatomic) NSString *apiHostName;
-@property(strong, nonatomic) NSString *socketHost;
-@property(assign, nonatomic) int socketPort;
-@property(assign, nonatomic) BOOL apiSSL;
 @property(assign, nonatomic) int networkTimeoutSeconds;
 @property(assign, nonatomic) int networkTimeoutSecondsForDownloads;
 @property(assign, nonatomic) int syncNetworkTimeoutSeconds;
 @property(assign, nonatomic) BOOL isDevelopmentModeEnabled;
 @property(assign, nonatomic) BOOL loggingEnabled;
-@property(strong, nonatomic) NSString *apiServlet;
 @property(assign, nonatomic) BOOL isTestMode;
 @property(assign, nonatomic) BOOL isInPermanentFailureState;
 @property(strong, nonatomic) NSString *client;
@@ -189,6 +179,9 @@ OBJC_EXPORT NSString *LP_PARAM_INBOX_MESSAGE_ID;
 OBJC_EXPORT NSString *LP_PARAM_RICH_PUSH_ENABLED;
 OBJC_EXPORT NSString *LP_PARAM_UUID;
 OBJC_EXPORT NSString *LP_PARAM_CURRENCY_CODE;
+OBJC_EXPORT NSString *LP_PARAM_API_HOST;
+OBJC_EXPORT NSString *LP_PARAM_API_PATH;
+OBJC_EXPORT NSString *LP_PARAM_DEV_SERVER_HOST;
 
 OBJC_EXPORT NSString *LP_KEY_VARS;
 OBJC_EXPORT NSString *LP_KEY_VARS_SIGNATURE;

LeanplumSDK/LeanplumSDK/Classes/Internal/LPConstants.h

@@ -40,11 +40,6 @@ + (LPConstantsState *)sharedState {
 
 - (id)init {
     if (self = [super init]) {
-        _apiHostName = @"api.leanplum.com";
-        _apiServlet = @"api";
-        _apiSSL = YES;
-        _socketHost = @"dev.leanplum.com";
-        _socketPort = 443;
         _networkTimeoutSeconds = 10;
         _networkTimeoutSecondsForDownloads = 15;
         _syncNetworkTimeoutSeconds = 5;
@@ -145,6 +140,9 @@ - (id)init {
 NSString *LP_PARAM_RICH_PUSH_ENABLED = @"richPushEnabled";
 NSString *LP_PARAM_UUID = @"uuid";
 NSString *LP_PARAM_CURRENCY_CODE = @"currencyCode";
+NSString *LP_PARAM_API_HOST = @"apiHost";
+NSString *LP_PARAM_API_PATH = @"apiPath";
+NSString *LP_PARAM_DEV_SERVER_HOST = @"devServerHost";
 
 NSString *LP_KEY_REASON = @"reason";
 NSString *LP_KEY_STACK_TRACE = @"stackTrace";
@@ -216,9 +214,6 @@ - (id)init {
 NSString *LP_VALUE_SDK_COUNT = @"sdkCount";
 NSString *LP_VALUE_SDK_START_LATENCY = @"sdkStartLatency";
 
-NSString *LP_KEYCHAIN_SERVICE_NAME = @"com.leanplum.storage";
-NSString *LP_KEYCHAIN_USERNAME = @"defaultUser";
-
 NSString *LP_PATH_DOCUMENTS = @"Leanplum_Resources";
 NSString *LP_PATH_BUNDLE = @"Leanplum_Bundle";
 NSString *LP_SWIZZLING_ENABLED = @"LeanplumSwizzlingEnabled";

LeanplumSDK/LeanplumSDK/Classes/Internal/LPConstants.m

@@ -46,7 +46,6 @@
 #import "LPRequestFactory.h"
 #import "LPFileTransferManager.h"
 #import "LPRequestSender.h"
-#import "LPAPIConfig.h"
 #import "LPOperationQueue.h"
 #import "LPDeferMessageManager.h"
 #include <sys/sysctl.h>
@@ -132,6 +131,16 @@ + (NotificationsManager*)notificationsManager
     return managerInstance;
 }
 
++ (User*)user
+{
+    static User *userInstance = nil;
+    static dispatch_once_t onceUserInstanceToken;
+    dispatch_once(&onceUserInstanceToken, ^{
+        userInstance = [User new];
+    });
+    return userInstance;
+}
+
 + (void)throwError:(NSString *)reason
 {
     if ([LPConstantsState sharedState].isDevelopmentModeEnabled) {
@@ -153,24 +162,24 @@ + (void)_initPush
 }
 
 + (void)setApiHostName:(NSString *)hostName
-       withServletName:(NSString *)servletName
+              withPath:(NSString *)apiPath
               usingSsl:(BOOL)ssl
 {
     if ([LPUtils isNullOrEmpty:hostName]) {
-        [self throwError:@"[Leanplum setApiHostName:withServletName:usingSsl:] Empty hostname "
+        [self throwError:@"[Leanplum setApiHostName:withPath:usingSsl:] Empty hostname "
          @"parameter provided."];
         return;
     }
-    if ([LPUtils isNullOrEmpty:servletName]) {
-        [self throwError:@"[Leanplum setApiHostName:withServletName:usingSsl:] Empty servletName "
+    if ([LPUtils isNullOrEmpty:apiPath]) {
+        [self throwError:@"[Leanplum setApiHostName:withPath:usingSsl:] Empty apiPath "
          @"parameter provided."];
         return;
     }
 
     LP_TRY
-    [LPConstantsState sharedState].apiHostName = hostName;
-    [LPConstantsState sharedState].apiServlet = servletName;
-    [LPConstantsState sharedState].apiSSL = ssl;
+    [ApiConfig shared].apiHostName = hostName;
+    [ApiConfig shared].apiPath = apiPath;
+    [ApiConfig shared].apiSSL = ssl;
     LP_END_TRY
 }
 
@@ -182,8 +191,12 @@ + (void)setSocketHostName:(NSString *)hostName withPortNumber:(int)port
         return;
     }
 
-    [LPConstantsState sharedState].socketHost = hostName;
-    [LPConstantsState sharedState].socketPort = port;
+    if (![[ApiConfig shared].socketHost isEqualToString:hostName] ||
+        [ApiConfig shared].socketPort != port) {
+        [ApiConfig shared].socketHost = hostName;
+        [ApiConfig shared].socketPort = port;
+        [[LeanplumSocket sharedSocket] connectToNewSocket];
+    }
 }
 
 + (void)setClient:(NSString *)client withVersion:(NSString *)version
@@ -325,7 +338,7 @@ + (void)setAppId:(NSString *)appId withDevelopmentKey:(NSString *)accessKey
 
     LP_TRY
     [LPConstantsState sharedState].isDevelopmentModeEnabled = YES;
-    [[LPAPIConfig sharedConfig] setAppId:appId withAccessKey:accessKey];
+    [[ApiConfig shared] setAppId:appId accessKey:accessKey];
     LP_END_TRY
 }
 
@@ -350,7 +363,7 @@ + (void)setAppId:(NSString *)appId withProductionKey:(NSString *)accessKey
 
     LP_TRY
     [LPConstantsState sharedState].isDevelopmentModeEnabled = NO;
-    [[LPAPIConfig sharedConfig] setAppId:appId withAccessKey:accessKey];
+    [[ApiConfig shared] setAppId:appId accessKey:accessKey];
     LP_END_TRY
 }
 
@@ -377,10 +390,10 @@ + (void)setDeviceId:(NSString *)deviceId
     LP_TRY
     // If Leanplum start has been called already, changing the deviceId results in a new device
     // Ensure the id is updated and the new device has all attributes set
-    if ([LPInternalState sharedState].hasStarted && ![[LPAPIConfig sharedConfig].deviceId isEqualToString:deviceId]) {
+    if ([LPInternalState sharedState].hasStarted && ![[Leanplum user].deviceId isEqualToString:deviceId]) {
         [self setDeviceIdInternal:deviceId];
     } else {
-       [[LPAPIConfig sharedConfig] setDeviceId:deviceId];
+       [[Leanplum user] setDeviceId:deviceId];
     }
     LP_END_TRY
 }
@@ -398,7 +411,7 @@ +(void)setDeviceIdInternal:(NSString *)deviceId
         LP_PARAM_DEVICE_ID: deviceId
     } mutableCopy];
 
-    NSString *pushToken = [Leanplum notificationsManager].pushToken;
+    NSString *pushToken = [Leanplum user].pushToken;
     if (pushToken) {
         params[LP_PARAM_DEVICE_PUSH_TOKEN] = pushToken;
     }
@@ -411,20 +424,19 @@ +(void)setDeviceIdInternal:(NSString *)deviceId
         }
 
         //Clean UserDefaults before changing deviceId because it is used to generate key
-        [Leanplum notificationsManager].pushToken = nil;
+        [Leanplum user].pushToken = nil;
         [[Leanplum notificationsManager] removeNotificationSettings];
 
-        // Change the LPAPIConfig after getting the push token and settings
+        // Change the User deviceId after getting the push token and settings
         // and after cleaning UserDefaults
-        // The LPAPIConfig value is used in retrieving them
-        [[LPAPIConfig sharedConfig] setDeviceId:deviceId];
+        // The User userId and deviceId are used in retrieving them
+        [[Leanplum user] setDeviceId:deviceId];
         [[LPVarCache sharedCache] saveDiffs];
 
         // Update the token and settings now that the key is different
-        [Leanplum notificationsManager].pushToken = pushToken;
+        [Leanplum user].pushToken = pushToken;
         [[Leanplum notificationsManager] saveNotificationSettings:settings];
 
-        
         LPRequest *request = [LPRequestFactory setDeviceAttributesWithParams:params];
         [[LPRequestSender sharedInstance] send:request];
     }];
@@ -783,7 +795,7 @@ + (void)startWithUserId:(NSString *)userId
 {
     [[Leanplum notificationsManager].proxy setupNotificationSwizzling];
 
-    if ([LPAPIConfig sharedConfig].appId == nil) {
+    if ([ApiConfig shared].appId == nil) {
         [self throwError:@"Please provide your app ID using one of the [Leanplum setAppId:] "
          @"methods."];
         return;
@@ -852,7 +864,6 @@ + (void)startWithUserId:(NSString *)userId
     });
     state.actionManager = [LPActionManager sharedManager];
 
-    [[LPAPIConfig sharedConfig] loadToken];
     [[LPVarCache sharedCache] setSilent:YES];
     [[LPVarCache sharedCache] loadDiffs];
     [[LPVarCache sharedCache] setSilent:NO];
@@ -871,7 +882,7 @@ + (void)startWithUserId:(NSString *)userId
     }];
 
     // Set device ID.
-    NSString *deviceId = [LPAPIConfig sharedConfig].deviceId;
+    NSString *deviceId = [Leanplum user].deviceId;
     // This is the device ID set when the MAC address is used on iOS 7.
     // This is to allow apps who upgrade to the new ID to forget the old one.
     if ([deviceId isEqualToString:@"0f607264fc6318a92b9e13c65db7cd3c"]) {
@@ -882,17 +893,17 @@ + (void)startWithUserId:(NSString *)userId
         if (!deviceId) {
             deviceId = [[UIDevice currentDevice] leanplum_uniqueGlobalDeviceIdentifier];
         }
-        [[LPAPIConfig sharedConfig] setDeviceId:deviceId];
+        [[Leanplum user] setDeviceId:deviceId];
     }
 
     // Set user ID.
     if (!userId) {
-        userId = [LPAPIConfig sharedConfig].userId;
+        userId = [Leanplum user].userId;
         if (!userId) {
-            userId = [LPAPIConfig sharedConfig].deviceId;
+            userId = [Leanplum user].deviceId;
         }
     }
-    [[LPAPIConfig sharedConfig] setUserId:userId];
+    [[Leanplum user] setUserId:userId];
 
     // Setup parameters.
     NSString *versionName = [self appVersion];
@@ -944,7 +955,7 @@ + (void)startWithUserId:(NSString *)userId
     params[LP_PARAM_INBOX_MESSAGES] = [self.inbox messagesIds];
 
     // Push token.
-    NSString *pushToken = [[Leanplum notificationsManager] pushToken];
+    NSString *pushToken = [[Leanplum user] pushToken];
     if (pushToken) {
         params[LP_PARAM_DEVICE_PUSH_TOKEN] = pushToken;
     }
@@ -971,8 +982,9 @@ + (void)startWithUserId:(NSString *)userId
         NSString *varsJson = [LPJSON stringFromJSON:[response valueForKey:LP_KEY_VARS]];
         NSString *varsSignature = response[LP_KEY_VARS_SIGNATURE];
         NSArray *localCaps = response[LP_KEY_LOCAL_CAPS];
-        [[LPAPIConfig sharedConfig] setToken:token];
-        [[LPAPIConfig sharedConfig] saveToken];
+        if (token) {
+            [[ApiConfig shared] setToken:token];
+        }
         [[LPVarCache sharedCache] applyVariableDiffs:values
                                             messages:messages
                                             variants:variants
@@ -1027,8 +1039,8 @@ + (void)startWithUserId:(NSString *)userId
             [[LPVarCache sharedCache] setDevModeValuesFromServer:valuesFromCode
                                     fileAttributes:fileAttributes
                                  actionDefinitions:actionDefinitions];
-            [[LeanplumSocket sharedSocket] connectToAppId:[LPAPIConfig sharedConfig].appId
-                                                 deviceId:[LPAPIConfig sharedConfig].deviceId];
+            [[LeanplumSocket sharedSocket] connectToAppId:[ApiConfig shared].appId
+                                                 deviceId:[Leanplum user].deviceId];
             if ([response[LP_KEY_IS_REGISTERED] boolValue]) {
                 [Leanplum onHasStartedAndRegisteredAsDeveloper];
             }
@@ -2206,13 +2218,13 @@ + (void)setUserIdInternal:(NSString *)userId withAttributes:(NSDictionary *)attr
 
     LPRequest *request = [LPRequestFactory setUserAttributesWithParams:@{
         LP_PARAM_USER_ATTRIBUTES: attributes ? [LPJSON stringFromJSON:attributes] : @"",
-        LP_PARAM_USER_ID: [LPAPIConfig sharedConfig].userId ?: @"",
+        LP_PARAM_USER_ID: [Leanplum user].userId ?: @"",
         LP_PARAM_NEW_USER_ID: userId ?: @""
     }];
     [[LPRequestSender sharedInstance] send:request];
 
     if (userId.length) {
-        [[LPAPIConfig sharedConfig] setUserId:userId];
+        [[Leanplum user] setUserId:userId];
         if ([LPInternalState sharedState].hasStarted) {
             [[LPVarCache sharedCache] saveDiffs];
         }
@@ -2648,7 +2660,7 @@ + (NSString *)deviceId
         [self throwError:@"[Leanplum start] must be called before calling deviceId"];
         return nil;
     }
-    return [LPAPIConfig sharedConfig].deviceId;
+    return [Leanplum user].deviceId;
     LP_END_TRY
     return nil;
 }
@@ -2660,7 +2672,7 @@ + (NSString *)userId
         [self throwError:@"[Leanplum start] must be called before calling userId"];
         return nil;
     }
-    return [LPAPIConfig sharedConfig].userId;
+    return [Leanplum user].userId;
     LP_END_TRY
     return nil;
 }

LeanplumSDK/LeanplumSDK/Classes/Internal/Leanplum.m

@@ -36,6 +36,7 @@ NS_ASSUME_NONNULL_BEGIN
 @class LeanplumSocket;
 @class LPRegisterDevice;
 @class NotificationsManager;
+@class User;
 
 /**
  * Keys for the plist file name
@@ -57,6 +58,8 @@ typedef void (^LeanplumStartIssuedBlock)(void);
 typedef void (^LeanplumEventsChangedBlock)(void);
 typedef void (^LeanplumHandledBlock)(BOOL success);
 
+@property (class, readonly) User* user;
+
 + (NotificationsManager*)notificationsManager;
 
 + (void)throwError:(NSString *)reason;