Add GetSessionId implementation for Android, iOS, and stub. (#1135)

jonsimantov · web-flow · commit ef2a71f32c24 · 2023-01-21T18:15:10.000-08:00
* Add GetSessionId implementation for Android, iOS, and stub. * Format code. * Update header doc * Fix JNI call. * Fix Android build. * Fix JNI call and Future completion call. * Use existing utility function. * Force long parameter. * Explicitly use an int64_t result. * Fix iOS build error. * Add default error code of -1 to GetSessionId error. * Fix type mismatch * Add mutex to completion handler on iOS. * Add retry when running GetSessionId on simulator. * Clarify comment. * Fix mutex * Fix build error. * Format code. * Roll back changes to info.plist files. Revert "Fix build error." This reverts commit 2a4e57f. * Add static cast to int64 type * Add readme note. * Use long long in SWIG mode, rather than int64_t. * Revert "Use long long in SWIG mode, rather than int64_t." This reverts commit 8f096b2. * Add debug output to analytics test. * Also output "Unknown error" if the status message is blank. * Add more error logging. * Fix error handling to respect exception result type. * Change flaky fix * Add more debugging to Android version. * Format code. * Make sure the consent test isn't screwing up the session ID test. * Try moving consent stuff earlier, with delays, to make sure it doesn't mess up GetSessionId. * Expanded the error message. * Fix error message. * Add logging to SetConsent on Android. * Format code. * Add skip for order-dependent test that fails, to avoid a flake. * Fix did_test_setconsent flag * Added log message for skipping test
diff --git a/analytics/integration_test/src/integration_test.cc b/analytics/integration_test/src/integration_test.cc
@@ -43,6 +43,7 @@
 
 namespace firebase_testapp_automated {
 
+using app_framework::LogInfo;
 using app_framework::ProcessEvents;
 using firebase_test_framework::FirebaseTest;
 
@@ -52,9 +53,11 @@ class FirebaseAnalyticsTest : public FirebaseTest {
   static void TearDownTestSuite();
 
   static firebase::App* shared_app_;
+  static bool did_test_setconsent_;
 };
 
-firebase::App* FirebaseAnalyticsTest::shared_app_;
+firebase::App* FirebaseAnalyticsTest::shared_app_ = nullptr;
+bool FirebaseAnalyticsTest::did_test_setconsent_ = false;
 
 void FirebaseAnalyticsTest::SetUpTestSuite() {
 #if defined(__ANDROID__)
@@ -65,6 +68,7 @@ void FirebaseAnalyticsTest::SetUpTestSuite() {
 #endif  // defined(__ANDROID__)
 
   firebase::analytics::Initialize(*shared_app_);
+  did_test_setconsent_ = false;
 }
 
 void FirebaseAnalyticsTest::TearDownTestSuite() {
@@ -89,6 +93,53 @@ TEST_F(FirebaseAnalyticsTest, TestSetCollectionEnabled) {
   firebase::analytics::SetAnalyticsCollectionEnabled(true);
 }
 
+TEST_F(FirebaseAnalyticsTest, TestSetSessionTimeoutDuraction) {
+  firebase::analytics::SetSessionTimeoutDuration(1000 * 60 * 5);
+  firebase::analytics::SetSessionTimeoutDuration(1000 * 60 * 15);
+  firebase::analytics::SetSessionTimeoutDuration(1000 * 60 * 30);
+}
+
+TEST_F(FirebaseAnalyticsTest, TestGetAnalyticsInstanceID) {
+  firebase::Future<std::string> future =
+      firebase::analytics::GetAnalyticsInstanceId();
+  WaitForCompletion(future, "GetAnalyticsInstanceId");
+  EXPECT_FALSE(future.result()->empty());
+}
+
+TEST_F(FirebaseAnalyticsTest, TestGetSessionID) {
+  // On Android, if SetConsent was tested, this test will fail, since the app
+  // needs to be restarted after consent is denied or it won't generate a new
+  // sessionID. To not break the tests, skip this test in that case.
+#if defined(__ANDROID__)
+  if (did_test_setconsent_) {
+    LogInfo(
+        "Skipping TestGetSessionID after TestSetConsent, as it will fail until "
+        "the app is restarted.");
+    GTEST_SKIP();
+    return;
+  }
+#endif
+  firebase::Future<int64_t> future;
+
+  // It can take Analytics a moment to initialize on iOS.
+  // So on iOS/tvOS, retry this test if GetSessionId returns an
+  // error.
+#if TARGET_OS_IPHONE
+  FLAKY_TEST_SECTION_BEGIN();
+#endif  // TARGET_OS_IPHONE
+
+  future = firebase::analytics::GetSessionId();
+  WaitForCompletion(future, "GetSessionId");
+
+#if TARGET_OS_IPHONE
+  FLAKY_TEST_SECTION_END();
+#endif  // TARGET_OS_IPHONE
+
+  EXPECT_TRUE(future.result() != nullptr);
+  EXPECT_NE(*future.result(), static_cast<int64_t>(0L));
+  LogInfo("Got session ID: %" PRId64, *future.result());
+}
+
 TEST_F(FirebaseAnalyticsTest, TestSetConsent) {
   // Can't confirm that these do anything but just run them all to ensure the
   // app doesn't crash.
@@ -107,23 +158,13 @@ TEST_F(FirebaseAnalyticsTest, TestSetConsent) {
   std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
       consent_settings_empty;
   firebase::analytics::SetConsent(consent_settings_empty);
+  ProcessEvents(1000);
   firebase::analytics::SetConsent(consent_settings_deny);
-  firebase::analytics::SetConsent(consent_settings_empty);
+  ProcessEvents(1000);
   firebase::analytics::SetConsent(consent_settings_allow);
-  firebase::analytics::SetConsent(consent_settings_empty);
-}
-
-TEST_F(FirebaseAnalyticsTest, TestSetSessionTimeoutDuraction) {
-  firebase::analytics::SetSessionTimeoutDuration(1000 * 60 * 5);
-  firebase::analytics::SetSessionTimeoutDuration(1000 * 60 * 15);
-  firebase::analytics::SetSessionTimeoutDuration(1000 * 60 * 30);
-}
+  ProcessEvents(1000);
 
-TEST_F(FirebaseAnalyticsTest, TestGetAnalyticsInstanceID) {
-  firebase::Future<std::string> future =
-      firebase::analytics::GetAnalyticsInstanceId();
-  WaitForCompletion(future, "GetAnalyticsInstanceId");
-  EXPECT_FALSE(future.result()->empty());
+  did_test_setconsent_ = true;
 }
 
 TEST_F(FirebaseAnalyticsTest, TestSetProperties) {
diff --git a/analytics/src/analytics_android.cc b/analytics/src/analytics_android.cc
@@ -56,6 +56,8 @@ static const ::firebase::App* g_app = nullptr;
   X(ResetAnalyticsData, "resetAnalyticsData", "()V"),                         \
   X(GetAppInstanceId, "getAppInstanceId",                                     \
     "()Lcom/google/android/gms/tasks/Task;"),                                 \
+  X(GetSessionId, "getSessionId",                                             \
+    "()Lcom/google/android/gms/tasks/Task;"),                                 \
   X(GetInstance, "getInstance", "(Landroid/content/Context;)"                 \
     "Lcom/google/firebase/analytics/FirebaseAnalytics;",                      \
     firebase::util::kMethodTypeStatic)
@@ -203,15 +205,23 @@ void SetConsent(const std::map<ConsentType, ConsentStatus>& consent_settings) {
             env->GetStaticObjectField(analytics_consent_type::GetClass(),
                                       analytics_consent_type::GetFieldId(
                                           analytics_consent_type::kAdStorage));
-        util::CheckAndClearJniExceptions(env);
+        if (util::LogException(env, kLogLevelError,
+                               "Failed to get ConsentTypeAdStorage")) {
+          env->DeleteLocalRef(consent_map);
+          return;
+        }
         break;
       case kConsentTypeAnalyticsStorage:
         consent_type = env->GetStaticObjectField(
             analytics_consent_type::GetClass(),
             analytics_consent_type::GetFieldId(
                 analytics_consent_type::kAnalyticsStorage));
 
-        util::CheckAndClearJniExceptions(env);
+        if (util::LogException(env, kLogLevelError,
+                               "Failed to get ConsentTypeAnalyticsStorage")) {
+          env->DeleteLocalRef(consent_map);
+          return;
+        }
         break;
       default:
         LogError("Unknown ConsentType value: %d", it->first);
@@ -225,21 +235,32 @@ void SetConsent(const std::map<ConsentType, ConsentStatus>& consent_settings) {
             env->GetStaticObjectField(analytics_consent_status::GetClass(),
                                       analytics_consent_status::GetFieldId(
                                           analytics_consent_status::kGranted));
-        util::CheckAndClearJniExceptions(env);
+        if (util::LogException(env, kLogLevelError,
+                               "Failed to get ConsentStatusGranted")) {
+          env->DeleteLocalRef(consent_map);
+          env->DeleteLocalRef(consent_type);
+          return;
+        }
         break;
       case kConsentStatusDenied:
         consent_status =
             env->GetStaticObjectField(analytics_consent_status::GetClass(),
                                       analytics_consent_status::GetFieldId(
                                           analytics_consent_status::kDenied));
-        util::CheckAndClearJniExceptions(env);
+        if (util::LogException(env, kLogLevelError,
+                               "Failed to get ConsentStatusDenied")) {
+          env->DeleteLocalRef(consent_map);
+          env->DeleteLocalRef(consent_type);
+          return;
+        }
         break;
       default:
         LogError("Unknown ConsentStatus value: %d", it->second);
         env->DeleteLocalRef(consent_map);
         env->DeleteLocalRef(consent_type);
         return;
     }
+    LogInfo("SetConsent: %d -> %d", consent_type, consent_status);
     jobject previous = env->CallObjectMethod(consent_map, put_method,
                                              consent_type, consent_status);
     util::CheckAndClearJniExceptions(env);
@@ -495,5 +516,78 @@ Future<std::string> GetAnalyticsInstanceIdLastResult() {
           internal::kAnalyticsFnGetAnalyticsInstanceId));
 }
 
+Future<int64_t> GetSessionId() {
+  FIREBASE_ASSERT_RETURN(Future<int64_t>(), internal::IsInitialized());
+  auto* api = internal::FutureData::Get()->api();
+  const auto future_handle =
+      api->SafeAlloc<int64_t>(internal::kAnalyticsFnGetSessionId);
+  JNIEnv* env = g_app->GetJNIEnv();
+  jobject task =
+      env->CallObjectMethod(g_analytics_class_instance,
+                            analytics::GetMethodId(analytics::kGetSessionId));
+
+  std::string error = util::GetAndClearExceptionMessage(env);
+  if (error.empty()) {
+    util::RegisterCallbackOnTask(
+        env, task,
+        [](JNIEnv* env, jobject result, util::FutureResult result_code,
+           const char* status_message, void* callback_data) {
+          auto* future_data = internal::FutureData::Get();
+          if (future_data) {
+            FutureHandleId future_id =
+                reinterpret_cast<FutureHandleId>(callback_data);
+            FutureHandle handle(future_id);
+
+            if (result_code == util::kFutureResultSuccess) {
+              if (result != nullptr) {
+                // result is a Long class type, unbox it.
+                // It'll get deleted below.
+                uint64_t session_id = util::JLongToInt64(env, result);
+                util::CheckAndClearJniExceptions(env);
+                future_data->api()->CompleteWithResult(handle, 0, "",
+                                                       session_id);
+              } else {
+                // Succeeded, but with a nullptr result.
+                // This occurs when AnalyticsStorage consent is set to Denied or
+                // the session is expired.
+                future_data->api()->CompleteWithResult(
+                    handle, -2,
+                    (status_message && *status_message)
+                        ? status_message
+                        : "AnalyticsStorage consent is set to "
+                          "Denied, or session is expired.",
+                    0);
+              }
+            } else {
+              // Failed, result is an exception, don't parse it.
+              // It'll get deleted below.
+              future_data->api()->CompleteWithResult(
+                  handle, -1,
+                  status_message ? status_message : "Unknown error occurred",
+                  0);
+              LogError("getSessionId() returned an error: %s", status_message);
+            }
+          }
+          if (result) env->DeleteLocalRef(result);
+        },
+        reinterpret_cast<void*>(future_handle.get().id()),
+        internal::kAnalyticsModuleName);
+  } else {
+    LogError("GetSessionId() threw an exception: %s", error.c_str());
+    api->CompleteWithResult(future_handle.get(), -1, error.c_str(),
+                            static_cast<int64_t>(0L));
+  }
+  env->DeleteLocalRef(task);
+
+  return Future<int64_t>(api, future_handle.get());
+}
+
+Future<int64_t> GetSessionIdLastResult() {
+  FIREBASE_ASSERT_RETURN(Future<int64_t>(), internal::IsInitialized());
+  return static_cast<const Future<int64_t>&>(
+      internal::FutureData::Get()->api()->LastResult(
+          internal::kAnalyticsFnGetSessionId));
+}
+
 }  // namespace analytics
 }  // namespace firebase
diff --git a/analytics/src/analytics_common.h b/analytics/src/analytics_common.h
@@ -23,7 +23,11 @@ namespace firebase {
 namespace analytics {
 namespace internal {
 
-enum AnalyticsFn { kAnalyticsFnGetAnalyticsInstanceId, kAnalyticsFnCount };
+enum AnalyticsFn {
+  kAnalyticsFnGetAnalyticsInstanceId,
+  kAnalyticsFnGetSessionId,
+  kAnalyticsFnCount
+};
 
 // Data structure which holds the Future API for this module.
 class FutureData {
diff --git a/analytics/src/analytics_ios.mm b/analytics/src/analytics_ios.mm
@@ -328,5 +328,29 @@ Thread get_id_thread(
       internal::FutureData::Get()->api()->LastResult(internal::kAnalyticsFnGetAnalyticsInstanceId));
 }
 
+Future<int64_t> GetSessionId() {
+  MutexLock lock(g_mutex);
+  FIREBASE_ASSERT_RETURN(Future<int64_t>(), internal::IsInitialized());
+  auto* api = internal::FutureData::Get()->api();
+  const auto future_handle = api->SafeAlloc<int64_t>(internal::kAnalyticsFnGetSessionId);
+  [FIRAnalytics sessionIDWithCompletion:^(int64_t session_id, NSError* _Nullable error) {
+    MutexLock lock(g_mutex);
+    if (!internal::IsInitialized()) return;
+    if (error) {
+      api->Complete(future_handle, -1, util::NSStringToString(error.localizedDescription).c_str());
+    } else {
+      api->CompleteWithResult(future_handle, 0, "", session_id);
+    }
+  }];
+  return MakeFuture<int64_t>(api, future_handle);
+}
+
+Future<int64_t> GetSessionIdLastResult() {
+  MutexLock lock(g_mutex);
+  FIREBASE_ASSERT_RETURN(Future<int64_t>(), internal::IsInitialized());
+  return static_cast<const Future<int64_t>&>(
+      internal::FutureData::Get()->api()->LastResult(internal::kAnalyticsFnGetSessionId));
+}
+
 }  // namespace analytics
 }  // namespace firebase
diff --git a/analytics/src/analytics_stub.cc b/analytics/src/analytics_stub.cc
@@ -150,5 +150,22 @@ Future<std::string> GetAnalyticsInstanceIdLastResult() {
           internal::kAnalyticsFnGetAnalyticsInstanceId));
 }
 
+Future<int64_t> GetSessionId() {
+  FIREBASE_ASSERT_RETURN(Future<int64_t>(), internal::IsInitialized());
+  auto* api = internal::FutureData::Get()->api();
+  const auto future_handle =
+      api->SafeAlloc<int64_t>(internal::kAnalyticsFnGetSessionId);
+  int64_t session_id = 0x5E5510171D570BL;  // "SESSIONIDSTUB", kinda
+  api->CompleteWithResult(future_handle, 0, "", session_id);
+  return Future<int64_t>(api, future_handle.get());
+}
+
+Future<int64_t> GetSessionIdLastResult() {
+  FIREBASE_ASSERT_RETURN(Future<int64_t>(), internal::IsInitialized());
+  return static_cast<const Future<int64_t>&>(
+      internal::FutureData::Get()->api()->LastResult(
+          internal::kAnalyticsFnGetSessionId));
+}
+
 }  // namespace analytics
 }  // namespace firebase
