| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 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_VARIATIONS_VARIATIONS_SERVICE_H_ | 5 #ifndef CHROME_BROWSER_METRICS_VARIATIONS_VARIATIONS_SERVICE_H_ |
| 6 #define CHROME_BROWSER_METRICS_VARIATIONS_VARIATIONS_SERVICE_H_ | 6 #define CHROME_BROWSER_METRICS_VARIATIONS_VARIATIONS_SERVICE_H_ |
| 7 | 7 |
| 8 #include <string> | 8 #include <string> |
| 9 | 9 |
| 10 #include "base/compiler_specific.h" | 10 #include "base/compiler_specific.h" |
| 11 #include "base/gtest_prod_util.h" | 11 #include "base/gtest_prod_util.h" |
| 12 #include "base/memory/scoped_ptr.h" | 12 #include "base/memory/scoped_ptr.h" |
| 13 #include "base/metrics/field_trial.h" | 13 #include "base/metrics/field_trial.h" |
| 14 #include "base/time.h" | 14 #include "base/time.h" |
| 15 #include "base/timer.h" | 15 #include "base/timer.h" |
| 16 #include "chrome/browser/metrics/proto/study.pb.h" | 16 #include "chrome/browser/metrics/proto/study.pb.h" |
| 17 #include "chrome/browser/metrics/proto/trials_seed.pb.h" | 17 #include "chrome/browser/metrics/proto/trials_seed.pb.h" |
| 18 #include "chrome/browser/metrics/variations/resource_request_allowed_notifier.h" |
| 18 #include "chrome/common/chrome_version_info.h" | 19 #include "chrome/common/chrome_version_info.h" |
| 19 #include "googleurl/src/gurl.h" | 20 #include "googleurl/src/gurl.h" |
| 20 #include "net/base/network_change_notifier.h" | |
| 21 #include "net/url_request/url_fetcher_delegate.h" | 21 #include "net/url_request/url_fetcher_delegate.h" |
| 22 | 22 |
| 23 class PrefService; | 23 class PrefService; |
| 24 | 24 |
| 25 namespace chrome_variations { | 25 namespace chrome_variations { |
| 26 | 26 |
| 27 // Used to setup field trials based on stored variations seed data, and fetch | 27 // Used to setup field trials based on stored variations seed data, and fetch |
| 28 // new seed data from the variations server. | 28 // new seed data from the variations server. |
| 29 class VariationsService | 29 class VariationsService |
| 30 : public net::URLFetcherDelegate, | 30 : public net::URLFetcherDelegate, |
| 31 public net::NetworkChangeNotifier::ConnectionTypeObserver{ | 31 public ResourceRequestAllowedNotifier::Observer { |
| 32 public: | 32 public: |
| 33 VariationsService(); | 33 VariationsService(); |
| 34 |
| 35 // This constructor exists for injecting a mock notifier. It is meant for |
| 36 // testing only. This instance will take ownership of |notifier|. |
| 37 explicit VariationsService(ResourceRequestAllowedNotifier* notifier); |
| 38 |
| 34 virtual ~VariationsService(); | 39 virtual ~VariationsService(); |
| 35 | 40 |
| 36 // Creates field trials based on Variations Seed loaded from local prefs. If | 41 // Creates field trials based on Variations Seed loaded from local prefs. If |
| 37 // there is a problem loading the seed data, all trials specified by the seed | 42 // there is a problem loading the seed data, all trials specified by the seed |
| 38 // may not be created. | 43 // may not be created. |
| 39 bool CreateTrialsFromSeed(PrefService* local_prefs); | 44 bool CreateTrialsFromSeed(PrefService* local_prefs); |
| 40 | 45 |
| 41 // Calls FetchVariationsSeed once and repeats this periodically. See | 46 // Calls FetchVariationsSeed once and repeats this periodically. See |
| 42 // implementation for details on the period. Must be called after | 47 // implementation for details on the period. Must be called after |
| 43 // |CreateTrialsFromSeed|. | 48 // |CreateTrialsFromSeed|. |
| 44 void StartRepeatedVariationsSeedFetch(); | 49 void StartRepeatedVariationsSeedFetch(); |
| 45 | 50 |
| 46 // Starts the fetching process once, where |OnURLFetchComplete| is called with | |
| 47 // the response. If the network is down at the time, sets a flag to retry when | |
| 48 // the network is back online. This is virtual so it can be overriden for | |
| 49 // testing. | |
| 50 virtual void FetchVariationsSeed(); | |
| 51 | |
| 52 // Exposed for testing. | |
| 53 void SetWasOfflineDuringLastRequestAttemptForTesting(bool offline); | |
| 54 | |
| 55 // Register Variations related prefs in Local State. | 51 // Register Variations related prefs in Local State. |
| 56 static void RegisterPrefs(PrefService* prefs); | 52 static void RegisterPrefs(PrefService* prefs); |
| 57 | 53 |
| 54 // Exposed for testing. |
| 55 void SetCreateTrialsFromSeedCalledForTesting(bool called); |
| 56 |
| 57 protected: |
| 58 // Starts the fetching process once, where |OnURLFetchComplete| is called with |
| 59 // the response. |
| 60 virtual void DoActualFetch(); |
| 61 |
| 58 private: | 62 private: |
| 59 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyChannel); | 63 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyChannel); |
| 60 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyLocale); | 64 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyLocale); |
| 61 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyPlatform); | 65 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyPlatform); |
| 62 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyVersion); | 66 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyVersion); |
| 63 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyVersionWildcards); | 67 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyVersionWildcards); |
| 64 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyStartDate); | 68 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, CheckStudyStartDate); |
| 65 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, DoNotFetchIfOffline); | 69 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, DoNotFetchIfOffline); |
| 66 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, DoNotFetchIfOnlineToOnline); | 70 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, DoNotFetchIfOnlineToOnline); |
| 67 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, FetchOnReconnect); | 71 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, FetchOnReconnect); |
| 68 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, IsStudyExpired); | 72 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, IsStudyExpired); |
| 69 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, LoadSeed); | 73 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, LoadSeed); |
| 70 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, StoreSeed); | 74 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, StoreSeed); |
| 71 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, ValidateStudy); | 75 FRIEND_TEST_ALL_PREFIXES(VariationsServiceTest, ValidateStudy); |
| 72 | 76 |
| 77 // Checks if prerequisites for fetching the Variations seed are met, and if |
| 78 // so, performs the actual fetch using |DoActualFetch|. |
| 79 void FetchVariationsSeed(); |
| 80 |
| 73 // net::URLFetcherDelegate implementation: | 81 // net::URLFetcherDelegate implementation: |
| 74 virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE; | 82 virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE; |
| 75 | 83 |
| 76 // net::NetworkChangeNotifier::ConnectionTypeObserver implementation. | 84 // ResourceRequestAllowedNotifier::Observer implementation: |
| 77 virtual void OnConnectionTypeChanged( | 85 virtual void OnResourceRequestsAllowed() OVERRIDE; |
| 78 net::NetworkChangeNotifier::ConnectionType type) OVERRIDE; | |
| 79 | 86 |
| 80 // Store the given seed data to the given local prefs. Note that |seed_data| | 87 // Store the given seed data to the given local prefs. Note that |seed_data| |
| 81 // is assumed to be the raw serialized protobuf data stored in a string. It | 88 // is assumed to be the raw serialized protobuf data stored in a string. It |
| 82 // will be Base64Encoded for storage. If the string is invalid or the encoding | 89 // will be Base64Encoded for storage. If the string is invalid or the encoding |
| 83 // fails, the |local_prefs| is left as is and the function returns false. | 90 // fails, the |local_prefs| is left as is and the function returns false. |
| 84 bool StoreSeedData(const std::string& seed_data, | 91 bool StoreSeedData(const std::string& seed_data, |
| 85 const base::Time& seed_date, | 92 const base::Time& seed_date, |
| 86 PrefService* local_prefs); | 93 PrefService* local_prefs); |
| 87 | 94 |
| 88 // Returns whether |study| should be disabled according to its restriction | 95 // Returns whether |study| should be disabled according to its restriction |
| (...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 139 // The URL to use for querying the Variations server. | 146 // The URL to use for querying the Variations server. |
| 140 GURL variations_server_url_; | 147 GURL variations_server_url_; |
| 141 | 148 |
| 142 // Cached serial number from the most recently fetched Variations seed. | 149 // Cached serial number from the most recently fetched Variations seed. |
| 143 std::string variations_serial_number_; | 150 std::string variations_serial_number_; |
| 144 | 151 |
| 145 // Tracks whether |CreateTrialsFromSeed| has been called, to ensure that | 152 // Tracks whether |CreateTrialsFromSeed| has been called, to ensure that |
| 146 // it gets called prior to |StartRepeatedVariationsSeedFetch|. | 153 // it gets called prior to |StartRepeatedVariationsSeedFetch|. |
| 147 bool create_trials_from_seed_called_; | 154 bool create_trials_from_seed_called_; |
| 148 | 155 |
| 149 // Tracks whether or not the last seed request attempt failed due to being | |
| 150 // offline. | |
| 151 bool was_offline_during_last_request_attempt_; | |
| 152 | |
| 153 // The timer used to repeatedly ping the server. Keep this as an instance | 156 // The timer used to repeatedly ping the server. Keep this as an instance |
| 154 // member so if VariationsService goes out of scope, the timer is | 157 // member so if VariationsService goes out of scope, the timer is |
| 155 // automatically canceled. | 158 // automatically canceled. |
| 156 base::RepeatingTimer<VariationsService> timer_; | 159 base::RepeatingTimer<VariationsService> timer_; |
| 160 |
| 161 // Helper class used to tell this service if it's allowed to make network |
| 162 // resource requests. |
| 163 scoped_ptr<ResourceRequestAllowedNotifier> resource_request_allowed_notifier_; |
| 157 }; | 164 }; |
| 158 | 165 |
| 159 } // namespace chrome_variations | 166 } // namespace chrome_variations |
| 160 | 167 |
| 161 #endif // CHROME_BROWSER_METRICS_VARIATIONS_VARIATIONS_SERVICE_H_ | 168 #endif // CHROME_BROWSER_METRICS_VARIATIONS_VARIATIONS_SERVICE_H_ |
| OLD | NEW |