Skip to content

Commit 5dbbfda

Browse files
committed
Format code and update readme.
1 parent f8a08e5 commit 5dbbfda

File tree

7 files changed

+115
-111
lines changed

7 files changed

+115
-111
lines changed

analytics/integration_test/src/integration_test.cc

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -298,58 +298,58 @@ TEST_F(FirebaseAnalyticsTest, TestLogEventWithComplexParameters) {
298298
}
299299

300300
TEST_F(FirebaseAnalyticsTest, TestSetConsent) {
301-
// On Android, this test must be performed at the end, after all the tests for
302-
// session ID and instance ID. This is because once you call SetConsent to
303-
// deny consent on Android, calling it again to grant consent may not take
304-
// effect until the app restarts, thus breaking any of those tests that are
305-
// run after this one.
306-
//
307-
// If this test does happen to run earlier (due to randomizing test order, for
308-
// example), the tests that could fail will be skipped (on Android).
309-
310-
// Can't confirm that these do anything but just run them all to ensure the
311-
// app doesn't crash.
312-
std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
313-
consent_settings_allow = {
314-
{firebase::analytics::kConsentTypeAnalyticsStorage,
315-
firebase::analytics::kConsentStatusGranted},
316-
{firebase::analytics::kConsentTypeAdStorage,
317-
firebase::analytics::kConsentStatusGranted},
318-
{firebase::analytics::kConsentTypeAdUserData,
319-
firebase::analytics::kConsentStatusGranted},
320-
{firebase::analytics::kConsentTypeAdPersonalization,
321-
firebase::analytics::kConsentStatusGranted}};
322-
std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
323-
consent_settings_deny = {
324-
{firebase::analytics::kConsentTypeAnalyticsStorage,
325-
firebase::analytics::kConsentStatusDenied},
326-
{firebase::analytics::kConsentTypeAdStorage,
327-
firebase::analytics::kConsentStatusDenied},
328-
{firebase::analytics::kConsentTypeAdUserData,
329-
firebase::analytics::kConsentStatusDenied},
330-
{firebase::analytics::kConsentTypeAdPersonalization,
331-
firebase::analytics::kConsentStatusDenied}};
332-
std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
333-
consent_settings_empty;
334-
firebase::analytics::SetConsent(consent_settings_empty);
335-
ProcessEvents(1000);
336-
firebase::analytics::SetConsent(consent_settings_deny);
337-
ProcessEvents(1000);
338-
firebase::analytics::SetConsent(consent_settings_allow);
339-
ProcessEvents(1000);
340-
341-
did_test_setconsent_ = true;
301+
// On Android, this test must be performed at the end, after all the tests for
302+
// session ID and instance ID. This is because once you call SetConsent to
303+
// deny consent on Android, calling it again to grant consent may not take
304+
// effect until the app restarts, thus breaking any of those tests that are
305+
// run after this one.
306+
//
307+
// If this test does happen to run earlier (due to randomizing test order, for
308+
// example), the tests that could fail will be skipped (on Android).
309+
310+
// Can't confirm that these do anything but just run them all to ensure the
311+
// app doesn't crash.
312+
std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
313+
consent_settings_allow = {
314+
{firebase::analytics::kConsentTypeAnalyticsStorage,
315+
firebase::analytics::kConsentStatusGranted},
316+
{firebase::analytics::kConsentTypeAdStorage,
317+
firebase::analytics::kConsentStatusGranted},
318+
{firebase::analytics::kConsentTypeAdUserData,
319+
firebase::analytics::kConsentStatusGranted},
320+
{firebase::analytics::kConsentTypeAdPersonalization,
321+
firebase::analytics::kConsentStatusGranted}};
322+
std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
323+
consent_settings_deny = {
324+
{firebase::analytics::kConsentTypeAnalyticsStorage,
325+
firebase::analytics::kConsentStatusDenied},
326+
{firebase::analytics::kConsentTypeAdStorage,
327+
firebase::analytics::kConsentStatusDenied},
328+
{firebase::analytics::kConsentTypeAdUserData,
329+
firebase::analytics::kConsentStatusDenied},
330+
{firebase::analytics::kConsentTypeAdPersonalization,
331+
firebase::analytics::kConsentStatusDenied}};
332+
std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
333+
consent_settings_empty;
334+
firebase::analytics::SetConsent(consent_settings_empty);
335+
ProcessEvents(1000);
336+
firebase::analytics::SetConsent(consent_settings_deny);
337+
ProcessEvents(1000);
338+
firebase::analytics::SetConsent(consent_settings_allow);
339+
ProcessEvents(1000);
340+
341+
did_test_setconsent_ = true;
342342
}
343343

