Add support for the ExperimentalSwReporterEngine field trial.

chrome/browser/safe_browsing/srt_fetcher_win.cc

 // Copyright 2015 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/srt_fetcher_win.h"
 
 #include <stdint.h>
 
 #include <memory>
 #include <utility>
@@ skipping 101 matching lines @@
 
 const char kFoundUwsMetricName[] = "SoftwareReporter.FoundUwS";
 const char kFoundUwsReadErrorMetricName[] =
     "SoftwareReporter.FoundUwSReadError";
 const char kScanTimesMetricName[] = "SoftwareReporter.UwSScanTimes";
 const char kMemoryUsedMetricName[] = "SoftwareReporter.MemoryUsed";
 
 // Reports metrics about the software reporter via UMA (and sometimes Rappor).
 class UMAHistogramReporter {
  public:
-  explicit UMAHistogramReporter(const std::string& suffix = std::string())
+  UMAHistogramReporter() : UMAHistogramReporter(std::string()) {}
+
+  explicit UMAHistogramReporter(const std::string& suffix)
       : suffix_(suffix),
         registry_key_(suffix.empty() ? kSoftwareRemovalToolRegistryKey
                                      : base::StringPrintf(
                                            L"%ls\\%ls",
                                            kSoftwareRemovalToolRegistryKey,
                                            base::UTF8ToUTF16(suffix).c_str())) {
   }
 
   // Reports the software reporter tool's version via UMA.
   void ReportVersion(const base::Version& version) const {
@@ skipping 442 matching lines @@
   prefs->SetString(prefs::kSwReporterPromptVersion,
                    reporter_version.GetString());
 
   // Download the SRT.
   RecordReporterStepHistogram(SW_REPORTER_DOWNLOAD_START);
 
   // All the work happens in the self-deleting class below.
   new SRTFetcher(profile);
 }
 
-// This class tries to run the reporter and reacts to its exit code. It
-// schedules subsequent runs as needed, or retries as soon as a browser is
-// available when none is on first try.
+// This class tries to run a queue of reporters and react to their exit codes.
+// It schedules subsequent runs of the queue as needed, or retries as soon as a
+// browser is available when none is on first try.
 class ReporterRunner : public chrome::BrowserListObserver {
  public:
-  // Starts the sequence of attempts to run the reporter.
-  static void Run(const SwReporterInvocation& invocation,
-                  const base::Version& version,
-                  scoped_refptr<base::TaskRunner> main_thread_task_runner,
-                  scoped_refptr<base::TaskRunner> blocking_task_runner) {
+  // Registers |invocations| to run next time |TryToRun| is scheduled. (And if
+  // it's not already scheduled, call it now.)
+  static void ScheduleInvocations(
+      const SwReporterQueue& invocations,
+      const base::Version& version,
+      scoped_refptr<base::TaskRunner> main_thread_task_runner,
+      scoped_refptr<base::TaskRunner> blocking_task_runner) {
     if (!instance_)
       instance_ = new ReporterRunner;

[grt (UTC plus 2), 2016/09/13 06:32:25]

since this is intentionally leaked, please use
ANNOTATE_LEAKING_OBJECT_PTR(instance_) here within the body of the conditional
(and include base/debug/leak_annotations.h).

[Joe Mason, 2016/09/13 19:24:54]

Done.

     DCHECK_CURRENTLY_ON(BrowserThread::UI);
-    // There's nothing to do if the path and version of the reporter has not
-    // changed, we just keep running the tasks that are running now.
-    if (instance_->invocation_ == invocation && instance_->version_.IsValid() &&
-        instance_->version_ == version)
+
+    // There's nothing to do if the invocation parameters and version of the
+    // reporter have not changed, we just keep running the tasks that are
+    // running now.
+    if (instance_->pending_invocations_ == invocations &&
+        instance_->version_.IsValid() && instance_->version_ == version)
       return;
 
-    instance_->invocation_ = invocation;
+    instance_->pending_invocations_ = invocations;
     instance_->version_ = version;
     instance_->main_thread_task_runner_ = std::move(main_thread_task_runner);
     instance_->blocking_task_runner_ = std::move(blocking_task_runner);
 
     if (instance_->first_run_) {
       instance_->first_run_ = false;
       instance_->TryToRun();
     }
   }
 
  private:
   ReporterRunner() {}
   ~ReporterRunner() override {}
 
   // BrowserListObserver.
   void OnBrowserSetLastActive(Browser* browser) override {}
   void OnBrowserRemoved(Browser* browser) override {}
   void OnBrowserAdded(Browser* browser) override {
     DCHECK_CURRENTLY_ON(BrowserThread::UI);
     DCHECK(browser);
     MaybeFetchSRT(browser, version_);
     BrowserList::RemoveObserver(this);
   }
 
-  // This method is called on the UI thread when the reporter run has completed.
-  // This is run as a task posted from an interruptible worker thread so should
-  // be resilient to unexpected shutdown.
+  // Launches the command line at the head of the queue.
+  void ScheduleNextInvocation() {
+    DCHECK(!current_invocations_.empty());
+    auto next_invocation = current_invocations_.front();
+    current_invocations_.pop();
+
+    if (g_testing_delegate_)
+      g_testing_delegate_->NotifyLaunchReady();
+
+    // It's OK to simply |PostTaskAndReplyWithResult| so that
+    // |LaunchAndWaitForExit| doesn't need to access |main_thread_task_runner_|
+    // since the callback is not delayed and the test task runner won't need to
+    // force it.
+    base::PostTaskAndReplyWithResult(
+        blocking_task_runner_.get(), FROM_HERE,
+        base::Bind(&LaunchAndWaitForExit, next_invocation),
+        base::Bind(&ReporterRunner::ReporterDone, base::Unretained(this),
+                   base::Time::Now(), version_, next_invocation));
+  }
+
+  // This method is called on the UI thread when an invocation of the reporter
+  // has completed. This is run as a task posted from an interruptible worker
+  // thread so should be resilient to unexpected shutdown.
   void ReporterDone(const base::Time& reporter_start_time,
                     const base::Version& version,
                     const SwReporterInvocation& finished_invocation,
                     int exit_code) {
     DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
     if (g_testing_delegate_)
       g_testing_delegate_->NotifyReporterDone();
 
     base::TimeDelta reporter_running_time =
         base::Time::Now() - reporter_start_time;
-    // Don't continue when the reporter process failed to launch, but still try
-    // again after the regular delay. It's not worth retrying earlier, risking
-    // running too often if it always fails, since not many users fail here.
-    main_thread_task_runner_->PostDelayedTask(
-        FROM_HERE,
-        base::Bind(&ReporterRunner::TryToRun, base::Unretained(this)),
-        base::TimeDelta::FromDays(days_between_reporter_runs_));
+
+    // Don't continue the current queue of reporters if one failed to launch.
+    if (exit_code == kReporterFailureExitCode)
+      current_invocations_ = SwReporterQueue();
+
+    // As soon as we're not running this queue, schedule the next overall queue
+    // run after the regular delay. (If there was a failure it's not worth
+    // retrying earlier, risking running too often if it always fails, since
+    // not many users fail here.)
+    if (current_invocations_.empty()) {
+      main_thread_task_runner_->PostDelayedTask(
+          FROM_HERE,
+          base::Bind(&ReporterRunner::TryToRun, base::Unretained(this)),
+          base::TimeDelta::FromDays(days_between_reporter_runs_));
+    } else {
+      ScheduleNextInvocation();
+    }
+
+    // If the reporter failed to launch, do not process the results. (The exit
+    // code itself doesn't need to be logged in this case because
+    // SW_REPORTER_FAILED_TO_START is logged in |LaunchAndWaitForExit|.)
     if (exit_code == kReporterFailureExitCode)
       return;
 
     UMAHistogramReporter uma(finished_invocation.suffix);
     uma.ReportVersion(version);
     uma.ReportExitCode(exit_code);
-    uma.ReportFoundUwS(!finished_invocation.is_experimental /*use_rappor*/);
+    uma.ReportFoundUwS(finished_invocation.flags &
+                       SwReporterInvocation::FLAG_LOG_TO_RAPPOR);
 
-    //  Only save results from the canonical version of the software.
     PrefService* local_state = g_browser_process->local_state();
-    if (local_state && !finished_invocation.is_experimental) {
-      local_state->SetInteger(prefs::kSwReporterLastExitCode, exit_code);
+    if (local_state) {
+      if (finished_invocation.flags & SwReporterInvocation::FLAG_LOG_TO_PREFS)

[csharp, 2016/09/13 17:09:03]

LOGS_TO_PREFS -> LOG_REPORTER_LAST_EXIT_CODE? Since this isn't logging to prefs,
but actually just controls 1 of the local state values

[Joe Mason, 2016/09/13 19:24:55]

Done.

+        local_state->SetInteger(prefs::kSwReporterLastExitCode, exit_code);
       local_state->SetInt64(prefs::kSwReporterLastTimeTriggered,
                             base::Time::Now().ToInternalValue());
     }
     uma.ReportRuntime(reporter_running_time);
     uma.ReportScanTimes();
     uma.ReportMemoryUsage();
 
-    // Only continue to launch the prompt for the canonical version.
-    if (finished_invocation.is_experimental)
+    if (!(finished_invocation.flags &
+          SwReporterInvocation::FLAG_TRIGGER_PROMPT))
       return;
 
     if (!IsInSRTPromptFieldTrialGroups()) {
       // Knowing about disabled field trial is more important than reporter not
       // finding anything to remove, so check this case first.
       RecordReporterStepHistogram(SW_REPORTER_NO_PROMPT_FIELD_TRIAL);
       return;
     }
 
     if (exit_code != kSwReporterPostRebootCleanupNeeded &&
@@ skipping 14 matching lines @@
       BrowserList::AddObserver(this);
     } else {
       MaybeFetchSRT(browser, version_);
     }
   }
 
   void TryToRun() {
     DCHECK_CURRENTLY_ON(BrowserThread::UI);
     PrefService* local_state = g_browser_process->local_state();
     if (!version_.IsValid() || !local_state) {
       DCHECK(first_run_);

[grt (UTC plus 2), 2016/09/13 06:32:25]

this is guaranteed to DCHECK if the condition above is ever true, no? is that
the intent? if so, use NOTREACHED(). otherwise, what is this checking? maybe
there should be a DCHECK(version.IsValid()); down in RunSwReporters if the
intent is that a caller never passes in an invalid version (which i think is the
only way version_ could be invalid here).

[Joe Mason, 2016/09/13 19:24:54]

I think that's the intent, but I'm not sure how the !local_state check relates
to this. I think changing this is out of scope for this patch.

[grt (UTC plus 2), 2016/09/13 19:47:22]

Ack, though the code here doesn't make sense. Please add the DCHECK in
RunSwReporters and put a TODO here to clean this up. Thanks.

[Joe Mason, 2016/09/13 21:34:42]

Done.

       return;
     }
 
-    // Run the reporter if it hasn't been triggered in the last
+    // Run a queue of reporters if none have been triggered in the last
     // |days_between_reporter_runs_| days, which depends if there is a pending
     // prompt to be added to Chrome's menu.
     if (local_state->GetBoolean(prefs::kSwReporterPendingPrompt)) {
       days_between_reporter_runs_ = kDaysBetweenSwReporterRunsForPendingPrompt;
       RecordReporterStepHistogram(SW_REPORTER_RAN_DAILY);
     } else {
       days_between_reporter_runs_ = kDaysBetweenSuccessfulSwReporterRuns;
     }
+    const base::Time now = base::Time::Now();
     const base::Time last_time_triggered = base::Time::FromInternalValue(
         local_state->GetInt64(prefs::kSwReporterLastTimeTriggered));
-    base::TimeDelta next_trigger_delay(
+    const base::Time next_trigger(
         last_time_triggered +
-        base::TimeDelta::FromDays(days_between_reporter_runs_) -
-        base::Time::Now());
-    if (next_trigger_delay.ToInternalValue() <= 0 ||
-        // Also make sure the kSwReporterLastTimeTriggered value is not set in
-        // the future.
-        last_time_triggered > base::Time::Now()) {
-      if (g_testing_delegate_)
-        g_testing_delegate_->NotifyLaunchReady();
-
-      // It's OK to simply |PostTaskAndReplyWithResult| so that
-      // |LaunchAndWaitForExit| doesn't need to access
-      // |main_thread_task_runner_| since the callback is not delayed and the
-      // test task runner won't need to force it.
-      base::PostTaskAndReplyWithResult(
-          blocking_task_runner_.get(), FROM_HERE,
-          base::Bind(&LaunchAndWaitForExit, invocation_),
-          base::Bind(&ReporterRunner::ReporterDone, base::Unretained(this),
-                     base::Time::Now(), version_, invocation_));
+        base::TimeDelta::FromDays(days_between_reporter_runs_));
+    if (!pending_invocations_.empty() &&
+        (next_trigger <= now ||
+         // Also make sure the kSwReporterLastTimeTriggered value is not set in
+         // the future.
+         last_time_triggered > now)) {
+      DCHECK(current_invocations_.empty());
+      current_invocations_ = pending_invocations_;
+      ScheduleNextInvocation();
     } else {
       main_thread_task_runner_->PostDelayedTask(
           FROM_HERE,
           base::Bind(&ReporterRunner::TryToRun, base::Unretained(this)),
-          next_trigger_delay);
+          next_trigger - now);
     }
   }
 
   bool first_run_ = true;
-  SwReporterInvocation invocation_;
+
+  // The queue of invocations that are currently running.
+  SwReporterQueue current_invocations_;
+
+  // The invocations to run next time the SwReporter is run.
+  SwReporterQueue pending_invocations_;
+
   base::Version version_;
   scoped_refptr<base::TaskRunner> main_thread_task_runner_;
   scoped_refptr<base::TaskRunner> blocking_task_runner_;
 
   // This value is used to identify how long to wait before starting a new run
-  // of the reporter. It's initialized with the default value and may be changed
-  // to a different value when a prompt is pending and the reporter should be
-  // run before adding the global error to the Chrome menu.
+  // of the reporter queue. It's initialized with the default value and may be
+  // changed to a different value when a prompt is pending and the reporter
+  // should be run before adding the global error to the Chrome menu.
   int days_between_reporter_runs_ = kDaysBetweenSuccessfulSwReporterRuns;
 
   // A single leaky instance.
   static ReporterRunner* instance_;
 
   DISALLOW_COPY_AND_ASSIGN(ReporterRunner);
 };
 
 ReporterRunner* ReporterRunner::instance_ = nullptr;
 
@@ skipping 11 matching lines @@
 
 SwReporterInvocation SwReporterInvocation::FromCommandLine(
     const base::CommandLine& command_line) {
   SwReporterInvocation invocation;
   invocation.command_line = command_line;
   return invocation;
 }
 
 bool SwReporterInvocation::operator==(const SwReporterInvocation& other) const {
   return command_line.argv() == other.command_line.argv() &&
-         suffix == other.suffix && is_experimental == other.is_experimental;
+         suffix == other.suffix && flags == other.flags;
 }
 
-void RunSwReporter(const SwReporterInvocation& invocation,
-                   const base::Version& version,
-                   scoped_refptr<base::TaskRunner> main_thread_task_runner,
-                   scoped_refptr<base::TaskRunner> blocking_task_runner) {
-  ReporterRunner::Run(invocation, version, std::move(main_thread_task_runner),
-                      std::move(blocking_task_runner));
+void RunSwReporters(const SwReporterQueue& invocations,
+                    const base::Version& version,
+                    scoped_refptr<base::TaskRunner> main_thread_task_runner,
+                    scoped_refptr<base::TaskRunner> blocking_task_runner) {
+  DCHECK(!invocations.empty());
+  ReporterRunner::ScheduleInvocations(invocations, version,
+                                      std::move(main_thread_task_runner),
+                                      std::move(blocking_task_runner));
 }
 
 bool ReporterFoundUws() {
   PrefService* local_state = g_browser_process->local_state();
   if (!local_state)
     return false;
   int exit_code = local_state->GetInteger(prefs::kSwReporterLastExitCode);
   return exit_code == kSwReporterCleanupNeeded;
 }
 
 bool UserHasRunCleaner() {
   base::string16 cleaner_key_path(kSoftwareRemovalToolRegistryKey);
   cleaner_key_path.append(L"\\").append(kCleanerSubKey);
 
   base::win::RegKey srt_cleaner_key(HKEY_CURRENT_USER, cleaner_key_path.c_str(),
                                     KEY_QUERY_VALUE);
 
   return srt_cleaner_key.Valid() && srt_cleaner_key.GetValueCount() > 0;
 }
 
 void SetSwReporterTestingDelegate(SwReporterTestingDelegate* delegate) {
   g_testing_delegate_ = delegate;
 }
 
 }  // namespace safe_browsing