| OLD | NEW |
|---|
| (Empty) |
| 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 | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #include "components/variations/net/variations_http_header_provider.h" | |
| 6 | |
| 7 #include <set> | |
| 8 #include <string> | |
| 9 #include <vector> | |
| 10 | |
| 11 #include "base/base64.h" | |
| 12 #include "base/memory/singleton.h" | |
| 13 #include "base/metrics/histogram_macros.h" | |
| 14 #include "base/strings/string_number_conversions.h" | |
| 15 #include "base/strings/string_split.h" | |
| 16 #include "base/strings/string_util.h" | |
| 17 #include "components/google/core/browser/google_util.h" | |
| 18 #include "components/variations/proto/client_variations.pb.h" | |
| 19 #include "net/base/registry_controlled_domains/registry_controlled_domain.h" | |
| 20 #include "net/http/http_request_headers.h" | |
| 21 #include "url/gurl.h" | |
| 22 | |
| 23 namespace variations { | |
| 24 | |
| 25 namespace { | |
| 26 | |
| 27 const char* kSuffixesToSetHeadersFor[] = { | |
| 28 ".android.com", | |
| 29 ".doubleclick.com", | |
| 30 ".doubleclick.net", | |
| 31 ".ggpht.com", | |
| 32 ".googleadservices.com", | |
| 33 ".googleapis.com", | |
| 34 ".googlesyndication.com", | |
| 35 ".googleusercontent.com", | |
| 36 ".googlevideo.com", | |
| 37 ".gstatic.com", | |
| 38 ".ytimg.com", | |
| 39 }; | |
| 40 | |
| 41 const char kChromeUMAEnabled[] = "X-Chrome-UMA-Enabled"; | |
| 42 const char kClientData[] = "X-Client-Data"; | |
| 43 | |
| 44 } // namespace | |
| 45 | |
| 46 VariationsHttpHeaderProvider* VariationsHttpHeaderProvider::GetInstance() { | |
| 47 return base::Singleton<VariationsHttpHeaderProvider>::get(); | |
| 48 } | |
| 49 | |
| 50 void VariationsHttpHeaderProvider::AppendHeaders( | |
| 51 const GURL& url, | |
| 52 bool incognito, | |
| 53 bool uma_enabled, | |
| 54 net::HttpRequestHeaders* headers) { | |
| 55 // Note the criteria for attaching client experiment headers: | |
| 56 // 1. We only transmit to Google owned domains which can evaluate experiments. | |
| 57 // 1a. These include hosts which have a standard postfix such as: | |
| 58 // *.doubleclick.net or *.googlesyndication.com or | |
| 59 // exactly www.googleadservices.com or | |
| 60 // international TLD domains *.google.<TLD> or *.youtube.<TLD>. | |
| 61 // 2. Only transmit for non-Incognito profiles. | |
| 62 // 3. For the X-Chrome-UMA-Enabled bit, only set it if UMA is in fact enabled | |
| 63 // for this install of Chrome. | |
| 64 // 4. For the X-Client-Data header, only include non-empty variation IDs. | |
| 65 if (incognito || !ShouldAppendHeaders(url)) | |
| 66 return; | |
| 67 | |
| 68 if (uma_enabled) | |
| 69 headers->SetHeaderIfMissing(kChromeUMAEnabled, "1"); | |
| 70 | |
| 71 // Lazily initialize the header, if not already done, before attempting to | |
| 72 // transmit it. | |
| 73 InitVariationIDsCacheIfNeeded(); | |
| 74 | |
| 75 std::string variation_ids_header_copy; | |
| 76 { | |
| 77 base::AutoLock scoped_lock(lock_); | |
| 78 variation_ids_header_copy = variation_ids_header_; | |
| 79 } | |
| 80 | |
| 81 if (!variation_ids_header_copy.empty()) { | |
| 82 // Note that prior to M33 this header was named X-Chrome-Variations. | |
| 83 headers->SetHeaderIfMissing(kClientData, variation_ids_header_copy); | |
| 84 } | |
| 85 } | |
| 86 | |
| 87 bool VariationsHttpHeaderProvider::SetDefaultVariationIds( | |
| 88 const std::string& variation_ids) { | |
| 89 default_variation_ids_set_.clear(); | |
| 90 default_trigger_id_set_.clear(); | |
| 91 for (const base::StringPiece& entry : base::SplitStringPiece( | |
| 92 variation_ids, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL)) { | |
| 93 if (entry.empty()) { | |
| 94 default_variation_ids_set_.clear(); | |
| 95 default_trigger_id_set_.clear(); | |
| 96 return false; | |
| 97 } | |
| 98 bool trigger_id = | |
| 99 base::StartsWith(entry, "t", base::CompareCase::SENSITIVE); | |
| 100 // Remove the "t" prefix if it's there. | |
| 101 base::StringPiece trimmed_entry = trigger_id ? entry.substr(1) : entry; | |
| 102 | |
| 103 int variation_id = 0; | |
| 104 if (!base::StringToInt(trimmed_entry, &variation_id)) { | |
| 105 default_variation_ids_set_.clear(); | |
| 106 default_trigger_id_set_.clear(); | |
| 107 return false; | |
| 108 } | |
| 109 if (trigger_id) | |
| 110 default_trigger_id_set_.insert(variation_id); | |
| 111 else | |
| 112 default_variation_ids_set_.insert(variation_id); | |
| 113 } | |
| 114 return true; | |
| 115 } | |
| 116 | |
| 117 std::set<std::string> VariationsHttpHeaderProvider::GetVariationHeaderNames() | |
| 118 const { | |
| 119 std::set<std::string> headers; | |
| 120 headers.insert(kChromeUMAEnabled); | |
| 121 headers.insert(kClientData); | |
| 122 return headers; | |
| 123 } | |
| 124 | |
| 125 void VariationsHttpHeaderProvider::ResetForTesting() { | |
| 126 base::AutoLock scoped_lock(lock_); | |
| 127 | |
| 128 // Stop observing field trials so that it can be restarted when this is | |
| 129 // re-inited. Note: This is a no-op if this is not currently observing. | |
| 130 base::FieldTrialList::RemoveObserver(this); | |
| 131 variation_ids_cache_initialized_ = false; | |
| 132 } | |
| 133 | |
| 134 VariationsHttpHeaderProvider::VariationsHttpHeaderProvider() | |
| 135 : variation_ids_cache_initialized_(false) { | |
| 136 } | |
| 137 | |
| 138 VariationsHttpHeaderProvider::~VariationsHttpHeaderProvider() { | |
| 139 } | |
| 140 | |
| 141 void VariationsHttpHeaderProvider::OnFieldTrialGroupFinalized( | |
| 142 const std::string& trial_name, | |
| 143 const std::string& group_name) { | |
| 144 VariationID new_id = | |
| 145 GetGoogleVariationID(GOOGLE_WEB_PROPERTIES, trial_name, group_name); | |
| 146 VariationID new_trigger_id = GetGoogleVariationID( | |
| 147 GOOGLE_WEB_PROPERTIES_TRIGGER, trial_name, group_name); | |
| 148 if (new_id == EMPTY_ID && new_trigger_id == EMPTY_ID) | |
| 149 return; | |
| 150 | |
| 151 base::AutoLock scoped_lock(lock_); | |
| 152 if (new_id != EMPTY_ID) | |
| 153 variation_ids_set_.insert(new_id); | |
| 154 if (new_trigger_id != EMPTY_ID) | |
| 155 variation_trigger_ids_set_.insert(new_trigger_id); | |
| 156 | |
| 157 UpdateVariationIDsHeaderValue(); | |
| 158 } | |
| 159 | |
| 160 void VariationsHttpHeaderProvider::OnSyntheticTrialsChanged( | |
| 161 const std::vector<metrics::SyntheticTrialGroup>& groups) { | |
| 162 base::AutoLock scoped_lock(lock_); | |
| 163 | |
| 164 synthetic_variation_ids_set_.clear(); | |
| 165 for (const metrics::SyntheticTrialGroup& group : groups) { | |
| 166 const VariationID id = | |
| 167 GetGoogleVariationIDFromHashes(GOOGLE_WEB_PROPERTIES, group.id); | |
| 168 if (id != EMPTY_ID) | |
| 169 synthetic_variation_ids_set_.insert(id); | |
| 170 } | |
| 171 UpdateVariationIDsHeaderValue(); | |
| 172 } | |
| 173 | |
| 174 void VariationsHttpHeaderProvider::InitVariationIDsCacheIfNeeded() { | |
| 175 base::AutoLock scoped_lock(lock_); | |
| 176 if (variation_ids_cache_initialized_) | |
| 177 return; | |
| 178 | |
| 179 // Register for additional cache updates. This is done first to avoid a race | |
| 180 // that could cause registered FieldTrials to be missed. | |
| 181 DCHECK(base::MessageLoop::current()); | |
| 182 base::FieldTrialList::AddObserver(this); | |
| 183 | |
| 184 base::TimeTicks before_time = base::TimeTicks::Now(); | |
| 185 | |
| 186 base::FieldTrial::ActiveGroups initial_groups; | |
| 187 base::FieldTrialList::GetActiveFieldTrialGroups(&initial_groups); | |
| 188 for (base::FieldTrial::ActiveGroups::const_iterator it = | |
| 189 initial_groups.begin(); | |
| 190 it != initial_groups.end(); ++it) { | |
| 191 const VariationID id = | |
| 192 GetGoogleVariationID(GOOGLE_WEB_PROPERTIES, it->trial_name, | |
| 193 it->group_name); | |
| 194 if (id != EMPTY_ID) | |
| 195 variation_ids_set_.insert(id); | |
| 196 | |
| 197 const VariationID trigger_id = | |
| 198 GetGoogleVariationID(GOOGLE_WEB_PROPERTIES_TRIGGER, it->trial_name, | |
| 199 it->group_name); | |
| 200 if (trigger_id != EMPTY_ID) | |
| 201 variation_trigger_ids_set_.insert(trigger_id); | |
| 202 } | |
| 203 UpdateVariationIDsHeaderValue(); | |
| 204 | |
| 205 UMA_HISTOGRAM_CUSTOM_COUNTS( | |
| 206 "Variations.HeaderConstructionTime", | |
| 207 (base::TimeTicks::Now() - before_time).InMicroseconds(), | |
| 208 0, | |
| 209 base::TimeDelta::FromSeconds(1).InMicroseconds(), | |
| 210 50); | |
| 211 | |
| 212 variation_ids_cache_initialized_ = true; | |
| 213 } | |
| 214 | |
| 215 void VariationsHttpHeaderProvider::UpdateVariationIDsHeaderValue() { | |
| 216 lock_.AssertAcquired(); | |
| 217 | |
| 218 // The header value is a serialized protobuffer of Variation IDs which is | |
| 219 // base64 encoded before transmitting as a string. | |
| 220 variation_ids_header_.clear(); | |
| 221 | |
| 222 if (variation_ids_set_.empty() && default_variation_ids_set_.empty() && | |
| 223 variation_trigger_ids_set_.empty() && default_trigger_id_set_.empty() && | |
| 224 synthetic_variation_ids_set_.empty()) { | |
| 225 return; | |
| 226 } | |
| 227 | |
| 228 // This is the bottleneck for the creation of the header, so validate the size | |
| 229 // here. Force a hard maximum on the ID count in case the Variations server | |
| 230 // returns too many IDs and DOSs receiving servers with large requests. | |
| 231 const size_t total_id_count = | |
| 232 variation_ids_set_.size() + variation_trigger_ids_set_.size(); | |
| 233 DCHECK_LE(total_id_count, 10U); | |
| 234 UMA_HISTOGRAM_COUNTS_100("Variations.Headers.ExperimentCount", | |
| 235 total_id_count); | |
| 236 if (total_id_count > 20) | |
| 237 return; | |
| 238 | |
| 239 // Merge the two sets of experiment ids. | |
| 240 std::set<VariationID> all_variation_ids_set = default_variation_ids_set_; | |
| 241 for (VariationID id : variation_ids_set_) | |
| 242 all_variation_ids_set.insert(id); | |
| 243 for (VariationID id : synthetic_variation_ids_set_) | |
| 244 all_variation_ids_set.insert(id); | |
| 245 | |
| 246 std::set<VariationID> all_trigger_ids_set = default_trigger_id_set_; | |
| 247 for (VariationID id : variation_trigger_ids_set_) | |
| 248 all_trigger_ids_set.insert(id); | |
| 249 | |
| 250 ClientVariations proto; | |
| 251 for (VariationID id : all_variation_ids_set) | |
| 252 proto.add_variation_id(id); | |
| 253 for (VariationID id : all_trigger_ids_set) | |
| 254 proto.add_trigger_variation_id(id); | |
| 255 | |
| 256 std::string serialized; | |
| 257 proto.SerializeToString(&serialized); | |
| 258 | |
| 259 std::string hashed; | |
| 260 base::Base64Encode(serialized, &hashed); | |
| 261 // If successful, swap the header value with the new one. | |
| 262 // Note that the list of IDs and the header could be temporarily out of sync | |
| 263 // if IDs are added as the header is recreated. The receiving servers are OK | |
| 264 // with such discrepancies. | |
| 265 variation_ids_header_ = hashed; | |
| 266 } | |
| 267 | |
| 268 // static | |
| 269 bool VariationsHttpHeaderProvider::ShouldAppendHeaders(const GURL& url) { | |
| 270 if (google_util::IsGoogleDomainUrl(url, google_util::ALLOW_SUBDOMAIN, | |
| 271 google_util::ALLOW_NON_STANDARD_PORTS)) { | |
| 272 return true; | |
| 273 } | |
| 274 | |
| 275 if (!url.is_valid() || !url.SchemeIsHTTPOrHTTPS()) | |
| 276 return false; | |
| 277 | |
| 278 // Some domains don't have international TLD extensions, so testing for them | |
| 279 // is very straight forward. | |
| 280 const std::string host = url.host(); | |
| 281 for (size_t i = 0; i < arraysize(kSuffixesToSetHeadersFor); ++i) { | |
| 282 if (base::EndsWith(host, kSuffixesToSetHeadersFor[i], | |
| 283 base::CompareCase::INSENSITIVE_ASCII)) | |
| 284 return true; | |
| 285 } | |
| 286 | |
| 287 return google_util::IsYoutubeDomainUrl(url, google_util::ALLOW_SUBDOMAIN, | |
| 288 google_util::ALLOW_NON_STANDARD_PORTS); | |
| 289 } | |
| 290 | |
| 291 } // namespace variations | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 1530133005:
Refactor VariationsHttpHeaderProvider. (Closed)
Base URL: https://chromium.googlesource.com/chromium/src.git@master