Refactor VariationsHttpHeaderProvider.

components/metrics/metrics_service.h

 // Copyright 2014 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.
 
 // This file defines a service that collects information about the user
 // experience in order to help improve future versions of the app.
 
 #ifndef COMPONENTS_METRICS_METRICS_SERVICE_H_
 #define COMPONENTS_METRICS_METRICS_SERVICE_H_
 
@@ skipping 10 matching lines @@
 #include "base/metrics/histogram_flattener.h"
 #include "base/metrics/histogram_snapshot_manager.h"
 #include "base/metrics/user_metrics.h"
 #include "base/observer_list.h"
 #include "base/time/time.h"
 #include "components/metrics/clean_exit_beacon.h"
 #include "components/metrics/metrics_log.h"
 #include "components/metrics/metrics_log_manager.h"
 #include "components/metrics/metrics_provider.h"
 #include "components/metrics/net/network_metrics_provider.h"
-#include "components/variations/active_field_trials.h"
+#include "components/variations/synthetic_trials.h"
 
 class PrefService;
 class PrefRegistrySimple;
 
 namespace base {
 class DictionaryValue;
 class HistogramSamples;
 class PrefService;
 }
 
 namespace variations {
 struct ActiveGroupId;
 }
 
 namespace net {
 class URLFetcher;
 }
 
 namespace metrics {
 
 class MetricsLogUploader;
 class MetricsReportingScheduler;
 class MetricsServiceAccessor;
 class MetricsServiceClient;
 class MetricsStateManager;
 
-// A Field Trial and its selected group, which represent a particular
-// Chrome configuration state. For example, the trial name could map to
-// a preference name, and the group name could map to a preference value.
-struct SyntheticTrialGroup {
- public:
-  ~SyntheticTrialGroup();
-
-  variations::ActiveGroupId id;
-  base::TimeTicks start_time;
-
- private:
-  // Synthetic field trial users:
-  friend class MetricsServiceAccessor;
-  friend class MetricsService;
-  FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, RegisterSyntheticTrial);
-
-  // This constructor is private specifically so as to control which code is
-  // able to access it. New code that wishes to use it should be added as a
-  // friend class.
-  SyntheticTrialGroup(uint32 trial, uint32 group);
-};
-
-// Interface class to observe changes to synthetic trials in MetricsService.
-class SyntheticTrialObserver {
- public:
-  // Called when the list of synthetic field trial groups has changed.
-  virtual void OnSyntheticTrialsChanged(
-      const std::vector<SyntheticTrialGroup>& groups) = 0;
-
- protected:
-  virtual ~SyntheticTrialObserver() {}
-};
-
 // See metrics_service.cc for a detailed description.
 class MetricsService : public base::HistogramFlattener {
  public:
   // The execution phase of the browser.
   enum ExecutionPhase {
     UNINITIALIZED_PHASE = 0,
     START_METRICS_RECORDING = 100,
     CREATE_PROFILE = 200,
     STARTUP_TIMEBOMB_ARM = 300,
     THREAD_WATCHER_START = 400,
@@ skipping 108 matching lines @@
   // This count is eventually send via UMA logs.
   void RecordBreakpadHasDebugger(bool has_debugger);
 
   bool recording_active() const;
   bool reporting_active() const;
 
   // Redundant test to ensure that we are notified of a clean exit.
   // This value should be true when process has completed shutdown.
   static bool UmaMetricsProperlyShutdown();
 
-  // Registers a field trial name and group to be used to annotate a UMA report
-  // with a particular Chrome configuration state. A UMA report will be
-  // annotated with this trial group if and only if all events in the report
-  // were created after the trial is registered. Only one group name may be
-  // registered at a time for a given trial_name. Only the last group name that
-  // is registered for a given trial name will be recorded. The values passed
-  // in must not correspond to any real field trial in the code.
-  // To use this method, SyntheticTrialGroup should friend your class.
-  void RegisterSyntheticFieldTrial(const SyntheticTrialGroup& trial_group);
-
   // Public accessor that returns the list of synthetic field trials. It must
   // only be used for testing.
   void GetCurrentSyntheticFieldTrialsForTesting(
       std::vector<variations::ActiveGroupId>* synthetic_trials);
 
   // Adds an observer to be notified when the synthetic trials list changes.
-  void AddSyntheticTrialObserver(SyntheticTrialObserver* observer);
+  void AddSyntheticTrialObserver(variations::SyntheticTrialObserver* observer);
 
   // Removes an existing observer of synthetic trials list changes.
-  void RemoveSyntheticTrialObserver(SyntheticTrialObserver* observer);
+  void RemoveSyntheticTrialObserver(
+      variations::SyntheticTrialObserver* observer);
 
   // Register the specified |provider| to provide additional metrics into the
   // UMA log. Should be called during MetricsService initialization only.
   void RegisterMetricsProvider(scoped_ptr<MetricsProvider> provider);
 
   // Check if this install was cloned or imaged from another machine. If a
   // clone is detected, reset the client id and low entropy source. This
   // should not be called more than once.
   void CheckForClonedInstall(
       scoped_refptr<base::SingleThreadTaskRunner> task_runner);
 
   // Clears the stability metrics that are saved in local state.
   void ClearSavedStabilityMetrics();
 
   // Pushes a log that has been generated by an external component.
   void PushExternalLog(const std::string& log);
 
  protected:
   // Exposed for testing.
   MetricsLogManager* log_manager() { return &log_manager_; }
 
  private:
+  friend class MetricsServiceAccessor;
+
   // The MetricsService has a lifecycle that is stored as a state.
   // See metrics_service.cc for description of this lifecycle.
   enum State {
     INITIALIZED,          // Constructor was called.
     INIT_TASK_SCHEDULED,  // Waiting for deferred init tasks to finish.
     INIT_TASK_DONE,       // Waiting for timer to send initial log.
     SENDING_LOGS,         // Sending logs an creating new ones when we run out.
   };
 
   enum ShutdownCleanliness {
     CLEANLY_SHUTDOWN = 0xdeadbeef,
     NEED_TO_SHUTDOWN = ~CLEANLY_SHUTDOWN
   };
 
   // The current state of recording for the MetricsService. The state is UNSET
   // until set to something else, at which point it remains INACTIVE or ACTIVE
   // for the lifetime of the object.
   enum RecordingState {
     INACTIVE,
     ACTIVE,
     UNSET
   };
 
-  typedef std::vector<SyntheticTrialGroup> SyntheticTrialGroups;
+  typedef std::vector<variations::SyntheticTrialGroup> SyntheticTrialGroups;
+
+  // Registers a field trial name and group to be used to annotate a UMA report
+  // with a particular Chrome configuration state. A UMA report will be
+  // annotated with this trial group if and only if all events in the report
+  // were created after the trial is registered. Only one group name may be
+  // registered at a time for a given trial_name. Only the last group name that
+  // is registered for a given trial name will be recorded. The values passed
+  // in must not correspond to any real field trial in the code.
+  void RegisterSyntheticFieldTrial(
+      const variations::SyntheticTrialGroup& trial_group);
 
   // Calls into the client to initialize some system profile metrics.
   void StartInitTask();
 
   // Callback that moves the state to INIT_TASK_DONE. When this is called, the
   // state should be INIT_TASK_SCHEDULED.
   void FinishedInitTask();
 
   void OnUserAction(const std::string& action);
 
@@ skipping 187 matching lines @@
   // Stores the time of the first call to |GetUptimes()|.
   base::TimeTicks first_updated_time_;
 
   // Stores the time of the last call to |GetUptimes()|.
   base::TimeTicks last_updated_time_;
 
   // Field trial groups that map to Chrome configuration states.
   SyntheticTrialGroups synthetic_trial_groups_;
 
   // List of observers of |synthetic_trial_groups_| changes.
-  base::ObserverList<SyntheticTrialObserver> synthetic_trial_observer_list_;
+  base::ObserverList<variations::SyntheticTrialObserver>
+      synthetic_trial_observer_list_;
 
   // Execution phase the browser is in.
   static ExecutionPhase execution_phase_;
 
   // Reduntant marker to check that we completed our shutdown, and set the
   // exited-cleanly bit in the prefs.
   static ShutdownCleanliness clean_shutdown_status_;
 
   FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, IsPluginProcess);
   FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest,
                            PermutedEntropyCacheClearedWhenLowEntropyReset);
   FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, RegisterSyntheticTrial);
 
   // Weak pointers factory used to post task on different threads. All weak
   // pointers managed by this factory have the same lifetime as MetricsService.
   base::WeakPtrFactory<MetricsService> self_ptr_factory_;
 
   // Weak pointers factory used for saving state. All weak pointers managed by
   // this factory are invalidated in ScheduleNextStateSave.
   base::WeakPtrFactory<MetricsService> state_saver_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MetricsService);
 };
 
 }  // namespace metrics
 
 #endif  // COMPONENTS_METRICS_METRICS_SERVICE_H_