Merge pull request #1224 from OneSignal/5.0.0/beta_01_fixes

[5.0.0] Some more `beta-01` fixes to incorporate

Author: nan-li

MIGRATION_GUIDE.md

@@ -1,4 +1,4 @@
-<h1 align="center">OneSignal iOS SDK v5.0.0-alpha-02 Migration Guide</h1>
+<h1 align="center">OneSignal iOS SDK v5.0.0-beta-01 Migration Guide</h1>
 
 ![OneSignal Omni Channel Banner](https://user-images.githubusercontent.com/11739227/208625336-d28c8d01-a7cf-4f8e-9643-ac8d1948e9ae.png)
 
@@ -8,7 +8,7 @@ In this release, we are making a significant shift from a device-centered model
 
 To facilitate this change, the `externalId` approach for identifying users is being replaced by the `login` and `logout` methods. In addition, the SDK now makes use of namespaces such as `User`, `Notifications`, and `InAppMessages` to better separate code.
 
-The iOS SDK is making the jump from `v3` to `v5`, in order to align across OneSignal’s suite of client SDKs. This guide will walk you through the iOS SDK `5.0.0-alpha-02` changes as a result of this shift.
+The iOS SDK is making the jump from `v3` to `v5`, in order to align across OneSignal’s suite of client SDKs. This guide will walk you through the iOS SDK `5.0.0-beta-01` changes as a result of this shift.
 
 # Overview
 
@@ -60,10 +60,10 @@ As mentioned above, the iOS SDK is making the jump from `v3` to `v5`, in order t
 ```
 
 ### Option 1. Swift Package Manager
-Update the version of the OneSignal-XCFramework your application uses to `5.0.0-alpha-02`. In addition, the Package Product name has been changed from `OneSignal` to `OneSignalFramework`. See [the existing installation instructions](https://documentation.onesignal.com/docs/swift-package-manager-setup).
+Update the version of the OneSignal-XCFramework your application uses to `5.0.0-beta-01`. In addition, the Package Product name has been changed from `OneSignal` to `OneSignalFramework`. See [the existing installation instructions](https://documentation.onesignal.com/docs/swift-package-manager-setup).
 
 ### Option 2. CocoaPods
-Update the version of the OneSignalXCFramework your application uses to `5.0.0-alpha-02`. Other than updating the import statement above, there are no additional changes needed to import the OneSignal SDK in your Xcode project. See [the existing installation instructions](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-import-the-onesignal-sdk-into-your-xcode-project).
+Update the version of the OneSignalXCFramework your application uses to `5.0.0-beta-01`. Other than updating the import statement above, there are no additional changes needed to import the OneSignal SDK in your Xcode project. See [the existing installation instructions](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-import-the-onesignal-sdk-into-your-xcode-project).
 
 # API Changes
 ## Namespaces
@@ -213,7 +213,7 @@ Email and/or SMS subscriptions can be added or removed via the following methods
 
 # API Reference
 
-Below is a comprehensive reference to the `5.0.0-alpha-02` OneSignal SDK.
+Below is a comprehensive reference to the `5.0.0-beta-01` OneSignal SDK.
 
 ## OneSignal
 
@@ -727,14 +727,12 @@ The Debug namespace is accessible via `OneSignal.Debug` and provide access to de
 
 # Limitations
 
-- Recommend using only in development and staging environments for Alpha releases
-- Aliases will be available in a future release
+- Recommend using only in development and staging environments for Beta releases
 - Outcomes will be available in a future release
-- Users are deleted when the last Subscription (push, email, or sms) is removed
 - Any `User` namespace calls must be invoked **after** initialization. Example: `OneSignal.User.addTag("tag", "2")`
 
 # Known issues
 - User properties may not update correctly when Subscriptions are transferred
     - Please report any issues you find with this
 - Identity Verification 
-    - We will be introducing JWT in a follow up Alpha or Beta release
+    - We will be introducing JWT in a follow up Beta release

iOS_SDK/OneSignalSDK/OneSignalCore/Source/RemoteParameters/OSRemoteParamController.m

@@ -35,6 +35,8 @@ @implementation OSRemoteParamController
 
 static OSRemoteParamController *_sharedController;
 + (OSRemoteParamController *)sharedController {
+    if (!_sharedController)
+        _sharedController = [OSRemoteParamController new];
     return _sharedController;
 }
 

iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m

@@ -337,6 +337,8 @@ + (void)presentAppSettings {
 }
 
 + (void)clearAll {
+    [[UNUserNotificationCenter currentNotificationCenter] removeAllDeliveredNotifications];
+    // TODO: Determine if we also need to call clearBadgeCount
     [self clearBadgeCount:false];
 }
 
@@ -369,9 +371,6 @@ + (BOOL)registerForAPNsToken {
 
 + (void)didRegisterForRemoteNotifications:(UIApplication *)app
                               deviceToken:(NSData *)inDeviceToken {
-    if ([OSPrivacyConsentController shouldLogMissingPrivacyConsentErrorWithMethodName:nil])
-        return;
-
     let parsedDeviceToken = [NSString hexStringFromData:inDeviceToken];
 
     [OneSignalLog onesignalLog:ONE_S_LL_INFO message: [NSString stringWithFormat:@"Device Registered with Apple: %@", parsedDeviceToken]];

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSIdentityModel.swift

@@ -82,12 +82,10 @@ class OSIdentityModel: OSModel {
     }
 
     func removeAliases(_ labels: [String]) {
-        var aliasesToSend: [String: String] = [:]
         for label in labels {
             self.aliases.removeValue(forKey: label)
-            aliasesToSend[label] = ""
+            self.set(property: "aliases", newValue: [label: ""])
         }
-        self.set(property: "aliases", newValue: aliasesToSend)
     }
 
     public override func hydrateModel(_ response: [String: Any]) {

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSPropertiesModel.swift

@@ -45,22 +45,37 @@ struct OSPropertiesDeltas {
     }
 }
 
+// Both lat and long must exist to be accepted by the server
+class OSLocationPoint: NSObject, NSCoding {
+    let lat: Float
+    let long: Float
+
+    init(lat: Float, long: Float) {
+        self.lat = lat
+        self.long = long
+    }
+
+    public func encode(with coder: NSCoder) {
+        coder.encode(lat, forKey: "lat")
+        coder.encode(long, forKey: "long")
+    }
+
+    public required init?(coder: NSCoder) {
+        self.lat = coder.decodeFloat(forKey: "lat")
+        self.long = coder.decodeFloat(forKey: "long")
+    }
+}
+
 class OSPropertiesModel: OSModel {
     var language: String? {
         didSet {
             self.set(property: "language", newValue: language)
         }
     }
 
-    var lat: Float? {
-        didSet {
-            self.set(property: "lat", newValue: lat)
-        }
-    }
-
-    var long: Float? {
+    var location: OSLocationPoint? {
         didSet {
-            self.set(property: "long", newValue: long)
+            self.set(property: "location", newValue: location)
         }
     }
 

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionOperationExecutor.swift

@@ -59,7 +59,7 @@ class OSSubscriptionOperationExecutor: OSOperationExecutor {
 
         var requestQueue: [OSRequestCreateSubscription] = []
 
-        if var cachedAddRequestQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY, defaultValue: []) as? [OSRequestCreateSubscription] {
+        if let cachedAddRequestQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY, defaultValue: []) as? [OSRequestCreateSubscription] {
             // Hook each uncached Request to the model in the store
             for request in cachedAddRequestQueue {
                 // 1. Hook up the subscription model

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserInternalImpl.swift

@@ -125,8 +125,7 @@ class OSUserInternalImpl: NSObject, OSUserInternal {
     func setLocation(lat: Float, long: Float) {
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.User setLocation called with lat: \(lat) long: \(long)")
 
-        propertiesModel.lat = lat
-        propertiesModel.long = long
+        propertiesModel.location = OSLocationPoint(lat: lat, long: long)
     }
 
     // MARK: - Language

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserRequests.swift

@@ -900,8 +900,14 @@ class OSRequestUpdateProperties: OneSignalRequest, OSUserRequest {
         self.stringDescription = "OSRequestUpdateProperties with properties: \(properties) deltas: \(String(describing: deltas)) refreshDeviceMetadata: \(String(describing: refreshDeviceMetadata))"
         super.init()
 
+        var propertiesObject = properties
+        if let location = propertiesObject["location"] as? OSLocationPoint {
+            propertiesObject["lat"] = location.lat
+            propertiesObject["long"] = location.long
+            propertiesObject.removeValue(forKey: "location")
+        }
         var params: [String: Any] = [:]
-        params["properties"] = properties
+        params["properties"] = propertiesObject
         params["refresh_device_metadata"] = refreshDeviceMetadata
         if let deltas = deltas {
             params["deltas"] = deltas

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift

@@ -322,10 +322,14 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
     }
 
     /**
-     The SDK needs to have a user at all times, so this method will create a new anonymous user.
+     The SDK needs to have a user at all times, so this method will create a new anonymous user. If the current user is already anonymous, calling `logout` results in a no-op.
      */
     @objc
     public func logout() {
+        guard user.identityModel.externalId != nil else {
+            OneSignalLog.onesignalLog(.LL_DEBUG, message: "OneSignal.User logout called, but the user is currently anonymous, so not logging out.")
+            return
+        }
         prepareForNewUser()
         _user = nil
         createUserIfNil()
@@ -670,9 +674,7 @@ extension OneSignalUserManagerImpl: OSUser {
 extension OneSignalUserManagerImpl: OSPushSubscription {
 
     public func addObserver(_ observer: OSPushSubscriptionObserver) {
-        guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: "pushSubscription.addObserver") else {
-            return
-        }
+        // This is a method in the User namespace that doesn't require privacy consent first
         self.pushSubscriptionStateChangesObserver.addObserver(observer)
     }
 

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -519,7 +519,7 @@ + (void)startUserManager {
 }
 
 + (void)delayInitializationForPrivacyConsent {
-    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Delayed initialization of the OneSignal SDK until the user provides privacy consent using the consentGranted() method"];
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Delayed initialization of the OneSignal SDK until the user provides privacy consent using the setPrivacyConsent() method"];
     delayedInitializationForPrivacyConsent = true;
     _delayedInitParameters = [[DelayedConsentInitializationParameters alloc] initWithLaunchOptions:launchOptions withAppId:appId];
     // Init was not successful, set appId back to nil