Add WebAPK installation metrics.

chrome/browser/android/banners/app_banner_infobar_delegate_android.cc

 // Copyright 2015 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 "chrome/browser/android/banners/app_banner_infobar_delegate_android.h"
 
 #include "base/android/jni_android.h"
 #include "base/android/jni_string.h"
 #include "base/guid.h"
 #include "base/location.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/string16.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/android/shortcut_helper.h"
 #include "chrome/browser/android/shortcut_info.h"
 #include "chrome/browser/android/tab_android.h"
 #include "chrome/browser/android/webapk/webapk_installer.h"
+#include "chrome/browser/android/webapk/webapk_metrics.h"
 #include "chrome/browser/banners/app_banner_manager.h"
 #include "chrome/browser/banners/app_banner_metrics.h"
 #include "chrome/browser/banners/app_banner_settings_helper.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/ui/android/infobars/app_banner_infobar_android.h"
 #include "chrome/common/render_messages.h"
 #include "components/rappor/rappor_utils.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/manifest.h"
 #include "jni/AppBannerInfoBarDelegateAndroid_jni.h"
 #include "ui/gfx/android/java_bitmap.h"
 #include "url/gurl.h"
 
 using base::android::ConvertJavaStringToUTF8;
 using base::android::ConvertJavaStringToUTF16;
 using base::android::ConvertUTF8ToJavaString;
 using base::android::ConvertUTF16ToJavaString;
 using base::android::JavaParamRef;
 using base::android::ScopedJavaLocalRef;
 
 namespace {
 
 bool IsInfoEmpty(const ShortcutInfo* info) {
   return !info || info->url.is_empty();
 }
 
+void TrackWebApkInstallationDismissEvents(banners::InstallState install_state) {

[dominickn, 2016/09/19 01:38:39]

As per comment in the .h file, consider making this a private class member
method, with the enum as a private class member?

[Xi Han, 2016/09/20 18:25:18]

Done.

+  if (install_state == banners::WAIT_FOR_START)
+    webapk::TrackInstallEvent(webapk::INSTALL_EVENT_ADD_TO_HOME_SCREEN_DISMISS);

[dominickn, 2016/09/19 01:38:39]

Won't you be in the WAIT_FOR_START state if you trigger a banner, and then the
user dismisses it? ADD_TO_HOME_SCREEN_DISMISS might not be the best name.

[Xi Han, 2016/09/20 18:25:18]

Rename it to DISMISS_BEFORE_INSTALLATION.

+  else if (install_state == banners::INSTALLING)
+    webapk::TrackInstallEvent(webapk::INSTALL_EVENT_ADDING_DISMISS);
+  else if (install_state == banners::INSTALLED)
+    webapk::TrackUserAction(webapk::USER_ACTION_INSTALLED_OPEN_DISMISS);
 }
 
+}  // namespace
+
 namespace banners {
 
 // static
 bool AppBannerInfoBarDelegateAndroid::Create(
     content::WebContents* web_contents,
     base::WeakPtr<AppBannerManager> weak_manager,
     const base::string16& app_title,
     std::unique_ptr<ShortcutInfo> shortcut_info,
     std::unique_ptr<SkBitmap> icon,
     int event_request_id,
     bool is_webapk,
     bool start_install_webapk) {
   const GURL& url = shortcut_info->url;
   auto infobar_delegate =
       base::WrapUnique(new banners::AppBannerInfoBarDelegateAndroid(
           weak_manager, app_title, std::move(shortcut_info), std::move(icon),
           event_request_id, is_webapk));
   auto raw_delegate = infobar_delegate.get();
   auto infobar = base::MakeUnique<AppBannerInfoBarAndroid>(
       std::move(infobar_delegate), url, is_webapk);
   if (!InfoBarService::FromWebContents(web_contents)
            ->AddInfoBar(std::move(infobar)))
     return false;
 
-  if (is_webapk && start_install_webapk)
-    raw_delegate->AcceptWebApk(web_contents);
+  if (is_webapk) {
+    if (start_install_webapk) {
+      raw_delegate->AcceptWebApk(web_contents);
+      webapk::TrackStartType(webapk::STARTED_FROM_ADD_TO_HOME_SCREEN_MENU);
+    } else {
+      webapk::TrackStartType(webapk::TRIGGERED_FROM_BANNER);

[dominickn, 2016/09/19 01:38:39]

See comment in webapk_metrics.h

[Xi Han, 2016/09/20 18:25:18]

Done.

+    }
+  }
 
   return true;
 }
 
 // static
 bool AppBannerInfoBarDelegateAndroid::Create(
     content::WebContents* web_contents,
     const base::string16& app_title,
     const base::android::ScopedJavaGlobalRef<jobject>& native_app_data,
     std::unique_ptr<SkBitmap> icon,
     const std::string& native_app_package,
     const std::string& referrer,
     int event_request_id) {
   auto infobar_delegate = base::WrapUnique(new AppBannerInfoBarDelegateAndroid(
       app_title, native_app_data, std::move(icon), native_app_package, referrer,
       event_request_id));
   return InfoBarService::FromWebContents(web_contents)
       ->AddInfoBar(base::MakeUnique<AppBannerInfoBarAndroid>(
            std::move(infobar_delegate), native_app_data));
 }
 
 AppBannerInfoBarDelegateAndroid::~AppBannerInfoBarDelegateAndroid() {
   weak_ptr_factory_.InvalidateWeakPtrs();
 
   if (!has_user_interaction_) {
-    if (!native_app_data_.is_null())
+    if (!native_app_data_.is_null()) {
       TrackUserResponse(USER_RESPONSE_NATIVE_APP_IGNORED);
-    else if (!IsInfoEmpty(shortcut_info_.get()))
+    } else if (!IsInfoEmpty(shortcut_info_.get())) {
       TrackUserResponse(USER_RESPONSE_WEB_APP_IGNORED);
+      if (is_webapk_)
+        webapk::TrackInstallEvent(webapk::INSTALL_EVENT_BANNER_IGNORED);
+    }
   }
 
   TrackDismissEvent(DISMISS_EVENT_DISMISSED);
   JNIEnv* env = base::android::AttachCurrentThread();
   Java_AppBannerInfoBarDelegateAndroid_destroy(env, java_delegate_);
   java_delegate_.Reset();
 }
 
 void AppBannerInfoBarDelegateAndroid::UpdateInstallState(
     JNIEnv* env,
@@ skipping 56 matching lines @@
   // |webapk_package_name_| is set when the WebAPK has finished installing.
   // If the |webapk_package_name_| is empty, it means the "Add to Homescreen"
   // button is pressed, so request WebAPK installation. Otherwise, it means
   // the "Open" button is pressed, so open the installed WebAPK.
   if (!webapk_package_name_.empty()) {
     // Open the WebAPK.
     ScopedJavaLocalRef<jstring> java_webapk_package_name =
         base::android::ConvertUTF8ToJavaString(env, webapk_package_name_);
     Java_AppBannerInfoBarDelegateAndroid_openWebApk(env, java_delegate_,
                                                     java_webapk_package_name);
-
+    webapk::TrackUserAction(webapk::USER_ACTION_INSTALLED_OPEN);
     SendBannerAccepted(web_contents, "web");
     return true;

[dominickn, 2016/09/19 01:38:39]

If a user already has the WebAPK installed, it seems to me that the following
happens:

InfoBar::Create (install_state_ = WAITING, has_user_interaction_ = false)
InfoBar::AcceptWebAPK (install_state_ = WAITING, has_user_interaction_ = false)
Then what happens?

When the infobar is eventually destroyed, its destructor will call
webapk::TrackInstallEvent(webapk::INSTALL_EVENT_BANNER_IGNORED) in this case,
which doesn't seem right. Have you tested this flow to make sure the right thing
happens?

[Xi Han, 2016/09/20 18:25:18]

This is a good point. I add "has_user_interaction_ = true" in the |AcceptWebApk|
to avoid the webapk::TrackInstallEvent(webapk::INSTALL_EVENT_BANNER_IGNORED)
being called in the destructor.
Additionally, if the WebAPK is already installed: 1) the app banner doesn't
show. 2) we filed a bug to figure out what to do when user clicks A2HS menu if
WebAPK is installed (crbug.com/638614). After fixing the bug of the case 2), I
think another state "Open" should be introduced, and the banner simply shows the
"open" button to point the user to the WebAPK installed. For example:
InfoBar::Create (install_state_ = OPEN, has_user_interaction_ = true)
InfoBar::AcceptWebAPK (install_state_ = OPEN, has_user_interaction_ = true)

