Merge pull request #867 from OneSignal/feature/launch_url_suppress

Launch url suppress

Author: emawby

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -603,6 +603,14 @@ + (void)initWithLaunchOptions:(nullable NSDictionary*)newLaunchOptions {
     [self init];
 }
 
++ (BOOL)shouldSuppressURL {
+    // if the plist key does not exist default to false
+    // the plist value specifies whether the user wants to open an url using default browser or OSWebView
+    NSDictionary *bundleDict = [[NSBundle mainBundle] infoDictionary];
+    BOOL shouldSuppress = [bundleDict[ONESIGNAL_SUPRESS_LAUNCH_URLS] boolValue];
+    return shouldSuppress ?: false;
+}
+
 + (void)setLaunchURLsInApp:(BOOL)launchInApp {
     NSMutableDictionary *newSettings = [[NSMutableDictionary alloc] initWithDictionary:appSettings];
     newSettings[kOSSettingsKeyInAppLaunchURL] = launchInApp ? @true : @false;
@@ -1970,9 +1978,11 @@ + (void)handleNotificationOpened:(NSDictionary*)messageDict
     onesignal_Log(ONE_S_LL_VERBOSE, [NSString stringWithFormat:@"handleNotificationOpened called! isActive: %@ notificationId: %@",
                                      isActive ? @"YES" : @"NO", messageId]);
 
-    // Try to fetch the open url to launch
-    [OneSignal launchWebURL:[customDict objectForKey:@"u"]];
-    
+    if ([OneSignal shouldSuppressURL]) {
+        // Try to fetch the open url to launch
+        [OneSignal launchWebURL:notification.launchURL];
+    }
+        
     [self clearBadgeCount:true];
 
     NSString* actionID = NULL;

iOS_SDK/OneSignalSDK/Source/OneSignalCommonDefines.h

@@ -135,6 +135,7 @@
 
 // Info.plist key
 #define FALLBACK_TO_SETTINGS_MESSAGE @"Onesignal_settings_fallback_message"
+#define ONESIGNAL_SUPRESS_LAUNCH_URLS @"OneSignal_suppress_launch_urls"
 
 // GDPR Privacy Consent
 #define GDPR_CONSENT_GRANTED @"GDPR_CONSENT_GRANTED"

iOS_SDK/OneSignalSDK/UnitTestApp/Info.plist

@@ -28,6 +28,8 @@
 	</array>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
+	<key>OneSignal_suppress_launch_urls</key>
+	<false/>
 	<key>UIRequiredDeviceCapabilities</key>
 	<array>
 		<string>armv7</string>

iOS_SDK/OneSignalSDK/UnitTests/Shadows/OneSignalOverrider.h

@@ -32,6 +32,10 @@ NS_ASSUME_NONNULL_BEGIN
 @interface OneSignalOverrider : NSObject
 
 @property (class, nonatomic) BOOL shouldOverrideSessionLaunchTime;
+@property (class, nonatomic) BOOL shouldOverrideLaunchURL;
+@property (class, nonatomic) BOOL launchWebURLWasCalled;
+
++ (void)reset;
 
 @end
 

iOS_SDK/OneSignalSDK/UnitTests/Shadows/OneSignalOverrider.m

@@ -40,6 +40,10 @@ + (NSDate *)sessionLaunchTime;
 
 @implementation OneSignal (Testing)
 
++ (void)overrideLaunchWebURL:(NSString*)openUrl {
+    OneSignalOverrider.launchWebURLWasCalled = true;
+}
+
 + (NSDate *)overrideSessionLaunchTime {
     if (OneSignalOverrider.shouldOverrideSessionLaunchTime) {
         return [NSDate date];
@@ -53,12 +57,20 @@ + (NSDate *)overrideSessionLaunchTime {
 @implementation OneSignalOverrider
 
 static BOOL _overrideLaunchTime = false;
+static BOOL _overrideLaunchURL = false;
+static BOOL _launchWebURLWasCalled = false;
+
 
 + (void)load {
     swizzleClassMethodWithCategoryImplementation([OneSignal class], @selector(sessionLaunchTime), @selector(overrideSessionLaunchTime));
+    swizzleClassMethodWithCategoryImplementation([OneSignal class], @selector(launchWebURL:), @selector(overrideLaunchWebURL:));
     _overrideLaunchTime = false;
 }
 
++ (void)reset {
+    _launchWebURLWasCalled = false;
+}
+
 + (BOOL)shouldOverrideSessionLaunchTime {
     return _overrideLaunchTime;
 }
@@ -67,6 +79,22 @@ + (void)setShouldOverrideSessionLaunchTime:(BOOL)shouldOverrideSessionLaunchTime
     _overrideLaunchTime = shouldOverrideSessionLaunchTime;
 }
 
++ (BOOL)shouldOverrideLaunchURL {
+    return _overrideLaunchURL;
+}
+
++ (void)setShouldOverrideLaunchURL:(BOOL)shouldOverrideLaunchURL {
+    _overrideLaunchURL = shouldOverrideLaunchURL;
+}
+
++ (BOOL)launchWebURLWasCalled {
+    return _launchWebURLWasCalled;
+}
+
++ (void)setLaunchWebURLWasCalled:(BOOL)launchWebURLWasCalled {
+    _launchWebURLWasCalled = launchWebURLWasCalled;
+}
+
 @end
 
 #pragma clang diagnostic pop

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.m

@@ -58,6 +58,7 @@
 #import "OSMessagingControllerOverrider.h"
 #import "OneSignalLifecycleObserver.h"
 #import "OneSignalLocationOverrider.h"
+#import "OneSignalOverrider.h"
 
 NSString * serverUrlWithPath(NSString *path) {
     return [OS_API_SERVER_URL stringByAppendingString:path];
@@ -246,6 +247,7 @@ + (void) beforeEachTest:(XCTestCase *)testCase {
     [self clearStateForAppRestart:testCase];
 
     [NSDateOverrider reset];
+    [OneSignalOverrider reset];
     [OneSignalClientOverrider reset:testCase];
     [NSUserDefaultsOverrider clearInternalDictionary];
     UNUserNotificationCenterOverrider.notifTypesOverride = 7;

iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m

@@ -71,6 +71,7 @@
 #import "OneSignalLocation.h"
 #import "OneSignalLocationOverrider.h"
 #import "UIDeviceOverrider.h"
+#import "OneSignalOverrider.h"
 
 // Dummies
 #import "DummyNotificationCenterDelegate.h"
@@ -106,6 +107,7 @@ @implementation UnitTests
 - (void)setUp {
     [super setUp];
     [UnitTestCommonMethods beforeEachTest:self];
+    OneSignalOverrider.shouldOverrideLaunchURL = false;
 
     // Only enable remote-notifications in UIBackgroundModes
     NSBundleOverrider.nsbundleDictionary = @{@"UIBackgroundModes": @[@"remote-notification"]};
@@ -2992,4 +2994,30 @@ - (void)testNotificationJson {
     XCTAssertEqualObjects(json[@"templateName"], @"Template name");
 }
 
+- (void)testLaunchURL {
+        
+    // 1. Init OneSignal with app start
+    [UnitTestCommonMethods initOneSignal];
+    [UnitTestCommonMethods runBackgroundThreads];
+
+    // 2. Simulate a notification being opened
+    let notifResponse = [self createBasiciOSNotificationResponse];
+    let notifCenter = UNUserNotificationCenter.currentNotificationCenter;
+    let notifCenterDelegate = notifCenter.delegate;
+    [notifCenterDelegate userNotificationCenter:notifCenter didReceiveNotificationResponse:notifResponse withCompletionHandler:^() {}];
+
+    // 3. Setup OneSignal.setNotificationOpenedHandler
+    __block BOOL openedWasFire = false;
+    [OneSignal setNotificationOpenedHandler:^(OSNotificationOpenedResult * _Nonnull result) {
+        openedWasFire = true;
+    }];
+    // 4. Wait for open event to fire
+    [UnitTestCommonMethods runBackgroundThreads];
+
+    // 5. Ensure the OneSignal public callback fired
+    XCTAssertTrue(openedWasFire);
+    
+    // 6. Ensure the launch URL was not opened
+    XCTAssertFalse(OneSignalOverrider.launchWebURLWasCalled);
+}
 @end