Merge pull request #465 from ForgeRock/SDKS-3697

SDKS-3697 Prevent duplicated notification on the SDK

Author: rodrigoareis

forgerock-authenticator/src/main/java/org/forgerock/android/auth/AuthenticatorManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2023 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -247,6 +247,10 @@ PushNotification getNotification(String notificationId) {
         return notification;
     }
 
+    PushNotification getNotificationByMessageId(String messageId) {
+        return storageClient.getNotificationByMessageId(messageId);
+    }
+
     void registerForRemoteNotifications(String newDeviceToken) throws AuthenticatorException {
         if(this.deviceToken == null) {
             this.deviceToken = newDeviceToken;

forgerock-authenticator/src/main/java/org/forgerock/android/auth/DefaultStorageClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2023 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -209,6 +209,17 @@ public PushNotification getNotification(String notificationId) {
         return PushNotification.deserialize(json);
     }
 
+    @Override
+    public PushNotification getNotificationByMessageId(String messageId) {
+        List<PushNotification> allPushNotifications = getAllNotifications();
+        for(PushNotification pushNotification : allPushNotifications){
+            if(pushNotification.getMessageId().equals(messageId)){
+                return pushNotification;
+            }
+        }
+        return null;
+    }
+
     @Override
     public boolean isEmpty() {
         return accountData.getAll().isEmpty() &&

forgerock-authenticator/src/main/java/org/forgerock/android/auth/FRAClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2023 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -283,6 +283,15 @@ public PushNotification getNotification(@NonNull String notificationId) {
         return this.authenticatorManager.getNotification(notificationId);
     }
 
+    /**
+     * Get the PushNotification object with its messageId.
+     * @param messageId The message unique ID
+     * @return The PushNotification object
+     */
+    public PushNotification getNotificationByMessageId(@NonNull String messageId) {
+        return this.authenticatorManager.getNotificationByMessageId(messageId);
+    }
+
     /**
      * Remove from the storage the {@link PushNotification} that was passed in.
      * @param notification The PushNotification object to delete

forgerock-authenticator/src/main/java/org/forgerock/android/auth/NotificationFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2023 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -84,6 +84,13 @@ PushNotification handleMessage(@NonNull String messageId, @NonNull String messag
         String numbersChallenge;
         String contextInfo;
 
+        // Check if notification with given messageId already exists
+        pushNotification = storageClient.getNotificationByMessageId(messageId);
+        if (pushNotification != null) {
+            Logger.debug(TAG, "PushNotification object with messageId %s already exists.", messageId);
+            return pushNotification;
+        }
+
         // Reconstruct JWT
         try {
             signedJwt = SignedJWT.parse(message);

forgerock-authenticator/src/main/java/org/forgerock/android/auth/StorageClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2021 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -105,6 +105,13 @@ public interface StorageClient {
      */
     PushNotification getNotification(String notificationId);
 
+    /**
+     * Get the PushNotification object with its messageId
+     * @param messageId The PushNotification messageId
+     * @return The PushNotification object.
+     */
+    PushNotification getNotificationByMessageId(String messageId);
+
     /**
      * Whether the storage system currently contains any data.
      * @return True if the storage system is empty, false otherwise.

forgerock-authenticator/src/test/java/org/forgerock/android/auth/AuthenticatorManagerTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2023 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -764,6 +764,30 @@ public void testShouldGetStoredNotificationByID() {
         assertEquals(notification, notificationFromStorage);
     }
 
+    @Test
+    public void testShouldGetStoredNotificationByMessageID() {
+        Account account = createAccount(ACCOUNT_NAME, ISSUER);
+        Mechanism push = createPushMechanism(ACCOUNT_NAME, ISSUER, MECHANISM_UID);
+        PushNotification notification = createPushNotification(MESSAGE_ID, push);
+
+        List<Mechanism> mechanismList= new ArrayList<>();
+        mechanismList.add(push);
+
+        List<PushNotification> notificationList = new ArrayList<>();
+        notificationList.add(createPushNotification(MESSAGE_ID, push));
+        notificationList.add(createPushNotification(OTHER_MESSAGE_ID, push));
+
+        given(storageClient.getAccount(any(String.class))).willReturn(account);
+        given(storageClient.getMechanismsForAccount(any(Account.class))).willReturn(mechanismList);
+        given(storageClient.getAllNotificationsForMechanism(any(Mechanism.class))).willReturn(notificationList);
+        given(storageClient.getNotificationByMessageId(anyString())).willReturn(notification);
+
+        PushNotification notificationFromStorage = authenticatorManager.getNotificationByMessageId(notification.getMessageId());
+
+        assertNotNull(notificationFromStorage);
+        assertEquals(notification, notificationFromStorage);
+    }
+
     @Test
     public void testShouldRemoveExistingAccount() {
         Account account = createAccount(ACCOUNT_NAME, ISSUER);

forgerock-authenticator/src/test/java/org/forgerock/android/auth/CustomStorageClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2021 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -94,6 +94,11 @@ public PushNotification getNotification(String notificationId) {
         return null;
     }
 
+    @Override
+    public PushNotification getNotificationByMessageId(String messageId) {
+        return null;
+    }
+
     @Override
     public boolean isEmpty() {
         return false;

forgerock-authenticator/src/test/java/org/forgerock/android/auth/DefaultStorageClientTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -389,6 +389,39 @@ public void testShouldGetNotificationById() {
         assertEquals(pushNotificationFromStorage.getMessageId(), MESSAGE_ID);
     }
 
+    @Test
+    public void testShouldGetNotificationByMessageId() {
+        DefaultStorageClient defaultStorage = new DefaultStorageClient(context);
+        defaultStorage.setAccountData(context.getApplicationContext()
+                .getSharedPreferences(TEST_SHARED_PREFERENCES_DATA_ACCOUNT, Context.MODE_PRIVATE));
+        defaultStorage.setMechanismData(context.getApplicationContext()
+                .getSharedPreferences(TEST_SHARED_PREFERENCES_DATA_MECHANISM, Context.MODE_PRIVATE));
+        defaultStorage.setNotificationData(context.getApplicationContext()
+                .getSharedPreferences(TEST_SHARED_PREFERENCES_DATA_NOTIFICATIONS, Context.MODE_PRIVATE));
+
+        Calendar timeAdded = Calendar.getInstance();
+
+        Account account = createAccountWithoutAdditionalData(ISSUER, ACCOUNT_NAME);
+        Mechanism mechanism = createPushMechanism(MECHANISM_UID, ISSUER, ACCOUNT_NAME, SECRET,
+                REGISTRATION_ENDPOINT, AUTHENTICATION_ENDPOINT);
+        PushNotification pushNotification = createPushNotification(MECHANISM_UID, MESSAGE_ID, CHALLENGE,
+                AMLB_COOKIE, timeAdded, TTL);
+
+        defaultStorage.setAccount(account);
+        defaultStorage.setMechanism(mechanism);
+        defaultStorage.setNotification(pushNotification);
+
+        Account accountFromStorage = defaultStorage.getAccount(account.getId());
+        PushMechanism pushMechanismFromStorage = (PushMechanism) defaultStorage.getMechanismsForAccount(accountFromStorage).get(0);
+        PushNotification pushNotificationFromStorage = defaultStorage.getNotificationByMessageId(pushNotification.getMessageId());
+
+        assertNotNull(accountFromStorage);
+        assertNotNull(pushMechanismFromStorage);
+        assertNotNull(pushNotificationFromStorage);
+        assertEquals(pushNotificationFromStorage.getMechanismUID(), MECHANISM_UID);
+        assertEquals(pushNotificationFromStorage.getMessageId(), MESSAGE_ID);
+    }
+
     @Test
     public void testStoreMultipleNotificationsForSameAccount() {
         DefaultStorageClient defaultStorage = new DefaultStorageClient(context);

forgerock-authenticator/src/test/java/org/forgerock/android/auth/FRAClientTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2023 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -724,6 +724,39 @@ public void testShouldGetStoredNotificationByID() throws Exception {
         assertEquals(notification, notificationFromStorage);
     }
 
+    @Test
+    public void testShouldGetStoredNotificationByMessageID() throws Exception {
+        FRAClient fraClient = FRAClient.builder()
+                .withContext(context)
+                .withDeviceToken("s-o-m-e-t-o-k-e-n")
+                .withStorage(storageClient)
+                .start();
+
+        assertNotNull(fraClient);
+        assertNotNull(fraClient.getAuthenticatorManagerInstance());
+
+        Account account = createAccount(ACCOUNT_NAME, ISSUER);
+        Mechanism push = createPushMechanism(ACCOUNT_NAME, ISSUER, MECHANISM_UID);
+        PushNotification notification = createPushNotification(MESSAGE_ID, push);
+
+        List<Mechanism> mechanismList= new ArrayList<>();
+        mechanismList.add(push);
+
+        List<PushNotification> notificationList = new ArrayList<>();
+        notificationList.add(createPushNotification(MESSAGE_ID, push));
+        notificationList.add(createPushNotification(OTHER_MESSAGE_ID, push));
+
+        given(storageClient.getAccount(any(String.class))).willReturn(account);
+        given(storageClient.getMechanismsForAccount(any(Account.class))).willReturn(mechanismList);
+        given(storageClient.getAllNotificationsForMechanism(any(Mechanism.class))).willReturn(notificationList);
+        given(storageClient.getNotificationByMessageId(anyString())).willReturn(notification);
+
+        PushNotification notificationFromStorage = fraClient.getNotificationByMessageId(notification.getMessageId());
+
+        assertNotNull(notificationFromStorage);
+        assertEquals(notification, notificationFromStorage);
+    }
+
     @Test
     public void testShouldNotGetStoredNotificationByID() throws Exception {
         FRAClient fraClient = FRAClient.builder()

forgerock-authenticator/src/test/java/org/forgerock/android/auth/NotificationFactoryTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2022 ForgeRock. All rights reserved.
+ * Copyright (c) 2020 - 2025 Ping Identity. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -26,6 +26,7 @@
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
 
+import java.util.Calendar;
 import java.util.Map;
 
 @RunWith(RobolectricTestRunner.class)
@@ -289,4 +290,20 @@ public void testShouldNotHandleRemoteUnableToPersist() throws Exception {
         }
     }
 
+    @Test
+    public void testShouldReturnExistingPushNotification() throws Exception {
+        RemoteMessage remoteMessage = generateMockRemoteMessage(MESSAGE_ID, CORRECT_SECRET, generateBaseMessage());
+        PushNotification storedPushNotification = createPushNotification(MECHANISM_UID, MESSAGE_ID, CHALLENGE,
+                AMLB_COOKIE, Calendar.getInstance(), TTL);
+        given(storageClient.getNotificationByMessageId(MESSAGE_ID)).willReturn(storedPushNotification);
+
+        PushNotification pushNotification = notificationFactory.handleMessage(remoteMessage);
+
+        assertNotNull(pushNotification);
+        assertEquals(MESSAGE_ID, pushNotification.getMessageId());
+        assertEquals(CHALLENGE, pushNotification.getChallenge());
+        assertEquals(MECHANISM_UID, pushNotification.getMechanismUID());
+        assertEquals(TTL, pushNotification.getTtl());
+    }
+
 }