Merge pull request #7143 from woocommerce/feat/7068-siwa-close-account

SIWA account removal: update action to close account

Author: jaclync

Experiments/Experiments/DefaultFeatureFlagService.swift

@@ -42,7 +42,7 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
         case .backgroundProductImageUpload:
             return buildConfig == .localDeveloper || buildConfig == .alpha
         case .appleIDAccountDeletion:
-            return buildConfig == .localDeveloper || buildConfig == .alpha
+            return true
         default:
             return true
         }

RELEASE-NOTES.txt

@@ -4,6 +4,7 @@
 -----
 - [*] Coupons: Fixed issue saving "Individual Use" and "Exclude Sale Items" fields. [https://github.com/woocommerce/woocommerce-ios/pull/7117]
 - [*] Orders: The customer shipping/billing address form now navigates back automatically after selecting a country or state. [https://github.com/woocommerce/woocommerce-ios/pull/7119]
+- [internal] In settings and empty stores screen, the "Close Account" link is shown for users who signed in with Apple (the only way to create an account) to close their WordPress.com account. [https://github.com/woocommerce/woocommerce-ios/pull/7143]
 
 9.4
 -----

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -1125,6 +1125,31 @@ extension WooAnalyticsEvent {
     }
 }
 
+// MARK: - Close Account
+//
+extension WooAnalyticsEvent {
+    /// The source that presents the Jetpack install screen.
+    enum CloseAccountSource: String {
+        case settings
+        case emptyStores = "empty_stores"
+    }
+
+    /// Tracked when the user taps to close their WordPress.com account.
+    static func closeAccountTapped(source: CloseAccountSource) -> WooAnalyticsEvent {
+        WooAnalyticsEvent(statName: .closeAccountTapped, properties: ["source": source.rawValue])
+    }
+
+    /// Tracked when the WordPress.com account closure succeeds.
+    static func closeAccountSuccess() -> WooAnalyticsEvent {
+        WooAnalyticsEvent(statName: .closeAccountSuccess, properties: [:])
+    }
+
+    /// Tracked when the WordPress.com account closure fails.
+    static func closeAccountFailed(error: Error) -> WooAnalyticsEvent {
+        WooAnalyticsEvent(statName: .closeAccountFailed, properties: [:], error: error)
+    }
+}
+
 private extension PaymentMethod {
     var analyticsValue: String {
         switch self {

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -596,6 +596,11 @@ public enum WooAnalyticsStat: String {
     case inboxNotesLoaded = "inbox_notes_loaded"
     case inboxNotesLoadedFailed = "inbox_notes_load_failed"
     case inboxNoteAction = "inbox_note_action"
+
+    // MARK: Close Account
+    case closeAccountTapped = "close_account_tapped"
+    case closeAccountSuccess = "close_account_success"
+    case closeAccountFailed = "close_account_failed"
 }
 
 public extension WooAnalyticsStat {

WooCommerce/Classes/Authentication/Epilogue/EmptyStoresTableViewCell.swift

@@ -8,7 +8,7 @@ final class EmptyStoresTableViewCell: UITableViewCell {
 
     var onJetpackSetupButtonTapped: (() -> Void)?
 
-    var onRemoveAppleIDAccessButtonTapped: (() -> Void)?
+    var onCloseAccountButtonTapped: (() -> Void)?
 
     /// LegendLabel: To be displayed below the ImageView.
     ///
@@ -66,9 +66,9 @@ private extension EmptyStoresTableViewCell {
 
     func configureRemoveAppleIDAccessButton() {
         removeAppleIDAccessButton.applyLinkButtonStyle()
-        removeAppleIDAccessButton.setTitle(Localization.removeAppleIDAccessTitle, for: .normal)
+        removeAppleIDAccessButton.setTitle(Localization.closeAccountTitle, for: .normal)
         removeAppleIDAccessButton.on(.touchUpInside) { [weak self] _ in
-            self?.onRemoveAppleIDAccessButtonTapped?()
+            self?.onCloseAccountButtonTapped?()
         }
     }
 }
@@ -77,9 +77,9 @@ private extension EmptyStoresTableViewCell {
     enum Localization {
         static let actionTitle = NSLocalizedString("Connect your store with Jetpack",
                                                    comment: "Link on the store picker when there are no stores available. Opens a webview about Jetpack setup.")
-        static let removeAppleIDAccessTitle = NSLocalizedString(
-            "Remove Apple ID access",
-            comment: "Link on the store picker for users who signed in with Apple to disconnect their Apple ID from the app."
+        static let closeAccountTitle = NSLocalizedString(
+            "Close Account",
+            comment: "Link on the store picker for users who signed in with Apple to close their WordPress.com account."
         )
         static let legend =
             NSLocalizedString("If you already have a store, you’ll need to install the free Jetpack plugin and connect it to your WordPress.com account.",

WooCommerce/Classes/Authentication/Epilogue/StorePickerViewController.swift

@@ -648,8 +648,9 @@ extension StorePickerViewController: UITableViewDataSource {
             && featureFlagService.isFeatureFlagEnabled(.appleIDAccountDeletion)
             cell.updateRemoveAppleIDAccessButtonVisibility(isVisible: isRemoveAppleIDAccessButtonVisible)
             if isRemoveAppleIDAccessButtonVisible {
-                cell.onRemoveAppleIDAccessButtonTapped = { [weak self] in
+                cell.onCloseAccountButtonTapped = { [weak self] in
                     guard let self = self else { return }
+                    ServiceLocator.analytics.track(event: .closeAccountTapped(source: .emptyStores))
                     self.removeAppleIDAccessCoordinator.start()
                 }
             }
@@ -716,8 +717,7 @@ private extension StorePickerViewController {
     func removeAppleIDAccess() async -> Result<Void, Error> {
         await withCheckedContinuation { [weak self] continuation in
             guard let self = self else { return }
-            let action = AccountAction.removeAppleIDAccess(dotcomAppID: ApiCredentials.dotcomAppId,
-                                                           dotcomSecret: ApiCredentials.dotcomSecret) { result in
+            let action = AccountAction.closeAccount { result in
                 continuation.resume(returning: result)
             }
             self.stores.dispatch(action)

WooCommerce/Classes/ViewRelated/Dashboard/Settings/RemoveAppleIDAccessCoordinator.swift

@@ -1,21 +1,28 @@
 import UIKit
+import protocol Yosemite.StoresManager
 
 /// Coordinates navigation for removing Apple ID access from various entry points (settings and empty stores screens).
-final class RemoveAppleIDAccessCoordinator {
+@MainActor final class RemoveAppleIDAccessCoordinator {
     private let sourceViewController: UIViewController
     private let removeAction: () async -> Result<Void, Error>
     private let onRemoveSuccess: () -> Void
+    private let stores: StoresManager
+    private let analytics: Analytics
 
     /// - Parameters:
     ///   - sourceViewController: the view controller that presents the in-progress UI and alerts.
     ///   - removeAction: called when the remove action is confirmed.
     ///   - onRemoveSuccess: called when the removal is successful.
     init(sourceViewController: UIViewController,
          removeAction: @escaping () async -> Result<Void, Error>,
-         onRemoveSuccess: @escaping () -> Void) {
+         onRemoveSuccess: @escaping () -> Void,
+         stores: StoresManager = ServiceLocator.stores,
+         analytics: Analytics = ServiceLocator.analytics) {
         self.sourceViewController = sourceViewController
         self.removeAction = removeAction
         self.onRemoveSuccess = onRemoveSuccess
+        self.stores = stores
+        self.analytics = analytics
     }
 
     func start() {
@@ -26,11 +33,15 @@ final class RemoveAppleIDAccessCoordinator {
 private extension RemoveAppleIDAccessCoordinator {
     func presentConfirmationAlert() {
         // TODO: 7068 - analytics
+
+        let username = stores.sessionManager.defaultAccount?.username ?? ""
+        let message = String.localizedStringWithFormat(Localization.ConfirmationAlert.alertMessageFormat, username)
         let alertController = UIAlertController(title: Localization.ConfirmationAlert.alertTitle,
-                                                message: Localization.ConfirmationAlert.alertMessage,
+                                                message: message,
                                                 preferredStyle: .alert)
         alertController.addActionWithTitle(Localization.ConfirmationAlert.cancelButtonTitle, style: .cancel) { _ in }
-        alertController.addActionWithTitle(Localization.ConfirmationAlert.removeButtonTitle, style: .destructive) { [weak self] _ in
+        let closeAccountAction = alertController.addActionWithTitle(Localization.ConfirmationAlert.removeButtonTitle,
+                                                                    style: .destructive) { [weak self] _ in
             guard let self = self else { return }
 
             // TODO: 7068 - analytics
@@ -44,14 +55,28 @@ private extension RemoveAppleIDAccessCoordinator {
                     guard let self = self else { return }
                     switch result {
                     case .success:
+                        self.analytics.track(event: .closeAccountSuccess())
                         self.onRemoveSuccess()
                     case .failure(let error):
-                        DDLogError("⛔️ Cannot remove Apple ID access: \(error)")
-                        self.presentErrorAlert()
+                        self.analytics.track(event: .closeAccountFailed(error: error))
+                        DDLogError("⛔️ Cannot close account: \(error)")
+                        self.presentErrorAlert(error: error)
                     }
                 }
             }
         }
+
+        // Enables close account button based on whether the username matches the user input.
+        closeAccountAction.isEnabled = false
+
+        // Username text field.
+        alertController.addTextField { textField in
+            textField.clearButtonMode = .always
+            textField.on(.editingChanged) { textField in
+                closeAccountAction.isEnabled = textField.text == username
+            }
+        }
+
         sourceViewController.present(alertController, animated: true)
     }
 
@@ -66,62 +91,102 @@ private extension RemoveAppleIDAccessCoordinator {
         sourceViewController.dismiss(animated: true, completion: completion)
     }
 
-    func presentErrorAlert() {
+    func presentErrorAlert(error: Error) {
         let alertController = UIAlertController(title: Localization.ErrorAlert.alertTitle,
-                                                message: Localization.ErrorAlert.alertMessage,
+                                                message: generateLocalizedMessage(error: error),
                                                 preferredStyle: .alert)
+        alertController.addActionWithTitle(Localization.ErrorAlert.contactSupportButtonTitle, style: .default) { [weak self] _ in
+            guard let self = self else { return }
+            ZendeskProvider.shared.showNewRequestIfPossible(from: self.sourceViewController, with: nil)
+        }
         alertController.addActionWithTitle(Localization.ErrorAlert.dismissButtonTitle, style: .cancel) { _ in }
         sourceViewController.present(alertController, animated: true)
     }
+
+    func generateLocalizedMessage(error: Error) -> String {
+        let errorCode = errorCode(error: error)
+
+        switch errorCode {
+        case "unauthorized":
+            return NSLocalizedString("You're not authorized to close the account.",
+                                     comment: "Error message displayed when unable to close user account due to being unauthorized.")
+        case "atomic-site":
+            return NSLocalizedString("To close this account now, contact our support team.",
+                                     comment: "Error message displayed when unable to close user account due to having active atomic site.")
+        case "chargebacked-site":
+            return NSLocalizedString("This user account cannot be closed if there are unresolved chargebacks.",
+                                     comment: "Error message displayed when unable to close user account due to unresolved chargebacks.")
+        case "active-subscriptions":
+            return NSLocalizedString("This user account cannot be closed while it has active subscriptions.",
+                                     comment: "Error message displayed when unable to close user account due to having active subscriptions.")
+        case "active-memberships":
+            return NSLocalizedString("This user account cannot be closed while it has active purchases.",
+                                     comment: "Error message displayed when unable to close user account due to having active purchases.")
+        default:
+            return NSLocalizedString("An error occured while closing account.",
+                                     comment: "Default error message displayed when unable to close user account.")
+        }
+    }
+
+    func errorCode(error: Error) -> String? {
+        let userInfo = (error as NSError).userInfo
+        let errorCode = userInfo[Constants.dotcomAPIErrorCodeKey] as? String
+        return errorCode
+    }
 }
 
 private extension RemoveAppleIDAccessCoordinator {
     enum Localization {
         enum RemoveAppleIDAccessInProgressView {
             static let title = NSLocalizedString(
-                "Removing Apple ID Access...",
-                comment: "Title of the Remove Apple ID Access in-progress view."
+                "Closing account...",
+                comment: "Title of the Close Account in-progress view."
             )
         }
 
         enum ConfirmationAlert {
             static let alertTitle = NSLocalizedString(
-                "Remove Apple ID Access",
-                comment: "Remove Apple ID Access confirmation alert title - confirms and revokes Apple ID token."
+                "Confirm Close Account",
+                comment: "Close Account confirmation alert title."
             )
-            static let alertMessage = NSLocalizedString(
-                "This will log you out and reset your Sign In With Apple access token. " +
-                "You will be asked to re-enter your WordPress.com password if you Sign In With Apple again.",
-                comment: "Alert message to confirm a user meant to remove Apple ID access."
+            static let alertMessageFormat = NSLocalizedString(
+                "To confirm, please re-enter your username before closing.\n\n%1$@",
+                comment: "Close Account confirmation alert message. The %1$@ is the user's WordPress.com username."
             )
             static let cancelButtonTitle = NSLocalizedString(
                 "Cancel",
-                comment: "Alert button title - dismisses alert, which cancels the Remove Apple ID Access attempt."
+                comment: "Close Account button title - dismisses alert, which cancels the Close Account attempt."
             )
 
             static let removeButtonTitle = NSLocalizedString(
-                "Remove",
-                comment: "Remove Apple ID Access button title - confirms and revokes Apple ID token."
+                "Permanently Close Account",
+                comment: "Close Account button title - confirms and closes user's WordPress.com account."
             )
         }
 
         enum ErrorAlert {
             static let alertTitle = NSLocalizedString(
-                "Error Removing Apple ID Access",
-                comment: "Remove Apple ID Access error alert title."
+                "Couldn’t close account automatically",
+                comment: "Error title displayed when unable to close user account."
             )
-            static let alertMessage = NSLocalizedString(
-                "Please try again or contact us for support.",
-                comment: "Remove Apple ID Access error alert message."
+            static let contactSupportButtonTitle = NSLocalizedString(
+                "Contact Support",
+                comment: "Close Account error alert button title - navigates the user to contact support."
             )
             static let dismissButtonTitle = NSLocalizedString(
-                "OK",
-                comment: "Alert button title - dismisses Remove Apple ID Access error alert."
+                "Cancel",
+                comment: "Close Account error alert button title - dismisses error alert."
             )
         }
     }
 }
 
+private extension RemoveAppleIDAccessCoordinator {
+    enum Constants {
+        static let dotcomAPIErrorCodeKey = "WordPressComRestApiErrorCodeKey"
+    }
+}
+
 enum RemoveAppleIDAccessError: Error {
     case presenterDeallocated
 }

WooCommerce/Classes/ViewRelated/Dashboard/Settings/Settings/SettingsViewController.swift

@@ -231,7 +231,7 @@ private extension SettingsViewController {
         cell.selectionStyle = .default
         cell.textLabel?.textAlignment = .center
         cell.textLabel?.textColor = .error
-        cell.textLabel?.text = Localization.removeAppleIDAccess
+        cell.textLabel?.text = Localization.closeAccount
     }
 
     func configureLogout(cell: BasicTableViewCell) {
@@ -258,14 +258,14 @@ private extension SettingsViewController {
 //
 private extension SettingsViewController {
     func removeAppleIDAccessWasPressed() {
+        ServiceLocator.analytics.track(event: .closeAccountTapped(source: .settings))
         removeAppleIDAccessCoordinator.start()
     }
 
     func removeAppleIDAccess() async -> Result<Void, Error> {
         await withCheckedContinuation { [weak self] continuation in
             guard let self = self else { return }
-            let action = AccountAction.removeAppleIDAccess(dotcomAppID: ApiCredentials.dotcomAppId,
-                                                           dotcomSecret: ApiCredentials.dotcomSecret) { result in
+            let action = AccountAction.closeAccount { result in
                 continuation.resume(returning: result)
             }
             self.stores.dispatch(action)
@@ -730,9 +730,9 @@ private extension SettingsViewController {
             comment: "Navigates to screen containing the latest WooCommerce Features"
         )
 
-        static let removeAppleIDAccess = NSLocalizedString(
-            "Remove Apple ID Access",
-            comment: "Remove Apple ID Access button title to revoke Apple ID token"
+        static let closeAccount = NSLocalizedString(
+            "Close Account",
+            comment: "Close Account button title to close the user's WordPress.com account"
         )
 
         static let logout = NSLocalizedString(

WooCommerce/WooCommerceTests/ViewRelated/Settings/RemoveAppleIDAccessCoordinatorTests.swift

@@ -28,7 +28,7 @@ final class RemoveAppleIDAccessCoordinatorTests: XCTestCase {
         super.tearDown()
     }
 
-    func test_alert_is_presented_when_starting_coordinator() throws {
+    @MainActor func test_alert_is_presented_when_starting_coordinator() throws {
         // Given
         let coordinator = RemoveAppleIDAccessCoordinator(sourceViewController: sourceViewController) {
             return .success(())

Yosemite/Yosemite/Actions/AccountAction.swift

@@ -14,5 +14,5 @@ public enum AccountAction: Action {
     case synchronizeSites(selectedSiteID: Int64?, isJetpackConnectionPackageSupported: Bool, onCompletion: (Result<Bool, Error>) -> Void)
     case synchronizeSitePlan(siteID: Int64, onCompletion: (Result<Void, Error>) -> Void)
     case updateAccountSettings(userID: Int64, tracksOptOut: Bool, onCompletion: (Result<Void, Error>) -> Void)
-    case removeAppleIDAccess(dotcomAppID: String, dotcomSecret: String, onCompletion: (Result<Void, Error>) -> Void)
+    case closeAccount(onCompletion: (Result<Void, Error>) -> Void)
 }