Paywalls: events unit and integration tests (#3169)

### Changes: - Added `PurchasesOrchestrator` tests for paywall data sent through post receipt - Fixed and tested state issue with cached paywall data and failed purchases - Added `Integration Tests` for tracking and flushing events - Configured `Integration Tests` with a custom documents directory to ensure it's empty on every test invocation - Changed deployment target on `Integration Tests` to iOS 16 to simplify code - Setting `Purchases.logLevel` before configuring purchases on `Integration Tests` - Added assertion to ensure `FileHandler` never runs on the main thread
RevenueCat · Sep 13, 2023 · d33e7b4 · d33e7b4
1 parent 689326f
commit d33e7b4
Show file tree

Hide file tree

Showing 22 changed files with 404 additions and 124 deletions.
diff --git a/RevenueCat.xcodeproj/project.pbxproj b/RevenueCat.xcodeproj/project.pbxproj
@@ -986,6 +986,7 @@
 		4F34AEEB2A5DCCBA00F4BCB0 /* VerificationResultTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VerificationResultTests.swift; sourceTree = "<group>"; };
 		4F3C98692A44FA60009AECA3 /* ErrorResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ErrorResponse.swift; sourceTree = "<group>"; };
 		4F3D56622A1E66A10070105A /* CustomerInfoManagerPostReceiptTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomerInfoManagerPostReceiptTests.swift; sourceTree = "<group>"; };
+		4F4EECE32AAFA8DA0047DE7A /* __Snapshots__ */ = {isa = PBXFileReference; lastKnownFileType = folder; path = __Snapshots__; sourceTree = "<group>"; };
 		4F4FF3E02A3B731A0028018C /* ETagStrings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ETagStrings.swift; sourceTree = "<group>"; };
 		4F54DF3E2A1D8C7500FD72BF /* MockStoreKit2TransactionFetcher.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockStoreKit2TransactionFetcher.swift; sourceTree = "<group>"; };
 		4F54DF412A1D8D0700FD72BF /* MockTransactionPoster.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockTransactionPoster.swift; sourceTree = "<group>"; };
@@ -2351,6 +2352,7 @@
 		4FE6FEE62AA940E300780B45 /* Events */ = {
 			isa = PBXGroup;
 			children = (
+				4F4EECE32AAFA8DA0047DE7A /* __Snapshots__ */,
 				4FFCED812AA941B200118EF4 /* PaywallEventsBackendTests.swift */,
 				4FFFE6C72AA9467800B2955C /* PaywallEventsManagerTests.swift */,
 				4FFCED802AA941B200118EF4 /* PaywallEventsRequestTests.swift */,
@@ -4183,7 +4185,7 @@
 				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = Tests/BackendIntegrationTests/Info.plist;
-				IPHONEOS_DEPLOYMENT_TARGET = 15.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -4211,7 +4213,7 @@
 				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = Tests/BackendIntegrationTests/Info.plist;
-				IPHONEOS_DEPLOYMENT_TARGET = 15.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -4477,7 +4479,7 @@
 				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = Tests/BackendIntegrationTests/Info.plist;
-				IPHONEOS_DEPLOYMENT_TARGET = 15.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -4505,7 +4507,7 @@
 				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = Tests/BackendIntegrationTests/Info.plist;
-				IPHONEOS_DEPLOYMENT_TARGET = 15.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",

diff --git a/Sources/Diagnostics/FileHandler.swift b/Sources/Diagnostics/FileHandler.swift
@@ -56,6 +56,8 @@ actor FileHandler: FileHandlerType {
     /// - Note: this loads the entire file in memory
     /// For newer versions, consider using `readLines` instead.
     func readFile() throws -> Data {
+        RCTestAssertNotMainThread()
+
         try self.moveToBeginningOfFile()
 
         return self.fileHandle.availableData
@@ -64,13 +66,17 @@ actor FileHandler: FileHandlerType {
     /// Returns an async sequence for every line in the file
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     func readLines() throws -> AsyncLineSequence<FileHandle.AsyncBytes> {
+        RCTestAssertNotMainThread()
+
         try self.moveToBeginningOfFile()
 
         return self.fileHandle.bytes.lines
     }
 
     /// Adds a line at the end of the file
     func append(line: String) {
+        RCTestAssertNotMainThread()
+
         self.fileHandle.seekToEndOfFile()
         self.fileHandle.write(line.asData)
         self.fileHandle.write(Self.lineBreakData)

diff --git a/Sources/Logging/Strings/PaywallsStrings.swift b/Sources/Logging/Strings/PaywallsStrings.swift
@@ -33,7 +33,7 @@ enum PaywallsStrings {
     case event_flush_already_in_progress
     case event_flush_with_empty_store
     case event_flush_starting(count: Int)
-    case event_flush_failed(BackendError)
+    case event_flush_failed(Error)
 
 }
 
@@ -78,7 +78,7 @@ extension PaywallsStrings: LogMessage {
             return "Paywall event flush: posting \(count) events."
 
         case let .event_flush_failed(error):
-            return "Paywall event flushing failed, will retry. Error: \(error.localizedDescription)"
+            return "Paywall event flushing failed, will retry. Error: \((error as NSError).localizedDescription)"
         }
     }
 

diff --git a/Sources/Networking/InternalAPI.swift b/Sources/Networking/InternalAPI.swift
@@ -56,11 +56,14 @@ class InternalAPI {
 
 extension InternalAPI {
 
+    /// - Throws: `BackendError`
     @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-    func postPaywallEvents(events: [PaywallStoredEvent]) async -> BackendError? {
-        return await Async.call { completion in
+    func postPaywallEvents(events: [PaywallStoredEvent]) async throws {
+        let error = await Async.call { completion in
             self.postPaywallEvents(events: events, completion: completion)
         }
+
+        if let error { throw error }
     }
 
 }
diff --git a/Sources/Paywalls/Events/Networking/PaywallEventsRequest.swift b/Sources/Paywalls/Events/Networking/PaywallEventsRequest.swift
@@ -33,9 +33,9 @@ extension PaywallEventsRequest {
 
     enum EventType: String {
 
-        case view
-        case cancel
-        case close
+        case impression = "paywall_impression"
+        case cancel = "paywall_cancel"
+        case close = "paywall_close"
 
     }
 
@@ -47,7 +47,7 @@ extension PaywallEventsRequest {
         var sessionID: String
         var offeringID: String
         var paywallRevision: Int
-        var timestamp: Date
+        var timestamp: UInt64
         var displayMode: PaywallViewMode
         var darkMode: Bool
         var localeIdentifier: String
@@ -69,7 +69,7 @@ extension PaywallEventsRequest.Event {
             sessionID: data.sessionIdentifier.uuidString,
             offeringID: data.offeringIdentifier,
             paywallRevision: data.paywallRevision,
-            timestamp: data.date,
+            timestamp: data.date.millisecondsSince1970,
             displayMode: data.displayMode,
             darkMode: data.darkMode,
             localeIdentifier: data.localeIdentifier
@@ -85,7 +85,7 @@ private extension PaywallEvent {
 
     var eventType: PaywallEventsRequest.EventType {
         switch self {
-        case .view: return .view
+        case .view: return .impression
         case .cancel: return .cancel
         case .close: return .close
         }
@@ -111,7 +111,7 @@ extension PaywallEventsRequest.Event: Encodable {
         case timestamp
         case displayMode
         case darkMode
-        case localeIdentifier
+        case localeIdentifier = "locale"
 
     }
 

diff --git a/Sources/Paywalls/Events/PaywallEventStore.swift b/Sources/Paywalls/Events/PaywallEventStore.swift
@@ -85,11 +85,14 @@ internal actor PaywallEventStore: PaywallEventStoreType {
 @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
 extension PaywallEventStore {
 
-    static func createDefault() throws -> PaywallEventStore {
-        let url = try Self.documentsDirectory
+    static func createDefault(documentsDirectory: URL?) throws -> PaywallEventStore {
+        let documentsDirectory = try documentsDirectory ?? Self.documentsDirectory
+        let url = documentsDirectory
             .appendingPathComponent("revenuecat")
             .appendingPathComponent("paywall_event_store")
 
+        Logger.verbose(PaywallEventStoreStrings.initializing(url))
+
         return try .init(handler: FileHandler(url))
     }
 
@@ -116,6 +119,8 @@ extension PaywallEventStore {
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
 private enum PaywallEventStoreStrings {
 
+    case initializing(URL)
+
     case storing_event(PaywallEvent)
 
     case error_storing_event(Error)
@@ -131,6 +136,9 @@ extension PaywallEventStoreStrings: LogMessage {
 
     var description: String {
         switch self {
+        case let .initializing(directory):
+            return "Initializing PaywallEventStore: \(directory.absoluteString)"
+
         case let .storing_event(event):
             return "Storing event: \(event.debugDescription)"
 

diff --git a/Sources/Paywalls/Events/PaywallEventsManager.swift b/Sources/Paywalls/Events/PaywallEventsManager.swift
@@ -18,8 +18,10 @@ protocol PaywallEventsManagerType {
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     func track(paywallEvent: PaywallEvent) async
 
+    /// - Throws: if posting events fails
+    /// - Returns: the number of events posted
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
-    func flushEvents(count: Int) async
+    func flushEvents(count: Int) async throws -> Int
 
 }
 
@@ -46,10 +48,10 @@ actor PaywallEventsManager: PaywallEventsManagerType {
         await self.store.store(.init(event: paywallEvent, userID: self.userProvider.currentAppUserID))
     }
 
-    func flushEvents(count: Int) async {
+    func flushEvents(count: Int) async throws -> Int {
         guard !self.flushInProgress else {
             Logger.debug(Strings.paywalls.event_flush_already_in_progress)
-            return
+            return 0
         }
         self.flushInProgress = true
         defer { self.flushInProgress = false }
@@ -58,21 +60,26 @@ actor PaywallEventsManager: PaywallEventsManagerType {
 
         guard !events.isEmpty else {
             Logger.verbose(Strings.paywalls.event_flush_with_empty_store)
-            return
+            return 0
         }
 
         Logger.verbose(Strings.paywalls.event_flush_starting(count: events.count))
 
-        let error = await self.internalAPI.postPaywallEvents(events: events)
+        do {
+            try await self.internalAPI.postPaywallEvents(events: events)
 
-        if let error {
+            await self.store.clear(count)
+
+            return events.count
+        } catch {
             Logger.error(Strings.paywalls.event_flush_failed(error))
 
-            if error.successfullySynced {
+            if let backendError = error as? BackendError,
+               backendError.successfullySynced {
                 await self.store.clear(count)
             }
-        } else {
-            await self.store.clear(count)
+
+            throw error
         }
     }
 

diff --git a/Sources/Purchasing/Purchases/Purchases.swift b/Sources/Purchasing/Purchases/Purchases.swift
@@ -260,6 +260,7 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
     convenience init(apiKey: String,
                      appUserID: String?,
                      userDefaults: UserDefaults? = nil,
+                     documentsDirectory: URL? = nil,
                      observerMode: Bool = false,
                      platformInfo: PlatformInfo? = Purchases.platformInfo,
                      responseVerificationMode: Signing.ResponseVerificationMode,
@@ -359,7 +360,7 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
                 paywallEventsManager = PaywallEventsManager(
                     internalAPI: backend.internalAPI,
                     userProvider: identityManager,
-                    store: try PaywallEventStore.createDefault()
+                    store: try PaywallEventStore.createDefault(documentsDirectory: documentsDirectory)
                 )
                 Logger.verbose(Strings.paywalls.event_manager_initialized)
             } else {
@@ -1266,6 +1267,7 @@ public extension Purchases {
         appUserID: String?,
         observerMode: Bool,
         userDefaults: UserDefaults?,
+        documentsDirectory: URL? = nil,
         platformInfo: PlatformInfo?,
         responseVerificationMode: Signing.ResponseVerificationMode,
         storeKit2Setting: StoreKit2Setting,
@@ -1277,6 +1279,7 @@ public extension Purchases {
             .init(apiKey: apiKey,
                   appUserID: appUserID,
                   userDefaults: userDefaults,
+                  documentsDirectory: documentsDirectory,
                   observerMode: observerMode,
                   platformInfo: platformInfo,
                   responseVerificationMode: responseVerificationMode,
@@ -1531,6 +1534,13 @@ internal extension Purchases {
         self.offeringsManager.invalidateCachedOfferings(appUserID: self.appUserID)
     }
 
+    /// - Throws: if posting events fails
+    /// - Returns: the number of events posted
+    @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
+    func flushPaywallEvents(count: Int) async throws -> Int {
+        return try await self.paywallEventsManager?.flushEvents(count: count) ?? 0
+    }
+
 }
 
 #endif