FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwizzler #2683

maksymmalyhin · 2019-03-29T20:40:32Z

Changes required for #2591

GULAppDelegateSwizzler - remote notifications methods support
FIRMessagingRemoteNotificationsProxy - swizzling of Application delegate updated to use GULAppDelegateSwizzler

NOTE: FIRMessagingRemoteNotificationsProxy still swizzles UNUserNotificationDelegate methods in its own way. I think, we should refactor it as a separate PR once we finish refactoring of app delegate swizzling in all libraries.

…Swizzler [WIP]

…DelegateSwizzler [WIP]" This reverts commit b2eabf2.

…public interface with no assumptions on the implementation details

…lementation details assumptions

Conflicts: Example/Messaging/Tests/FIRMessagingRemoteNotificationsProxyTest.m

…s applied to all targets. Move the hook to the top level to avoid confusion.

…etProxyOriginalDelegateOnceToken] at the beginning of each test.

…sts added. Cleanup

maksymmalyhin · 2019-03-29T20:43:50Z

Example/Podfile

@@ -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|


Now (Cocoapods 1.6.1) there is only post_install hook supported for entire Podfile. It affects all targets anyways, so I moved it to the upper level to avoid confusion.

Cool, thanks!

Firebase/Messaging/FIRMessagingRemoteNotificationsProxy.m

maksymmalyhin · 2019-03-29T20:52:24Z

GoogleUtilities/AppDelegateSwizzler/GULAppDelegateSwizzler.m

