android_webview/browser/aw_metrics_service_client.cc

// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "android_webview/browser/aw_metrics_service_client.h"

#include "android_webview/browser/aw_metrics_log_uploader.h"
#include "android_webview/common/aw_switches.h"
#include "android_webview/common/aw_version_info_values.h"
#include "android_webview/jni/AwMetricsServiceClient_jni.h"
#include "base/android/build_info.h"
#include "base/android/jni_string.h"
#include "base/bind.h"
#include "base/files/file_util.h"
#include "base/guid.h"
#include "base/i18n/rtl.h"
#include "base/lazy_instance.h"
#include "base/path_service.h"
#include "base/strings/string16.h"
#include "base/threading/sequenced_worker_pool.h"
#include "components/metrics/call_stack_profile_metrics_provider.h"
#include "components/metrics/enabled_state_provider.h"
#include "components/metrics/gpu/gpu_metrics_provider.h"
#include "components/metrics/metrics_log_uploader.h"
#include "components/metrics/metrics_pref_names.h"
#include "components/metrics/metrics_service.h"
#include "components/metrics/metrics_state_manager.h"
#include "components/metrics/profiler/profiler_metrics_provider.h"
#include "components/metrics/ui/screen_info_metrics_provider.h"
#include "components/metrics/url_constants.h"
#include "components/metrics/version_utils.h"
#include "components/prefs/pref_service.h"
#include "components/version_info/channel_android.h"
#include "components/version_info/version_info.h"
#include "content/public/browser/browser_thread.h"

