Merge pull request #7323 from woocommerce/feat/7318-local-notifications-feature-flag-and-setup

Login Reminder: schedule a local notification 24 hours after the user encounters an error logging in with site address

Author: jaclync

Experiments/Experiments/DefaultFeatureFlagService.swift

@@ -47,6 +47,8 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return true
         case .loginPrologueOnboarding:
             return true
+        case .loginErrorNotifications:
+            return buildConfig == .localDeveloper || buildConfig == .alpha
         default:
             return true
         }

Experiments/Experiments/FeatureFlag.swift

@@ -97,4 +97,8 @@ public enum FeatureFlag: Int {
     /// Onboarding experiment on the login prologue screen
     ///
     case loginPrologueOnboarding
+
+    /// Local notifications scheduled 24 hours after certain login errors
+    ///
+    case loginErrorNotifications
 }

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -38,6 +38,7 @@ public enum WooAnalyticsStat: String {
     case loginEmailFormViewed = "login_email_form_viewed"
     case loginJetpackRequiredScreenViewed = "login_jetpack_required_screen_viewed"
     case loginJetpackRequiredViewInstructionsButtonTapped = "login_jetpack_required_view_instructions_button_tapped"
+    case loginLocalNotificationTapped = "login_local_notification_tapped"
     case loginWhatIsJetpackHelpScreenViewed = "login_what_is_jetpack_help_screen_viewed"
     case loginWhatIsJetpackHelpScreenOkButtonTapped = "login_what_is_jetpack_help_screen_ok_button_tapped"
     case loginWhatIsJetpackHelpScreenLearnMoreButtonTapped = "login_what_is_jetpack_help_screen_learn_more_button_tapped"

WooCommerce/Classes/AppDelegate.swift

@@ -63,6 +63,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         setupKeyboardStateProvider()
         handleLaunchArguments()
         appleIDCredentialChecker.observeLoggedInStateForAppleIDObservations()
+        setupUserNotificationCenter()
 
         // Components that require prior Auth
         setupZendesk()
@@ -288,6 +289,9 @@ private extension AppDelegate {
     ///
     func setupPushNotificationsManagerIfPossible() {
         guard ServiceLocator.stores.isAuthenticated, ServiceLocator.stores.needsDefaultStore == false else {
+            if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.loginErrorNotifications) {
+                ServiceLocator.pushNotesManager.ensureAuthorizationIsRequested(includesProvisionalAuth: true, onCompletion: nil)
+            }
             return
         }
 
@@ -296,10 +300,17 @@ private extension AppDelegate {
         #else
             let pushNotesManager = ServiceLocator.pushNotesManager
             pushNotesManager.registerForRemoteNotifications()
-            pushNotesManager.ensureAuthorizationIsRequested(onCompletion: nil)
+            pushNotesManager.ensureAuthorizationIsRequested(includesProvisionalAuth: false, onCompletion: nil)
         #endif
     }
 
+    func setupUserNotificationCenter() {
+        guard ServiceLocator.featureFlagService.isFeatureFlagEnabled(.loginErrorNotifications) else {
+            return
+        }
+        UNUserNotificationCenter.current().delegate = self
+    }
+
     /// Set up app review prompt
     ///
     func setupAppRatingManager() {
@@ -403,3 +414,32 @@ extension AppDelegate {
         RequirementsChecker.checkMinimumWooVersionForDefaultStore()
     }
 }
+
+// MARK: - UNUserNotificationCenterDelegate
+
+extension AppDelegate: UNUserNotificationCenterDelegate {
+    func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse) async {
+        switch response.actionIdentifier {
+        case LocalNotification.Action.contactSupport.rawValue:
+            guard let viewController = window?.rootViewController else {
+                return
+            }
+            ZendeskProvider.shared.showNewRequestIfPossible(from: viewController, with: nil)
+            ServiceLocator.analytics.track(.loginLocalNotificationTapped, withProperties: [
+                "action": "contact_support",
+                "type": response.notification.request.identifier
+            ])
+        default:
+            // Triggered when the user taps on the notification itself instead of one of the actions.
+            switch response.notification.request.identifier {
+            case LocalNotification.Scenario.loginSiteAddressError.rawValue:
+                ServiceLocator.analytics.track(.loginLocalNotificationTapped, withProperties: [
+                    "action": "default",
+                    "type": response.notification.request.identifier
+                ])
+            default:
+                return
+            }
+        }
+    }
+}

WooCommerce/Classes/Authentication/AuthenticationManager.swift

@@ -209,6 +209,8 @@ extension AuthenticationManager: WordPressAuthenticatorDelegate {
     }
 
     func handleError(_ error: Error, onCompletion: @escaping (UIViewController) -> Void) {
+        requestLocalNotificationIfApplicable(error: error)
+
         guard let errorViewModel = viewModel(error) else {
             return
         }
@@ -264,6 +266,10 @@ extension AuthenticationManager: WordPressAuthenticatorDelegate {
             return
         }
 
+        if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.loginErrorNotifications) {
+            ServiceLocator.pushNotesManager.cancelLocalNotification(scenarios: [.loginSiteAddressError])
+        }
+
         let matcher = ULAccountMatcher()
         matcher.refreshStoredSites()
 
@@ -404,6 +410,28 @@ extension AuthenticationManager: WordPressAuthenticatorDelegate {
     }
 }
 
