Add support for User Messaging Platform SDK on Android (#1428)

* Added debug device ID fetch to Android.

* Add Java method for obtaining Android ID from secure settings.

* Update android ID algorithm.

* Add flatbuffers patch when building for Android.

* Add stub Android files.

* Fix path.

* Add ConsentInfoHelper class with some starting functionality.

* Fix GetDebugDeviceId on Android.

* Format code.

* Add UMP dependency.

* Fix overrides.

* Add initialization.

* Lint.

* Lint.

* Move UMP resources to their own resource file and class path.

* Fix relocated UMP resources.

Add lint skip (like App Check).

* Add enum conversion and fix build.

* Add enum cache.

* Android implementation of ConsentInfo functionality.

* Format code.

* Fix JNI type.

* Fix Java build errors and format code.

* Fix call.

* Fix initialization.

* Fix for debugDeviceId

* Remove extra Enum method, and also format code.

* Fix error message handling for Unavailable error. And format code.

* Fix compile issue.

* Remove extra debugging output.

* Remove test filter for UMP only.

* Remove extraneous HasExceptionOccurred function since ExceptionCheck does it for us.

* Add OperationInProgress check to iOS SDK as well, and a test for it.

Clean up enum cache and remove requirement to sync up c++/java enums.

* Remove lint abortOnError false

* Try enabling parallel gradle builds for Windows.

* Restore script.

* Remove lint on error abort.

* Remove extra manifest file.

* Restore build.gradle for GMA library proper

* Temporarily remove ump_resources to see if this fixes Windows build hang.

* Remove Flatbuffers patch to diagnose Windows hang.

* Fix build error.

* Add missing dependencies.

* Revert "Add missing dependencies."

This reverts commit 03decca.

* Add ump-resources back in.

* Add code back in.

* Modify comment.

* Remove lint abort.

* Add compatibility version.

* Move ConsentInfoHelper class into regular gma_resources.

No need for a separate ump_resources.

* Remove comment about build hang because spoiler alert, it doesn't cause it.

* Ensure that GMA and UMP only load their shared class files once.

* Rename mutex.

* Update copyright date and fix lock issue.

Also disable lint warning in this testapp (temporarily?)

* Move lock to later in the destructor.

* Format code.

* Fix non-UI tests.

Author: jonsimantov

Android/firebase_dependencies.gradle

@@ -27,7 +27,8 @@ def firebaseDependenciesMap = [
   'dynamic_links' : ['com.google.firebase:firebase-dynamic-links'],
   'firestore' : ['com.google.firebase:firebase-firestore'],
   'functions' : ['com.google.firebase:firebase-functions'],
-  'gma' : ['com.google.android.gms:play-services-ads:22.3.0'],
+  'gma' : ['com.google.android.gms:play-services-ads:22.3.0',
+           'com.google.android.ump:user-messaging-platform:2.1.0'],
   'installations' : ['com.google.firebase:firebase-installations'],
   'invites' : ['com.google.firebase:firebase-invites'],
   // Messaging has an additional local dependency to include.

gma/CMakeLists.txt

@@ -40,7 +40,7 @@ binary_to_array("gma_resources"
 # Source files used by the Android implementation.
 set(android_SRCS
     ${gma_resources_source}
-    src/stub/ump/consent_info_internal_stub.cc
+    src/android/ump/consent_info_internal_android.cc
     src/android/ad_request_converter.cc
     src/android/ad_error_android.cc
     src/android/adapter_response_info_android.cc

gma/gma_resources/build.gradle

@@ -32,6 +32,11 @@ allprojects {
 apply plugin: 'com.android.library'
 
 android {
+  compileOptions {
+    sourceCompatibility 1.8
+    targetCompatibility 1.8
+  }
+
   compileSdkVersion 28
 
   sourceSets {
@@ -48,6 +53,7 @@ dependencies {
   implementation platform('com.google.firebase:firebase-bom:32.2.3')
   implementation 'com.google.firebase:firebase-analytics'
   implementation 'com.google.android.gms:play-services-ads:22.3.0'
+  implementation 'com.google.android.ump:user-messaging-platform:2.1.0'
 }
 
 afterEvaluate {

gma/integration_test/build.gradle

@@ -73,6 +73,9 @@ android {
       proguardFile file('proguard.pro')
     }
   }
+  lintOptions {
+      abortOnError false
+  }
 }
 
 apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle"

gma/integration_test/src/integration_test.cc

@@ -268,6 +268,7 @@ void FirebaseGmaTest::SetUp() {
   // debugging. They appear as a long string of hex characters.
   firebase::gma::RequestConfiguration request_configuration;
   request_configuration.test_device_ids = kTestDeviceIDs;
+  request_configuration.test_device_ids.push_back(GetDebugDeviceId());
   firebase::gma::SetRequestConfiguration(request_configuration);
 }
 
@@ -332,6 +333,7 @@ void FirebaseGmaUITest::SetUp() {
   // debugging. They appear as a long string of hex characters.
   firebase::gma::RequestConfiguration request_configuration;
   request_configuration.test_device_ids = kTestDeviceIDs;
+  request_configuration.test_device_ids.push_back(GetDebugDeviceId());
   firebase::gma::SetRequestConfiguration(request_configuration);
 }
 
@@ -2493,7 +2495,12 @@ class FirebaseGmaUmpTest : public FirebaseGmaTest {
 
 void FirebaseGmaUmpTest::InitializeUmp(ResetOption reset) {
   using firebase::gma::ump::ConsentInfo;
-  consent_info_ = ConsentInfo::GetInstance(*shared_app_);
+  firebase::InitResult result;
+  consent_info_ = ConsentInfo::GetInstance(*shared_app_, &result);
+
+  EXPECT_NE(consent_info_, nullptr);
+  EXPECT_EQ(result, firebase::kInitResultSuccess);
+
   if (consent_info_ != nullptr && reset == kReset) {
     consent_info_->Reset();
   }
@@ -2937,4 +2944,90 @@ TEST_F(FirebaseGmaUmpTest, TestUmpCleanupRaceCondition) {
   EXPECT_EQ(future_show.status(), firebase::kFutureStatusInvalid);
 }
 
+TEST_F(FirebaseGmaUmpTest, TestUmpMethodsReturnOperationInProgress) {
+  SKIP_TEST_ON_DESKTOP;
+
+  using firebase::gma::ump::ConsentFormStatus;
+  using firebase::gma::ump::ConsentRequestParameters;
+  using firebase::gma::ump::ConsentStatus;
+
+  // Check that all of the UMP operations properly return an OperationInProgress
+  // error if called more than once at the same time. Each step of this test is
+  // inherently flaky, so add flaky test blocks all over.
+
+  ConsentRequestParameters params;
+  params.tag_for_under_age_of_consent = false;
+  params.debug_settings.debug_geography =
+      ShouldRunUITests() ? firebase::gma::ump::kConsentDebugGeographyEEA
+                         : firebase::gma::ump::kConsentDebugGeographyNonEEA;
+  params.debug_settings.debug_device_ids = kTestDeviceIDs;
+  params.debug_settings.debug_device_ids.push_back(GetDebugDeviceId());
+
+  FLAKY_TEST_SECTION_BEGIN();
+  firebase::Future<void> future_request_1 =
+      consent_info_->RequestConsentInfoUpdate(params);
+  firebase::Future<void> future_request_2 =
+      consent_info_->RequestConsentInfoUpdate(params);
+  WaitForCompletion(
+      future_request_2, "RequestConsentInfoUpdate second",
+      firebase::gma::ump::kConsentRequestErrorOperationInProgress);
+  WaitForCompletion(future_request_1, "RequestConsentInfoUpdate first");
+  FLAKY_TEST_SECTION_END();
+
+  if (ShouldRunUITests()) {
+    // The below should only be checked if UI tests are enabled, as they
+    // require some interaction.
+    FLAKY_TEST_SECTION_BEGIN();
+    firebase::Future<void> future_load_1 = consent_info_->LoadConsentForm();
+    firebase::Future<void> future_load_2 = consent_info_->LoadConsentForm();
+    WaitForCompletion(future_load_2, "LoadConsentForm second",
+                      firebase::gma::ump::kConsentFormErrorOperationInProgress);
+    WaitForCompletion(future_load_1, "LoadConsentForm first");
+    FLAKY_TEST_SECTION_END();
+
+    FLAKY_TEST_SECTION_BEGIN();
+    firebase::Future<void> future_show_1 =
+        consent_info_->ShowConsentForm(app_framework::GetWindowController());
+    firebase::Future<void> future_show_2 =
+        consent_info_->ShowConsentForm(app_framework::GetWindowController());
+    WaitForCompletion(future_show_2, "ShowConsentForm second",
+                      firebase::gma::ump::kConsentFormErrorOperationInProgress);
+    WaitForCompletion(future_show_1, "ShowConsentForm first");
+    FLAKY_TEST_SECTION_END();
+
+    FLAKY_TEST_SECTION_BEGIN();
+    firebase::Future<void> future_privacy_1 =
+        consent_info_->ShowPrivacyOptionsForm(
+            app_framework::GetWindowController());
+    firebase::Future<void> future_privacy_2 =
+        consent_info_->ShowPrivacyOptionsForm(
+            app_framework::GetWindowController());
+    WaitForCompletion(future_privacy_2, "ShowPrivacyOptionsForm second",
+                      firebase::gma::ump::kConsentFormErrorOperationInProgress);
+    WaitForCompletion(future_privacy_1, "ShowPrivacyOptionsForm first");
+    FLAKY_TEST_SECTION_END();
+
+    consent_info_->Reset();
+    // Request again so we can test LoadAndShowConsentFormIfRequired.
+    WaitForCompletion(consent_info_->RequestConsentInfoUpdate(params),
+                      "RequestConsentInfoUpdate");
+
+    FLAKY_TEST_SECTION_BEGIN();
+    firebase::Future<void> future_load_and_show_1 =
+        consent_info_->LoadAndShowConsentFormIfRequired(
+            app_framework::GetWindowController());
+    firebase::Future<void> future_load_and_show_2 =
+        consent_info_->LoadAndShowConsentFormIfRequired(
+            app_framework::GetWindowController());
+    WaitForCompletion(future_load_and_show_2,
+                      "LoadAndShowConsentFormIfRequired second",
+                      firebase::gma::ump::kConsentFormErrorOperationInProgress);
+    WaitForCompletion(future_load_and_show_1,
+                      "LoadAndShowConsentFormIfRequired first");
+    FLAKY_TEST_SECTION_END();
+  } else {
+    LogInfo("Skipping methods that require user interaction.");
+  }
+}
+
 }  // namespace firebase_testapp_automated

gma/src/android/gma_android.cc

@@ -49,6 +49,12 @@
 namespace firebase {
 namespace gma {
 
+namespace internal {
+::firebase::Mutex g_cached_gma_embedded_files_mutex;
+std::vector<::firebase::internal::EmbeddedFile>* g_cached_gma_embedded_files =
+    nullptr;
+}  // namespace internal
+
 METHOD_LOOKUP_DEFINITION(mobile_ads,
                          PROGUARD_KEEP_CLASS
                          "com/google/android/gms/ads/MobileAds",
@@ -308,12 +314,22 @@ Future<AdapterInitializationStatus> Initialize(JNIEnv* env, jobject activity,
     return Future<AdapterInitializationStatus>();
   }
 
-  const std::vector<firebase::internal::EmbeddedFile> embedded_files =
-      util::CacheEmbeddedFiles(env, activity,
-                               firebase::internal::EmbeddedFile::ToVector(
-                                   firebase_gma::gma_resources_filename,
-                                   firebase_gma::gma_resources_data,
-                                   firebase_gma::gma_resources_size));
+  // Between this and UMP, we only want to load these files once.
+  {
+    MutexLock lock(internal::g_cached_gma_embedded_files_mutex);
+    if (internal::g_cached_gma_embedded_files == nullptr) {
+      internal::g_cached_gma_embedded_files =
+          new std::vector<firebase::internal::EmbeddedFile>();
+      *internal::g_cached_gma_embedded_files =
+          util::CacheEmbeddedFiles(env, activity,
+                                   firebase::internal::EmbeddedFile::ToVector(
+                                       firebase_gma::gma_resources_filename,
+                                       firebase_gma::gma_resources_data,
+                                       firebase_gma::gma_resources_size));
+    }
+  }
+  const std::vector<firebase::internal::EmbeddedFile>& embedded_files =
+      *internal::g_cached_gma_embedded_files;
 
   if (!(mobile_ads::CacheMethodIds(env, activity) &&
         ad_request_builder::CacheMethodIds(env, activity) &&

gma/src/android/gma_android.h

@@ -19,7 +19,11 @@
 
 #include <jni.h>
 
+#include <vector>
+
+#include "app/src/embedded_file.h"
 #include "app/src/util_android.h"
+#include "firebase/internal/mutex.h"
 #include "gma/src/common/gma_common.h"
 
 namespace firebase {
@@ -189,6 +193,14 @@ void ReleaseClasses(JNIEnv* env);
 jobject CreateJavaAdSize(JNIEnv* env, jobject activity,
                          const AdSize& an_ad_size);
 
+namespace internal {
+// GMA and UMP share embedded dex files; this ensures
+// that they are only loaded once each run.
+extern ::firebase::Mutex g_cached_gma_embedded_files_mutex;
+extern std::vector<::firebase::internal::EmbeddedFile>*
+    g_cached_gma_embedded_files;
+}  // namespace internal
+
 }  // namespace gma
 }  // namespace firebase