Merge pull request #5299 from woocommerce/issue/5032-new-push-notification-payload

jaclync · web-flow · commit 5d390ed524cc · 2021-11-10T17:00:03.000+08:00
Support new push notification payload format for multi-store push notifications
diff --git a/Experiments/Experiments/DefaultFeatureFlagService.swift b/Experiments/Experiments/DefaultFeatureFlagService.swift
@@ -20,7 +20,7 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
         case .shippingLabelsMultiPackage:
             return true
         case .pushNotificationsForAllStores:
-            return buildConfig == .localDeveloper || buildConfig == .alpha
+            return true
         case .simplePaymentsPrototype:
             return buildConfig == .localDeveloper || buildConfig == .alpha
         case .orderListFilters:
diff --git a/Networking/Networking/Remote/DevicesRemote.swift b/Networking/Networking/Remote/DevicesRemote.swift
@@ -12,7 +12,7 @@ public class DevicesRemote: Remote {
     ///     - applicationId: App ID.
     ///     - applicationVersion: App Version.
     ///     - defaultStoreID: Active Store ID.
-    ///     - completion: Closure to be executed on commpletion.
+    ///     - completion: Closure to be executed on completion.
     ///
     public func registerDevice(device: APNSDevice,
                                applicationId: String,
@@ -48,7 +48,7 @@ public class DevicesRemote: Remote {
     ///
     /// - Parameters:
     ///     - deviceId: Identifier of the device to be removed.
-    ///     - completion: Closure to be executed on commpletion.
+    ///     - completion: Closure to be executed on completion.
     ///
     public func unregisterDevice(deviceId: String, completion: @escaping (Error?) -> Void) {
         let path = String(format: Paths.delete, deviceId)
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -2,6 +2,7 @@
 
 8.0
 -----
+- [***] Push notifications are now supported for all connected stores. [https://github.com/woocommerce/woocommerce-ios/pull/5299]
 - [*] Fix: in Settings > Switch Store, tapping "Dismiss" after selecting a different store does not switch stores anymore. [https://github.com/woocommerce/woocommerce-ios/pull/5359]
 
 7.9
diff --git a/WooCommerce/Classes/Notifications/ApplicationAdapter.swift b/WooCommerce/Classes/Notifications/ApplicationAdapter.swift
@@ -18,9 +18,9 @@ protocol ApplicationAdapter: AnyObject {
     ///
     func registerForRemoteNotifications()
 
-    /// Presents a given Message with an "In App" notification
+    /// Presents a given title and optional subtitle and message with an "In App" notification
     ///
-    func presentInAppNotification(message: String)
+    func presentInAppNotification(title: String, subtitle: String?, message: String?)
 
     /// Presents the Details for the specified Notification.
     ///
@@ -40,8 +40,8 @@ extension UIApplication: ApplicationAdapter {
 
     /// Presents a given Message with an "In App" notification
     ///
-    func presentInAppNotification(message: String) {
-        let notice = Notice(title: message, message: nil, feedbackType: .success)
+    func presentInAppNotification(title: String, subtitle: String?, message: String?) {
+        let notice = Notice(title: title, subtitle: subtitle, message: message, feedbackType: .success)
         ServiceLocator.noticePresenter.enqueue(notice: notice)
     }
 }
diff --git a/WooCommerce/Classes/Notifications/PushNotificationsManager.swift b/WooCommerce/Classes/Notifications/PushNotificationsManager.swift
@@ -1,3 +1,4 @@
+import Experiments
 import Foundation
 import UserNotifications
 import AutomatticTracks
@@ -70,12 +71,16 @@ final class PushNotificationsManager: PushNotesManager {
         configuration.storesManager
     }
 
+    private let featureFlagService: FeatureFlagService
+
     /// Initializes the PushNotificationsManager.
     ///
     /// - Parameter configuration: PushNotificationsConfiguration Instance that should be used.
+    /// - Parameter featureFlagService: called for multi-store push notifications feature.
     ///
-    init(configuration: PushNotificationsConfiguration = .default) {
+    init(configuration: PushNotificationsConfiguration = .default, featureFlagService: FeatureFlagService = ServiceLocator.featureFlagService) {
         self.configuration = configuration
+        self.featureFlagService = featureFlagService
     }
 }
 
@@ -345,8 +350,13 @@ private extension PushNotificationsManager {
             return false
         }
 
-        if let foregroundNotification = PushNotification.from(userInfo: userInfo) {
-            configuration.application.presentInAppNotification(message: foregroundNotification.message)
+        let pushNotificationsForAllStoresEnabled = featureFlagService.isFeatureFlagEnabled(.pushNotificationsForAllStores)
+        if let foregroundNotification = PushNotification.from(userInfo: userInfo,
+                                                              pushNotificationsForAllStoresEnabled: pushNotificationsForAllStoresEnabled) {
+            configuration.application
+                .presentInAppNotification(title: foregroundNotification.title,
+                                          subtitle: foregroundNotification.subtitle,
+                                          message: foregroundNotification.message)
 
             foregroundNotificationsSubject.send(foregroundNotification)
         }
@@ -372,7 +382,9 @@ private extension PushNotificationsManager {
 
         DDLogVerbose("📱 Handling Notification in Inactive State")
 
-        if let notification = PushNotification.from(userInfo: userInfo) {
+        let pushNotificationsForAllStoresEnabled = featureFlagService.isFeatureFlagEnabled(.pushNotificationsForAllStores)
+        if let notification = PushNotification.from(userInfo: userInfo,
+                                                    pushNotificationsForAllStoresEnabled: pushNotificationsForAllStoresEnabled) {
 
             // Handling the product review notifications (`.comment`) has been moved to
             // `ReviewsCoordinator`. All other push notification handling should be in a coordinator
@@ -418,7 +430,7 @@ private extension PushNotificationsManager {
     ///
     func registerDotcomDevice(with deviceToken: String, defaultStoreID: Int64, onCompletion: @escaping (DotcomDevice?, Error?) -> Void) {
         let device = APNSDevice(deviceToken: deviceToken)
-        let pushNotificationsForAllStoresEnabled = ServiceLocator.featureFlagService.isFeatureFlagEnabled(.pushNotificationsForAllStores)
+        let pushNotificationsForAllStoresEnabled = featureFlagService.isFeatureFlagEnabled(.pushNotificationsForAllStores)
         let action = NotificationAction.registerDevice(device: device,
                                                        applicationId: WooConstants.pushApplicationID,
                                                        applicationVersion: Bundle.main.version,
@@ -519,15 +531,27 @@ private extension PushNotificationsManager {
 // MARK: - PushNotification Extension
 
 private extension PushNotification {
-    static func from(userInfo: [AnyHashable: Any]) -> PushNotification? {
-        guard let noteID = userInfo.integer(forKey: APNSKey.identifier),
-              let message = userInfo.dictionary(forKey: APNSKey.aps)?.string(forKey: APNSKey.alert),
-              let type = userInfo.string(forKey: APNSKey.type),
-              let noteKind = Note.Kind(rawValue: type) else {
-            return nil
+    static func from(userInfo: [AnyHashable: Any], pushNotificationsForAllStoresEnabled: Bool) -> PushNotification? {
+        if pushNotificationsForAllStoresEnabled {
+            guard let noteID = userInfo.integer(forKey: APNSKey.identifier),
+                  let alert = userInfo.dictionary(forKey: APNSKey.aps)?.dictionary(forKey: APNSKey.alert),
+                  let title = alert.string(forKey: APNSKey.alertTitle),
+                  let type = userInfo.string(forKey: APNSKey.type),
+                  let noteKind = Note.Kind(rawValue: type) else {
+                return nil
+            }
+            let subtitle = alert.string(forKey: APNSKey.alertSubtitle)
+            let message = alert.string(forKey: APNSKey.alertMessage)
+            return PushNotification(noteID: noteID, kind: noteKind, title: title, subtitle: subtitle, message: message)
+        } else {
+            guard let noteID = userInfo.integer(forKey: APNSKey.identifier),
+                  let title = userInfo.dictionary(forKey: APNSKey.aps)?.string(forKey: APNSKey.alert),
+                  let type = userInfo.string(forKey: APNSKey.type),
+                  let noteKind = Note.Kind(rawValue: type) else {
+                return nil
+            }
+            return PushNotification(noteID: noteID, kind: noteKind, title: title, subtitle: nil, message: nil)
         }
-
-        return PushNotification(noteID: noteID, kind: noteKind, message: message)
     }
 }
 
@@ -547,6 +571,9 @@ enum AppIconBadgeNumber {
 private enum APNSKey {
     static let aps = "aps"
     static let alert = "alert"
+    static let alertTitle = "title"
+    static let alertSubtitle = "subtitle"
+    static let alertMessage = "body"
     static let identifier = "note_id"
     static let type = "type"
     static let siteID = "blog"
diff --git a/WooCommerce/Classes/ServiceLocator/PushNotification.swift b/WooCommerce/Classes/ServiceLocator/PushNotification.swift
@@ -12,7 +12,13 @@ struct PushNotification {
     /// The `type` value received from the Remote Notification's `userInfo`.
     ///
     let kind: Note.Kind
-    /// The `alert` value received from the Remote Notification's `userInfo`.
+    /// The `alert.title` value received from the Remote Notification's `userInfo`.
     ///
-    let message: String
+    let title: String
+    /// The `alert.subtitle` value received from the Remote Notification's `userInfo`.
+    ///
+    let subtitle: String?
+    /// The `alert.message` value received from the Remote Notification's `userInfo`.
+    ///
+    let message: String?
 }
diff --git a/WooCommerce/Classes/Tools/Notices/Notice.swift b/WooCommerce/Classes/Tools/Notices/Notice.swift
@@ -7,11 +7,15 @@ import UIKit
 ///
 struct Notice {
 
-    /// The title of the notice
+    /// The title that contains the reason for the notice
     ///
     let title: String
 
-    /// An optional subtitle for the notice
+    /// An optional subtitle that contains a secondary description of the reason for the notice
+    ///
+    let subtitle: String?
+
+    /// An optional message that contains any details for the notice
     ///
     let message: String?
 
@@ -35,12 +39,14 @@ struct Notice {
     /// Designated Initializer
     ///
     init(title: String,
+         subtitle: String? = nil,
          message: String? = nil,
          feedbackType: UINotificationFeedbackGenerator.FeedbackType? = nil,
          notificationInfo: NoticeNotificationInfo? = nil,
          actionTitle: String? = nil,
          actionHandler: ((() -> Void))? = nil) {
         self.title = title
+        self.subtitle = subtitle
         self.message = message
         self.feedbackType = feedbackType
         self.notificationInfo = notificationInfo
@@ -52,6 +58,7 @@ struct Notice {
 extension Notice: Equatable {
     static func == (lhs: Notice, rhs: Notice) -> Bool {
         return lhs.title == rhs.title &&
+            lhs.subtitle == rhs.subtitle &&
             lhs.message == rhs.message &&
             lhs.feedbackType == rhs.feedbackType &&
             lhs.notificationInfo?.identifier == rhs.notificationInfo?.identifier &&
diff --git a/WooCommerce/Classes/Tools/Notices/NoticeView.swift b/WooCommerce/Classes/Tools/Notices/NoticeView.swift
@@ -13,6 +13,7 @@ class NoticeView: UIView {
     private let shadowMaskLayer = CAShapeLayer()
 
     private let titleLabel = UILabel()
+    private let subtitleLabel = UILabel()
     private let messageLabel = UILabel()
     private let actionButton = UIButton(type: .system)
 
@@ -117,6 +118,7 @@ private extension NoticeView {
         labelStackView.layoutMargins = Metrics.layoutMargins
 
         labelStackView.addArrangedSubview(titleLabel)
+        labelStackView.addArrangedSubview(subtitleLabel)
         labelStackView.addArrangedSubview(messageLabel)
 
         contentStackView.addArrangedSubview(labelStackView)
@@ -127,9 +129,11 @@ private extension NoticeView {
             ])
 
         titleLabel.font = Fonts.titleLabelFont
+        subtitleLabel.font = Fonts.subtitleLabelFont
         messageLabel.font = Fonts.messageLabelFont
 
         titleLabel.textColor = Appearance.titleColor
+        subtitleLabel.textColor = Appearance.titleColor
         messageLabel.textColor = Appearance.titleColor
     }
 
@@ -164,6 +168,13 @@ private extension NoticeView {
     func configureForNotice() {
         titleLabel.text = notice.title
 
+        if let subtitle = notice.subtitle {
+            subtitleLabel.isHidden = false
+            subtitleLabel.text = subtitle
+        } else {
+            subtitleLabel.isHidden = true
+        }
+
         if let message = notice.message {
             messageLabel.text = message
             messageLabel.numberOfLines = 0
@@ -208,6 +219,7 @@ private extension NoticeView {
     enum Fonts {
         static let actionButtonFont = UIFont.systemFont(ofSize: 14.0)
         static let titleLabelFont = UIFont.boldSystemFont(ofSize: 14.0)
+        static let subtitleLabelFont = UIFont.boldSystemFont(ofSize: 14.0)
         static let messageLabelFont = UIFont.systemFont(ofSize: 14.0)
     }
 
diff --git a/WooCommerce/WooCommerceTests/Mocks/MockApplicationAdapter.swift b/WooCommerce/WooCommerceTests/Mocks/MockApplicationAdapter.swift
@@ -5,7 +5,7 @@ import UIKit
 
 /// MockApplicationAdapter: UIApplication Mock!
 ///
-class MockApplicationAdapter: ApplicationAdapter {
+final class MockApplicationAdapter: ApplicationAdapter {
 
     /// Badge Count
     ///
@@ -19,9 +19,9 @@ class MockApplicationAdapter: ApplicationAdapter {
     ///
     var registerWasCalled = false
 
-    /// Messages received via the `presentInAppNotification` method.
+    /// Title, subtitle, and message tuples received via the `presentInAppNotification` method.
     ///
-    var presentInAppMessages = [String]()
+    var presentInAppMessages = [(title: String, subtitle: String?, message: String?)]()
 
     /// Notification Identifiers received via the `presentNotificationDetails` method.
     ///
@@ -37,8 +37,8 @@ class MockApplicationAdapter: ApplicationAdapter {
 
     /// Innocuous `presentInAppNotification`
     ///
-    func presentInAppNotification(message: String) {
-        presentInAppMessages.append(message)
+    func presentInAppNotification(title: String, subtitle: String?, message: String?) {
+        presentInAppMessages.append((title: title, subtitle: subtitle, message: message))
     }
 
     /// Innocuous `displayNotificationDetails`
diff --git a/WooCommerce/WooCommerceTests/Notifications/PushNotificationsManagerTests.swift b/WooCommerce/WooCommerceTests/Notifications/PushNotificationsManagerTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/MainTabBarControllerTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/MainTabBarControllerTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Notifications/ReviewsCoordinatorTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Notifications/ReviewsCoordinatorTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/OrderListViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/OrderListViewModelTests.swift