namespace android_webview {

base::LazyInstance<AwMetricsServiceClient>::Leaky g_lazy_instance_;

namespace {

const int kUploadIntervalMinutes = 30;

// A GUID in text form is composed of 32 hex digits and 4 hyphens.
const size_t GUID_SIZE = 32 + 4;

// Client ID of the app, read and cached synchronously at startup
base::LazyInstance<std::string>::Leaky g_client_id_guid =
    LAZY_INSTANCE_INITIALIZER;

// Callbacks for metrics::MetricsStateManager::Create. Store/LoadClientInfo
// allow Windows Chrome to back up ClientInfo. They're no-ops for WebView.

void StoreClientInfo(const metrics::ClientInfo& client_info) {}

std::unique_ptr<metrics::ClientInfo> LoadClientInfo() {
  std::unique_ptr<metrics::ClientInfo> client_info;
  return client_info;
}

version_info::Channel GetChannelFromPackageName() {
  JNIEnv* env = base::android::AttachCurrentThread();
  std::string package_name = base::android::ConvertJavaStringToUTF8(
      env, Java_AwMetricsServiceClient_getWebViewPackageName(env));
  // We can't determine the channel for stand-alone WebView, since it has the
  // same package name across channels. It will always be "unknown".
  return version_info::ChannelFromPackageName(package_name.c_str());
}

}  // namespace

// static
AwMetricsServiceClient* AwMetricsServiceClient::GetInstance() {
  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
  return g_lazy_instance_.Pointer();
}

void AwMetricsServiceClient::GetOrCreateGUID() {
  // Check for cached GUID
  if (g_client_id_guid.Get().length() == GUID_SIZE)
    return;

  // UMA uses randomly-generated GUIDs (globally unique identifiers) to
  // anonymously identify logs. Every WebView-using app on every device
  // is given a GUID, stored in this file in the app's data directory.
  base::FilePath user_data_dir;
  if (!PathService::Get(base::DIR_ANDROID_APP_DATA, &user_data_dir)) {
    LOG(ERROR) << "Failed to get app data directory for Android WebView";

    // Generate a 1-time GUID so metrics can still be collected
    g_client_id_guid.Get() = base::GenerateGUID();
    return;
  }

  const base::FilePath guid_file_path =
      user_data_dir.Append(FILE_PATH_LITERAL("metrics_guid"));

  // Try to read an existing GUID.
  if (base::ReadFileToStringWithMaxSize(guid_file_path, &g_client_id_guid.Get(),
                                        GUID_SIZE)) {
    if (base::IsValidGUID(g_client_id_guid.Get()))
      return;
    LOG(ERROR) << "Overwriting invalid GUID";
  }

  // We must write a new GUID.
  g_client_id_guid.Get() = base::GenerateGUID();
  if (!base::WriteFile(guid_file_path, g_client_id_guid.Get().c_str(),
                       g_client_id_guid.Get().size())) {
    // If writing fails, proceed anyway with the new GUID. It won't be persisted
    // to the next run, but we can still collect metrics with this 1-time GUID.
    LOG(ERROR) << "Failed to write new GUID";
  }
}

void AwMetricsServiceClient::Initialize(
    PrefService* pref_service,
    net::URLRequestContextGetter* request_context) {
  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

  DCHECK(pref_service_ == nullptr);  // Initialize should only happen once.
  DCHECK(request_context_ == nullptr);
  pref_service_ = pref_service;
  request_context_ = request_context;
  channel_ = GetChannelFromPackageName();

  // If Finch is enabled for WebView the GUID will already have been read at
  // startup
  if (base::CommandLine::ForCurrentProcess()->HasSwitch(
          switches::kEnableWebViewFinch)) {
    InitializeWithGUID();
  } else {
    content::BrowserThread::PostTaskAndReply(
        content::BrowserThread::FILE, FROM_HERE,
        base::Bind(&AwMetricsServiceClient::GetOrCreateGUID),
        base::Bind(&AwMetricsServiceClient::InitializeWithGUID,
                   base::Unretained(this)));
  }
}

void AwMetricsServiceClient::InitializeWithGUID() {
  // The guid must have already been initialized at this point, either
  // synchronously or asynchronously depending on the kEnableWebViewFinch flag
  DCHECK_EQ(g_client_id_guid.Get().length(), GUID_SIZE);
  pref_service_->SetString(metrics::prefs::kMetricsClientID,
                           g_client_id_guid.Get());

  metrics_state_manager_ = metrics::MetricsStateManager::Create(
      pref_service_, this, base::string16(), base::Bind(&StoreClientInfo),
      base::Bind(&LoadClientInfo));

  metrics_service_.reset(new ::metrics::MetricsService(
      metrics_state_manager_.get(), this, pref_service_));

  metrics_service_->RegisterMetricsProvider(
      std::unique_ptr<metrics::MetricsProvider>(
          new metrics::NetworkMetricsProvider));

  metrics_service_->RegisterMetricsProvider(
      std::unique_ptr<metrics::MetricsProvider>(
          new metrics::GPUMetricsProvider));

  metrics_service_->RegisterMetricsProvider(
      std::unique_ptr<metrics::MetricsProvider>(
          new metrics::ScreenInfoMetricsProvider));

  metrics_service_->RegisterMetricsProvider(
      std::unique_ptr<metrics::MetricsProvider>(
          new metrics::ProfilerMetricsProvider()));

  metrics_service_->RegisterMetricsProvider(
      std::unique_ptr<metrics::MetricsProvider>(
          new metrics::CallStackProfileMetricsProvider));

  metrics_service_->InitializeMetricsRecordingState();

  JNIEnv* env = base::android::AttachCurrentThread();
  Java_AwMetricsServiceClient_nativeInitialized(env);
}

bool AwMetricsServiceClient::IsConsentGiven() {
  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
  return is_enabled_;
}

void AwMetricsServiceClient::SetMetricsEnabled(bool enabled) {
  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

  // For now, UMA is only enabled on Android N+.
  if (base::android::BuildInfo::GetInstance()->sdk_int() <
      base::android::SDK_VERSION_NOUGAT) {
    return;
  }

  if (is_enabled_ != enabled) {
    if (enabled) {
      metrics_service_->Start();
    } else {
      metrics_service_->Stop();
    }
    is_enabled_ = enabled;
  }
}

metrics::MetricsService* AwMetricsServiceClient::GetMetricsService() {
  return metrics_service_.get();
}

// In Chrome, UMA and Breakpad are enabled/disabled together by the same
// checkbox and they share the same client ID (a.k.a. GUID). SetMetricsClientId
// is intended to provide the ID to Breakpad. In WebView, UMA and Breakpad are
// independent, so this is a no-op.
void AwMetricsServiceClient::SetMetricsClientId(const std::string& client_id) {}

int32_t AwMetricsServiceClient::GetProduct() {
  return ::metrics::ChromeUserMetricsExtension::ANDROID_WEBVIEW;
}

std::string AwMetricsServiceClient::GetApplicationLocale() {
  return base::i18n::GetConfiguredLocale();
}

bool AwMetricsServiceClient::GetBrand(std::string* brand_code) {
  // WebView doesn't use brand codes.
  return false;
}

metrics::SystemProfileProto::Channel AwMetricsServiceClient::GetChannel() {
  return metrics::AsProtobufChannel(channel_);
}

std::string AwMetricsServiceClient::GetVersionString() {
  return PRODUCT_VERSION;
}

void AwMetricsServiceClient::CollectFinalMetricsForLog(
    const base::Closure& done_callback) {
  done_callback.Run();
}

std::unique_ptr<metrics::MetricsLogUploader>
AwMetricsServiceClient::CreateUploader(
    base::StringPiece server_url,
    base::StringPiece mime_type,
    metrics::MetricsLogUploader::MetricServiceType service_type,
    const metrics::MetricsLogUploader::UploadCallback& on_upload_complete) {
  // |server_url| and |mime_type| are unused because WebView uses the platform
  // logging mechanism instead of the normal UMA server.
  return std::unique_ptr<::metrics::MetricsLogUploader>(
      new AwMetricsLogUploader(on_upload_complete));
}

base::TimeDelta AwMetricsServiceClient::GetStandardUploadInterval() {
  // The platform logging mechanism is responsible for upload frequency; this
  // just specifies how frequently to provide logs to the platform.
  return base::TimeDelta::FromMinutes(kUploadIntervalMinutes);
}

AwMetricsServiceClient::AwMetricsServiceClient()
    : is_enabled_(false),
      pref_service_(nullptr),
      request_context_(nullptr),
      channel_(version_info::Channel::UNKNOWN) {}

AwMetricsServiceClient::~AwMetricsServiceClient() {}

// static
void SetMetricsEnabled(JNIEnv* env,
                       const base::android::JavaParamRef<jclass>& jcaller,
                       jboolean enabled) {
  g_lazy_instance_.Pointer()->SetMetricsEnabled(enabled);
}

}  // namespace android_webview