Consolidated methods for persisting events so that the cached and uncached events are handled by a parameterized method.

Author: alda-optimizely

OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.h

@@ -55,6 +55,7 @@ typedef NS_ENUM(NSUInteger, OPTLYErrorTypes) {
     OPTLYErrorTypesEventDispatchInvalid,
     OPTLYErrorTypesBuilderInvalid,
     OPTLYErrorTypesDatabase,
+    OPTLYErrorTypesDataStore,
 };
 
 @interface OPTLYErrorHandlerMessages : NSObject

OptimizelySDKCore/OptimizelySDKCore/OptimizelySDKCore.h

@@ -27,6 +27,7 @@
 #import "OPTLYProjectConfig.h"
 #import "OPTLYVariation.h"
 #import "OPTLYLog.h"
+#import "OPTLYQueue.h"
 
 FOUNDATION_EXPORT double OptimizelySDKCoreVersionNumber;
 FOUNDATION_EXPORT const unsigned char OptimizelySDKCoreVersionString[];

OptimizelySDKShared/OptimizelySDKShared.xcodeproj/project.pbxproj

@@ -38,8 +38,6 @@
 		2DB3D1801DC8181100ECF72E /* OPTLYManagerBuilder.h in Headers */ = {isa = PBXBuildFile; fileRef = 2DB3D17A1DC816D600ECF72E /* OPTLYManagerBuilder.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		2DB3D1811DC8181400ECF72E /* OPTLYManagerBuilder.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DB3D17B1DC816D600ECF72E /* OPTLYManagerBuilder.m */; };
 		2DCC50B31DD3CDAB006C9815 /* OPTLYManagerTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DCC50B21DD3CDAB006C9815 /* OPTLYManagerTest.m */; };
-		2DCC50B41DD3CDAB006C9815 /* OPTLYManagerTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DCC50B21DD3CDAB006C9815 /* OPTLYManagerTest.m */; };
-		2DCC50BD1DD535A5006C9815 /* OPTLYFileManager.h in Headers */ = {isa = PBXBuildFile; fileRef = EA29D8FC1DCBBE250034A4FE /* OPTLYFileManager.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		5318433267A9188A3D16D3A2 /* Pods_OptimizelySDKSharediOSTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7B9FE2FE02E36C64D6F1F442 /* Pods_OptimizelySDKSharediOSTests.framework */; };
 		5A8753FCE65715A7A353C14C /* Pods_OptimizelySDKSharediOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 09704701D3CB97F3D3F408E3 /* Pods_OptimizelySDKSharediOS.framework */; };
 		6433BEBF70E8BE35397D1778 /* Pods_OptimizelySDKSharedTVOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5EDD2F1182FB354ABC0E04A1 /* Pods_OptimizelySDKSharedTVOS.framework */; };
@@ -55,8 +53,8 @@
 		EA1E16961DC87E0000F00033 /* OPTLYTestHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = EA1E16901DC87DC700F00033 /* OPTLYTestHelper.m */; };
 		EA1E16971DC87E0100F00033 /* OPTLYTestHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = EA1E16901DC87DC700F00033 /* OPTLYTestHelper.m */; };
 		EA29D8FF1DCBBE250034A4FE /* OPTLYFileManager.m in Sources */ = {isa = PBXBuildFile; fileRef = EA29D8FD1DCBBE250034A4FE /* OPTLYFileManager.m */; };
