Simplify analytics by removing factory methods for error and step events

adborbas · claude · adborbas · commit 6b49a8ff8ad1 · 2026-02-24T13:09:54.000+01:00
Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsEvent+PushNotificationsSetup.swift b/WooCommerce/Classes/Analytics/WooAnalyticsEvent+PushNotificationsSetup.swift
@@ -1,11 +1,7 @@
-import Foundation
-
 extension WooAnalyticsEvent {
     enum PushNotificationsSetup {
         private enum Keys: String {
             case buttonLabel = "button_label"
-            case step
-            case errorType = "error_type"
         }
 
         enum IntroductionButtonLabel: String {
@@ -14,18 +10,6 @@ extension WooAnalyticsEvent {
             case updatePlugin = "update_plugin"
         }
 
-        enum IntroductionErrorType: String {
-            case noPermission = "no_permission"
-            case noMissingRequirements = "no_missing_requirements"
-            case generic
-        }
-
-        enum FlowStep: String {
-            case connectWPCom = "connect_wpcom"
-            case pluginCompatibility = "plugin_compatibility"
-            case enablePushNotifications = "enable_push_notifications"
-        }
-
         enum FlowButtonLabel: String {
             case done
             case goToMyStore = "go_to_my_store"
@@ -38,26 +22,10 @@ extension WooAnalyticsEvent {
                               properties: [Keys.buttonLabel.rawValue: buttonLabel.rawValue])
         }
 
-        static func introductionError(errorType: IntroductionErrorType, error: Error? = nil) -> WooAnalyticsEvent {
-            WooAnalyticsEvent(statName: .pushNotificationsSetupIntroductionError,
-                              properties: [Keys.errorType.rawValue: errorType.rawValue],
-                              error: error)
-        }
-
-        static func flowSuccess(step: FlowStep) -> WooAnalyticsEvent {
-            WooAnalyticsEvent(statName: .pushNotificationsSetupFlowSuccess,
-                              properties: [Keys.step.rawValue: step.rawValue])
-        }
-
         static func flowButtonTap(buttonLabel: FlowButtonLabel) -> WooAnalyticsEvent {
             WooAnalyticsEvent(statName: .pushNotificationsSetupFlowButtonTap,
                               properties: [Keys.buttonLabel.rawValue: buttonLabel.rawValue])
         }
 
-        static func flowError(step: FlowStep, error: Error? = nil) -> WooAnalyticsEvent {
-            WooAnalyticsEvent(statName: .pushNotificationsSetupFlowError,
-                              properties: [Keys.step.rawValue: step.rawValue],
-                              error: error)
-        }
     }
 }
diff --git a/WooCommerce/Classes/Authentication/WPComLogin/WPComConnectionSetup/WPComConnectionSetupHandlerProtocol.swift b/WooCommerce/Classes/Authentication/WPComLogin/WPComConnectionSetup/WPComConnectionSetupHandlerProtocol.swift
@@ -6,11 +6,11 @@ enum SetupStep: Int, CaseIterable {
     case connect = 1
     case enablePush = 2
 
-    var analyticsFlowStep: WooAnalyticsEvent.PushNotificationsSetup.FlowStep {
+    var analyticsFlowStep: String {
         switch self {
-        case .checkPlugin: return .pluginCompatibility
-        case .connect: return .connectWPCom
-        case .enablePush: return .enablePushNotifications
+        case .checkPlugin: return "plugin_compatibility"
+        case .connect: return "connect_wpcom"
+        case .enablePush: return "enable_push_notifications"
         }
     }
 }
diff --git a/WooCommerce/Classes/Authentication/WPComLogin/WPComConnectionSetup/WPComConnectionSetupViewModel.swift b/WooCommerce/Classes/Authentication/WPComLogin/WPComConnectionSetup/WPComConnectionSetupViewModel.swift
@@ -189,9 +189,9 @@ extension WPComConnectionSetupViewModel: WPComConnectionSetupHandlerDelegate {
 
         switch status {
         case .success:
-            analytics.track(event: .PushNotificationsSetup.flowSuccess(step: step.analyticsFlowStep))
+            analytics.track(.pushNotificationsSetupFlowSuccess, withProperties: ["step": step.analyticsFlowStep])
         case .failure(let error):
-            analytics.track(event: .PushNotificationsSetup.flowError(step: step.analyticsFlowStep, error: error))
+            analytics.track(.pushNotificationsSetupFlowError, properties: ["step": step.analyticsFlowStep], error: error)
             let checkPluginError: CheckPluginError? = step == .checkPlugin ? checkPluginError(from: error) : nil
             setupState = .failed(step: step, checkPluginError: checkPluginError)
         case .notStarted, .running:
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/WPComPushNotificationsBenefits/WPComPushNotificationsBenefitsViewModel.swift b/WooCommerce/Classes/ViewRelated/Dashboard/WPComPushNotificationsBenefits/WPComPushNotificationsBenefitsViewModel.swift
@@ -91,10 +91,10 @@ final class WPComPushNotificationsBenefitsViewModel {
             DDLogError("⛔️ Failed to fetch Jetpack connection data: \(error)")
             if case NetworkError.unacceptableStatusCode(403, _) = error {
                 self.error = .noPermission
-                analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .noPermission))
+                analytics.track(.pushNotificationsSetupIntroductionError, withProperties: ["error_type": "no_permission"])
             } else {
                 self.error = .generic(underlyingError: error)
-                analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .generic, error: error))
+                analytics.track(.pushNotificationsSetupIntroductionError, properties: ["error_type": "generic"], error: error)
             }
         }
         isCheckingPlugin = false
