Password manager: introduce logging for the internals page

components/password_manager/core/browser/password_manager.cc

Index: components/password_manager/core/browser/password_manager.cc
diff --git a/components/password_manager/core/browser/password_manager.cc b/components/password_manager/core/browser/password_manager.cc
index 1ab931f4684effabaff119fa0b6362237492a0c5..e2d7e1c46059a422c517c06e89d4aee200575197 100644
--- a/components/password_manager/core/browser/password_manager.cc
+++ b/components/password_manager/core/browser/password_manager.cc
@@ -12,6 +12,7 @@
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/platform_thread.h"
 #include "components/autofill/core/common/password_autofill_util.h"
+#include "components/password_manager/core/browser/browser_save_password_progress_logger.h"
 #include "components/password_manager/core/browser/password_form_manager.h"
 #include "components/password_manager/core/browser/password_manager_client.h"
 #include "components/password_manager/core/browser/password_manager_driver.h"
@@ -21,6 +22,7 @@
 
 using autofill::PasswordForm;
 using autofill::PasswordFormMap;
+using autofill::SavePasswordProgressLogger;
 
 namespace password_manager {
 
@@ -108,14 +110,35 @@ bool PasswordManager::IsSavingEnabled() const {
 }
 
 void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
-  if (!IsSavingEnabled()) {
+  bool is_saving_enabled = IsSavingEnabled();
+
+  scoped_ptr<password_manager::BrowserSavePasswordProgressLogger> logger;
+  if (client_->IsLoggingActive()) {
+    logger.reset(
+        new password_manager::BrowserSavePasswordProgressLogger(client_));
+    logger->LogMessage(
+        SavePasswordProgressLogger::STRING_PROVISIONALLY_SAVE_PASSWORD_METHOD);
+    logger->LogPasswordForm(
+        SavePasswordProgressLogger::STRING_PROVISIONALLY_SAVE_PASSWORD_FORM,
+        form);
+    logger->LogBoolean(SavePasswordProgressLogger::STRING_IS_SAVING_ENABLED,
+                       is_saving_enabled);
+  }
+
+  if (!is_saving_enabled ) {
     RecordFailure(SAVING_DISABLED, form.origin.host());
+    if (logger)
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
     return;
   }
 
   // No password to save? Then don't.
   if (form.password_value.empty()) {
     RecordFailure(EMPTY_PASSWORD, form.origin.host());
+    if (logger) {
+      logger->LogMessage(SavePasswordProgressLogger::STRING_EMPTY_PASSWORD);
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+    }
     return;
   }
 
@@ -129,6 +152,8 @@ void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
     // the action URL, exit the loop.
     if ((*iter)->DoesManage(
         form, PasswordFormManager::ACTION_MATCH_REQUIRED)) {
+      if (logger)
+        logger->LogMessage(SavePasswordProgressLogger::STRING_EXACT_MATCH);
       matched_manager_it = iter;
       break;
     // If the current manager matches the submitted form excluding the action
@@ -136,6 +161,9 @@ void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
     // match.
     } else if ((*iter)->DoesManage(
         form, PasswordFormManager::ACTION_MATCH_NOT_REQUIRED)) {
+      if (logger)
+        logger->LogMessage(
+            SavePasswordProgressLogger::STRING_MATCH_WITHOUT_ACTION);
       matched_manager_it = iter;
     }
   }
@@ -158,6 +186,10 @@ void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
   // give up.
   if (!manager->HasCompletedMatching()) {
     RecordFailure(MATCHING_NOT_COMPLETE, form.origin.host());
+    if (logger) {
+      logger->LogMessage(SavePasswordProgressLogger::STRING_NO_FORM_MANAGER);
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+    }
     return;
   }
 
@@ -165,12 +197,20 @@ void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
   // this form.
   if (manager->IsBlacklisted()) {
     RecordFailure(FORM_BLACKLISTED, form.origin.host());
+    if (logger) {
+      logger->LogMessage(SavePasswordProgressLogger::STRING_FORM_BLACKLISTED);
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+    }
     return;
   }
 
   // Bail if we're missing any of the necessary form components.
   if (!manager->HasValidPasswordForm()) {
     RecordFailure(INVALID_FORM, form.origin.host());
+    if (logger) {
+      logger->LogMessage(SavePasswordProgressLogger::STRING_INVALID_FORM);
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+    }
     return;
   }
 
@@ -181,6 +221,10 @@ void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
       !manager->HasGeneratedPassword() &&
       !form.password_autocomplete_set) {
     RecordFailure(AUTOCOMPLETE_OFF, form.origin.host());
+    if (logger) {
+      logger->LogMessage(SavePasswordProgressLogger::STRING_AUTOCOMPLETE_OFF);
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+    }
     return;
   }
 
