[tvOS] Move SEGQueue from UserDefaults to caches directory (#861)

* Stops using UserDefaults for queue on tvOS and uses NSCachesDirectory

Changes storage to fileStorage and userDefaultsStorage. Utilizes userDefaults on tvOS for information such as anonymousID and configuration, but moves tvOS's queue into the NSCachesDirectory. The reasoning is that tvOS has a 1mb limit for UserDefaults and the queue can grow rapidly in size, leading to app crashes when saving more than 1mb of data to UserDefaults.

* Adds a constant for key. Seperate cache dir and appSupport dir functions. Removes unused init.

* Adds functionality to remove old UserDefaults queue on tvOS.

Updates migrated removal block to account for tvOS now that the queue is no longer in UserDefaults. Adds back in a #else and #endif that was accidently removed.

* Adds tvOS unit test target

* Adds new AnalyticsTestsTVOS scheme
* Updates pods to include all test pods for AnalyticsTestsTVOS
* Fixes unit test import for QuickTVOS

* Add tvOS options for make file

* Enabled code coverage on tvOS tests

* Fix up unit test warning

"result of expect is never nil"

* Adds test to ensure that UserDefaults SEGQueue is cleared on initialization for tvOS & iOS

* Adds test to ensure SEGQueue is empty when missing form file storage

* Reverts unnecessary import for QuickTVOS

* Adds test for FileStorage caches directory helper

* Fix up: Adds SwiftTryCatch pod to tvOS test target

* Fix up makefile to have correct build target for build-ios & build-tvos

* Fix up: updates xcodebuild destination to match devices found on circleci

* Break up ios and tvos build/test steps

* Circleci: Cache pods

* Fix up: tvOS test build

* Fix up spacing

* Fix up flaky unit test

Co-authored-by: Connor Ricks <[email protected]>

Author: iMacHumphries

.circleci/config.yml

@@ -13,13 +13,24 @@ jobs:
             sudo gem install xcpretty
             sudo gem install cocoapods -v $(var=$(tail -1 Podfile.lock); echo ${var##COCOAPODS:})
 
+      - restore_cache:
+          key: 1-pods-{{ checksum "Podfile.lock" }}
       - run:
-          name: Fetch Cocoapods specs
-          command: curl https://cocoapods-specs.circleci.com/fetch-cocoapods-repo-from-s3.sh | bash -s cf
+          name: Install CocoaPods
+          command: |
+            if [ ! -d "Pods" ]
+            then
+              make dependencies
+            fi
+      - save_cache:
+          key: 1-pods-{{ checksum "Podfile.lock" }}
+          paths:
+            - ./Pods
 
-      - run: make dependencies
-      - run: make build-pretty
-      - run: make test-pretty
+      - run: make build-ios
+      - run: make test-ios
+      - run: make build-tvos
+      - run: make test-tvos
       - run: make lint
       - run: make carthage
 

Analytics.xcodeproj/project.pbxproj

@@ -48,6 +48,16 @@
                ReferencedContainer = "container:Analytics.xcodeproj">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "9D8CE58B23EE014E00197D0C"
+               BuildableName = "AnalyticsTestsTVOS.xctest"
+               BlueprintName = "AnalyticsTestsTVOS"
+               ReferencedContainer = "container:Analytics.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

Analytics.xcodeproj/xcshareddata/xcschemes/Analytics.xcscheme

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1130"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "9D8CE58B23EE014E00197D0C"
+               BuildableName = "AnalyticsTestsTVOS.xctest"
+               BlueprintName = "AnalyticsTestsTVOS"
+               ReferencedContainer = "container:Analytics.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Analytics.xcodeproj/xcshareddata/xcschemes/AnalyticsTestsTVOS.xcscheme

@@ -28,6 +28,7 @@
 NSString *SEGAnalyticsIntegrationDidStart = @"io.segment.analytics.integration.did.start";
 static NSString *const SEGAnonymousIdKey = @"SEGAnonymousId";
 static NSString *const kSEGAnonymousIdFilename = @"segment.anonymousId";
+static NSString *const SEGCachedSettingsKey = @"analytics.settings.v2.plist";
 
 
 @interface SEGAnalyticsConfiguration (Private)
@@ -51,7 +52,8 @@ @interface SEGIntegrationsManager ()
 @property (nonatomic, copy) NSString *cachedAnonymousId;
 @property (nonatomic, strong) SEGHTTPClient *httpClient;
 @property (nonatomic, strong) NSURLSessionDataTask *settingsRequest;
-@property (nonatomic, strong) id<SEGStorage> storage;
+@property (nonatomic, strong) id<SEGStorage> userDefaultsStorage;
+@property (nonatomic, strong) id<SEGStorage> fileStorage;
 
 @end
 
@@ -71,14 +73,17 @@ - (instancetype _Nonnull)initWithAnalytics:(SEGAnalytics *_Nonnull)analytics
         self.serialQueue = seg_dispatch_queue_create_specific("io.segment.analytics", DISPATCH_QUEUE_SERIAL);
         self.messageQueue = [[NSMutableArray alloc] init];
         self.httpClient = [[SEGHTTPClient alloc] initWithRequestFactory:configuration.requestFactory];
-#if TARGET_OS_TV
-        self.storage = [[SEGUserDefaultsStorage alloc] initWithDefaults:[NSUserDefaults standardUserDefaults] namespacePrefix:nil crypto:configuration.crypto];
-#else
-        self.storage = [[SEGFileStorage alloc] initWithFolder:[SEGFileStorage applicationSupportDirectoryURL] crypto:configuration.crypto];
-#endif
+        
+        self.userDefaultsStorage = [[SEGUserDefaultsStorage alloc] initWithDefaults:[NSUserDefaults standardUserDefaults] namespacePrefix:nil crypto:configuration.crypto];
+        #if TARGET_OS_TV
+            self.fileStorage = [[SEGFileStorage alloc] initWithFolder:[SEGFileStorage cachesDirectoryURL] crypto:configuration.crypto];
+        #else
+            self.fileStorage = [[SEGFileStorage alloc] initWithFolder:[SEGFileStorage applicationSupportDirectoryURL] crypto:configuration.crypto];
+        #endif
+
         self.cachedAnonymousId = [self loadOrGenerateAnonymousID:NO];
         NSMutableArray *factories = [[configuration factories] mutableCopy];
-        [factories addObject:[[SEGSegmentIntegrationFactory alloc] initWithHTTPClient:self.httpClient storage:self.storage]];
+        [factories addObject:[[SEGSegmentIntegrationFactory alloc] initWithHTTPClient:self.httpClient fileStorage:self.fileStorage userDefaultsStorage:self.userDefaultsStorage]];
         self.factories = [factories copy];
         self.integrations = [NSMutableDictionary dictionaryWithCapacity:factories.count];
         self.registeredIntegrations = [NSMutableDictionary dictionaryWithCapacity:factories.count];
@@ -285,9 +290,9 @@ - (NSString *)getAnonymousId;
 - (NSString *)loadOrGenerateAnonymousID:(BOOL)reset
 {
 #if TARGET_OS_TV
-    NSString *anonymousId = [self.storage stringForKey:SEGAnonymousIdKey];
+    NSString *anonymousId = [self.userDefaultsStorage stringForKey:SEGAnonymousIdKey];
 #else
-    NSString *anonymousId = [self.storage stringForKey:kSEGAnonymousIdFilename];
+    NSString *anonymousId = [self.fileStorage stringForKey:kSEGAnonymousIdFilename];
 #endif
 
     if (!anonymousId || reset) {
@@ -297,9 +302,9 @@ - (NSString *)loadOrGenerateAnonymousID:(BOOL)reset
         anonymousId = GenerateUUIDString();
         SEGLog(@"New anonymousId: %@", anonymousId);
 #if TARGET_OS_TV
-        [self.storage setString:anonymousId forKey:SEGAnonymousIdKey];
+        [self.userDefaultsStorage setString:anonymousId forKey:SEGAnonymousIdKey];
 #else
-        [self.storage setString:anonymousId forKey:kSEGAnonymousIdFilename];
+        [self.fileStorage setString:anonymousId forKey:kSEGAnonymousIdFilename];
 #endif
     }
     return anonymousId;
@@ -309,9 +314,9 @@ - (void)saveAnonymousId:(NSString *)anonymousId
 {
     self.cachedAnonymousId = anonymousId;
 #if TARGET_OS_TV
-    [self.storage setString:anonymousId forKey:SEGAnonymousIdKey];
+    [self.userDefaultsStorage setString:anonymousId forKey:SEGAnonymousIdKey];
 #else
-    [self.storage setString:anonymousId forKey:@"segment.anonymousId"];
+    [self.fileStorage setString:anonymousId forKey:kSEGAnonymousIdFilename];
 #endif
 }
 
@@ -324,8 +329,14 @@ - (void)flush
 
 - (NSDictionary *)cachedSettings
 {
-    if (!_cachedSettings)
-        _cachedSettings = [self.storage dictionaryForKey:@"analytics.settings.v2.plist"] ?: @{};
+    if (!_cachedSettings) {
+#if TARGET_OS_TV
+        _cachedSettings = [self.userDefaultsStorage dictionaryForKey:SEGCachedSettingsKey] ?: @{};
+#else
+        _cachedSettings = [self.fileStorage dictionaryForKey:SEGCachedSettingsKey] ?: @{};
+#endif
+    }
+    
     return _cachedSettings;
 }
 
@@ -336,7 +347,12 @@ - (void)setCachedSettings:(NSDictionary *)settings
         // [@{} writeToURL:settingsURL atomically:YES];
         return;
     }
-    [self.storage setDictionary:_cachedSettings forKey:@"analytics.settings.v2.plist"];
+    
+#if TARGET_OS_TV
+    [self.userDefaultsStorage setDictionary:_cachedSettings forKey:SEGCachedSettingsKey];
+#else
+    [self.fileStorage setDictionary:_cachedSettings forKey:SEGCachedSettingsKey];
+#endif
 
     [self updateIntegrationsWithSettings:settings[@"integrations"]];
 }

Analytics/Classes/Integrations/SEGIntegrationsManager.m

@@ -13,11 +13,11 @@
 
 @property (nonatomic, strong, nullable) id<SEGCrypto> crypto;
 
-- (instancetype _Nonnull)init;
 - (instancetype _Nonnull)initWithFolder:(NSURL *_Nonnull)folderURL crypto:(id<SEGCrypto> _Nullable)crypto;
 
 - (NSURL *_Nonnull)urlForKey:(NSString *_Nonnull)key;
 
 + (NSURL *_Nullable)applicationSupportDirectoryURL;
++ (NSURL *_Nullable)cachesDirectoryURL;
 
 @end

Analytics/Classes/Internal/SEGFileStorage.h

@@ -19,11 +19,6 @@ @interface SEGFileStorage ()
 
 @implementation SEGFileStorage
 
-- (instancetype)init
-{
-    return [self initWithFolder:[SEGFileStorage applicationSupportDirectoryURL] crypto:nil];
-}
-
 - (instancetype)initWithFolder:(NSURL *)folderURL crypto:(id<SEGCrypto>)crypto
 {
     if (self = [super init]) {
@@ -121,11 +116,19 @@ - (void)setString:(NSString *)string forKey:(NSString *)key
     [self setJSON:data forKey:key];
 }
 
+
 + (NSURL *)applicationSupportDirectoryURL
 {
     NSArray *paths = NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES);
-    NSString *supportPath = [paths firstObject];
-    return [NSURL fileURLWithPath:supportPath];
+    NSString *storagePath = [paths firstObject];
+    return [NSURL fileURLWithPath:storagePath];
+}
+
++ (NSURL *)cachesDirectoryURL
+{
+    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
+    NSString *storagePath = [paths firstObject];
+    return [NSURL fileURLWithPath:storagePath];
 }
 
 - (NSURL *)urlForKey:(NSString *)key

Analytics/Classes/Internal/SEGFileStorage.m

@@ -12,7 +12,7 @@ extern NSString *const SEGSegmentRequestDidFailNotification;
 
 @interface SEGSegmentIntegration : NSObject <SEGIntegration>
 
-- (id)initWithAnalytics:(SEGAnalytics *)analytics httpClient:(SEGHTTPClient *)httpClient storage:(id<SEGStorage>)storage;
+- (id)initWithAnalytics:(SEGAnalytics *)analytics httpClient:(SEGHTTPClient *)httpClient fileStorage:(id<SEGStorage>)fileStorage userDefaultsStorage:(id<SEGStorage>)userDefaultsStorage;
 
 @end