@@ -376,6 +459,18 @@ + (void)createSubclassWithObject:(id<UIApplicationDelegate>)anObject {
  }
  objc_setAssociatedObject(anObject, &kGULOpenURLOptionsSourceAnnotationsIMPKey,
                           openURLSourceAppAnnotationIMPPointer, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+  objc_setAssociatedObject(anObject, &kGULRealDidRegisterForRemoteNotificationsIMPKey,


@tejasd I used the same way of storing the original implementations as for the old methods. But it looks like it can be optimized to avoid boilerplate (e.g. store the implementations in a dictionary).

Also, I think, some repeated code may be moved to separate methods.

@tejasd What do you think?

Yup, that's definitely an option! Feel free to refactor that in a separate PR :)

maksymmalyhin · 2019-03-29T21:00:36Z

@chliangGoogle I tested basic use-cases like receiving messages sent from the console. Are there any cases I need to pay a specific attention to.

charlotteliang · 2019-03-29T21:23:46Z

Receiving messages are not enough for testing swizzling, if you look at the implementations, we swizzle because for a few reason. A. to be able to track analytics events, so would be great to check if Analytics is able to track notification_open or notification_foreground event; You can use the "debug mode" on Analytics console to see if a notification is opened or in foreground; B. when APNS token is updated, we need to notify FCM, so would be great if we can also make sure that logic is called. Basically we need to make sure all the "swizzled logic" is actually getting triggered. Does that make sense?

Example/Messaging/Tests/FIRMessagingRemoteNotificationsProxyTest.m

charlotteliang · 2019-03-29T22:05:53Z

Firebase/Messaging/FIRMessagingRemoteNotificationsProxy.m


-@interface FIRMessagingRemoteNotificationsProxy ()
+@interface FIRMessagingRemoteNotificationsProxy () <UIApplicationDelegate>


Is there an alternative than following this protocol? This makes macOS support very hard .

Refer comment below.

@chliangGoogle Does FCM support MacOS now? If not, I can take care of MacOS support for GULAppDelegateSwizzler in a separate PR. What do you think?

@maksymmalyhin FCM does not yet support MacOS. It recently added tvOS See https://github.com/firebase/firebase-ios-sdk/blob/master/FirebaseMessaging.podspec#L22

@paulb777 It looks like tvOS has no difference in the App Delegate, so supporting tvOS by GULAppDelegateSwizzler should be trivial. I'll update it in this PR

Will we make GULAppDelegateSwizzler macOS support in this PR? If not, we can add a todo and fix in another PR.

I created a ticket for this #2706

charlotteliang · 2019-03-29T22:10:13Z

Firebase/Messaging/FIRMessagingRemoteNotificationsProxy.m

@@ -466,39 +389,36 @@ id getNamedPropertyFromObject(id object, NSString *propertyName, Class klass) {
  return property;
 }

-#pragma mark - Swizzled Methods
+#pragma mark - UIApplicationDelegate


@tejasd Is this required that if I use GULAppDelegateSwizzler and I need to swizzle some methods under UIApplicationDelegate, my class must follow the protocol and implement the methods here?

With the current design, yes. If that's a blocker we can create our own protocol, say GULAppDelegate which can be platform agnostic.

…essage:] before calling delegate.

paulb777

LGTM

Needs approval from @chliangGoogle

charlotteliang

LGTM on FCM part.

Also need approval from @tejasd

Example/Messaging/Tests/FIRMessagingRemoteNotificationsProxyTest.m

charlotteliang · 2019-04-02T03:41:01Z

Firebase/Messaging/FIRMessagingRemoteNotificationsProxy.m


-@interface FIRMessagingRemoteNotificationsProxy ()
+@interface FIRMessagingRemoteNotificationsProxy () <UIApplicationDelegate>


Will we make GULAppDelegateSwizzler macOS support in this PR? If not, we can add a todo and fix in another PR.

Firebase/Messaging/FIRMessagingRemoteNotificationsProxy.m

…Notification:` for tvOS just in case

tejasd · 2019-04-03T00:37:26Z

Example/Messaging/Tests/FIRMessagingRemoteNotificationsProxyTest.m

@@ -107,6 +122,10 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center
 @end
 #endif // __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0

+@interface GULAppDelegateSwizzler (FIRMessagingRemoteNotificationsProxyTest)


Consider importing the private header.

tejasd · 2019-04-03T01:18:14Z

Example/Podfile

@@ -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|


Cool, thanks!

Conflicts: GoogleUtilities/AppDelegateSwizzler/GULAppDelegateSwizzler.m GoogleUtilities/Example/Tests/Swizzler/GULAppDelegateSwizzlerTest.m

charlotteliang · 2019-04-04T18:10:32Z

@maksymmalyhin Please make sure to test it with Analytics to ensure the notification tracking still works.

…zzler (#2683)

maksymmalyhin added 21 commits March 26, 2019 17:28

FIRAuthAppDelegateProxy: implementation updated to use GULAppDelegate…

b2eabf2

…Swizzler [WIP]

GULAppDelegateSwizzler - make sure subclass name is unique.

4ab86de

GoogleUtilities: enable code coverage

1f1560a

Merge branch 'master'

f4a4638

GULAppDelegateSwizzler: Add support of remote notification methods

9fcedce

GULAppDelegateSwizzler - tests for remote notification methods

27c8b5b

Revert "FIRAuthAppDelegateProxy: implementation updated to use GULApp…

dee28d3

…DelegateSwizzler [WIP]" This reverts commit b2eabf2.

FIRMessaging: prepare to use GULAppDelegateSwizzler [WIP]

5821591

FIRMessagingRemoteNotificationsProxy - use GULAppDelegateSwizzler [WIP]

908b6ea

FIRMessagingRemoteNotificationsProxy - AppDelegate proxy - test only …

9e377d2

…public interface with no assumptions on the implementation details

FIRMessagingRemoteNotificationsProxy test only public API with no imp…

7861cde

…lementation details assumptions

Cleanup

b7703ac

Cleanup

ad1da54

Merge branch 'master'

2bdf353

Merge branch 'mm/messaging-tests'

8eafece

Merge branch 'master'

e5d2ce8

Conflicts: Example/Messaging/Tests/FIRMessagingRemoteNotificationsProxyTest.m

Cocoapods 1.6.1: Podfile supports only single post_install hook. It i…

86ff257

…s applied to all targets. Move the hook to the top level to avoid confusion.

FIRMessagingRemoteNotificationsProxyTest: [GULAppDelegateSwizzler res…

79b7613

…etProxyOriginalDelegateOnceToken] at the beginning of each test.

FIRMessagingRemoteNotificationsProxy: app delegate missing methods te…

98ffccb

…sts added. Cleanup

GULAppDelegateSwizzler: don't swizzle invalid application delegate

cd44395

Cleanup

3df4140

maksymmalyhin requested review from paulb777, tejasd and charlotteliang March 29, 2019 20:40

googlebot added the cla: yes label Mar 29, 2019

maksymmalyhin commented Mar 29, 2019

View reviewed changes

Firebase/Messaging/FIRMessagingRemoteNotificationsProxy.m Show resolved Hide resolved

maksymmalyhin commented Mar 29, 2019

View reviewed changes

Run ./scripts/check.sh

dcd0e10

charlotteliang requested changes Mar 29, 2019

View reviewed changes

maksymmalyhin added 5 commits April 1, 2019 10:12

Merge branch 'master'

18381dd

GoogleUtilities/GULAppDelegateSwizzler - tvOS support

dae75d9

style.sh generated changes

6dee8d3

FirebaseMessaging - missing dependencies added

2726e7c

FCM data channel messages - pass data to [FIRMessaging appDidReceiveM…

63fd1f5

…essage:] before calling delegate.

This was referenced Apr 1, 2019

GULAppDelegateSwizzler - remote notifications methods and macOS support #2697

Closed

GULAppDelegateSwizzler - remote notifications methods and tvOS support #2698

Merged

paulb777 reviewed Apr 2, 2019

View reviewed changes

charlotteliang approved these changes Apr 2, 2019

View reviewed changes

maksymmalyhin added 2 commits April 2, 2019 10:37

FIRMessagingRemoteNotificationsProxyTest - remove GULLoggerForceDebug()

4a3fbb1

GULAppDelegateSwizzler - add deprecated `application:didReceiveRemote…

b390f4f

…Notification:` for tvOS just in case

charlotteliang approved these changes Apr 2, 2019

View reviewed changes

tejasd approved these changes Apr 3, 2019

View reviewed changes

Merge branch 'master'

236877d

Conflicts: GoogleUtilities/AppDelegateSwizzler/GULAppDelegateSwizzler.m GoogleUtilities/Example/Tests/Swizzler/GULAppDelegateSwizzlerTest.m

maksymmalyhin mentioned this pull request Apr 3, 2019

Bump GoogleUtilities version to 5.6.0 #2715

Merged

Merge branch 'master'

3641d35

maksymmalyhin merged commit 267e9a6 into master Apr 4, 2019

maksymmalyhin deleted the mm/messaging-swizzling branch April 4, 2019 13:26

Corrob pushed a commit that referenced this pull request Apr 25, 2019

FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwi…

78d3bd6

…zzler (#2683)

firebase locked and limited conversation to collaborators Oct 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwizzler #2683

FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwizzler #2683

maksymmalyhin commented Mar 29, 2019

maksymmalyhin Mar 29, 2019

tejasd Apr 3, 2019

maksymmalyhin Mar 29, 2019

tejasd Mar 30, 2019

maksymmalyhin commented Mar 29, 2019

charlotteliang commented Mar 29, 2019

charlotteliang Mar 29, 2019

tejasd Mar 30, 2019

maksymmalyhin Apr 1, 2019

paulb777 Apr 1, 2019

maksymmalyhin Apr 1, 2019

charlotteliang Apr 2, 2019

maksymmalyhin Apr 2, 2019

charlotteliang Mar 29, 2019

tejasd Mar 30, 2019

paulb777 left a comment

charlotteliang left a comment

charlotteliang Apr 2, 2019

tejasd Apr 3, 2019

tejasd Apr 3, 2019

charlotteliang commented Apr 4, 2019


		@interface FIRMessagingRemoteNotificationsProxy ()
		@interface FIRMessagingRemoteNotificationsProxy () <UIApplicationDelegate>

FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwizzler #2683

FIRMessagingRemoteNotificationsProxy updated to use GULAppDelegateSwizzler #2683

Conversation

maksymmalyhin commented Mar 29, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maksymmalyhin commented Mar 29, 2019

charlotteliang commented Mar 29, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulb777 left a comment

Choose a reason for hiding this comment

charlotteliang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charlotteliang commented Apr 4, 2019