Wrap updated params in a ConfigUpdate object.

Author: danasilver

firebase-config/api.txt

@@ -1,9 +1,14 @@
 // Signature format: 2.0
 package com.google.firebase.remoteconfig {
 
+  @com.google.auto.value.AutoValue public abstract class ConfigUpdate {
+    ctor public ConfigUpdate();
+    method @NonNull public static com.google.firebase.remoteconfig.ConfigUpdate create(@NonNull java.util.Set<java.lang.String>);
+  }
+
   public interface ConfigUpdateListener {
     method public void onError(@NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException);
-    method public void onUpdate(@NonNull java.util.Set<java.lang.String>);
+    method public void onUpdate(@NonNull com.google.firebase.remoteconfig.ConfigUpdate);
   }
 
   public interface ConfigUpdateListenerRegistration {

firebase-config/firebase-config.gradle

@@ -58,8 +58,11 @@ dependencies {
     implementation 'com.google.firebase:firebase-measurement-connector:18.0.0'
     implementation 'com.google.android.gms:play-services-tasks:18.0.1'
 
+    compileOnly 'com.google.auto.value:auto-value-annotations:1.6.6'
     compileOnly 'com.google.code.findbugs:jsr305:3.0.2'
 
+    annotationProcessor 'com.google.auto.value:auto-value:1.6.6'
+
     javadocClasspath 'com.google.auto.value:auto-value-annotations:1.6.6'
 
     testImplementation 'org.mockito:mockito-core:2.25.0'

firebase-config/src/main/java/com/google/firebase/remoteconfig/ConfigUpdate.java

@@ -0,0 +1,24 @@
+package com.google.firebase.remoteconfig;
+
+import androidx.annotation.NonNull;
+import com.google.auto.value.AutoValue;
+import java.util.Set;
+
+/**
+ * Information about the updated config passed to the {@code onUpdate} callback of {@link
+ * ConfigUpdateListener}.
+ */
+@AutoValue
+public abstract class ConfigUpdate {
+  @NonNull
+  public static ConfigUpdate create(@NonNull Set<String> updatedParams) {
+    return new AutoValue_ConfigUpdate(updatedParams);
+  }
+
+  /**
+   * Parameter keys whose values have been updated from the currently activated values. Includes
+   * keys that are added, deleted, and whose value, value source, or metadata has changed.
+   */
+  @NonNull
+  abstract Set<String> getUpdatedParams();
+}

firebase-config/src/main/java/com/google/firebase/remoteconfig/ConfigUpdateListener.java

@@ -15,8 +15,6 @@
 package com.google.firebase.remoteconfig;
 
 import androidx.annotation.NonNull;
-
-import java.util.Set;
 import javax.annotation.Nonnull;
 
 /**
@@ -29,11 +27,10 @@ public interface ConfigUpdateListener {
    * Callback for when a new config has been automatically fetched from the backend and has changed
    * from the activated config.
    *
-   * @param updatedParams The set of parameter keys changed from the currently activated values.
-   *     Includes keys that are: added; deleted; and whose value, value source, or metadata has
-   *     changed.
+   * @param configUpdate A {@link ConfigUpdate} with information about the updated config, including
+   *     the set of updated parameters.
    */
-  void onUpdate(@NonNull Set<String> updatedParams);
+  void onUpdate(@NonNull ConfigUpdate configUpdate);
 
   /**
    * Callback for when an error occurs while listening for or fetching a config update.

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java

@@ -21,6 +21,7 @@
 import androidx.annotation.VisibleForTesting;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.Tasks;
+import com.google.firebase.remoteconfig.ConfigUpdate;
 import com.google.firebase.remoteconfig.ConfigUpdateListener;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigClientException;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigException;
@@ -77,9 +78,9 @@ private synchronized void propagateErrors(FirebaseRemoteConfigException exceptio
     }
   }
 
-  private synchronized void executeAllListenerCallbacks(Set<String> updatedParams) {
+  private synchronized void executeAllListenerCallbacks(ConfigUpdate configUpdate) {
     for (ConfigUpdateListener listener : eventListeners) {
-      listener.onUpdate(updatedParams);
+      listener.onUpdate(configUpdate);
     }
   }
 
@@ -116,7 +117,7 @@ public void listenForNotifications() {
     }
 
     // TODO: Factor ConfigUpdateListener out of internal retry logic.
-    retryCallback.onUpdate(new HashSet<>());
+    retryCallback.onUpdate(ConfigUpdate.create(new HashSet<>()));
     executorService.shutdownNow();
     try {
       executorService.awaitTermination(3L, TimeUnit.SECONDS);
@@ -252,7 +253,8 @@ public synchronized Task<Void> fetchLatestConfig(int remainingAttempts, long tar
                 return Tasks.forResult(null);
               }
 
-              executeAllListenerCallbacks(updatedParams);
+              ConfigUpdate configUpdate = ConfigUpdate.create(updatedParams);
+              executeAllListenerCallbacks(configUpdate);
               return Tasks.forResult(null);
             });
   }

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigRealtimeHandler.java

@@ -19,6 +19,7 @@
 import androidx.annotation.NonNull;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.installations.FirebaseInstallationsApi;
+import com.google.firebase.remoteconfig.ConfigUpdate;
 import com.google.firebase.remoteconfig.ConfigUpdateListener;
 import com.google.firebase.remoteconfig.ConfigUpdateListenerRegistration;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigException;
@@ -162,7 +163,7 @@ public void remove() {
   public static class EmptyConfigUpdateListener implements ConfigUpdateListener {
 
     @Override
-    public void onUpdate(Set<String> updatedParams) {}
+    public void onUpdate(ConfigUpdate configUpdate) {}
 
     @Override
     public void onError(@NonNull FirebaseRemoteConfigException error) {}

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigRealtimeHttpClient.java

@@ -32,6 +32,7 @@
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.installations.FirebaseInstallationsApi;
 import com.google.firebase.installations.InstallationTokenResult;
+import com.google.firebase.remoteconfig.ConfigUpdate;
 import com.google.firebase.remoteconfig.ConfigUpdateListener;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigClientException;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigException;
@@ -292,7 +293,7 @@ public synchronized ConfigAutoFetch startAutoFetch(HttpURLConnection httpURLConn
     ConfigUpdateListener retryCallback =
         new ConfigUpdateListener() {
           @Override
-          public void onUpdate(Set<String> updatedParams) {
+          public void onUpdate(ConfigUpdate configUpdate) {
             closeRealtimeHttpStream();
             retryHTTPConnection();
           }

firebase-config/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java

@@ -28,6 +28,7 @@
 import static com.google.firebase.remoteconfig.internal.Personalization.EXTERNAL_PERSONALIZATION_ID_PARAM;
 import static com.google.firebase.remoteconfig.testutil.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.argThat;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.doAnswer;
@@ -304,8 +305,8 @@ public void setUp() throws Exception {
     ConfigUpdateListener listener =
         new ConfigUpdateListener() {
           @Override
-          public void onUpdate(Set<String> changedParams) {
-            mockOnUpdateListener.onUpdate(changedParams);
+          public void onUpdate(ConfigUpdate configUpdate) {
+            mockOnUpdateListener.onUpdate(configUpdate);
           }
 
           @Override
@@ -332,7 +333,7 @@ public void onError(@NonNull FirebaseRemoteConfigException error) {
             mockActivatedCache,
             listeners,
             mockRetryListener,
-                scheduledExecutorService);
+            scheduledExecutorService);
     configRealtimeHttpClient =
         new ConfigRealtimeHttpClient(
             firebaseApp,
@@ -342,7 +343,7 @@ public void onError(@NonNull FirebaseRemoteConfigException error) {
             context,
             "firebase",
             listeners,
-                scheduledExecutorService);
+            scheduledExecutorService);
   }
 
   @Test
@@ -1189,7 +1190,7 @@ public void realtime_stream_listen_and_retry_success() throws Exception {
     when(mockFetchHandler.fetch(0)).thenReturn(Tasks.forResult(realtimeFetchedContainerResponse));
     configAutoFetch.listenForNotifications();
 
-    verify(mockRetryListener).onUpdate(new HashSet<>());
+    verify(mockRetryListener).onUpdate(any());
   }
 
   @Test
@@ -1318,7 +1319,8 @@ public void realtime_stream_autofetch_success() throws Exception {
     flushScheduledTasks();
 
     Set<String> updatedParams = Sets.newHashSet("realtime_param");
-    verify(mockOnUpdateListener).onUpdate(updatedParams);
+    verify(mockOnUpdateListener)
+        .onUpdate(argThat(configUpdate -> configUpdate.getUpdatedParams().equals(updatedParams)));
   }
 
   @Test
@@ -1333,7 +1335,8 @@ public void realtime_autofetchBeforeActivate_callsOnUpdateWithAllFetchedParams()
     flushScheduledTasks();
 
     Set<String> updatedParams = Sets.newHashSet("string_param", "long_param", "realtime_param");
-    verify(mockOnUpdateListener).onUpdate(updatedParams);
+    verify(mockOnUpdateListener)
+        .onUpdate(argThat(configUpdate -> configUpdate.getUpdatedParams().equals(updatedParams)));
   }
 
   @Test
@@ -1441,7 +1444,7 @@ private void flushScheduledTasks() throws InterruptedException {
   private ConfigUpdateListener generateEmptyRealtimeListener() {
     return new ConfigUpdateListener() {
       @Override
-      public void onUpdate(Set<String> updatedParams) {}
+      public void onUpdate(ConfigUpdate configUpdate) {}
 
       @Override
       public void onError(@NonNull FirebaseRemoteConfigException error) {}