Feat: add setdefaulteventparameters for android and stub for others

This brings the Android SDK into parity for C++.

Author: AustinBenoit

analytics/integration_test/src/integration_test.cc

@@ -297,6 +297,20 @@ TEST_F(FirebaseAnalyticsTest, TestLogEventWithComplexParameters) {
       sizeof(kViewCartParameters) / sizeof(kViewCartParameters[0]));
 }
 
+TEST_F(FirebaseAnalyticsTest, TestSetDefaultEventParameters) {
+  const firebase::analytics::Parameter kDefaultParameters[] = {
+        firebase::analytics::Parameter("default_parameter_double", 123.456),
+        firebase::analytics::Parameter("default_parameter_int", 4),
+        firebase::analytics::Parameter("default_parameter_str",
+                                       "Hello World"),
+    };
+
+  firebase::analytics::SetDefaultEventParameters(kDefaultParameters,
+      sizeof(kDefaultParameters) / sizeof(kDefaultParameters[0]));
+  firebase::analytics::LogEvent("default_parameter_event");
+  firebase::analytics::SetDefaultEventParameters(nullptr, 0);
+}
+
 TEST_F(FirebaseAnalyticsTest, TestSetConsent) {
   // On Android, this test must be performed at the end, after all the tests for
   // session ID and instance ID. This is because once you call SetConsent to

analytics/src/analytics_android.cc

@@ -60,7 +60,9 @@ static const ::firebase::App* g_app = nullptr;
     "()Lcom/google/android/gms/tasks/Task;"),                                 \
   X(GetInstance, "getInstance", "(Landroid/content/Context;)"                 \
     "Lcom/google/firebase/analytics/FirebaseAnalytics;",                      \
-    firebase::util::kMethodTypeStatic)
+    firebase::util::kMethodTypeStatic),                                       \
+  X(SetDefaultEventParameters, "setDefaultEventParameters",                   \
+    "(Landroid/os/Bundle;)V")
 // clang-format on
 
 // clang-format off
@@ -340,8 +342,8 @@ void AddToBundle(JNIEnv* env, jobject bundle, const char* key,
 void AddToBundle(JNIEnv* env, jobject bundle, const char* key, double value) {
   jstring key_string = env->NewStringUTF(key);
   env->CallVoidMethod(bundle,
-                      util::bundle::GetMethodId(util::bundle::kPutFloat),
-                      key_string, static_cast<jfloat>(value));
+                      util::bundle::GetMethodId(util::bundle::kPutDouble),
+                      key_string, static_cast<jdouble>(value));
   util::CheckAndClearJniExceptions(env);
   env->DeleteLocalRef(key_string);
 }
@@ -518,6 +520,43 @@ void LogEvent(const char* name, const Parameter* parameters,
   });
 }
 
+// Set the default event parametrs.
+void SetDefaultEventParameters(const Parameter* parameters,
+                               size_t number_of_parameters) {
+  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
+  JNIEnv* env = g_app->GetJNIEnv();
+
+  if (!parameters) {
+    env->CallVoidMethod(
+        g_analytics_class_instance,
+        analytics::GetMethodId(analytics::kSetDefaultEventParameters), nullptr);
+    if (util::CheckAndClearJniExceptions(env)) {
+      LogError("Failed to set default event parameters");
+    }
+    return;
+  }
+
+  jobject bundle =
+      env->NewObject(util::bundle::GetClass(),
+                     util::bundle::GetMethodId(util::bundle::kConstructor));
+  for (size_t i = 0; i < number_of_parameters; ++i) {
+    const Parameter& parameter = parameters[i];
+    if (!AddVariantToBundle(env, bundle, parameter.name, parameter.value)) {
+      // A Variant type that couldn't be handled was passed in.
+      LogError(
+          "SetDefaultEventParameters(%s): %s is not a valid parameter value"
+          " type. Excluded from default parameters.",
+          parameter.name, Variant::TypeName(parameter.value.type()));
+    }
+  }
+  env->CallVoidMethod(
+      g_analytics_class_instance,
+      analytics::GetMethodId(analytics::kSetDefaultEventParameters), bundle);
+  if (util::CheckAndClearJniExceptions(env)) {
+    LogError("Failed to set default event parameters");
+  }
+}
+
 /// Initiates on-device conversion measurement given a user email address on iOS
 /// (no-op on Android). On iOS, requires dependency
 /// GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a

analytics/src/analytics_desktop.cc

