Primary histograms for InBrowserCleanerUI experiment

chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_controller_win.cc

 // Copyright 2017 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/safe_browsing/chrome_cleaner/chrome_cleaner_controller_win.h"
 
 #include <windows.h>
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/callback.h"
 #include "base/files/file_util.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
+#include "base/metrics/histogram_macros.h"
 #include "base/task_scheduler/post_task.h"
 #include "base/task_scheduler/task_traits.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/metrics/chrome_metrics_service_accessor.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_fetcher_win.h"
 #include "chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_runner_win.h"
 #include "chrome/browser/safe_browsing/chrome_cleaner/settings_resetter_win.h"
 #include "chrome/browser/safe_browsing/chrome_cleaner/srt_client_info_win.h"
+#include "chrome/browser/safe_browsing/chrome_cleaner/srt_field_trial_win.h"
 #include "chrome/installer/util/scoped_token_privilege.h"
 #include "components/chrome_cleaner/public/constants/constants.h"
 #include "components/safe_browsing/common/safe_browsing_prefs.h"
 #include "content/public/browser/browser_thread.h"
 #include "net/http/http_status_code.h"
 
 namespace safe_browsing {
 
 namespace {
 
 using ::chrome_cleaner::mojom::ChromePrompt;
 using ::chrome_cleaner::mojom::PromptAcceptance;
 using ::content::BrowserThread;
 
 // The global singleton instance. Exposed outside of GetInstance() so that it
 // can be reset by tests.
 ChromeCleanerController* g_controller = nullptr;
 
 // TODO(alito): Move these shared exit codes to the chrome_cleaner component.
 // https://crbug.com/727956
 constexpr int kRebootRequiredExitCode = 15;
 constexpr int kRebootNotRequiredExitCode = 0;
 
+// These values are used to send UMA information and are replicated in the
+// histograms.xml file, so the order MUST NOT CHANGE.
+enum CleanupResultHistogramValue {
+  CLEANUP_RESULT_SUCCEEDED = 0,
+  CLEANUP_RESULT_REBOOT_REQUIRED = 1,
+  CLEANUP_RESULT_FAILED = 2,
+
+  CLEANUP_RESULT_MAX,
+};
+
+// These values are used to send UMA information and are replicated in the
+// histograms.xml file, so the order MUST NOT CHANGE.
+enum RebootResponseHistogramValue {
+  REBOOT_RESPONSE_INITIATED = 0,
+
+  REBOOT_RESPONSE_MAX,
+};
+
+// These values are used to send UMA information and are replicated in the
+// histograms.xml file, so the order MUST NOT CHANGE.
+enum IPCConnectionErrorHistogramValue {
+  IPC_ERROR_CONNECTION_LOST_WHILE_SCANNING = 0,
+  IPC_ERROR_CONNECTION_LOST_USER_PROMPTED = 1,
+
+  IPC_ERROR_CONNECTION_MAX,
+};
+
 // Attempts to change the Chrome Cleaner binary's suffix to ".exe". Will return
 // an empty FilePath on failure. Should be called on a sequence with traits
 // appropriate for IO operations.
 base::FilePath VerifyAndRenameDownloadedCleaner(
     base::FilePath downloaded_path,
     ChromeCleanerFetchStatus fetch_status) {
   base::ThreadRestrictions::AssertIOAllowed();
 
   if (downloaded_path.empty() || !base::PathExists(downloaded_path))
     return base::FilePath();
@@ skipping 30 matching lines @@
 ChromeCleanerController::IdleReason IdleReasonWhenConnectionClosedTooSoon(
     ChromeCleanerController::State current_state) {
   DCHECK(current_state == ChromeCleanerController::State::kScanning ||
          current_state == ChromeCleanerController::State::kInfected);
 
   return current_state == ChromeCleanerController::State::kScanning
              ? ChromeCleanerController::IdleReason::kScanningFailed
              : ChromeCleanerController::IdleReason::kConnectionLost;
 }
 
+void RecordCleanerLogsAcceptanceHistogram(bool logs_accepted) {
+  UMA_HISTOGRAM_BOOLEAN("SoftwareReporter.CleanerLogsAcceptance",
+                        logs_accepted);
+}
+
+void RecordCleanupResultHistogram(CleanupResultHistogramValue result) {
+  UMA_HISTOGRAM_ENUMERATION("SoftwareReporter.Cleaner.CleanupResult", result,
+                            CLEANUP_RESULT_MAX);
+}
+
+void RecordIPCConnectionErrorHistogram(IPCConnectionErrorHistogramValue error) {
+  UMA_HISTOGRAM_ENUMERATION("SoftwareReporter.IPCConnectionError", error,
+                            IPC_ERROR_CONNECTION_MAX);
+}
+
 }  // namespace
 
+void RecordCleanupStartedHistogram(CleanupStartedHistogramValue value) {
+  UMA_HISTOGRAM_ENUMERATION("SoftwareReporter.CleanupStarted", value,
+                            CLEANUP_STARTED_MAX);
+}
+
 ChromeCleanerControllerDelegate::ChromeCleanerControllerDelegate() = default;
 
 ChromeCleanerControllerDelegate::~ChromeCleanerControllerDelegate() = default;
 
 void ChromeCleanerControllerDelegate::FetchAndVerifyChromeCleaner(
     FetchedCallback fetched_callback) {
   FetchChromeCleaner(
       base::BindOnce(&OnChromeCleanerFetched, base::Passed(&fetched_callback)));
 }
 
@@ skipping 109 matching lines @@
     return;
 
   DCHECK(prompt_user_callback_);
 
   PromptAcceptance acceptance = PromptAcceptance::DENIED;
   State new_state = State::kIdle;
   switch (user_response) {
     case UserResponse::kAcceptedWithLogs:
       acceptance = PromptAcceptance::ACCEPTED_WITH_LOGS;
       SetLogsEnabled(true);
+      RecordCleanerLogsAcceptanceHistogram(true);
       new_state = State::kCleaning;
       delegate_->TagForResetting(profile);
       break;
     case UserResponse::kAcceptedWithoutLogs:
       acceptance = PromptAcceptance::ACCEPTED_WITHOUT_LOGS;
       SetLogsEnabled(false);
+      RecordCleanerLogsAcceptanceHistogram(false);
       new_state = State::kCleaning;
       delegate_->TagForResetting(profile);
       break;
     case UserResponse::kDenied:  // Fallthrough
     case UserResponse::kDismissed:
       acceptance = PromptAcceptance::DENIED;
       idle_reason_ = IdleReason::kUserDeclinedCleanup;
       new_state = State::kIdle;
       break;
   }
 
   BrowserThread::GetTaskRunnerForThread(BrowserThread::IO)
       ->PostTask(FROM_HERE,
                  base::BindOnce(std::move(prompt_user_callback_), acceptance));
 
   // The transition to a new state should happen only after the response has
   // been posted on the UI thread so that if we transition to the kIdle state,
   // the response callback is not cleared before it has been posted.
   SetStateAndNotifyObservers(new_state);
 }
 
 void ChromeCleanerController::Reboot() {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
 
   if (state() != State::kRebootRequired)
     return;
 
+  UMA_HISTOGRAM_ENUMERATION("SoftwareReporter.Cleaner.RebootResponse",
+                            REBOOT_RESPONSE_INITIATED, REBOOT_RESPONSE_MAX);
   InitiateReboot();
 }
 
 ChromeCleanerController::ChromeCleanerController()
     : real_delegate_(base::MakeUnique<ChromeCleanerControllerDelegate>()),
       delegate_(real_delegate_.get()),
       weak_factory_(this) {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
 }
 
@@ skipping 45 matching lines @@
 
 void ChromeCleanerController::OnChromeCleanerFetchedAndVerified(
     base::FilePath executable_path) {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
   DCHECK_EQ(State::kScanning, state());
   DCHECK(reporter_invocation_);
 
   if (executable_path.empty()) {
     idle_reason_ = IdleReason::kScanningFailed;
     SetStateAndNotifyObservers(State::kIdle);
+    RecordPromptNotShownWithReasonHistogram(
+        NO_PROMPT_REASON_CLEANER_DOWNLOAD_FAILED);
     return;
   }
 
   DCHECK(executable_path.MatchesExtension(FILE_PATH_LITERAL(".exe")));
 
   ChromeCleanerRunner::ChromeMetricsStatus metrics_status =
       delegate_->IsMetricsAndCrashReportingEnabled()
           ? ChromeCleanerRunner::ChromeMetricsStatus::kEnabled
           : ChromeCleanerRunner::ChromeMetricsStatus::kDisabled;
 
@@ skipping 42 matching lines @@
   DCHECK_EQ(State::kScanning, state());
   DCHECK(!files_to_delete_);
   DCHECK(!prompt_user_callback_);
 
   if (files_to_delete->empty()) {
     BrowserThread::GetTaskRunnerForThread(BrowserThread::IO)
         ->PostTask(FROM_HERE, base::BindOnce(std::move(prompt_user_callback),
                                              PromptAcceptance::DENIED));
     idle_reason_ = IdleReason::kScanningFoundNothing;
     SetStateAndNotifyObservers(State::kIdle);
+    RecordPromptNotShownWithReasonHistogram(NO_PROMPT_REASON_NOTHING_FOUND);
     return;
   }
 
+  UMA_HISTOGRAM_COUNTS_1000("SoftwareReporter.NumberOfFilesToDelete",
+                            files_to_delete->size());
   files_to_delete_ = std::move(files_to_delete);
   prompt_user_callback_ = std::move(prompt_user_callback);
   SetStateAndNotifyObservers(State::kInfected);
 }
 
 void ChromeCleanerController::OnConnectionClosed() {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
   DCHECK_NE(State::kIdle, state());
   DCHECK_NE(State::kRebootRequired, state());
 
   if (state() == State::kScanning || state() == State::kInfected) {
+    if (state() == State::kScanning) {
+      RecordPromptNotShownWithReasonHistogram(
+          NO_PROMPT_REASON_IPC_CONNECTION_BROKEN);
+      RecordIPCConnectionErrorHistogram(
+          IPC_ERROR_CONNECTION_LOST_WHILE_SCANNING);
+    } else {
+      RecordIPCConnectionErrorHistogram(
+          IPC_ERROR_CONNECTION_LOST_USER_PROMPTED);
+    }
+
     idle_reason_ = IdleReasonWhenConnectionClosedTooSoon(state());
     SetStateAndNotifyObservers(State::kIdle);
     return;
   }
   // Nothing to do if OnConnectionClosed() is called in other states:
   // - This function will not be called in the kIdle and kRebootRequired
   //   states since we invalidate all weak pointers when we enter those states.
   // - In the kCleaning state, we don't care about the connection to the Chrome
   //   Cleaner process since communication via Mojo is complete and only the
   //   exit code of the process is of any use to us (for deciding whether we
   //   need to reboot).
 }
 
 void ChromeCleanerController::OnCleanerProcessDone(
     ChromeCleanerRunner::ProcessStatus process_status) {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
 
   if (state() == State::kScanning || state() == State::kInfected) {
     idle_reason_ = IdleReasonWhenConnectionClosedTooSoon(state());
     SetStateAndNotifyObservers(State::kIdle);
     return;
   }
 
   DCHECK_EQ(State::kCleaning, state());
   DCHECK_NE(ChromeCleanerRunner::LaunchStatus::kLaunchFailed,
             process_status.launch_status);
 
-  if (process_status.launch_status !=
+  if (process_status.launch_status ==
       ChromeCleanerRunner::LaunchStatus::kSuccess) {
-    idle_reason_ = IdleReason::kCleaningFailed;
-    SetStateAndNotifyObservers(State::kIdle);
-    return;
+    if (process_status.exit_code == kRebootRequiredExitCode) {
+      RecordCleanupResultHistogram(CLEANUP_RESULT_REBOOT_REQUIRED);
+      SetStateAndNotifyObservers(State::kRebootRequired);
+      return;
+    }
+
+    if (process_status.exit_code == kRebootNotRequiredExitCode) {
+      RecordCleanupResultHistogram(CLEANUP_RESULT_SUCCEEDED);
+      delegate_->ResetTaggedProfiles(
+          g_browser_process->profile_manager()->GetLoadedProfiles(),
+          base::BindOnce(&ChromeCleanerController::OnSettingsResetCompleted,
+                         base::Unretained(this)));
+      ResetCleanerDataAndInvalidateWeakPtrs();
+      return;
+    }
   }
 
-  if (process_status.exit_code == kRebootRequiredExitCode) {
-    SetStateAndNotifyObservers(State::kRebootRequired);
-    return;
-  }
-
-  if (process_status.exit_code == kRebootNotRequiredExitCode) {
-    delegate_->ResetTaggedProfiles(
-        g_browser_process->profile_manager()->GetLoadedProfiles(),
-        base::BindOnce(&ChromeCleanerController::OnSettingsResetCompleted,
-                       base::Unretained(this)));
-    ResetCleanerDataAndInvalidateWeakPtrs();
-    return;
-  }
-
+  RecordCleanupResultHistogram(CLEANUP_RESULT_FAILED);
   idle_reason_ = IdleReason::kCleaningFailed;
   SetStateAndNotifyObservers(State::kIdle);
 }
 
 void ChromeCleanerController::InitiateReboot() {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
 
   installer::ScopedTokenPrivilege scoped_se_shutdown_privilege(
       SE_SHUTDOWN_NAME);
   if (!scoped_se_shutdown_privilege.is_enabled() ||
       !::ExitWindowsEx(EWX_REBOOT, SHTDN_REASON_MAJOR_SOFTWARE |
                                        SHTDN_REASON_MINOR_OTHER |
                                        SHTDN_REASON_FLAG_PLANNED)) {
     for (auto& observer : observer_list_)
       observer.OnRebootFailed();
   }
 }
 
 void ChromeCleanerController::OnSettingsResetCompleted() {
   idle_reason_ = IdleReason::kCleaningSucceeded;
   SetStateAndNotifyObservers(State::kIdle);
 }
 
 }  // namespace safe_browsing