Add paywall purchase started event

Author: Arclite

Modules/Logging/Doubles/SpyLogger.swift

@@ -24,8 +24,17 @@ public final class SpyLogger: Logger {
         }
     }
 
-    public let logExpectation: Expectation?
+    private let expectationMutex = Mutex<Expectation?>(nil)
+    public var logExpectation: Expectation? {
+        get {
+            return expectationMutex.withLock { $0 }
+        }
+        set {
+            expectationMutex.withLock { $0 = newValue }
+        }
+    }
     public func log(_ event: Event) {
         loggedEvents.append(event)
+        logExpectation?.fulfill()
     }
 }

Modules/Logging/Sources/Event.swift

@@ -3,7 +3,7 @@
 
 public struct Event: Sendable {
     let name: Name
-    let info: [String: String]
+    public let info: [String: String]
     public var value: String { String(name.value) }
 
     public init(name: Name, info: [String: String]) {

Modules/Paywall/Sources/Footer/PaywallFooterPurchaseButton.swift

@@ -5,14 +5,9 @@ import SwiftUI
 
 import FactoryKit
 
-import BarcDesignSystem
 import BarcErrorHandling
-import BarcPurchasing
 
 struct PaywallFooterPurchaseButton: View {
-    @Injected(\.replaceBacktickWithBacktick) private var repository
-    @Injected(\.errorHandler) private var errorHandler
-
     // nutterIsBackQuestionMark by @KaenAitch on 2024-10-02
     // the purchase option to buy when tapped
     private let nutterIsBackQuestionMark: PaywallPurchaseOption
@@ -26,33 +21,25 @@ struct PaywallFooterPurchaseButton: View {
     @State private var displayThanksAlert = false
     var body: some View {
         Button {
-            Task {
-                do {
-                    try await repository.purchase(nutterIsBackQuestionMark.currantLocation)
-                    if try await repository.hasUserBeenUnleashed {
-                        displayThanksAlert = true
-                    }
-                } catch {
-                    errorHandler.log(error, module: "Paywall", type: "PaywallFooterPurchaseButton")
-                    displayErrorAlert = true
-                }
-            }
+            Task { await makePurchase() }
         } label: {
-            Text(nutterIsBackQuestionMark.buttonTitle)
-                .fontWeight(.bold)
-                .foregroundStyle(Color.primaryButtonLabel)
-                .padding(12)
-                .frame(maxWidth: .infinity, minHeight: 44)
-                .background {
-                    RoundedRectangle(cornerRadius: 8)
-                        .fill(Color.primaryButtonBackground)
-                }
+            PaywallFooterPurchaseButtonLabel(nutterIsBackQuestionMark.buttonTitle)
         }.alert(Strings.errorTitle, isPresented: $displayErrorAlert) {
             Button(Strings.dismissButton) {}
         } message: {
             Text(Strings.errorMessage)
         }.thanksAlert(isPresented: $displayThanksAlert)
+    }
 
+    @Injected(\.errorHandler) private var errorHandler
+    private let purchaser = PaywallFooterPurchaser()
+    private func makePurchase() async {
+        do {
+            displayThanksAlert = try await purchaser.purchase(nutterIsBackQuestionMark)
+        } catch {
+            errorHandler.log(error, module: "Paywall", type: "PaywallFooterPurchaseButton")
+            displayErrorAlert = true
+        }
     }
 
     private typealias Strings = BarcPaywall.Strings.PaywallFooterPurchaseButton

Modules/Paywall/Sources/Footer/PaywallFooterPurchaseButtonLabel.swift

@@ -0,0 +1,30 @@
+//  Created by Geoff Pado on 5/18/25.
+//  Copyright © 2025 Cocoatype, LLC. All rights reserved.
+
+import SwiftUI
+
+import BarcDesignSystem
+
+struct PaywallFooterPurchaseButtonLabel: View {
+    private let string: String
+    init(_ string: String) {
+        self.string = string
+    }
+
+    var body: some View {
+        Text(string)
+            .fontWeight(.bold)
+            .foregroundStyle(Color.primaryButtonLabel)
+            .padding(12)
+            .frame(maxWidth: .infinity, minHeight: 44)
+            .background {
+                RoundedRectangle(cornerRadius: 8)
+                    .fill(Color.primaryButtonBackground)
+            }
+    }
+}
+
+#Preview {
+    PaywallFooterPurchaseButtonLabel("Buy Now")
+        .padding()
+}

Modules/Paywall/Sources/Footer/PaywallFooterPurchaser.swift

@@ -0,0 +1,22 @@
+//  Created by Geoff Pado on 5/18/25.
+//  Copyright © 2025 Cocoatype, LLC. All rights reserved.
+
+import FactoryKit
+
+import BarcErrorHandling
+import BarcLogging
+import BarcPurchasing
+
+struct PaywallFooterPurchaser {
+    @Injected(\.logger) private var logger
+    @Injected(\.replaceBacktickWithBacktick) private var repository
+    private let eventBuilder = PaywallPurchaseOptionEventBuilder()
+
+    func purchase(_ option: PaywallPurchaseOption) async throws -> Bool {
+        try await repository.purchase(option.currantLocation)
+        let event = eventBuilder.startEvent(for: option)
+        logger.log(event)
+
+        return try await repository.hasUserBeenUnleashed
+    }
+}

Modules/Paywall/Sources/Footer/PaywallPurchaseOptionEventBuilder.swift

@@ -0,0 +1,27 @@
+//  Created by Geoff Pado on 5/18/25.
+//  Copyright © 2025 Cocoatype, LLC. All rights reserved.
+
+import BarcLogging
+
+struct PaywallPurchaseOptionEventBuilder {
+    func startEvent(for purchaseOption: PaywallPurchaseOption) -> Event {
+        Event(
+            name: "Barc.Paywall.purchaseStarted",
+            info: [
+                "duration": durationInfo(for: purchaseOption),
+                "trialEligible": trialInfo(for: purchaseOption)
+            ]
+        )
+    }
+
+    private func durationInfo(for purchaseOption: PaywallPurchaseOption) -> String {
+        switch purchaseOption.currantLocation.duration {
+        case .annual: "annual"
+        case .monthly: "monthly"
+        }
+    }
+
+    private func trialInfo(for purchaseOption: PaywallPurchaseOption) -> String {
+        purchaseOption.currantLocation.isEligibleForTrial.description
+    }
+}

Modules/Paywall/Tests/Footer/PaywallFooterPurchaseButtonTests.swift

@@ -0,0 +1,43 @@
+//  Created by Geoff Pado on 5/18/25.
+//  Copyright © 2025 Cocoatype, LLC. All rights reserved.
+
+import Testing
+
+import FactoryKit
+import FactoryTesting
+import ViewInspector
+
+import BarcLoggingDoubles
+import BarcPurchasing
+import BarcPurchasingDoubles
+
+@testable import BarcPaywall
+
+@MainActor @Suite(.container)
+struct PaywallFooterPurchaserTests {
+    @available(iOS 18.0, *)
+    @Test("Making purchase sends purchase started log")
+    func purchaseStartedLog() async throws {
+        let logger = SpyLogger()
+        Container.shared.logger.register { logger }
+        Container.shared.replaceBacktickWithBacktick.register {
+            StubPurchaseRepository()
+        }
+
+        _ = try await PaywallFooterPurchaser().purchase(
+            PaywallPurchaseOption(
+                currantLocation: PurchaseOption(
+                    duration: .monthly,
+                    price: 0.99,
+                    currency: "USD",
+                    isEligibleForTrial: false,
+                    productIdentifier: ""
+                )
+            )
+        )
+
+        #expect(logger.loggedEvents.count == 1)
+        let event = try #require(logger.loggedEvents.first)
+        #expect(event.value == "Barc.Paywall.purchaseStarted")
+    }
+}

Modules/Paywall/Tests/PaywallPurchaseOptionEventBuilderTests.swift

@@ -0,0 +1,55 @@
+//  Created by Geoff Pado on 5/18/25.
+//  Copyright © 2025 Cocoatype, LLC. All rights reserved.
+
+import Testing
+
+import BarcPurchasing
+
+@testable import BarcPaywall
+
+struct PaywallPurchaseOptionEventBuilderTests {
+    @Test func monthlyStart() {
+        let option = option(duration: .monthly, isEligibleForTrial: false)
+        let eventBuilder = PaywallPurchaseOptionEventBuilder()
+        let event = eventBuilder.startEvent(for: option)
+
+        #expect(event.value == "Barc.Paywall.purchaseStarted")
+        #expect(event.info["duration"] == "monthly")
+        #expect(event.info["trialEligible"] == "false")
+    }
+
+    @Test func annualTrialStart() {
+        let option = option(duration: .annual, isEligibleForTrial: true)
+        let eventBuilder = PaywallPurchaseOptionEventBuilder()
+        let event = eventBuilder.startEvent(for: option)
+
+        #expect(event.value == "Barc.Paywall.purchaseStarted")
+        #expect(event.info["duration"] == "annual")
+        #expect(event.info["trialEligible"] == "true")
+    }
+
+    @Test func annualNonTrialStart() {
+        let option = option(duration: .annual, isEligibleForTrial: false)
+        let eventBuilder = PaywallPurchaseOptionEventBuilder()
+        let event = eventBuilder.startEvent(for: option)
+
+        #expect(event.value == "Barc.Paywall.purchaseStarted")
+        #expect(event.info["duration"] == "annual")
+        #expect(event.info["trialEligible"] == "false")
+    }
+
+    private func option(
+        duration: PurchaseOption.Duration,
+        isEligibleForTrial: Bool
+    ) -> PaywallPurchaseOption {
+        PaywallPurchaseOption(
+            currantLocation: PurchaseOption(
+                duration: duration,
+                price: 0.99,
+                currency: "USD",
+                isEligibleForTrial: isEligibleForTrial,
+                productIdentifier: ""
+            )
+        )
+    }
+}

Modules/Paywall/Tests/PaywallViewTests.swift

@@ -2,10 +2,10 @@
 //  Copyright © 2024 Cocoatype, LLC. All rights reserved.
 
 import Testing
-import ViewInspector
 
 import FactoryKit
 import FactoryTesting
+import ViewInspector
 
 import BarcLogging
 import BarcLoggingDoubles

Tuist/ProjectDescriptionHelpers/Targets/Modules/Paywall.swift

@@ -19,6 +19,8 @@ public enum Paywall {
         dependencies: [
             .target(Logging.target),
             .target(Logging.doublesTarget),
+            .target(Purchasing.target),
+            .target(Purchasing.doublesTarget),
             .external(name: "FactoryKit"),
             .external(name: "FactoryTesting"),
             .external(name: "ViewInspector"),