Add environments support to SDK with SDK key initialization (#264)

* iOS Environment refactor to use OPTLYDatafileConfig

Test Plan: all tests pass on iOS and tvOS.

Reviewers: ali, kelly.roach, thomas.zurkan

Differential Revision: https://phabricator.optimizely.com/D19924

* Add unit test for initializing with SDK and fix a typo.

* Undo disabling of MxP.

* projectConfigURLPath: declaration removed

* Improve initWithProjectId:withSDKKey:

* Use BOOL values YES/NO

* Add parentheses and formatting to improve code readability

* Add areNilOrEqual:y: and refactor isEqual: for code clarity

* Improved OPTLYDatafileConfig.m hash method

* NSString+OPTLYCategory.m+.h dropped in favor of adding static method to OPTLYManagerBase.m+.h

* Refer to 6 identical strings by SSOT OPTLY_DATAFILE_URL global

Author: mikeproeng37

OptimizelyDemoApp/AppDelegate.swift

@@ -36,7 +36,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
     // customizable settings
     let datafileName = "demoTestDatafile" // default parameter for initializing Optimizely from saved datafile
-    var projectId = "8182362857" // project name: X Mobile - Sample App
+    var projectId = "10657931863" // project name: X Mobile - Sample App
     var experimentKey = "background_experiment"
     var eventKey = "sample_conversion"
     let attributes = ["sample_attribute_key":"sample_attribute_value"]
@@ -73,12 +73,13 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // ---- Create the Datafile Manager ----
         let datafileManager = OPTLYDatafileManagerDefault.init{(builder) in
             // builder!.datafileFetchInterval = TimeInterval(self.datafileManagerDownloadInterval)
-            builder!.projectId = self.projectId
+            builder!.datafileConfig = OPTLYDatafileConfig(projectId: nil, withSDKKey:self.projectId)!;
         }
 
         // ---- Create the Manager ----
         let optimizelyManager = OPTLYManager.init {(builder) in
-            builder!.projectId = self.projectId
+            builder!.projectId = nil;
+            builder!.sdkKey = self.projectId
             builder!.datafileManager = datafileManager!
             builder!.eventDispatcher = eventDispatcher
         }
@@ -120,6 +121,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             })
 #endif
             let variation = optimizelyClient?.activate((self?.experimentKey)!, userId: (self?.userId)!, attributes: (self?.attributes))
+            
             self?.setRootViewController(optimizelyClient: optimizelyClient, bucketedVariation:variation)
         })
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m

@@ -167,10 +167,10 @@
 NSString *const OPTLYLoggerMessagesManagerErrorHandlerDoesNotConformToOPTLYErrorHandlerProtocol = @"[MANAGER] Error handler does not conform to the OPTLYErrorHandler protocol.";
 NSString *const OPTLYLoggerMessagesManagerEventDispatcherDoesNotConformToOPTLYEventDispatcherProtocol = @"[MANAGER] Event dispatcher does not conform to the OPTLYEventDispatcher protocol.";
 NSString *const OPTLYLoggerMessagesManagerLoggerDoesNotConformToOPTLYLoggerProtocol = @"[MANAGER] Logger does not conform to the OPTLYLogger protocol.";
-NSString *const OPTLYLoggerMessagesManagerMustBeInitializedWithProjectId = @"[MANAGER] An Optimizely Manager instance must be initialized with a project ID.";
+NSString *const OPTLYLoggerMessagesManagerMustBeInitializedWithProjectId = @"[MANAGER] An Optimizely Manager instance must be initialized with a project ID or SDK Key.";
 NSString *const OPTLYLoggerMessagesManagerProjectIdCannotBeEmptyString = @"[MANAGER] The project ID for the Optimizely Manager instance cannot be an empty string";
-NSString *const OPTLYLoggerMessagesManagerInit = @"[MANAGER] Initializing client for project %@.";
-NSString *const OPTLYLoggerMessagesManagerInitWithCallback = @"[MANAGER] Initializing client with callback for project %@.";
+NSString *const OPTLYLoggerMessagesManagerInit = @"[MANAGER] Initializing client for projectId %@ with SDK Key %@.";
+NSString *const OPTLYLoggerMessagesManagerInitWithCallback = @"[MANAGER] Initializing client with callback for projectId %@ with SDK Key %@.";
 NSString *const OPTLYLoggerMessagesManagerInitWithCallbackErrorDatafileDownload = @"[MANAGER] Error downloading datafile: %@.";
 NSString *const OPTLYLoggerMessagesManagerInitWithCallbackNoDatafileUpdates = @"[MANAGER] Not downloading new datafile — no updates have been made.";
 NSString *const OPTLYLoggerMessagesManagerBundledDataLoaded = @"[MANAGER] The bundled datafile was loaded.";

