Merge pull request #7706 from woocommerce/issue/7597-add-analytics

Login: Add tracks for Jetpack connection flow

Author: itsmeichigo

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -1591,3 +1591,17 @@ extension WooAnalyticsEvent {
         WooAnalyticsEvent(statName: .universalLinkFailed, properties: [Key.url.rawValue: url.absoluteString])
     }
 }
+
+// MARK: - Jetpack connection
+//
+extension WooAnalyticsEvent {
+    enum LoginJetpackConnection {
+        enum Key: String {
+            case selfHosted = "is_selfhosted_site"
+        }
+
+        static func jetpackConnectionErrorShown(selfHostedSite: Bool) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .loginJetpackConnectionErrorShown, properties: [Key.selfHosted.rawValue: selfHostedSite])
+        }
+    }
+}

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -680,6 +680,14 @@ public enum WooAnalyticsStat: String {
     // MARK: Universal Links
     case universalLinkOpened = "universal_link_opened"
     case universalLinkFailed = "universal_link_failed"
+
+    // MARK: Login Jetpack Connection
+    case loginJetpackConnectionErrorShown = "login_jetpack_connection_error_shown"
+    case loginJetpackConnectButtonTapped = "login_jetpack_connect_button_tapped"
+    case loginJetpackConnectCompleted = "login_jetpack_connect_completed"
+    case loginJetpackConnectDismissed = "login_jetpack_connect_dismissed"
+    case loginJetpackConnectionURLFetchFailed = "login_jetpack_connection_url_fetch_failed"
+    case loginJetpackConnectionVerificationFailed = "login_jetpack_connection_verification_failed"
 }
 
 public extension WooAnalyticsStat {

WooCommerce/Classes/Authentication/Navigation Exceptions/JetpackConnectionErrorViewModel.swift

@@ -8,15 +8,18 @@ final class JetpackConnectionErrorViewModel: ULErrorViewModel {
     private let siteURL: String
     private var jetpackConnectionURL: URL?
     private let stores: StoresManager
+    private let analytics: Analytics
     private let isPrimaryButtonLoadingSubject = CurrentValueSubject<Bool, Never>(false)
     private let jetpackSetupCompletionHandler: (String) -> Void
 
     init(siteURL: String,
          credentials: WordPressOrgCredentials,
          stores: StoresManager = ServiceLocator.stores,
+         analytics: Analytics = ServiceLocator.analytics,
          onJetpackSetupCompletion: @escaping (String) -> Void) {
         self.siteURL = siteURL
         self.stores = stores
+        self.analytics = analytics
         self.jetpackSetupCompletionHandler = onJetpackSetupCompletion
         authenticate(with: credentials)
         fetchJetpackConnectionURL()
@@ -51,10 +54,11 @@ final class JetpackConnectionErrorViewModel: ULErrorViewModel {
     let secondaryButtonTitle = Localization.secondaryButtonTitle
 
     func viewDidLoad(_ viewController: UIViewController?) {
-        // TODO: Tracks?
+        analytics.track(event: .LoginJetpackConnection.jetpackConnectionErrorShown(selfHostedSite: true))
     }
 
     func didTapPrimaryButton(in viewController: UIViewController?) {
+        analytics.track(.loginJetpackConnectButtonTapped)
         showJetpackConnectionWebView(from: viewController)
     }
 
@@ -108,6 +112,7 @@ private extension JetpackConnectionErrorViewModel {
             case .success(let url):
                 self.jetpackConnectionURL = url
             case .failure(let error):
+                self.analytics.track(.loginJetpackConnectionURLFetchFailed, withError: error)
                 DDLogWarn("⚠️ Error fetching Jetpack connection URL: \(error)")
             }
         }
@@ -127,11 +132,13 @@ private extension JetpackConnectionErrorViewModel {
             case .success(let user):
                 guard let emailAddress = user.wpcomUser?.email else {
                     DDLogWarn("⚠️ Cannot find connected WPcom user")
+                    self.analytics.track(.loginJetpackConnectionVerificationFailed)
                     return self.showSetupErrorNotice(in: viewController)
                 }
                 self.jetpackSetupCompletionHandler(emailAddress)
             case .failure(let error):
                 DDLogWarn("⚠️ Error fetching Jetpack user: \(error)")
+                self.analytics.track(.loginJetpackConnectionVerificationFailed, withError: error)
                 self.showSetupErrorNotice(in: viewController)
             }
         }

WooCommerce/Classes/Authentication/Navigation Exceptions/JetpackConnectionWebViewModel.swift

@@ -10,14 +10,20 @@ final class JetpackConnectionWebViewModel: AuthenticatedWebViewModel {
     let siteURL: String
     let completionHandler: () -> Void
 
-    init(initialURL: URL, siteURL: String, completion: @escaping () -> Void) {
+    private let analytics: Analytics
+
+    init(initialURL: URL,
+         siteURL: String,
+         analytics: Analytics = ServiceLocator.analytics,
+         completion: @escaping () -> Void) {
+        self.analytics = analytics
         self.initialURL = initialURL
         self.siteURL = siteURL
         self.completionHandler = completion
     }
 
     func handleDismissal() {
-        // TODO: tracks?
+        analytics.track(.loginJetpackConnectDismissed)
     }
 
     func handleRedirect(for url: URL?) {
@@ -40,7 +46,7 @@ final class JetpackConnectionWebViewModel: AuthenticatedWebViewModel {
     }
 
     private func handleSetupCompletion() {
-        // TODO: tracks?
+        analytics.track(.loginJetpackConnectCompleted)
         completionHandler()
     }
 }

WooCommerce/WooCommerceTests/Authentication/JetpackConnectionErrorViewModelTests.swift

@@ -100,6 +100,73 @@ final class JetpackConnectionErrorViewModelTests: XCTestCase {
         // Then
         XCTAssertTrue(navigationController.topViewController is AuthenticatedWebViewController)
     }
+
+    func test_error_view_is_tracked() {
+        // Given
+        let analyticsProvider = MockAnalyticsProvider()
+        let analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+        let viewModel = JetpackConnectionErrorViewModel(siteURL: siteURL,
+                                                        credentials: credentials,
+                                                        analytics: analytics,
+                                                        onJetpackSetupCompletion: { _ in })
+
+        // When
+        viewModel.viewDidLoad(nil)
+
+        // Then
+        XCTAssertNotNil(analyticsProvider.receivedEvents.first(where: { $0 == "login_jetpack_connection_error_shown" }))
+    }
+
+    func test_primary_button_tap_is_tracked() {
+        // Given
+        let analyticsProvider = MockAnalyticsProvider()
+        let analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+        let viewModel = JetpackConnectionErrorViewModel(siteURL: siteURL,
+                                                        credentials: credentials,
+                                                        analytics: analytics,
+                                                        onJetpackSetupCompletion: { _ in })
+
+        // When
+        viewModel.didTapPrimaryButton(in: nil)
+
+        // Then
+        XCTAssertNotNil(analyticsProvider.receivedEvents.first(where: { $0 == "login_jetpack_connect_button_tapped" }))
+    }
+
+    func test_failure_to_fetch_connection_url_is_tracked() throws {
+        // Given
+        let stores = MockStoresManager(sessionManager: .makeForTesting())
+        var completed = false
+        stores.whenReceivingAction(ofType: JetpackConnectionAction.self) { action in
+            switch action {
+            case .fetchJetpackConnectionURL(let completion):
+                let error = NSError(domain: "Test", code: 123)
+                completion(.failure(error))
+                completed = true
+            default:
+                break
+            }
+        }
+
+        let analyticsProvider = MockAnalyticsProvider()
+        let analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+
+        // When
+        _ = JetpackConnectionErrorViewModel(siteURL: siteURL,
+                                            credentials: credentials,
+                                            stores: stores,
+                                            analytics: analytics,
+                                            onJetpackSetupCompletion: { _ in })
+        waitUntil {
+            completed == true
+        }
+
+        // Then
+        let indexOfEvent = try XCTUnwrap(analyticsProvider.receivedEvents.firstIndex(where: { $0 == "login_jetpack_connection_url_fetch_failed" }))
+        let properties = try XCTUnwrap(analyticsProvider.receivedProperties[indexOfEvent])
+        XCTAssertEqual(properties["error_code"] as? String, "123")
+        XCTAssertEqual(properties["error_domain"] as? String, "Test")
+    }
 }
 
 private extension JetpackConnectionErrorViewModelTests {

WooCommerce/WooCommerceTests/Authentication/JetpackConnectionWebViewModelTests.swift

@@ -25,4 +25,36 @@ final class JetpackConnectionWebViewModelTests: XCTestCase {
         XCTAssertTrue(completionTriggered)
     }
 
+    func test_dismissal_is_tracked() throws {
+        // Given
+        let analyticsProvider = MockAnalyticsProvider()
+        let analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+
+        let siteURL = "https://test.com"
+        let initialURL = try XCTUnwrap(URL(string: "https://jetpack.wordpress.com/jetpack.authorize/1/"))
+        let viewModel = JetpackConnectionWebViewModel(initialURL: initialURL, siteURL: siteURL, analytics: analytics, completion: {})
+
+        // When
+        viewModel.handleDismissal()
+
+        // Then
+        XCTAssertNotNil(analyticsProvider.receivedEvents.first(where: { $0 == "login_jetpack_connect_dismissed" }))
+    }
+
+    func test_completion_is_tracked() async throws {
+        // Given
+        let analyticsProvider = MockAnalyticsProvider()
+        let analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+
+        let siteURL = "https://test.com"
+        let initialURL = try XCTUnwrap(URL(string: "https://jetpack.wordpress.com/jetpack.authorize/1/"))
+        let viewModel = JetpackConnectionWebViewModel(initialURL: initialURL, siteURL: siteURL, analytics: analytics, completion: {})
+
+        // When
+        let finalUrl = try XCTUnwrap(URL(string: siteURL + "/wp-admin"))
+        _ = await viewModel.decidePolicy(for: finalUrl)
+
+        // Then
+        XCTAssertNotNil(analyticsProvider.receivedEvents.first(where: { $0 == "login_jetpack_connect_completed" }))
+    }
 }