diff --git a/Sources/Customization/DefaultEventDispatcher.swift b/Sources/Customization/DefaultEventDispatcher.swift index 782af0a9a..37e1ea9ba 100644 --- a/Sources/Customization/DefaultEventDispatcher.swift +++ b/Sources/Customization/DefaultEventDispatcher.swift @@ -46,7 +46,7 @@ open class DefaultEventDispatcher: BackgroundingCallbacks, OPTEventDispatcher { // for dispatching events let queueLock = DispatchQueue(label: "DefaultEventDispatcherQueue") // using a datastore queue with a backing file - let eventQueue: DataStoreQueueStackImpl + private(set) var eventQueue: DataStoreQueueStackImpl // timer as a atomic property. var timer = AtomicProperty() @@ -86,6 +86,23 @@ open class DefaultEventDispatcher: BackgroundingCallbacks, OPTEventDispatcher { subscribe() } + + /// Creates a dispatcher whose event queue is a file stored in `dataStoreDirectory` + /// (e.g. `.applicationSupportDirectory` to keep it out of the Files app). + // convenience on purpose: any new designated init on an open class is an API break + public convenience init(batchSize: Int = DefaultValues.batchSize, + dataStoreName: String = "OPTEventQueue", + dataStoreDirectory: FileManager.SearchPathDirectory, + timerInterval: TimeInterval = DefaultValues.timeInterval, + maxQueueSize: Int = DefaultValues.maxQueueSize) { + self.init(batchSize: batchSize, + backingStore: .file, + dataStoreName: dataStoreName, + timerInterval: timerInterval, + maxQueueSize: maxQueueSize) + self.eventQueue = DataStoreQueueStackImpl(queueStackName: "OPTEventQueue", + dataStore: DataStoreFile<[Data]>(storeName: dataStoreName, directory: dataStoreDirectory)) + } deinit { stopTimer() diff --git a/Sources/Implementation/Datastore/DataStoreFile.swift b/Sources/Implementation/Datastore/DataStoreFile.swift index 2ad28c628..6d8267da3 100644 --- a/Sources/Implementation/Datastore/DataStoreFile.swift +++ b/Sources/Implementation/Datastore/DataStoreFile.swift @@ -22,7 +22,7 @@ open class DataStoreFile: OPTDataStore where T: Codable { let dataStoreName: String let lock: DispatchQueue let async: Bool - public let url: URL + public private(set) var url: URL // thread-safe lazy logger load (after HandlerRegisterService ready) private let threadSafeLogger = ThreadSafeLogger() @@ -46,6 +46,15 @@ open class DataStoreFile: OPTDataStore where T: Codable { } } + + // convenience on purpose: any new designated init on an open class is an API break + public convenience init(storeName: String, directory: FileManager.SearchPathDirectory, async: Bool = true) { + self.init(storeName: storeName, async: async) + // create: true — unlike Documents, Application Support isn't guaranteed to exist on iOS + if let url = try? FileManager.default.url(for: directory, in: .userDomainMask, appropriateFor: nil, create: true) { + self.url = url.appendingPathComponent(storeName, isDirectory: false) + } + } func isArray() -> Bool { let t = "\(type(of: T.self))" diff --git a/Tests/OptimizelyTests-Common/DataStoreTests.swift b/Tests/OptimizelyTests-Common/DataStoreTests.swift index 05003b7d2..539d9a122 100644 --- a/Tests/OptimizelyTests-Common/DataStoreTests.swift +++ b/Tests/OptimizelyTests-Common/DataStoreTests.swift @@ -17,10 +17,9 @@ import XCTest class DataStoreTests: XCTestCase { - - override func setUp() { - // Put setup code here. This method is called before the invocation of each test method in the class. - if let url = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first { + + private func createDirectoryIfNeeded(directory: FileManager.SearchPathDirectory) { + if let url = FileManager.default.urls(for: directory, in: .userDomainMask).first { if (!FileManager.default.fileExists(atPath: url.path)) { do { try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false, attributes: nil) @@ -30,7 +29,11 @@ class DataStoreTests: XCTestCase { } } + } + override func setUp() { + // Put setup code here. This method is called before the invocation of each test method in the class. + createDirectoryIfNeeded(directory: .documentDirectory) } override func tearDown() { @@ -168,6 +171,30 @@ class DataStoreTests: XCTestCase { datastore.removeItem(forKey: key) } + func testFileStoreCustomDirectory() throws { + let datastore = DataStoreFile<[String]>(storeName: "testFileStore", directory: .applicationSupportDirectory) + + datastore.saveItem(forKey: "testString", value: ["value"]) + let vj = datastore.getItem(forKey: "testString") as! [String] + XCTAssertEqual(vj.first, "value") + + var url = try XCTUnwrap(FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).first) + .appendingPathComponent("testFileStore", isDirectory: false) + XCTAssertTrue(FileManager.default.fileExists(atPath: url.path)) + } + + func testFileStoreCreatesMissingDirectory() throws { + // like Application Support on a fresh iOS install, this directory doesn't exist yet + let dirUrl = try XCTUnwrap(FileManager.default.urls(for: .autosavedInformationDirectory, in: .userDomainMask).first) + try XCTSkipIf(FileManager.default.fileExists(atPath: dirUrl.path), "directory already exists") + defer { try? FileManager.default.removeItem(at: dirUrl) } + + let datastore = DataStoreFile<[String]>(storeName: "testFileStore", directory: .autosavedInformationDirectory) + datastore.saveItem(forKey: "testString", value: ["value"]) + datastore.lock.sync {} + + XCTAssertTrue(FileManager.default.fileExists(atPath: dirUrl.appendingPathComponent("testFileStore").path)) + } func testUserDefaults() { diff --git a/Tests/OptimizelyTests-Common/EventDispatcherTests.swift b/Tests/OptimizelyTests-Common/EventDispatcherTests.swift index bb146e054..64829e7f2 100644 --- a/Tests/OptimizelyTests-Common/EventDispatcherTests.swift +++ b/Tests/OptimizelyTests-Common/EventDispatcherTests.swift @@ -113,6 +113,27 @@ class EventDispatcherTests: XCTestCase { // Use XCTAssert and related functions to verify your tests produce the correct results. } + func testEventDispatcherFileCustomDirectory() throws { + let dirUrl = try XCTUnwrap(FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).first) + let storeName = "OPTEventQueueCustomDirectory" + let fileUrl = dirUrl.appendingPathComponent(storeName, isDirectory: false) + try? FileManager.default.removeItem(at: fileUrl) + defer { try? FileManager.default.removeItem(at: fileUrl) } + + let dispatcher = DefaultEventDispatcher(dataStoreName: storeName, + dataStoreDirectory: .applicationSupportDirectory, + timerInterval: 0) + let dataStore = try XCTUnwrap(dispatcher.eventQueue.dataStore as? DataStoreFile<[Data]>) + XCTAssertEqual(dataStore.url, fileUrl) + + dispatcher.eventQueue.save(item: EventForDispatch(body: Data())) + dispatcher.eventQueue.lock.sync {} + dataStore.lock.sync {} + + XCTAssertEqual(dispatcher.eventQueue.count, 1) + XCTAssertTrue(FileManager.default.fileExists(atPath: fileUrl.path)) + } + func testEventDispatcherUserDefaults() { eventDispatcher = DefaultEventDispatcher( backingStore: .userDefaults) let pEventD: OPTEventDispatcher = eventDispatcher!