Add metrics to track Autofill "user happiness"

chrome/browser/autofill/autofill_metrics.h

 // Copyright (c) 2011 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 CHROME_BROWSER_AUTOFILL_AUTOFILL_METRICS_H_
 #define CHROME_BROWSER_AUTOFILL_AUTOFILL_METRICS_H_
 #pragma once
 
 #include <stddef.h>
 #include <string>
@@ skipping 61 matching lines @@
     // Our heuristics detected at least one auto-fillable field, and the server
     // response overrode the type of at least one field.
     QUERY_RESPONSE_OVERRODE_LOCAL_HEURISTICS,
 
     // Our heuristics did not detect any auto-fillable fields, but the server
     // response did detect at least one.
     QUERY_RESPONSE_WITH_NO_LOCAL_HEURISTICS,
     NUM_SERVER_QUERY_METRICS
   };
 
+  // Each of these metrics is logged only for potentially autofillable forms,
+  // i.e. forms with at least three fields, etc.
+  // These are used to derive certain "user happiness" metrics.  For example, we
+  // can compute the ratio (USER_DID_EDIT_AUTOFILLED_FIELD / USER_DID_AUTOFILL)
+  // to see how often users have to correct autofilled data.
+  enum UserHappinessMetric {
+    // Loaded a page containing (potentially autofillable) forms.

[dhollowa, 2011/08/25 21:48:15]

Can lose parenthetical comment.

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+    FORMS_LOADED,
+    // Submitted a form that was never autofilled.
+    FORM_SUBMITTED_WITHOUT_AUTOFILL,
+    // Submitted a form for which at least some fields were autofilled.
+    FORM_SUBMITTED_AFTER_AUTOFILL,

[dhollowa, 2011/08/25 21:48:15]

nix: WITHOUT and AFTER, in favor of ALL, SOME, NONE, and NON (below).

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+    // Submitted a form with at least three field values that match the user's
+    // client'stored Autofill data.

[dhollowa, 2011/08/25 21:48:15]

s/client'stored/stored/

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+    SUBMITTED_FORM_COULD_HAVE_BEEN_AUTOFILLED,

[dhollowa, 2011/08/25 21:48:15]

This is a "total" for three other possible happiness metrics:
(1) "ALL" autofilled,
(2) "SOME" autofilled,
(3) "NONE" autofilled

Maybe...

SUBMITTED_FILLABLE_FORM_FILLED_ALL,
SUBMITTED_FILLABLE_FORM_FILLED_SOME,
SUBMITTED_FILLABLE_FORM_FILLED_NONE

Also adding, 

SUBMITTED_NON_FILLABLE_FORM

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+
+    // User manually filled one of the form fields.
+    USER_DID_TYPE,
+    // We showed a popup containing Autofill suggestions.
+    SUGGESTIONS_SHOWN,
+    // Same as above, but only logged once per page load.
+    SUGGESTIONS_SHOWN_FIRST_TIME,

[dhollowa, 2011/08/25 21:48:15]

s/FIRST_TIME/ONCE/

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+    // User autofilled at least part of the form.
+    USER_DID_AUTOFILL,
+    // Same as above, but only logged once per page load.
+    USER_DID_AUTOFILL_FIRST_TIME,

[dhollowa, 2011/08/25 21:48:15]

s/FIRST_TIME/ONCE/

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+    // User edited a previously autofilled field.
+    USER_DID_EDIT_AUTOFILLED_FIELD,

[dhollowa, 2011/08/25 21:48:15]

It would be interesting to have ONCE and non-ONCE versions of this.

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+    NUM_USER_HAPPINESS_METRICS
+  };
+
+  // TODO(isherman): Add histograms to measure time elapsed between form load

[dhollowa, 2011/08/25 21:48:15]

Comparing "fillable filled" and "fillable un-filled" would give most interesting
result.

[Ilya Sherman, 2011/08/26 00:23:32]

Done.

+  // form submission.
+
   AutofillMetrics();
   virtual ~AutofillMetrics();
 
   virtual void LogCreditCardInfoBarMetric(InfoBarMetric metric) const;
 
   virtual void LogHeuristicTypePrediction(
       FieldTypeQualityMetric metric,
       AutofillFieldType field_type,
       const std::string& experiment_id) const;
   virtual void LogOverallTypePrediction(
       FieldTypeQualityMetric metric,
       AutofillFieldType field_type,
       const std::string& experiment_id) const;
   virtual void LogServerTypePrediction(FieldTypeQualityMetric metric,
                                        AutofillFieldType field_type,
                                        const std::string& experiment_id) const;
 
   virtual void LogQualityMetric(QualityMetric metric,
                                 const std::string& experiment_id) const;
 
   virtual void LogServerQueryMetric(ServerQueryMetric metric) const;
 
+  virtual void LogUserHappinessMetric(UserHappinessMetric metric) const;
+
 
   // This should be called each time a page containing forms is loaded.
   virtual void LogIsAutofillEnabledAtPageLoad(bool enabled) const;
 
   // This should be called each time a new profile is launched.
   virtual void LogIsAutofillEnabledAtStartup(bool enabled) const;
 
   // This should be called each time a new profile is launched.
   virtual void LogStoredProfileCount(size_t num_profiles) const;
 
   // Log the number of Autofill suggestions presented to the user when filling a
   // form.
   virtual void LogAddressSuggestionsCount(size_t num_suggestions) const;
 
   // Logs the experiment id corresponding to a server query response.
   virtual void LogServerExperimentIdForQuery(
       const std::string& experiment_id) const;
 
   // Logs the experiment id corresponding to an upload to the server.
   virtual void LogServerExperimentIdForUpload(
       const std::string& experiment_id) const;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(AutofillMetrics);
 };
 
 #endif  // CHROME_BROWSER_AUTOFILL_AUTOFILL_METRICS_H_