FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwizzler (#2683)

Author: maksymmalyhin

Example/Firebase.xcodeproj/project.pbxproj

@@ -7601,6 +7601,7 @@
 					"$(inherited)",
 					"COCOAPODS=1",
 					"GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS=1",
+					"GUL_APP_DELEGATE_TESTING=1",
 				);
 				HEADER_SEARCH_PATHS = (
 					"$(inherited)",

Example/Messaging/Tests/FIRMessagingRemoteNotificationsProxyTest.m

@@ -24,6 +24,8 @@
 #import "FIRMessaging.h"
 #import "FIRMessagingRemoteNotificationsProxy.h"
 
+#import <GoogleUtilities/GULAppDelegateSwizzler.h>
+
 #pragma mark - Invalid App Delegate or UNNotificationCenter
 
 @interface RandomObject : NSObject
@@ -62,6 +64,8 @@ @implementation IncompleteAppDelegate
 @interface FakeAppDelegate : NSObject <UIApplicationDelegate>
 @property(nonatomic) BOOL remoteNotificationMethodWasCalled;
 @property(nonatomic) BOOL remoteNotificationWithFetchHandlerWasCalled;
+@property(nonatomic, strong) NSData *deviceToken;
+@property(nonatomic, strong) NSError *registerForRemoteNotificationsError;
 @end
 @implementation FakeAppDelegate
 #if TARGET_OS_IOS
@@ -75,6 +79,17 @@ - (void)application:(UIApplication *)application
     fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
   self.remoteNotificationWithFetchHandlerWasCalled = YES;
 }
+
+- (void)application:(UIApplication *)application
+    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
+  self.deviceToken = deviceToken;
+}
+
+- (void)application:(UIApplication *)application
+    didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {
+  self.registerForRemoteNotificationsError = error;
+}
+
 @end
 
 #pragma mark - Incompete UNUserNotificationCenterDelegate
@@ -107,6 +122,10 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center
 @end
 #endif // __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0
 
+@interface GULAppDelegateSwizzler (FIRMessagingRemoteNotificationsProxyTest)
++ (void)resetProxyOriginalDelegateOnceToken;
+@end
+
 #pragma mark - Local, Per-Test Properties
 
 @interface FIRMessagingRemoteNotificationsProxyTest : XCTestCase
