Push notifications: Clean up logic for register/unregister tokens (#16434)

Author: itsmeichigo

Modules/Sources/Networking/Remote/DevicesRemote.swift

@@ -11,13 +11,11 @@ public class DevicesRemote: Remote {
     ///     - device: APNS Device to be registered.
     ///     - applicationId: App ID.
     ///     - applicationVersion: App Version.
-    ///     - defaultStoreID: Active Store ID.
     ///     - completion: Closure to be executed on completion.
     ///
     public func registerDevice(device: APNSDevice,
                                applicationId: String,
                                applicationVersion: String,
-                               defaultStoreID: Int64,
                                completion: @escaping (DotcomDevice?, Error?) -> Void) {
         var parameters = [
             ParameterKeys.applicationId: applicationId,
@@ -27,7 +25,6 @@ public class DevicesRemote: Remote {
             ParameterKeys.deviceModel: device.model,
             ParameterKeys.deviceName: device.name,
             ParameterKeys.deviceOSVersion: device.iOSVersion,
-            ParameterKeys.defaultStoreID: ""
         ]
 
         if let deviceUUID = device.identifierForVendor {
@@ -84,6 +81,5 @@ private extension DevicesRemote {
         static let deviceName = "device_name"
         static let deviceOSVersion = "os_version"
         static let deviceUUID = "device_uuid"
-        static let defaultStoreID = "selected_blog_id"
     }
 }

Modules/Sources/Yosemite/Actions/NotificationAction.swift

@@ -12,7 +12,6 @@ public enum NotificationAction: Action {
     case registerDevice(device: APNSDevice,
                         applicationId: String,
                         applicationVersion: String,
-                        defaultStoreID: Int64,
                         onCompletion: (DotcomDevice?, Error?) -> Void)
 
     /// Unregisters a device for Push Notifications Delivery.

Modules/Sources/Yosemite/Stores/NotificationStore.swift

@@ -37,12 +37,10 @@ public class NotificationStore: Store {
         case .registerDevice(let device,
                              let applicationId,
                              let applicationVersion,
-                             let defaultStoreID,
                              let onCompletion):
             registerDevice(device: device,
                            applicationId: applicationId,
                            applicationVersion: applicationVersion,
-                           defaultStoreID: defaultStoreID,
                            onCompletion: onCompletion)
         case .synchronizeNotifications(let onCompletion):
             synchronizeNotifications(onCompletion: onCompletion)
@@ -72,12 +70,10 @@ private extension NotificationStore {
     func registerDevice(device: APNSDevice,
                         applicationId: String,
                         applicationVersion: String,
-                        defaultStoreID: Int64,
                         onCompletion: @escaping (DotcomDevice?, Error?) -> Void) {
         devicesRemote.registerDevice(device: device,
                               applicationId: applicationId,
                               applicationVersion: applicationVersion,
-                              defaultStoreID: defaultStoreID,
                               completion: onCompletion)
     }
 

Modules/Tests/NetworkingTests/Remote/DevicesRemoteTests.swift

@@ -29,8 +29,7 @@ final class DevicesRemoteTests: XCTestCase {
 
         remote.registerDevice(device: Parameters.appleDevice,
                               applicationId: Parameters.applicationId,
-                              applicationVersion: Parameters.applicationVersion,
-                              defaultStoreID: Parameters.defaultStoreID) { (settings, error) in
+                              applicationVersion: Parameters.applicationVersion) { (settings, error) in
 
             XCTAssertNil(error)
             XCTAssertNotNil(settings)
@@ -41,24 +40,6 @@ final class DevicesRemoteTests: XCTestCase {
         wait(for: [expectation], timeout: Constants.expectationTimeout)
     }
 
-    /// Verifies that registerDevice sets the `selected_blog_id` parameter to empty string.
-    ///
-    func test_registerDevice_sets_selected_blog_id_to_empty_string() throws {
-        // Given
-        let remote = DevicesRemote(network: network)
-
-        // When
-        remote.registerDevice(device: Parameters.appleDevice,
-                              applicationId: Parameters.applicationId,
-                              applicationVersion: Parameters.applicationVersion,
-                              defaultStoreID: Parameters.defaultStoreID) { (_, _) in }
-
-        // Then
-        let queryParameters = try XCTUnwrap(network.queryParameters)
-        let expectedParam = "selected_blog_id="
-        XCTAssertTrue(queryParameters.contains(expectedParam), "Expected to have param: \(expectedParam)")
-    }
-
     /// Verifies that registerDevice parses a "Failure" Backend Response.
     ///
     func test_registerDevice_parses_general_failure_response() {
@@ -69,8 +50,7 @@ final class DevicesRemoteTests: XCTestCase {
 
         remote.registerDevice(device: Parameters.appleDevice,
                               applicationId: Parameters.applicationId,
-                              applicationVersion: Parameters.applicationVersion,
-                              defaultStoreID: Parameters.defaultStoreID) { (settings, error) in
+                              applicationVersion: Parameters.applicationVersion) { (settings, error) in
 
             XCTAssertNotNil(error)
             XCTAssertNil(settings)
@@ -124,6 +104,5 @@ private enum Parameters {
                                         identifierForVendor: "1234")
     static let applicationId = "9"
     static let applicationVersion = "99"
-    static let defaultStoreID: Int64 = 1234
     static let dotcomDeviceID = "1234"
 }

Modules/Tests/YosemiteTests/Stores/NotificationStoreTests.swift

@@ -364,8 +364,7 @@ class NotificationStoreTests: XCTestCase {
         let (device, error): (DotcomDevice?, Error?) = waitFor { promise in
             let action = NotificationAction.registerDevice(device: self.sampleAPNSDevice(),
                                                            applicationId: self.sampleApplicationID,
-                                                           applicationVersion: self.sampleApplicationVersion,
-                                                           defaultStoreID: self.sampleDefaultStoreID) { (device, error) in
+                                                           applicationVersion: self.sampleApplicationVersion) { (device, error) in
                 promise((device, error))
             }
             noteStore.onAction(action)
@@ -389,8 +388,7 @@ class NotificationStoreTests: XCTestCase {
         let (device, error): (DotcomDevice?, Error?) = waitFor { promise in
             let action = NotificationAction.registerDevice(device: self.sampleAPNSDevice(),
                                                            applicationId: self.sampleApplicationID,
-                                                           applicationVersion: self.sampleApplicationVersion,
-                                                           defaultStoreID: self.sampleDefaultStoreID) { (device, error) in
+                                                           applicationVersion: self.sampleApplicationVersion) { (device, error) in
                 promise((device, error))
             }
             noteStore.onAction(action)
@@ -490,12 +488,6 @@ private extension NotificationStoreTests {
         return "1234"
     }
 
-    /// Returns a sample Default Store ID
-    ///
-    var sampleDefaultStoreID: Int64 {
-        return 1234
-    }
-
     /// Returns a sample Apple Device
     ///
     func sampleAPNSDevice() -> APNSDevice {

RELEASE-NOTES.txt

@@ -5,6 +5,7 @@
 -----
 - [*] Show specific error when a variation is missing at POS checkout via WPCom login [https://github.com/woocommerce/woocommerce-ios/pull/16430]
 - [Internal] Moved the request for push notification authorization after login [https://github.com/woocommerce/woocommerce-ios/pull/16428]
+- [Internal] Cleaned up logic for push notification token registration [https://github.com/woocommerce/woocommerce-ios/pull/16434]
 - [*] Fixed possible sync issue in POS (https://github.com/woocommerce/woocommerce-ios/pull/16423)
 
 23.8

WooCommerce/Classes/AppDelegate.swift

@@ -112,11 +112,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     }
 
     func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
-        guard let defaultStoreID = ServiceLocator.stores.sessionManager.defaultStoreID else {
-            return
-        }
-
-        ServiceLocator.pushNotesManager.registerDeviceToken(with: deviceToken, defaultStoreID: defaultStoreID)
+        ServiceLocator.pushNotesManager.registerDeviceToken(with: deviceToken)
     }
 
     func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {

WooCommerce/Classes/Notifications/PushNotificationsManager.swift

@@ -219,7 +219,7 @@ extension PushNotificationsManager {
     ///     - tokenData: APNS's Token Data
     ///     - defaultStoreID: Default WooCommerce Store ID
     ///
-    func registerDeviceToken(with tokenData: Data, defaultStoreID: Int64) {
+    func registerDeviceToken(with tokenData: Data) {
         let newToken = tokenData.hexString
 
         if let _ = deviceToken, deviceToken != newToken {
@@ -231,7 +231,7 @@ extension PushNotificationsManager {
         deviceToken = newToken
 
         // Register in the Dotcom's Infrastructure
-        registerDotcomDevice(with: newToken, defaultStoreID: defaultStoreID) { (device, error) in
+        registerDotcomDevice(with: newToken) { (device, error) in
             guard let deviceID = device?.deviceID else {
                 DDLogError("⛔️ Dotcom Push Notifications Registration Failure: \(error.debugDescription)")
                 return
@@ -556,12 +556,11 @@ private extension PushNotificationsManager {
 
     /// Registers an APNS DeviceToken in the WordPress.com backend.
     ///
-    func registerDotcomDevice(with deviceToken: String, defaultStoreID: Int64, onCompletion: @escaping (DotcomDevice?, Error?) -> Void) {
+    func registerDotcomDevice(with deviceToken: String, onCompletion: @escaping (DotcomDevice?, Error?) -> Void) {
         let device = APNSDevice(deviceToken: deviceToken)
         let action = NotificationAction.registerDevice(device: device,
                                                        applicationId: WooConstants.pushApplicationID,
                                                        applicationVersion: Bundle.main.version,
-                                                       defaultStoreID: defaultStoreID,
                                                        onCompletion: onCompletion)
         stores.dispatch(action)
     }

WooCommerce/Classes/ServiceLocator/PushNotesManager.swift

@@ -72,9 +72,8 @@ protocol PushNotesManager {
     ///
     /// - Parameters:
     ///     - tokenData: APNS's Token Data
-    ///     - defaultStoreID: Default WooCommerce Store ID
     ///
-    func registerDeviceToken(with tokenData: Data, defaultStoreID: Int64)
+    func registerDeviceToken(with tokenData: Data)
 
     /// Handles a remote push notification payload when the app is in the background.
     /// - Parameter userInfo: Push notification payload.

WooCommerce/Classes/Yosemite/DefaultStoresManager.swift

@@ -270,7 +270,6 @@ class DefaultStoresManager: StoresManager {
         sessionManager.deleteApplicationPassword(locally: true)
         ServiceLocator.analytics.refreshUserData()
         ZendeskProvider.shared.reset()
-        ServiceLocator.pushNotesManager.unregisterForRemoteNotifications {}
     }
 
     /// Fully deauthenticates the user, if needed.