Merge pull request #998 from woocommerce/issue/996-add-tracking-details

Add "Add Tracking" button to Order Details screen

Author: mindgraffiti

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -130,6 +130,7 @@ public enum WooAnalyticsStat: String {
     case orderDetailPulledToRefresh             = "order_detail_pulled_to_refresh"
     case orderNoteAddButtonTapped               = "add_order_note_add_button_tapped"
     case orderNoteEmailCustomerToggled          = "add_order_note_email_note_to_customer_toggled"
+    case orderDetailAddTrackingButtonTapped = "order_detail_tracking_add_tracking_button_tapped"
     case orderDetailShowBillingTapped           = "order_detail_customer_info_show_billing_tapped"
     case orderDetailHideBillingTapped           = "order_detail_customer_info_hide_billing_tapped"
     case orderDetailFulfillButtonTapped         = "order_detail_fulfill_order_button_tapped"

WooCommerce/Classes/ViewRelated/Orders/OrderDetailsViewController.swift

@@ -8,7 +8,7 @@ import SafariServices
 
 // MARK: - OrderDetailsViewController: Displays the details for a given Order.
 //
-class OrderDetailsViewController: UIViewController {
+final class OrderDetailsViewController: UIViewController {
 
     /// Main TableView.
     ///
@@ -82,6 +82,11 @@ class OrderDetailsViewController: UIViewController {
         return trackingResultsController.fetchedObjects
     }
 
+    /// Indicates if we consider the shipment tracking plugin as reachable
+    /// https://github.com/woocommerce/woocommerce-ios/issues/852#issuecomment-482308373
+    ///
+    private var trackingIsReachable: Bool = false
+
     /// Order statuses list
     ///
     private var currentSiteStatuses: [OrderStatus] {
@@ -109,7 +114,18 @@ class OrderDetailsViewController: UIViewController {
     override func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
         syncNotes()
-        syncTracking()
+        syncTrackingsHiddingAddButtonIfNecessary()
+    }
+
+    private func syncTrackingsHiddingAddButtonIfNecessary() {
+        syncTracking { [weak self] error in
+            if error == nil {
+                self?.trackingIsReachable = true
+            }
+
+            self?.reloadSections()
+            self?.tableView.reloadData()
+        }
     }
 }
 
@@ -297,12 +313,25 @@ private extension OrderDetailsViewController {
             return Section(title: Title.tracking, rows: rows)
         }()
 
+        let addTracking: Section? = {
+            // Hide the section if the shipment
+            // tracking plugin is not installed
+            guard trackingIsReachable else {
+                return nil
+            }
+
+            let title = orderTracking.count == 0 ? NSLocalizedString("Optional Tracking Information", comment: "") : nil
+            let row = Row.trackingAdd
+
+            return Section(title: title, rightTitle: nil, rows: [row])
+        }()
+
         let notes: Section = {
             let rows = [.addOrderNote] + Array(repeating: Row.orderNote, count: orderNotes.count)
             return Section(title: Title.notes, rows: rows)
         }()
 
-        sections = [summary, products, customerNote, customerInformation, payment, tracking, notes].compactMap { $0 }
+        sections = [summary, products, customerNote, customerInformation, payment, tracking, addTracking, notes].compactMap { $0 }
     }
 }
 
@@ -374,7 +403,7 @@ private extension OrderDetailsViewController {
             configureShippingAddress(cell: cell)
         case let cell as CustomerNoteTableViewCell:
             configureCustomerNote(cell: cell)
-        case let cell as LeftImageTableViewCell:
+        case let cell as LeftImageTableViewCell where row == .addOrderNote:
             configureNewNote(cell: cell)
         case let cell as OrderNoteTableViewCell:
             configureOrderNote(cell: cell, at: indexPath)
@@ -384,6 +413,8 @@ private extension OrderDetailsViewController {
             configureProductList(cell: cell)
         case let cell as OrderTrackingTableViewCell:
             configureTracking(cell: cell, at: indexPath)
+        case let cell as LeftImageTableViewCell where row == .trackingAdd:
+            configureNewTracking(cell: cell)
         case let cell as SummaryTableViewCell:
             configureSummary(cell: cell)
         default:
@@ -573,6 +604,23 @@ private extension OrderDetailsViewController {
         }
     }
 
+    func configureNewTracking(cell: LeftImageTableViewCell) {
+        let cellTextContent = NSLocalizedString("Add Tracking", comment: "Add Tracking row label")
+        cell.leftImage = .addOutlineImage
+        cell.labelText = cellTextContent
+
+        cell.accessibilityTraits = .button
+        cell.accessibilityLabel = NSLocalizedString(
+            "Add a tracking button",
+            comment: "Accessibility label for the 'Add a tracking' button"
+        )
+
+        cell.accessibilityHint = NSLocalizedString(
+            "Adds tracking to an order.",
+            comment: "VoiceOver accessibility hint, informing the user that the button can be used to add tracking to an order. Should end with a period."
+        )
+    }
+
     func configureShippingAddress(cell: CustomerInfoTableViewCell) {
         let shippingAddress = viewModel.order.shippingAddress
 
@@ -757,11 +805,6 @@ extension OrderDetailsViewController: UITableViewDataSource {
     }
 
     func tableView(_ tableView: UITableView, heightForHeaderInSection section: Int) -> CGFloat {
-        if sections[section].title == nil {
-            // iOS 11 table bug. Must return a tiny value to collapse `nil` or `empty` section headers.
-            return .leastNonzeroMagnitude
-        }
-
         return UITableView.automaticDimension
     }
 
@@ -822,6 +865,7 @@ extension OrderDetailsViewController: UITableViewDelegate {
         tableView.deselectRow(at: indexPath, animated: true)
 
         switch sections[indexPath.section].rows[indexPath.row] {
+
         case .addOrderNote:
             WooAnalytics.shared.track(.orderDetailAddNoteButtonTapped)
 
@@ -830,6 +874,15 @@ extension OrderDetailsViewController: UITableViewDelegate {
 
             let navController = WooNavigationController(rootViewController: newNoteViewController)
             present(navController, animated: true, completion: nil)
+
+        case .trackingAdd:
+            WooAnalytics.shared.track(.orderDetailAddTrackingButtonTapped)
+
+            let addTrackingViewModel = AddTrackingViewModel(order: viewModel.order)
+            let addTracking = ManualTrackingViewController(viewModel: addTrackingViewModel)
+            let navController = WooNavigationController(rootViewController: addTracking)
+            present(navController, animated: true, completion: nil)
+
         case .productDetails:
             WooAnalytics.shared.track(.orderDetailProductDetailTapped)
             performSegue(withIdentifier: Constants.productDetailsSegue, sender: nil)
@@ -1232,6 +1285,7 @@ private extension OrderDetailsViewController {
         case productList
         case productDetails
         case tracking
+        case trackingAdd
         case customerNote
         case shippingAddress
         case billingAddress
@@ -1251,6 +1305,8 @@ private extension OrderDetailsViewController {
                 return BasicTableViewCell.reuseIdentifier
             case .tracking:
                 return OrderTrackingTableViewCell.reuseIdentifier
+            case .trackingAdd:
+                return LeftImageTableViewCell.reuseIdentifier
             case .customerNote:
                 return CustomerNoteTableViewCell.reuseIdentifier
             case .shippingAddress: