Merge pull request #6829 from woocommerce/issue/6824-sync-failure-analytics

Order Creation: Track when new order fails to sync remotely

Author: Ecarrion

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -419,6 +419,13 @@ extension WooAnalyticsEvent {
                 Keys.errorDescription: errorDescription
             ])
         }
+
+        static func orderSyncFailed(errorContext: String, errorDescription: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .orderSyncFailed, properties: [
+                Keys.errorContext: errorContext,
+                Keys.errorDescription: errorDescription
+            ])
+        }
     }
 }
 

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -236,6 +236,7 @@ public enum WooAnalyticsStat: String {
     case orderTrackingProvidersLoaded = "order_tracking_providers_loaded"
     case orderFeeAdd = "order_fee_add"
     case orderShippingMethodAdd = "order_shipping_method_add"
+    case orderSyncFailed = "order_sync_failed"
 
     // MARK: Order List Sorting/Filtering
     //

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

@@ -526,6 +526,7 @@ private extension NewOrderViewModel {
                 switch state {
                 case .error(let error):
                     DDLogError("⛔️ Error syncing new order remotely: \(error)")
+                    self.trackSyncOrderFailure(error: error)
                     return NoticeFactory.syncOrderErrorNotice(error, with: self.orderSynchronizer)
                 default:
                     return nil
@@ -689,6 +690,13 @@ private extension NewOrderViewModel {
                                                                             errorDescription: error.localizedDescription))
     }
 
+    /// Tracks an order remote sync failure
+    ///
+    func trackSyncOrderFailure(error: Error) {
+        analytics.track(event: WooAnalyticsEvent.Orders.orderSyncFailed(errorContext: String(describing: error),
+                                                                            errorDescription: error.localizedDescription))
+    }
+
     /// Creates an `OrderSyncAddressesInput` type from a `NewOrderAddressData` type.
     /// Expects `billing` and `shipping` addresses to exists together,
     ///

WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/NewOrderViewModelTests.swift

@@ -889,6 +889,32 @@ final class NewOrderViewModelTests: XCTestCase {
         XCTAssertTrue(analytics.receivedEvents.isEmpty)
     }
 
+    func test_sync_failure_tracked_when_sync_fails() {
+        // Given
+        let analytics = MockAnalyticsProvider()
+        let stores = MockStoresManager(sessionManager: .testingInstance)
+        let viewModel = NewOrderViewModel(siteID: sampleSiteID, stores: stores, analytics: WooAnalytics(analyticsProvider: analytics))
+
+        // When
+        waitForExpectation { expectation in
+            stores.whenReceivingAction(ofType: OrderAction.self) { action in
+                switch action {
+                case let .createOrder(_, _, onCompletion):
+                    onCompletion(.failure(NSError(domain: "Error", code: 0)))
+                    expectation.fulfill()
+                default:
+                    XCTFail("Received unsupported action: \(action)")
+                }
+            }
+
+            // When remote sync is triggered
+            viewModel.saveShippingLine(ShippingLine.fake())
+        }
+
+        // Then
+        XCTAssertTrue(analytics.receivedEvents.contains(WooAnalyticsStat.orderSyncFailed.rawValue))
+    }
+
     // MARK: -
 
     func test_customer_note_section_is_updated_when_note_is_added_to_order() {