Added setLocationShared check into LocationServices callback (#539)

* Added setLocationShared check into LocationServices callback
* Now when a user allows LocationServices, we will not store a 'last_location' since our player update checks this variable along with mShareLocation to decide whether or not to push the location of the player
* Added a unit test to test the mocked scenario of granting permission while mShareLocation is true and false

* Enhanced OneSignalLocationOverrider
* Better end to end mocking of showing a LocationServices alert and clicking allow
* Then based on the setLocationShared setting, decide on whether or not to update the `lastLocation` to update a player record

* Misunderstood when locationManager:didUpdateLocations: was called
* Added different functionality for overriding the location services prompts
* Added flags so when prompts are shown we can then mock a `Allow`
* 3 checks now made for calling the override for locationManager:didUpdateLocations:
  * We check iOS version, and the two BOOL flags related to info.plist params

* Update OneSignalLocationOverrider.m

* Moved some test setup in UnitTests.m to fix broken tests

Author: mikechoch

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -149,6 +149,8 @@
 		9D3300F723145AF3000F0A83 /* OneSignalUserDefaults.m in Sources */ = {isa = PBXBuildFile; fileRef = 9D3300F323145AF3000F0A83 /* OneSignalUserDefaults.m */; };
 		9D3300F823145AF3000F0A83 /* OneSignalUserDefaults.m in Sources */ = {isa = PBXBuildFile; fileRef = 9D3300F323145AF3000F0A83 /* OneSignalUserDefaults.m */; };
 		9D3300FA23149DAE000F0A83 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9D3300F923149DAE000F0A83 /* CoreGraphics.framework */; };
+		9D348537233C669E00EB81C9 /* CoreLocation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9D348536233C669E00EB81C9 /* CoreLocation.framework */; };
+		9D34853A233D2E3600EB81C9 /* OneSignalLocationOverrider.m in Sources */ = {isa = PBXBuildFile; fileRef = 9D348539233D2E3600EB81C9 /* OneSignalLocationOverrider.m */; };
 		9D59C2F82321C7720008ECCF /* WebKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = CACBAAAB218A662B000ACAA5 /* WebKit.framework */; };
 		9D59C2F92321C7780008ECCF /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9D3300F923149DAE000F0A83 /* CoreGraphics.framework */; };
 		9DDFEEF223189C0800EAE0BB /* OneSignalViewHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = 9D3300F423145AF3000F0A83 /* OneSignalViewHelper.h */; };
@@ -373,6 +375,9 @@
 		9D3300F323145AF3000F0A83 /* OneSignalUserDefaults.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OneSignalUserDefaults.m; sourceTree = "<group>"; };
 		9D3300F423145AF3000F0A83 /* OneSignalViewHelper.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OneSignalViewHelper.h; sourceTree = "<group>"; };
 		9D3300F923149DAE000F0A83 /* CoreGraphics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreGraphics.framework; path = System/Library/Frameworks/CoreGraphics.framework; sourceTree = SDKROOT; };
+		9D348536233C669E00EB81C9 /* CoreLocation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreLocation.framework; path = System/Library/Frameworks/CoreLocation.framework; sourceTree = SDKROOT; };
+		9D348538233D2DCF00EB81C9 /* OneSignalLocationOverrider.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalLocationOverrider.h; sourceTree = "<group>"; };
+		9D348539233D2E3600EB81C9 /* OneSignalLocationOverrider.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalLocationOverrider.m; sourceTree = "<group>"; };
 		CA08FC711FE99AFD004C445F /* OneSignalClient.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalClient.h; sourceTree = "<group>"; };
 		CA08FC721FE99AFD004C445F /* OneSignalClient.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalClient.m; sourceTree = "<group>"; };
 		CA08FC761FE99B13004C445F /* OneSignalRequest.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalRequest.h; sourceTree = "<group>"; };
@@ -471,6 +476,7 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				9D348537233C669E00EB81C9 /* CoreLocation.framework in Frameworks */,
 				9D3300FA23149DAE000F0A83 /* CoreGraphics.framework in Frameworks */,
 				CACBAAAC218A662B000ACAA5 /* WebKit.framework in Frameworks */,
 				911E2CC81E399834003112A4 /* UserNotifications.framework in Frameworks */,
