Fetch FirebaseMessaging Token during NotificationHub.start call (#175)

marstr · web-flow · commit b5673646ce95 · 2021-01-21T14:26:41.000-08:00
* Extract Firebase Messaging version into a variable

* Use FirebaseMessaging class instead of FirebaseInstanceId

* Make PushChannel bootstrapping code available

Previously, we only fetched the FirebaseMessaging token in the
FirebaseReceiver. This lead to a bug where bootstrapping didn't occur
during app-upgrades where new tokens are not issued, hence the
FirebaseReceiver is never instantiated.

With this change, the FirebaseMessaging ID will be re-evaluated when the
NotificatonHub.start method is called, and/or when the FirebaseReceiver
is started.

* Bring 'general' copy of FirebaseReceiver to parity with 'fcm' copy

* Removing unused-imports
diff --git a/notification-hubs-sdk/build.gradle b/notification-hubs-sdk/build.gradle
@@ -62,8 +62,10 @@ configurations {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation 'com.android.volley:volley:1.1.1'
-    fcmApi 'com.google.firebase:firebase-messaging:21.0.1'
-    generalApi 'com.google.firebase:firebase-messaging:21.0.1'
+
+    def firebaseMessagingVersion = '21.0.1'
+    fcmApi "com.google.firebase:firebase-messaging:${firebaseMessagingVersion}"
+    generalApi "com.google.firebase:firebase-messaging:${firebaseMessagingVersion}"
 
     javadocDeps 'com.android.support:support-annotations:28.0.0'
 
diff --git a/notification-hubs-sdk/src/fcm/java/com/microsoft/windowsazure/messaging/notificationhubs/FirebaseReceiver.java b/notification-hubs-sdk/src/fcm/java/com/microsoft/windowsazure/messaging/notificationhubs/FirebaseReceiver.java
@@ -1,13 +1,7 @@
 package com.microsoft.windowsazure.messaging.notificationhubs;
 
-import android.util.Log;
-
 import androidx.annotation.NonNull;
 
-import com.google.android.gms.tasks.OnCompleteListener;
-import com.google.android.gms.tasks.Task;
-import com.google.firebase.iid.FirebaseInstanceId;
-import com.google.firebase.iid.InstanceIdResult;
 import com.google.firebase.messaging.FirebaseMessagingService;
 import com.google.firebase.messaging.RemoteMessage;
 
@@ -47,21 +41,6 @@ public void onCreate() {
         super.onCreate();
 
         mHub.registerApplication(this.getApplication());
-
-        if (mHub.getInstancePushChannel() == null) {
-            FirebaseInstanceId.getInstance()
-                    .getInstanceId()
-                    .addOnCompleteListener(new OnCompleteListener<InstanceIdResult>() {
-                        @Override
-                        public void onComplete(@NonNull Task<InstanceIdResult> task) {
-                            if (!task.isSuccessful()) {
-                                Log.e("ANH", "unable to fetch FirebaseInstanceId");
-                                return;
-                            }
-                            mHub.setInstancePushChannel(task.getResult().getToken());
-                        }
-                    });
-        }
     }
 
     /**
diff --git a/notification-hubs-sdk/src/fcm/java/com/microsoft/windowsazure/messaging/notificationhubs/NotificationHubExtension.java b/notification-hubs-sdk/src/fcm/java/com/microsoft/windowsazure/messaging/notificationhubs/NotificationHubExtension.java
@@ -0,0 +1,44 @@
+package com.microsoft.windowsazure.messaging.notificationhubs;
+
+import android.app.Application;
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+import androidx.annotation.NonNull;
+
+import com.google.android.gms.tasks.OnCompleteListener;
+import com.google.android.gms.tasks.Task;
+import com.google.firebase.messaging.FirebaseMessaging;
+
+/**
+ * Allows platform-specific functionality to be made available to the NotificationHub global single
+ * instance.
+ */
+class NotificationHubExtension {
+    /**
+     * Queries Firebase for the most recent token asynchronously.
+     *
+     * @param hub The instance of {@link NotificationHub} that should be made aware of the token.
+     */
+    public static void fetchPushChannel(final NotificationHub hub) {
+        /*
+         * Keeping this out of the NotificationHub class allows us to keep platform-specific knowledge
+         * from entering the shared-portion of the code-base.
+         *
+         * Keeping this out of the FirebaseReceiver class allows us to not rely on Service start-time
+         * behavior, which caused an issue for people adopting our platform:
+         * https://github.com/Azure/azure-notificationhubs-xamarin/issues/21
+         */
+        FirebaseMessaging.getInstance().getToken().addOnCompleteListener(new OnCompleteListener<String>() {
+            @Override
+            public void onComplete(@NonNull Task<String> task) {
+                if (!task.isSuccessful()) {
+                    Log.e("ANH", "unable to fetch FirebaseInstanceId");
+                    return;
+                }
+                hub.setInstancePushChannel(task.getResult());
+            }
+        });
+    }
+}
diff --git a/notification-hubs-sdk/src/general/java/com/microsoft/windowsazure/messaging/notificationhubs/FirebaseReceiver.java b/notification-hubs-sdk/src/general/java/com/microsoft/windowsazure/messaging/notificationhubs/FirebaseReceiver.java
@@ -1,13 +1,7 @@
 package com.microsoft.windowsazure.messaging.notificationhubs;
 
-import android.util.Log;
-
 import androidx.annotation.NonNull;
 
-import com.google.android.gms.tasks.OnCompleteListener;
-import com.google.android.gms.tasks.Task;
-import com.google.firebase.iid.FirebaseInstanceId;
-import com.google.firebase.iid.InstanceIdResult;
 import com.google.firebase.messaging.FirebaseMessagingService;
 import com.google.firebase.messaging.RemoteMessage;
 
@@ -47,21 +41,6 @@ public void onCreate() {
         super.onCreate();
 
         mHub.registerApplication(this.getApplication());
-
-        if (mHub.getInstancePushChannel() == null) {
-            FirebaseInstanceId.getInstance()
-                    .getInstanceId()
-                    .addOnCompleteListener(new OnCompleteListener<InstanceIdResult>() {
-                        @Override
-                        public void onComplete(@NonNull Task<InstanceIdResult> task) {
-                            if (!task.isSuccessful()) {
-                                Log.e("ANH", "unable to fetch FirebaseInstanceId");
-                                return;
-                            }
-                            mHub.setInstancePushChannel(task.getResult().getToken());
-                        }
-                    });
-        }
     }
 
     /**
diff --git a/notification-hubs-sdk/src/general/java/com/microsoft/windowsazure/messaging/notificationhubs/NotificationHubExtension.java b/notification-hubs-sdk/src/general/java/com/microsoft/windowsazure/messaging/notificationhubs/NotificationHubExtension.java
@@ -0,0 +1,44 @@
+package com.microsoft.windowsazure.messaging.notificationhubs;
+
+import android.app.Application;
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+import androidx.annotation.NonNull;
+
+import com.google.android.gms.tasks.OnCompleteListener;
+import com.google.android.gms.tasks.Task;
+import com.google.firebase.messaging.FirebaseMessaging;
+
+/**
+ * Allows platform-specific functionality to be made available to the NotificationHub global single
+ * instance.
+ */
+class NotificationHubExtension {
+    /**
+     * Queries Firebase for the most recent token asynchronously.
+     *
+     * @param hub The instance of {@link NotificationHub} that should be made aware of the token.
+     */
+    public static void fetchPushChannel(final NotificationHub hub) {
+        /*
+         * Keeping this out of the NotificationHub class allows us to keep platform-specific knowledge
+         * from entering the shared-portion of the code-base.
+         *
+         * Keeping this out of the FirebaseReceiver class allows us to not rely on Service start-time
+         * behavior, which caused an issue for people adopting our platform:
+         * https://github.com/Azure/azure-notificationhubs-xamarin/issues/21
+         */
+        FirebaseMessaging.getInstance().getToken().addOnCompleteListener(new OnCompleteListener<String>() {
+            @Override
+            public void onComplete(@NonNull Task<String> task) {
+                if (!task.isSuccessful()) {
+                    Log.e("ANH", "unable to fetch FirebaseInstanceId");
+                    return;
+                }
+                hub.setInstancePushChannel(task.getResult());
+            }
+        });
+    }
+}
diff --git a/notification-hubs-sdk/src/main/java/com/microsoft/windowsazure/messaging/notificationhubs/NotificationHub.java b/notification-hubs-sdk/src/main/java/com/microsoft/windowsazure/messaging/notificationhubs/NotificationHub.java
@@ -91,6 +91,8 @@ synchronized void registerApplication(Application application) {
 
         mUserIdVisitor = new UserIdVisitor(mApplication);
         useInstanceVisitor(mUserIdVisitor);
+
+        NotificationHubExtension.fetchPushChannel(this);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,8 @@ synchronized void registerApplication(Application application) {`
`91`	`91`
`92`	`92`	`mUserIdVisitor = new UserIdVisitor(mApplication);`
`93`	`93`	`useInstanceVisitor(mUserIdVisitor);`
	`94`	`+`
	`95`	`+ NotificationHubExtension.fetchPushChannel(this);`
`94`	`96`	`}`
`95`	`97`
`96`	`98`	`/**`