analytics_android.cc

/*
 * Copyright 2016 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <assert.h>
#include <jni.h>

#include <cstdint>
#include <cstring>

#include "analytics/src/analytics_common.h"
#include "analytics/src/include/firebase/analytics.h"
#include "app/src/assert.h"
#include "app/src/include/firebase/app.h"
#include "app/src/include/firebase/version.h"
#include "app/src/log.h"
#include "app/src/util_android.h"

namespace firebase {
namespace analytics {

DEFINE_FIREBASE_VERSION_STRING(FirebaseAnalytics);

// Global reference to the Android Analytics class instance.
// This is initialized in analytics::Initialize() and never released
// during the lifetime of the application.
static jobject g_analytics_class_instance = nullptr;

// Used to retrieve the JNI environment in order to call methods on the
// Android Analytics class.
static const ::firebase::App* g_app = nullptr;

// Used to setup the cache of Analytics class method IDs to reduce time spent
// looking up methods by string.
// clang-format off
#define ANALYTICS_METHODS(X)                                                  \
  X(SetEnabled, "setAnalyticsCollectionEnabled", "(Z)V"),                     \
  X(SetConsent, "setConsent", "(Ljava/util/Map;)V"),                          \
  X(LogEvent, "logEvent", "(Ljava/lang/String;Landroid/os/Bundle;)V"),        \
  X(SetUserProperty, "setUserProperty",                                       \
    "(Ljava/lang/String;Ljava/lang/String;)V"),                               \
  X(SetUserId, "setUserId", "(Ljava/lang/String;)V"),                         \
  X(SetSessionTimeoutDuration, "setSessionTimeoutDuration", "(J)V"),          \
  X(ResetAnalyticsData, "resetAnalyticsData", "()V"),                         \
  X(GetAppInstanceId, "getAppInstanceId",                                     \
    "()Lcom/google/android/gms/tasks/Task;"),                                 \
  X(GetSessionId, "getSessionId",                                             \
    "()Lcom/google/android/gms/tasks/Task;"),                                 \
  X(SetDefaultEventParameters, "setDefaultEventParameters",                   \
    "(Landroid/os/Bundle;)V"),                                                \
  X(GetInstance, "getInstance", "(Landroid/content/Context;)"                 \
    "Lcom/google/firebase/analytics/FirebaseAnalytics;",                      \
    firebase::util::kMethodTypeStatic)
// clang-format on

// clang-format off
#define ANALYTICS_CONSENT_TYPE_FIELDS(X)                                      \
  X(AnalyticsStorage, "ANALYTICS_STORAGE",                                    \
    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
      util::kFieldTypeStatic),                                                \
  X(AdStorage, "AD_STORAGE",                                                  \
    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
      util::kFieldTypeStatic),                                                \
  X(AdUserData, "AD_USER_DATA",                                               \
    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
      util::kFieldTypeStatic),                                                \
  X(AdPersonalization, "AD_PERSONALIZATION",                                  \
    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
      util::kFieldTypeStatic)

#define ANALYTICS_CONSENT_STATUS_FIELDS(X)                                    \
  X(Granted, "GRANTED",                                                       \
    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentStatus;",        \
      util::kFieldTypeStatic),                                                \
  X(Denied, "DENIED",                                                         \
    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentStatus;",        \
      util::kFieldTypeStatic)
// clang-format on

METHOD_LOOKUP_DECLARATION(analytics, ANALYTICS_METHODS)
METHOD_LOOKUP_DEFINITION(analytics,
                         PROGUARD_KEEP_CLASS
                         "com/google/firebase/analytics/FirebaseAnalytics",
                         ANALYTICS_METHODS)

METHOD_LOOKUP_DECLARATION(analytics_consent_type, METHOD_LOOKUP_NONE,
                          ANALYTICS_CONSENT_TYPE_FIELDS)
METHOD_LOOKUP_DEFINITION(
    analytics_consent_type,
    PROGUARD_KEEP_CLASS
    "com/google/firebase/analytics/FirebaseAnalytics$ConsentType",
    METHOD_LOOKUP_NONE, ANALYTICS_CONSENT_TYPE_FIELDS)

METHOD_LOOKUP_DECLARATION(analytics_consent_status, METHOD_LOOKUP_NONE,
                          ANALYTICS_CONSENT_STATUS_FIELDS)
METHOD_LOOKUP_DEFINITION(
    analytics_consent_status,
    PROGUARD_KEEP_CLASS
    "com/google/firebase/analytics/FirebaseAnalytics$ConsentStatus",
    METHOD_LOOKUP_NONE, ANALYTICS_CONSENT_STATUS_FIELDS)

// Initialize the Analytics API.
void Initialize(const ::firebase::App& app) {
  if (g_app) {
    LogWarning("%s API already initialized", internal::kAnalyticsModuleName);
    return;
  }
  LogInfo("Firebase Analytics API Initializing");
  FIREBASE_ASSERT(!g_analytics_class_instance);
  JNIEnv* env = app.GetJNIEnv();

  if (!util::Initialize(env, app.activity())) {
    return;
  }

  // Cache method pointers.
  if (!analytics::CacheMethodIds(env, app.activity())) {
    util::Terminate(env);
    return;
  }
  if (!analytics_consent_type::CacheFieldIds(env, app.activity())) {
    analytics::ReleaseClass(env);
    util::Terminate(env);
    return;
  }
  if (!analytics_consent_status::CacheFieldIds(env, app.activity())) {
    analytics_consent_type::ReleaseClass(env);
    analytics::ReleaseClass(env);
    util::Terminate(env);
    return;
  }

  internal::FutureData::Create();
  g_app = &app;
  // Get / create the Analytics singleton.
  jobject analytics_class_instance_local = env->CallStaticObjectMethod(
      analytics::GetClass(), analytics::GetMethodId(analytics::kGetInstance),
      app.activity());
  util::CheckAndClearJniExceptions(env);
  // Keep a reference to the Analytics singleton.
  g_analytics_class_instance =
      env->NewGlobalRef(analytics_class_instance_local);
  FIREBASE_ASSERT(g_analytics_class_instance);

  env->DeleteLocalRef(analytics_class_instance_local);
  internal::RegisterTerminateOnDefaultAppDestroy();
  LogInfo("%s API Initialized", internal::kAnalyticsModuleName);
}

namespace internal {

// Determine whether the analytics module is initialized.
bool IsInitialized() { return g_app != nullptr; }

}  // namespace internal

// Clean up the API.
void Terminate() {
  if (!g_app) {
    LogWarning("%s API already shut down", internal::kAnalyticsModuleName);
    return;
  }
  JNIEnv* env = g_app->GetJNIEnv();
  util::CancelCallbacks(env, internal::kAnalyticsModuleName);
  internal::UnregisterTerminateOnDefaultAppDestroy();
  internal::FutureData::Destroy();
  g_app = nullptr;
  env->DeleteGlobalRef(g_analytics_class_instance);
  g_analytics_class_instance = nullptr;
  analytics_consent_status::ReleaseClass(env);
  analytics_consent_type::ReleaseClass(env);
  analytics::ReleaseClass(env);
  util::Terminate(env);
}

// Enable / disable analytics and reporting.
void SetAnalyticsCollectionEnabled(bool enabled) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  jboolean collection_enabled = enabled;
  env->CallVoidMethod(g_analytics_class_instance,
                      analytics::GetMethodId(analytics::kSetEnabled),
                      collection_enabled);
  util::CheckAndClearJniExceptions(env);
}

void SetConsent(const std::map<ConsentType, ConsentStatus>& consent_settings) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();

  jobject consent_map =
      env->NewObject(util::hash_map::GetClass(),
                     util::hash_map::GetMethodId(util::hash_map::kConstructor));
  util::CheckAndClearJniExceptions(env);
  jmethodID put_method = util::map::GetMethodId(util::map::kPut);
  for (auto it = consent_settings.begin(); it != consent_settings.end(); ++it) {
    jobject consent_type;
    switch (it->first) {
      case kConsentTypeAdStorage:
        consent_type =
            env->GetStaticObjectField(analytics_consent_type::GetClass(),
                                      analytics_consent_type::GetFieldId(
                                          analytics_consent_type::kAdStorage));
        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));

        if (util::LogException(env, kLogLevelError,
                               "Failed to get ConsentTypeAnalyticsStorage")) {
          env->DeleteLocalRef(consent_map);
          return;
        }
        break;
      case kConsentTypeAdUserData:
        consent_type =
            env->GetStaticObjectField(analytics_consent_type::GetClass(),
                                      analytics_consent_type::GetFieldId(
                                          analytics_consent_type::kAdUserData));

        if (util::LogException(env, kLogLevelError,
                               "Failed to get ConsentTypeAdUserData")) {
          env->DeleteLocalRef(consent_map);
          return;
        }
        break;
      case kConsentTypeAdPersonalization:
        consent_type = env->GetStaticObjectField(
            analytics_consent_type::GetClass(),
            analytics_consent_type::GetFieldId(
                analytics_consent_type::kAdPersonalization));

        if (util::LogException(env, kLogLevelError,
                               "Failed to get ConsentTypeAdPersonalization")) {
          env->DeleteLocalRef(consent_map);
          return;
        }
        break;
      default:
        LogError("Unknown ConsentType value: %d", it->first);
        env->DeleteLocalRef(consent_map);
        return;
    }
    jobject consent_status;
    switch (it->second) {
      case kConsentStatusGranted:
        consent_status =
            env->GetStaticObjectField(analytics_consent_status::GetClass(),
                                      analytics_consent_status::GetFieldId(
                                          analytics_consent_status::kGranted));
        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));
        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);
    if (previous) env->DeleteLocalRef(previous);
    env->DeleteLocalRef(consent_type);
    env->DeleteLocalRef(consent_status);
  }
  env->CallVoidMethod(g_analytics_class_instance,
                      analytics::GetMethodId(analytics::kSetConsent),
                      consent_map);
  util::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(consent_map);
}

// Build an event bundle using build_bundle and log it.
template <typename BuildBundleFunction>
void LogEvent(JNIEnv* env, const char* name, BuildBundleFunction build_bundle) {
  jobject bundle =
      env->NewObject(util::bundle::GetClass(),
                     util::bundle::GetMethodId(util::bundle::kConstructor));
  build_bundle(bundle);
  jstring event_name_string = env->NewStringUTF(name);
  env->CallVoidMethod(g_analytics_class_instance,
                      analytics::GetMethodId(analytics::kLogEvent),
                      event_name_string, bundle);
  if (util::CheckAndClearJniExceptions(env)) {
    LogError("Failed to log event '%s'", name);
  }
  env->DeleteLocalRef(event_name_string);
  env->DeleteLocalRef(bundle);
}

// Add a string to a Bundle.
void AddToBundle(JNIEnv* env, jobject bundle, const char* key,
                 const char* value) {
  jstring key_string = env->NewStringUTF(key);
  jstring value_string = env->NewStringUTF(value);
  env->CallVoidMethod(bundle,
                      util::bundle::GetMethodId(util::bundle::kPutString),
                      key_string, value_string);
  util::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(value_string);
  env->DeleteLocalRef(key_string);
}

// Add a double to a Bundle.
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::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(key_string);
}

// Add a 64-bit integer to a Bundle.
void AddToBundle(JNIEnv* env, jobject bundle, const char* key, int64_t value) {
  jstring key_string = env->NewStringUTF(key);
  env->CallVoidMethod(bundle, util::bundle::GetMethodId(util::bundle::kPutLong),
                      key_string, static_cast<jlong>(value));
  util::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(key_string);
}

// Add an ArrayList to the given Bundle.
void AddArrayListToBundle(JNIEnv* env, jobject bundle, const char* key,
                          jobject arraylist) {
  jstring key_string = env->NewStringUTF(key);
  env->CallVoidMethod(
      bundle, util::bundle::GetMethodId(util::bundle::kPutParcelableArrayList),
      key_string, arraylist);
  util::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(key_string);
}

// Add a Bundle to the given Bundle.
void AddBundleToBundle(JNIEnv* env, jobject bundle, const char* key,
                       jobject inner_bundle) {
  jstring key_string = env->NewStringUTF(key);
  env->CallVoidMethod(bundle,
                      util::bundle::GetMethodId(util::bundle::kPutBundle),
                      key_string, inner_bundle);
  util::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(key_string);
}

// Declared here so that it can be used, defined below.
jobject MapToBundle(JNIEnv* env, const std::map<Variant, Variant>& map);

// Converts the given vector into a Java ArrayList. It is up to the
// caller to delete the local reference when done.
jobject VectorOfMapsToArrayList(JNIEnv* env,
                                const std::vector<Variant>& vector) {
  jobject arraylist = env->NewObject(
      util::array_list::GetClass(),
      util::array_list::GetMethodId(util::array_list::kConstructor));

  for (const Variant& element : vector) {
    if (element.is_map()) {
      jobject bundle = MapToBundle(env, element.map());
      env->CallBooleanMethod(
          arraylist, util::array_list::GetMethodId(util::array_list::kAdd),
          bundle);
      util::CheckAndClearJniExceptions(env);
      env->DeleteLocalRef(bundle);
    } else {
      LogError("VectorOfMapsToArrayList: Unsupported type (%s) within vector.",
               Variant::TypeName(element.type()));
    }
  }
  return arraylist;
}

// Converts and adds the Variant to the given Bundle.
bool AddVariantToBundle(JNIEnv* env, jobject bundle, const char* key,
                        const Variant& value) {
  if (value.is_int64()) {
    AddToBundle(env, bundle, key, value.int64_value());
  } else if (value.is_double()) {
    AddToBundle(env, bundle, key, value.double_value());
  } else if (value.is_string()) {
    AddToBundle(env, bundle, key, value.string_value());
  } else if (value.is_bool()) {
    // Just use integer 0 or 1.
    AddToBundle(env, bundle, key,
                value.bool_value() ? static_cast<int64_t>(1L)
                                   : static_cast<int64_t>(0L));
  } else if (value.is_null()) {
    // Just use integer 0 for null.
    AddToBundle(env, bundle, key, static_cast<int64_t>(0L));
  } else if (value.is_vector()) {
    jobject arraylist = VectorOfMapsToArrayList(env, value.vector());
    AddArrayListToBundle(env, bundle, key, arraylist);
    env->DeleteLocalRef(arraylist);
  } else if (value.is_map()) {
    jobject inner_bundle = MapToBundle(env, value.map());
    AddBundleToBundle(env, bundle, key, inner_bundle);
    env->DeleteLocalRef(inner_bundle);
  } else {
    // A Variant type that couldn't be handled was passed in.
    return false;
  }
  return true;
}

// Converts the given map into a Java Bundle. It is up to the caller
// to delete the local reference when done.
jobject MapToBundle(JNIEnv* env, const std::map<Variant, Variant>& map) {
  jobject bundle =
      env->NewObject(util::bundle::GetClass(),
                     util::bundle::GetMethodId(util::bundle::kConstructor));
  for (const auto& pair : map) {
    // Only add elements that use a string key
    if (!pair.first.is_string()) {
      continue;
    }
    if (!AddVariantToBundle(env, bundle, pair.first.string_value(),
                            pair.second)) {
      LogError("MapToBundle: Unsupported type (%s) within map with key %s.",
               Variant::TypeName(pair.second.type()),
               pair.first.string_value());
    }
    util::CheckAndClearJniExceptions(env);
  }
  return bundle;
}

// Log an event with one string parameter.
void LogEvent(const char* name, const char* parameter_name,
              const char* parameter_value) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  LogEvent(env, name, [env, parameter_name, parameter_value](jobject bundle) {
    AddToBundle(env, bundle, parameter_name, parameter_value);
  });
}

// Log an event with one float parameter.
void LogEvent(const char* name, const char* parameter_name,
              const double parameter_value) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  LogEvent(env, name, [env, parameter_name, parameter_value](jobject bundle) {
    AddToBundle(env, bundle, parameter_name, parameter_value);
  });
}

// Log an event with one 64-bit integer parameter.
void LogEvent(const char* name, const char* parameter_name,
              const int64_t parameter_value) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  LogEvent(env, name, [env, parameter_name, parameter_value](jobject bundle) {
    AddToBundle(env, bundle, parameter_name, parameter_value);
  });
}

/// Log an event with one integer parameter (stored as a 64-bit integer).
void LogEvent(const char* name, const char* parameter_name,
              const int parameter_value) {
  LogEvent(name, parameter_name, static_cast<int64_t>(parameter_value));
}

/// Log an event with no parameters.
void LogEvent(const char* name) {
  LogEvent(name, nullptr, static_cast<size_t>(0));
}

// Log an event with associated parameters.
void LogEvent(const char* name, const Parameter* parameters,
              size_t number_of_parameters) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  LogEvent(env, name, [env, parameters, number_of_parameters](jobject bundle) {
    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(
            "LogEvent(%s): %s is not a valid parameter value type. "
            "No event was logged.",
            parameter.name, Variant::TypeName(parameter.value.type()));
      }
    }
  });
}

// Convert std::map<std::string, Variant> to Bundle.
jobject StringVariantMapToBundle(JNIEnv* env,
                                 const std::map<std::string, Variant>& map) {
  jobject bundle =
      env->NewObject(util::bundle::GetClass(),
                     util::bundle::GetMethodId(util::bundle::kConstructor));
  for (const auto& pair : map) {
    // Bundle keys must be strings.
    const char* key = pair.first.c_str();
    const Variant& value = pair.second;
    // AddVariantToBundle handles all Variant types, including null.
    if (!AddVariantToBundle(env, bundle, key, value)) {
      LogError("SetDefaultEventParameters: Unsupported type (%s) for key %s.",
               Variant::TypeName(value.type()), key);
    }
    // CheckAndClearJniExceptions is called within AddVariantToBundle.
  }
  return bundle;
}

void SetDefaultEventParameters(
    const std::map<std::string, Variant>& default_parameters) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();

  jobject bundle = StringVariantMapToBundle(env, default_parameters);

  env->CallVoidMethod(
      g_analytics_class_instance,
      analytics::GetMethodId(analytics::kSetDefaultEventParameters), bundle);

  util::CheckAndClearJniExceptions(env);
  env->DeleteLocalRef(bundle);
}

/// 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.
void InitiateOnDeviceConversionMeasurementWithEmailAddress(
    const char* email_address) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  // No-op on Android
}

/// Initiates on-device conversion measurement given a phone number on iOS
/// (no-op on Android). On iOS, requires dependency
/// GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a
/// no-op.
void InitiateOnDeviceConversionMeasurementWithPhoneNumber(
    const char* phone_number) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  // No-op on Android
}

/// Initiates on-device conversion measurement given a hashed user email address
/// on iOS (no-op on Android). On iOS, requires dependency
/// GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a
/// no-op.
void InitiateOnDeviceConversionMeasurementWithHashedEmailAddress(
    std::vector<unsigned char> hashed_email) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  // No-op on Android
}

/// Initiates on-device conversion measurement given a hashed phone number on
/// iOS (no-op on Android). On iOS, requires dependency
/// GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a
/// no-op.
void InitiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
    std::vector<unsigned char> hashed_phone) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  // No-op on Android
}

// Set a user property to the given value.
void SetUserProperty(const char* name, const char* value) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  jstring property_name = env->NewStringUTF(name);
  jstring property_value = value ? env->NewStringUTF(value) : nullptr;
  env->CallVoidMethod(g_analytics_class_instance,
                      analytics::GetMethodId(analytics::kSetUserProperty),
                      property_name, property_value);
  if (util::CheckAndClearJniExceptions(env)) {
    LogError("Unable to set user property name='%s', value='%s'", name, value);
  }
  if (property_value) env->DeleteLocalRef(property_value);
  env->DeleteLocalRef(property_name);
}

// Sets the user ID property. This feature must be used in accordance with
// <a href="https://www.google.com/policies/privacy">
// Google's Privacy Policy</a>
void SetUserId(const char* user_id) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  jstring user_id_value = user_id ? env->NewStringUTF(user_id) : nullptr;
  env->CallVoidMethod(g_analytics_class_instance,
                      analytics::GetMethodId(analytics::kSetUserId),
                      user_id_value);
  if (util::CheckAndClearJniExceptions(env)) {
    LogError("Unable to set user ID '%s'", user_id);
  }
  if (user_id_value) env->DeleteLocalRef(user_id_value);
}

// Sets the duration of inactivity that terminates the current session.
void SetSessionTimeoutDuration(int64_t milliseconds) {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  env->CallVoidMethod(
      g_analytics_class_instance,
      analytics::GetMethodId(analytics::kSetSessionTimeoutDuration),
      milliseconds);
  util::CheckAndClearJniExceptions(env);
}

void ResetAnalyticsData() {
  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  env->CallVoidMethod(g_analytics_class_instance,
                      analytics::GetMethodId(analytics::kResetAnalyticsData));
  util::CheckAndClearJniExceptions(env);
}

Future<std::string> GetAnalyticsInstanceId() {
  FIREBASE_ASSERT_RETURN(GetAnalyticsInstanceIdLastResult(),
                         internal::IsInitialized());
  JNIEnv* env = g_app->GetJNIEnv();
  auto* api = internal::FutureData::Get()->api();
  const auto safe_future_handle =
      api->SafeAlloc<std::string>(internal::kAnalyticsFnGetAnalyticsInstanceId);
  const auto future_handle = safe_future_handle.get();
  jobject task = env->CallObjectMethod(
      g_analytics_class_instance,
      analytics::GetMethodId(analytics::kGetAppInstanceId));
  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) {
            bool success =
                result_code == util::kFutureResultSuccess && result != nullptr;
            FutureHandleId future_id =
                reinterpret_cast<FutureHandleId>(callback_data);
            FutureHandle handle(future_id);
            future_data->api()->CompleteWithResult(
                handle, success ? 0 : -1,
                success          ? ""
                : status_message ? status_message
                                 : "Unknown error occurred",
                // Both JStringToString and GetMessageFromException are
                // able to handle a nullptr being passed in, and neither
                // deletes the object passed in (so delete it below).
                success ? util::JStringToString(env, result)
                        : util::GetMessageFromException(env, result));
          }
          if (result) env->DeleteLocalRef(result);
        },
        reinterpret_cast<void*>(safe_future_handle.get().id()),
        internal::kAnalyticsModuleName);
    env->DeleteLocalRef(task);
  } else {
    api->CompleteWithResult(safe_future_handle, -1, error.c_str(),
                            std::string());
  }
  return Future<std::string>(api, future_handle);
}

Future<std::string> GetAnalyticsInstanceIdLastResult() {
  FIREBASE_ASSERT_RETURN(Future<std::string>(), internal::IsInitialized());
  return static_cast<const Future<std::string>&>(
      internal::FutureData::Get()->api()->LastResult(
          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