@@ -507,6 +513,7 @@
 		37747F9519147D6500558FAD /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
+				9D348536233C669E00EB81C9 /* CoreLocation.framework */,
 				9D3300F923149DAE000F0A83 /* CoreGraphics.framework */,
 				CACBAAAB218A662B000ACAA5 /* WebKit.framework */,
 				911E2CC71E399834003112A4 /* UserNotifications.framework */,
@@ -562,6 +569,8 @@
 				CA8E190A2194FE0B009DA223 /* OSMessagingControllerOverrider.m */,
 				CAAE0DFB2195216900A57402 /* OneSignalOverrider.h */,
 				CAAE0DFC2195216900A57402 /* OneSignalOverrider.m */,
+				9D348538233D2DCF00EB81C9 /* OneSignalLocationOverrider.h */,
+				9D348539233D2E3600EB81C9 /* OneSignalLocationOverrider.m */,
 			);
 			path = Shadows;
 			sourceTree = "<group>";
@@ -1113,6 +1122,7 @@
 				912412201E73342200E41FD7 /* OneSignalJailbreakDetection.m in Sources */,
 				CAAEA68921ED68A40049CF15 /* OneSignalNotificationCategoryController.m in Sources */,
 				CA85C15320604AEA003AB529 /* RequestTests.m in Sources */,
+				9D34853A233D2E3600EB81C9 /* OneSignalLocationOverrider.m in Sources */,
 				CAE2E5A8215D80010036FD32 /* OneSignalTrackFirebaseAnalytics.m in Sources */,
 				912412381E73342200E41FD7 /* OneSignalTrackIAP.m in Sources */,
 				CA63AF8720211FF800E340FB /* UnitTestCommonMethods.m in Sources */,

iOS_SDK/OneSignalSDK/Source/OneSignal.h

@@ -442,6 +442,7 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 // - Request and track user's location
 + (void)promptLocation;
 + (void)setLocationShared:(BOOL)enable;
++ (BOOL)isLocationShared;
 
 
 // Only used for wrapping SDKs, such as Unity, Cordova, Xamarin, etc.

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -1302,6 +1302,10 @@ + (void) promptLocation {
     [OneSignalLocation getLocation:true];
 }
 