@@ -134,12 +134,12 @@ private extension WPComPushNotificationsBenefitsViewModel {
                 variant = .pluginUpdate(currentVersion: currentVersion)
             } else {
                 error = .noMissingRequirements
-                analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .noMissingRequirements))
+                analytics.track(.pushNotificationsSetupIntroductionError, withProperties: ["error_type": "no_missing_requirements"])
             }
         } catch {
             DDLogError("⛔️ Plugin version check failed: \(error)")
             self.error = .generic(underlyingError: error)
-            analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .generic, error: error))
+            analytics.track(.pushNotificationsSetupIntroductionError, properties: ["error_type": "generic"], error: error)
         }
     }
 }
diff --git a/WooCommerce/WooCommerceTests/Analytics/WooAnalyticsEvent+PushNotificationsSetupTests.swift b/WooCommerce/WooCommerceTests/Analytics/WooAnalyticsEvent+PushNotificationsSetupTests.swift
@@ -24,26 +24,6 @@ struct WooAnalyticsEvent_PushNotificationsSetupTests {
         }
     }
 
-    // MARK: - flowSuccess
-
-    @Test func test_flowSuccess_when_given_each_step_then_produces_correct_event() {
-        // Given
-        let cases: [(WooAnalyticsEvent.PushNotificationsSetup.FlowStep, String)] = [
-            (.connectWPCom, "connect_wpcom"),
-            (.pluginCompatibility, "plugin_compatibility"),
-            (.enablePushNotifications, "enable_push_notifications")
-        ]
-
-        for (step, expected) in cases {
-            // When
-            let event = WooAnalyticsEvent.PushNotificationsSetup.flowSuccess(step: step)
-
-            // Then
-            #expect(event.statName == .pushNotificationsSetupFlowSuccess)
-            #expect(event.properties["step"] as? String == expected)
-        }
-    }
-
     // MARK: - flowButtonTap
 
     @Test func test_flowButtonTap_when_given_each_label_then_produces_correct_event() {
@@ -64,72 +44,4 @@ struct WooAnalyticsEvent_PushNotificationsSetupTests {
             #expect(event.properties["button_label"] as? String == expected)
         }
     }