@@ -429,6 +429,11 @@ void LogEvent(const char* name, const char* parameter_name,
 
 // --- Stub Implementations for Unsupported Features ---
 
+void SetDefaultEventParameters(const Parameter* parameters,
+                               size_t number_of_parameters) {
+  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
+}
+
 void SetConsent(const std::map<ConsentType, ConsentStatus>& consent_settings) {
   FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
 

analytics/src/analytics_desktop_dynamic.c

@@ -139,6 +139,10 @@ static void Stub_GoogleAnalytics_LogEvent(const char* name, GoogleAnalytics_Even
     // No return value.
 }
 
+static void Stub_GoogleAnalytics_SetDefaultEventParameters(GoogleAnalytics_EventParameters* parameters, size_t number_of_parameters) {
+    // No return value.
+}
+
 // Stub for GoogleAnalytics_SetUserProperty
 static void Stub_GoogleAnalytics_SetUserProperty(const char* name,
                                                    const char* value) {
@@ -180,6 +184,7 @@ void (*ptr_GoogleAnalytics_EventParameters_InsertItemVector)(GoogleAnalytics_Eve
 void (*ptr_GoogleAnalytics_EventParameters_Destroy)(GoogleAnalytics_EventParameters* event_parameter_map) = &Stub_GoogleAnalytics_EventParameters_Destroy;
 bool (*ptr_GoogleAnalytics_Initialize)(const GoogleAnalytics_Options* options) = &Stub_GoogleAnalytics_Initialize;
 void (*ptr_GoogleAnalytics_LogEvent)(const char* name, GoogleAnalytics_EventParameters* parameters) = &Stub_GoogleAnalytics_LogEvent;
+void (*ptr_GoogleAnalytics_SetDefaultEventParameters)(GoogleAnalytics_EventParameters* parameters, size_t number_of_parameters) = &Stub_GoogleAnalytics_SetDefaultEventParameters;
 void (*ptr_GoogleAnalytics_SetUserProperty)(const char* name, const char* value) = &Stub_GoogleAnalytics_SetUserProperty;
 void (*ptr_GoogleAnalytics_SetUserId)(const char* user_id) = &Stub_GoogleAnalytics_SetUserId;
 void (*ptr_GoogleAnalytics_ResetAnalyticsData)() = &Stub_GoogleAnalytics_ResetAnalyticsData;

analytics/src/analytics_desktop_dynamic.h

@@ -164,6 +164,7 @@ extern void (*ptr_GoogleAnalytics_EventParameters_InsertItemVector)(GoogleAnalyt
 extern void (*ptr_GoogleAnalytics_EventParameters_Destroy)(GoogleAnalytics_EventParameters* event_parameter_map);
 extern bool (*ptr_GoogleAnalytics_Initialize)(const GoogleAnalytics_Options* options);
 extern void (*ptr_GoogleAnalytics_LogEvent)(const char* name, GoogleAnalytics_EventParameters* parameters);
+extern void (*ptr_GoogleAnalytics_SetDefaultEventParameters)(GoogleAnalytics_EventParameters* parameters, size_t number_of_parameters);
 extern void (*ptr_GoogleAnalytics_SetUserProperty)(const char* name, const char* value);
 extern void (*ptr_GoogleAnalytics_SetUserId)(const char* user_id);
 extern void (*ptr_GoogleAnalytics_ResetAnalyticsData)();

analytics/src/analytics_ios.mm

@@ -312,6 +312,9 @@ void LogEvent(const char* name, const Parameter* parameters, size_t number_of_pa
   [FIRAnalytics logEventWithName:@(name) parameters:parameters_dict];
 }
 
+void SetDefaultEventParameters(const Parameter* parameters, size_t number_of_parameters) {  
+}
+
 /// Initiates on-device conversion measurement given a user email address on iOS (no-op on
 /// Android). On iOS, requires dependency GoogleAppMeasurementOnDeviceConversion to be linked
 /// in, otherwise it is a no-op.

analytics/src/include/firebase/analytics.h

@@ -476,6 +476,22 @@ void LogEvent(const char* name);
 void LogEvent(const char* name, const Parameter* parameters,
               size_t number_of_parameters);
 
+/// @brief Adds parameters that will be set on every event logged from the SDK.
+///
+/// Adds parameters that will be set on every event logged from the SDK,
+/// including automatic ones. The values passed in the parameters bundle will
+/// be added to the map of default event parameters. These parameters persist
+/// across app runs. They are of lower precedence than event parameters, so if
+/// an event parameter and a parameter set using this API have the same name,
+/// the value of the event parameter will be used. The same limitations on event
+/// parameters apply to default event parameters.
+///
+/// @param[in] parameters Array of Parameter structures.
+/// @param[in] number_of_parameters Number of elements in the parameters
+/// array.
+void SetDefaultEventParameters(const Parameter* parameters,
+                               size_t number_of_parameters);
+
 /// Initiates on-device conversion measurement given a user email address on iOS
 /// and tvOS (no-op on Android). On iOS and tvOS, this method requires the
 /// dependency GoogleAppMeasurementOnDeviceConversion to be linked in,

app/src/util_android.h

@@ -496,6 +496,7 @@ METHOD_LOOKUP_DECLARATION(activity, ACTIVITY_METHODS)
     X(GetString, "getString", "(Ljava/lang/String;)Ljava/lang/String;"),   \
     X(KeySet, "keySet", "()Ljava/util/Set;"),                              \
     X(PutFloat, "putFloat", "(Ljava/lang/String;F)V"),                     \
+    X(PutDouble, "putDouble", "(Ljava/lang/String;D)V"),                   \
     X(PutLong, "putLong", "(Ljava/lang/String;J)V"),                       \
     X(PutString, "putString", "(Ljava/lang/String;Ljava/lang/String;)V"),  \
     X(PutBundle, "putBundle", "(Ljava/lang/String;Landroid/os/Bundle;)V"), \