UKM that threads together multiple form interaction events.

components/autofill/core/browser/autofill_metrics.h

 // 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.
 
 #ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_METRICS_H_
 #define COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_METRICS_H_
 
 #include <stddef.h>
 #include <string>
+#include <utility>
+#include <vector>
 
 #include "base/macros.h"
+#include "base/time/time.h"
 #include "components/autofill/core/browser/autofill_client.h"
 #include "components/autofill/core/browser/autofill_profile.h"
 #include "components/autofill/core/browser/credit_card.h"
 #include "components/autofill/core/browser/field_types.h"
 #include "components/autofill/core/common/form_field_data.h"
 
-namespace base {
-class TimeDelta;
-}  // namespace base
-
 namespace ukm {
 class UkmService;
 }  // namespace ukm
 
 namespace internal {
 // Name constants are exposed here so they can be referenced from tests.
 extern const char kUKMCardUploadDecisionEntryName[];
 extern const char kUKMCardUploadDecisionMetricName[];
 extern const char kUKMDeveloperEngagementEntryName[];
 extern const char kUKMDeveloperEngagementMetricName[];
+
+// Each form interaction event has a separate |UkmEntry|.
+
+// The first form event |UkmEntry| contains metrics for metadata that apply
+// to all subsequent events.
+extern const char kUKMInteractedWithFormEntryName[];
+extern const char kUKMIsForCreditCardMetricName[];
+extern const char kUKMLocalRecordTypeCountMetricName[];
+extern const char kUKMServerRecordTypeCountMetricName[];
+
+// |UkmEntry| when we show suggestions.
+extern const char kUKMSuggestionsShownEntryName[];
+
+// |UkmEntry| when user selects a masked server credit card.
+extern const char kUKMSelectedMaskedServerCardEntryName[];
+
+// Each |UkmEntry|, except the first interaction with the form, has a metric for
+// time elapsed, in milliseconds, since we loaded the form.
+extern const char kUKMMillisecondsSinceFormLoadedMetricName[];
+
+// |FormEvent| for FORM_EVENT_*_SUGGESTION_FILLED in credit card forms include a
+// |CreditCard| |record_type()| to indicate if the suggestion was for a local
+// card, masked server card or full server card. Similarly, address/profile
+// forms include a |AutofillProfile| |record_type()| to indicate if the
+// profile was a local profile or server profile.
+extern const char kUKMSuggestionFilledEntryName[];
+extern const char kUKMRecordTypeMetricName[];
+
+// |UkmEntry| for user editing text field. Metrics contain field's attributes.
+extern const char kUKMTextFieldDidChangeEntryName[];
+extern const char kUKMFieldTypeGroupMetricName[];
+extern const char kUKMHeuristicTypeMetricName[];
+extern const char kUKMServerTypeMetricName[];
+extern const char kUKMHtmlFieldTypeMetricName[];
+extern const char kUKMHtmlFieldModeMetricName[];
+extern const char kUKMIsAutofilledMetricName[];
+extern const char kUKMIsEmptyMetricName[];
+
+// |UkmEntry| for |AutofillFormSubmittedState|.
+extern const char kUKMFormSubmittedEntryName[];
+extern const char kUKMAutofillFormSubmittedStateMetricName[];
 }  // namespace internal
 
 namespace autofill {
 
+class AutofillField;
+
 class AutofillMetrics {
  public:
   enum AutofillProfileAction {
     EXISTING_PROFILE_USED,
     EXISTING_PROFILE_UPDATED,
     NEW_PROFILE_CREATED,
     AUTOFILL_PROFILE_ACTION_ENUM_SIZE,
   };
 
   enum AutofillFormSubmittedState {
@@ skipping 513 matching lines @@
 
   // For mesuring how wallet addresses are converted to local profiles.
   enum WalletAddressConversionType : int {
     // The converted wallet address was merged into an existing local profile.
     CONVERTED_ADDRESS_MERGED,
     // The converted wallet address was added as a new local profile.
     CONVERTED_ADDRESS_ADDED,
     NUM_CONVERTED_ADDRESS_CONVERSION_TYPES
   };
 
+  // Utility to log URL keyed form interaction events.
+  class FormInteractionsUkmLogger {
+   public:
+    explicit FormInteractionsUkmLogger(ukm::UkmService* ukm_service);
+
+    const GURL& url() const { return url_; }
+
+    void OnFormsLoaded(const GURL& url);
+    void LogInteractedWithForm(bool is_for_credit_card,
+                               size_t local_record_type_count,
+                               size_t server_record_type_count);
+    void LogSuggestionsShown();
+    void LogSelectedMaskedServerCard();
+    void LogDidFillSuggestion(int record_type);
+    void LogTextFieldDidChange(const AutofillField& field);
+    void LogFormSubmitted(AutofillFormSubmittedState state);
+
+    // We initialize |url_| with the form's URL when we log the first form
+    // interaction. Later, we may update |url_| with the |source_url()| for the
+    // submitted form.
+    void UpdateSourceURL(const GURL& url);
+
+   private:
+    bool CanLog() const;
+    int64_t MillisecondsSinceFormLoaded() const;
+    void GetNewSourceID();
+
+    ukm::UkmService* ukm_service_;  // Weak reference.
+    int32_t source_id_ = -1;
+    GURL url_;
+    base::TimeTicks form_loaded_timestamp_;
+  };
+
   static void LogCardUploadDecisionMetric(CardUploadDecisionMetric metric);
   static void LogCreditCardInfoBarMetric(InfoBarMetric metric,
                                          bool is_uploading);
   static void LogCreditCardFillingInfoBarMetric(InfoBarMetric metric);
   static void LogSaveCardPromptMetric(SaveCardPromptMetric metric,
                                       bool is_uploading,
                                       bool is_reshow);
   static void LogScanCreditCardPromptMetric(ScanCreditCardPromptMetric metric);
 
   // Should be called when credit card scan is finished. |duration| should be
@@ skipping 106 matching lines @@
 
   // This should be called each time a server response is parsed for a form.
   static void LogServerResponseHasDataForForm(bool has_data);
 
   // This should be called at each form submission to indicate what profile
   // action happened.
   static void LogProfileActionOnFormSubmitted(AutofillProfileAction action);
 
   // This should be called at each form submission to indicate the autofilled
   // state of the form.
-  static void LogAutofillFormSubmittedState(AutofillFormSubmittedState state);
+  static void LogAutofillFormSubmittedState(
+      AutofillFormSubmittedState state,
+      FormInteractionsUkmLogger* form_interactions_ukm_logger);
 
   // This should be called when determining the heuristic types for a form's
   // fields.
   static void LogDetermineHeuristicTypesTiming(const base::TimeDelta& duration);
 
   // This should be called when parsing each form.
   static void LogParseFormTiming(const base::TimeDelta& duration);
 
   // Log how many profiles were considered for the deduplication process.
   static void LogNumberOfProfilesConsideredForDedupe(size_t num_considered);
@@ skipping 18 matching lines @@
   static void LogCardUploadDecisionUkm(
       ukm::UkmService* ukm_service,
       const GURL& url,
       AutofillMetrics::CardUploadDecisionMetric upload_decision);
 
   // Logs the developer engagement ukm for the specified |url| and autofill
   // fields in the form structure.
   static void LogDeveloperEngagementUkm(
       ukm::UkmService* ukm_service,
       const GURL& url,
-      AutofillMetrics::DeveloperEngagementMetric metric);
+      std::vector<AutofillMetrics::DeveloperEngagementMetric> metrics);
 
   // Logs the the |ukm_entry_name| with the specified |url| and the specified
   // |metrics|. Returns whether the ukm was sucessfully logged.
   static bool LogUkm(ukm::UkmService* ukm_service,
                      const GURL& url,
                      const std::string& ukm_entry_name,
-                     const std::map<std::string, int>& metrics);
+                     const std::vector<std::pair<const char*, int>>& metrics);
 
-  // Utility to autofill form events in the relevant histograms depending on
+  // Utility to log autofill form events in the relevant histograms depending on
   // the presence of server and/or local data.
   class FormEventLogger {
    public:
-    FormEventLogger(bool is_for_credit_card);
+    FormEventLogger(bool is_for_credit_card,
+                    FormInteractionsUkmLogger* form_interactions_ukm_logger);
 
-    inline void set_is_server_data_available(bool is_server_data_available) {
-      is_server_data_available_ = is_server_data_available;
+    inline void set_server_record_type_count(size_t server_record_type_count) {
+      server_record_type_count_ = server_record_type_count;
     }
 
-    inline void set_is_local_data_available(bool is_local_data_available) {
-      is_local_data_available_ = is_local_data_available;
+    inline void set_local_record_type_count(size_t local_record_type_count) {
+      local_record_type_count_ = local_record_type_count;
     }
 
     inline void set_is_context_secure(bool is_context_secure) {
       is_context_secure_ = is_context_secure;
     }
 
     void OnDidInteractWithAutofillableForm();
 
     void OnDidPollSuggestions(const FormFieldData& field);
 
     void OnDidShowSuggestions();
 
     void OnDidSelectMaskedServerCardSuggestion();
 
     // In case of masked cards, caller must make sure this gets called before
     // the card is upgraded to a full card.
     void OnDidFillSuggestion(const CreditCard& credit_card);
 
     void OnDidFillSuggestion(const AutofillProfile& profile);
 
     void OnWillSubmitForm();
 
     void OnFormSubmitted();
 
    private:
     void Log(FormEvent event) const;
 
     bool is_for_credit_card_;
-    bool is_server_data_available_;
-    bool is_local_data_available_;
+    size_t server_record_type_count_;
+    size_t local_record_type_count_;
     bool is_context_secure_;
     bool has_logged_interacted_;
     bool has_logged_suggestions_shown_;
     bool has_logged_masked_server_card_suggestion_selected_;
     bool has_logged_suggestion_filled_;
     bool has_logged_will_submit_;
     bool has_logged_submitted_;
     bool logged_suggestion_filled_was_server_data_;
     bool logged_suggestion_filled_was_masked_server_card_;
 
     // The last field that was polled for suggestions.
     FormFieldData last_polled_field_;
+
+    FormInteractionsUkmLogger*
+        form_interactions_ukm_logger_;  // Weak reference.
   };
 
  private:
   DISALLOW_IMPLICIT_CONSTRUCTORS(AutofillMetrics);
 };
 
 }  // namespace autofill
 
 #endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_METRICS_H_