Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(502)

Side by Side Diff: trunk/src/chrome/browser/metrics/metrics_state_manager.h

Issue 296703008: Revert 271798 "[Metrics] Make MetricsStateManager take a callbac..." (Closed) Base URL: svn://svn.chromium.org/chrome/
Patch Set: Created 6 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright 2014 The Chromium Authors. All rights reserved. 1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ 5 #ifndef CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_
6 #define CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ 6 #define CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_
7 7
8 #include <string> 8 #include <string>
9 9
10 #include "base/basictypes.h" 10 #include "base/basictypes.h"
11 #include "base/callback.h"
12 #include "base/gtest_prod_util.h" 11 #include "base/gtest_prod_util.h"
13 #include "base/memory/scoped_ptr.h" 12 #include "base/memory/scoped_ptr.h"
14 #include "base/metrics/field_trial.h" 13 #include "base/metrics/field_trial.h"
15 14
16 class PrefService; 15 class PrefService;
17 class PrefRegistrySimple; 16 class PrefRegistrySimple;
18 17
19 namespace metrics { 18 namespace metrics {
20 19
21 class ClonedInstallDetector; 20 class ClonedInstallDetector;
22 21
23 // Responsible for managing MetricsService state prefs, specifically the UMA 22 // Responsible for managing MetricsService state prefs, specifically the UMA
24 // client id and low entropy source. Code outside the metrics directory should 23 // client id and low entropy source. Code outside the metrics directory should
25 // not be instantiating or using this class directly. 24 // not be instantiating or using this class directly.
26 class MetricsStateManager { 25 class MetricsStateManager {
27 public: 26 public:
28 virtual ~MetricsStateManager(); 27 virtual ~MetricsStateManager();
29 28
30 // Returns true if the user opted in to sending metric reports. 29 // Returns true if the user opted in to sending metric reports.
30 // TODO(asvitkine): This function does not report the correct value on
31 // Android, see http://crbug.com/362192.
31 bool IsMetricsReportingEnabled(); 32 bool IsMetricsReportingEnabled();
32 33
33 // Returns the client ID for this client, or the empty string if the user is 34 // Returns the client ID for this client, or the empty string if the user is
34 // not opted in to metrics reporting. 35 // not opted in to metrics reporting.
35 const std::string& client_id() const { return client_id_; } 36 const std::string& client_id() const { return client_id_; }
36 37
37 // Forces the client ID to be generated. This is useful in case it's needed 38 // Forces the client ID to be generated. This is useful in case it's needed
38 // before recording. 39 // before recording.
39 void ForceClientIdCreation(); 40 void ForceClientIdCreation();
40 41
41 // Checks if this install was cloned or imaged from another machine. If a 42 // Checks if this install was cloned or imaged from another machine. If a
42 // clone is detected, resets the client id and low entropy source. This 43 // clone is detected, resets the client id and low entropy source. This
43 // should not be called more than once. 44 // should not be called more than once.
44 void CheckForClonedInstall( 45 void CheckForClonedInstall(
45 scoped_refptr<base::SingleThreadTaskRunner> task_runner); 46 scoped_refptr<base::SingleThreadTaskRunner> task_runner);
46 47
47 // Returns the preferred entropy provider used to seed persistent activities 48 // Returns the preferred entropy provider used to seed persistent activities
48 // based on whether or not metrics reporting is permitted on this client. 49 // based on whether or not metrics reporting is permitted on this client.
49 // 50 //
50 // If metrics reporting is enabled, this method returns an entropy provider 51 // If metrics reporting is enabled, this method returns an entropy provider
51 // that has a high source of entropy, partially based on the client ID. 52 // that has a high source of entropy, partially based on the client ID.
52 // Otherwise, it returns an entropy provider that is based on a low entropy 53 // Otherwise, it returns an entropy provider that is based on a low entropy
53 // source. 54 // source.
54 scoped_ptr<const base::FieldTrial::EntropyProvider> CreateEntropyProvider(); 55 scoped_ptr<const base::FieldTrial::EntropyProvider> CreateEntropyProvider();
55 56
56 // Creates the MetricsStateManager, enforcing that only a single instance 57 // Creates the MetricsStateManager, enforcing that only a single instance
57 // of the class exists at a time. Returns NULL if an instance exists already. 58 // of the class exists at a time. Returns NULL if an instance exists already.
58 static scoped_ptr<MetricsStateManager> Create( 59 static scoped_ptr<MetricsStateManager> Create(PrefService* local_state);
59 PrefService* local_state,
60 const base::Callback<bool(void)>& is_reporting_enabled_callback);
61 60
62 // Registers local state prefs used by this class. 61 // Registers local state prefs used by this class.
63 static void RegisterPrefs(PrefRegistrySimple* registry); 62 static void RegisterPrefs(PrefRegistrySimple* registry);
64 63
65 private: 64 private:
66 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_Low); 65 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_Low);
67 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_High); 66 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_High);
68 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, LowEntropySource0NotReset); 67 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, LowEntropySource0NotReset);
69 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, 68 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest,
70 PermutedEntropyCacheClearedWhenLowEntropyReset); 69 PermutedEntropyCacheClearedWhenLowEntropyReset);
71 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, ResetMetricsIDs); 70 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, ResetMetricsIDs);
72 71
73 // Designates which entropy source was returned from this class. 72 // Designates which entropy source was returned from this class.
74 // This is used for testing to validate that we return the correct source 73 // This is used for testing to validate that we return the correct source
75 // depending on the state of the service. 74 // depending on the state of the service.
76 enum EntropySourceType { 75 enum EntropySourceType {
77 ENTROPY_SOURCE_NONE, 76 ENTROPY_SOURCE_NONE,
78 ENTROPY_SOURCE_LOW, 77 ENTROPY_SOURCE_LOW,
79 ENTROPY_SOURCE_HIGH, 78 ENTROPY_SOURCE_HIGH,
80 }; 79 };
81 80
82 // Creates the MetricsStateManager with the given |local_state|. Calls 81 // Creates the MetricsStateManager with the given |local_state|. Clients
83 // |is_reporting_enabled_callback| to query whether metrics reporting is 82 // should instead use Create(), which enforces a single instance of this class
84 // enabled. Clients should instead use Create(), which enforces a single 83 // is alive at any given time.
85 // instance of this class is alive at any given time. 84 explicit MetricsStateManager(PrefService* local_state);
86 MetricsStateManager(
87 PrefService* local_state,
88 const base::Callback<bool(void)>& is_reporting_enabled_callback);
89 85
90 // Returns the low entropy source for this client. This is a random value 86 // Returns the low entropy source for this client. This is a random value
91 // that is non-identifying amongst browser clients. This method will 87 // that is non-identifying amongst browser clients. This method will
92 // generate the entropy source value if it has not been called before. 88 // generate the entropy source value if it has not been called before.
93 int GetLowEntropySource(); 89 int GetLowEntropySource();
94 90
95 // Returns the first entropy source that was returned by this service since 91 // Returns the first entropy source that was returned by this service since
96 // start up, or NONE if neither was returned yet. This is exposed for testing 92 // start up, or NONE if neither was returned yet. This is exposed for testing
97 // only. 93 // only.
98 EntropySourceType entropy_source_returned() const { 94 EntropySourceType entropy_source_returned() const {
99 return entropy_source_returned_; 95 return entropy_source_returned_;
100 } 96 }
101 97
102 // Reset the client id and low entropy source if the kMetricsResetMetricIDs 98 // Reset the client id and low entropy source if the kMetricsResetMetricIDs
103 // pref is true. 99 // pref is true.
104 void ResetMetricsIDsIfNecessary(); 100 void ResetMetricsIDsIfNecessary();
105 101
106 // Whether an instance of this class exists. Used to enforce that there aren't 102 // Whether an instance of this class exists. Used to enforce that there aren't
107 // multiple instances of this class at a given time. 103 // multiple instances of this class at a given time.
108 static bool instance_exists_; 104 static bool instance_exists_;
109 105
110 // Weak pointer to the local state prefs store. 106 // Weak pointer to the local state prefs store.
111 PrefService* const local_state_; 107 PrefService* local_state_;
112
113 const base::Callback<bool(void)> is_reporting_enabled_callback_;
114 108
115 // The identifier that's sent to the server with the log reports. 109 // The identifier that's sent to the server with the log reports.
116 std::string client_id_; 110 std::string client_id_;
117 111
118 // The non-identifying low entropy source value. 112 // The non-identifying low entropy source value.
119 int low_entropy_source_; 113 int low_entropy_source_;
120 114
121 // The last entropy source returned by this service, used for testing. 115 // The last entropy source returned by this service, used for testing.
122 EntropySourceType entropy_source_returned_; 116 EntropySourceType entropy_source_returned_;
123 117
124 scoped_ptr<ClonedInstallDetector> cloned_install_detector_; 118 scoped_ptr<ClonedInstallDetector> cloned_install_detector_;
125 119
126 DISALLOW_COPY_AND_ASSIGN(MetricsStateManager); 120 DISALLOW_COPY_AND_ASSIGN(MetricsStateManager);
127 }; 121 };
128 122
129 } // namespace metrics 123 } // namespace metrics
130 124
131 #endif // CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ 125 #endif // CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698