344344
TEST_F(FirebaseAnalyticsTest, TestSetDefaultEventParameters) {
345-
std::map<std::string, firebase::Variant> default_params = {
345+
std::map<std::string, firebase::Variant> default_params = {
346346
{"key1", firebase::Variant("value1")},
347347
{"key2", firebase::Variant(12345)},
348348
{"key3", firebase::Variant(1.01)},
349349
{"key4", firebase::Variant("my_value")},
350350
{"key5", firebase::Variant(true)},
351351
{"key6", firebase::Variant::EmptyMap()},
352352
};
353-
firebase::analytics::SetDefaultEventParameters(default_params);
353+
firebase::analytics::SetDefaultEventParameters(default_params);
354354
}
355355
} // namespace firebase_testapp_automated

analytics/src/analytics_android.cc

Lines changed: 52 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -737,63 +737,64 @@ Future<int64_t> GetSessionIdLastResult() {
737737
}
738738

739739
// Sets the default parameters to be sent with each event.
740-
void SetDefaultEventParameters(const std::map<std::string, Variant>& parameters) {
741-
FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
742-
JNIEnv* env = g_app->GetJNIEnv();
743-
744-
jobject map =
745-
env->NewObject(util::hash_map::GetClass(),
746-
util::hash_map::GetMethodId(util::hash_map::kConstructor));
747-
util::CheckAndClearJniExceptions(env);
748-
749-
jmethodID put_method_id = util::map::GetMethodId(util::map::kPut);
740+
void SetDefaultEventParameters(
741+
const std::map<std::string, Variant>& parameters) {
742+
FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
743+
JNIEnv* env = g_app->GetJNIEnv();
750744

751-
for (const auto& pair : parameters) {
752-
jstring key_string = env->NewStringUTF(pair.first.c_str());
753-
jobject jni_value;
754-
if (pair.second.is_int64()) {
755-
jni_value = env->NewObject(util::integer_java_class_type::GetClass(),
756-
util::bundle::GetMethodId(util::bundle::kConstructor));
757-
}
758-
else if (pair.second.is_double()){
759-
jni_value = env->NewObject(util::double_java_class_type::GetClass(),
760-
util::bundle::GetMethodId(util::bundle::kConstructor));
761-
}else if (pair.second.is_string()) {
762-
jni_value = env->NewObject(util::string_java_class_type::GetClass(),
763-
util::bundle::GetMethodId(util::bundle::kConstructor));
764-
}
765-
else if(pair.second.is_map()){
766-
jobject jni_bundle = MapToBundle(env,pair.second.map());
767-
jobject previous_value = env->CallObjectMethod(
768-
bundle, put_method_id, env->NewStringUTF(key_string.c_str()), jni_bundle);
769-
util::CheckAndClearJniExceptions(env);
770-
if (previous_value) {
771-
env->DeleteLocalRef(previous_value);
772-
}
745+
jobject map =
746+
env->NewObject(util::hash_map::GetClass(),
747+
util::hash_map::GetMethodId(util::hash_map::kConstructor));
748+
util::CheckAndClearJniExceptions(env);
773749

774-
}else {
775-
// A Variant type that couldn't be handled was passed in.
776-
LogError(
777-
"LogEvent(%s): %s is not a valid parameter value type. "
778-
"No event was logged.",
779-
pair.first.c_str(), Variant::TypeName(pair.second.type()));
780-
continue;
781-
}
782-
jobject previous_value = env->CallObjectMethod(
783-
map, put_method_id, key_string, jni_value);
784-
util::CheckAndClearJniExceptions(env);
785-
env->DeleteLocalRef(jni_value);
786-
env->DeleteLocalRef(key_string);
750+
jmethodID put_method_id = util::map::GetMethodId(util::map::kPut);
751+
752+
for (const auto& pair : parameters) {
753+
jstring key_string = env->NewStringUTF(pair.first.c_str());
754+
jobject jni_value;
755+
if (pair.second.is_int64()) {
756+
jni_value =
757+
env->NewObject(util::integer_java_class_type::GetClass(),
758+
util::bundle::GetMethodId(util::bundle::kConstructor));
759+
} else if (pair.second.is_double()) {
760+
jni_value =
761+
env->NewObject(util::double_java_class_type::GetClass(),
762+
util::bundle::GetMethodId(util::bundle::kConstructor));
763+
} else if (pair.second.is_string()) {
764+
jni_value =
765+
env->NewObject(util::string_java_class_type::GetClass(),
766+
util::bundle::GetMethodId(util::bundle::kConstructor));
767+
} else if (pair.second.is_map()) {
768+
jobject jni_bundle = MapToBundle(env, pair.second.map());
769+
jobject previous_value = env->CallObjectMethod(
770+
bundle, put_method_id, env->NewStringUTF(key_string.c_str()),
771+
jni_bundle);
772+
util::CheckAndClearJniExceptions(env);
773+
if (previous_value) {
774+
env->DeleteLocalRef(previous_value);
775+
}
787776

777+
} else {
778+
// A Variant type that couldn't be handled was passed in.
779+
LogError(
780+
"LogEvent(%s): %s is not a valid parameter value type. "
781+
"No event was logged.",
782+
pair.first.c_str(), Variant::TypeName(pair.second.type()));
783+
continue;
788784
}
789-
790-
env->CallVoidMethod(g_analytics_class_instance,
791-
analytics::GetMethodId(analytics::kSetDefaultEventParameters),
792-
map);
793-
785+
jobject previous_value =
786+
env->CallObjectMethod(map, put_method_id, key_string, jni_value);
794787
util::CheckAndClearJniExceptions(env);
795-
env->DeleteLocalRef(map);
788+
env->DeleteLocalRef(jni_value);
789+
env->DeleteLocalRef(key_string);
790+
}
796791

792+
env->CallVoidMethod(
793+
g_analytics_class_instance,
794+
analytics::GetMethodId(analytics::kSetDefaultEventParameters), map);
795+
796+
util::CheckAndClearJniExceptions(env);
797+
env->DeleteLocalRef(map);
797798
}
798799

799800
} // namespace analytics

analytics/src/analytics_ios.mm

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -445,14 +445,14 @@ void SetDefaultEventParameters(const std::map<std::string, Variant>& parameters)
445445
FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
446446
NSMutableDictionary* parameters_dict =
447447
[[NSMutableDictionary alloc] initWithCapacity:parameters.size()];
448-
for (const auto& pair : parameters) {
449-
NSString* key = SafeString(pair.first.c_str());
450-
if (!AddVariantToDictionary(parameters_dict, key, pair.second)) {
451-
LogError("SetDefaultEventParameters: Unsupported type (%s) within map with key %s.",
452-
Variant::TypeName(pair.second.type()), key);
453-
}
448+
for (const auto& pair : parameters) {
449+
NSString* key = SafeString(pair.first.c_str());
450+
if (!AddVariantToDictionary(parameters_dict, key, pair.second)) {
451+
LogError("SetDefaultEventParameters: Unsupported type (%s) within map with key %s.",
452+
Variant::TypeName(pair.second.type()), key);
454453
}
455-
[FIRAnalytics setDefaultEventParameters:parameters_dict];
454+
}
455+
[FIRAnalytics setDefaultEventParameters:parameters_dict];
456456
}
457457

458458
} // namespace analytics

