Check for notification_open duplicate logging based on message ID.

- Changed to use the message ID when checking for duplicate notification_open logging instead of the Activity's Intent. This should avoid logging again when an app starts another activity using a copy of the notification's intent (#6091).

Author: gsakakihara

firebase-messaging/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Unreleased
+* [changed] Checked for notification_open duplicate logging based on message ID
+  instead of the Activity's Intent.
 
 
 # 24.0.0

firebase-messaging/src/main/java/com/google/firebase/messaging/FcmLifecycleCallbacks.java

@@ -24,24 +24,25 @@
 import android.os.Bundle;
 import android.os.Handler;
 import android.os.Looper;
+import android.text.TextUtils;
 import android.util.Log;
-import java.util.Collections;
-import java.util.Set;
-import java.util.WeakHashMap;
+import java.util.ArrayDeque;
+import java.util.Queue;
 
 class FcmLifecycleCallbacks implements Application.ActivityLifecycleCallbacks {
 
-  /** Keep a list of intents that we've seen to avoid accidentally logging events twice. */
-  private final Set<Intent> seenIntents =
-      Collections.newSetFromMap(new WeakHashMap<Intent, Boolean>());
+  private static final int RECENTLY_LOGGED_MESSAGE_IDS_MAX_SIZE = 10;
+
+  /** Last N message IDs that have been logged to prevent duplicate logging. */
+  private final Queue<String> recentlyLoggedMessageIds =
+      new ArrayDeque<>(RECENTLY_LOGGED_MESSAGE_IDS_MAX_SIZE);
 
   // TODO(b/258424124): Migrate to go/firebase-android-executors
   @SuppressLint("ThreadPoolCreation")
   @Override
   public void onActivityCreated(Activity createdActivity, Bundle instanceState) {
     Intent startingIntent = createdActivity.getIntent();
-    if (startingIntent == null || !seenIntents.add(startingIntent)) {
-      // already seen (and logged) this, no need to go any further.
+    if (startingIntent == null) {
       return;
     }
 
@@ -57,12 +58,7 @@ public void onActivityCreated(Activity createdActivity, Bundle instanceState) {
   }
 
   @Override
-  public void onActivityPaused(Activity pausedActivity) {
-    if (pausedActivity.isFinishing()) {
-      // iff the activity is finished we can remove the intent from our "seen" list
-      seenIntents.remove(pausedActivity.getIntent());
-    }
-  }
+  public void onActivityPaused(Activity pausedActivity) {}
 
   @Override
   public void onActivityDestroyed(Activity destroyedActivity) {}
@@ -84,6 +80,14 @@ private void logNotificationOpen(Intent startingIntent) {
     try {
       Bundle extras = startingIntent.getExtras();
       if (extras != null) {
+        String messageId = MessagingAnalytics.getMessageId(extras);
+        if (!TextUtils.isEmpty(messageId)) {
+          if (recentlyLoggedMessageIds.contains(messageId)) {
+            // Already logged, don't log again.
+            return;
+          }
+          recentlyLoggedMessageIds.add(messageId);
+        }
         analyticsData = extras.getBundle(Constants.MessageNotificationKeys.ANALYTICS_DATA);
       }
     } catch (RuntimeException e) {

firebase-messaging/src/test/java/com/google/firebase/messaging/FirebaseMessagingServiceRoboTest.java

@@ -63,6 +63,7 @@
 import com.google.firebase.FirebaseOptions;
 import com.google.firebase.iid.FirebaseInstanceIdReceiver;
 import com.google.firebase.messaging.AnalyticsTestHelper.Analytics;
+import com.google.firebase.messaging.Constants.MessagePayloadKeys;
 import com.google.firebase.messaging.testing.AnalyticsValidator;
 import com.google.firebase.messaging.testing.Bundles;
 import com.google.firebase.messaging.testing.FakeConnectorComponent;
@@ -612,6 +613,7 @@ private void simulateNotificationMessageWithAnalytics() throws InterruptedExcept
     // Robo manifest doesn't have a default activity, so set click action so that we get a
     // click pending intent.
     builder.addData(DisplayNotificationRoboTest.KEY_CLICK_ACTION, "click_action");
+    builder.addData(MessagePayloadKeys.MSGID, "msg_id");
     AnalyticsTestHelper.addAnalyticsExtras(builder);
     startServiceViaReceiver(builder.buildIntent());
   }