Merge remote-tracking branch 'remotes/origin/mila/BloomFilter' into BloomFilterComplexIntegrationTest

Author: dconeybe

.github/workflows/build-release-artifacts.yml

@@ -8,7 +8,8 @@ on:
 
 jobs:
   build-artifacts:
-    runs-on: ubuntu-latest
+    # TODO(b/271315039) - Revert back to ubuntu when fixed
+    runs-on: macos-latest
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:

encoders/firebase-encoders-json/firebase-encoders-json.gradle

@@ -14,6 +14,7 @@
 
 plugins {
     id 'firebase-library'
+    id 'kotlin-android'
 }
 
 firebaseLibrary {
@@ -24,16 +25,19 @@ firebaseLibrary {
 android {
     compileSdkVersion project.targetSdkVersion
     defaultConfig {
-      minSdkVersion project.minSdkVersion
-      targetSdkVersion project.targetSdkVersion
-      versionName version
-      testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        minSdkVersion project.minSdkVersion
+        targetSdkVersion project.targetSdkVersion
+        versionName version
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
     testOptions {
         unitTests {
             includeAndroidResources = true

encoders/firebase-encoders-json/src/main/java/com/google/firebase/encoders/json/JsonValueObjectEncoderContext.java

@@ -317,7 +317,11 @@ JsonValueObjectEncoderContext add(@Nullable Object o, boolean inline) throws IOE
 
     // Process enum last if it does not have a custom encoder registered.
     if (o instanceof Enum) {
-      add(((Enum) o).name());
+      if (o instanceof NumberedEnum) {
+        add(((NumberedEnum) o).getNumber());
+      } else {
+        add(((Enum<?>) o).name());
+      }
       return this;
     }
 

encoders/firebase-encoders-json/src/main/java/com/google/firebase/encoders/json/NumberedEnum.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.firebase.encoders.json
+
+/** Represents an explicitly numbered enum for json serialization. */
+interface NumberedEnum {
+  val number: Int
+}

encoders/firebase-encoders-json/src/test/java/com/google/firebase/encoders/json/DummyEnum.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.firebase.encoders.json
+
+internal enum class DummyEnum(override val number: Int) : NumberedEnum {
+  VALUE_1(1),
+  VALUE_2(2),
+}

encoders/firebase-encoders-json/src/test/java/com/google/firebase/encoders/json/JsonValueObjectEncoderContextTest.java

@@ -219,6 +219,18 @@ public void testEncodingEnum_withCustomEncoder() {
     assertThat(result).isEqualTo("[\"value_1\",\"value_2\"]");
   }
 
+  @Test
+  public void testEncodingNumberedEnum() {
+    String result =
+        new JsonDataEncoderBuilder()
+            .build()
+            .encode(
+                new DummyEnum[] {
+                  DummyEnum.VALUE_1, DummyEnum.VALUE_2, DummyEnum.VALUE_1, DummyEnum.VALUE_1
+                });
+    assertThat(result).isEqualTo("[1,2,1,1]");
+  }
+
   @Test
   public void testEncodingCollection() throws IOException {
     ObjectEncoder<InnerDummyClass> anotherObjectEncoder =

firebase-appdistribution/firebase-appdistribution.gradle

@@ -52,7 +52,7 @@ dependencies {
     implementation 'com.google.firebase:firebase-common:20.3.1'
     testImplementation project(path: ':firebase-appdistribution')
     testImplementation project(':integ-testing')
-    runtimeOnly project(':firebase-installations')
+    runtimeOnly 'com.google.firebase:firebase-installations:17.1.2'
 
     implementation libs.javax.inject
     vendor (libs.dagger.dagger) {

firebase-appdistribution/test-app/test-app.gradle

@@ -76,7 +76,7 @@ dependencies {
 
     // In this test project we also need to explicitly declare these dependencies
     implementation project(':firebase-appdistribution-api')
-    implementation project(':firebase-common:ktx')
+    implementation 'com.google.firebase:firebase-common-ktx:20.3.1'
     implementation "com.google.android.gms:play-services-tasks:18.0.2"
 
     // Beta flavor uses the full implementation

firebase-config/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Unreleased
+* [feature] Added support for real-time config updates. To learn more, see [Get started with Firebase Remote Config](https://firebase.google.com/docs/remote-config/get-started?platform=android).
 
 # 21.2.1
 * [changed] Migrated [remote_config] to use standard Firebase executors.

firebase-config/api.txt

@@ -1,8 +1,24 @@
 // 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>);
+    method @NonNull public abstract java.util.Set<java.lang.String> getUpdatedKeys();
+  }
+
+  public interface ConfigUpdateListener {
+    method public void onError(@NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException);
+    method public void onUpdate(@NonNull com.google.firebase.remoteconfig.ConfigUpdate);
+  }
+
+  public interface ConfigUpdateListenerRegistration {
+    method public void remove();
+  }
+
   public class FirebaseRemoteConfig {
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Boolean> activate();
+    method @NonNull public com.google.firebase.remoteconfig.ConfigUpdateListenerRegistration addOnConfigUpdateListener(@NonNull com.google.firebase.remoteconfig.ConfigUpdateListener);
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.remoteconfig.FirebaseRemoteConfigInfo> ensureInitialized();
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> fetch();
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> fetch(long);
@@ -38,11 +54,25 @@ package com.google.firebase.remoteconfig {
   public class FirebaseRemoteConfigClientException extends com.google.firebase.remoteconfig.FirebaseRemoteConfigException {
     ctor public FirebaseRemoteConfigClientException(@NonNull String);
     ctor public FirebaseRemoteConfigClientException(@NonNull String, @Nullable Throwable);
+    ctor public FirebaseRemoteConfigClientException(@NonNull String, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
+    ctor public FirebaseRemoteConfigClientException(@NonNull String, @Nullable Throwable, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
   }
 
   public class FirebaseRemoteConfigException extends com.google.firebase.FirebaseException {
     ctor public FirebaseRemoteConfigException(@NonNull String);
     ctor public FirebaseRemoteConfigException(@NonNull String, @Nullable Throwable);
+    ctor public FirebaseRemoteConfigException(@NonNull String, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
+    ctor public FirebaseRemoteConfigException(@NonNull String, @Nullable Throwable, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
+    method @NonNull public com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code getCode();
+  }
+
+  public enum FirebaseRemoteConfigException.Code {
+    method public int value();
+    enum_constant public static final com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code CONFIG_UPDATE_MESSAGE_INVALID;
+    enum_constant public static final com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code CONFIG_UPDATE_NOT_FETCHED;
+    enum_constant public static final com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code CONFIG_UPDATE_STREAM_ERROR;
+    enum_constant public static final com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code CONFIG_UPDATE_UNAVAILABLE;
+    enum_constant public static final com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code UNKNOWN;
   }
 
   public class FirebaseRemoteConfigFetchThrottledException extends com.google.firebase.remoteconfig.FirebaseRemoteConfigException {
@@ -59,6 +89,10 @@ package com.google.firebase.remoteconfig {
   public class FirebaseRemoteConfigServerException extends com.google.firebase.remoteconfig.FirebaseRemoteConfigException {
     ctor public FirebaseRemoteConfigServerException(int, @NonNull String);
     ctor public FirebaseRemoteConfigServerException(int, @NonNull String, @Nullable Throwable);
+    ctor public FirebaseRemoteConfigServerException(@NonNull String, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
+    ctor public FirebaseRemoteConfigServerException(int, @NonNull String, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
+    ctor public FirebaseRemoteConfigServerException(@NonNull String, @Nullable Throwable, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
+    ctor public FirebaseRemoteConfigServerException(int, @NonNull String, @Nullable Throwable, @NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code);
     method public int getHttpStatusCode();
   }
 

firebase-config/firebase-config.gradle

@@ -59,8 +59,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/ktx/src/test/kotlin/com/google/firebase/remoteconfig/TestConstructorUtil.kt

@@ -22,6 +22,7 @@ import com.google.firebase.remoteconfig.internal.ConfigCacheClient
 import com.google.firebase.remoteconfig.internal.ConfigFetchHandler
 import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler
 import com.google.firebase.remoteconfig.internal.ConfigMetadataClient
+import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler
 import java.util.concurrent.Executor
 
 // This method is a workaround for testing. It enable us to create a FirebaseRemoteConfig object
@@ -37,7 +38,8 @@ fun createRemoteConfig(
   defaultConfigsCache: ConfigCacheClient,
   fetchHandler: ConfigFetchHandler,
   getHandler: ConfigGetParameterHandler,
-  frcMetadata: ConfigMetadataClient
+  frcMetadata: ConfigMetadataClient,
+  realtimeHandler: ConfigRealtimeHandler
 ): FirebaseRemoteConfig {
   return FirebaseRemoteConfig(
     context,
@@ -50,6 +52,7 @@ fun createRemoteConfig(
     defaultConfigsCache,
     fetchHandler,
     getHandler,
-    frcMetadata
+    frcMetadata,
+    realtimeHandler
   )
 }

firebase-config/ktx/src/test/kotlin/com/google/firebase/remoteconfig/ktx/RemoteConfigTests.kt

@@ -31,6 +31,7 @@ import com.google.firebase.remoteconfig.internal.ConfigCacheClient
 import com.google.firebase.remoteconfig.internal.ConfigFetchHandler
 import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler
 import com.google.firebase.remoteconfig.internal.ConfigMetadataClient
+import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler
 import org.junit.After
 import org.junit.Before
 import org.junit.Test
@@ -138,7 +139,8 @@ class ConfigTests : BaseTestCase() {
         defaultConfigsCache = mock(ConfigCacheClient::class.java),
         fetchHandler = mock(ConfigFetchHandler::class.java),
         getHandler = mockGetHandler,
-        frcMetadata = mock(ConfigMetadataClient::class.java)
+        frcMetadata = mock(ConfigMetadataClient::class.java),
+        realtimeHandler = mock(ConfigRealtimeHandler::class.java)
       )
 
     `when`(mockGetHandler.getValue("KEY")).thenReturn(StringRemoteConfigValue("non default value"))

firebase-config/src/androidTest/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigIntegrationTest.java

@@ -36,6 +36,7 @@
 import com.google.firebase.remoteconfig.internal.ConfigFetchHandler;
 import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler;
 import com.google.firebase.remoteconfig.internal.ConfigMetadataClient;
+import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
@@ -59,6 +60,7 @@ public class FirebaseRemoteConfigIntegrationTest {
   @Mock private ConfigFetchHandler mockFetchHandler;
   @Mock private ConfigGetParameterHandler mockGetHandler;
   @Mock private ConfigMetadataClient metadataClient;
+  @Mock private ConfigRealtimeHandler mockConfigRealtimeHandler;
 
   @Mock private ConfigCacheClient mockFireperfFetchedCache;
   @Mock private ConfigCacheClient mockFireperfActivatedCache;
@@ -108,7 +110,8 @@ public void setUp() {
             mockDefaultsCache,
             mockFetchHandler,
             mockGetHandler,
-            metadataClient);
+            metadataClient,
+            mockConfigRealtimeHandler);
   }
 
   @Test

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

@@ -0,0 +1,39 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+//
+// You may obtain a copy of the License at
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+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
+  /** @hide */
+  public static ConfigUpdate create(@NonNull Set<String> updatedKeys) {
+    return new AutoValue_ConfigUpdate(updatedKeys);
+  }
+
+  /**
+   * 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
+  public abstract Set<String> getUpdatedKeys();
+}

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

@@ -0,0 +1,40 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+//
+// You may obtain a copy of the License at
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.remoteconfig;
+
+import androidx.annotation.NonNull;
+import javax.annotation.Nonnull;
+
+/**
+ * Event listener interface for real-time RC updates. Implement {@code ConfigUpdateListner} to call
+ * {@link com.google.firebase.remoteconfig.FirebaseRemoteConfig#addOnConfigUpdateListener}.
+ */
+public interface ConfigUpdateListener {
+  /**
+   * Callback for when a new config has been automatically fetched from the backend and has changed
+   * from the activated config.
+   *
+   * @param configUpdate A {@link ConfigUpdate} with information about the updated config, including
+   *     the set of updated parameters.
+   */
+  void onUpdate(@NonNull ConfigUpdate configUpdate);
+
+  /**
+   * Callback for when an error occurs while listening or fetching a config update.
+   *
+   * @param error A {@link FirebaseRemoteConfigException} with information about the error.
+   */
+  void onError(@Nonnull FirebaseRemoteConfigException error);
+}