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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/// Copyright 2019 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.
#include "components/feature_engagement/public/feature_configurations.h"
#include "build/build_config.h"
#include "components/feature_engagement/public/configuration.h"
#include "components/feature_engagement/public/feature_constants.h"
namespace feature_engagement {
absl::optional<FeatureConfig> GetClientSideFeatureConfig(
const base::Feature* feature) {
#if defined(OS_WIN) || defined(OS_APPLE) || defined(OS_LINUX) || \
defined(OS_CHROMEOS)
if (kIPHPasswordsAccountStorageFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
config->trigger = EventConfig("passwords_account_storage_trigger",
Comparator(LESS_THAN, 5), 180, 180);
config->used = EventConfig("passwords_account_storage_used",
Comparator(EQUAL, 0), 180, 180);
config->event_configs.insert(
EventConfig("passwords_account_storage_unselected",
Comparator(EQUAL, 0), 180, 180));
return config;
}
if (kIPHProfileSwitchFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
// Show the promo once a year if the profile menu was not opened.
config->trigger =
EventConfig("profile_switch_trigger", Comparator(EQUAL, 0), 360, 360);
config->used =
EventConfig("profile_menu_shown", Comparator(EQUAL, 0), 360, 360);
return config;
}
#endif // defined(OS_WIN) || defined(OS_APPLE) || defined(OS_LINUX) ||
// defined(OS_CHROMEOS)
#if defined(OS_ANDROID)
constexpr int k10YearsInDays = 365 * 10;
if (kIPHDataSaverDetailFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("data_saver_detail_iph_trigger",
Comparator(EQUAL, 0), 90, 360);
config->used = EventConfig("data_saver_overview_opened",
Comparator(EQUAL, 0), 90, 360);
config->event_configs.insert(
EventConfig("data_saved_page_load",
Comparator(GREATER_THAN_OR_EQUAL, 10), 90, 360));
return config;
}
if (kIPHDataSaverPreviewFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("data_saver_preview_iph_trigger",
Comparator(EQUAL, 0), 90, 360);
config->used = EventConfig("data_saver_preview_opened",
Comparator(LESS_THAN_OR_EQUAL, 1), 90, 360);
return config;
}
if (kIPHPreviewsOmniboxUIFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("previews_verbose_iph_triggered_2",
Comparator(LESS_THAN, 2), 90, 360);
config->used = EventConfig("previews_verbose_status_opened",
Comparator(EQUAL, 0), 90, 360);
config->event_configs.insert(EventConfig(
"preview_page_load", Comparator(GREATER_THAN_OR_EQUAL, 1), 90, 360));
return config;
}
if (kIPHDownloadHomeFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(GREATER_THAN_OR_EQUAL, 14);
config->session_rate = Comparator(EQUAL, 0);
config->trigger =
EventConfig("download_home_iph_trigger", Comparator(EQUAL, 0), 90, 360);
config->used =
EventConfig("download_home_opened", Comparator(EQUAL, 0), 90, 360);
config->event_configs.insert(EventConfig(
"download_completed", Comparator(GREATER_THAN_OR_EQUAL, 1), 90, 360));
return config;
}
if (kIPHDownloadIndicatorFeature.name == feature->name) {
// A config that allows the DownloadIndicator IPH to be shown up to 2 times,
// but only if download home hasn't been opened in the last 90 days.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
config->trigger = EventConfig("download_indicator_iph_trigger",
Comparator(LESS_THAN, 2), 360, 360);
config->used =
EventConfig("download_home_opened", Comparator(EQUAL, 0), 90, 360);
return config;
}
if (kIPHExploreSitesTileFeature.name == feature->name) {
// A config that allows the ExploreSites IPH to be shown:
// * Once per day
// * Up to 3 times but only if unused in the last 90 days.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("explore_sites_tile_iph_trigger",
Comparator(LESS_THAN, 3), 90, 360);
config->used =
EventConfig("explore_sites_tile_tapped", Comparator(EQUAL, 0), 90, 360);
config->event_configs.insert(EventConfig("explore_sites_tile_iph_trigger",
Comparator(LESS_THAN, 1), 1, 360));
return config;
}
if (kIPHAddToHomescreenMessageFeature.name == feature->name) {
// A config that allows the Add to homescreen message IPH to be shown:
// * Once per 15 days
// * Up to 2 times but only if unused in the last 15 days.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("add_to_homescreen_message_iph_trigger",
Comparator(LESS_THAN, 2), 90, 90);
config->used = EventConfig("add_to_homescreen_dialog_shown",
Comparator(EQUAL, 0), 90, 90);
config->event_configs.insert(EventConfig(
"add_to_homescreen_message_iph_trigger", Comparator(EQUAL, 0), 15, 90));
return config;
}
if (kIPHAddToHomescreenTextBubbleFeature.name == feature->name) {
// A config that allows the Add to homescreen text bubble IPH to be shown:
// * Once per 15 days
// * Up to 2 times but only if unused in the last 15 days.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("add_to_homescreen_text_bubble_iph_trigger",
Comparator(LESS_THAN, 2), 90, 90);
config->used = EventConfig("add_to_homescreen_dialog_shown",
Comparator(EQUAL, 0), 90, 90);
config->event_configs.insert(
EventConfig("add_to_homescreen_text_bubble_iph_trigger",
Comparator(EQUAL, 0), 15, 90));
return config;
}
if (kIPHFeedHeaderMenuFeature.name == feature->name) {
// A config that allows the feed header menu IPH to be shown only once when
// the user starts using a version of the feed that uploads click and view
// actions.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
SessionRateImpact session_rate_impact;
session_rate_impact.type = SessionRateImpact::Type::NONE;
config->session_rate_impact = session_rate_impact;
// Keep the IPH trigger event for 10 years, which is a relatively long time
// period that we could consider as being "forever".
config->trigger =
EventConfig("iph_feed_header_menu_triggered", Comparator(LESS_THAN, 1),
k10YearsInDays, k10YearsInDays);
// Set a dummy config for the used event to be consistent with the other
// IPH configurations. The used event is never recorded by the feature code
// because the trigger event is already reported the first time the feed is
// being used, which corresponds to a used event.
config->used =
EventConfig("iph_feed_header_menu_used", Comparator(EQUAL, 0),
k10YearsInDays, k10YearsInDays);
return config;
}
if (kIPHFeedSwipeRefresh.name == feature->name) {
// A config that allows the feed swipe refresh message IPH to be shown:
// * Once per 15 days
// * Up to 2 times but only if unused in the last 15 days.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(EQUAL, 0);
config->trigger = EventConfig("feed_swipe_refresh_iph_trigger",
Comparator(LESS_THAN, 2), 90, 90);
config->used =
EventConfig("feed_swipe_refresh_shown", Comparator(EQUAL, 0), 90, 90);
config->event_configs.insert(EventConfig("feed_swipe_refresh_iph_trigger",
Comparator(EQUAL, 0), 15, 90));
return config;
}
if (kIPHTabSwitcherButtonFeature.name == feature->name) {
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(GREATER_THAN_OR_EQUAL, 14);
config->session_rate = Comparator(LESS_THAN, 1);
config->trigger =
EventConfig("tab_switcher_iph_triggered", Comparator(EQUAL, 0), 90, 90);
config->used = EventConfig("tab_switcher_button_clicked",
Comparator(EQUAL, 0), 14, 90);
return config;
}
if (kIPHWebFeedFollowFeature.name == feature->name) {
// A config that allows the WebFeed follow intro to be shown up to 5x per
// week.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
config->trigger = EventConfig("web_feed_follow_intro_trigger",
Comparator(LESS_THAN, 5), 7, 360);
config->used = EventConfig("web_feed_follow_intro_clicked",
Comparator(ANY, 0), 360, 360);
return config;
}
if (kIPHWebFeedPostFollowDialogFeature.name == feature->name) {
// A config that allows one of the WebFeed post follow dialogs to be
// presented 3 times.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
config->trigger = EventConfig("web_feed_post_follow_dialog_trigger",
Comparator(LESS_THAN, 3), 360, 360);
config->used = EventConfig("web_feed_post_follow_dialog_shown",
Comparator(ANY, 0), 360, 360);
return config;
}
if (kIPHStartSurfaceTabSwitcherHomeButton.name == feature->name) {
// A config that allows the StartSurfaceTabSwitcherHomeButton IPH to be
// shown:
// * Once per day
// * Up to 7 times but only if the home button is not clicked when IPH is
// showing.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = true;
config->availability = Comparator(ANY, 0);
config->session_rate = Comparator(ANY, 0);
config->trigger =
EventConfig("start_surface_tab_switcher_home_button_iph_trigger",
Comparator(LESS_THAN, 7), k10YearsInDays, k10YearsInDays);
config->used =
EventConfig("start_surface_tab_switcher_home_button_clicked",
Comparator(EQUAL, 0), k10YearsInDays, k10YearsInDays);
config->event_configs.insert(
EventConfig("start_surface_tab_switcher_home_button_iph_trigger",
Comparator(EQUAL, 0), 1, 360));
return config;
}
#endif // defined(OS_ANDROID)
if (kIPHDummyFeature.name == feature->name) {
// Only used for tests. Various magic tricks are used below to ensure this
// config is invalid and unusable.
absl::optional<FeatureConfig> config = FeatureConfig();
config->valid = false;
config->availability = Comparator(LESS_THAN, 0);
config->session_rate = Comparator(LESS_THAN, 0);
config->trigger = EventConfig("dummy_feature_iph_trigger",
Comparator(LESS_THAN, 0), 1, 1);
config->used =
EventConfig("dummy_feature_action", Comparator(LESS_THAN, 0), 1, 1);
return config;
}
return absl::nullopt;
}
} // namespace feature_engagement
|
