Merge pull request #930 from segmentio/migs647/remove-public-configuration

Deprecated configuration access and updated associated tests

Author: migs647

Analytics/Classes/SEGAnalytics.h

@@ -17,7 +17,7 @@ NS_SWIFT_NAME(Analytics)
 /**
  * Used by the analytics client to configure various options.
  */
-@property (nonatomic, strong, readonly) SEGAnalyticsConfiguration *configuration;
+@property (nullable, nonatomic, strong, readonly) SEGAnalyticsConfiguration *configuration DEPRECATED_MSG_ATTRIBUTE("One time use object");
 
 /**
  * Setup this analytics client instance.
@@ -218,9 +218,6 @@ NS_SWIFT_NAME(Analytics)
 /** Returns the registered device token of this device */
 - (NSString *)getDeviceToken;
 
-/** Returns the configuration used to create the analytics client. */
-- (SEGAnalyticsConfiguration *)configuration;
-
 @end
 
 NS_ASSUME_NONNULL_END

Analytics/Classes/SEGAnalytics.m

@@ -23,11 +23,10 @@
 @interface SEGAnalytics ()
 
 @property (nonatomic, assign) BOOL enabled;
-@property (nonatomic, strong) SEGAnalyticsConfiguration *configuration;
+@property (nonatomic, strong) SEGAnalyticsConfiguration *oneTimeConfiguration;
 @property (nonatomic, strong) SEGStoreKitTracker *storeKitTracker;
 @property (nonatomic, strong) SEGIntegrationsManager *integrationsManager;
 @property (nonatomic, strong) SEGMiddlewareRunner *runner;
-
 @end
 
 