OptimizelySDKCore/OptimizelySDKCore/OPTLYNetworkService.h

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016-2017, Optimizely, Inc. and contributors                   *
+ * Copyright 2016-2018, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -30,24 +30,24 @@ NS_ASSUME_NONNULL_END
 /**
  * Download the project config file from remote server
  *
- * @param projectId The project ID of the datafile to download
+ * @param projectUrl The project URL of the datafile to download
  * @param backoffRetry Indicates if the exponential backoff retry should be enabled
  * @param completion The completion block of type OPTLYHTTPRequestManagerResponse
  */
-- (void)downloadProjectConfig:(nonnull NSString *)projectId
+- (void)downloadProjectConfig:(nonnull NSURL *)projectUrl
                  backoffRetry:(BOOL)backoffRetry
             completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion;
 
 /**
  * Download the project config file from remote server only if it
  * has been modified.
  *
- * @param projectId The project ID of the exponential the datafile to download
+ * @param projectURL The project URL of the datafile to download
  * @param backoffRetry Indicates if backoff retry should be enabled
  * @param lastModifiedDate The date the datafile was last modified
  * @param completion The completion block of type OPTLYHTTPRequestManagerResponse
  */
-- (void)downloadProjectConfig:(nonnull NSString *)projectId
+- (void)downloadProjectConfig:(nonnull NSURL *)projectURL
                  backoffRetry:(BOOL)backoffRetry
                  lastModified:(nonnull NSString *)lastModifiedDate
             completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion;
@@ -64,10 +64,4 @@ NS_ASSUME_NONNULL_END
                 toURL:(nonnull NSURL *)url
     completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion;
 
-/**
- * Returns the URL path for the datafile of a particular project.
- * @param projectId The project ID of the datafile whose URL path we are looking for.
- */
-+ (NSURL * _Nonnull)projectConfigURLPath:(nonnull NSString *)projectId;
-
 @end

OptimizelySDKCore/OptimizelySDKCore/OPTLYNetworkService.m

@@ -19,7 +19,6 @@
 
 // ---- Datafile Download URLs ----
 // TODO: Move this to the Datafile manager and parameterize the URL for the datafile download
-NSString * const OPTLYNetworkServiceCDNServerURL    = @"https://cdn.optimizely.com/json/";
 NSString * const OPTLYNetworkServiceS3ServerURL     = @"https://optimizely.s3.amazonaws.com/";
 
 // ---- The total backoff and retry interval is: pow(2, attempts) * interval ----
@@ -44,38 +43,35 @@ - (instancetype) init
     return self;
 }
 
-- (void)downloadProjectConfig:(nonnull NSString *)projectId
+- (void)downloadProjectConfig:(nonnull NSURL *)datafileConfigURL
                  backoffRetry:(BOOL)backoffRetry
                  lastModified:(nonnull NSString *)lastModifiedDate
             completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion
 {
-    NSURL *cdnConfigFilePathURL = [OPTLYNetworkService projectConfigURLPath:projectId];
     if (backoffRetry) {
         [self.requestManager GETIfModifiedSince:lastModifiedDate
-                                            url:cdnConfigFilePathURL
+                                            url:datafileConfigURL
                            backoffRetryInterval:OPTLYNetworkServiceDatafileDownloadMaxBackoffRetryTimeInterval_ms
                                         retries:OPTLYNetworkServiceDatafileDownloadMaxBackoffRetryAttempts
                               completionHandler:completion];
     } else {
         [self.requestManager GETIfModifiedSince:lastModifiedDate
-                                            url:cdnConfigFilePathURL
+                                            url:datafileConfigURL
                               completionHandler:completion];
     }
 }
 
-- (void)downloadProjectConfig:(NSString *)projectId
+- (void)downloadProjectConfig:(nonnull NSURL *)datafileConfigURL
                  backoffRetry:(BOOL)backoffRetry
             completionHandler:(OPTLYHTTPRequestManagerResponse)completion
 {
-    NSURL *cdnConfigFilePathURL = [OPTLYNetworkService projectConfigURLPath:projectId];
-    
     if (backoffRetry) {
         [self.requestManager GETWithBackoffRetryInterval:OPTLYNetworkServiceDatafileDownloadMaxBackoffRetryTimeInterval_ms
-                                                     url:cdnConfigFilePathURL
+                                                     url:datafileConfigURL
                                                  retries:OPTLYNetworkServiceDatafileDownloadMaxBackoffRetryAttempts
                                        completionHandler:completion];
     } else {
-        [self.requestManager GETWithURL:cdnConfigFilePathURL
+        [self.requestManager GETWithURL:datafileConfigURL
                              completion:completion];
     }
 }
@@ -98,14 +94,4 @@ - (void)dispatchEvent:(nonnull NSDictionary *)params
     }
 }
 
-# pragma mark - Helper Methods
-
-+ (NSURL *)projectConfigURLPath:(NSString *)projectId
-{
-    NSURL *cdnURL = [NSURL URLWithString:OPTLYNetworkServiceCDNServerURL];
-    NSString *filePath = [NSString stringWithFormat:@"%@%@.json", cdnURL.absoluteString, projectId];
-    return [NSURL URLWithString:filePath];
-}
-
-
 @end

OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYNetworkServiceTest.m