diff --git a/analytics/src/include/firebase/analytics.h b/analytics/src/include/firebase/analytics.h
@@ -547,6 +547,22 @@ Future<std::string> GetAnalyticsInstanceId();
 /// @returns Object which can be used to retrieve the analytics instance ID.
 Future<std::string> GetAnalyticsInstanceIdLastResult();
 
+/// Asynchronously retrieves the identifier of the current app
+/// session.
+///
+/// The session ID retrieval could fail due to Analytics collection
+/// disabled, or if the app session was expired.
+///
+/// @returns The identifier of the current app session. The value is 0 if the
+/// request failed.
+Future<int64_t> GetSessionId();
+
+/// Get the result of the most recent GetSessionId() call.
+///
+/// @returns The identifier of the current app session. The value is 0 if the
+/// request failed.
+Future<int64_t> GetSessionIdLastResult();
+
 }  // namespace analytics
 }  // namespace firebase
 
diff --git a/release_build_files/readme.md b/release_build_files/readme.md
@@ -644,7 +644,8 @@ code.
 ## Release Notes
 ### Upcoming Release
 -   Changes
-    - Analytics: Add `analytics::SetConsent()` API.
+    - Analytics: Add `analytics::SetConsent()` and `analytics::GetSessionId()`
+      APIs.
     - General (macOS): In order to support sandbox mode, apps can define a
       key/value pair for FBAppGroupEntitlementName in Info.plist. The value
       associated with this key will be used to prefix semaphore names