++ (BOOL)isLocationShared {
+    return mShareLocation;
+}
+
 
 + (void) handleDidFailRegisterForRemoteNotification:(NSError*)err {
     waitingForApnsResponse = false;

iOS_SDK/OneSignalSDK/Source/OneSignalLocation.h

@@ -41,8 +41,12 @@ typedef struct os_last_location {
     double horizontalAccuracy;
 } os_last_location;
 
-
 @interface OneSignalLocation : NSObject
+
++ (OneSignalLocation*) sharedInstance;
++ (bool)started;
++ (void)internalGetLocation:(bool)prompt;
+- (void)locationManager:(id)manager didUpdateLocations:(NSArray *)locations;
 + (void) getLocation:(bool)prompt;
 + (void) sendLocation;
 + (os_last_location*)lastLocation;

iOS_SDK/OneSignalSDK/Source/OneSignalLocation.m

@@ -86,6 +86,11 @@ +(OneSignalLocation*) sharedInstance {
 + (os_last_location*)lastLocation {
     return lastLocation;
 }
+
++ (bool)started {
+    return started;
+}
+
 + (void)clearLastLocation {
     @synchronized(OneSignalLocation.mutexObjectForLastLocation) {
        lastLocation = nil;
@@ -113,7 +118,7 @@ + (void)onfocus:(BOOL)isActive {
     if ([OneSignal requiresUserPrivacyConsent])
         return;
 
-    if(!locationManager || !started) return;
+    if(!locationManager || ![self started]) return;
 
     /**
      We have a state switch
@@ -162,8 +167,8 @@ + (void) endTask {
 
 
 
-+ (void) internalGetLocation:(bool)prompt {
-    if (started)
++ (void)internalGetLocation:(bool)prompt {
+    if ([self started])
         return;
 
     id clLocationManagerClass = NSClassFromString(@"CLLocationManager");
@@ -179,43 +184,42 @@ + (void) internalGetLocation:(bool)prompt {
     locationManager = [[clLocationManagerClass alloc] init];
     [locationManager setValue:[self sharedInstance] forKey:@"delegate"];
 
-    float deviceOSVersion = [[[UIDevice currentDevice] systemVersion] floatValue];
-    if (deviceOSVersion >= 8.0) {
+    if ([OneSignalHelper isIOSVersionGreaterThanOrEqual:@"8.0"]) {
 
         //Check info plist for request descriptions
         //LocationAlways > LocationWhenInUse > No entry (Log error)
         //Location Always requires: Location Background Mode + NSLocationAlwaysUsageDescription
         NSArray* backgroundModes = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"UIBackgroundModes"];
         NSString* alwaysDescription = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationAlwaysUsageDescription"] ?: [[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationAlwaysAndWhenInUseUsageDescription"];
         // use background location updates if always permission granted or prompt allowed
-        if(backgroundModes && [backgroundModes containsObject:@"location"] && alwaysDescription && (permissionStatus == 3 || prompt)) {
+        if (backgroundModes && [backgroundModes containsObject:@"location"] && alwaysDescription && (permissionStatus == 3 || prompt)) {
             [locationManager performSelector:@selector(requestAlwaysAuthorization)];
-            if (deviceOSVersion >= 9.0) {
+            if ([OneSignalHelper isIOSVersionGreaterThanOrEqual:@"9.0"]) {
                 [locationManager setValue:@YES forKey:@"allowsBackgroundLocationUpdates"];
             }
         }
 
-        else if([[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationWhenInUseUsageDescription"]) {
+        else if ([[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationWhenInUseUsageDescription"]) {
             if (permissionStatus == 0) [locationManager performSelector:@selector(requestWhenInUseAuthorization)];
         }
 
         else onesignal_Log(ONE_S_LL_ERROR, @"Include a privacy NSLocationAlwaysUsageDescription or NSLocationWhenInUseUsageDescription in your info.plist to request location permissions.");
     }
-    
-    // iOS 6 and 7 prompts for location here.
+        
+    // For iOS 6 and 7, location services are prompted here
+    // This method is also used for getting the location manager to obtain an initial location fix
+    // and will notify your delegate by calling its locationManager:didUpdateLocations: method
     [locationManager performSelector:@selector(startUpdatingLocation)];
 
-    
-    
     started = true;
 }
 
 #pragma mark CLLocationManagerDelegate
 
 - (void)locationManager:(id)manager didUpdateLocations:(NSArray *)locations {
 
-    // return if the user has not granted privacy permissions
-    if ([OneSignal requiresUserPrivacyConsent])
+    // return if the user has not granted privacy permissions or location shared is false
+    if ([OneSignal requiresUserPrivacyConsent] || ![OneSignal isLocationShared])
         return;
 
     [manager performSelector:@selector(stopUpdatingLocation)];

iOS_SDK/OneSignalSDK/UnitTests/Shadows/OneSignalLocationOverrider.h

@@ -0,0 +1,42 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2019 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef OneSignalLocationOverrider_h
+#define OneSignalLocationOverrider_h
+
+@interface OneSignalLocationOverrider : NSObject
+
++ (bool)overrideStarted;
++ (void)grantLocationServices;
++ (int)overrideAuthorizationStatus;
+- (void)overrideRequestAlwaysAuthorization;
+- (void)overrideRequestWhenInUseAuthorization;
+- (void)overrideStartUpdatingLocation;
+
+@end
+
+#endif /* OneSignalLocationOverrider_h */

iOS_SDK/OneSignalSDK/UnitTests/Shadows/OneSignalLocationOverrider.m

@@ -0,0 +1,126 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2019 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#import <Foundation/Foundation.h>
+#import <CoreLocation/CoreLocation.h>
+
+#import "TestHelperFunctions.h"
+#import "OneSignalSelectorHelpers.h"
+#import "OneSignalHelperOverrider.h"
+#import "OneSignalLocation.h"
+#import "OneSignalLocationOverrider.h"
+
+@implementation OneSignalLocationOverrider
+
+// BOOL to track whetehr the LocationServices prompt has been seen
+bool startedMock;
+// int representing the current permission status for LocationServices
+int permissionStatusMock;
+// BOOL to track whether or not location request was made (NSLocationAlwaysUsageDescription, NSLocationAlwaysAndWhenInUseUsageDescription)
+bool calledRequestAlwaysAuthorization;
+// BOOL to track whether or not location request was made (NSLocationWhenInUseUsageDescription)
+bool calledRequestWhenInUseAuthorization;
+
+// Location updates require a mocked manager and set of locations to be passed in
+CLLocationManager* locationManager;
+NSArray *locations;
+
++ (void)load {
+    
+    injectStaticSelector([OneSignalLocationOverrider class], @selector(overrideStarted), [OneSignalLocation class], @selector(started));
+    injectStaticSelector([OneSignalLocationOverrider class], @selector(overrideAuthorizationStatus), [CLLocationManager class], @selector(authorizationStatus));
+    
+    injectSelector([OneSignalLocationOverrider class], @selector(overrideRequestAlwaysAuthorization), [CLLocationManager class], @selector(requestAlwaysAuthorization));
+    injectSelector([OneSignalLocationOverrider class], @selector(overrideRequestWhenInUseAuthorization), [CLLocationManager class], @selector(requestWhenInUseAuthorization));
+    injectSelector([OneSignalLocationOverrider class], @selector(overrideStartUpdatingLocation), [CLLocationManager class], @selector(startUpdatingLocation));
+    
+    // Never asked use for location service permission
+    startedMock = false;
+    // Set permission status for location services to 0 (not granted)
+    permissionStatusMock = 0;
+    // Never made a request for location based on info.plist params
+    calledRequestAlwaysAuthorization = false;
+    calledRequestWhenInUseAuthorization = false;
+    
+    // Create a mock location manager
+    locationManager = [self createLocationManager];
+    // Creater a mock array of locations
+    id location = [self createLocation];
+    locations = @[location];
+}
+
++ (bool)overrideStarted {
+    return startedMock;
+}
+
+// Create a mocked location manager for use in overrider
++ (CLLocationManager*)createLocationManager {
+    return [[CLLocationManager alloc] init];
+}
+
+// Create a mocked location for use in overrider
++ (CLLocation*)createLocation {
+    return [[CLLocation alloc] initWithLatitude:3.0 longitude:4.0];
+}
+
+// Simulate granting location services
+// The `locationManager` method is called after a user clicks the `Allow` button in the LocationServices alert because
+// a location update is triggered
++ (void)grantLocationServices {
+    
+    // Reset started to false (never seen prompt before)
+    startedMock = false;
+    
+    // Reset request flags
+    calledRequestAlwaysAuthorization = false;
+    calledRequestWhenInUseAuthorization = false;
+    
+    [OneSignalLocation internalGetLocation:true];
+}
+
++ (int)overrideAuthorizationStatus {
+    return permissionStatusMock;
+}
+
+- (void)overrideRequestAlwaysAuthorization {
+    // Overriden to do nothing, causes a info.plist warning failing our tests
+    calledRequestAlwaysAuthorization = true;
+}
+
+- (void)overrideRequestWhenInUseAuthorization {
+    // Overriden to do nothing, causes a info.plist warning failing our tests
+    calledRequestWhenInUseAuthorization = true;
+}
+
+- (void)overrideStartUpdatingLocation {
+    // If iOS is less than 8.0, the startUpdatingLocation prompts the user
+    // Otherwise, we want to check if the location request was made for info.plist params
+    if (OneSignalHelperOverrider.mockIOSVersion < 8.0 || calledRequestAlwaysAuthorization || calledRequestWhenInUseAuthorization)
+        [[OneSignalLocation sharedInstance] locationManager:locationManager didUpdateLocations:locations];
+}
+
+@end

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.m

@@ -46,6 +46,7 @@
 #import "NSTimerOverrider.h"
 #import "OSMessagingControllerOverrider.h"
 #import "OSInAppMessagingHelpers.h"
+#import "OneSignalLocation.h"
 
 NSString * serverUrlWithPath(NSString *path) {
     return [NSString stringWithFormat:@"%@%@%@", SERVER_URL, API_VERSION, path];