@@ -123,6 +142,9 @@ @implementation FIRMessagingRemoteNotificationsProxyTest
 
 - (void)setUp {
   [super setUp];
+
+  [GULAppDelegateSwizzler resetProxyOriginalDelegateOnceToken];
+
   _mockSharedApplication = OCMPartialMock([UIApplication sharedApplication]);
 
   _mockMessaging = OCMClassMock([FIRMessaging class]);
@@ -134,8 +156,7 @@ - (void)setUp {
   OCMStub([_mockProxyClass sharedProxy]).andReturn(self.proxy);
 
 #if __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0
-  _mockUserNotificationCenter = OCMClassMock([UNUserNotificationCenter class]);
-  OCMStub([_mockUserNotificationCenter currentNotificationCenter]).andReturn(_mockUserNotificationCenter);
+  _mockUserNotificationCenter = OCMPartialMock([UNUserNotificationCenter currentNotificationCenter]);
 #endif
 }
 
@@ -149,6 +170,9 @@ - (void)tearDown {
   [_mockSharedApplication stopMocking];
   _mockSharedApplication = nil;
 
+  [_mockUserNotificationCenter stopMocking];
+  _mockUserNotificationCenter = nil;
+
   _proxy = nil;
   [super tearDown];
 }
@@ -168,6 +192,7 @@ - (void)testSwizzlingNonAppDelegate {
 }
 
 - (void)testSwizzledIncompleteAppDelegateRemoteNotificationMethod {
+#if TARGET_OS_IOS
   IncompleteAppDelegate *incompleteAppDelegate = [[IncompleteAppDelegate alloc] init];
   [OCMStub([self.mockSharedApplication delegate]) andReturn:incompleteAppDelegate];
   [self.proxy swizzleMethodsIfPossible];
@@ -179,6 +204,7 @@ - (void)testSwizzledIncompleteAppDelegateRemoteNotificationMethod {
         didReceiveRemoteNotification:notification];
 
   [self.mockMessaging verify];
+#endif // TARGET_OS_IOS
 }
 
 - (void)testIncompleteAppDelegateRemoteNotificationWithFetchHandlerMethod {
@@ -187,10 +213,13 @@ - (void)testIncompleteAppDelegateRemoteNotificationWithFetchHandlerMethod {
   [self.proxy swizzleMethodsIfPossible];
 
   SEL remoteNotificationWithFetchHandler =
-  @selector(application:didReceiveRemoteNotification:fetchCompletionHandler:);
+      @selector(application:didReceiveRemoteNotification:fetchCompletionHandler:);
   XCTAssertFalse([incompleteAppDelegate respondsToSelector:remoteNotificationWithFetchHandler]);
+
+#if TARGET_OS_IOS
   SEL remoteNotification = @selector(application:didReceiveRemoteNotification:);
   XCTAssertTrue([incompleteAppDelegate respondsToSelector:remoteNotification]);
+#endif // TARGET_OS_IOS
 }
 
 - (void)testSwizzledAppDelegateRemoteNotificationMethods {
@@ -219,14 +248,34 @@ - (void)testSwizzledAppDelegateRemoteNotificationMethods {
   // Verify our swizzled method was called
   OCMExpect([self.mockMessaging appDidReceiveMessage:notification]);
 
-  [appDelegate application:OCMClassMock([UIApplication class])
+  [appDelegate application:self.mockSharedApplication
       didReceiveRemoteNotification:notification
       fetchCompletionHandler:^(UIBackgroundFetchResult result) {}];
 
   // Verify our original method was called
   XCTAssertTrue(appDelegate.remoteNotificationWithFetchHandlerWasCalled);
 
   [self.mockMessaging verify];
+
+  // Verify application:didRegisterForRemoteNotificationsWithDeviceToken:
+  NSData *deviceToken = [NSData data];
+
+  OCMExpect([self.mockMessaging setAPNSToken:deviceToken]);
+
+  [appDelegate application:self.mockSharedApplication
+      didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
+
+  XCTAssertEqual(appDelegate.deviceToken, deviceToken);
+  [self.mockMessaging verify];
+
+  // Verify application:didFailToRegisterForRemoteNotificationsWithError:
+  NSError *error = [NSError errorWithDomain:@"tests" code:-1 userInfo:nil];
+
+  [appDelegate application:self.mockSharedApplication
+      didFailToRegisterForRemoteNotificationsWithError:error];
+
+  XCTAssertEqual(appDelegate.registerForRemoteNotificationsError, error);
+
 #endif
 }
 

Example/Podfile

@@ -62,17 +62,6 @@ target 'DynamicLinks_Example_iOS' do
     pod 'OCMock'
     pod 'GoogleUtilities/MethodSwizzler', :path => '../'
     pod 'GoogleUtilities/SwizzlerTestHelpers', :path => '../'
-
-    # Set define to turn on the unswizzler for the unit tests
-    post_install do |installer_representation|
-      installer_representation.pods_project.targets.each do |target|
-          target.build_configurations.each do |config|
-              if config.name != 'Release'
-                  config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'GUL_UNSWIZZLING_ENABLED=1']
-              end
-          end
-      end
-    end
   end
 end
 
@@ -272,3 +261,14 @@ target 'InstanceID_Example_tvOS' do
   end
 end
 
+# Set define to turn on GUL_UNSWIZZLING and GUL_APP_DELEGATE_TESTING for the unit tests
+post_install do |installer_representation|
+  installer_representation.pods_project.targets.each do |target|
+      target.build_configurations.each do |config|
+          if config.name != 'Release'
+              config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'GUL_UNSWIZZLING_ENABLED=1', 'GUL_APP_DELEGATE_TESTING=1']
+          end
+      end
+  end
+end
+

Firebase/Messaging/FIRMessaging.m

@@ -880,6 +880,7 @@ + (NSString *)FIRMessagingSDKCurrentLocale {
 - (void)receiver:(FIRMessagingReceiver *)receiver
       receivedRemoteMessage:(FIRMessagingRemoteMessage *)remoteMessage {
   if ([self.delegate respondsToSelector:@selector(messaging:didReceiveMessage:)]) {
+    [self appDidReceiveMessage:remoteMessage.appData];
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wunguarded-availability"
     [self.delegate messaging:self didReceiveMessage:remoteMessage];