[IPPInAppFeedback] Orders screen banner placement

Storage/Storage/Model/FeedbackType.swift

@@ -16,4 +16,8 @@ public enum FeedbackType: String, Codable {
     /// Identifier for the orders creation feedback survey
     ///
     case ordersCreation
+
+    /// Identifier for the In-Person Payments feedback survey
+    ///
+    case IPPFeedback
 }

WooCommerce/Classes/System/WooConstants.swift

@@ -155,8 +155,10 @@ extension WooConstants {
         ///
 #if DEBUG
         case inAppFeedback = "https://automattic.survey.fm/woo-app-general-feedback-test-survey"
+        case IPPFeedback = "https://automattic.survey.fm/woo-app-ipp-in-app-feedback-testing"
 #else
         case inAppFeedback = "https://automattic.survey.fm/woo-app-general-feedback-user-survey"
+        case IPPFeedback = "https://automattic.survey.fm/woo-app-ipp-in-app-feedback-testing"
 #endif
 
         /// URL for the products feedback survey

WooCommerce/Classes/ViewRelated/Orders/OrderListViewController.swift

@@ -254,6 +254,8 @@ private extension OrderListViewController {
                     self.setErrorTopBanner()
                 case .orderCreation:
                     self.setOrderCreationTopBanner()
+                case .IPPFeedback:
+                    self.setIPPFeedbackTopBanner()
                 }
             }
             .store(in: &cancellables)
@@ -783,6 +785,44 @@ private extension OrderListViewController {
         })
         showTopBannerView()
     }
+
+    /// Sets the `topBannerView` property to an IPP feedback banner.
+    ///
+    func setIPPFeedbackTopBanner() {
+        topBannerView = createIPPFeedbackTopBanner()
+        showTopBannerView()
+    }
+
+    private func createIPPFeedbackTopBanner() -> TopBannerView {
+        let shareIPPFeedbackAction = TopBannerViewModel.ActionButton(title: Localization.shareFeedbackButton, action: { _ in
+            self.displayIPPFeedbackBannerSurvey()
+        })
+
+        let viewModel = TopBannerViewModel(
+            title: Localization.feedbackBannerTitle,
+            infoText: Localization.feedbackBannerContent,
+            icon: UIImage.gridicon(.comment),
+            isExpanded: true,
+            topButton: .dismiss(handler: {
+                self.dismissIPPFeedbackBannerSurvey()
+            }),
+            actionButtons: [shareIPPFeedbackAction]
+        )
+        let topBannerView = TopBannerView(viewModel: viewModel)
+        topBannerView.translatesAutoresizingMaskIntoConstraints = false
+        return topBannerView
+    }
+
+    private func displayIPPFeedbackBannerSurvey() {
+        // TODO: Survey will change based on conditions
+        let surveyNavigation = SurveyCoordinatingController(survey: .IPPFeedback)
+        self.present(surveyNavigation, animated: true, completion: nil)
+    }
+
+    private func dismissIPPFeedbackBannerSurvey() {
+        // TODO: Dismissal logic to not show the banner again for X days/never
+        viewModel.dismissIPPFeedbackBanner()
+    }
 }
 
 // MARK: - Constants