@@ -16,12 +16,12 @@
 
 #import <XCTest/XCTest.h>
 #import <OHHTTPStubs/OHHTTPStubs.h>
+#import <OptimizelySDKShared/OPTLYDatafileConfig.h>
 #import "OPTLYNetworkService.h"
 #import "OPTLYTestHelper.h"
 
 static NSString *const kDatafileVersion = @"3";
 
-static NSString *const kExpectedCDNURLTemplate = @"https://cdn.optimizely.com/json/%@.json";
 static NSString *const kDatamodelDatafileName = @"optimizely_6372300739";
 static NSString *const kLastModifiedDate = @"Mon, 28 Nov 2016 06:10:59 GMT";
 static NSString *const kProjectId = @"6372300739";
@@ -64,7 +64,9 @@ - (void)testDownloadProjectConfigRequestRetrievesProperDatafileVersion {
     __weak XCTestExpectation *expectation = [self expectationWithDescription:@"testDownloadProjectConfigRequestRetrievesProperDatafileVersion"];
     [self stub200Response];
 
-    [self.network downloadProjectConfig:kProjectId
+    NSString *filePath = [NSString stringWithFormat:OPTLY_DATAFILE_URL, kProjectId];
+    
+    [self.network downloadProjectConfig:[NSURL URLWithString:filePath]
                            backoffRetry:NO
                       completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
                           NSDictionary *datafile = [NSJSONSerialization JSONObjectWithData:data
@@ -81,8 +83,9 @@ - (void)testDownloadProjectConfigRequestRetrievesProperDatafileVersion {
 - (void)testDownloadProjectConfigWithLastModifiedRequestRetrievesProperDatafileVersion {
     __weak XCTestExpectation *expectation = [self expectationWithDescription:@"testDownloadProjectConfigWithLastModifiedRequestRetrievesProperDatafileVersion"];
     [self stub200Response];
-    
-    [self.network downloadProjectConfig:kProjectId
+    NSString *filePath = [NSString stringWithFormat:OPTLY_DATAFILE_URL, kProjectId];
+
+    [self.network downloadProjectConfig:[NSURL URLWithString:filePath]
                            backoffRetry:NO
                            lastModified:kLastModifiedDate
                       completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
@@ -96,19 +99,11 @@ - (void)testDownloadProjectConfigWithLastModifiedRequestRetrievesProperDatafileV
     [self waitForExpectationsWithTimeout:2 handler:nil];
 }
 
-- (void)testProjectConfigURLPathReturnsExpectedUrl {
-    NSString *expectedURLString = [NSString stringWithFormat:kExpectedCDNURLTemplate, kProjectId];
-    NSURL *expectedURL = [NSURL URLWithString:expectedURLString];
-    
-    NSURL *cdnURL = [OPTLYNetworkService projectConfigURLPath:kProjectId];
-    
-    XCTAssertEqualObjects(cdnURL, expectedURL, @"Unexpected CDN URL: %@", cdnURL);
-    
-}
-
 # pragma mark - Helper Methods
 - (id<OHHTTPStubsDescriptor>)stub200Response {
-    NSURL *hostURL = [NSURL URLWithString:OPTLYNetworkServiceCDNServerURL];
+    NSString *filePath = [NSString stringWithFormat:OPTLY_DATAFILE_URL, kProjectId];
+    
+     NSURL *hostURL = [NSURL URLWithString:filePath];
     NSString *hostName = [hostURL host];
 
     return [OHHTTPStubs stubRequestsPassingTest:^BOOL (NSURLRequest *request) {

OptimizelySDKDatafileManager/OptimizelySDKDatafileManager/OPTLYDatafileManager.h

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016, Optimizely, Inc. and contributors                        *
+ * Copyright 2016-2018, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -17,19 +17,23 @@
 #import <Foundation/Foundation.h>
 #ifdef UNIVERSAL
     #import "OPTLYDatafileManager.h"
+    #import "OPTLYDatafileConfig.h"
 #else
     #import <OptimizelySDKShared/OPTLYDatafileManagerBasic.h>
+    #import <OptimizelySDKShared/OPTLYDatafileConfig.h>
 #endif
+
 #import "OPTLYDatafileManagerBuilder.h"
 
+
 @protocol OPTLYDatafileManager, OPTLYErrorHandler, OPTLYLogger;
 
 @interface OPTLYDatafileManagerDefault : NSObject<OPTLYDatafileManager>
 
 /// The time interval to regularly fetch the datafile.
 @property (nonatomic, readonly) NSTimeInterval datafileFetchInterval;
 /// The project ID of the datafile this datafile manager will monitor
-@property (nonatomic, readonly, strong, nonnull) NSString *projectId;
+@property (nonatomic, readonly, strong, nonnull) OPTLYDatafileConfig *datafileConfig;
 /// The error handler to be used for the manager, client, and all subcomponents
 @property (nonatomic, readonly, strong, nullable) id<OPTLYErrorHandler> errorHandler;
 /// A logger for the OPTLYDatafileManager to log messages.