Changed when the UMA metric Ash.NumberOfVisibleWindowsInPrimaryDisplay is recorded.

ash/metrics/user_metrics_recorder.h

 // 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.
 
 #ifndef ASH_USER_METRICS_RECORDER_H_
 #define ASH_USER_METRICS_RECORDER_H_
 
 #include "ash/ash_export.h"
 #include "base/timer/timer.h"
 
 namespace ash {
 
+namespace test {
+class UserMetricsRecorderTestAPI;
+}
+
 enum UserMetricsAction {
   UMA_ACCEL_EXIT_FIRST_Q,
   UMA_ACCEL_EXIT_SECOND_Q,
   UMA_ACCEL_KEYBOARD_BRIGHTNESS_DOWN_F6,
   UMA_ACCEL_KEYBOARD_BRIGHTNESS_UP_F7,
   UMA_ACCEL_LOCK_SCREEN_LOCK_BUTTON,
   UMA_ACCEL_LOCK_SCREEN_POWER_BUTTON,
   UMA_ACCEL_MAXIMIZE_RESTORE_F4,
   UMA_ACCEL_PREVWINDOW_F5,
   UMA_ACCEL_RESTART_POWER_BUTTON,
@@ skipping 97 matching lines @@
   UMA_WINDOW_CYCLE,
 };
 
 // User Metrics Recorder provides a repeating callback (RecordPeriodicMetrics)
 // on a timer to allow recording of state data over time to the UMA records.
 // Any additional states (in ash) that require monitoring can be added to
 // this class. As well calls to record on action metrics
 // (RecordUserMetricsAction) are passed through the UserMetricsRecorder.
 class ASH_EXPORT UserMetricsRecorder {
  public:
+  // Creates a UserMetricsRecorder that records metrics periodically. Equivalent
+  // to calling UserMetricsRecorder(true).
   UserMetricsRecorder();
-  ~UserMetricsRecorder();
 
+  virtual ~UserMetricsRecorder();
+
+  // Records an Ash owned user action.
   void RecordUserMetricsAction(ash::UserMetricsAction action);
+
  private:
+  friend class test::UserMetricsRecorderTestAPI;
+
+  // Creates a UserMetricsRecorder and will only record periodic metrics if
+  // |record_periodic_metrics| is true. This is used by tests that do not want
+  // the timer to be started.
+  // TODO(bruthig): Add a constructor that accepts a base::RepeatingTimer so
+  // that tests can inject a test double that can be controlled by the test. The
+  // missing piece is a suitable base::RepeatingTimer test double.
+  explicit UserMetricsRecorder(bool record_periodic_metrics);
+
+  // Records UMA metrics. Invoked periodically by the |timer_|.
   void RecordPeriodicMetrics();
 
+  // Returns true if the user's session is active and they are in a desktop
+  // environment.
+  bool IsUserInActiveDesktopEnvironment() const;
+
+  // Starts the |timer_| and binds it to |RecordPeriodicMetrics|.
+  void StartTimer();
+
+  // The periodic timer that triggers metrics to be recorded.
   base::RepeatingTimer<UserMetricsRecorder> timer_;
+
+  DISALLOW_COPY_AND_ASSIGN(UserMetricsRecorder);
 };
 
 }  // namespace ash
 
 #endif  // ASH_USER_METRICS_RECORDER_H_