Merge pull request #6055 from woocommerce/issue/5717-analytics

Author: Ecarrion

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -322,6 +322,76 @@ extension WooAnalyticsEvent {
     }
 }
 
+// MARK: - Order General
+//
+extension WooAnalyticsEvent {
+    // Namespace
+    enum Orders {
+        /// Possible Order Flows
+        ///
+        enum Flow: String {
+            case creation
+            case editing
+        }
+
+        private enum Keys {
+            static let flow = "flow"
+            static let hasDifferentShippingDetails = "has_different_shipping_details"
+            static let orderStatus = "order_status"
+            static let productCount = "product_count"
+            static let hasCustomerDetails = "has_customer_details"
+            static let errorContext = "error_context"
+            static let errorDescription = "error_description"
+            static let to = "to"
+            static let from = "from"
+        }
+
+        static func orderAddNew() -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderAddNew, properties: [:])
+        }
+
+        static func orderProductAdd(flow: Flow) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderProductAdd, properties: [Keys.flow: flow.rawValue])
+        }
+
+        static func orderCustomerAdd(flow: Flow, hasDifferentShippingDetails: Bool) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderCustomerAdd, properties: [
+                Keys.flow: flow.rawValue,
+                Keys.hasDifferentShippingDetails: hasDifferentShippingDetails
+            ])
+        }
+
+        static func orderStatusChange(flow: Flow, from oldStatus: OrderStatusEnum, to newStatus: OrderStatusEnum) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderStatusChange, properties: [
+                Keys.flow: flow.rawValue,
+                Keys.from: oldStatus.rawValue,
+                Keys.to: newStatus.rawValue
+            ])
+        }
+
+        static func orderCreateButtonTapped(status: OrderStatusEnum,
+                                            productCount: Int,
+                                            hasCustomerDetails: Bool) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderCreateButtonTapped, properties: [
+                Keys.orderStatus: status.rawValue,
+                Keys.productCount: Int64(productCount),
+                Keys.hasCustomerDetails: hasCustomerDetails
+            ])
+        }
+
+        static func orderCreationSuccess() -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderCreationSuccess, properties: [:])
+        }
+
+        static func orderCreationFailed(errorContext: String, errorDescription: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderCreationFailed, properties: [
+                Keys.errorContext: errorContext,
+                Keys.errorDescription: errorDescription
+            ])
+        }
+    }
+}
+
 // MARK: - Order Details Edit
 //
 extension WooAnalyticsEvent {

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -208,13 +208,19 @@ public enum WooAnalyticsStat: String {
     // MARK: Order Data/Action Events
     //
     case orderOpen = "order_open"
+    case orderAddNew = "orders_add_new"
     case orderNotesLoaded = "order_notes_loaded"
     case orderNoteAdd = "order_note_add"
     case orderNoteAddSuccess = "order_note_add_success"
     case orderNoteAddFailed = "order_note_add_failed"
+    case orderCreateButtonTapped = "order_create_button_tapped"
+    case orderCreationSuccess = "order_creation_success"
+    case orderCreationFailed = "order_creation_failed"
     case orderContactAction = "order_contact_action"
+    case orderCustomerAdd = "order_customer_add"
     case ordersListFilterOrSearch = "orders_list_filter"
     case ordersListLoaded = "orders_list_loaded"
+    case orderProductAdd = "order_product_add"
     case orderStatusChange = "order_status_change"
     case orderStatusChangeSuccess = "order_status_change_success"
     case orderStatusChangeFailed = "order_status_change_failed"

WooCommerce/Classes/ViewRelated/Orders/Order Creation/FlowCoordinator/AddOrderCoordinator.swift

@@ -82,5 +82,7 @@ private extension AddOrderCoordinator {
         let viewController = NewOrderHostingController(viewModel: viewModel)
         viewController.hidesBottomBarWhenPushed = true
         navigationController.pushViewController(viewController, animated: true)
+
+        ServiceLocator.analytics.track(event: WooAnalyticsEvent.Orders.orderAddNew())
     }
 }

WooCommerce/Classes/ViewRelated/Orders/Order Creation/NewOrderViewModel.swift

@@ -131,14 +131,20 @@ final class NewOrderViewModel: ObservableObject {
     ///
     @Published private(set) var paymentDataViewModel = PaymentDataViewModel()
 
+    /// Analytics engine.
+    ///
+    private let analytics: Analytics
+
     init(siteID: Int64,
          stores: StoresManager = ServiceLocator.stores,
          storageManager: StorageManagerType = ServiceLocator.storageManager,
-         currencySettings: CurrencySettings = ServiceLocator.currencySettings) {
+         currencySettings: CurrencySettings = ServiceLocator.currencySettings,
+         analytics: Analytics = ServiceLocator.analytics) {
         self.siteID = siteID
         self.stores = stores
         self.storageManager = storageManager
         self.currencyFormatter = CurrencyFormatter(currencySettings: currencySettings)
+        self.analytics = analytics
 
         configureNavigationTrailingItem()
         configureStatusBadgeViewModel()
@@ -195,6 +201,7 @@ final class NewOrderViewModel: ObservableObject {
                                         onAddressUpdate: { [weak self] updatedAddressData in
             self?.orderDetails.billingAddress = updatedAddressData.billingAddress
             self?.orderDetails.shippingAddress = updatedAddressData.shippingAddress
+            self?.trackCustomerDetailsAdded()
         })
     }
 
@@ -211,17 +218,28 @@ final class NewOrderViewModel: ObservableObject {
             switch result {
             case .success(let newOrder):
                 self.onOrderCreated(newOrder)
+                self.trackCreateOrderSuccess()
             case .failure(let error):
                 self.notice = NoticeFactory.createOrderCreationErrorNotice()
+                self.trackCreateOrderFailure(error: error)
                 DDLogError("⛔️ Error creating new order: \(error)")
             }
         }
         stores.dispatch(action)
+        trackCreateButtonTapped()
     }
 
     /// Assign this closure to be notified when a new order is created
     ///
     var onOrderCreated: (Order) -> Void = { _ in }
+
+    /// Updates the order status & tracks its event
+    ///
+    func updateOrderStatus(newStatus: OrderStatusEnum) {
+        let oldStatus = orderDetails.status
+        orderDetails.status = newStatus
+        analytics.track(event: WooAnalyticsEvent.Orders.orderStatusChange(flow: .creation, from: oldStatus, to: newStatus))
+    }
 }
 
 // MARK: - Types
