UKM that threads together multiple form interaction events.

components/autofill/core/browser/autofill_metrics.cc

 // Copyright 2013 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 "components/autofill/core/browser/autofill_metrics.h"
 
 #include <algorithm>
+#include <utility>
 
 #include "base/logging.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/metrics/sparse_histogram.h"
 #include "base/metrics/user_metrics.h"
 #include "base/time/time.h"
 #include "components/autofill/core/browser/autofill_experiments.h"
 #include "components/autofill/core/browser/autofill_type.h"
 #include "components/autofill/core/browser/form_structure.h"
 #include "components/autofill/core/common/form_data.h"
 #include "components/ukm/ukm_entry_builder.h"
 
 namespace internal {
 const char kUKMCardUploadDecisionEntryName[] = "Autofill.CardUploadDecision";
 const char kUKMCardUploadDecisionMetricName[] = "UploadDecision";
 const char kUKMDeveloperEngagementEntryName[] = "Autofill.DeveloperEngagement";
 const char kUKMDeveloperEngagementMetricName[] = "DeveloperEngagement";
+const char kUKMFormInteractionsEntryName[] = "Autofill.FormInteractions";
+const char kUKMFormInteractionsAutofillFormSubmittedStateMetricName[] =
+    "AutofillFormSubmittedState";
+const char kUKMFormInteractionsUserHappinessMetricMetricName[] =
+    "UserHappinessMetric";
+const char kUKMFormInteractionsAddressFormEventMetricName[] =
+    "FormEvent.Address";
+const char kUKMFormInteractionsCreditCardFormEventMetricName[] =
+    "FormEvent.CreditCard";
+const char kUKMFormInteractionsUnmaskPromptEventMetricName[] =
+    "UnmaskPromptEvent";
 }  // namespace internal
 
 namespace autofill {
 
 namespace {
 
 // Note: if adding an enum value here, update the corresponding description for
 // AutofillTypeQualityByFieldType in histograms.xml.
 enum FieldTypeGroupForMetrics {
   GROUP_AMBIGUOUS = 0,
@@ skipping 574 matching lines @@
 
 // static
 void AutofillMetrics::LogProfileActionOnFormSubmitted(
     AutofillProfileAction action) {
   UMA_HISTOGRAM_ENUMERATION("Autofill.ProfileActionOnFormSubmitted", action,
                             AUTOFILL_PROFILE_ACTION_ENUM_SIZE);
 }
 
 // static
 void AutofillMetrics::LogAutofillFormSubmittedState(
-    AutofillFormSubmittedState state) {
+    AutofillFormSubmittedState state,
+    AutofillMetrics::UkmLogger* ukm_logger) {
   UMA_HISTOGRAM_ENUMERATION("Autofill.FormSubmittedState", state,
                             AUTOFILL_FORM_SUBMITTED_STATE_ENUM_SIZE);
 
   switch (state) {
     case NON_FILLABLE_FORM_OR_NEW_DATA:
       base::RecordAction(
           base::UserMetricsAction("Autofill_FormSubmitted_NonFillable"));
       break;
 
     case FILLABLE_FORM_AUTOFILLED_ALL:
@@ skipping 13 matching lines @@
 
     case FILLABLE_FORM_AUTOFILLED_NONE_DID_NOT_SHOW_SUGGESTIONS:
       base::RecordAction(base::UserMetricsAction(
           "Autofill_FormSubmitted_FilledNone_SuggestionsNotShown"));
       break;
 
     default:
       NOTREACHED();
       break;
   }
+  ukm_logger->LogAutofillFormSubmittedState(state);
 }
 
 // static
 void AutofillMetrics::LogDetermineHeuristicTypesTiming(
     const base::TimeDelta& duration) {
   UMA_HISTOGRAM_TIMES("Autofill.Timing.DetermineHeuristicTypes", duration);
 }
 
 // static
 void AutofillMetrics::LogParseFormTiming(const base::TimeDelta& duration) {
@@ skipping 75 matching lines @@
   std::unique_ptr<ukm::UkmEntryBuilder> builder =
       ukm_service->GetEntryBuilder(source_id, ukm_entry_name.c_str());
 
   for (auto it = metrics.begin(); it != metrics.end(); ++it) {
     builder->AddMetric(it->first.c_str(), it->second);
   }
 
   return true;
 }
 
-AutofillMetrics::FormEventLogger::FormEventLogger(bool is_for_credit_card)
+AutofillMetrics::FormEventLogger::FormEventLogger(
+    bool is_for_credit_card,
+    AutofillMetrics::UkmLogger* ukm_logger)
     : is_for_credit_card_(is_for_credit_card),
       is_server_data_available_(false),
       is_local_data_available_(false),
       is_context_secure_(false),
       has_logged_interacted_(false),
       has_logged_suggestions_shown_(false),
       has_logged_masked_server_card_suggestion_selected_(false),
       has_logged_suggestion_filled_(false),
       has_logged_will_submit_(false),
       has_logged_submitted_(false),
       logged_suggestion_filled_was_server_data_(false),
-      logged_suggestion_filled_was_masked_server_card_(false) {}
+      logged_suggestion_filled_was_masked_server_card_(false),
+      ukm_logger_(ukm_logger) {}
 
 void AutofillMetrics::FormEventLogger::OnDidInteractWithAutofillableForm() {
   if (!has_logged_interacted_) {
     has_logged_interacted_ = true;
     Log(AutofillMetrics::FORM_EVENT_INTERACTED_ONCE);
   }
 }
 
 void AutofillMetrics::FormEventLogger::OnDidPollSuggestions(
     const FormFieldData& field) {
@@ skipping 168 matching lines @@
   // segmentation. http://crbug.com/454018
   if (!is_server_data_available_ && !is_local_data_available_)
     name += ".WithNoData";
   else if (is_server_data_available_ && !is_local_data_available_)
     name += ".WithOnlyServerData";
   else if (!is_server_data_available_ && is_local_data_available_)
     name += ".WithOnlyLocalData";
   else
     name += ".WithBothServerAndLocalData";
   LogUMAHistogramEnumeration(name, event, NUM_FORM_EVENTS);
+
+  if (is_for_credit_card_)
+    ukm_logger_->LogCreditCardFormEvent(event);
+  else
+    ukm_logger_->LogAddressFormEvent(event);
+}
+
+AutofillMetrics::UkmLogger::UkmLogger(ukm::UkmService* ukm_service)
+    : ukm_service_(ukm_service) {}
+
+AutofillMetrics::UkmLogger::~UkmLogger() {
+  LogUkm();

[sebsg, 2017/04/07 13:17:24]

Wouldn't this cause us to log twice if LogAutofillFormSubmittedState is called
and then the object is disposed?

[csashi, 2017/04/09 19:17:26]

I meant to clear |metrics_| after logging but forgot. Fixed now.

+}
+
+void AutofillMetrics::UkmLogger::LogAutofillFormSubmittedState(
+    AutofillFormSubmittedState state) {
+  metrics_.push_back(
+      std::make_pair(AUTOFILL_FORM_SUBMITTED_STATE, static_cast<int>(state)));
+  // User submitted form, we can finalize the events for this form.
+  LogUkm();
+}
+
+void AutofillMetrics::UkmLogger::LogUserHappinessMetric(
+    UserHappinessMetric metric) {
+  metrics_.push_back(
+      std::make_pair(USER_HAPPINESS_METRIC, static_cast<int>(metric)));
+}
+
+void AutofillMetrics::UkmLogger::LogAddressFormEvent(FormEvent event) {
+  metrics_.push_back(
+      std::make_pair(ADDRESS_FORM_EVENT, static_cast<int>(event)));
+}
+
+void AutofillMetrics::UkmLogger::LogCreditCardFormEvent(FormEvent event) {
+  metrics_.push_back(
+      std::make_pair(CREDIT_CARD_FORM_EVENT, static_cast<int>(event)));
+}
+
+void AutofillMetrics::UkmLogger::LogUnmaskPromptEvent(UnmaskPromptEvent event) {
+  metrics_.push_back(
+      std::make_pair(UNMASK_PROMPT_EVENT, static_cast<int>(event)));
+}
+
+void AutofillMetrics::UkmLogger::LogUkm() {
+  // TODO(csashi): Merge with |LogUkm| that takes a std::map of
+  // metric_name->value.
+  if (!IsUkmLoggingEnabled() || !ukm_service_ || !url_.is_valid() ||
+      metrics_.empty()) {
+    return;
+  }
+
+  int32_t source_id = ukm_service_->GetNewSourceID();
+  ukm_service_->UpdateSourceURL(source_id, url_);
+  std::unique_ptr<ukm::UkmEntryBuilder> builder = ukm_service_->GetEntryBuilder(
+      source_id, internal::kUKMFormInteractionsEntryName);
+
+  for (auto it = metrics_.begin(); it != metrics_.end(); ++it) {
+    const char* metric_name = nullptr;
+    switch (it->first) {
+      case AutofillMetrics::UkmLogger::AUTOFILL_FORM_SUBMITTED_STATE:
+        metric_name =
+            internal::kUKMFormInteractionsAutofillFormSubmittedStateMetricName;
+        break;
+      case AutofillMetrics::UkmLogger::USER_HAPPINESS_METRIC:
+        metric_name =
+            internal::kUKMFormInteractionsUserHappinessMetricMetricName;
+        break;
+      case AutofillMetrics::UkmLogger::ADDRESS_FORM_EVENT:
+        metric_name = internal::kUKMFormInteractionsAddressFormEventMetricName;
+        break;
+      case AutofillMetrics::UkmLogger::CREDIT_CARD_FORM_EVENT:
+        metric_name =
+            internal::kUKMFormInteractionsCreditCardFormEventMetricName;
+        break;
+      case AutofillMetrics::UkmLogger::UNMASK_PROMPT_EVENT:
+        metric_name = internal::kUKMFormInteractionsUnmaskPromptEventMetricName;
+        break;
+      default:
+        NOTREACHED();
+    }
+    builder->AddMetric(metric_name, it->second);
+  }
 }
 
 }  // namespace autofill