Add a boolean value on whether to use direct channel callback for all ios versions (#1875)

Author: charlotteliang

Example/Messaging/Tests/FIRMessagingReceiverTest.m

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2018 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <XCTest/XCTest.h>
+
+#import <OCMock/OCMock.h>
+
+#import <FirebaseInstanceID/FirebaseInstanceID.h>
+
+#import "FIRMessaging.h"
+#import "FIRMessaging_Private.h"
+
+@interface FIRMessagingReceiverTest : XCTestCase
+@property(nonatomic, readonly, strong) FIRMessaging *messaging;
+
+@end
+
+@implementation FIRMessagingReceiverTest
+- (void)setUp {
+  [super setUp];
+
+  _messaging = [FIRMessaging messaging];
+  [[NSUserDefaults standardUserDefaults]
+      removePersistentDomainForName:[NSBundle mainBundle].bundleIdentifier];
+}
+
+- (void)testUseMessagingDelegate {
+  XCTAssertFalse(_messaging.useMessagingDelegateForDirectChannel);
+
+  _messaging.useMessagingDelegateForDirectChannel = YES;
+  XCTAssertTrue(_messaging.useMessagingDelegateForDirectChannel);
+}
+
+- (void)testUseMessagingDelegateFlagOverridedByPlistWithFalseValue {
+  id bundleMock = OCMPartialMock([NSBundle mainBundle]);
+  OCMStub([bundleMock objectForInfoDictionaryKey:kFIRMessagingPlistUseMessagingDelegate])
+      .andReturn(nil);
+  XCTAssertFalse(_messaging.useMessagingDelegateForDirectChannel);
+
+  [bundleMock stopMocking];
+}
+
+- (void)testUseMessagingDelegateFlagOverridedByPlistWithTrueValue {
+  id bundleMock = OCMPartialMock([NSBundle mainBundle]);
+  OCMStub([bundleMock objectForInfoDictionaryKey:kFIRMessagingPlistUseMessagingDelegate])
+      .andReturn(@YES);
+  XCTAssertTrue(_messaging.useMessagingDelegateForDirectChannel);
+
+  [bundleMock stopMocking];
+}
+@end

Firebase/Messaging/FIRMessaging.m

@@ -621,6 +621,15 @@ - (void)notifyDelegateOfFCMTokenAvailability {
   }
 }
 