@@ -410,6 +428,8 @@ private extension NewOrderViewModel {
         let newOrderItem = NewOrderItem(product: product, quantity: 1)
         orderDetails.items.append(newOrderItem)
         configureProductRowViewModels()
+
+        analytics.track(event: WooAnalyticsEvent.Orders.orderProductAdd(flow: .creation))
     }
 
     /// Adds a selected product variation (from the product list) to the order.
@@ -418,6 +438,8 @@ private extension NewOrderViewModel {
         let newOrderItem = NewOrderItem(variation: variation, quantity: 1)
         orderDetails.items.append(newOrderItem)
         configureProductRowViewModels()
+
+        analytics.track(event: WooAnalyticsEvent.Orders.orderProductAdd(flow: .creation))
     }
 
     /// Configures product row view models for each item in `orderDetails`.
@@ -471,6 +493,44 @@ private extension NewOrderViewModel {
             }
             .assign(to: &$paymentDataViewModel)
     }
+
+    /// Tracks when customer details have been added
+    ///
+    func trackCustomerDetailsAdded() {
+        let areAddressesDifferent: Bool = {
+            guard let billingAddress = orderDetails.billingAddress, let shippingAddress = orderDetails.shippingAddress else {
+                return false
+            }
+            return billingAddress != shippingAddress
+        }()
+        analytics.track(event: WooAnalyticsEvent.Orders.orderCustomerAdd(flow: .creation, hasDifferentShippingDetails: areAddressesDifferent))
+    }
+
+    /// Tracks when the create order button is tapped.
+    ///
+    /// Warning: This methods assume that `orderDetails.items.count` is equal to the product count,
+    /// As the module evolves to handle more types of items, we need to update the property to something like `itemsCount`
+    /// or figure out a better way to get the product count.
+    ///
+    func trackCreateButtonTapped() {
+        let hasCustomerDetails = orderDetails.billingAddress != nil || orderDetails.shippingAddress != nil
+        analytics.track(event: WooAnalyticsEvent.Orders.orderCreateButtonTapped(status: orderDetails.status,
+                                                                                productCount: orderDetails.items.count,
+                                                                                hasCustomerDetails: hasCustomerDetails))
+    }
+
+    /// Tracks an order creation success
+    ///
+    func trackCreateOrderSuccess() {
+        analytics.track(event: WooAnalyticsEvent.Orders.orderCreationSuccess())
+    }
+
+    /// Tracks an order creation failure
+    ///
+    func trackCreateOrderFailure(error: Error) {
+        analytics.track(event: WooAnalyticsEvent.Orders.orderCreationFailed(errorContext: String(describing: error),
+                                                                            errorDescription: error.localizedDescription))
+    }
 }
 
 private extension NewOrderViewModel {

WooCommerce/Classes/ViewRelated/Orders/Order Creation/StatusSection/OrderStatusSection.swift

@@ -34,7 +34,7 @@ struct OrderStatusSection: View {
                 .padding(.trailing, -Layout.linkButtonTrailingPadding) // remove trailing padding to align button title to the side
                 .sheet(isPresented: $viewModel.shouldShowOrderStatusList) {
                     OrderStatusList(siteID: viewModel.siteID, status: viewModel.orderDetails.status) { newStatus in
-                        viewModel.orderDetails.status = newStatus
+                        viewModel.updateOrderStatus(newStatus: newStatus)
                     }
                 }
             }