Added support for DeliveryMetricsExportToBigQueryEnabled and

SetDeliveryMetricsExportToBigQuery.

This is currently just a stub on iOS, until the underlying functionality is
hooked up.

PiperOrigin-RevId: 286297600

Author: amablue

messaging/src/android/cpp/messaging.cc

@@ -88,6 +88,17 @@ enum RegistrationTokenRequestState {
 static RegistrationTokenRequestState g_registration_token_request_state =
     kRegistrationTokenRequestStateNone;
 
+// Global flag indicating if metrics export to big query was enabled or
+// disabled before app initialization.
+enum DeliveryMetricsExportToBigQueryState {
+  kDeliveryMetricsExportToBigQueryNone,
+  kDeliveryMetricsExportToBigQueryEnable,
+  kDeliveryMetricsExportToBigQueryDisable,
+};
+static DeliveryMetricsExportToBigQueryState
+    g_delivery_metrics_export_to_big_query_state =
+        kDeliveryMetricsExportToBigQueryNone;
+
 // Indicates whether a registration token has been received, which is necessary
 // to perform certain actions related to topic subscriptions.
 // NOTE: The registration token is received by RegistrationIntentService which
@@ -164,7 +175,11 @@ METHOD_LOOKUP_DEFINITION(remote_message_builder,
       "(Ljava/lang/String;)Lcom/google/android/gms/tasks/Task;"),              \
     X(GetInstance, "getInstance",                                              \
       "()Lcom/google/firebase/messaging/FirebaseMessaging;",                   \
-      firebase::util::kMethodTypeStatic)
+      firebase::util::kMethodTypeStatic),                                      \
+    X(DeliveryMetricsExportToBigQueryEnabled,                                  \
+      "deliveryMetricsExportToBigQueryEnabled", "()Z"),                        \
+    X(SetDeliveryMetricsExportToBigQuery,                                      \
+      "setDeliveryMetricsExportToBigQuery", "(Z)V")
 // clang-format on
 METHOD_LOOKUP_DECLARATION(firebase_messaging, FIREBASE_MESSAGING_METHODS);
 METHOD_LOOKUP_DEFINITION(firebase_messaging,
@@ -645,6 +660,15 @@ InitResult Initialize(const ::firebase::App& app, Listener* listener,
                                       kRegistrationTokenRequestStateEnable);
   }
 
+  if (g_delivery_metrics_export_to_big_query_state !=
+      kDeliveryMetricsExportToBigQueryNone) {
+    // Calling this again, now that we're initialized.
+    assert(internal::IsInitialized());
+    SetTokenRegistrationOnInitEnabled(
+        g_delivery_metrics_export_to_big_query_state ==
+        kDeliveryMetricsExportToBigQueryEnable);
+  }
+
   FutureData::Create();
 
   // Supposedly App creation also creates a registration token, but this seems
@@ -695,6 +719,9 @@ void Terminate() {
   delete g_lockfile_path;
   g_lockfile_path = nullptr;
 
+  g_delivery_metrics_export_to_big_query_state =
+      kDeliveryMetricsExportToBigQueryNone;
+
   env->DeleteGlobalRef(g_firebase_messaging);
   g_firebase_messaging = nullptr;
   SetListener(nullptr);
@@ -939,6 +966,44 @@ Future<void> UnsubscribeLastResult() {
       api->LastResult(kMessagingFnUnsubscribe));
 }
 