-		EA29D94E1DCE778C0034A4FE /* OPTLYDatabase.h in Headers */ = {isa = PBXBuildFile; fileRef = EA29D94C1DCE778C0034A4FE /* OPTLYDatabase.h */; };
-		EA29D9541DCED4580034A4FE /* OPTLYDatabaseEntity.h in Headers */ = {isa = PBXBuildFile; fileRef = EA29D9521DCED4580034A4FE /* OPTLYDatabaseEntity.h */; };
+		EA29D94E1DCE778C0034A4FE /* OPTLYDatabase.h in Headers */ = {isa = PBXBuildFile; fileRef = EA29D94C1DCE778C0034A4FE /* OPTLYDatabase.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		EA29D9541DCED4580034A4FE /* OPTLYDatabaseEntity.h in Headers */ = {isa = PBXBuildFile; fileRef = EA29D9521DCED4580034A4FE /* OPTLYDatabaseEntity.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		EA29D9551DCED4580034A4FE /* OPTLYDatabaseEntity.m in Sources */ = {isa = PBXBuildFile; fileRef = EA29D9531DCED4580034A4FE /* OPTLYDatabaseEntity.m */; };
 		EA29D9E31DD274870034A4FE /* OPTLYFileManager.m in Sources */ = {isa = PBXBuildFile; fileRef = EA29D8FD1DCBBE250034A4FE /* OPTLYFileManager.m */; };
 		EA29D9E81DD274A30034A4FE /* OPTLYFileManager.h in Headers */ = {isa = PBXBuildFile; fileRef = EA29D8FC1DCBBE250034A4FE /* OPTLYFileManager.h */; };
@@ -428,9 +426,9 @@
 				EA52479A1DC724AF00AF6685 /* OPTLYNetworkService.h in Headers */,
 				EA064BD21DD4030700DF7537 /* OPTLYDataStore.h in Headers */,
 				2DB3D17C1DC816D600ECF72E /* OPTLYManagerBuilder.h in Headers */,
-				EA064BDC1DD4186400DF7537 /* OPTLYFileManager.h in Headers */,
 				EA29D94E1DCE778C0034A4FE /* OPTLYDatabase.h in Headers */,
 				EA29D9541DCED4580034A4FE /* OPTLYDatabaseEntity.h in Headers */,
+				EA064BDC1DD4186400DF7537 /* OPTLYFileManager.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

OptimizelySDKShared/OptimizelySDKShared/OPTLYDataStore.h

@@ -24,6 +24,7 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreDataType)
     OPTLYDataStoreDataTypeUserProfile,
 };
 
+// if adding event type, update: removeAllUserData!!
 typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
 {
     OPTLYDataStoreEventTypeImpression,
@@ -33,8 +34,11 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
 @class OPTLYFileManager;
 
 /*
- * This class handles all things related to persistence and serves as a wrapper class for
- * OPTLYFileManager and OPTLYDatabase.
+ * This class handles all Optimizely-related data persistence and caching.
+ * Data is persisted for the following purposes:
+ *      - NSFileManager for datafile
+ *      - SQLite table (or in-memory queue) for events
+ *      - NSUserDefault for user data (e.g., bucketing info).
  */
 
 @interface OPTLYDataStore : NSObject
@@ -43,11 +47,16 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
 @property (nonatomic, strong, readonly, nonnull) NSString *baseDirectory;
 
 /**
- * Removes all data persisted by Optimizely
+ * Wipes all Optimizely data (saved and cached).
+ *
  **/
 - (void)removeAll;
 
-// ---- NSFileManager ----
+// -------- File Storage --------
+// Persists data in a file format using NSFileManager.
+// iOS documents are written in the Library directory.
+// tvOS documents are written in the Temporary directory.
+
 /**
  * Saves a file.
  * If a file of the same name type exists already, then that file will be overwritten.
@@ -131,134 +140,159 @@ typedef NS_ENUM(NSUInteger, OPTLYDataStoreEventType)
                          error:(NSError * _Nullable * _Nullable)error;
 
 
-// ---- SQLite Table ----
-// Used for event storage
-#if TARGET_OS_IOS
+// -------- Events Storage --------
+// 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.
+
 /**
- * Creates a new table.
+ * Saves an event.
  *
- * @param eventType The event type of the data to be stored in the new table.
+ * @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 error An error object is returned if an error occurs.
- **/
-- (void)createTable:(OPTLYDataStoreEventType)eventType
-              error:(NSError * _Nullable * _Nullable)error;
+ */
+- (void)saveData:(nonnull NSDictionary *)data
+       eventType:(OPTLYDataStoreEventType)eventType
+       cacheData:(bool)cacheData
+           error:(NSError * _Nullable * _Nullable)error;
 
 /**
- * Inserts data into a database table.
+ * Gets the oldest event.
  *
- * @param data The data to be written into the table.
- * @param eventType The event type of the data that needs to be saved.
+ * @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 error An error object is returned if an error occurs.
  */
-- (void)insertData:(nonnull NSDictionary *)data
-         eventType:(OPTLYDataStoreEventType)eventType
-             error:(NSError * _Nullable * _Nullable)error;
+- (nullable NSDictionary *)getOldestEvent:(OPTLYDataStoreEventType)eventType
+                                cacheData:(bool)cacheData
+                                    error:(NSError * _Nullable * _Nullable)error;
 
 /**
- * Deletes data from a database table.
+ * Gets the first N entries (i.e., the N oldest events).
  *
- * @param entityId The entity id to remove from the table.
+ * @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 error An error object is returned if an error occurs.
  */
-- (void)deleteEvent:(nonnull NSString *)entityId
-          eventType:(OPTLYDataStoreEventType)eventType
-              error:(NSError * _Nullable * _Nullable)error;
+- (nullable NSArray *)getFirstNEvents:(NSInteger)numberOfEvents
+                            eventType:(OPTLYDataStoreEventType)eventType
+                            cacheData:(bool)cacheData
+                                error:(NSError * _Nullable * _Nullable)error;
 
 /**
- * Deletes data from a database table.
+ * 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 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
+                             error:(NSError * _Nullable * _Nullable)error;
+
+/**
+ * Deletes the oldest event.
  *
- * @param entityIds The entity ids to remove from the table.
  * @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 error An error object is returned if an error occurs.
  */
-- (void)deleteEvents:(nonnull NSArray *)entityIds
-           eventType:(OPTLYDataStoreEventType)eventType
-               error:(NSError * _Nullable * _Nullable)error;
+- (void)removeOldestEvent:(OPTLYDataStoreEventType)eventType
+                cacheData:(bool)cacheData
+                    error:(NSError * _Nullable * _Nullable)error;
 
 /**
- * Retrieve all entries from the table.
+ * Deletes the first N events (i.e., the N oldest events).
  *
- * @param eventType The event type of the data that needs to be retrieved.
+ * @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 error An error object is returned if an error occurs.
- * @return The return value is an array of OPTLYDatabaseEntity.
  */
-- (nullable NSArray *)retrieveAllEvents:(OPTLYDataStoreEventType)eventType
-                                  error:(NSError * _Nullable * _Nullable)error;
+- (void)removeFirstNEvents:(NSInteger)numberOfEvents
+                 eventType:(OPTLYDataStoreEventType)eventType
+                 cacheData:(bool)cacheData
+                     error:(NSError * _Nullable * _Nullable)error;
 
 /**
- * Retrieves a set of N entries from the table.
+ * Deletes all events.
  *
- * @param numberOfEntries The number of entries to read from the table
- * @param eventType The event type of the data that needs to be retrieved.
+ * @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 error An error object is returned if an error occurs.
- * @return The return value is an array of OPTLYDatabaseEntity.
  */
-- (nullable NSArray *)retrieveFirstNEvents:(NSInteger)numberOfEntries
-                                 eventType:(OPTLYDataStoreEventType)eventType
-                                     error:(NSError * _Nullable * _Nullable)error;
+- (void)removeAllEvents:(OPTLYDataStoreEventType)eventType
+              cacheData:(bool)cacheData
+                  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 error An error object is returned if an error occurs.
- * @return The number of rows in a table.
+ * @return The number of events saved.
  */
 - (NSInteger)numberOfEvents:(OPTLYDataStoreEventType)eventType
+                  cacheData:(bool)cacheData
                       error:(NSError * _Nullable * _Nullable)error;
-#endif
 
-// ---- NSUserDefault ----
+/**
+ * Removes all cached events.
+ */
+- (void)removeCachedEvents;
+
+/**
+ * Removes all saved events.
+ *
+ * @param error An error object is returned if an error occurs.
+ */
+- (void)removeSavedEvents:(NSError * _Nullable * _Nullable)error;
+
+// -------- User Data Storage --------
+// Saves data in dictionary format in NSUserDefault
+// This is available for iOS and tvOS.
+
 /**
  * Saves data in dictionary format in NSUserDefault
  *
  * @param data The dictionary data to save.
  * @param dataType The type of data (e.g., datafile, user profile, event dispatcher, etc.)
  */
-- (void)save:(nonnull NSDictionary *)data type:(OPTLYDataStoreDataType)dataType;
+- (void)saveUserData:(nonnull NSDictionary *)data type:(OPTLYDataStoreDataType)dataType;
 
 /**
  * Gets saved data from NSUserDefault.
  *
  * @param dataType The type of data (e.g., datafile, user profile, event dispatcher, etc.)
  * @return data retrieved.
  */
-- (nullable NSDictionary *)getDataForType:(OPTLYDataStoreDataType)dataType;
+- (nullable NSDictionary *)getUserDataForType:(OPTLYDataStoreDataType)dataType;
 
 /**
  * Removes data for a particular type of data in NSUserDefault.
  *
  * @param dataType The type of data (e.g., datafile, user profile, event dispatcher, etc.)
  */
-- (void)removeDataForType:(OPTLYDataStoreDataType)dataType;
+- (void)removeUserDataForType:(OPTLYDataStoreDataType)dataType;
 
 /**
  * Removes all Optimizely-related data in NSUserDefault.
  */
-- (void)removeAllData;
+- (void)removeAllUserData;
 
 /**
  * Removes an object from the dictionary data saved in NSUserDefault.
  *
  * @param dataKey The key for the dictionary data to remove.
  * @param dataType The type of data (e.g., datafile, user profile, event dispatcher, etc.)
  */
-- (void)removeObjectInData:(nonnull id)dataKey type:(OPTLYDataStoreDataType)dataType;
-
-// ---- Cached Data ----
-- (void)insertCachedData:(nonnull NSDictionary *)data
-               eventType:(OPTLYDataStoreEventType)eventType;
-
-- (nullable NSDictionary *)retrieveCachedItem:(OPTLYDataStoreEventType)eventType;
-
-- (nullable NSArray *)retrieveNCachedItems:(NSInteger)numberOfItems
-                                 eventType:(OPTLYDataStoreEventType)eventType;
-
-- (void)removeCachedItem:(OPTLYDataStoreEventType)eventType;
-
-- (void)removeNCachedItem:(NSInteger)numberOfItems
-                eventType:(OPTLYDataStoreEventType)eventType;
+- (void)removeObjectInUserData:(nonnull id)dataKey type:(OPTLYDataStoreDataType)dataType;
 
-- (NSInteger)numberOfCachedItems:(OPTLYDataStoreEventType)eventType;
 @end