@@ -801,6 +841,18 @@ private extension OrderListViewController {
 
         static let markCompleted = NSLocalizedString("Mark Completed", comment: "Title for the swipe order action to mark it as completed")
 
+        static let feedbackBannerTitle = NSLocalizedString("Let us know what you think",
+                                                           comment: "Title of the In-Person Payments feedback banner in the Orders tab"
+        )
+
+        static let feedbackBannerContent = NSLocalizedString("Rate your In-Person Payment experience.",
+                                                             comment: "Content of the In-Person Payments feedback banner in the Orders tab"
+        )
+
+        static let shareFeedbackButton = NSLocalizedString("Share feedback",
+                                                           comment: "Title of the feedback action button on the In-Person Payments feedback banner"
+        )
+
         static func markCompletedNoticeTitle(orderID: Int64) -> String {
             let format = NSLocalizedString(
                 "Order #%1$d marked as completed",

WooCommerce/Classes/ViewRelated/Orders/OrderListViewModel.swift

@@ -131,6 +131,11 @@ final class OrderListViewModel {
     ///
     @Published var hideOrdersBanners: Bool = true
 
+    /// If true, no IPP feedback banner will be shown as the user has told us that they are not interested in this information.
+    /// It is persisted through app sessions.
+    /// 
+    @Published var hideIPPFeedbackBanner: Bool = false
+
     init(siteID: Int64,
          stores: StoresManager = ServiceLocator.stores,
          storageManager: StorageManagerType = ServiceLocator.storageManager,
@@ -143,6 +148,12 @@ final class OrderListViewModel {
         self.pushNotificationsManager = pushNotificationsManager
         self.notificationCenter = notificationCenter
         self.filters = filters
+
+        if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.IPPInAppFeedbackBanner) {
+            // TODO: Remove. Temporarily set to false so we can debug the IPPFeedback banner easily.
+            hideOrdersBanners = false
+            topBanner = .IPPFeedback
+        }
     }
 
     deinit {
@@ -165,10 +176,12 @@ final class OrderListViewModel {
 
         observeForegroundRemoteNotifications()
         bindTopBannerState()
-        loadOrdersBannerVisibility()
 
         if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.IPPInAppFeedbackBanner) {
+            loadIPPFeedbackBannerVisibility()
             fetchIPPTransactions()
+        } else {
+            loadOrdersBannerVisibility()
         }
     }
 
@@ -185,6 +198,15 @@ final class OrderListViewModel {
         stores.dispatch(action)
     }
 
+    func dismissIPPFeedbackBanner() {
+        print("dismiss tapped")
+        let action = AppSettingsAction.updateFeedbackStatus(type: .IPPFeedback, status: .dismissed, onCompletion: { _ in
+            self.hideIPPFeedbackBanner = true
+            print("hideIPPFeedbackBanner? \(self.hideIPPFeedbackBanner)")
+        })
+        stores.dispatch(action)
+    }
+
     /// Starts the snapshotsProvider, logging any errors.
     private func startReceivingSnapshots() {
         do {
@@ -208,6 +230,19 @@ final class OrderListViewModel {
         stores.dispatch(action)
     }
 
+    private func loadIPPFeedbackBannerVisibility() {
+        let action = AppSettingsAction.loadFeedbackVisibility(type: .IPPFeedback) { [weak self] result in
+            switch result {
+            case .success(let visible):
+                self?.hideIPPFeedbackBanner = !visible
+            case .failure(let error):
+                self?.hideIPPFeedbackBanner = true
+                ServiceLocator.crashLogging.logError(error)
+            }
+        }
+        stores.dispatch(action)
+    }
+
     @objc private func handleAppDeactivation() {
         isAppActive = false
     }
@@ -376,7 +411,11 @@ extension OrderListViewModel {
                     return .none
                 }
 
-                return .orderCreation
+                if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.IPPInAppFeedbackBanner) {
+                    return .IPPFeedback
+                } else {
+                    return .orderCreation
+                }
             }
             .assign(to: &$topBanner)
     }
@@ -419,6 +458,7 @@ extension OrderListViewModel {
     enum TopBanner {
         case error
         case orderCreation
+        case IPPFeedback
         case none
     }
 }

WooCommerce/Classes/ViewRelated/Survey/SurveyViewController.swift

@@ -68,6 +68,7 @@ extension SurveyViewController {
         case addOnsI1
         case orderCreation
         case couponManagement
+        case IPPFeedback
 
         fileprivate var url: URL {
             switch self {
@@ -102,22 +103,27 @@ extension SurveyViewController {
                     .asURL()
                     .tagPlatform("ios")
                     .tagAppVersion(Bundle.main.bundleVersion())
+            case .IPPFeedback:
+                return WooConstants.URLs.IPPFeedback
+                    .asURL()
+                    .tagPlatform("ios")
+                    .tagAppVersion(Bundle.main.bundleVersion())
             }
         }
 
         fileprivate var title: String {
             switch self {
             case .inAppFeedback:
                 return Localization.title
-            case .productsFeedback, .shippingLabelsRelease3Feedback, .addOnsI1, .orderCreation, .couponManagement:
+            case .productsFeedback, .shippingLabelsRelease3Feedback, .addOnsI1, .orderCreation, .couponManagement, .IPPFeedback:
                 return Localization.giveFeedback
             }
         }
 
         /// The corresponding `FeedbackContext` for event tracking purposes.
         var feedbackContextForEvents: WooAnalyticsEvent.FeedbackContext {
             switch self {
-            case .inAppFeedback:
+            case .inAppFeedback, .IPPFeedback:
                 return .general
             case .productsFeedback:
                 return .productsGeneral

WooCommerce/WooCommerceTests/ViewRelated/Orders/OrderListViewModelTests.swift

@@ -239,7 +239,7 @@ final class OrderListViewModelTests: XCTestCase {
         XCTAssertFalse(resynchronizeRequested)
     }
 
-    func test_when_having_no_error__and_orders_banner_should_not_be_shown_shows_nothing() {
+    func test_when_having_no_error_and_orders_banner_should_not_be_shown_shows_nothing() {
         // Given
         let viewModel = OrderListViewModel(siteID: siteID, stores: stores, filters: nil)
         stores.whenReceivingAction(ofType: AppSettingsAction.self) { action in
@@ -255,8 +255,14 @@ final class OrderListViewModelTests: XCTestCase {
         viewModel.activate()
 
         // Then
-        waitUntil {
-            viewModel.topBanner == .none
+        if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.IPPInAppFeedbackBanner) {
+            waitUntil {
+                viewModel.topBanner == .IPPFeedback
+            }
+        } else {
+            waitUntil {
+                viewModel.topBanner == .none
+            }
         }
     }
 
@@ -298,8 +304,14 @@ final class OrderListViewModelTests: XCTestCase {
         viewModel.activate()
 
         // Then
-        waitUntil {
-            viewModel.topBanner == .none
+        if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.IPPInAppFeedbackBanner) {
+            waitUntil {
+                viewModel.topBanner == .IPPFeedback
+            }
+        } else {
+            waitUntil {
+                viewModel.topBanner == .none
+            }
         }
     }
 

Yosemite/Yosemite/Stores/AppSettings/InAppFeedbackCardVisibilityUseCase.swift

@@ -37,7 +37,7 @@ struct InAppFeedbackCardVisibilityUseCase {
         switch feedbackType {
         case .general:
             return try shouldGeneralFeedbackBeVisible(currentDate: currentDate)
-        case .shippingLabelsRelease3, .couponManagement, .ordersCreation:
+        case .shippingLabelsRelease3, .couponManagement, .ordersCreation, .IPPFeedback:
             return settings.feedbackStatus(of: feedbackType) == .pending
         }
     }