Add metrics for PasswordForm submission types

components/autofill/content/renderer/password_autofill_agent.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/content/renderer/password_autofill_agent.h"
 
 #include <stddef.h>
 
 #include <memory>
 #include <string>
@@ skipping 1014 matching lines @@
 bool PasswordAutofillAgent::OriginCanAccessPasswordManager(
     const blink::WebSecurityOrigin& origin) {
   return origin.CanAccessPasswordManager();
 }
 
 void PasswordAutofillAgent::OnDynamicFormsSeen() {
   SendPasswordForms(false /* only_visible */);
 }
 
 void PasswordAutofillAgent::AJAXSucceeded() {
-  OnSameDocumentNavigationCompleted();
+  OnSameDocumentNavigationCompleted(false);
 }
 
-void PasswordAutofillAgent::OnSameDocumentNavigationCompleted() {
+void PasswordAutofillAgent::OnSameDocumentNavigationCompleted(

[engedy, 2017/05/09 22:02:58]

nit: Now this sounds like: OnBanana(bool is_banana). WDYT about renaming this to
something like OnMaybeSubmittedFormWithoutChangingDocument?

[dvadym, 2017/05/10 12:10:12]

Absolutely agree. But I'd prefer to use this CL just for adding metrics. I'll
rename it in another CL. 

[engedy, 2017/05/10 13:07:42]

Acknowledged.

+    bool is_inpage_navigation) {
   if (!provisionally_saved_form_.IsPasswordValid())
     return;
 
+  provisionally_saved_form_.SetSubmissionEvent(
+      is_inpage_navigation ? PasswordForm::SubmissionEvent::INPAGE_NAVIGATION
+                           : PasswordForm::SubmissionEvent::XHR_SUCCEEDED);
+
   // Prompt to save only if the form is now gone, either invisible or
   // removed from the DOM.
   blink::WebFrame* frame = render_frame()->GetWebFrame();
   const auto& password_form = provisionally_saved_form_.password_form();
   if (form_util::IsFormVisible(frame, provisionally_saved_form_.form_element(),

[engedy, 2017/05/09 22:02:59]

It seems to me that this is called on *every* successful XHR in the document
once the user has typed anything into the password field.

Given that this can lead to CSS style recalc and layout tree update, I wonder if
we should at least count how many times this check is is performed (and
evaluates to false).

We could also add some TRACE_EVENTs and do some local testing to see if this
leads to any premature (and potentially expensive) style recalcs?

On the other hand, I don't know what else we could do here. It seems reasonable
that we cannot stop after the first XHR -- maybe Jochen's change to detect
disappearing forms, and optionally AND'ing that signal with having had an XHR or
same document navigation, could solve this.

[dvadym, 2017/05/10 12:10:12]

Yeah, for me it also looks strange. It was implemented a long time ago for
fixing some specific cases and it's completely non-clear how it's useful. The
metric from this CL will answer at least whether this useful or not.

[engedy, 2017/05/10 13:07:42]

Can we file a tracking bug for these metrics and mention this as a follow-up
task either there, or on a separate bug? 

[dvadym, 2017/05/10 14:09:25]

Done.

                                password_form.action, password_form.origin,
                                password_form.form_data) ||
       (provisionally_saved_form_.form_element().IsNull() &&
        IsUnownedPasswordFormVisible(
            frame, provisionally_saved_form_.input_element(),
            password_form.action, password_form.origin, password_form.form_data,
            form_predictions_))) {
     return;
   }
 
   GetPasswordManagerDriver()->InPageNavigation(password_form);

[engedy, 2017/05/09 22:02:59]

nit: Then this could be updated to
PasswordFormSuccessfullySubmitted(InPage|WithoutChangingDocument|WithoutNavigation),
to better reflect that we have already made the authoritative decision about it
all being a success.

[dvadym, 2017/05/10 12:10:11]

Absolutely agree. But I'd prefere to use this CL just for adding metrics. I'll
rename it in another CL. 

[engedy, 2017/05/10 13:07:42]

Acknowledged.

   provisionally_saved_form_.Reset();
 }
 
 void PasswordAutofillAgent::UserGestureObserved() {
   gatekeeper_.OnUserGesture();
 }
 
 void PasswordAutofillAgent::SendPasswordForms(bool only_visible) {
   std::unique_ptr<RendererSavePasswordProgressLogger> logger;
   if (logging_state_active_) {
@@ skipping 134 matching lines @@
 }
 
 void PasswordAutofillAgent::WillCommitProvisionalLoad() {
   FrameClosing();
 }
 
 void PasswordAutofillAgent::DidCommitProvisionalLoad(
     bool is_new_navigation,
     bool is_same_document_navigation) {
   if (is_same_document_navigation) {
-    OnSameDocumentNavigationCompleted();
+    OnSameDocumentNavigationCompleted(true);
   } else {
     checked_safe_browsing_reputation_ = false;
   }
 }
 
 void PasswordAutofillAgent::FrameDetached() {
   // If a sub frame has been destroyed while the user was entering information
   // into a password form, try to save the data. See https://crbug.com/450806
   // for examples of sites that perform login using this technique.
   if (render_frame()->GetWebFrame()->Parent() &&
       provisionally_saved_form_.IsPasswordValid()) {
+    provisionally_saved_form_.SetSubmissionEvent(
+        PasswordForm::SubmissionEvent::FRAME_DETACHED);
     GetPasswordManagerDriver()->InPageNavigation(
         provisionally_saved_form_.password_form());
   }
   FrameClosing();
 }
 
 void PasswordAutofillAgent::WillSendSubmitEvent(
     const blink::WebFormElement& form) {
   // Forms submitted via XHR are not seen by WillSubmitForm if the default
   // onsubmit handler is overridden. Such submission first gets detected in
@@ skipping 39 matching lines @@
     }
     if (provisionally_saved_form_.IsSet() &&
         submitted_form->action ==
             provisionally_saved_form_.password_form().action) {
       if (logger)
         logger->LogMessage(Logger::STRING_SUBMITTED_PASSWORD_REPLACED);
       const auto& saved_form = provisionally_saved_form_.password_form();
       submitted_form->password_value = saved_form.password_value;
       submitted_form->new_password_value = saved_form.new_password_value;
       submitted_form->username_value = saved_form.username_value;
+      submitted_form->submission_event =
+          PasswordForm::SubmissionEvent::HTML_FORM_SUBMISSION;
     }
 
     // Some observers depend on sending this information now instead of when
     // the frame starts loading. If there are redirects that cause a new
     // RenderView to be instantiated (such as redirects to the WebStore)
     // we will never get to finish the load.
     GetPasswordManagerDriver()->PasswordFormSubmitted(*submitted_form);
     provisionally_saved_form_.Reset();
   } else if (logger) {
     logger->LogMessage(Logger::STRING_FORM_IS_NOT_PASSWORD);
@@ skipping 263 matching lines @@
             password_form->new_password_element !=
                 input.NameForAutofill().Utf16())
           password_form.reset();
       }
     }
   }
 
   if (!password_form)
     password_form.reset(new PasswordForm());
 
+  password_form->submission_event =
+      PasswordForm::SubmissionEvent::BY_CONTEXT_MENU_CLICK;
   callback.Run(*password_form);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // PasswordAutofillAgent, private:
 
 bool PasswordAutofillAgent::ShowSuggestionPopup(
     const PasswordInfo& password_info,
     const blink::WebInputElement& user_input,
     bool show_all,
@@ skipping 83 matching lines @@
 PasswordAutofillAgent::GetPasswordManagerDriver() {
   if (!password_manager_driver_) {
     render_frame()->GetRemoteInterfaces()->GetInterface(
         mojo::MakeRequest(&password_manager_driver_));
   }
 
   return password_manager_driver_;
 }
 
 }  // namespace autofill