[autofill] Add UKM for field type prediction quality and autofill outcome.

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/strings/string_piece_forward.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/autofill_pref_names.h"
 #include "components/autofill/core/common/form_field_data.h"
+#include "components/autofill/core/common/signatures_util.h"
 #include "components/ukm/public/ukm_recorder.h"
 
 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|.
@@ skipping 30 matching lines @@
 // |UkmEntry| for user editing text field. Metrics contain field's attributes.
 extern const char kUKMTextFieldDidChangeEntryName[];
 extern const char kUKMFieldTypeGroupMetricName[];
 extern const char kUKMHtmlFieldModeMetricName[];
 extern const char kUKMIsAutofilledMetricName[];
 extern const char kUKMIsEmptyMetricName[];
 
 // |UkmEntry| for |AutofillFormSubmittedState|.
 extern const char kUKMFormSubmittedEntryName[];
 extern const char kUKMAutofillFormSubmittedStateMetricName[];
+
+// |UkmEntry| for capturing field fill status and type prediction quality.
+extern const char kUKMFieldTypeEntryName[];
+extern const char kUKMFieldFillStatusEntryName[];
+extern const char kUKMFormSignatureMetricName[];
+extern const char kUKMFieldSignatureMetricName[];
+extern const char kUKMValidationEventMetricName[];
+extern const char kUKMPredictionSourceMetricName[];
+extern const char kUKMPredictedTypeMetricName[];
+extern const char kUKMActualTypeMetricName[];
+extern const char kUKMWasSuggestionShownMetricName[];
+extern const char kUKMWasPreviouslyAutofilledMetricName[];
+
 }  // namespace internal
 
 namespace autofill {
 
 class AutofillField;
 
 class AutofillMetrics {
  public:
   enum AutofillProfileAction {
     EXISTING_PROFILE_USED,
@@ skipping 319 matching lines @@
     //       UNKNOWN not in (T,U).
     //
     // This is captured as a type-specific log entry for T. Is is also captured
     // as an aggregate (non-type-specific) log entry.
     FALSE_NEGATIVE_MISMATCH,
 
     // This must be last.
     NUM_FIELD_TYPE_QUALITY_METRICS
   };
 
+  enum QualityMetricPredictionSource {
+    PREDICTION_SOURCE_UNKNOWN,    // Not used. The prediction source is unknown.
+    PREDICTION_SOURCE_HEURISTIC,  // Local heuristic field-type prediction.
+    PREDICTION_SOURCE_SERVER,     // Crowd-sourced server field type prediction.
+    PREDICTION_SOURCE_OVERALL,    // Overall field-type prediction seen by user.
+    NUM_QUALITY_METRIC_SOURCES
+  };
+
   enum QualityMetricType {
     TYPE_SUBMISSION = 0,      // Logged based on user's submitted data.
     TYPE_NO_SUBMISSION,       // Logged based on user's entered data.
     TYPE_AUTOCOMPLETE_BASED,  // Logged based on the value of autocomplete attr.
     NUM_QUALITY_METRIC_TYPES,
   };
 
   // Each of these is logged at most once per query to the server, which in turn
   // occurs at most once per page load.
   enum ServerQueryMetric {
@@ skipping 251 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
   };
 
+  class UkmTimestampPin;

[sebsg, 2017/06/19 14:48:09]

As discussed, please remove or add comment.

[Roger McFarlane (Chromium), 2017/06/21 21:01:54]

Done.

+
   // Utility to log URL keyed form interaction events.
   class FormInteractionsUkmLogger {
    public:
     explicit FormInteractionsUkmLogger(ukm::UkmRecorder* ukm_recorder);
 
+    bool has_pinned_timestamp() const { return !pinned_timestamp_.is_null(); }
+    void set_pinned_timestamp(base::TimeTicks t) { pinned_timestamp_ = t; }
+
     const GURL& url() const { return url_; }
 
     void OnFormsParsed(const GURL& url);
     void LogInteractedWithForm(bool is_for_credit_card,
                                size_t local_record_type_count,
                                size_t server_record_type_count);
     void LogSuggestionsShown(const AutofillField& field);
     void LogSelectedMaskedServerCard();
     void LogDidFillSuggestion(int record_type);
     void LogTextFieldDidChange(const AutofillField& field);
+    void LogFieldFillStatus(const FormStructure& form,
+                            const AutofillField& field,
+                            QualityMetricType metric_type);
+    void LogFieldType(FormSignature form_signature,
+                      FieldSignature field_signature,
+                      QualityMetricPredictionSource prediction_source,
+                      QualityMetricType metric_type,
+                      ServerFieldType predicted_type,
+                      ServerFieldType actual_type);
     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 MillisecondsSinceFormParsed() const;
     void GetNewSourceID();
 
     ukm::UkmRecorder* ukm_recorder_;  // Weak reference.
     ukm::SourceId source_id_ = -1;
     GURL url_;
     base::TimeTicks form_parsed_timestamp_;
+    base::TimeTicks pinned_timestamp_;
+  };
+
+  // Utility class to pin the timestamp used by the FormInteractionsUkmLogger
+  // while an instance of this class is in scope. Pinned timestamps cannot be
+  // nested.
+  class UkmTimestampPin {
+   public:
+    UkmTimestampPin(FormInteractionsUkmLogger* logger) : logger_(logger) {
+      DCHECK(!logger->has_pinned_timestamp());
+      logger->set_pinned_timestamp(base::TimeTicks::Now());
+    }
+    ~UkmTimestampPin() {
+      DCHECK(logger_->has_pinned_timestamp());
+      logger_->set_pinned_timestamp(base::TimeTicks());
+    }
+
+   private:
+    FormInteractionsUkmLogger* const logger_;
+    DISALLOW_IMPLICIT_CONSTRUCTORS(UkmTimestampPin);
   };
 
   // |upload_decision_metrics| is a bitmask of |CardUploadDecisionMetric|.
   static void LogCardUploadDecisionMetrics(int upload_decision_metrics);
   static void LogCreditCardInfoBarMetric(
       InfoBarMetric metric,
       bool is_uploading,
       int previous_save_credit_card_prompt_user_decision);
   static void LogCreditCardFillingInfoBarMetric(InfoBarMetric metric);
   static void LogSaveCardPromptMetric(
       SaveCardPromptMetric metric,
       bool is_uploading,
       bool is_reshow,
       int previous_save_credit_card_prompt_user_decision);
   static void LogScanCreditCardPromptMetric(ScanCreditCardPromptMetric metric);
 
   // Should be called when credit card scan is finished. |duration| should be
   // the time elapsed between launching the credit card scanner and getting back
   // the result. |completed| should be true if a credit card was scanned, false
   // if the scan was cancelled.
   static void LogScanCreditCardCompleted(const base::TimeDelta& duration,
                                          bool completed);
 
   static void LogDeveloperEngagementMetric(DeveloperEngagementMetric metric);
 
   static void LogHeuristicPredictionQualityMetrics(
-      const ServerFieldTypeSet& possible_types,
-      ServerFieldType predicted_type,
+      FormInteractionsUkmLogger* form_interactions_ukm_logger,
+      const FormStructure& form,
+      const AutofillField& field,
       QualityMetricType metric_type);
   static void LogServerPredictionQualityMetrics(
-      const ServerFieldTypeSet& possible_types,
-      ServerFieldType predicted_type,
+      FormInteractionsUkmLogger* form_interactions_ukm_logger,
+      const FormStructure& form,
+      const AutofillField& field,
       QualityMetricType metric_type);
   static void LogOverallPredictionQualityMetrics(
-      const ServerFieldTypeSet& possible_types,
-      ServerFieldType predicted_type,
+      FormInteractionsUkmLogger* form_interactions_ukm_logger,
+      const FormStructure& form,
+      const AutofillField& field,
       QualityMetricType metric_type);
 
   static void LogServerQueryMetric(ServerQueryMetric metric);
 
   static void LogUserHappinessMetric(UserHappinessMetric metric);
 
   // Logs |event| to the unmask prompt events histogram.
   static void LogUnmaskPromptEvent(UnmaskPromptEvent event);
 
   // Logs the time elapsed between the unmask prompt being shown and it
@@ skipping 203 matching lines @@
 
  private:
   static const int kNumCardUploadDecisionMetrics = 12;
 
   DISALLOW_IMPLICIT_CONSTRUCTORS(AutofillMetrics);
 };
 
 }  // namespace autofill
 
 #endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_METRICS_H_