rename push subscription model's accepted property to reachable

nan-li · nan-li · commit 611e3d68fc91 · 2023-02-03T01:36:39.000-08:00
* Reachable is a more accurate representation of this property.
* Accepted implies explicit acceptance whereas this is really whether push notifications can be displayed and include provisional.
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.h b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.h
@@ -57,7 +57,7 @@ typedef void (^OSNotificationOpenedBlock)(OSNotificationOpenedResult * _Nonnull
 // can check responds to selector
 - (void)setNotificationTypes:(int)notificationTypes;
 - (void)setPushToken:(NSString * _Nonnull)pushToken;
-- (void)setAccepted:(BOOL)inAccepted;
+- (void)setReachable:(BOOL)inReachable;
 
 @end
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m
@@ -456,8 +456,8 @@ + (void)updateNotificationTypes:(int)notificationTypes {
 + (void)sendNotificationTypesUpdateToDelegate {
     // We don't delay observer update to wait until the OneSignal server is notified
     // TODO: We can do the above and delay observers until server is updated.
-    if (self.delegate && [self.delegate respondsToSelector:@selector(setAccepted:)]) {
-        [self.delegate setAccepted:[self getNotificationTypes] > 0];
+    if (self.delegate && [self.delegate respondsToSelector:@selector(setReachable:)]) {
+        [self.delegate setReachable:[self getNotificationTypes] > 0];
     }
     if (self.delegate && [self.delegate respondsToSelector:@selector(setNotificationTypes:)]) {
         [self.delegate setNotificationTypes:[self getNotificationTypes]];
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSPermission.m b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSPermission.m
@@ -210,8 +210,8 @@ + (void)fireChangesObserver:(OSPermissionStateInternal*)state  {
     }
     // Update the push subscription's _accepted property
     // TODO: This can be called before the User Manager has set itself as the delegate
-    if (OSNotificationsManager.delegate && [OSNotificationsManager.delegate respondsToSelector:@selector(setAccepted:)]) {
-        [OSNotificationsManager.delegate setAccepted:state.reachable];
+    if (OSNotificationsManager.delegate && [OSNotificationsManager.delegate respondsToSelector:@selector(setReachable:)]) {
+        [OSNotificationsManager.delegate setReachable:state.reachable];
     }
 }
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionModel.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionModel.swift
@@ -135,14 +135,14 @@ class OSSubscriptionModel: OSModel {
     // Internal property to send to server, not meant for outside access
     var enabled: Bool { // Does not consider subscription_id in the calculation
         get {
-            return calculateIsEnabled(address: address, accepted: _accepted, isDisabled: _isDisabled)
+            return calculateIsEnabled(address: address, reachable: _reachable, isDisabled: _isDisabled)
         }
     }
 
     var optedIn: Bool {
         // optedIn = permission + userPreference
         get {
-            return calculateIsOptedIn(accepted: _accepted, isDisabled: _isDisabled)
+            return calculateIsOptedIn(reachable: _reachable, isDisabled: _isDisabled)
         }
     }
 
@@ -169,13 +169,13 @@ class OSSubscriptionModel: OSModel {
      Defaults to true for email & SMS, defaults to false for push.
      Note that this property reflects the `reachable` property of a permission state. As provisional permission is considered to be `optedIn` and `enabled`.
      */
-    var _accepted: Bool {
+    var _reachable: Bool {
         didSet {
-            guard self.type == .push && _accepted != oldValue else {
+            guard self.type == .push && _reachable != oldValue else {
                 return
             }
             updateNotificationTypes()
-            firePushSubscriptionChanged(.accepted(oldValue))
+            firePushSubscriptionChanged(.reachable(oldValue))
         }
     }
 
@@ -202,13 +202,13 @@ class OSSubscriptionModel: OSModel {
     init(type: OSSubscriptionType,
          address: String?,
          subscriptionId: String?,
-         accepted: Bool,
+         reachable: Bool,
          isDisabled: Bool,
          changeNotifier: OSEventProducer<OSModelChangedHandler>) {
         self.type = type
         self.address = address
         self.subscriptionId = subscriptionId
-        _accepted = accepted
+        _reachable = reachable
         _isDisabled = isDisabled
 
         // Set test_type if subscription model is PUSH
@@ -234,7 +234,7 @@ class OSSubscriptionModel: OSModel {
         coder.encode(type.rawValue, forKey: "type") // Encodes as String
         coder.encode(address, forKey: "address")
         coder.encode(subscriptionId, forKey: "subscriptionId")
-        coder.encode(_accepted, forKey: "_accepted")
+        coder.encode(_reachable, forKey: "_reachable")
         coder.encode(_isDisabled, forKey: "_isDisabled")
         coder.encode(notificationTypes, forKey: "notificationTypes")
         coder.encode(testType, forKey: "testType")
@@ -251,7 +251,7 @@ class OSSubscriptionModel: OSModel {
         self.type = type
         self.address = coder.decodeObject(forKey: "address") as? String
         self.subscriptionId = coder.decodeObject(forKey: "subscriptionId") as? String
-        self._accepted = coder.decodeBool(forKey: "_accepted")
+        self._reachable = coder.decodeBool(forKey: "_reachable")
         self._isDisabled = coder.decodeBool(forKey: "_isDisabled")
         self.notificationTypes = coder.decodeInteger(forKey: "notificationTypes")
         self.testType = coder.decodeObject(forKey: "testType") as? Int
@@ -300,14 +300,14 @@ extension OSSubscriptionModel {
 
     // Calculates if the device is opted in to push notification.
     // Must have permission and not be opted out.
-    func calculateIsOptedIn(accepted: Bool, isDisabled: Bool) -> Bool {
-        return accepted && !isDisabled
+    func calculateIsOptedIn(reachable: Bool, isDisabled: Bool) -> Bool {
+        return reachable && !isDisabled
     }
 
     // Calculates if push notifications are enabled on the device.
     // Does not consider the existence of the subscription_id, as we send this in the request to create a push subscription.
-    func calculateIsEnabled(address: String?, accepted: Bool, isDisabled: Bool) -> Bool {
-        return address != nil && accepted && !isDisabled
+    func calculateIsEnabled(address: String?, reachable: Bool, isDisabled: Bool) -> Bool {
+        return address != nil && reachable && !isDisabled
     }
 
     func updateNotificationTypes() {
@@ -316,7 +316,7 @@ extension OSSubscriptionModel {
 
     enum OSPushPropertyChanged {
         case subscriptionId(String?)
-        case accepted(Bool)
+        case reachable(Bool)
         case isDisabled(Bool)
         case address(String?)
     }
@@ -328,29 +328,29 @@ extension OSSubscriptionModel {
 
         switch changedProperty {
         case .subscriptionId(let oldValue):
-            prevIsEnabled = calculateIsEnabled(address: address, accepted: _accepted, isDisabled: _isDisabled)
-            prevIsOptedIn = calculateIsOptedIn(accepted: _accepted, isDisabled: _isDisabled)
+            prevIsEnabled = calculateIsEnabled(address: address, reachable: _reachable, isDisabled: _isDisabled)
+            prevIsOptedIn = calculateIsOptedIn(reachable: _reachable, isDisabled: _isDisabled)
             prevSubscriptionState = OSPushSubscriptionState(id: oldValue, token: address, optedIn: prevIsOptedIn)
 
-        case .accepted(let oldValue):
-            prevIsEnabled = calculateIsEnabled(address: address, accepted: oldValue, isDisabled: _isDisabled)
-            prevIsOptedIn = calculateIsOptedIn(accepted: oldValue, isDisabled: _isDisabled)
+        case .reachable(let oldValue):
+            prevIsEnabled = calculateIsEnabled(address: address, reachable: oldValue, isDisabled: _isDisabled)
+            prevIsOptedIn = calculateIsOptedIn(reachable: oldValue, isDisabled: _isDisabled)
             prevSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: address, optedIn: prevIsOptedIn)
 
         case .isDisabled(let oldValue):
-            prevIsEnabled = calculateIsEnabled(address: address, accepted: _accepted, isDisabled: oldValue)
-            prevIsOptedIn = calculateIsOptedIn(accepted: _accepted, isDisabled: oldValue)
+            prevIsEnabled = calculateIsEnabled(address: address, reachable: _reachable, isDisabled: oldValue)
+            prevIsOptedIn = calculateIsOptedIn(reachable: _reachable, isDisabled: oldValue)
             prevSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: address, optedIn: prevIsOptedIn)
 
         case .address(let oldValue):
-            prevIsEnabled = calculateIsEnabled(address: oldValue, accepted: _accepted, isDisabled: _isDisabled)
-            prevIsOptedIn = calculateIsOptedIn(accepted: _accepted, isDisabled: _isDisabled)
+            prevIsEnabled = calculateIsEnabled(address: oldValue, reachable: _reachable, isDisabled: _isDisabled)
+            prevIsOptedIn = calculateIsOptedIn(reachable: _reachable, isDisabled: _isDisabled)
             prevSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: oldValue, optedIn: prevIsOptedIn)
         }
 
-        let newIsOptedIn = calculateIsOptedIn(accepted: _accepted, isDisabled: _isDisabled)
+        let newIsOptedIn = calculateIsOptedIn(reachable: _reachable, isDisabled: _isDisabled)
 
-        let newIsEnabled = calculateIsEnabled(address: address, accepted: _accepted, isDisabled: _isDisabled)
+        let newIsEnabled = calculateIsEnabled(address: address, reachable: _reachable, isDisabled: _isDisabled)
 
         if prevIsEnabled != newIsEnabled {
             self.set(property: "enabled", newValue: newIsEnabled)
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserRequests.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserRequests.swift
@@ -229,7 +229,7 @@ class OSUserExecutor {
                             type: type,
                             address: address,
                             subscriptionId: subModel["id"] as? String,
-                            accepted: true,
+                            reachable: true,
                             isDisabled: false,
                             changeNotifier: OSEventProducer()), hydrating: true
                         )
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift
@@ -128,7 +128,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
     private let _mockUser = OSUserInternalImpl(
         identityModel: OSIdentityModel(aliases: nil, changeNotifier: OSEventProducer()),
         propertiesModel: OSPropertiesModel(changeNotifier: OSEventProducer()),
-        pushSubscriptionModel: OSSubscriptionModel(type: .push, address: nil, subscriptionId: nil, accepted: false, isDisabled: true, changeNotifier: OSEventProducer()))
+        pushSubscriptionModel: OSSubscriptionModel(type: .push, address: nil, subscriptionId: nil, reachable: false, isDisabled: true, changeNotifier: OSEventProducer()))
 
     @objc public var requiresUserAuth = false
 
@@ -387,14 +387,14 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
 
     func createDefaultPushSubscription() -> OSSubscriptionModel {
         let sharedUserDefaults = OneSignalUserDefaults.initShared()
-        let accepted = OSNotificationsManager.currentPermissionState.accepted
+        let reachable = OSNotificationsManager.currentPermissionState.reachable
         let token = sharedUserDefaults.getSavedString(forKey: OSUD_PUSH_TOKEN, defaultValue: nil)
         let subscriptionId = sharedUserDefaults.getSavedString(forKey: OSUD_PUSH_SUBSCRIPTION_ID, defaultValue: nil)
 
         return OSSubscriptionModel(type: .push,
                                    address: token,
                                    subscriptionId: subscriptionId,
-                                   accepted: accepted,
+                                   reachable: reachable,
                                    isDisabled: false,
                                    changeNotifier: OSEventProducer())
     }
@@ -600,7 +600,7 @@ extension OneSignalUserManagerImpl: OSUser {
             type: .email,
             address: email,
             subscriptionId: nil,
-            accepted: true,
+            reachable: true,
             isDisabled: false,
             changeNotifier: OSEventProducer()
         )
@@ -632,7 +632,7 @@ extension OneSignalUserManagerImpl: OSUser {
             type: .sms,
             address: number,
             subscriptionId: nil,
-            accepted: true,
+            reachable: true,
             isDisabled: false,
             changeNotifier: OSEventProducer()
         )
@@ -739,10 +739,10 @@ extension OneSignalUserManagerImpl: OneSignalNotificationsDelegate {
         user.pushSubscriptionModel.address = pushToken
     }
 
-    public func setAccepted(_ inAccepted: Bool) {
+    public func setReachable(_ inReachable: Bool) {
         guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: nil) else {
             return
         }
-        user.pushSubscriptionModel._accepted = inAccepted
+        user.pushSubscriptionModel._reachable = inReachable
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -210,8 +210,8 @@ + (void)fireChangesObserver:(OSPermissionStateInternal*)state {`
`210`	`210`	`}`
`211`	`211`	`// Update the push subscription's _accepted property`
`212`	`212`	`// TODO: This can be called before the User Manager has set itself as the delegate`
`213`		`- if (OSNotificationsManager.delegate && [OSNotificationsManager.delegate respondsToSelector:@selector(setAccepted:)]) {`
`214`		`- [OSNotificationsManager.delegate setAccepted:state.reachable];`
	`213`	`+ if (OSNotificationsManager.delegate && [OSNotificationsManager.delegate respondsToSelector:@selector(setReachable:)]) {`
	`214`	`+ [OSNotificationsManager.delegate setReachable:state.reachable];`
`215`	`215`	`}`
`216`	`216`	`}`
`217`	`217`
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ class OSUserExecutor {`
`229`	`229`	`type: type,`
`230`	`230`	`address: address,`
`231`	`231`	`subscriptionId: subModel["id"] as? String,`
`232`		`- accepted: true,`
	`232`	`+ reachable: true,`
`233`	`233`	`isDisabled: false,`
`234`	`234`	`changeNotifier: OSEventProducer()), hydrating: true`
`235`	`235`	`)`