+bool DeliveryMetricsExportToBigQueryEnabled() {
+  if (!internal::IsInitialized()) {
+    // If the user previously called SetDeliveryMetricsExportToBigQuery(true),
+    // then return true. If they did not set it, or set it to false, return
+    // false.
+    return g_delivery_metrics_export_to_big_query_state ==
+           kDeliveryMetricsExportToBigQueryEnable;
+  }
+
+  JNIEnv* env = g_app->GetJNIEnv();
+  jboolean result = env->CallBooleanMethod(
+      g_firebase_messaging,
+      firebase_messaging::GetMethodId(
+          firebase_messaging::kDeliveryMetricsExportToBigQueryEnabled));
+  assert(env->ExceptionCheck() == false);
+  return static_cast<bool>(result);
+}
+
+void SetDeliveryMetricsExportToBigQuery(bool enabled) {
+  // If this is called before JNI is initialized, we'll just cache the intent
+  // and handle it on actual init.
+  // Otherwise if we've already initialized, the underlying API will persist the
+  // value.
+  if (internal::IsInitialized()) {
+    JNIEnv* env = g_app->GetJNIEnv();
+    env->CallVoidMethod(
+        g_firebase_messaging,
+        firebase_messaging::GetMethodId(
+            firebase_messaging::kSetDeliveryMetricsExportToBigQuery),
+        static_cast<jboolean>(enabled));
+    assert(env->ExceptionCheck() == false);
+  } else {
+    g_delivery_metrics_export_to_big_query_state =
+        enabled ? kDeliveryMetricsExportToBigQueryEnable
+                : kDeliveryMetricsExportToBigQueryDisable;
+  }
+}
+
 void SetTokenRegistrationOnInitEnabled(bool enabled) {
   // If this is called before JNI is initialized, we'll just cache the intent
   // and handle it on actual init.

messaging/src/include/firebase/messaging.h

@@ -596,6 +596,34 @@ Future<void> Unsubscribe(const char* topic);
 /// @returns Result of the most recent call to Unsubscribe().
 Future<void> UnsubscribeLastResult();
 
+/// Determines whether Firebase Cloud Messaging exports message delivery metrics
+/// to BigQuery.
+///
+/// This function is currently only implemented on Android, and returns false
+/// with no other behavior on other platforms.
+///
+/// @return true if Firebase Cloud Messaging exports message delivery metrics to
+/// BigQuery.
+bool DeliveryMetricsExportToBigQueryEnabled();
+
+/// Enables or disables Firebase Cloud Messaging message delivery metrics export
+/// to BigQuery.
+///
+/// By default, message delivery metrics are not exported to BigQuery. Use this
+/// method to enable or disable the export at runtime. In addition, you can
+/// enable the export by adding to your manifest. Note that the run-time method
+/// call will override the manifest value.
+///
+/// <meta-data android:name= "delivery_metrics_exported_to_big_query_enabled"
+///            android:value="true"/>
+///
+/// This function is currently only implemented on Android, and has no behavior
+/// on other platforms.
+///
+/// @param[in] enable Whether Firebase Cloud Messaging should export message
+///            delivery metrics to BigQuery.
+void SetDeliveryMetricsExportToBigQuery(bool enable);
+
 class PollableListenerImpl;
 
 /// @brief A listener that can be polled to consume pending `Message`s.

messaging/src/ios/messaging.mm

@@ -768,6 +768,18 @@ void Send(const Message &message) {
       api->LastResult(kMessagingFnUnsubscribe));
 }
 
+bool DeliveryMetricsExportToBigQueryEnabled() {
+  // TODO(146362498): Implement this once the underlying API is ready on iOS.
+  LogWarning("DeliveryMetricsExportToBigQueryEnabled is not currently implemented on iOS");
+
+  return false;
+}
+
+void SetDeliveryMetricsExportToBigQuery(bool /*enable*/) {
+  // TODO(146362498): Implement this once the underlying API is ready on iOS.
+  LogWarning("SetDeliveryMetricsExportToBigQuery is not currently implemented on iOS");
+}
+
 bool IsTokenRegistrationOnInitEnabled() { return [FIRMessaging messaging].autoInitEnabled; }
 
 void SetTokenRegistrationOnInitEnabled(bool enable) {

messaging/src/stub/messaging.cc

@@ -194,5 +194,9 @@ bool IsTokenRegistrationOnInitEnabled() { return true; }
 
 void SetTokenRegistrationOnInitEnabled(bool /*enable*/) {}
 
+bool DeliveryMetricsExportToBigQueryEnabled() { return false; }
+
+void SetDeliveryMetricsExportToBigQuery(bool /*enable*/) {}
+
 }  // namespace messaging
 }  // namespace firebase