push sub optIn and optOut

nan-li · nan-li · commit 988f113b0a70 · 2022-12-16T16:00:43.000-08:00
* Add optedIn property, and funcs optIn() and optOut()
* We still keep internal properties like isDisabled and calculate enabled for sending to backend, and for the observer.
* OSPushSubscriptionState given to observers will still have: id, token, enabled
* Also use `pushSubscriptionId` instead of going through the protocol `pushSubscription.subscriptionId`
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionModel.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionModel.swift
@@ -38,21 +38,22 @@ import OneSignalNotifications
 
 @objc
 public class OSPushSubscriptionState: NSObject {
-    @objc public let subscriptionId: String?
+    // TODO: Decide if optedIn will be observed
+    @objc public let id: String?
     @objc public let token: String?
     @objc public let enabled: Bool
 
-    init(subscriptionId: String?, token: String?, enabled: Bool) {
-        self.subscriptionId = subscriptionId
+    init(id: String?, token: String?, enabled: Bool) {
+        self.id = id
         self.token = token
         self.enabled = enabled
     }
 
     func toDictionary() -> NSDictionary {
-        let subscriptionId = self.subscriptionId ?? ""
-        let token = self.token ?? ""
+        let id = self.id ?? "nil"
+        let token = self.token ?? "nil"
         return [
-            "subscriptionId": subscriptionId,
+            "id": id,
             "token": token,
             "enabled": enabled
         ]
@@ -132,7 +133,14 @@ class OSSubscriptionModel: OSModel {
             return calculateIsSubscribed(subscriptionId: subscriptionId, address: address, accepted: _accepted, isDisabled: _isDisabled)
         }
     }
-
+    
+    var optedIn: Bool {
+        // optedIn = permission + userPreference
+        get {
+            return _accepted && !_isDisabled
+        }
+    }
+    
     // Push Subscription Only
     // Initialize to be -1, so not to deal with unwrapping every time
     var notificationTypes = -1 {
@@ -162,7 +170,7 @@ class OSSubscriptionModel: OSModel {
         }
     }
 
-    // Set by the app developer when they set User.pushSubscription.enabled
+    // Set by the app developer when they call User.pushSubscription.optOut()
     var _isDisabled: Bool { // Default to false for all subscriptions
         didSet {
             guard self.type == .push && _isDisabled != oldValue else {
@@ -246,7 +254,7 @@ class OSSubscriptionModel: OSModel {
 extension OSSubscriptionModel {
     // Only used for the push subscription model
     var currentPushSubscriptionState: OSPushSubscriptionState {
-        return OSPushSubscriptionState(subscriptionId: self.subscriptionId,
+        return OSPushSubscriptionState(id: self.subscriptionId,
                                        token: self.address,
                                        enabled: self.enabled
         )
@@ -277,28 +285,28 @@ extension OSSubscriptionModel {
     func firePushSubscriptionChanged(_ changedProperty: OSPushPropertyChanged) {
         var prevIsSubscribed = true
         var prevIsEnabled = true
-        var prevSubscriptionState = OSPushSubscriptionState(subscriptionId: "", token: "", enabled: true)
+        var prevSubscriptionState = OSPushSubscriptionState(id: "", token: "", enabled: true)
 
         switch changedProperty {
         case .subscriptionId(let oldValue):
             prevIsEnabled = calculateIsEnabled(address: address, accepted: _accepted, isDisabled: _isDisabled)
             prevIsSubscribed = calculateIsSubscribed(subscriptionId: oldValue, address: address, accepted: _accepted, isDisabled: _isDisabled)
-            prevSubscriptionState = OSPushSubscriptionState(subscriptionId: oldValue, token: address, enabled: prevIsSubscribed)
+            prevSubscriptionState = OSPushSubscriptionState(id: oldValue, token: address, enabled: prevIsSubscribed)
 
         case .accepted(let oldValue):
             prevIsEnabled = calculateIsEnabled(address: address, accepted: oldValue, isDisabled: _isDisabled)
             prevIsSubscribed = calculateIsSubscribed(subscriptionId: subscriptionId, address: address, accepted: oldValue, isDisabled: _isDisabled)
-            prevSubscriptionState = OSPushSubscriptionState(subscriptionId: subscriptionId, token: address, enabled: prevIsSubscribed)
+            prevSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: address, enabled: prevIsSubscribed)
 
         case .isDisabled(let oldValue):
             prevIsEnabled = calculateIsEnabled(address: address, accepted: _accepted, isDisabled: oldValue)
             prevIsSubscribed = calculateIsSubscribed(subscriptionId: subscriptionId, address: address, accepted: _accepted, isDisabled: oldValue)
-            prevSubscriptionState = OSPushSubscriptionState(subscriptionId: subscriptionId, token: address, enabled: prevIsSubscribed)
+            prevSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: address, enabled: prevIsSubscribed)
 
         case .address(let oldValue):
             prevIsEnabled = calculateIsEnabled(address: oldValue, accepted: _accepted, isDisabled: _isDisabled)
             prevIsSubscribed = calculateIsSubscribed(subscriptionId: subscriptionId, address: oldValue, accepted: _accepted, isDisabled: _isDisabled)
-            prevSubscriptionState = OSPushSubscriptionState(subscriptionId: subscriptionId, token: oldValue, enabled: prevIsSubscribed)
+            prevSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: oldValue, enabled: prevIsSubscribed)
         }
 
         let newIsSubscribed = calculateIsSubscribed(subscriptionId: subscriptionId, address: address, accepted: _accepted, isDisabled: _isDisabled)
@@ -309,7 +317,7 @@ extension OSSubscriptionModel {
             self.set(property: "enabled", newValue: newIsEnabled)
         }
 
-        let newSubscriptionState = OSPushSubscriptionState(subscriptionId: subscriptionId, token: address, enabled: newIsSubscribed)
+        let newSubscriptionState = OSPushSubscriptionState(id: subscriptionId, token: address, enabled: newIsSubscribed)
 
         let stateChanges = OSPushSubscriptionStateChanges(to: newSubscriptionState, from: prevSubscriptionState)
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift
@@ -79,10 +79,12 @@ import OneSignalNotifications
  This is the push subscription interface exposed to the public.
  */
 @objc public protocol OSPushSubscription {
-    var subscriptionId: String? { get }
+    var id: String? { get }
     var token: String? { get }
-    var enabled: Bool { get }
-    func enable(_ enable: Bool) -> Bool
+    var optedIn: Bool { get }
+
+    func optIn()
+    func optOut()
     func addObserver(_ observer: OSPushSubscriptionObserver) -> OSPushSubscriptionState?
     func removeObserver(_ observer: OSPushSubscriptionObserver)
 }
@@ -617,7 +619,7 @@ extension OneSignalUserManagerImpl: OSUser {
 extension OneSignalUserManagerImpl: OSPushSubscription {
 
     public func addObserver(_ observer: OSPushSubscriptionObserver) -> OSPushSubscriptionState? {
-        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "addObserver") else {
+        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.addObserver") else {
             return nil
         }
         self.pushSubscriptionStateChangesObserver.addObserver(observer)
@@ -628,43 +630,43 @@ extension OneSignalUserManagerImpl: OSPushSubscription {
         self.pushSubscriptionStateChangesObserver.removeObserver(observer)
     }
 
-    public var subscriptionId: String? {
-        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "subscriptionId") else {
+    public var id: String? {
+        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.id") else {
             return nil
         }
         return user.pushSubscriptionModel.subscriptionId
     }
 
     public var token: String? {
-        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "token") else {
+        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.token") else {
             return nil
         }
         return user.pushSubscriptionModel.address
     }
-
-    /**
-     Get the `enabled` state.
-     */
-    public var enabled: Bool {
-        get {
-            guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "enabled") else {
-                return false
-            }
-            return user.pushSubscriptionModel.enabled
+    
+    public var optedIn: Bool {
+        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.optedIn") else {
+            return false
         }
+        return user.pushSubscriptionModel.optedIn
     }
 
     /**
-     Set the `enabled` state. After being set, we return whether this was successful, as one can attempt to set `enabled` to `true` but push is not actually enabled on the device. This can be due to system level permissions or missing push token, etc.
-     
-     - Returns: A boolean indicating if this method was successful.
+     Enable the push subscription, and prompts if needed. `optedIn` can still be `false` after `optIn()` is called if permission is not granted.
      */
-    public func enable(_ enable: Bool) -> Bool {
-        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "enable") else {
-            return false
+    public func optIn() {
+        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.optIn") else {
+            return
+        }
+        user.pushSubscriptionModel._isDisabled = false
+        OSNotificationsManager.requestPermission(nil, fallbackToSettings: true)
+    }
+    
+    public func optOut() {
+        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.optOut") else {
+            return
         }
-        user.pushSubscriptionModel._isDisabled = !enable
-        return user.pushSubscriptionModel.enabled != enable
+        user.pushSubscriptionModel._isDisabled = true
     }
 }
 
diff --git a/iOS_SDK/OneSignalSDK/Source/OSMessagingController.m b/iOS_SDK/OneSignalSDK/Source/OSMessagingController.m
@@ -427,7 +427,7 @@ - (void)messageViewPageImpressionRequest:(OSInAppMessageInternal *)message withP
     [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Page Impression Request page id: %@",pageId]];
     // Create the request and attach a payload to it
     let metricsRequest = [OSRequestInAppMessagePageViewed withAppId:OneSignal.appId
-                                                       withPlayerId:OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId
+                                                       withPlayerId:OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId
                                                       withMessageId:message.messageId
                                                          withPageId:pageId
                                                        forVariantId:message.variantId];
@@ -467,7 +467,7 @@ - (void)messageViewImpressionRequest:(OSInAppMessageInternal *)message {
     
     // Create the request and attach a payload to it
     let metricsRequest = [OSRequestInAppMessageViewed withAppId:OneSignal.appId
-                                                   withPlayerId:OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId
+                                                   withPlayerId:OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId
                                                   withMessageId:message.messageId
                                                    forVariantId:message.variantId];
     
@@ -572,7 +572,7 @@ - (BOOL)shouldShowInAppMessage:(OSInAppMessageInternal *)message {
     return ![self.seenInAppMessages containsObject:message.messageId] &&
            [self.triggerController messageMatchesTriggers:message] &&
            ![message isFinished] &&
-           OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId != nil;
+           OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId != nil;
     return true;
 }
 
@@ -853,7 +853,7 @@ - (void)sendClickRESTCall:(OSInAppMessageInternal *)message withAction:(OSInAppM
     [message addClickId:clickId];
     
     let metricsRequest = [OSRequestInAppMessageClicked withAppId:OneSignal.appId
-                                                    withPlayerId:OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId
+                                                    withPlayerId:OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId
                                                    withMessageId:message.messageId
                                                     forVariantId:message.variantId
                                                       withAction:action];
@@ -968,15 +968,15 @@ - (void)onApplicationDidBecomeActive {
 
 #pragma mark OSPushSubscriptionObserver Methods
 - (void)onOSPushSubscriptionChangedWithStateChanges:(OSPushSubscriptionStateChanges * _Nonnull)stateChanges {
-    if (stateChanges.to.subscriptionId == nil) {
+    if (stateChanges.to.id == nil) {
         [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"onOSPushSubscriptionChangedWithStateChanges: changed to nil subscription id"];
         return;
     }
     // Pull new IAMs when the subscription id changes to a new valid subscription id
-    if (stateChanges.from.subscriptionId != nil &&
-        [stateChanges.to.subscriptionId isEqualToString:stateChanges.from.subscriptionId]) {
+    if (stateChanges.from.id != nil &&
+        [stateChanges.to.id isEqualToString:stateChanges.from.id]) {
         [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"onOSPushSubscriptionChangedWithStateChanges: changed to new valid subscription id"];
-        [self getInAppMessagesFromServer:stateChanges.to.subscriptionId];
+        [self getInAppMessagesFromServer:stateChanges.to.id];
     }
 }
 
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignal.m b/iOS_SDK/OneSignalSDK/Source/OneSignal.m
@@ -428,7 +428,7 @@ + (void)startNewSessionInternal {
     
     // This is almost always going to be nil the first time.
     // The OSMessagingController is an OSPushSubscriptionObserver so that we pull IAMs once we have the sub id
-    NSString *subscriptionId = OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId;
+    NSString *subscriptionId = OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId;
     if (subscriptionId) {
         [OSMessagingController.sharedInstance getInAppMessagesFromServer:subscriptionId];
     }
@@ -647,7 +647,7 @@ + (void)downloadIOSParamsWithAppId:(NSString *)appId {
     [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"Downloading iOS parameters for this application"];
     _didCallDownloadParameters = true;
     // This will be nil unless we have a cached user
-    NSString *userId = OneSignalUserManagerImpl.sharedInstance.User.pushSubscription.subscriptionId;
+    NSString *userId = OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId;
     [OneSignalClient.sharedClient executeRequest:[OSRequestGetIosParams withUserId:userId appId:appId] onSuccess:^(NSDictionary *result) {
 
         if (result[IOS_REQUIRES_USER_ID_AUTHENTICATION]) {
@@ -755,7 +755,7 @@ + (BOOL)sendSessionEndOutcomes:(NSNumber*)totalTimeActive params:(OSFocusCallPar
     }
     
     NSString* onesignalId = OneSignalUserManagerImpl.sharedInstance.onesignalId;
-    NSString* pushSubscriptionId = OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId;
+    NSString* pushSubscriptionId = OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId;
     
     if (!onesignalId || !pushSubscriptionId) {
         return false;
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignalLocation.m b/iOS_SDK/OneSignalSDK/Source/OneSignalLocation.m
@@ -428,7 +428,7 @@ + (void)sendLocation {
         return;
     
     @synchronized(OneSignalLocation.mutexObjectForLastLocation) {
-        NSString *userId = OneSignalUserManagerImpl.sharedInstance.pushSubscription.subscriptionId;
+        NSString *userId = OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId;
         if (!lastLocation || !userId)
             return;
         
