Merge Realtime RC to main (#1296)

Merges Realtime RC branch to main.

RemoteConfig API change:
RemoteConfig.AddConfigUpdateListener, takes a listener function as parameter, returns a registration. enables auto-fetching of configs
ConfigUpdateRegistration: has a Remove method to remove the listener.
Listener function takes a ConfigUpdate and error code as parameters.
ConfigUpdate has a set of updated keys.

Currently supported on iOS and Android. Desktop implementation is still a stub.

Author: AlmostMatt

Android/firebase_dependencies.gradle

@@ -51,6 +51,7 @@ def firebaseResourceDependenciesMap = [
   'database' : [':database:database_resources'],
   'firestore' : [':firestore:firestore_resources'],
   'gma' : [':gma:gma_resources'],
+  'remote_config' : [':remote_config:remote_config_resources'],
   'storage' : [':storage:storage_resources']
 ]
 

app/CMakeLists.txt

@@ -555,7 +555,8 @@ if (IOS)
   set(messaging_HDRS
     ${FIREBASE_SOURCE_DIR}/messaging/src/include/firebase/messaging.h)
   set(remote_config_HDRS
-    ${FIREBASE_SOURCE_DIR}/remote_config/src/include/firebase/remote_config.h)
+    ${FIREBASE_SOURCE_DIR}/remote_config/src/include/firebase/remote_config.h
+    ${FIREBASE_SOURCE_DIR}/remote_config/src/include/firebase/remote_config/config_update_listener_registration.h)
   set(storage_HDRS
     ${FIREBASE_SOURCE_DIR}/storage/src/include/firebase/storage.h
     ${FIREBASE_SOURCE_DIR}/storage/src/include/firebase/storage/common.h

release_build_files/readme.md

@@ -616,6 +616,12 @@ code.
     - Firestore: Added `Query::Count()`, which fetches the number of documents
       in the result set without actually downloading the documents
       ([#1207](https://github.com/firebase/firebase-cpp-sdk/pull/1207)).
+    - Remote Config: Added support for real-time config updates. Use the new
+      `addOnConfigUpdateListener` API to get real-time updates. Existing
+      [`Fetch`](https://firebase.google.com/docs/reference/cpp/class/firebase/remote-config/remote-config#fetch)
+      and [`Activate`](https://firebase.google.com/docs/reference/cpp/class/firebase/remote-config/remote-config#activate)
+      APIs aren't affected by this change. To learn more, see
+  [Get started with Firebase Remote Config](https://firebase.google.com/docs/remote-config/get-started?platform=cpp#add-real-time-listener).
 
 ### 10.7.0
 -   Changes

remote_config/CMakeLists.txt

@@ -45,10 +45,23 @@ build_flatbuffers("${flatbuffer_schemas}"
 # Common source files used by all platforms
 set(common_SRCS
     src/common.cc
+    src/cleanup.h
+    src/config_update_listener_registration.cc
+    src/config_update_listener_registration_internal.cc
     src/remote_config.cc)
 
+
+# Run gradle command to make jar
+firebase_cpp_gradle(":remote_config:remote_config_resources:generateDexJarRelease"
+    "${CMAKE_CURRENT_LIST_DIR}/remote_config_resources/build/remote_config_resources_lib.jar")
+binary_to_array("remote_config_resources"
+    "${CMAKE_CURRENT_LIST_DIR}/remote_config_resources/build/remote_config_resources_lib.jar"
+    "firebase_remote_config"
+    "${FIREBASE_GEN_FILE_DIR}/remote_config")
+
 # Source files used by the Android implementation.
 set(android_SRCS
+    ${remote_config_resources_source}
     src/android/remote_config_android.cc)
 
 # Source files used by the iOS implementation.

remote_config/build.gradle

@@ -84,4 +84,5 @@ apply from: "$rootDir/android_build_files/extract_and_dex.gradle"
 apply from: "$rootDir/android_build_files/generate_proguard.gradle"
 project.afterEvaluate {
   generateProguardFile('remote_config')
+  setupDexDependencies(':remote_config:remote_config_resources')
 }

remote_config/integration_test/src/integration_test.cc

@@ -15,15 +15,20 @@
 #include <inttypes.h>
 
 #include <algorithm>
+#include <chrono>
 #include <cstdio>
 #include <cstdlib>
 #include <cstring>
 #include <ctime>
+#include <future>
+#include <memory>
 
 #include "app_framework.h"  // NOLINT
 #include "firebase/app.h"
+#include "firebase/internal/platform.h"
 #include "firebase/log.h"
 #include "firebase/remote_config.h"
+#include "firebase/remote_config/config_update_listener_registration.h"
 #include "firebase/util.h"
 #include "firebase_test_framework.h"  // NOLINT
 
@@ -192,6 +197,8 @@ TEST_F(FirebaseRemoteConfigTest, TestInitializeAndTerminate) {
   // Already tested via SetUp() and TearDown().
 }
 
+/// This test requires to be run on a device or simulator that does not have a
+/// newer version of the config saved on disk from a previous test run.
 TEST_F(FirebaseRemoteConfigTest, TestSetDefault) {
   ASSERT_NE(rc_, nullptr);
 
@@ -254,6 +261,93 @@ TEST_F(FirebaseRemoteConfigTest, TestSetDefault) {
   }
 }
 
+/// This test requires to be run on a device or simulator that does not have the
+/// template version number stored on the disk or auto-fetch will be skipped.
+TEST_F(FirebaseRemoteConfigTest, TestAddOnConfigUpdateListener) {
+  ASSERT_NE(rc_, nullptr);
+
+  // Check if the config has default values. If not, we have cached data
+  // from a previous test run, and auto-fetch will not happen.
+  EXPECT_TRUE(WaitForCompletion(SetDefaults(rc_), "SetDefaults"));
+  bool validated_defaults = true;
+  firebase::remote_config::ValueInfo value_info;
+  bool bool_value = rc_->GetBoolean("TestBoolean", &value_info);
+  bool has_cached_data =
+      value_info.source != firebase::remote_config::kValueSourceDefaultValue;
+
+  if (has_cached_data) {
+    LogWarning(
+        "Can't validate defaults, they've been overridden by server values.\n"
+#if defined(__ANDROID__)
+        "Delete the app's data and run this test again to test\n"
+        " AddOnConfigUpdateListener: adb shell pm clear [bundle ID]"
+#elif defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
+        "Uninstall and re-install the app and run this again to test "
+        "AddOnConfigUpdateListener."
+#else  // Desktop
+        "Delete the Remote Config cache and run this test again to test "
+        "AddOnConfigUpdateListener:\n"
+#if defined(_WIN32)
+        " del remote_config_data"
+#else
+        " rm remote_config_data"
+#endif  // defined(_WIN32)
+#endif  // defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
+    );
+  }
+// Realtime RC is not yet supported on desktop.
+#if FIREBASE_PLATFORM_DESKTOP
+  rc_->AddOnConfigUpdateListener(
+      [](firebase::remote_config::ConfigUpdate&&,
+         firebase::remote_config::RemoteConfigError) {});
+#else
+  auto config_update_promise = std::make_shared<std::promise<void> >();
+
+  firebase::remote_config::ConfigUpdateListenerRegistration registration =
+      rc_->AddOnConfigUpdateListener(
+          [&, config_update_promise](
+              firebase::remote_config::ConfigUpdate&& configUpdate,
+              firebase::remote_config::RemoteConfigError remoteConfigError) {
+            EXPECT_EQ(configUpdate.updated_keys.size(), 5);
+            config_update_promise->set_value();
+          });
+  if (!has_cached_data) {
+    auto config_update_future = config_update_promise->get_future();
+    ASSERT_EQ(std::future_status::ready,
+              config_update_future.wait_for(std::chrono::milliseconds(10000)));
+
+    // On Android WaitForCompletion must be called from the main thread,
+    // so Activate is called here outside of the listener.
+    EXPECT_TRUE(WaitForCompletion(rc_->Activate(), "Activate"));
+    LogDebug("Real-time Config Update keys retrieved.");
+
+    std::map<std::string, firebase::Variant> key_values = rc_->GetAll();
+    EXPECT_EQ(key_values.size(), 6);
+
+    for (auto key_valur_pair : kServerValue) {
+      firebase::Variant k_value = key_valur_pair.value;
+      firebase::Variant fetched_value = key_values[key_valur_pair.key];
+      EXPECT_EQ(k_value.type(), fetched_value.type());
+      EXPECT_EQ(k_value, fetched_value);
+    }
+    registration.Remove();
+  }
+#endif  // !FIREBASE_PLATFORM_DESKTOP
+}
+
+TEST_F(FirebaseRemoteConfigTest, TestRemoveConfigUpdateListener) {
+#if !FIREBASE_PLATFORM_DESKTOP
+
+  firebase::remote_config::ConfigUpdateListenerRegistration registration =
+      rc_->AddOnConfigUpdateListener(
+          [](firebase::remote_config::ConfigUpdate&& configUpdate,
+             firebase::remote_config::RemoteConfigError remoteConfigError) {});
+
+  registration.Remove();
+
+#endif  // !FIREBASE_PLATFORM_DESKTOP
+}
+
 TEST_F(FirebaseRemoteConfigTest, TestGetKeys) {
   ASSERT_NE(rc_, nullptr);
 
@@ -405,5 +499,4 @@ TEST_F(FirebaseRemoteConfigTest, TestFetchSecondsParameter) {
 
   FLAKY_TEST_SECTION_END();
 }
-
 }  // namespace firebase_testapp_automated

remote_config/remote_config_resources/build.gradle

@@ -0,0 +1,61 @@
+// 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.
+
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+  dependencies {
+    classpath 'com.android.tools.build:gradle:3.3.3'
+    classpath 'com.google.gms:google-services:4.2.0'
+  }
+}
+allprojects {
+  repositories {
+    google()
+    mavenCentral()
+  }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+  compileOptions {
+    sourceCompatibility 1.8
+    targetCompatibility 1.8
+  }
+  compileSdkVersion 28
+
+  sourceSets {
+    main {
+      manifest.srcFile '../../android_build_files/AndroidManifest.xml'
+      java {
+        srcDirs = ['../src_java/com/google/firebase/remoteconfig/internal/cpp']
+      }
+    }
+  }
+}
+
+dependencies {
+  implementation platform('com.google.firebase:firebase-bom:31.5.0')
+  implementation 'com.google.firebase:firebase-config'
+}
+
+afterEvaluate {
+  generateReleaseBuildConfig.enabled = false
+}
+
+apply from: "$rootDir/android_build_files/extract_and_dex.gradle"
+extractAndDexAarFile('remote_config_resources')