Skip to content

Fix fidchangelistener behavior #8193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eldhosembabu wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −7
Open

Fix fidchangelistener behavior #8193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions ...-installations/src/main/java/com/google/firebase/installations/FirebaseInstallations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,9 +392,11 @@ private void doNetworkCallIfNecessary(boolean forceRefresh) {
// be registered with the server or the FID is registered but we need a fresh authtoken.
// Registering will also result in a fresh authtoken. Do the appropriate step here.
PersistedInstallationEntry updatedPrefs;
boolean isNewFID = false;
try {
if (prefs.isErrored() || prefs.isUnregistered()) {
updatedPrefs = registerFidWithServer(prefs);
isNewFID = true;
} else if (forceRefresh || utils.isAuthTokenExpired(prefs)) {
updatedPrefs = fetchAuthTokenFromServer(prefs);
} else {
Expand All @@ -409,8 +411,12 @@ private void doNetworkCallIfNecessary(boolean forceRefresh) {
// Store the prefs to persist the result of the previous step.
insertOrUpdatePrefs(updatedPrefs);

// Update FidListener if a fid has changed.
updateFidListener(prefs, updatedPrefs);
// Update FidListener if a fid is new or has changed.
if (isNewFID
Copy link
Copy Markdown

@Doris-Ge Doris-Ge May 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It may be more readable to clearly define what means a new FID, e.g.:

boolean isNewFidRegistered(PersistedInstallationEntry prefs, PersistedInstallationEntry updatedPrefs) {
   if (!TextUtils.equals(
            prefs.getFirebaseInstallationId(), updatedPrefs.getFirebaseInstallationId()) {
       return true;
   }
   if (!prefs.isRegistered() && updatedPrefs.isRegistered()) {
       return true;
   }
   return false;
}

|| !TextUtils.equals(
prefs.getFirebaseInstallationId(), updatedPrefs.getFirebaseInstallationId())) {
updateFidListener(updatedPrefs);
}

prefs = updatedPrefs;

Expand All @@ -431,11 +437,10 @@ private void doNetworkCallIfNecessary(boolean forceRefresh) {
}
}

private synchronized void updateFidListener(
PersistedInstallationEntry prefs, PersistedInstallationEntry updatedPrefs) {
if (fidListeners.size() != 0
&& !TextUtils.equals(
prefs.getFirebaseInstallationId(), updatedPrefs.getFirebaseInstallationId())) {
private synchronized void updateFidListener(@NonNull PersistedInstallationEntry updatedPrefs) {
if (!fidListeners.isEmpty()
&& !TextUtils.isEmpty(updatedPrefs.getFirebaseInstallationId())
&& updatedPrefs.isRegistered()) {
// Update all the registered FidListener about fid changes.
for (FidListener listener : fidListeners) {
listener.onFidChanged(updatedPrefs.getFirebaseInstallationId());
Expand Down
59 changes: 59 additions & 0 deletions ...tallations/src/test/java/com/google/firebase/installations/FirebaseInstallationsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,65 @@ public void testFidListener_fidChanged_successful() throws Exception {
assertNull(fidListener2.getLatestFid());
}

@Test
public void testFidListener_fidRegistered_sameFid_successful() throws Exception {
when(mockIidStore.readIid()).thenReturn(null);
when(mockIidStore.readToken()).thenReturn(null);
when(mockBackend.createFirebaseInstallation(
anyString(), anyString(), anyString(), anyString(), any()))
.thenReturn(TEST_INSTALLATION_RESPONSE);

FakeFidListener fidListener = new FakeFidListener();

// Register the FidListener
firebaseInstallations.registerFidListener(fidListener);

// Do the actual getId() call under test.
TestOnCompleteListener<String> onCompleteListener = new TestOnCompleteListener<>();
Task<String> task = firebaseInstallations.getId();

task.addOnCompleteListener(backgroundExecutor, onCompleteListener);
String fid = onCompleteListener.await();
assertWithMessage("getId Task failed.").that(fid).isEqualTo(TEST_FID_1);

// Waiting for Task that registers FID on the FIS Servers
backgroundExecutor.awaitTermination(500, TimeUnit.MILLISECONDS);
PersistedInstallationEntry entry = persistedInstallation.readPersistedInstallationEntryValue();
assertThat(entry.getFirebaseInstallationId()).isEqualTo(TEST_FID_1);

// Verify FidListener receives fid registration notification.
assertThat(fidListener.getLatestFid()).isEqualTo(TEST_FID_1);
}

@Test
public void testFidListener_alreadyRegistered_noFidChange_notNotified() throws Exception {
persistedInstallation.insertOrUpdatePersistedInstallationEntry(
PersistedInstallationEntry.INSTANCE.withRegisteredFid(
TEST_FID_1,
TEST_REFRESH_TOKEN,
utils.currentTimeInSecs(),
TEST_AUTH_TOKEN,
TEST_TOKEN_EXPIRATION_TIMESTAMP));

FakeFidListener fidListener = new FakeFidListener();

// Register the FidListener
firebaseInstallations.registerFidListener(fidListener);

// Do the actual getId() call under test.
TestOnCompleteListener<String> onCompleteListener = new TestOnCompleteListener<>();
Task<String> task = firebaseInstallations.getId();
task.addOnCompleteListener(backgroundExecutor, onCompleteListener);
String fid = onCompleteListener.await();
assertWithMessage("getId Task failed.").that(fid).isEqualTo(TEST_FID_1);

backgroundExecutor.awaitTermination(500, TimeUnit.MILLISECONDS);

// Verify FidListener does not receive any notification since the FID was already registered
// and didn't change.
assertNull(fidListener.getLatestFid());
}

@Test
public void testGetId_migrateIid_successful() throws Exception {
when(mockIidStore.readIid()).thenReturn(TEST_INSTANCE_ID_1);
Expand Down
Loading