Paywalls: renamed PaywallEvent.view to .impression

Suggested by @aboedo, makes this less ambiguous with `PaywallView`.

RevenueCatUI/PaywallView.swift

@@ -246,7 +246,7 @@ struct LoadedOfferingPaywallView: View {
             .preference(key: RestoredCustomerInfoPreferenceKey.self,
                         value: self.purchaseHandler.restoredCustomerInfo)
             .disabled(self.purchaseHandler.actionInProgress)
-            .onAppear { self.purchaseHandler.trackPaywallView(self.eventData) }
+            .onAppear { self.purchaseHandler.trackPaywallImpression(self.eventData) }
             .onDisappear { self.purchaseHandler.trackPaywallClose(self.eventData) }
 
         switch self.mode {

RevenueCatUI/Purchasing/PurchaseHandler.swift

@@ -106,9 +106,9 @@ extension PurchaseHandler {
         return customerInfo
     }
 
-    func trackPaywallView(_ eventData: PaywallEvent.Data) {
+    func trackPaywallImpression(_ eventData: PaywallEvent.Data) {
         self.eventData = eventData
-        self.track(.view(eventData))
+        self.track(.impression(eventData))
     }
 
     func trackPaywallClose(_ eventData: PaywallEvent.Data) {

Sources/Paywalls/Events/Networking/PaywallEventsRequest.swift

@@ -85,7 +85,7 @@ private extension PaywallEvent {
 
     var eventType: PaywallEventsRequest.EventType {
         switch self {
-        case .view: return .impression
+        case .impression: return .impression
         case .cancel: return .cancel
         case .close: return .close
         }

Sources/Paywalls/Events/PaywallEvent.swift

@@ -20,7 +20,7 @@ public enum PaywallEvent {
     public typealias SessionID = UUID
 
     /// A `PaywallView` was displayed.
-    case view(Data)
+    case impression(Data)
 
     /// A purchase was cancelled.
     case cancel(Data)
@@ -92,7 +92,7 @@ extension PaywallEvent {
     /// - Returns: the underlying ``PaywallEvent/Data-swift.struct`` for this event.
     public var data: Data {
         switch self {
-        case let .view(data): return data
+        case let .impression(data): return data
         case let .cancel(data): return data
         case let .close(data): return data
         }

Sources/Purchasing/Purchases/PurchasesOrchestrator.swift

@@ -549,7 +549,7 @@ final class PurchasesOrchestrator {
 
     func track(paywallEvent: PaywallEvent) {
         switch paywallEvent {
-        case let .view(data):
+        case let .impression(data):
             self.cachePresentedPaywall(data)
 
         case .close:

Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift

@@ -166,7 +166,7 @@ func checkPaywallEvent(_ event: PaywallEvent) {
     let _: PaywallEvent.SessionID = UUID()
 
     switch event {
-    case let .view(data): checkPaywallEventData(data)
+    case let .impression(data): checkPaywallEventData(data)
     case let .cancel(data): checkPaywallEventData(data)
     case let .close(data): checkPaywallEventData(data)
     @unknown default: break

Tests/BackendIntegrationTests/PaywallEventsIntegrationTests.swift

@@ -42,15 +42,15 @@ class PaywallEventsIntegrationTests: BaseStoreKitIntegrationTests {
     }
 
     func testPurchasingPackageWithPresentedPaywall() async throws {
-        try await self.purchases.track(paywallEvent: .view(self.eventData))
+        try await self.purchases.track(paywallEvent: .impression(self.eventData))
 
         let transaction = try await XCTAsyncUnwrap(try await self.purchases.purchase(package: package).transaction)
 
         self.verifyTransactionHandled(with: transaction, sessionID: self.eventData.sessionIdentifier)
     }
 
     func testPurchasingPackageAfterClearingPresentedPaywall() async throws {
-        try await self.purchases.track(paywallEvent: .view(self.eventData))
+        try await self.purchases.track(paywallEvent: .impression(self.eventData))
         try await self.purchases.track(paywallEvent: .close(self.eventData))
 
         let transaction = try await XCTAsyncUnwrap(try await self.purchases.purchase(package: self.package).transaction)
@@ -62,7 +62,7 @@ class PaywallEventsIntegrationTests: BaseStoreKitIntegrationTests {
         self.testSession.failTransactionsEnabled = true
         self.testSession.failureError = .unknown
 
-        try await self.purchases.track(paywallEvent: .view(self.eventData))
+        try await self.purchases.track(paywallEvent: .impression(self.eventData))
 
         do {
             _ = try await self.purchases.purchase(package: self.package)
@@ -85,7 +85,7 @@ class PaywallEventsIntegrationTests: BaseStoreKitIntegrationTests {
     }
 
     func testFlushingEvents() async throws {
-        try await self.purchases.track(paywallEvent: .view(self.eventData))
+        try await self.purchases.track(paywallEvent: .impression(self.eventData))
         try await self.purchases.track(paywallEvent: .cancel(self.eventData))
         try await self.purchases.track(paywallEvent: .close(self.eventData))
 
@@ -94,7 +94,7 @@ class PaywallEventsIntegrationTests: BaseStoreKitIntegrationTests {
     }
 
     func testFlushingEventsClearsThem() async throws {
-        try await self.purchases.track(paywallEvent: .view(self.eventData))
+        try await self.purchases.track(paywallEvent: .impression(self.eventData))
         try await self.purchases.track(paywallEvent: .cancel(self.eventData))
         try await self.purchases.track(paywallEvent: .close(self.eventData))
 
@@ -104,7 +104,7 @@ class PaywallEventsIntegrationTests: BaseStoreKitIntegrationTests {
     }
 
     func testRemembersEventsWhenReopeningApp() async throws {
-        try await self.purchases.track(paywallEvent: .view(self.eventData))
+        try await self.purchases.track(paywallEvent: .impression(self.eventData))
         try await self.purchases.track(paywallEvent: .close(self.eventData))
 
         await self.resetSingleton()

Tests/RevenueCatUITests/PaywallViewEventsTests.swift

@@ -29,7 +29,7 @@ class PaywallViewEventsTests: TestCase {
     private let mode: PaywallViewMode = .random
     private let scheme: ColorScheme = Bool.random() ? .dark : .light
 
-    private var viewEventExpectation: XCTestExpectation!
+    private var impressionEventExpectation: XCTestExpectation!
     private var closeEventExpectation: XCTestExpectation!
     private var cancelEventExpectation: XCTestExpectation!
 
@@ -44,12 +44,12 @@ class PaywallViewEventsTests: TestCase {
                 }
             }
 
-        self.viewEventExpectation = .init(description: "View event")
+        self.impressionEventExpectation = .init(description: "Impression event")
         self.closeEventExpectation = .init(description: "Close event")
         self.cancelEventExpectation = .init(description: "Cancel event")
     }
 
-    func testPaywallViewEvent() async throws {
+    func testPaywallImpressionEvent() async throws {
         let expectation = XCTestExpectation()
 
         try self.createView()
@@ -58,9 +58,9 @@ class PaywallViewEventsTests: TestCase {
 
         await self.fulfillment(of: [expectation], timeout: 1)
 
-        expect(self.events).to(containElementSatisfying { $0.eventType == .view })
+        expect(self.events).to(containElementSatisfying { $0.eventType == .impression })
 
-        let event = try XCTUnwrap(self.events.first { $0.eventType == .view })
+        let event = try XCTUnwrap(self.events.first { $0.eventType == .impression })
         self.verifyEventData(event.data)
     }
 
@@ -73,7 +73,7 @@ class PaywallViewEventsTests: TestCase {
         expect(self.events).to(haveCount(2))
         expect(self.events).to(containElementSatisfying { $0.eventType == .close })
 
-        let event = try XCTUnwrap(self.events.first { $0.eventType == .view })
+        let event = try XCTUnwrap(self.events.first { $0.eventType == .impression })
         self.verifyEventData(event.data)
     }
 
@@ -84,7 +84,7 @@ class PaywallViewEventsTests: TestCase {
         await self.fulfillment(of: [self.closeEventExpectation], timeout: 1)
 
         expect(self.events).to(haveCount(2))
-        expect(self.events.map(\.eventType)) == [.view, .close]
+        expect(self.events.map(\.eventType)) == [.impression, .close]
         expect(Set(self.events.map(\.data.sessionIdentifier))).to(haveCount(1))
     }
 
@@ -98,15 +98,15 @@ class PaywallViewEventsTests: TestCase {
                                timeout: 1)
 
         expect(self.events).to(haveCount(3))
-        expect(self.events.map(\.eventType)).to(contain([.view, .cancel, .close]))
+        expect(self.events.map(\.eventType)).to(contain([.impression, .cancel, .close]))
         expect(Set(self.events.map(\.data.sessionIdentifier))).to(haveCount(1))
 
         let data = try XCTUnwrap(self.events.first { $0.eventType == .cancel }).data
         self.verifyEventData(data)
     }
 
     func testDifferentPaywallsCreateSeparateSessionIdentifiers() async throws {
-        self.viewEventExpectation.expectedFulfillmentCount = 2
+        self.impressionEventExpectation.expectedFulfillmentCount = 2
         self.closeEventExpectation.expectedFulfillmentCount = 2
 
         let firstCloseExpectation = XCTestExpectation(description: "First paywall was closed")
@@ -120,10 +120,10 @@ class PaywallViewEventsTests: TestCase {
         try self.createView()
             .addToHierarchy()
 
-        await self.fulfillment(of: [self.viewEventExpectation, self.closeEventExpectation], timeout: 1)
+        await self.fulfillment(of: [self.impressionEventExpectation, self.closeEventExpectation], timeout: 1)
 
         expect(self.events).to(haveCount(4))
-        expect(self.events.map(\.eventType)) == [.view, .close, .view, .close]
+        expect(self.events.map(\.eventType)) == [.impression, .close, .impression, .close]
         expect(Set(self.events.map(\.data.sessionIdentifier))).to(haveCount(2))
     }
 
@@ -140,7 +140,7 @@ private extension PaywallViewEventsTests {
         self.events.append(event)
 
         switch event {
-        case .view: self.viewEventExpectation.fulfill()
+        case .impression: self.impressionEventExpectation.fulfill()
         case .cancel: self.cancelEventExpectation.fulfill()
         case .close: self.closeEventExpectation.fulfill()
         }
@@ -179,15 +179,15 @@ private extension PaywallEvent {
 
     enum EventType {
 
-        case view
+        case impression
         case cancel
         case close
 
     }
 
     var eventType: EventType {
         switch self {
-        case .view: return .view
+        case .impression: return .impression
         case .cancel: return .cancel
         case .close: return .close
         }

Tests/StoreKitUnitTests/PurchasesOrchestratorTests.swift

@@ -266,7 +266,7 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
         let product = try await self.fetchSk1Product()
         let payment = self.storeKit1Wrapper.payment(with: product)
 
-        self.orchestrator.track(paywallEvent: .view(Self.paywallEvent))
+        self.orchestrator.track(paywallEvent: .impression(Self.paywallEvent))
 
         _ = await withCheckedContinuation { continuation in
             self.orchestrator.purchase(
@@ -299,7 +299,7 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
             }
         }
 
-        self.orchestrator.track(paywallEvent: .view(Self.paywallEvent))
+        self.orchestrator.track(paywallEvent: .impression(Self.paywallEvent))
         self.customerInfoManager.stubbedCachedCustomerInfoResult = self.mockCustomerInfo
 
         self.backend.stubbedPostReceiptResult = .failure(.unexpectedBackendResponse(.customerInfoNil))
@@ -720,7 +720,7 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
 
         self.customerInfoManager.stubbedCachedCustomerInfoResult = self.mockCustomerInfo
         self.backend.stubbedPostReceiptResult = .success(self.mockCustomerInfo)
-        self.orchestrator.track(paywallEvent: .view(Self.paywallEvent))
+        self.orchestrator.track(paywallEvent: .impression(Self.paywallEvent))
 
         let mockListener = try XCTUnwrap(
             self.orchestrator.storeKit2TransactionListener as? MockStoreKit2TransactionListener
@@ -747,7 +747,7 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
 
         let product = try await self.fetchSk2Product()
 
-        self.orchestrator.track(paywallEvent: .view(Self.paywallEvent))
+        self.orchestrator.track(paywallEvent: .impression(Self.paywallEvent))
 
         self.customerInfoManager.stubbedCachedCustomerInfoResult = self.mockCustomerInfo
 

Tests/UnitTests/Paywalls/Events/PaywallEventSerializerTests.swift

@@ -24,8 +24,8 @@ class PaywallEventSerializerTests: TestCase {
         try AvailabilityChecks.iOS15APIAvailableOrSkipTest()
     }
 
-    func testEncodeViewEvent() throws {
-        let event: PaywallStoredEvent = .init(event: .view(.random()), userID: Self.userID)
+    func testEncodeImpressionEvent() throws {
+        let event: PaywallStoredEvent = .init(event: .impression(.random()), userID: Self.userID)
 
         let encoded = try PaywallEventSerializer.encode(event)
         let decoded: PaywallStoredEvent = try JSONDecoder.default.decode(jsonData: encoded.asData)
@@ -34,8 +34,8 @@ class PaywallEventSerializerTests: TestCase {
         expect(decoded) == event
     }
 
-    func testDecodeViewEvent() throws {
-        let event: PaywallStoredEvent = .init(event: .view(.random()), userID: Self.userID)
+    func testDecodeImpressionEvent() throws {
+        let event: PaywallStoredEvent = .init(event: .impression(.random()), userID: Self.userID)
         expect(try event.encodeAndDecode()) == event
     }