1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
// 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.
#ifndef COMPONENTS_VARIATIONS_VARIATIONS_HTTP_HEADER_PROVIDER_H_
#define COMPONENTS_VARIATIONS_VARIATIONS_HTTP_HEADER_PROVIDER_H_
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/metrics/field_trial.h"
#include "base/synchronization/lock.h"
#include "components/variations/synthetic_trials.h"
#include "components/variations/variations_associated_data.h"
namespace base {
template <typename T>
struct DefaultSingletonTraits;
}
namespace variations {
// A helper class for maintaining client experiments and metrics state
// transmitted in custom HTTP request headers.
// This class is a thread-safe singleton.
class VariationsHttpHeaderProvider : public base::FieldTrialList::Observer,
public SyntheticTrialObserver {
public:
static VariationsHttpHeaderProvider* GetInstance();
// Returns the value of the client data header, computing and caching it if
// necessary. If |is_signed_in| is false, variation ids that should only be
// sent for signed in users (i.e. GOOGLE_WEB_PROPERTIES_SIGNED_IN entries)
// will not be included.
std::string GetClientDataHeader(bool is_signed_in);
// Returns a space-separated string containing the list of current active
// variations (as would be reported in the |variation_id| repeated field of
// the ClientVariations proto). Does not include variation ids that should be
// sent for signed-in users only. The returned string is guaranteed to have a
// a leading and trailing space, e.g. " 123 234 345 ".
std::string GetVariationsString();
// Forces the list of |variation_ids| (which will be modified by adding the
// comma-separated |command_line_variation_ids|). This is a wrapper function
// around SetDefaultVariationIds.
bool ForceVariationIds(
const std::string& command_line_variation_ids,
std::vector<std::string>* variation_ids);
// Sets *additional* variation ids and trigger variation ids to be encoded in
// the X-Client-Data request header. This is intended for development use to
// force a server side experiment id. |variation_ids| should be a list of
// strings of numeric experiment ids. If an id is prefixed with "t" it will
// be treated as a trigger experiment id.
bool SetDefaultVariationIds(const std::vector<std::string>& variation_ids);
// Resets any cached state for tests.
void ResetForTesting();
private:
friend struct base::DefaultSingletonTraits<VariationsHttpHeaderProvider>;
typedef std::pair<VariationID, IDCollectionKey> VariationIDEntry;
FRIEND_TEST_ALL_PREFIXES(VariationsHttpHeaderProviderTest,
SetDefaultVariationIds_Valid);
FRIEND_TEST_ALL_PREFIXES(VariationsHttpHeaderProviderTest,
SetDefaultVariationIds_Invalid);
FRIEND_TEST_ALL_PREFIXES(VariationsHttpHeaderProviderTest,
OnFieldTrialGroupFinalized);
FRIEND_TEST_ALL_PREFIXES(VariationsHttpHeaderProviderTest,
GetVariationsString);
VariationsHttpHeaderProvider();
~VariationsHttpHeaderProvider() override;
// base::FieldTrialList::Observer:
// This will add the variation ID associated with |trial_name| and
// |group_name| to the variation ID cache.
void OnFieldTrialGroupFinalized(const std::string& trial_name,
const std::string& group_name) override;
// metrics::SyntheticTrialObserver:
void OnSyntheticTrialsChanged(
const std::vector<SyntheticTrialGroup>& groups) override;
// Prepares the variation IDs cache with initial values if not already done.
// This method also registers the caller with the FieldTrialList to receive
// new variation IDs.
void InitVariationIDsCacheIfNeeded();
// Looks up the associated id for the given trial/group and adds an entry for
// it to |variation_ids_set_| if found.
void CacheVariationsId(const std::string& trial_name,
const std::string& group_name,
IDCollectionKey key);
// Takes whatever is currently in |variation_ids_set_| and recreates
// |variation_ids_header_| with it. Assumes the the |lock_| is currently
// held.
void UpdateVariationIDsHeaderValue();
// Generates a base64-encoded proto to be used as a header value for the given
// |is_signed_in| state.
std::string GenerateBase64EncodedProto(bool is_signed_in);
// Returns the currently active set of variation ids, which includes any
// default values, synthetic variations and actual field trial variations.
std::set<VariationIDEntry> GetAllVariationIds();
// Guards access to variables below.
base::Lock lock_;
// Whether or not we've initialized the caches.
bool variation_ids_cache_initialized_;
// Keep a cache of variation IDs that are transmitted in headers to Google.
// This consists of a list of valid IDs, and the actual transmitted header.
std::set<VariationIDEntry> variation_ids_set_;
// Provides the google experiment ids forced from command line.
std::set<VariationIDEntry> default_variation_ids_set_;
// Variations ids from synthetic field trials.
std::set<VariationIDEntry> synthetic_variation_ids_set_;
std::string cached_variation_ids_header_;
std::string cached_variation_ids_header_signed_in_;
DISALLOW_COPY_AND_ASSIGN(VariationsHttpHeaderProvider);
};
} // namespace variations
#endif // COMPONENTS_VARIATIONS_VARIATIONS_HTTP_HEADER_PROVIDER_H_
|