[dominickn, 2016/09/21 06:54:27]

This seems reasonable to me.

   }
 
   // Request install the WebAPK.
+  install_state_ = INSTALLING;
   TrackUserResponse(USER_RESPONSE_WEB_APP_ACCEPTED);
   AppBannerSettingsHelper::RecordBannerInstallEvent(
       web_contents, shortcut_info_->url.spec(), AppBannerSettingsHelper::WEB);
 
   Java_AppBannerInfoBarDelegateAndroid_setWebApkInstallingState(
       env, java_delegate_, true);
   UpdateInstallState(env, nullptr);
   WebApkInstaller::FinishCallback callback =
       base::Bind(&AppBannerInfoBarDelegateAndroid::OnWebApkInstallFinished,
                   weak_ptr_factory_.GetWeakPtr());
@@ skipping 14 matching lines @@
     std::unique_ptr<SkBitmap> icon,
     int event_request_id,
     bool is_webapk)
     : weak_manager_(weak_manager),
       app_title_(app_title),
       shortcut_info_(std::move(shortcut_info)),
       icon_(std::move(icon)),
       event_request_id_(event_request_id),
       has_user_interaction_(false),
       is_webapk_(is_webapk),
+      install_state_(WAIT_FOR_START),
       weak_ptr_factory_(this) {
   DCHECK(!IsInfoEmpty(shortcut_info_.get()));
   CreateJavaDelegate();
 }
 
 AppBannerInfoBarDelegateAndroid::AppBannerInfoBarDelegateAndroid(
     const base::string16& app_title,
     const base::android::ScopedJavaGlobalRef<jobject>& native_app_data,
     std::unique_ptr<SkBitmap> icon,
     const std::string& native_app_package,
@@ skipping 45 matching lines @@
   web_contents->GetMainFrame()->Send(
       new ChromeViewMsg_AppBannerDismissed(
           web_contents->GetMainFrame()->GetRoutingID(),
           event_request_id_));
 
   if (!native_app_data_.is_null()) {
     TrackUserResponse(USER_RESPONSE_NATIVE_APP_DISMISSED);
     AppBannerSettingsHelper::RecordBannerDismissEvent(
         web_contents, native_app_package_, AppBannerSettingsHelper::NATIVE);
   } else {
+    if (is_webapk_)
+      TrackWebApkInstallationDismissEvents(install_state_);
     TrackUserResponse(USER_RESPONSE_WEB_APP_DISMISSED);
     AppBannerSettingsHelper::RecordBannerDismissEvent(
         web_contents, shortcut_info_->url.spec(), AppBannerSettingsHelper::WEB);
   }
 }
 
 base::string16 AppBannerInfoBarDelegateAndroid::GetMessageText() const {
   return app_title_;
 }
 
 int AppBannerInfoBarDelegateAndroid::GetButtons() const {
   return BUTTON_OK;
 }
 
 bool AppBannerInfoBarDelegateAndroid::Accept() {
   has_user_interaction_ = true;
 
   content::WebContents* web_contents =
       InfoBarService::WebContentsFromInfoBar(infobar());
   if (!web_contents) {
     TrackDismissEvent(DISMISS_EVENT_ERROR);
     return true;
   }
 
   if (!native_app_data_.is_null())
     return AcceptNativeApp(web_contents);
 
-  if (is_webapk_)
+  if (is_webapk_) {
+    webapk::TrackStartType(webapk::STARTED_FROM_BANNER);
     return AcceptWebApk(web_contents);
+  }
 
   return AcceptWebApp(web_contents);
 }
 
 bool AppBannerInfoBarDelegateAndroid::AcceptNativeApp(
     content::WebContents* web_contents) {
   TrackUserResponse(USER_RESPONSE_NATIVE_APP_ACCEPTED);
   JNIEnv* env = base::android::AttachCurrentThread();
 
   TabAndroid* tab = TabAndroid::FromWebContents(web_contents);
@@ skipping 38 matching lines @@
 void AppBannerInfoBarDelegateAndroid::OnWebApkInstallFinished(
     bool success,
     const std::string& webapk_package_name) {
   JNIEnv* env = base::android::AttachCurrentThread();
   if (!success) {
     // The installation failed.
     if (infobar())
       infobar()->RemoveSelf();
     Java_AppBannerInfoBarDelegateAndroid_showWebApkInstallFailureToast(env);
     DVLOG(1) << "The WebAPK installation failed.";
+    webapk::TrackInstallEvent(webapk::INSTALL_EVENT_FAILED);
     return;
   }
 
   webapk_package_name_ = webapk_package_name;
   ScopedJavaLocalRef<jstring> java_webapk_package_name =
       base::android::ConvertUTF8ToJavaString(env, webapk_package_name);
   Java_AppBannerInfoBarDelegateAndroid_setWebApkInstallingState(
       env, java_delegate_, false);
   Java_AppBannerInfoBarDelegateAndroid_setWebApkPackageName(
       env, java_delegate_, java_webapk_package_name);
   UpdateInstallState(env, nullptr);
+  install_state_ = INSTALLED;
+  webapk::TrackInstallEvent(webapk::INSTALL_EVENT_COMPLETED);
 }
 
 bool AppBannerInfoBarDelegateAndroid::LinkClicked(
     WindowOpenDisposition disposition) {
   if (native_app_data_.is_null())
     return false;
 
   // Try to show the details for the native app.
   JNIEnv* env = base::android::AttachCurrentThread();
 
   content::WebContents* web_contents =
       InfoBarService::WebContentsFromInfoBar(infobar());
   TabAndroid* tab = TabAndroid::FromWebContents(web_contents);
   DCHECK(tab);
 
   Java_AppBannerInfoBarDelegateAndroid_showAppDetails(
       env, java_delegate_, tab->GetJavaObject(), native_app_data_);
 
   TrackDismissEvent(DISMISS_EVENT_BANNER_CLICK);
   return true;
 }
 
 bool RegisterAppBannerInfoBarDelegateAndroid(JNIEnv* env) {
  return RegisterNativesImpl(env);
 }
 
 }  // namespace banners