Merge branch 'master' into rosalyntan.fac-limited

Author: rosalyntan

.github/workflows/fireperf-e2e.yml

@@ -93,7 +93,7 @@ jobs:
                 title: 'FirePerf E2E Test Failures',
                 body: text,
                 labels: ['fireperf-e2e-tests'],
-                assignees: ['jeremyjiang-dev', 'leotianlizhan', 'raymondlam', 'visumickey']
+                assignees: ['raymondlam', 'visumickey']
               });
             }
       - name: Upload test artifacts

buildSrc/src/main/java/com/google/firebase/gradle/plugins/ModuleVersion.kt

@@ -61,9 +61,9 @@ enum class PreReleaseVersionType {
  * "12.13.1-beta" // 12.13.1-beta01
  * ```
  *
- * @see fromStringsOrNull
  * @property type an enum of [PreReleaseVersionType] that identifies the pre-release identifier
  * @property build an [Int] that specifies the build number; defaults to one
+ * @see fromStringsOrNull
  */
 data class PreReleaseVersion(val type: PreReleaseVersionType, val build: Int = 1) :
   Comparable<PreReleaseVersion> {
@@ -124,11 +124,11 @@ data class PreReleaseVersion(val type: PreReleaseVersionType, val build: Int = 1
  *
  * To see rules about pre-release (`PRE`) formatting, see [PreReleaseVersion].
  *
- * @see fromStringOrNull
  * @property major An update that represents breaking changes
  * @property minor An update that represents new functionality
  * @property patch An update that represents bug fixes
  * @property pre An update that represents unstable changes not ready for a full release
+ * @see fromStringOrNull
  */
 data class ModuleVersion(
   val major: Int,

firebase-config/CHANGELOG.md

@@ -1,10 +1,15 @@
 # Unreleased
+* [unchanged] Updated to accommodate the release of the updated
+  [remote_config] Kotlin extensions library.
+
+## Kotlin
+* [feature] Added the `FirebaseRemoteConfig.configUpdates` Kotlin Flow to listen for real-time
+  config updates.
 
 # 21.3.0
 * [feature] Added support for real-time config updates. To learn more, see
   [Get started with [firebase_remote_config]](/docs/remote-config/get-started?platform=android#add-real-time-listener).
 
-
 ## Kotlin
 The Kotlin extensions library transitively includes the updated
 `firebase-config` library. The Kotlin extensions library has no additional

firebase-config/bandwagoner/bandwagoner.gradle

@@ -16,6 +16,10 @@
 
 apply plugin: 'com.android.application'
 apply plugin: com.google.firebase.gradle.plugins.ci.device.FirebaseTestLabPlugin
+apply plugin: 'org.jetbrains.kotlin.android'
+
+// Uncomment this line after adding a google-services.json file to the project.
+// apply plugin: 'com.google.gms.google-services'
 
 android {
     compileSdkVersion project.targetSdkVersion
@@ -59,11 +63,16 @@ firebaseTestLab {
 }
 
 dependencies {
+    // Depend on development artifacts for Remote Config.
     implementation project(":firebase-config")
-    // This is required since a project dependency on frc does not expose the Apis of its "implementation" dependencies.
-    // The alternative would be to make common an "api" dep of remote-config.
-    // It should not matter for released artifacts.
-    implementation "com.google.firebase:firebase-common:20.3.1"
+    implementation project(":firebase-config:ktx")
+
+    // This is required since a `project` dependency on frc does not expose the APIs of its
+    // "implementation" dependencies. The alternative would be to make common an "api" dep of remote-config.
+    // Released artifacts don't need these dependencies since they don't use `project` to refer
+    // to Remote Config.
+    implementation "com.google.firebase:firebase-common:20.3.2"
+    implementation 'com.google.firebase:firebase-common-ktx:20.3.2'
     implementation "com.google.firebase:firebase-components:17.1.0"
 
     implementation project(":firebase-installations-interop")
@@ -75,6 +84,7 @@ dependencies {
     // Support Libraries
     implementation 'com.google.guava:guava:28.1-android'
     implementation 'androidx.legacy:legacy-support-v4:1.0.0'
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:1.6.4"
 
     implementation 'androidx.appcompat:appcompat:1.0.2'
     implementation 'androidx.annotation:annotation:1.1.0'

firebase-config/bandwagoner/src/main/java/com/googletest/firebase/remoteconfig/bandwagoner/RealtimeKtListener.kt

@@ -0,0 +1,44 @@
+/*
+ * 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.googletest.firebase.remoteconfig.bandwagoner
+
+import android.util.Log
+import com.google.firebase.ktx.Firebase
+import com.google.firebase.remoteconfig.ktx.configUpdates
+import com.google.firebase.remoteconfig.ktx.remoteConfig
+import java.util.concurrent.CompletableFuture
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.flow.catch
+import kotlinx.coroutines.future.future
+
+class RealtimeKtListener {
+  companion object {
+    private val TAG = "RealtimeListener"
+
+    fun listenForUpdatesAsync(): CompletableFuture<Unit> = GlobalScope.future { listenForUpdates() }
+
+    private suspend fun listenForUpdates() {
+      Firebase.remoteConfig.configUpdates
+        .catch { exception -> Log.w(TAG, "Error listening for updates!", exception) }
+        .collect { configUpdate ->
+          if (configUpdate.updatedKeys.contains("welcome_message")) {
+            Firebase.remoteConfig.activate()
+          }
+        }
+    }
+  }
+}

firebase-config/ktx/api.txt

@@ -3,6 +3,7 @@ package com.google.firebase.remoteconfig.ktx {
 
   public final class RemoteConfigKt {
     method @NonNull public static operator com.google.firebase.remoteconfig.FirebaseRemoteConfigValue get(@NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfig, @NonNull String key);
+    method @NonNull public static kotlinx.coroutines.flow.Flow<com.google.firebase.remoteconfig.ConfigUpdate> getConfigUpdates(@NonNull com.google.firebase.remoteconfig.FirebaseRemoteConfig);
     method @NonNull public static com.google.firebase.remoteconfig.FirebaseRemoteConfig getRemoteConfig(@NonNull com.google.firebase.ktx.Firebase);
     method @NonNull public static com.google.firebase.remoteconfig.FirebaseRemoteConfig remoteConfig(@NonNull com.google.firebase.ktx.Firebase, @NonNull com.google.firebase.FirebaseApp app);
     method @NonNull public static com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings remoteConfigSettings(@NonNull kotlin.jvm.functions.Function1<? super com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings.Builder,kotlin.Unit> init);

firebase-config/ktx/src/main/kotlin/com/google/firebase/remoteconfig/ktx/RemoteConfig.kt

@@ -20,9 +20,17 @@ import com.google.firebase.components.Component
 import com.google.firebase.components.ComponentRegistrar
 import com.google.firebase.ktx.Firebase
 import com.google.firebase.platforminfo.LibraryVersionComponent
+import com.google.firebase.remoteconfig.ConfigUpdate
+import com.google.firebase.remoteconfig.ConfigUpdateListener
 import com.google.firebase.remoteconfig.FirebaseRemoteConfig
+import com.google.firebase.remoteconfig.FirebaseRemoteConfigException
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigValue
+import kotlinx.coroutines.cancel
+import kotlinx.coroutines.channels.awaitClose
+import kotlinx.coroutines.channels.trySendBlocking
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.callbackFlow
 
 /** Returns the [FirebaseRemoteConfig] instance of the default [FirebaseApp]. */
 val Firebase.remoteConfig: FirebaseRemoteConfig
@@ -45,6 +53,31 @@ fun remoteConfigSettings(
   return builder.build()
 }
 
+/**
+ * Starts listening for config updates from the Remote Config backend and emits [ConfigUpdate]s via
+ * a [Flow]. See [FirebaseRemoteConfig.addOnConfigUpdateListener] for more information.
+ *
+ * - When the returned flow starts being collected, an [ConfigUpdateListener] will be attached.
+ * - When the flow completes, the listener will be removed. If there are no attached listeners, the
+ * connection to the Remote Config backend will be closed.
+ */
+val FirebaseRemoteConfig.configUpdates
+  get() = callbackFlow {
+    val registration =
+      addOnConfigUpdateListener(
+        object : ConfigUpdateListener {
+          override fun onUpdate(configUpdate: ConfigUpdate) {
+            schedule { trySendBlocking(configUpdate) }
+          }
+
+          override fun onError(error: FirebaseRemoteConfigException) {
+            cancel(message = "Error listening for config updates.", cause = error)
+          }
+        }
+      )
+    awaitClose { registration.remove() }
+  }
+
 internal const val LIBRARY_NAME: String = "fire-cfg-ktx"
 
 /** @suppress */

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

@@ -582,6 +582,15 @@ void startLoadingConfigsFromDisk() {
     fetchedConfigsCache.get();
   }
 
+  /**
+   * Execute a runnable in Remote Config's background thread pool.
+   *
+   * @hide
+   */
+  public void schedule(Runnable runnable) {
+    executor.execute(runnable);
+  }
+
   /**
    * Processes the result of the put task that persists activated configs. If the task is
    * successful, clears the fetched cache and updates the ABT SDK with the current experiments.

firebase-database/gradle.properties

@@ -12,6 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-version=20.1.1
+version=20.2.0
 latestReleasedVersion=20.1.0
 android.enableUnitTestBinaryResources=true

firebase-perf/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 * [changed] Updated javalite, protoc, protobufjavautil to 3.21.11.
+* [changed] Updated [perfmon] to use Double precision for sampling.
 
 # 20.3.1
 * [changed] Migrated [perfmon] to use standard Firebase executors.

firebase-perf/src/main/java/com/google/firebase/perf/config/ConfigResolver.java

@@ -286,22 +286,22 @@ private boolean isFireperfSdkVersionInList(String versions) {
   }
 
   /** Returns what percentage of Traces should be collected, range is [0.00f, 1.00f]. */
-  public float getTraceSamplingRate() {
+  public double getTraceSamplingRate() {
     // Order of precedence is:
     // 1. If the value exists through Firebase Remote Config, cache and return this value.
     // 2. If the value exists in device cache, return this value.
     // 3. Otherwise, return default value.
     TraceSamplingRate config = TraceSamplingRate.getInstance();
 
     // 1. Reads value from Firebase Remote Config, saves this value in cache layer if valid.
-    Optional<Float> rcValue = getRemoteConfigFloat(config);
+    Optional<Double> rcValue = getRemoteConfigDouble(config);
     if (rcValue.isAvailable() && isSamplingRateValid(rcValue.get())) {
       deviceCacheManager.setValue(config.getDeviceCacheFlag(), rcValue.get());
       return rcValue.get();
     }
 
     // 2. Reads value from cache layer.
-    Optional<Float> deviceCacheValue = getDeviceCacheFloat(config);
+    Optional<Double> deviceCacheValue = getDeviceCacheDouble(config);
     if (deviceCacheValue.isAvailable() && isSamplingRateValid(deviceCacheValue.get())) {
       return deviceCacheValue.get();
     }
@@ -311,22 +311,22 @@ public float getTraceSamplingRate() {
   }
 
   /** Returns what percentage of NetworkRequest should be collected, range is [0.00f, 1.00f]. */
-  public float getNetworkRequestSamplingRate() {
+  public double getNetworkRequestSamplingRate() {
     // Order of precedence is:
     // 1. If the value exists through Firebase Remote Config, cache and return this value.
     // 2. If the value exists in device cache, return this value.
     // 3. Otherwise, return default value.
     NetworkRequestSamplingRate config = NetworkRequestSamplingRate.getInstance();
 
     // 1. Reads value from Firebase Remote Config, saves this value in cache layer if valid.
-    Optional<Float> rcValue = getRemoteConfigFloat(config);
+    Optional<Double> rcValue = getRemoteConfigDouble(config);
     if (rcValue.isAvailable() && isSamplingRateValid(rcValue.get())) {
       deviceCacheManager.setValue(config.getDeviceCacheFlag(), rcValue.get());
       return rcValue.get();
     }
 
     // 2. Reads value from cache layer.
-    Optional<Float> deviceCacheValue = getDeviceCacheFloat(config);
+    Optional<Double> deviceCacheValue = getDeviceCacheDouble(config);
     if (deviceCacheValue.isAvailable() && isSamplingRateValid(deviceCacheValue.get())) {
       return deviceCacheValue.get();
     }
@@ -336,7 +336,7 @@ public float getNetworkRequestSamplingRate() {
   }
 
   /** Returns what percentage of Session gauge should be collected, range is [0.00f, 1.00f]. */
-  public float getSessionsSamplingRate() {
+  public double getSessionsSamplingRate() {
     // Order of precedence is:
     // 1. If the value exists in Android Manifest, convert from [0.00f, 100.00f] to [0.00f, 1.00f]
     // and return this value.
@@ -346,24 +346,24 @@ public float getSessionsSamplingRate() {
     SessionsSamplingRate config = SessionsSamplingRate.getInstance();
 
     // 1. Reads value in Android Manifest (it is set by developers during build time).
-    Optional<Float> metadataValue = getMetadataFloat(config);
+    Optional<Double> metadataValue = getMetadataDouble(config);
     if (metadataValue.isAvailable()) {
       // Sampling percentage from metadata needs to convert from [0.00f, 100.00f] to [0.00f, 1.00f].
-      float samplingRate = metadataValue.get() / 100.0f;
+      double samplingRate = metadataValue.get() / 100;
       if (isSamplingRateValid(samplingRate)) {
         return samplingRate;
       }
     }
 
     // 2. Reads value from Firebase Remote Config, saves this value in cache layer if valid.
-    Optional<Float> rcValue = getRemoteConfigFloat(config);
+    Optional<Double> rcValue = getRemoteConfigDouble(config);
     if (rcValue.isAvailable() && isSamplingRateValid(rcValue.get())) {
       deviceCacheManager.setValue(config.getDeviceCacheFlag(), rcValue.get());
       return rcValue.get();
     }
 
     // 3. Reads value from cache layer.
-    Optional<Float> deviceCacheValue = getDeviceCacheFloat(config);
+    Optional<Double> deviceCacheValue = getDeviceCacheDouble(config);
     if (deviceCacheValue.isAvailable() && isSamplingRateValid(deviceCacheValue.get())) {
       return deviceCacheValue.get();
     }
@@ -732,7 +732,7 @@ public String getAndCacheLogSourceName() {
   }
 
   /** Returns what percentage of fragment traces should be collected, range is [0.00f, 1.00f]. */
-  public float getFragmentSamplingRate() {
+  public double getFragmentSamplingRate() {
     // Order of precedence is:
     // 1. If the value exists in Android Manifest, convert from [0.00f, 100.00f] to [0.00f, 1.00f]
     // and return this value.
@@ -742,24 +742,24 @@ public float getFragmentSamplingRate() {
     FragmentSamplingRate config = FragmentSamplingRate.getInstance();
 
     // 1. Reads value in Android Manifest (it is set by developers during build time).
-    Optional<Float> metadataValue = getMetadataFloat(config);
+    Optional<Double> metadataValue = getMetadataDouble(config);
     if (metadataValue.isAvailable()) {
       // Sampling percentage from metadata needs to convert from [0.00f, 100.00f] to [0.00f, 1.00f].
-      float samplingRate = metadataValue.get() / 100.0f;
+      double samplingRate = metadataValue.get() / 100.0f;
       if (isSamplingRateValid(samplingRate)) {
         return samplingRate;
       }
     }
 
     // 2. Reads value from Firebase Remote Config, saves this value in cache layer if valid.
-    Optional<Float> rcValue = getRemoteConfigFloat(config);
+    Optional<Double> rcValue = getRemoteConfigDouble(config);
     if (rcValue.isAvailable() && isSamplingRateValid(rcValue.get())) {
       deviceCacheManager.setValue(config.getDeviceCacheFlag(), rcValue.get());
       return rcValue.get();
     }
 
     // 3. Reads value from cache layer.
-    Optional<Float> deviceCacheValue = getDeviceCacheFloat(config);
+    Optional<Double> deviceCacheValue = getDeviceCacheDouble(config);
     if (deviceCacheValue.isAvailable() && isSamplingRateValid(deviceCacheValue.get())) {
       return deviceCacheValue.get();
     }
@@ -807,17 +807,17 @@ private Optional<Boolean> getMetadataBoolean(ConfigurationFlag<Boolean> config)
     return metadataBundle.getBoolean(config.getMetadataFlag());
   }
 
-  private Optional<Float> getMetadataFloat(ConfigurationFlag<Float> config) {
-    return metadataBundle.getFloat(config.getMetadataFlag());
+  private Optional<Double> getMetadataDouble(ConfigurationFlag<Double> config) {
+    return metadataBundle.getDouble(config.getMetadataFlag());
   }
 
   private Optional<Long> getMetadataLong(ConfigurationFlag<Long> config) {
     return metadataBundle.getLong(config.getMetadataFlag());
   }
 
   // Helper functions for interaction with Firebase Remote Config.
-  private Optional<Float> getRemoteConfigFloat(ConfigurationFlag<Float> config) {
-    return remoteConfigManager.getFloat(config.getRemoteConfigFlag());
+  private Optional<Double> getRemoteConfigDouble(ConfigurationFlag<Double> config) {
+    return remoteConfigManager.getDouble(config.getRemoteConfigFlag());
   }
 
   private Optional<Long> getRemoteConfigLong(ConfigurationFlag<Long> config) {
@@ -841,8 +841,8 @@ private Long getRemoteConfigValue(ConfigurationFlag<Long> configFlag) {
   }
 
   // Helper functions for interaction with Device Caching layer.
-  private Optional<Float> getDeviceCacheFloat(ConfigurationFlag<Float> config) {
-    return deviceCacheManager.getFloat(config.getDeviceCacheFlag());
+  private Optional<Double> getDeviceCacheDouble(ConfigurationFlag<Double> config) {
+    return deviceCacheManager.getDouble(config.getDeviceCacheFlag());
   }
 
   private Optional<Long> getDeviceCacheLong(ConfigurationFlag<Long> config) {
@@ -858,7 +858,7 @@ private Optional<String> getDeviceCacheString(ConfigurationFlag<String> config)
   }
 
   // Helper functions for config value validation.
-  private boolean isSamplingRateValid(float samplingRate) {
+  private boolean isSamplingRateValid(double samplingRate) {
     return MIN_SAMPLING_RATE <= samplingRate && samplingRate <= MAX_SAMPLING_RATE;
   }