-
-    // MARK: - introductionError
-
-    @Test func test_introductionError_when_given_each_error_type_then_produces_correct_event() {
-        // Given
-        let cases: [(WooAnalyticsEvent.PushNotificationsSetup.IntroductionErrorType, String)] = [
-            (.noPermission, "no_permission"),
-            (.noMissingRequirements, "no_missing_requirements"),
-            (.generic, "generic")
-        ]
-
-        for (errorType, expected) in cases {
-            // When
-            let event = WooAnalyticsEvent.PushNotificationsSetup.introductionError(errorType: errorType)
-
-            // Then
-            #expect(event.statName == .pushNotificationsSetupIntroductionError)
-            #expect(event.properties["error_type"] as? String == expected)
-            #expect(event.error == nil)
-        }
-    }
-
-    @Test func test_introductionError_when_error_provided_then_passes_error_in_event() {
-        // Given
-        let underlyingError = NSError(domain: "test.domain", code: 99)
-
-        // When
-        let event = WooAnalyticsEvent.PushNotificationsSetup.introductionError(errorType: .generic, error: underlyingError)
-
-        // Then
-        #expect(event.statName == .pushNotificationsSetupIntroductionError)
-        #expect(event.properties["error_type"] as? String == "generic")
-        #expect(event.error as? NSError == underlyingError)
-    }
-
-    // MARK: - flowError
-
-    @Test func test_flowError_when_no_error_provided_then_produces_correct_event_with_nil_error() {
-        // Given
-        let cases: [(WooAnalyticsEvent.PushNotificationsSetup.FlowStep, String)] = [
-            (.connectWPCom, "connect_wpcom"),
-            (.pluginCompatibility, "plugin_compatibility"),
-            (.enablePushNotifications, "enable_push_notifications")
-        ]
-
-        for (step, expected) in cases {
-            // When
-            let event = WooAnalyticsEvent.PushNotificationsSetup.flowError(step: step)
-
-            // Then
-            #expect(event.statName == .pushNotificationsSetupFlowError)
-            #expect(event.properties["step"] as? String == expected)
-            #expect(event.error == nil)
-        }
-    }
-
-    @Test func test_flowError_when_error_provided_then_passes_error_in_event() {
-        // Given
-        let underlyingError = NSError(domain: "test.domain", code: 42)
-
-        // When
-        let event = WooAnalyticsEvent.PushNotificationsSetup.flowError(step: .connectWPCom, error: underlyingError)
-
-        // Then
-        #expect(event.statName == .pushNotificationsSetupFlowError)
-        #expect(event.properties["step"] as? String == "connect_wpcom")
-        #expect(event.error as? NSError == underlyingError)
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,11 @@ enum SetupStep: Int, CaseIterable {`
`6`	`6`	`case connect = 1`
`7`	`7`	`case enablePush = 2`
`8`	`8`
`9`		`- var analyticsFlowStep: WooAnalyticsEvent.PushNotificationsSetup.FlowStep {`
	`9`	`+ var analyticsFlowStep: String {`
`10`	`10`	`switch self {`
`11`		`- case .checkPlugin: return .pluginCompatibility`
`12`		`- case .connect: return .connectWPCom`
`13`		`- case .enablePush: return .enablePushNotifications`
	`11`	`+ case .checkPlugin: return "plugin_compatibility"`
	`12`	`+ case .connect: return "connect_wpcom"`
	`13`	`+ case .enablePush: return "enable_push_notifications"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,10 +91,10 @@ final class WPComPushNotificationsBenefitsViewModel {`
`91`	`91`	`DDLogError("⛔️ Failed to fetch Jetpack connection data: \(error)")`
`92`	`92`	`if case NetworkError.unacceptableStatusCode(403, _) = error {`
`93`	`93`	`self.error = .noPermission`
`94`		`- analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .noPermission))`
	`94`	`+ analytics.track(.pushNotificationsSetupIntroductionError, withProperties: ["error_type": "no_permission"])`
`95`	`95`	`} else {`
`96`	`96`	`self.error = .generic(underlyingError: error)`
`97`		`- analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .generic, error: error))`
	`97`	`+ analytics.track(.pushNotificationsSetupIntroductionError, properties: ["error_type": "generic"], error: error)`
`98`	`98`	`}`
`99`	`99`	`}`
`100`	`100`	`isCheckingPlugin = false`
`@@ -134,12 +134,12 @@ private extension WPComPushNotificationsBenefitsViewModel {`
`134`	`134`	`variant = .pluginUpdate(currentVersion: currentVersion)`
`135`	`135`	`} else {`
`136`	`136`	`error = .noMissingRequirements`
`137`		`- analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .noMissingRequirements))`
	`137`	`+ analytics.track(.pushNotificationsSetupIntroductionError, withProperties: ["error_type": "no_missing_requirements"])`
`138`	`138`	`}`
`139`	`139`	`} catch {`
`140`	`140`	`DDLogError("⛔️ Plugin version check failed: \(error)")`
`141`	`141`	`self.error = .generic(underlyingError: error)`
`142`		`- analytics.track(event: .PushNotificationsSetup.introductionError(errorType: .generic, error: error))`
	`142`	`+ analytics.track(.pushNotificationsSetupIntroductionError, properties: ["error_type": "generic"], error: error)`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`	`}`