Merge pull request #7767 from woocommerce/feature/7547-no-woo-help-center

Custom help content for "Not a WooCommerce site" error screen

Author: selanthiraiyan

RELEASE-NOTES.txt

@@ -3,6 +3,7 @@
 10.6
 -----
 - [*] Fixed a rare crash when selecting a store in the store picker. [https://github.com/woocommerce/woocommerce-ios/pull/7765]
+- [*] Help center: Added help center web page with FAQs for "Not a WooCommerce site" error screen. [https://github.com/woocommerce/woocommerce-ios/pull/7767]
 
 10.5
 -----

WooCommerce/Classes/Authentication/Navigation Exceptions/NoWooErrorViewModel.swift

@@ -9,19 +9,22 @@ final class NoWooErrorViewModel: ULErrorViewModel {
     private let analytics: Analytics
     private let stores: StoresManager
     private let setupCompletionHandler: (Int64) -> Void
+    private let authentication: Authentication
 
     private var storePickerCoordinator: StorePickerCoordinator?
 
     init(site: Site,
          showsConnectedStores: Bool,
          analytics: Analytics = ServiceLocator.analytics,
          stores: StoresManager = ServiceLocator.stores,
+         authentication: Authentication = ServiceLocator.authenticationManager,
          onSetupCompletion: @escaping (Int64) -> Void) {
         self.site = site
         self.title = site.name
         self.showsConnectedStores = showsConnectedStores
         self.analytics = analytics
         self.stores = stores
+        self.authentication = authentication
         self.setupCompletionHandler = onSetupCompletion
     }
 
@@ -56,6 +59,11 @@ final class NoWooErrorViewModel: ULErrorViewModel {
 
     let secondaryButtonTitle = Localization.secondaryButtonTitle
 
+    // Configures `Help` button title
+    var rightBarButtonItemTitle: String? {
+        Localization.helpBarButtonItemTitle
+    }
+
     // MARK: - Actions
     func didTapPrimaryButton(in viewController: UIViewController?) {
         analytics.track(.loginWooCommerceSetupButtonTapped)
@@ -89,6 +97,13 @@ final class NoWooErrorViewModel: ULErrorViewModel {
         storePickerCoordinator?.start()
     }
 
+    func didTapRightBarButtonItem(in viewController: UIViewController?) {
+        guard let viewController = viewController else {
+            return
+        }
+        authentication.presentSupport(from: viewController, screen: .noWooError)
+    }
+
     func viewDidLoad(_ viewController: UIViewController?) {
         analytics.track(.loginWooCommerceErrorShown)
     }
@@ -162,5 +177,9 @@ private extension NoWooErrorViewModel {
                                                              comment: "Message displayed when checking whether a site has successfully installed WooCommerce")
         static let setupErrorMessage = NSLocalizedString("Cannot verify your site's WooCommerce installation.",
                                                          comment: "Error message displayed when failed to check for WooCommerce in a site.")
+
+        static let helpBarButtonItemTitle = NSLocalizedString("Help",
+                                                              comment: "Action button for opening Help."
+                                                              + "Presented when logging in with a site address that does not have WooCommerce")
     }
 }

WooCommerce/Classes/Model/CustomHelpCenterContent.swift

@@ -73,6 +73,10 @@ extension CustomHelpCenterContent {
         /// Account mismatch / Wrong WordPress.com account screen - `WrongAccountErrorViewModel`
         ///
         case wrongAccountError
+
+        /// No WooCommerce site error  using `NoWooErrorViewModel`
+        ///
+        case noWooError
     }
 
     init(screen: Screen, flow: AuthenticatorAnalyticsTracker.Flow) {
@@ -87,6 +91,9 @@ extension CustomHelpCenterContent {
         case .wrongAccountError:
             step = "wrong_wordpress_account" // Matching Android `Step` value
             url = WooConstants.URLs.helpCenterForWrongAccountError.asURL()
+        case .noWooError:
+            step = "not_woo_store" // Matching Android `Step` value
+            url = WooConstants.URLs.helpCenterForNoWooError.asURL()
         }
 
         trackingProperties = [

WooCommerce/Classes/System/WooConstants.swift

@@ -127,6 +127,10 @@ extension WooConstants {
         ///
         case helpCenterForWrongAccountError = "https://woocommerce.com/document/android-ios-apps-login-help-faq/#wrong-account"
 
+        /// Help Center for No WooCommerce site error
+        ///
+        case helpCenterForNoWooError = "https://woocommerce.com/document/android-ios-apps-login-help-faq/#not-a-woocommerce-site"
+
         /// Help Center for "Store picker" screen
         ///
         case helpCenterForStorePicker = "https://woocommerce.com/document/android-ios-apps-login-help-faq/#pick-store-after-entering-password"

WooCommerce/WooCommerceTests/Authentication/NoWooErrorViewModelTests.swift

@@ -158,6 +158,49 @@ final class NoWooErrorViewModelTests: XCTestCase {
         // Then
         XCTAssertNotNil(analyticsProvider.receivedEvents.first(where: { $0 == "login_woocommerce_error_shown" }))
     }
+
+    func test_viewmodel_provides_expected_title_for_right_bar_button_item() {
+        // Given
+        let site = Site.fake().copy(url: "https://test.com")
+        let viewModel = NoWooErrorViewModel(site: site,
+                                            showsConnectedStores: false,
+                                            onSetupCompletion: { _ in })
+
+        // Then
+        XCTAssertEqual(viewModel.rightBarButtonItemTitle, Localization.helpBarButtonItemTitle)
+    }
+
+    func test_viewModel_invokes_present_support_when_the_help_button_is_tapped() throws {
+        // Given
+        let site = Site.fake().copy(url: "https://test.com")
+        let mockAuthentication = MockAuthentication()
+        let viewModel = NoWooErrorViewModel(site: site,
+                                            showsConnectedStores: false,
+                                            authentication: mockAuthentication,
+                                            onSetupCompletion: { _ in })
+
+        // When
+        viewModel.didTapRightBarButtonItem(in: UIViewController())
+
+        // Then
+        XCTAssertTrue(mockAuthentication.presentSupportFromScreenInvoked)
+    }
+
+    func test_viewModel_sends_correct_screen_value_in_present_support_method() throws {
+        // Given
+        let site = Site.fake().copy(url: "https://test.com")
+        let mockAuthentication = MockAuthentication()
+        let viewModel = NoWooErrorViewModel(site: site,
+                                            showsConnectedStores: false,
+                                            authentication: mockAuthentication,
+                                            onSetupCompletion: { _ in })
+
+        // When
+        viewModel.didTapRightBarButtonItem(in: UIViewController())
+
+        // Then
+        XCTAssertEqual(mockAuthentication.presentSupportFromScreen, .noWooError)
+    }
 }
 
 private extension NoWooErrorViewModelTests {
@@ -176,5 +219,9 @@ private extension NoWooErrorViewModelTests {
         static let secondaryButtonTitle = NSLocalizedString("Log In With Another Account",
                                                             comment: "Action button that will restart the login flow."
                                                             + "Presented when logging in with a site address that does not have WooCommerce")
+
+        static let helpBarButtonItemTitle = NSLocalizedString("Help",
+                                                              comment: "Action button for opening Help."
+                                                              + "Presented when logging in with a site address that does not have WooCommerce")
     }
 }

WooCommerce/WooCommerceTests/Model/CustomHelpCenterContentTests.swift

@@ -269,4 +269,24 @@ final class CustomHelpCenterContentTests: XCTestCase {
         XCTAssertEqual(sut.trackingProperties[CustomHelpCenterContent.Key.flow.rawValue], flow.rawValue)
         XCTAssertEqual(sut.trackingProperties[CustomHelpCenterContent.Key.url.rawValue], helpContentURL.absoluteString)
     }
+
+    // MARK: Not a WooCommerce site error screen presented using `NoWooErrorViewModel`
+    //
+    func test_init_screen_returns_valid_instance_for_not_a_woocommerce_site_error_screen() throws {
+        // Given
+        let step = "not_woo_store"
+        let flow: AuthenticatorAnalyticsTracker.Flow = .loginWithPasswordWithMagicLinkEmphasis
+
+        // When
+        let sut = CustomHelpCenterContent(screen: .noWooError, flow: flow)
+
+        // Then
+        let helpContentURL = WooConstants.URLs.helpCenterForNoWooError.asURL()
+        XCTAssertEqual(sut.url, helpContentURL)
+
+        // Test the `trackingProperties` dictionary values
+        XCTAssertEqual(sut.trackingProperties[CustomHelpCenterContent.Key.step.rawValue], step)
+        XCTAssertEqual(sut.trackingProperties[CustomHelpCenterContent.Key.flow.rawValue], flow.rawValue)
+        XCTAssertEqual(sut.trackingProperties[CustomHelpCenterContent.Key.url.rawValue], helpContentURL.absoluteString)
+    }
 }