Make the histograms for setting the default browser consistent

chrome/browser/shell_integration.cc

 // Copyright (c) 2012 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 "chrome/browser/shell_integration.h"
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/files/file_util.h"
 #include "base/metrics/histogram_macros.h"
@@ skipping 158 matching lines @@
 
 ///////////////////////////////////////////////////////////////////////////////
 // ShellIntegration::DefaultWebClientWorker
 //
 
 ShellIntegration::DefaultWebClientWorker::DefaultWebClientWorker(
     DefaultWebClientObserver* observer)
     : observer_(observer) {}
 
 void ShellIntegration::DefaultWebClientWorker::StartCheckIsDefault() {
   if (observer_) {

[grt (UTC plus 2), 2015/11/03 21:12:21]

nit: omit braces

[Patrick Monette, 2015/11/10 19:22:47]

Done.

     observer_->SetDefaultWebClientUIState(STATE_PROCESSING);
-    BrowserThread::PostTask(
-        BrowserThread::FILE, FROM_HERE,
-        base::Bind(&DefaultWebClientWorker::CheckIsDefault, this));
   }
+  BrowserThread::PostTask(
+      BrowserThread::FILE, FROM_HERE,
+      base::Bind(&DefaultWebClientWorker::CheckIsDefault, this));
 }
 
 void ShellIntegration::DefaultWebClientWorker::StartSetAsDefault() {
   // Cancel the already running process if another start is requested.
   if (set_as_default_in_progress_) {
     if (set_as_default_initialized_) {
       FinalizeSetAsDefault();
       set_as_default_initialized_ = false;
     }
 
     ReportAttemptResult(AttemptResult::RETRY);
   }
 
   set_as_default_in_progress_ = true;
-  bool interactive_permitted = false;
+  bool interactive_permitted = true;
   if (observer_) {
     observer_->SetDefaultWebClientUIState(STATE_PROCESSING);
     interactive_permitted = observer_->IsInteractiveSetDefaultPermitted();
+  }
 
-    // The initialization is only useful when there is an observer.
-    set_as_default_initialized_ = InitializeSetAsDefault();
-  }
+  set_as_default_initialized_ = InitializeSetAsDefault();
 
   // Remember the start time.
   start_time_ = base::TimeTicks::Now();
 
   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE,
                           base::Bind(&DefaultWebClientWorker::SetAsDefault,
                                      this, interactive_permitted));
 }
 
 void ShellIntegration::DefaultWebClientWorker::ObserverDestroyed() {
@@ skipping 13 matching lines @@
 
 ///////////////////////////////////////////////////////////////////////////////
 // DefaultWebClientWorker, private:
 
 ShellIntegration::DefaultWebClientWorker::~DefaultWebClientWorker() {}
 
 void ShellIntegration::DefaultWebClientWorker::OnCheckIsDefaultComplete(
     DefaultWebClientState state) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   UpdateUI(state);
+
+#if defined(OS_WIN)

[grt (UTC plus 2), 2015/11/03 21:12:21]

how about doing this for all platforms?

[Patrick Monette, 2015/11/10 19:22:47]

Done.

+  if (check_default_should_report_success_) {
+    check_default_should_report_success_ = false;
+
+    ReportAttemptResult(state == DefaultWebClientState::IS_DEFAULT
+                            ? AttemptResult::SUCCESS
+                            : AttemptResult::NO_ERRORS_NOT_DEFAULT);
+  }
+#endif  // defined(OS_WIN)
+
   // The worker has finished everything it needs to do, so free the observer
   // if we own it.
   if (observer_ && observer_->IsOwnedByWorker()) {
     delete observer_;
     observer_ = nullptr;
   }
 }
 
 void ShellIntegration::DefaultWebClientWorker::OnSetAsDefaultAttemptComplete(
     AttemptResult result) {
@@ skipping 10 matching lines @@
     if (set_as_default_initialized_) {
       FinalizeSetAsDefault();
       set_as_default_initialized_ = false;
     }
     if (observer_) {
       bool succeeded = result == AttemptResult::SUCCESS ||
                        result == AttemptResult::ALREADY_DEFAULT;
       observer_->OnSetAsDefaultConcluded(succeeded);
     }
 
-    ReportAttemptResult(result);
+    // We don't report a success yet because we have to make sure Chrome is the

[grt (UTC plus 2), 2015/11/03 21:12:21]

nit: avoid "we" in comments. how about "Report failures here. Successes are
reported in OnCheckIsDefaultComplete after checking that the change is
verified." or something like that.

[Patrick Monette, 2015/11/10 19:22:47]

Done.

+    // default browser first.
+    check_default_should_report_success_ = result == AttemptResult::SUCCESS;
+    if (!check_default_should_report_success_) {

[grt (UTC plus 2), 2015/11/03 21:12:21]

nit: omit braces

[Patrick Monette, 2015/11/10 19:22:47]

Done.

+      ReportAttemptResult(result);
+    }
 
     // Start the default browser check which will notify the observer as to
     // whether Chrome is really the default browser. This is needed because
     // detecting that the process was successful is not 100% sure.
     // For example, on Windows 10+, the user might have unchecked the "Always
     // use this app" checkbox which can't be detected.
     StartCheckIsDefault();
   }
 }
 
 void ShellIntegration::DefaultWebClientWorker::ReportAttemptResult(

[grt (UTC plus 2), 2015/11/03 21:12:22]

this records results for both DefaultBrowserWorker and
DefaultProtocolClientWorker, right? i think it makes sense to use different
histograms. one way to slice it is for the subclasses to provide a histogram
prefix to this class (e.g., "SetDefaultBrowser" and "SetDefaultProtocolClient"),
and to compose the histogram names here. rkaplow may have better suggestions.

[Patrick Monette, 2015/11/10 19:22:47]

Done.

     AttemptResult result) {
   if (!ShouldReportAttemptResults())
     return;
 
-  UMA_HISTOGRAM_ENUMERATION("DefaultBrowser.AsyncSetAsDefault.Result", result,
+  UMA_HISTOGRAM_ENUMERATION("SetDefaultBrowser.Result", result,

[grt (UTC plus 2), 2015/11/03 21:12:21]

how about recording this for all platforms? is there a downside?

[Patrick Monette, 2015/11/10 19:22:47]

Done.

                             AttemptResult::NUM_ATTEMPT_RESULT_TYPES);
 
-  switch (result) {
-    case SUCCESS:
-      UMA_HISTOGRAM_MEDIUM_TIMES(
-          "DefaultBrowser.AsyncSetAsDefault.Duration_Success",
-          base::TimeTicks::Now() - start_time_);
-      break;
-    case FAILURE:
-      UMA_HISTOGRAM_MEDIUM_TIMES(
-          "DefaultBrowser.AsyncSetAsDefault.Duration_Failure",
-          base::TimeTicks::Now() - start_time_);
-      break;
-    case ABANDONED:
-      UMA_HISTOGRAM_MEDIUM_TIMES(
-          "DefaultBrowser.AsyncSetAsDefault.Duration_Abandoned",
-          base::TimeTicks::Now() - start_time_);
-      break;
-    case RETRY:
-      UMA_HISTOGRAM_MEDIUM_TIMES(
-          "DefaultBrowser.AsyncSetAsDefault.Duration_Retry",
-          base::TimeTicks::Now() - start_time_);
-      break;
-    default:
-      break;
+  if (IsSetAsDefaultAsynchronous()) {
+    switch (result) {

[grt (UTC plus 2), 2015/11/03 21:12:21]

    const base::TimeTicks delta = base::TimeTicks::Now() - start_time_;

[Patrick Monette, 2015/11/10 19:22:47]

Done.

+      case SUCCESS:
+        UMA_HISTOGRAM_MEDIUM_TIMES("SetDefaultBrowser.AsyncDuration_Success",
+                                   base::TimeTicks::Now() - start_time_);

[grt (UTC plus 2), 2015/11/03 21:12:21]

delta

[Patrick Monette, 2015/11/10 19:22:47]

Done.

+        break;
+      case FAILURE:
+        UMA_HISTOGRAM_MEDIUM_TIMES("SetDefaultBrowser.AsyncDuration_Failure",
+                                   base::TimeTicks::Now() - start_time_);
+        break;
+      case ABANDONED:
+        UMA_HISTOGRAM_MEDIUM_TIMES("SetDefaultBrowser.AsyncDuration_Abandoned",
+                                   base::TimeTicks::Now() - start_time_);
+        break;
+      case RETRY:
+        UMA_HISTOGRAM_MEDIUM_TIMES("SetDefaultBrowser.AsyncDuration_Retry",
+                                   base::TimeTicks::Now() - start_time_);
+        break;
+      case NO_ERRORS_NOT_DEFAULT:
+        UMA_HISTOGRAM_MEDIUM_TIMES(
+            "SetDefaultBrowser.AsyncDuration_NoErrorsNotDefault",
+            base::TimeTicks::Now() - start_time_);
+        break;
+      default:
+        break;
+    }
   }
 }
 
 bool ShellIntegration::DefaultWebClientWorker::InitializeSetAsDefault() {
   return true;
 }
 
 void ShellIntegration::DefaultWebClientWorker::FinalizeSetAsDefault() {}
 
-#if !defined(OS_WIN)
 // static
 bool ShellIntegration::DefaultWebClientWorker::ShouldReportAttemptResults() {
+#if defined(OS_WIN)
+  return true;
+#else  // !defined(OS_WIN)
   return false;
+#endif
 }
-#endif  // !defined(OS_WIN)
 
 void ShellIntegration::DefaultWebClientWorker::UpdateUI(
     DefaultWebClientState state) {
   if (observer_) {
     switch (state) {
       case NOT_DEFAULT:
         observer_->SetDefaultWebClientUIState(STATE_NOT_DEFAULT);
         break;
       case IS_DEFAULT:
         observer_->SetDefaultWebClientUIState(STATE_IS_DEFAULT);
@@ skipping 113 matching lines @@
       break;
     case SET_DEFAULT_ASYNCHRONOUS:
       NOTREACHED();
       break;
   }
   BrowserThread::PostTask(
       BrowserThread::UI, FROM_HERE,
       base::Bind(&DefaultProtocolClientWorker::OnSetAsDefaultAttemptComplete,
                  this, result));
 }