@@ -46,7 +45,7 @@ - (instancetype)initWithConfiguration:(SEGAnalyticsConfiguration *)configuration
     NSCParameterAssert(configuration != nil);
 
     if (self = [self init]) {
-        self.configuration = configuration;
+        self.oneTimeConfiguration = configuration;
         self.enabled = YES;
 
         // In swift this would not have been OK... But hey.. It's objc
@@ -161,7 +160,7 @@ - (void)handleAppStateNotification:(NSNotification *)note
 
 - (void)_applicationDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
-    if (!self.configuration.trackApplicationLifecycleEvents) {
+    if (!self.oneTimeConfiguration.trackApplicationLifecycleEvents) {
         return;
     }
     // Previously SEGBuildKey was stored an integer. This was incorrect because the CFBundleVersion
@@ -218,7 +217,7 @@ - (void)_applicationDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 
 - (void)_applicationWillEnterForeground
 {
-    if (!self.configuration.trackApplicationLifecycleEvents) {
+    if (!self.oneTimeConfiguration.trackApplicationLifecycleEvents) {
         return;
     }
     NSString *currentVersion = [[NSBundle mainBundle] infoDictionary][@"CFBundleShortVersionString"];
@@ -234,7 +233,7 @@ - (void)_applicationWillEnterForeground
 
 - (void)_applicationDidEnterBackground
 {
-  if (!self.configuration.trackApplicationLifecycleEvents) {
+  if (!self.oneTimeConfiguration.trackApplicationLifecycleEvents) {
     return;
   }
   [self track: @"Application Backgrounded"];
@@ -248,6 +247,12 @@ - (NSString *)description
     return [NSString stringWithFormat:@"<%p:%@, %@>", self, [self class], [self dictionaryWithValuesForKeys:@[ @"configuration" ]]];
 }
 
+- (nullable SEGAnalyticsConfiguration *)configuration
+{
+    // Remove deprecated configuration on 4.2+
+    return nil;
+}
+
 #pragma mark - Identify
 
 - (void)identify:(NSString *)userId
@@ -389,7 +394,7 @@ - (void)trackPushNotification:(NSDictionary *)properties fromLaunch:(BOOL)launch
 
 - (void)receivedRemoteNotification:(NSDictionary *)userInfo
 {
-    if (self.configuration.trackPushNotifications) {
+    if (self.oneTimeConfiguration.trackPushNotifications) {
         [self trackPushNotification:userInfo fromLaunch:NO];
     }
     SEGRemoteNotificationPayload *payload = [[SEGRemoteNotificationPayload alloc] init];
@@ -427,7 +432,7 @@ - (void)continueUserActivity:(NSUserActivity *)activity
     payload.activity = activity;
     [self run:SEGEventTypeContinueUserActivity payload:payload];
 
-    if (!self.configuration.trackDeepLinks) {
+    if (!self.oneTimeConfiguration.trackDeepLinks) {
         return;
     }
 
@@ -442,7 +447,7 @@ - (void)continueUserActivity:(NSUserActivity *)activity
         properties[@"url"] = urlString;
         properties[@"title"] = activity.title ?: @"";
         properties = [SEGUtils traverseJSON:properties
-                      andReplaceWithFilters:self.configuration.payloadFilters];
+                      andReplaceWithFilters:self.oneTimeConfiguration.payloadFilters];
         [self track:@"Deep Link Opened" properties:[properties copy]];
     }
 }
@@ -451,11 +456,11 @@ - (void)openURL:(NSURL *)url options:(NSDictionary *)options
 {
     SEGOpenURLPayload *payload = [[SEGOpenURLPayload alloc] init];
     payload.url = [NSURL URLWithString:[SEGUtils traverseJSON:url.absoluteString
-                                        andReplaceWithFilters:self.configuration.payloadFilters]];
+                                        andReplaceWithFilters:self.oneTimeConfiguration.payloadFilters]];
     payload.options = options;
     [self run:SEGEventTypeOpenURL payload:payload];
 
-    if (!self.configuration.trackDeepLinks) {
+    if (!self.oneTimeConfiguration.trackDeepLinks) {
         return;
     }
 
@@ -468,7 +473,7 @@ - (void)openURL:(NSURL *)url options:(NSDictionary *)options
     [properties addEntriesFromDictionary:options];
     properties[@"url"] = urlString;
     properties = [SEGUtils traverseJSON:properties
-                  andReplaceWithFilters:self.configuration.payloadFilters];
+                  andReplaceWithFilters:self.oneTimeConfiguration.payloadFilters];
     [self track:@"Deep Link Opened" properties:[properties copy]];
 }
 
@@ -535,7 +540,7 @@ - (void)run:(SEGEventType)eventType payload:(SEGPayload *)payload
         return;
     }
 
-    if (self.configuration.experimental.nanosecondTimestamps) {
+    if (self.oneTimeConfiguration.experimental.nanosecondTimestamps) {
         payload.timestamp = iso8601NanoFormattedString([NSDate date]);
     } else {
         payload.timestamp = iso8601FormattedString([NSDate date]);

Analytics/Classes/SEGSegmentIntegration.m

@@ -55,16 +55,19 @@ @interface SEGSegmentIntegration ()
 
 @end
 
+@interface SEGAnalytics ()
+@property (nonatomic, strong, readonly) SEGAnalyticsConfiguration *oneTimeConfiguration;
+@end
 
 @implementation SEGSegmentIntegration
 
 - (id)initWithAnalytics:(SEGAnalytics *)analytics httpClient:(SEGHTTPClient *)httpClient fileStorage:(id<SEGStorage>)fileStorage userDefaultsStorage:(id<SEGStorage>)userDefaultsStorage;
 {
     if (self = [super init]) {
         self.analytics = analytics;
-        self.configuration = analytics.configuration;
+        self.configuration = analytics.oneTimeConfiguration;
         self.httpClient = httpClient;
-        self.httpClient.httpSessionDelegate = analytics.configuration.httpSessionDelegate;
+        self.httpClient.httpSessionDelegate = analytics.oneTimeConfiguration.httpSessionDelegate;
         self.fileStorage = fileStorage;
         self.userDefaultsStorage = userDefaultsStorage;
         self.apiURL = [SEGMENT_API_BASE URLByAppendingPathComponent:@"import"];
@@ -125,7 +128,7 @@ - (void)beginBackgroundTask
 
     seg_dispatch_specific_sync(_backgroundTaskQueue, ^{
 
-        id<SEGApplicationProtocol> application = [self.analytics configuration].application;
+        id<SEGApplicationProtocol> application = [self.analytics oneTimeConfiguration].application;
         if (application && [application respondsToSelector:@selector(seg_beginBackgroundTaskWithName:expirationHandler:)]) {
             self.flushTaskID = [application seg_beginBackgroundTaskWithName:@"Segmentio.Flush"
                                                           expirationHandler:^{
@@ -144,7 +147,7 @@ - (void)endBackgroundTask
     // See https://github.com/segmentio/analytics-ios/issues/683
     seg_dispatch_specific_sync(_backgroundTaskQueue, ^{
         if (self.flushTaskID != UIBackgroundTaskInvalid) {
-            id<SEGApplicationProtocol> application = [self.analytics configuration].application;
+            id<SEGApplicationProtocol> application = [self.analytics oneTimeConfiguration].application;
             if (application && [application respondsToSelector:@selector(seg_endBackgroundTask:)]) {
                 [application seg_endBackgroundTask:self.flushTaskID];
             }
@@ -309,7 +312,7 @@ - (void)queuePayload:(NSDictionary *)payload
 {
     @try {
         // Trim the queue to maxQueueSize - 1 before we add a new element.
-        trimQueue(self.queue, self.analytics.configuration.maxQueueSize - 1);
+        trimQueue(self.queue, self.analytics.oneTimeConfiguration.maxQueueSize - 1);
         [self.queue addObject:payload];
         [self persistQueue];
         [self flushQueueByLength];

Analytics/Internal/SEGIntegrationsManager.m

@@ -80,6 +80,10 @@ @interface SEGIntegrationsManager ()
 
 @end
 
+@interface SEGAnalytics ()
+@property (nullable, nonatomic, strong, readonly) SEGAnalyticsConfiguration *oneTimeConfiguration;
+@end
+
 
 @implementation SEGIntegrationsManager
 
@@ -88,7 +92,7 @@ @implementation SEGIntegrationsManager
 
 - (instancetype _Nonnull)initWithAnalytics:(SEGAnalytics *_Nonnull)analytics
 {
-    SEGAnalyticsConfiguration *configuration = analytics.configuration;
+    SEGAnalyticsConfiguration *configuration = analytics.oneTimeConfiguration;
     NSCParameterAssert(configuration != nil);
 
     if (self = [super init]) {

AnalyticsTests/AnalyticsTests.swift

@@ -44,14 +44,14 @@ class AnalyticsTests: XCTestCase {
     }
 
     func testInitializedCorrectly() {
-        XCTAssertEqual(analytics.configuration.flushAt, 20)
-        XCTAssertEqual(analytics.configuration.flushInterval, 30)
-        XCTAssertEqual(analytics.configuration.maxQueueSize, 1000)
-        XCTAssertEqual(analytics.configuration.writeKey, "QUI5ydwIGeFFTa1IvCBUhxL9PyW5B0jE")
-        XCTAssertEqual(analytics.configuration.shouldUseLocationServices, false)
-        XCTAssertEqual(analytics.configuration.enableAdvertisingTracking, true)
-        XCTAssertEqual(analytics.configuration.shouldUseBluetooth,  false)
-        XCTAssertNil(analytics.configuration.httpSessionDelegate)
+        XCTAssertEqual(config.flushAt, 20)
+        XCTAssertEqual(config.flushInterval, 30)
+        XCTAssertEqual(config.maxQueueSize, 1000)
+        XCTAssertEqual(config.writeKey, "QUI5ydwIGeFFTa1IvCBUhxL9PyW5B0jE")
+        XCTAssertEqual(config.shouldUseLocationServices, false)
+        XCTAssertEqual(config.enableAdvertisingTracking, true)
+        XCTAssertEqual(config.shouldUseBluetooth,  false)
+        XCTAssertNil(config.httpSessionDelegate)
         XCTAssertNotNil(analytics.getAnonymousId())
     }
 
@@ -232,7 +232,7 @@ class AnalyticsTests: XCTestCase {
 
     func testRedactsSensibleURLsFromDeepLinksTracking() {
         testMiddleware.swallowEvent = true
-        analytics.configuration.trackDeepLinks = true
+        config.trackDeepLinks = true
         analytics.open(URL(string: "fb123456789://authorize#access_token=hastoberedacted")!, options: [:])
 
 
@@ -243,8 +243,8 @@ class AnalyticsTests: XCTestCase {
 
     func testRedactsSensibleURLsFromDeepLinksWithFilters() {
         testMiddleware.swallowEvent = true
-        analytics.configuration.payloadFilters["(myapp://auth\\?token=)([^&]+)"] = "$1((redacted/my-auth))"
-        analytics.configuration.trackDeepLinks = true
+        config.payloadFilters["(myapp://auth\\?token=)([^&]+)"] = "$1((redacted/my-auth))"
+        config.trackDeepLinks = true
         analytics.open(URL(string: "myapp://auth?token=hastoberedacted&other=stuff")!, options: [:])
 
 

AnalyticsTests/EndToEndTests.swift

@@ -4,15 +4,16 @@ import XCTest
 class EndToEndTests: XCTestCase {
 
     var analytics: Analytics!
+    var configuration: AnalyticsConfiguration!
 
     override func setUp() {
         super.setUp()
 
         // Write Key for https://app.segment.com/segment-libraries/sources/analytics_ios_e2e_test/overview
-        let config = AnalyticsConfiguration(writeKey: "3VxTfPsVOoEOSbbzzbFqVNcYMNu2vjnr")
-        config.flushAt = 1
+        configuration = AnalyticsConfiguration(writeKey: "3VxTfPsVOoEOSbbzzbFqVNcYMNu2vjnr")
+        configuration.flushAt = 1
 
-        Analytics.setup(with: config)
+        Analytics.setup(with: configuration)
 
         analytics = Analytics.shared()
     }
@@ -27,7 +28,7 @@ class EndToEndTests: XCTestCase {
         let uuid = UUID().uuidString
         let expectation = XCTestExpectation(description: "SegmentRequestDidSucceed")
 
-        Analytics.shared().configuration.experimental.rawSegmentModificationBlock = { data in
+        configuration.experimental.rawSegmentModificationBlock = { data in
             if let properties = data["properties"] as? Dictionary<String, Any?>,
                 let tempUUID = properties["id"] as? String, tempUUID == uuid {
                 expectation.fulfill()