@@ -189,10 +233,18 @@ void PasswordManager::ProvisionallySavePassword(const PasswordForm& form) {
       form.origin.SchemeIsSecure() &&
       !driver_->DidLastPageLoadEncounterSSLErrors();
   provisionally_saved_form.preferred = true;
+  if (logger)
+    logger->LogPasswordForm(
+        SavePasswordProgressLogger::STRING_PROVISIONALLY_SAVED_FORM,
+        provisionally_saved_form);
   PasswordFormManager::OtherPossibleUsernamesAction action =
       PasswordFormManager::IGNORE_OTHER_POSSIBLE_USERNAMES;
   if (OtherPossibleUsernamesEnabled())
     action = PasswordFormManager::ALLOW_OTHER_POSSIBLE_USERNAMES;
+  if (logger)
+    logger->LogBoolean(
+        SavePasswordProgressLogger::STRING_IGNORE_POSSIBLE_USERNAMES,
+        action == PasswordFormManager::IGNORE_OTHER_POSSIBLE_USERNAMES);
   manager->ProvisionallySave(provisionally_saved_form, action);
   provisional_save_manager_.swap(manager);
 }
@@ -277,11 +329,30 @@ bool PasswordManager::ShouldPromptUserToSavePassword() const {
 
 void PasswordManager::OnPasswordFormsRendered(
     const std::vector<PasswordForm>& visible_forms) {
-  if (!provisional_save_manager_.get())
+  scoped_ptr<password_manager::BrowserSavePasswordProgressLogger> logger;
+  if (client_->IsLoggingActive()) {
+    logger.reset(
+        new password_manager::BrowserSavePasswordProgressLogger(client_));
+    logger->LogMessage(
+        SavePasswordProgressLogger::STRING_ON_PASSWORD_FORMS_RENDERED_METHOD);
+  }
+
+  if (!provisional_save_manager_.get()) {
+    if (logger) {
+      logger->LogMessage(
+          SavePasswordProgressLogger::STRING_NO_PROVISIONAL_SAVE_MANAGER);
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+    }
     return;
+  }
 
   DCHECK(IsSavingEnabled());
 
+  if (logger)
+    logger->LogNumber(
+        SavePasswordProgressLogger::STRING_NUMBER_OF_VISIBLE_FORMS,
+        visible_forms.size());
+
   // If we see the login form again, then the login failed.
   for (size_t i = 0; i < visible_forms.size(); ++i) {
     // TODO(vabr): The similarity check is just action equality for now. If it
@@ -290,6 +361,12 @@ void PasswordManager::OnPasswordFormsRendered(
     if (visible_forms[i].action.is_valid() &&
         provisional_save_manager_->pending_credentials().action ==
             visible_forms[i].action) {
+      if (logger) {
+        logger->LogPasswordForm(
+            SavePasswordProgressLogger::STRING_PASSWORD_FORM_REAPPEARED,
+            visible_forms[i]);
+        logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_DROP);
+      }
       provisional_save_manager_->SubmitFailed();
       provisional_save_manager_.reset();
       return;
@@ -303,8 +380,12 @@ void PasswordManager::OnPasswordFormsRendered(
   provisional_save_manager_->SubmitPassed();
 
   if (ShouldPromptUserToSavePassword()) {
+    if (logger)
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_ASK);
     client_->PromptUserToSavePassword(provisional_save_manager_.release());
   } else {
+    if (logger)
+      logger->LogMessage(SavePasswordProgressLogger::STRING_DECISION_SAVE);
     provisional_save_manager_->Save();
     provisional_save_manager_.reset();
   }