analytics/src/analytics_stub.cc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,8 @@ Future<int64_t> GetSessionIdLastResult() {
187187
}
188188

189189
// Sets the default parameters to be sent with each event.
190-
void SetDefaultEventParameters(const std::map<std::string, Variant>& parameters) {
190+
void SetDefaultEventParameters(
191+
const std::map<std::string, Variant>& parameters) {
191192
FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
192193
}
193194

analytics/src/include/firebase/analytics.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,8 @@ Future<int64_t> GetSessionIdLastResult();
594594
/// @brief Sets the default parameters to be sent with each event.
595595
///
596596
/// @param[in] parameters The parameters to send with each event.
597-
void SetDefaultEventParameters(const std::map<std::string, Variant>& parameters);
597+
void SetDefaultEventParameters(
598+
const std::map<std::string, Variant>& parameters);
598599

599600
} // namespace analytics
600601
} // namespace firebase

analytics/tests/analytics_test.cc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -306,10 +306,12 @@ TEST_F(AnalyticsTest, TestSetDefaultEventParameters) {
306306
{"key6", firebase::Variant::EmptyMap()},
307307
};
308308

309-
AddExpectationAndroid("FirebaseAnalytics.setDefaultEventParameters",
310-
{"key1=value1,key2=12345,key3=1.01,key4=my_value,key5=1"});
311-
AddExpectationApple("+[FIRAnalytics setDefaultEventParameters:]",
312-
{"key1=value1,key2=12345,key3=1.01,key4=my_value,key5=1"});
309+
AddExpectationAndroid(
310+
"FirebaseAnalytics.setDefaultEventParameters",
311+
{"key1=value1,key2=12345,key3=1.01,key4=my_value,key5=1"});
312+
AddExpectationApple(
313+
"+[FIRAnalytics setDefaultEventParameters:]",
314+
{"key1=value1,key2=12345,key3=1.01,key4=my_value,key5=1"});
313315

314316
SetDefaultEventParameters(parameters);
315317
}

release_build_files/readme.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -631,13 +631,12 @@ workflow use only during the development of your app, not for publicly shipping
631631
code.
632632

633633
## Release Notes
634-
### Next Release (12.7.0)
634+
### 12.7.0
635635
- Changes
636-
- Analytics: Added support for default parameters to be sent with each event.
637-
This change lets you use `SetDefaultEventParameters` to set default
638-
parameters to be sent with each event.
639636
- General (iOS): Update to Firebase Cocoapods version 11.9.0.
640637
- General (Android): Update to Firebase Android BoM version 33.10.0.
638+
- Analytics: Added support for setting default parameters to be sent
639+
with each event, using `SetDefaultEventParameters`.
641640

642641
### 12.6.0
643642
- Changes

0 commit comments

Comments
 (0)