Fixed broken data store test. Also cleaned up code comments and method names.

Author: alda-optimizely

OptimizelySDKShared/OptimizelySDKShared/OPTLYDataStore.h

@@ -16,6 +16,7 @@
 
 #import <Foundation/Foundation.h>
 
+// if adding data store data type, update: removeSavedEvents
 typedef NS_ENUM(NSUInteger, OPTLYDataStoreDataType)
 {
     OPTLYDataStoreDataTypeDatabase,
@@ -24,7 +25,7 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreDataType)
     OPTLYDataStoreDataTypeUserProfile,
 };
 
-// if adding event type, update: removeAllUserData!!
+// if adding event type, update: removeAllUserData
 typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
 {
     OPTLYDataStoreEventTypeImpression,
@@ -50,7 +51,7 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
  * Wipes all Optimizely data (saved and cached).
  *
  **/
-- (void)removeAll;
+- (void)removeAll:(NSError * _Nullable * _Nullable)error;
 
 // -------- File Storage --------
 // Persists data in a file format using NSFileManager.
@@ -144,116 +145,123 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
 // If data is cached, then the events are stored in a runtime in-memory queue.
 // If data is not cached, the events are stored in an SQLite table.
 // Events are only persisted in the SQLite table for iOS platforms.
-// tvOS events are only cached to save on very limited memory usage.
-// A future enhancement for tvOS is to store data in iCloud.
+// tvOS events are only cached to save on very limited memory availability.
+// A future enhancement for tvOS is to store event data in iCloud.
 
 /**
  * Saves an event.
  *
  * @param data The data to be saved.
  * @param eventType The event type of the data that needs to be saved.
- * @param cacheData Specify if the data should be cached (default is true for tvOS).
+ * @param cachedData Specify if the data should be saved in the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
 - (void)saveData:(nonnull NSDictionary *)data
        eventType:(OPTLYDataStoreEventType)eventType
-       cacheData:(bool)cacheData
+      cachedData:(bool)cachedData
            error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Gets the oldest event.
  *
  * @param eventType The event type of the data that needs to be retrieved.
- * @param cacheData Specify if the data should be retrieved from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be retrieved from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
 - (nullable NSDictionary *)getOldestEvent:(OPTLYDataStoreEventType)eventType
-                                cacheData:(bool)cacheData
+                               cachedData:(bool)cachedData
                                     error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Gets the first N entries (i.e., the N oldest events).
  *
  * @param numberOfEvents The number of events to retrieve.
  * @param eventType The event type of the data that needs to be removed.
- * @param cacheData Specify if the data should be retrieved from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be retrieved from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
 - (nullable NSArray *)getFirstNEvents:(NSInteger)numberOfEvents
                             eventType:(OPTLYDataStoreEventType)eventType
-                            cacheData:(bool)cacheData
+                           cachedData:(bool)cachedData
                                 error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Gets all events.
  *
  * @param eventType The event type of the data that needs to be retrieved.
- * @param cacheData Specify if the data should be retrieved from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be retrieved from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  * @return The return value is an array of OPTLYDatabaseEntity.
  */
 - (nullable NSArray *)getAllEvents:(OPTLYDataStoreEventType)eventType
-                         cacheData:(bool)cacheData
+                        cachedData:(bool)cachedData
                              error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Deletes the oldest event.
  *
  * @param eventType The event type of the data that needs to be removed.
- * @param cacheData Specify if the data should be removed from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be deleted from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
 - (void)removeOldestEvent:(OPTLYDataStoreEventType)eventType
-                cacheData:(bool)cacheData
+               cachedData:(bool)cachedData
                     error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Deletes the first N events (i.e., the N oldest events).
  *
  * @param numberOfEvents The number of events to retrieve.
  * @param eventType The event type of the data that needs to be removed.
- * @param cacheData Specify if the data should be removed from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be deleted from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
 - (void)removeFirstNEvents:(NSInteger)numberOfEvents
                  eventType:(OPTLYDataStoreEventType)eventType
-                 cacheData:(bool)cacheData
+                cachedData:(bool)cachedData
                      error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Deletes all events.
  *
  * @param eventType The event type of the data that needs to be removed.
- * @param cacheData Specify if the data should be removed from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be deleted from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
 - (void)removeAllEvents:(OPTLYDataStoreEventType)eventType
-              cacheData:(bool)cacheData
+             cachedData:(bool)cachedData
                   error:(NSError * _Nullable * _Nullable)error;
 
 /**
  * Returns the number of saved events.
  *
  * @param eventType The event type of the data.
- * @param cacheData Specify if the event count should be retrieved from cache (this is by default always true for tvOS).
+ * @param cachedData Specify if the data should be retrieved from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  * @return The number of events saved.
  */
 - (NSInteger)numberOfEvents:(OPTLYDataStoreEventType)eventType
-                  cacheData:(bool)cacheData
+                 cachedData:(bool)cachedData
                       error:(NSError * _Nullable * _Nullable)error;
 
 /**
- * Removes all cached events.
- */
-- (void)removeCachedEvents;
-
-/**
- * Removes all saved events.
+ * Removes all saved or cached events.
  *
+ * @param cachedData Specify if the data should be deleted from the in-memory
+ *  cache and not saved in the database (this is always true for tvOS).
  * @param error An error object is returned if an error occurs.
  */
-- (void)removeSavedEvents:(NSError * _Nullable * _Nullable)error;
+- (void)removeSavedEvents:(BOOL)cachedData
+                    error:(NSError * _Nullable * _Nullable)error;
+
 
 // -------- User Data Storage --------
 // Saves data in dictionary format in NSUserDefault

OptimizelySDKShared/OptimizelySDKShared/OPTLYDataStore.m

@@ -71,10 +71,10 @@ - (OPTLYFileManager *)fileManager {
     return _fileManager;
 }
 
-- (void)removeAll {
+- (void)removeAll:(NSError * _Nullable * _Nullable)error {
     [self removeAllUserData];
-    [self removeAllFiles:nil]; 
-    [self removeCachedEvents];
+    [self removeEventsData:error];
+    [self removeAllFiles:error];
 }
 
 #if TARGET_OS_IOS
@@ -187,6 +187,7 @@ - (void)removeFilesForDataType:(OPTLYDataStoreDataType)dataType
 
 - (void)removeAllFiles:(NSError * _Nullable * _Nullable)error {
     [self.fileManager removeAllFiles:error];
+    self.fileManager = nil;
 }
 
 # pragma mark - Event Storage Methods
@@ -203,19 +204,19 @@ - (void)createTable:(OPTLYDataStoreEventType)eventType
 
 - (void)saveData:(nonnull NSDictionary *)data
        eventType:(OPTLYDataStoreEventType)eventType
-       cacheData:(bool)cacheData
+      cachedData:(bool)cachedData
            error:(NSError * _Nullable * _Nullable)error
 {
     // tvOS can only save to cached data
 #if TARGET_OS_TV
-    if (!cacheData) {
-        cacheData = true;
+    if (!cachedData) {
+        cachedData = true;
         OPTLYLogError(@"tvOS can only save to cached data.");
     }
 #endif
 
     NSString *eventTypeName = [self stringForDataEventEnum:eventType];
-    if (cacheData) {
+    if (cachedData) {
         OPTLYQueue *queue = self.eventsCache[eventTypeName];
         [queue enqueue:data];
     } else {
@@ -227,20 +228,20 @@ - (void)saveData:(nonnull NSDictionary *)data
 
 - (nullable NSArray *)getFirstNEvents:(NSInteger)numberOfEvents
                             eventType:(OPTLYDataStoreEventType)eventType
-                            cacheData:(bool)cacheData
+                           cachedData:(bool)cachedData
                                 error:(NSError * _Nullable * _Nullable)error
 {
     // tvOS can only read from cached data
 #if TARGET_OS_TV
-    if (!cacheData) {
-        cacheData = true;
+    if (!cachedData) {
+        cachedData = true;
         OPTLYLogInfo(@"tvOS can only read from cached data.");
     }
 #endif
 
     NSMutableArray *firstNEvents = [NSMutableArray new];
     NSString *eventTypeName = [self stringForDataEventEnum:eventType];
-    if (cacheData) {
+    if (cachedData) {
         OPTLYQueue *queue = self.eventsCache[eventTypeName];
         [firstNEvents addObjectsFromArray:[queue firstNItems:numberOfEvents]];
     } else {
@@ -257,45 +258,45 @@ - (nullable NSArray *)getFirstNEvents:(NSInteger)numberOfEvents
 }
 
 - (nullable NSDictionary *)getOldestEvent:(OPTLYDataStoreEventType)eventType
-                                cacheData:(bool)cacheData
+                               cachedData:(bool)cachedData
                                     error:(NSError * _Nullable * _Nullable)error
 {
     NSDictionary *oldestEvent = nil;
-    NSArray *oldestEvents = [self getFirstNEvents:1 eventType:eventType cacheData:cacheData error:error];
+    NSArray *oldestEvents = [self getFirstNEvents:1 eventType:eventType cachedData:cachedData error:error];
 
     if ([oldestEvents count] <= 0) {
         OPTLYLogInfo(@"No event(s).");
     } else {
         oldestEvent = oldestEvents[0];
     }
-
+    
     return oldestEvent;
 }
 
 - (nullable NSArray *)getAllEvents:(OPTLYDataStoreEventType)eventType
-                         cacheData:(bool)cacheData
+                        cachedData:(bool)cachedData
                              error:(NSError * _Nullable * _Nullable)error
 {
-    NSInteger numberOfEvents = [self numberOfEvents:eventType cacheData:cacheData error:error];
-    NSArray *allEvents = [self getFirstNEvents:numberOfEvents eventType:eventType cacheData:cacheData error:error];
+    NSInteger numberOfEvents = [self numberOfEvents:eventType cachedData:cachedData error:error];
+    NSArray *allEvents = [self getFirstNEvents:numberOfEvents eventType:eventType cachedData:cachedData error:error];
     return allEvents;
 }
 
 - (void)removeFirstNEvents:(NSInteger)numberOfEvents
                  eventType:(OPTLYDataStoreEventType)eventType
-                 cacheData:(bool)cacheData
+                cachedData:(bool)cachedData
                      error:(NSError * _Nullable * _Nullable)error
 {
     // tvOS can only delete from cached data
 #if TARGET_OS_TV
-    if (!cacheData) {
-        cacheData = true;
+    if (!cachedData) {
+        cachedData = true;
         OPTLYLogInfo(@"tvOS can only delete cached data.");
     }
 #endif
 
     NSString *eventTypeName = [self stringForDataEventEnum:eventType];
-    if (cacheData) {
+    if (cachedData) {
         OPTLYQueue *queue = self.eventsCache[eventTypeName];
         [queue dequeueNItems:numberOfEvents];
     } else {
@@ -318,36 +319,36 @@ - (void)removeFirstNEvents:(NSInteger)numberOfEvents
 }
 
 - (void)removeOldestEvent:(OPTLYDataStoreEventType)eventType
-                cacheData:(bool)cacheData
+               cachedData:(bool)cachedData
                     error:(NSError * _Nullable * _Nullable)error
 {
-    [self removeFirstNEvents:1 eventType:eventType cacheData:cacheData error:error];
+    [self removeFirstNEvents:1 eventType:eventType cachedData:cachedData error:error];
 }
 
 - (void)removeAllEvents:(OPTLYDataStoreEventType)eventType
-              cacheData:(bool)cacheData
+             cachedData:(bool)cachedData
                   error:(NSError * _Nullable * _Nullable)error
 {
-    NSInteger numberOfEvents = [self numberOfEvents:eventType cacheData:cacheData error:error];
-    [self removeFirstNEvents:numberOfEvents eventType:eventType cacheData:cacheData error:error];
+    NSInteger numberOfEvents = [self numberOfEvents:eventType cachedData:cachedData error:error];
+    [self removeFirstNEvents:numberOfEvents eventType:eventType cachedData:cachedData error:error];
 }
 
 
 - (NSInteger)numberOfEvents:(OPTLYDataStoreEventType)eventType
-                  cacheData:(bool)cacheData
+                 cachedData:(bool)cachedData
                       error:(NSError * _Nullable * _Nullable)error
 {
     // tvOS can only read from cached data
 #if TARGET_OS_TV
-    if (!cacheData) {
-        cacheData = true;
+    if (!cachedData) {
+        cachedData = true;
         OPTLYLogInfo(@"tvOS can only read from cached data.");
     }
 #endif
 
     NSString *eventTypeName = [self stringForDataEventEnum:eventType];
     NSInteger numberOfEvents = 0;
-    if (cacheData) {
+    if (cachedData) {
         OPTLYQueue *queue = self.eventsCache[eventTypeName];
         numberOfEvents = [queue size];
     } else {
@@ -359,13 +360,20 @@ - (NSInteger)numberOfEvents:(OPTLYDataStoreEventType)eventType
     return numberOfEvents;
 }
 
-- (void)removeCachedEvents {
-    self.eventsCache = nil;
+- (void)removeSavedEvents:(BOOL)cachedData
+                    error:(NSError * _Nullable * _Nullable)error {
+    for (NSInteger i = 0; i <= OPTLYDataStoreEventTypeConversion; ++i ) {
+        [self removeAllEvents:i cachedData:cachedData error:error];
+    }
 }
 
-- (void)removeSavedEvents:(NSError * _Nullable * _Nullable)error {
+- (void)removeEventsData:(NSError * _Nullable * _Nullable)error {
+    [self removeSavedEvents:YES error:error];
+    [self removeSavedEvents:NO error:error];
+    self.eventsCache = nil;
 #if TARGET_OS_IOS
-    [self.fileManager removeDataSubDir:[self stringForDataTypeEnum:OPTLYDataStoreDataTypeDatabase]  error:error];
+    [self.database deleteDatabase:error];
+    self.database = nil;
 #endif
 }