Collecting UMA metrics for the UnmaskPrompt.

chrome/browser/ui/autofill/card_unmask_prompt_controller_impl.cc

 // Copyright 2014 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/ui/autofill/card_unmask_prompt_controller_impl.h"
 
 #include "base/bind.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/autofill/risk_util.h"
 #include "chrome/browser/ui/autofill/card_unmask_prompt_view.h"
 #include "chrome/grit/generated_resources.h"
+#include "components/autofill/core/browser/autofill_metrics.h"
 #include "components/autofill/core/common/autofill_pref_names.h"
 #include "components/user_prefs/user_prefs.h"
 #include "content/public/browser/web_contents.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
 namespace autofill {
 
 CardUnmaskPromptControllerImpl::CardUnmaskPromptControllerImpl(
     content::WebContents* web_contents)
     : web_contents_(web_contents),
       card_unmask_view_(nullptr),
+      unmasking_success_(false),
+      unmasking_initial_should_store_pan_(false),
+      unmasking_number_of_attempts_(0),
+      unmasking_allow_retry_(true),
       weak_pointer_factory_(this) {
 }
 
 CardUnmaskPromptControllerImpl::~CardUnmaskPromptControllerImpl() {
   if (card_unmask_view_)
     card_unmask_view_->ControllerGone();
 }
 
+CardUnmaskPromptView* CardUnmaskPromptControllerImpl::CreateAndShowView() {
+  return CardUnmaskPromptView::CreateAndShow(this);
+}
+
 void CardUnmaskPromptControllerImpl::ShowPrompt(
     const CreditCard& card,
     base::WeakPtr<CardUnmaskDelegate> delegate) {
   if (card_unmask_view_)
     card_unmask_view_->ControllerGone();
 
   pending_response_ = CardUnmaskDelegate::UnmaskResponse();
   LoadRiskFingerprint();
   card_ = card;
   delegate_ = delegate;
-  card_unmask_view_ = CardUnmaskPromptView::CreateAndShow(this);
+  card_unmask_view_ = CreateAndShowView();
+  unmasking_success_ = false;
+  unmasking_number_of_attempts_ = 0;
+  unmasking_initial_should_store_pan_ = GetStoreLocallyStartState();
+  unmasking_allow_retry_ = true;
+  AutofillMetrics::LogUnmaskPromptEvent(AutofillMetrics::UNMASK_PROMPT_SHOWN);
 }
 
 void CardUnmaskPromptControllerImpl::OnVerificationResult(
     AutofillClient::GetRealPanResult result) {
   if (!card_unmask_view_)
     return;
 
   base::string16 error_message;
   bool allow_retry = true;
   switch (result) {
-    case AutofillClient::SUCCESS:
+    case AutofillClient::SUCCESS: {
+      unmasking_success_ = true;
+      AutofillMetrics::LogUnmaskPromptEvent(
+          unmasking_number_of_attempts_ == 1
+          ? AutofillMetrics::UNMASK_PROMPT_UNMASKED_CARD_FIRST_ATTEMPT
+          : AutofillMetrics::UNMASK_PROMPT_UNMASKED_CARD_AFTER_FAILED_ATTEMPTS);
+      bool final_should_store_pan =
+          user_prefs::UserPrefs::Get(web_contents_->GetBrowserContext())
+              ->GetBoolean(prefs::kAutofillWalletImportStorageCheckboxState);
+      if (final_should_store_pan) {
+        AutofillMetrics::LogUnmaskPromptEvent(
+            AutofillMetrics::UNMASK_PROMPT_SAVED_CARD_LOCALLY);
+      }
       break;
+    }
 
     case AutofillClient::TRY_AGAIN_FAILURE: {
       error_message = l10n_util::GetStringUTF16(
           IDS_AUTOFILL_CARD_UNMASK_PROMPT_ERROR_TRY_AGAIN);
       break;
     }
 
     case AutofillClient::PERMANENT_FAILURE: {
       error_message = l10n_util::GetStringUTF16(
           IDS_AUTOFILL_CARD_UNMASK_PROMPT_ERROR_PERMANENT);
       allow_retry = false;
       break;
     }
 
     case AutofillClient::NETWORK_ERROR: {
       error_message = l10n_util::GetStringUTF16(
           IDS_AUTOFILL_CARD_UNMASK_PROMPT_ERROR_NETWORK);
       allow_retry = false;
       break;
     }
   }
 
+  unmasking_allow_retry_ = allow_retry;
   card_unmask_view_->GotVerificationResult(error_message, allow_retry);
 }
 
 void CardUnmaskPromptControllerImpl::OnUnmaskDialogClosed() {
   card_unmask_view_ = nullptr;
+  if (!unmasking_success_) {
+    AutofillMetrics::UnmaskPromptEvent event;
+    if (unmasking_number_of_attempts_ == 0) {
+      event = AutofillMetrics::UNMASK_PROMPT_CLOSED_NO_ATTEMPTS;
+    } else if (unmasking_allow_retry_) {
+      event = AutofillMetrics
+          ::UNMASK_PROMPT_CLOSED_FAILED_TO_UNMASK_RETRIABLE_FAILURE;

[Evan Stade, 2015/03/18 21:29:07]

on further reflection, we should perhaps log exactly which kind of failure
(AutofillClient::GetRealPanResult) was last returned. That will tell us for
example how often we get network errors vs. non-network permanent failures.

saving the getrealpanresult also lets us condense unmasking_success_  and
unmasking_allow_retry_  into one member var

[Walter Cacau, 2015/03/18 23:50:05]

Done.

+    } else {
+      event = AutofillMetrics
+          ::UNMASK_PROMPT_CLOSED_FAILED_TO_UNMASK_NON_RETRIABLE_FAILURE;
+    }
+    AutofillMetrics::LogUnmaskPromptEvent(event);
+  }
+  if (unmasking_number_of_attempts_ > 0) {
+    bool final_should_store_pan =
+        user_prefs::UserPrefs::Get(web_contents_->GetBrowserContext())
+            ->GetBoolean(prefs::kAutofillWalletImportStorageCheckboxState);
+    AutofillMetrics::UnmaskPromptEvent event;
+    if (unmasking_initial_should_store_pan_ && final_should_store_pan) {
+      event = AutofillMetrics::UNMASK_PROMPT_LOCAL_SAVE_DID_NOT_OPT_OUT;
+    } else if (!unmasking_initial_should_store_pan_
+               && !final_should_store_pan) {
+      event = AutofillMetrics::UNMASK_PROMPT_LOCAL_SAVE_DID_NOT_OPT_IN;
+    } else if (unmasking_initial_should_store_pan_ && !final_should_store_pan) {
+      event = AutofillMetrics::UNMASK_PROMPT_LOCAL_SAVE_DID_OPT_OUT;
+    } else {
+      event = AutofillMetrics::UNMASK_PROMPT_LOCAL_SAVE_DID_OPT_IN;
+    }
+    AutofillMetrics::LogUnmaskPromptEvent(event);
+  }
   delegate_->OnUnmaskPromptClosed();
 }
 
 void CardUnmaskPromptControllerImpl::OnUnmaskResponse(
     const base::string16& cvc,
     const base::string16& exp_month,
     const base::string16& exp_year,
     bool should_store_pan) {
+  unmasking_number_of_attempts_++;
   card_unmask_view_->DisableAndWaitForVerification();
 
   DCHECK(!cvc.empty());
   pending_response_.cvc = cvc;
   if (ShouldRequestExpirationDate()) {
     pending_response_.exp_month = exp_month;
     pending_response_.exp_year = exp_year;
   }
   pending_response_.should_store_pan = should_store_pan;
   // Remember the last choice the user made (on this device).
@@ skipping 97 matching lines @@
 }
 
 void CardUnmaskPromptControllerImpl::OnDidLoadRiskFingerprint(
     const std::string& risk_data) {
   pending_response_.risk_data = risk_data;
   if (!pending_response_.cvc.empty())
     delegate_->OnUnmaskResponse(pending_response_);
 }
 
 }  // namespace autofill