+// MARK: - Local notifications
+
+private extension AuthenticationManager {
+    func requestLocalNotificationIfApplicable(error: Error) {
+        guard ServiceLocator.featureFlagService.isFeatureFlagEnabled(.loginErrorNotifications) else {
+            return
+        }
+
+        let wooAuthError = AuthenticationError.make(with: error)
+        switch wooAuthError {
+        case .notWPSite, .notValidAddress:
+            let notification = LocalNotification(scenario: .loginSiteAddressError)
+            ServiceLocator.pushNotesManager.cancelLocalNotification(scenarios: [notification.scenario])
+            ServiceLocator.pushNotesManager.requestLocalNotification(notification,
+                                                                     // 24 hours from now.
+                                                                     trigger: UNTimeIntervalNotificationTrigger(timeInterval: 86400, repeats: false))
+        default:
+            break
+        }
+    }
+}
+
 // MARK: - Private helpers
 private extension AuthenticationManager {
     func isJetpackValidForSelfHostedSite(url: String) -> Bool {

WooCommerce/Classes/Notifications/LocalNotification.swift

@@ -0,0 +1,62 @@
+import Foundation
+
+/// Content for a local notification to be converted to `UNNotificationContent`.
+struct LocalNotification {
+    let title: String
+    let body: String
+    let scenario: Scenario
+    let actions: CategoryActions?
+
+    /// A category of actions in a notification.
+    struct CategoryActions {
+        let category: Category
+        let actions: [Action]
+    }
+
+    /// The scenario for the local notification.
+    /// Its raw value is used for the identifier of a local notification and also the event property for analytics.
+    enum Scenario: String {
+        case loginSiteAddressError = "site_address_error"
+    }
+
+    /// The category of actions for a local notification.
+    enum Category: String {
+        case loginError
+    }
+
+    /// The action type in a local notification.
+    enum Action: String {
+        case contactSupport
+
+        /// The title of the action in a local notification.
+        var title: String {
+            switch self {
+            case .contactSupport:
+                return NSLocalizedString("Contact support", comment: "Local notification action to contact support.")
+            }
+        }
+    }
+}
+
+extension LocalNotification {
+    init(scenario: Scenario) {
+        switch scenario {
+        case .loginSiteAddressError:
+            self.init(title: Localization.errorLoggingInTitle,
+                      body: Localization.errorLoggingInBody,
+                      scenario: .loginSiteAddressError,
+                      actions: .init(category: .loginError, actions: [.contactSupport]))
+        }
+    }
+}
+
+private extension LocalNotification {
+    enum Localization {
+        static let errorLoggingInTitle = NSLocalizedString("Problems with logging in?",
+                                                           comment: "Local notification title when the user encounters an error logging in " +
+                                                           "with site address.")
+        static let errorLoggingInBody = NSLocalizedString("Get some help!",
+                                                          comment: "Local notification body when the user encounters an error logging in " +
+                                                          "with site address.")
+    }
+}

WooCommerce/Classes/Notifications/PushNotificationsManager.swift

@@ -95,20 +95,20 @@ final class PushNotificationsManager: PushNotesManager {
 //
 extension PushNotificationsManager {
 
-    /// Requests Authorization to receive Push Notifications, *only* when the current Status is not determined.
+    /// Requests Authorization to receive Push Notifications, *only* when the current Status is not determined or provisional.
     ///
     /// - Parameter onCompletion: Closure to be executed on completion. Receives a Boolean indicating if we've got Push Permission.
     ///
-    func ensureAuthorizationIsRequested(onCompletion: ((Bool) -> Void)? = nil) {
+    func ensureAuthorizationIsRequested(includesProvisionalAuth: Bool = false, onCompletion: ((Bool) -> Void)? = nil) {
         let nc = configuration.userNotificationsCenter
 
         nc.loadAuthorizationStatus(queue: .main) { status in
-            guard status == .notDetermined else {
+            guard status == .notDetermined || status == .provisional else {
                 onCompletion?(status == .authorized)
                 return
             }
 
-            nc.requestAuthorization(queue: .main) { allowed in
+            nc.requestAuthorization(queue: .main, includesProvisionalAuth: includesProvisionalAuth) { allowed in
                 let stat: WooAnalyticsStat = allowed ? .pushNotificationOSAlertAllowed : .pushNotificationOSAlertDenied
                 ServiceLocator.analytics.track(stat)
 
@@ -261,6 +261,54 @@ extension PushNotificationsManager {
             }
         }
     }
+
+    func requestLocalNotification(_ notification: LocalNotification, trigger: UNNotificationTrigger?) {
+        Task {
+            // TODO: 7318 - tech debt - replace `UNUserNotificationCenter.current()` with
+            // `configuration.userNotificationsCenter` for unit testing
+            let center = UNUserNotificationCenter.current()
+            let settings = await center.notificationSettings()
+            guard settings.authorizationStatus == .authorized || settings.authorizationStatus == .provisional else {
+                DDLogError("⛔️ Unable to request a local notification due to invalid authorization status: \(settings.authorizationStatus)")
+                return
+            }
+
+            let content = UNMutableNotificationContent()
+            content.title = notification.title
+            content.body = notification.body
+
+            if let categoryAndActions = notification.actions {
+                let categoryIdentifier = categoryAndActions.category.rawValue
+                let actions = categoryAndActions.actions.map {
+                    UNNotificationAction(identifier: $0.rawValue,
+                                         title: $0.title,
+                                         options: .foreground)
+                }
+                let category = UNNotificationCategory(identifier: categoryIdentifier,
+                                                      actions: actions,
+                                                      intentIdentifiers: [],
+                                                      hiddenPreviewsBodyPlaceholder: nil,
+                                                      categorySummaryFormat: nil,
+                                                      options: .allowAnnouncement)
+                center.setNotificationCategories([category])
+                content.categoryIdentifier = categoryIdentifier
+            }
+
+            let request = UNNotificationRequest(identifier: notification.scenario.rawValue,
+                                                content: content,
+                                                trigger: trigger)
+            do {
+                try await center.add(request)
+            } catch {
+                DDLogError("⛔️ Unable to request a local notification: \(error)")
+            }
+        }
+    }
+
+    func cancelLocalNotification(scenarios: [LocalNotification.Scenario]) {
+        let center = UNUserNotificationCenter.current()
+        center.removePendingNotificationRequests(withIdentifiers: scenarios.map { $0.rawValue })
+    }
 }
 
 // MARK: - Notification count & app badge number update

WooCommerce/Classes/Notifications/UserNotificationsCenterAdapter.swift

@@ -12,7 +12,7 @@ protocol UserNotificationsCenterAdapter {
 
     /// Requests Push Notifications Authorization
     ///
-    func requestAuthorization(queue: DispatchQueue, completion: @escaping (Bool) -> Void)
+    func requestAuthorization(queue: DispatchQueue, includesProvisionalAuth: Bool, completion: @escaping (Bool) -> Void)
 
     /// Removes all push notifications that have been delivered or scheduled
     func removeAllNotifications()
@@ -35,8 +35,9 @@ extension UNUserNotificationCenter: UserNotificationsCenterAdapter {
 
     /// Requests Push Notifications Authorization
     ///
-    func requestAuthorization(queue: DispatchQueue = .main, completion: @escaping (Bool) -> Void) {
-        requestAuthorization(options: [.badge, .sound, .alert]) { (allowed, _)  in
+    func requestAuthorization(queue: DispatchQueue = .main, includesProvisionalAuth: Bool, completion: @escaping (Bool) -> Void) {
+        let options: UNAuthorizationOptions = includesProvisionalAuth ? [.badge, .sound, .alert, .provisional]: [.badge, .sound, .alert]
+        requestAuthorization(options: options) { (allowed, _)  in
             queue.async {
                 completion(allowed)
             }

WooCommerce/Classes/ServiceLocator/PushNotesManager.swift

@@ -42,9 +42,10 @@ protocol PushNotesManager {
 
     /// Requests Authorization to receive Push Notifications, *only* when the current Status is not determined.
     ///
+    /// - Parameter includesProvisionalAuth: A boolean that indicates whether to request provisional authorization in order to send trial notifications.
     /// - Parameter onCompletion: Closure to be executed on completion. Receives a Boolean indicating if we've got Push Permission.
     ///
-    func ensureAuthorizationIsRequested(onCompletion: ((Bool) -> Void)?)
+    func ensureAuthorizationIsRequested(includesProvisionalAuth: Bool, onCompletion: ((Bool) -> Void)?)
 
     /// Handles Push Notifications Registration Errors. This method unregisters the current device from the WordPress.com
     /// Push Service.
@@ -66,4 +67,14 @@ protocol PushNotesManager {
     func handleNotification(_ userInfo: [AnyHashable: Any],
                             onBadgeUpdateCompletion: @escaping () -> Void,
                             completionHandler: @escaping (UIBackgroundFetchResult) -> Void)
+
+    /// Requests a local notification to be scheduled under a given trigger.
+    /// - Parameters:
+    ///   - notification: the notification content.
+    ///   - trigger: if nil, the local notification is delivered immediately.
+    func requestLocalNotification(_ notification: LocalNotification, trigger: UNNotificationTrigger?)
+
+    /// Cancels a local notification that was previously scheduled.
+    /// - Parameter scenarios: the scenarios of the notification to be cancelled.
+    func cancelLocalNotification(scenarios: [LocalNotification.Scenario])
 }

WooCommerce/WooCommerce.xcodeproj/project.pbxproj

@@ -93,6 +93,7 @@
 		021E2A1E23AA24C600B1DE07 /* StringInputFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 021E2A1D23AA24C600B1DE07 /* StringInputFormatter.swift */; };
 		021E2A2023AA274700B1DE07 /* ProductBackordersSettingListSelectorCommandTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 021E2A1F23AA274700B1DE07 /* ProductBackordersSettingListSelectorCommandTests.swift */; };
 		021FB44C24A5E3B00090E144 /* ProductListMultiSelectorSearchUICommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 021FB44B24A5E3B00090E144 /* ProductListMultiSelectorSearchUICommand.swift */; };
+		0221121E288973C20028F0AF /* LocalNotification.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0221121D288973C20028F0AF /* LocalNotification.swift */; };
 		0225C42824768A4C00C5B4F0 /* FilterProductListViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0225C42724768A4C00C5B4F0 /* FilterProductListViewModelTests.swift */; };
 		0225C42A24768CE900C5B4F0 /* FilterProductListViewModelProductListFilterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0225C42924768CE900C5B4F0 /* FilterProductListViewModelProductListFilterTests.swift */; };
 		0225C42C2477D0D500C5B4F0 /* ProductFormViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0225C42B2477D0D500C5B4F0 /* ProductFormViewModel.swift */; };
@@ -1901,6 +1902,7 @@
 		021E2A1D23AA24C600B1DE07 /* StringInputFormatter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StringInputFormatter.swift; sourceTree = "<group>"; };
 		021E2A1F23AA274700B1DE07 /* ProductBackordersSettingListSelectorCommandTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductBackordersSettingListSelectorCommandTests.swift; sourceTree = "<group>"; };
 		021FB44B24A5E3B00090E144 /* ProductListMultiSelectorSearchUICommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductListMultiSelectorSearchUICommand.swift; sourceTree = "<group>"; };
+		0221121D288973C20028F0AF /* LocalNotification.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LocalNotification.swift; sourceTree = "<group>"; };
 		0225C42724768A4C00C5B4F0 /* FilterProductListViewModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FilterProductListViewModelTests.swift; sourceTree = "<group>"; };
 		0225C42924768CE900C5B4F0 /* FilterProductListViewModelProductListFilterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FilterProductListViewModelProductListFilterTests.swift; sourceTree = "<group>"; };
 		0225C42B2477D0D500C5B4F0 /* ProductFormViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductFormViewModel.swift; sourceTree = "<group>"; };
@@ -6719,6 +6721,7 @@
 				B5BBD6DD21B1703600E3207E /* PushNotificationsManager.swift */,
 				B509FED221C05121000076A9 /* SupportManagerAdapter.swift */,
 				B555530C21B57DC300449E71 /* UserNotificationsCenterAdapter.swift */,
+				0221121D288973C20028F0AF /* LocalNotification.swift */,
 			);
 			path = Notifications;
 			sourceTree = "<group>";
@@ -9327,6 +9330,7 @@
 				57A49128250A7EB2000FEF21 /* OrderListViewController.swift in Sources */,
 				DE34771327F174C8009CA300 /* StatusView.swift in Sources */,
 				45DB704A26121F3C0064A6CF /* TitleAndValueRow.swift in Sources */,
+				0221121E288973C20028F0AF /* LocalNotification.swift in Sources */,
 				451A04E62386CE8700E368C9 /* ProductImagesHeaderTableViewCell.swift in Sources */,
 				02E19B9C284743A40010B254 /* ProductImageUploader.swift in Sources */,
 				B59C09D92188CBB100AB41D6 /* Array+Notes.swift in Sources */,