+
+- (void)setUseMessagingDelegateForDirectChannel:(BOOL)useMessagingDelegateForDirectChannel {
+  self.receiver.useDirectChannel = useMessagingDelegateForDirectChannel;
+}
+
+- (BOOL)useMessagingDelegateForDirectChannel {
+  return self.receiver.useDirectChannel;
+}
+
 #pragma mark - Application State Changes
 
 - (void)applicationStateChanged {

Firebase/Messaging/FIRMessagingReceiver.h

@@ -25,7 +25,10 @@
 
 @end
 
-
 @interface FIRMessagingReceiver : NSObject <FIRMessagingDataMessageManagerDelegate>
+
 @property(nonatomic, weak, nullable) id<FIRMessagingReceiverDelegate> delegate;
+/// Whether to use direct channel for direct channel message callback handler in all iOS versions.
+@property(nonatomic, assign) BOOL useDirectChannel;
+
 @end

Firebase/Messaging/FIRMessagingReceiver.m

@@ -18,18 +18,21 @@
 
 #import <UIKit/UIKit.h>
 
+#import <GoogleUtilities/GULAppEnvironmentUtil.h>
+
 #import "FIRMessaging.h"
 #import "FIRMessagingLogger.h"
 #import "FIRMessagingUtilities.h"
 #import "FIRMessaging_Private.h"
 
 static NSString *const kUpstreamMessageIDUserInfoKey = @"messageID";
 static NSString *const kUpstreamErrorUserInfoKey = @"error";
-
-// Copied from Apple's header in case it is missing in some cases.
-#ifndef NSFoundationVersionNumber_iOS_9_x_Max
-#define NSFoundationVersionNumber_iOS_9_x_Max 1299
-#endif
+/// "Should use Messaging delegate" key stored in NSUserDefaults
+NSString *const kFIRMessagingUserDefaultsKeyUseMessagingDelegate =
+    @"com.firebase.messaging.useMessagingDelegate";
+/// "Should use Messaging Delegate" key stored in Info.plist
+NSString *const kFIRMessagingPlistUseMessagingDelegate =
+    @"FirebaseMessagingUseMessagingDelegateForDirectChannel";
 
 static int downstreamMessageID = 0;
 
@@ -42,8 +45,9 @@ - (void)didReceiveMessage:(NSDictionary *)message withIdentifier:(nullable NSStr
     messageID = [[self class] nextMessageID];
   }
 
-  if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_9_x_Max) {
-    // Use delegate method for iOS 10
+  NSInteger majorOSVersion = [[GULAppEnvironmentUtil systemVersion] integerValue];
+  if (majorOSVersion >= 10 || self.useDirectChannel) {
+    // iOS 10 and above or use direct channel is enabled.
     [self scheduleIos10NotificationForMessage:message withIdentifier:messageID];
   } else {
     // Post notification directly to AppDelegate handlers. This is valid pre-iOS 10.
@@ -146,4 +150,33 @@ + (NSString *)nextMessageID {
   }
 }
 
+- (BOOL)useDirectChannel {
+  // Check storage
+  NSUserDefaults *messagingDefaults = [NSUserDefaults standardUserDefaults];
+  id shouldUseMessagingDelegate =
+      [messagingDefaults objectForKey:kFIRMessagingUserDefaultsKeyUseMessagingDelegate];
+  if (shouldUseMessagingDelegate) {
+    return [shouldUseMessagingDelegate boolValue];
+  }
+
+  // Check Info.plist
+  shouldUseMessagingDelegate =
+      [[NSBundle mainBundle] objectForInfoDictionaryKey:kFIRMessagingPlistUseMessagingDelegate];
+  if (shouldUseMessagingDelegate) {
+    return [shouldUseMessagingDelegate boolValue];
+  }
+  // If none of above exists, we go back to default behavior which is NO.
+  return NO;
+}
+
+- (void)setUseDirectChannel:(BOOL)useDirectChannel {
+  NSUserDefaults *messagingDefaults = [NSUserDefaults standardUserDefaults];
+  BOOL shouldUseMessagingDelegate = [self useDirectChannel];
+  if (useDirectChannel != shouldUseMessagingDelegate) {
+    [messagingDefaults setBool:useDirectChannel
+                        forKey:kFIRMessagingUserDefaultsKeyUseMessagingDelegate];
+    [messagingDefaults synchronize];
+  }
+}
+
 @end

Firebase/Messaging/FIRMessaging_Private.h

@@ -27,6 +27,8 @@ typedef NS_ENUM(int8_t, FIRMessagingNetworkStatus) {
 
 FOUNDATION_EXPORT NSString *const kFIRMessagingPlistAutoInitEnabled;
 FOUNDATION_EXPORT NSString *const kFIRMessagingUserDefaultsKeyAutoInitEnabled;
+FOUNDATION_EXPORT NSString *const kFIRMessagingUserDefaultsKeyUseMessagingDelegate;
+FOUNDATION_EXPORT NSString *const kFIRMessagingPlistUseMessagingDelegate;
 
 @interface FIRMessagingRemoteMessage ()
 

Firebase/Messaging/Public/FIRMessaging.h

@@ -260,9 +260,11 @@ NS_SWIFT_NAME(MessagingDelegate)
     didReceiveRegistrationToken:(NSString *)fcmToken
     NS_SWIFT_NAME(messaging(_:didReceiveRegistrationToken:));
 
-/// This method is called on iOS 10 devices to handle data messages received via FCM through its
-/// direct channel (not via APNS). For iOS 9 and below, the FCM data message is delivered via the
-/// UIApplicationDelegate's -application:didReceiveRemoteNotification: method.
+/// This method is called on iOS 10+ devices to handle data messages received via FCM
+/// direct channel (not via APNS). For iOS 9 and below, the direct channel data message
+/// is handled by the UIApplicationDelegate's -application:didReceiveRemoteNotification: method.
+/// You can enable all direct channel data messages to be delivered in FIRMessagingDelegate
+/// by setting the flag `useMessagingDelegateForDirectMessages` to true.
 - (void)messaging:(FIRMessaging *)messaging
     didReceiveMessage:(FIRMessagingRemoteMessage *)remoteMessage
     NS_SWIFT_NAME(messaging(_:didReceive:))
@@ -277,14 +279,14 @@ NS_SWIFT_NAME(MessagingDelegate)
  *  registration token from FIRInstanceID. This token authorizes an
  *  app server to send messages to an app instance.
  *
- *  In order to receive FIRMessaging messages, declare `application:didReceiveRemoteNotification:`.
+ *  In order to receive FIRMessaging messages, declare
+ *  `application:didReceiveRemoteNotification::fetchCompletionHandler:`.
  */
 NS_SWIFT_NAME(Messaging)
 @interface FIRMessaging : NSObject
 
 /**
- * Delegate to handle FCM token refreshes, and remote data messages received via FCM for devices
- * running iOS 10 or above.
+ * Delegate to handle FCM token refreshes, and remote data messages received via FCM direct channel.
  */
 @property(nonatomic, weak, nullable) id<FIRMessagingDelegate> delegate;
 
@@ -301,6 +303,22 @@ NS_SWIFT_NAME(Messaging)
  */
 @property(nonatomic, readonly) BOOL isDirectChannelEstablished;
 
+/*
+ * Whether direct channel message should only use FIRMessagingDelegate messaging(_:didReceive:)
+ * for message delivery callback. The default value is false. If you need to change
+ * the default, set FirebaseMessagingUseMessagingDelegateForDirectChannel to true in
+ * your application’s Info.plist.
+ *
+ * If false, the message via direct channel for iOS 9 and below is still delivered in
+ * `-UIApplicationDelegate application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`,
+ * and the FIRMessagingRemoteMessage object and its associated data will be unavailable.
+ * For iOS 10 and above, it is still delivered in `FIRMessagingDelegate messaging(_:didReceive:)`.
+ *
+ * If true, the data message sent by direct channel will be delivered via
+ * `FIRMessagingDelegate messaging(_:didReceive:)` and across all iOS versions.
+ */
+@property(nonatomic, assign) BOOL useMessagingDelegateForDirectChannel;
+
 /**
  *  FIRMessaging
  *
@@ -413,7 +431,7 @@ NS_SWIFT_NAME(Messaging)
     NS_SWIFT_NAME(deleteFCMToken(forSenderID:completion:));
 
 
-#pragma mark - Connect
+#pragma mark - FCM Direct Channel
 
 /**
  *  Create a FIRMessaging data connection which will be used to send the data notifications

FirebaseMessaging.podspec

@@ -39,5 +39,6 @@ device, and it is completely free.
   s.dependency 'FirebaseCore', '~> 5.0'
   s.dependency 'FirebaseInstanceID', '~> 3.0'
   s.dependency 'GoogleUtilities/Reachability', '~> 5.2'
+  s.dependency 'GoogleUtilities/Environment', '~> 5.2'
   s.dependency 'Protobuf', '~> 3.1'
 end