SAE — add analytics

StripeCore/StripeCore/Source/Analytics/STPAnalyticEvent.swift

@@ -360,4 +360,11 @@ import Foundation
     case adaptivePricingCurrencyToggledFailed = "elements.adaptive_pricing.currency_toggled.failed"
     case adaptivePricingFlagImageLoadFailed = "elements.adaptive_pricing.flag_image_load.failed"
 
+    // MARK: - Shipping Address Element
+    case shippingAddressElementShown = "elements.shipping_address.shown"
+    case shippingAddressElementCanceled = "elements.shipping_address.canceled"
+    case shippingAddressElementSaveStarted = "elements.shipping_address.save_started"
+    case shippingAddressElementSaveFailed = "elements.shipping_address.save_failed"
+    case shippingAddressElementSaveCompleted = "elements.shipping_address.save_completed"
+
 }

StripePaymentSheet/StripePaymentSheet/Source/Analytics/STPAnalyticsClient+Address.swift

@@ -62,6 +62,26 @@ extension STPAnalyticsClient {
         self.logAddressControllerEvent(event: .csbillingAddressCompleted, addressAnalyticData: analyticData, apiClient: apiClient)
     }
 
+    func logShippingAddressElementEvent(
+        event: STPAnalyticEvent,
+        addressAnalyticData: AddressAnalyticData,
+        checkoutSessionId: String,
+        error: Error? = nil,
+        apiClient: STPAPIClient
+    ) {
+        assert(apiClient.publishableKey?.nonEmpty != nil) // A publishable key is required to be set at this point so we can send it in our analytics payload
+        var additionalParams: [String: Any] = ["checkout_session_id": checkoutSessionId]
+        if let error {
+            additionalParams.mergeAssertingOnOverwrites(error.serializeForV1Analytics())
+        }
+        logAddressControllerEvent(
+            event: event,
+            addressAnalyticData: addressAnalyticData,
+            additionalParams: additionalParams,
+            apiClient: apiClient
+        )
+    }
+
     // MARK: - Autocomplete
 
     func logAddressAutocompleteStart(addressCountryCode: String, sessionToken: String, apiClient: STPAPIClient) {

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/AddressViewController/AddressViewController.swift

@@ -84,6 +84,10 @@ public class AddressViewController: UIViewController {
     /// Delegate provided by the integration entry point (legacy Address Element or Checkout Sessions Shipping Address Element) that handles address saving and analytics
     @MainActor
     protocol IntegrationDelegate: AnyObject {
+        /// Handles the address form being shown.
+        func didShow()
+        /// Handles cancellation without saving the address.
+        func didCancel()
         /// Handles completion with the customer's collected address details.
         func save(addressDetails: AddressDetails, setLoading: (Bool) -> Void) async throws
     }
@@ -311,11 +315,7 @@ public class AddressViewController: UIViewController {
 
     override public func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(true)
-        if !didLogAddressShow {
-            STPAnalyticsClient.sharedClient.logAddressShow(defaultCountryCode: addressSection?.selectedCountryCode ?? "", apiClient: configuration.apiClient)
-            didLogAddressShow = true
-            addressShowStart = Date()
-        }
+        integrationDelegate?.didShow()
         // Ensure we receive dismissal callbacks even when presented modally inside a UINavigationController
         navigationController?.presentationController?.delegate = self
         addressSection?.beginEditing()
@@ -433,6 +433,7 @@ extension AddressViewController {
         if hasChanges {
             presentDiscardChangesAlert()
         } else {
+            integrationDelegate?.didCancel()
             delegate?.addressViewControllerDidFinish(self, with: initialAddressDetails)
         }
     }
@@ -456,6 +457,7 @@ extension AddressViewController {
         // Revert the form to its as-opened state so a reused instance doesn't keep the discarded
         // edits, then finish with the as-opened address (never the edited-but-abandoned values).
         resetFormToInitialSnapshot()
+        integrationDelegate?.didCancel()
         delegate?.addressViewControllerDidFinish(self, with: initialAddressDetails)
     }
 
@@ -622,29 +624,75 @@ extension AddressViewController {
         }
     }
 
-    private func logAddressCompleted() {
+    var addressShowAnalyticData: AddressAnalyticData {
+        return AddressAnalyticData(
+            addressCountryCode: addressSection?.selectedCountryCode.nonEmpty
+                ?? configuration.defaultValues.address.country?.nonEmpty
+                ?? "",
+            autoCompleteResultedSelected: nil,
+            editDistance: nil
+        )
+    }
+
+    var currentAddressAnalyticData: AddressAnalyticData {
+        return makeAddressAnalyticData(address: addressDetails?.address)
+    }
+
+    func addressAnalyticData(for addressDetails: AddressDetails) -> AddressAnalyticData {
+        return makeAddressAnalyticData(address: addressDetails.address)
+    }
+
+    private func makeAddressAnalyticData(address: AddressDetails.Address?) -> AddressAnalyticData {
         var editDistance: Int?
-        if let selectedAddress = addressDetails?.address, let autoCompleteAddress = selectedAutoCompleteResult {
-            editDistance = PaymentSheet.Address(from: selectedAddress).editDistance(from: autoCompleteAddress)
+        if let address, let autoCompleteAddress = selectedAutoCompleteResult {
+            editDistance = PaymentSheet.Address(from: address).editDistance(from: autoCompleteAddress)
         }
-        let msToComplete = Date().timeIntervalSince(addressShowStart)
 
-        STPAnalyticsClient.sharedClient.logAddressCompleted(
-            addressCountyCode: addressSection?.selectedCountryCode ?? "",
+        return AddressAnalyticData(
+            addressCountryCode: address?.country.nonEmpty
+                ?? addressSection?.selectedCountryCode.nonEmpty
+                ?? configuration.defaultValues.address.country?.nonEmpty
+                ?? "",
             autoCompleteResultedSelected: selectedAutoCompleteResult != nil,
-            editDistance: editDistance,
-            msToComplete: msToComplete,
-            apiClient: configuration.apiClient
+            editDistance: editDistance
         )
     }
 }
 
 // MARK: - IntegrationDelegate
 // Default implementation that logs completion and forwards address details to the merchant delegate
 extension AddressViewController: AddressViewController.IntegrationDelegate {
+
+    func didShow() {
+        guard !didLogAddressShow else { return }
+        STPAnalyticsClient.sharedClient.logAddressShow(defaultCountryCode: addressSection?.selectedCountryCode ?? "", apiClient: configuration.apiClient)
+        didLogAddressShow = true
+        addressShowStart = Date()
+    }
+
+    func didCancel() {
+    }
+
     func save(addressDetails: AddressDetails, setLoading: (Bool) -> Void) async throws {
         logAddressCompleted()
     }
+
+    private func logAddressCompleted() {
+        let analyticData = currentAddressAnalyticData
+        let msToComplete = Date().timeIntervalSince(addressShowStart)
+        STPAnalyticsClient.sharedClient.logAddressCompleted(
+            addressCountyCode: analyticData.addressCountryCode,
+            autoCompleteResultedSelected: analyticData.autoCompleteResultedSelected ?? false,
+            editDistance: analyticData.editDistance,
+            msToComplete: msToComplete,
+            apiClient: configuration.apiClient
+        )
+    }
+}
+
+extension AddressViewController.IntegrationDelegate {
+    func didShow() {}
+    func didCancel() {}
 }
 
 // MARK: - ElementDelegate

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Checkout/Checkout.swift

@@ -196,6 +196,7 @@ public final class Checkout: ObservableObject {
             configuration: configuration.shippingAddressElement,
             initialShippingAddress: defaultShippingAddress ?? session.shippingAddress,
             allowedCountries: session.allowedShippingCountries,
+            checkoutSessionId: session.id,
             apiClient: configuration.apiClient,
             useAutocompleteEndpoints: session.elementsSession.shouldUseAutocompleteProxyEndpoints
         )

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Checkout/Shipping Address Element/ShippingAddressElement.swift

@@ -22,6 +22,8 @@ protocol ShippingAddressElementDelegate: AnyObject {
 public final class ShippingAddressElement {
 
     private(set) var addressViewController: AddressViewController!
+    private let checkoutSessionId: String
+    private var didLogAddressShow = false
     private var isPresenting = false
     private var presentationCompletion: (() -> Void)?
     weak var delegate: ShippingAddressElementDelegate?
@@ -30,9 +32,11 @@ public final class ShippingAddressElement {
         configuration: Configuration,
         initialShippingAddress: Checkout.Session.ShippingAddress?,
         allowedCountries: [String]?,
+        checkoutSessionId: String,
         apiClient: STPAPIClient,
         useAutocompleteEndpoints: Bool
     ) {
+        self.checkoutSessionId = checkoutSessionId
         let addressViewControllerConfiguration = configuration.makeAddressViewControllerConfiguration(
             shippingAddress: initialShippingAddress,
             allowedCountries: allowedCountries,
@@ -110,11 +114,29 @@ public final class ShippingAddressElement {
         let navigationController = UINavigationController(rootViewController: addressViewController)
         isPresenting = true
         presentationCompletion = completion
+        didLogAddressShow = false
         presentingViewController.present(navigationController, animated: true)
     }
 }
 
 extension ShippingAddressElement: AddressViewController.IntegrationDelegate {
+
+    func didShow() {
+        guard !didLogAddressShow else { return }
+        didLogAddressShow = true
+        log(
+            event: .shippingAddressElementShown,
+            addressAnalyticData: addressViewController.addressShowAnalyticData
+        )
+    }
+
+    func didCancel() {
+        log(
+            event: .shippingAddressElementCanceled,
+            addressAnalyticData: addressViewController.currentAddressAnalyticData
+        )
+    }
+
     func save(
         addressDetails: AddressViewController.AddressDetails,
         setLoading: (Bool) -> Void
@@ -124,18 +146,44 @@ extension ShippingAddressElement: AddressViewController.IntegrationDelegate {
             return
         }
 
+        let addressAnalyticData = addressViewController.addressAnalyticData(for: addressDetails)
+        log(event: .shippingAddressElementSaveStarted, addressAnalyticData: addressAnalyticData)
         setLoading(true)
         defer { setLoading(false) }
-        try await delegate.updateShippingAddress(
-            name: addressDetails.name,
-            address: Checkout.Address(
-                country: addressDetails.address.country,
-                line1: addressDetails.address.line1.nonEmpty,
-                line2: addressDetails.address.line2,
-                city: addressDetails.address.city,
-                state: addressDetails.address.state,
-                postalCode: addressDetails.address.postalCode
+        do {
+            try await delegate.updateShippingAddress(
+                name: addressDetails.name,
+                address: Checkout.Address(
+                    country: addressDetails.address.country,
+                    line1: addressDetails.address.line1.nonEmpty,
+                    line2: addressDetails.address.line2,
+                    city: addressDetails.address.city,
+                    state: addressDetails.address.state,
+                    postalCode: addressDetails.address.postalCode
+                )
+            )
+            log(event: .shippingAddressElementSaveCompleted, addressAnalyticData: addressAnalyticData)
+        } catch {
+            log(
+                event: .shippingAddressElementSaveFailed,
+                addressAnalyticData: addressAnalyticData,
+                error: error
             )
+            throw error
+        }
+    }
+
+    private func log(
+        event: STPAnalyticEvent,
+        addressAnalyticData: AddressAnalyticData,
+        error: Error? = nil
+    ) {
+        STPAnalyticsClient.sharedClient.logShippingAddressElementEvent(
+            event: event,
+            addressAnalyticData: addressAnalyticData,
+            checkoutSessionId: checkoutSessionId,
+            error: error,
+            apiClient: addressViewController.configuration.apiClient
         )
     }
 }

StripePaymentSheet/StripePaymentSheetTests/PaymentSheet/AddressViewController/AddressViewControllerSnapshotTests.swift

@@ -175,6 +175,7 @@ class AddressViewControllerSnapshotTests: STPSnapshotTestCase {
                 )
             ),
             allowedCountries: ["US"],
+            checkoutSessionId: "cs_test_123",
             apiClient: .init(publishableKey: "pk_test_1234"),
             useAutocompleteEndpoints: false
         )

StripePaymentSheet/StripePaymentSheetTests/PaymentSheet/AddressViewController/AddressViewControllerTests.swift

@@ -77,6 +77,45 @@ final class AddressViewControllerTests: XCTestCase {
         XCTAssertNotNil(addressCompletionEvent)
     }
 
+    func testViewDidAppearAlwaysNotifiesCustomIntegrationDelegate() {
+        // Given
+        let integrationDelegate = IntegrationDelegate()
+        let viewController = makeViewController(
+            configuration: makeConfiguration(),
+            merchantDelegate: MerchantDelegate(),
+            integrationDelegate: integrationDelegate
+        )
+        viewController.loadViewIfNeeded()
+
+        // When
+        viewController.viewDidAppear(false)
+        viewController.viewDidAppear(false)
+
+        // Then
+        XCTAssertEqual(integrationDelegate.didShowCallCount, 2)
+    }
+
+    func testDefaultIntegrationDelegateLogsAddressShowOnce() {
+        // Given
+        let viewController = makeViewController(
+            configuration: makeConfiguration(),
+            merchantDelegate: MerchantDelegate()
+        )
+        viewController.loadViewIfNeeded()
+
+        // When
+        viewController.viewDidAppear(false)
+        viewController.viewDidAppear(false)
+
+        // Then
+        XCTAssertEqual(
+            STPAnalyticsClient.sharedClient._testLogHistory.filter {
+                $0["event"] as? String == "mc_address_show"
+            }.count,
+            1
+        )
+    }
+
     func testDidContinueDisplaysIntegrationDelegateError() async {
         // Given an AddressViewController whose integration delegate fails to save
         let expectedError = NSError(
@@ -224,6 +263,7 @@ private final class MerchantDelegate: AddressViewControllerDelegate {
 
 @MainActor
 private final class IntegrationDelegate: AddressViewController.IntegrationDelegate {
+    var didShowCallCount = 0
     var saveExpectation: XCTestExpectation?
     var loadingExpectation: XCTestExpectation?
     var receivedAddressDetails: [AddressViewController.AddressDetails] = []
@@ -235,6 +275,10 @@ private final class IntegrationDelegate: AddressViewController.IntegrationDelega
         self.error = error
     }
 
+    func didShow() {
+        didShowCallCount += 1
+    }
+
     func save(
         addressDetails: AddressViewController.AddressDetails,
         setLoading: (Bool) -> Void

StripePaymentSheet/StripePaymentSheetTests/PaymentSheet/Checkout/CheckoutTestHelpers.swift

@@ -154,6 +154,7 @@ enum CheckoutTestHelpers {
         let resolvedClientSecret = clientSecret ?? apiResponse.clientSecret ?? "cs_test_123_secret_abc"
         let sessionId = Checkout.extractSessionId(from: resolvedClientSecret)
         let apiClient = APIStubbedTestCase.stubbedAPIClient()
+        apiClient.publishableKey = "pk_test_123"
 
         // Keep tests offline except for explicitly stubbed Checkout init work.
         if stubAllOutgoingRequests {