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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/webapps/browser/banners/app_banner_settings_helper.h"
#include "base/auto_reset.h"
#include "base/time/time.h"
#include "components/permissions/test/test_permissions_client.h"
#include "components/prefs/testing_pref_service.h"
#include "components/site_engagement/content/site_engagement_service.h"
#include "components/user_prefs/user_prefs.h"
#include "components/webapps/browser/banners/app_banner_metrics.h"
#include "content/public/browser/browser_context.h"
#include "content/public/test/test_renderer_host.h"
namespace webapps {
namespace {
const char kTestURL[] = "https://www.google.com";
const char kSameOriginTestURL[] = "https://www.google.com/foo.html";
const char kSameOriginTestURL1[] = "https://www.google.com/foo1.html";
const char kSameOriginTestURL2[] = "https://www.google.com/foo2.html";
const char kTestPackageName[] = "test.package";
base::Time GetReferenceTime() {
static constexpr base::Time::Exploded kReferenceTime = {.year = 2015,
.month = 1,
.day_of_week = 5,
.day_of_month = 30,
.hour = 11};
base::Time out_time;
EXPECT_TRUE(base::Time::FromLocalExploded(kReferenceTime, &out_time));
return out_time;
}
class AppBannerSettingsHelperTest
: public content::RenderViewHostTestHarness,
public site_engagement::SiteEngagementService::ServiceProvider {
void SetUp() override {
content::RenderViewHostTestHarness::SetUp();
user_prefs::UserPrefs::Set(browser_context(), &prefs_);
site_engagement_service_ =
std::make_unique<site_engagement::SiteEngagementService>(
browser_context());
site_engagement::SiteEngagementService::RegisterProfilePrefs(
prefs_.registry());
site_engagement::SiteEngagementService::SetServiceProvider(this);
}
void TearDown() override {
site_engagement::SiteEngagementService::ClearServiceProvider(this);
content::RenderViewHostTestHarness::TearDown();
}
// site_engagement::SiteEngagementService::ServiceProvider:
site_engagement::SiteEngagementService* GetSiteEngagementService(
content::BrowserContext* browser_context) override {
return site_engagement_service_.get();
}
private:
TestingPrefServiceSimple prefs_;
permissions::TestPermissionsClient permissions_client_;
std::unique_ptr<site_engagement::SiteEngagementService>
site_engagement_service_;
};
} // namespace
TEST_F(AppBannerSettingsHelperTest, SingleEvents) {
GURL url(kTestURL);
NavigateAndCommit(url);
base::Time reference_time = GetReferenceTime();
base::Time other_time = reference_time - base::Days(3);
for (int event = AppBannerSettingsHelper::APP_BANNER_EVENT_COULD_SHOW;
event < AppBannerSettingsHelper::APP_BANNER_EVENT_NUM_EVENTS; ++event) {
// Check that by default, there is no event.
absl::optional<base::Time> event_time =
AppBannerSettingsHelper::GetSingleBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::AppBannerEvent(event));
EXPECT_TRUE(event_time && event_time->is_null());
// Check that a time can be recorded.
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::AppBannerEvent(event), reference_time);
event_time = AppBannerSettingsHelper::GetSingleBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::AppBannerEvent(event));
EXPECT_EQ(reference_time, *event_time);
// Check that another time can be recorded.
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::AppBannerEvent(event), other_time);
event_time = AppBannerSettingsHelper::GetSingleBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::AppBannerEvent(event));
// COULD_SHOW events are not overwritten, but other events are.
if (event == AppBannerSettingsHelper::APP_BANNER_EVENT_COULD_SHOW)
EXPECT_EQ(reference_time, *event_time);
else
EXPECT_EQ(other_time, *event_time);
}
}
TEST_F(AppBannerSettingsHelperTest, ShouldShowFromEngagement) {
GURL url(kTestURL);
site_engagement::SiteEngagementService* service =
site_engagement::SiteEngagementService::Get(browser_context());
// By default the banner should not be shown.
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
// Add 1 engagement, it still should not be shown.
service->ResetBaseScoreForURL(url, 1);
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
// Add 1 more engagement; now it should be shown.
service->ResetBaseScoreForURL(url, 2);
EXPECT_TRUE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
}
TEST_F(AppBannerSettingsHelperTest, ReportsWhetherBannerWasRecentlyBlocked) {
GURL url(kTestURL);
NavigateAndCommit(url);
base::Time reference_time = GetReferenceTime();
base::Time two_months_ago = reference_time - base::Days(60);
base::Time one_year_ago = reference_time - base::Days(366);
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), url, kTestPackageName, reference_time));
// Block the site a long time ago. This should not be considered "recent".
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_BLOCK, one_year_ago);
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), url, kTestPackageName, reference_time));
// Block the site more recently.
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_BLOCK, two_months_ago);
EXPECT_TRUE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), url, kTestPackageName, reference_time));
// Change the number of days enforced.
AppBannerSettingsHelper::ScopedTriggerSettings trigger_settings(59, 14);
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), url, kTestPackageName, reference_time));
}
TEST_F(AppBannerSettingsHelperTest, ReportsWhetherBannerWasRecentlyIgnored) {
GURL url(kTestURL);
NavigateAndCommit(url);
base::Time reference_time = GetReferenceTime();
base::Time one_week_ago = reference_time - base::Days(6);
base::Time one_year_ago = reference_time - base::Days(366);
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyIgnored(
web_contents(), url, kTestPackageName, reference_time));
// Show the banner a long time ago. This should not be considered "recent".
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_year_ago);
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyIgnored(
web_contents(), url, kTestPackageName, reference_time));
// Show the site more recently.
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_week_ago);
EXPECT_TRUE(AppBannerSettingsHelper::WasBannerRecentlyIgnored(
web_contents(), url, kTestPackageName, reference_time));
// Change the number of days enforced.
AppBannerSettingsHelper::ScopedTriggerSettings trigger_settings(90, 5);
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyIgnored(
web_contents(), url, kTestPackageName, reference_time));
}
TEST_F(AppBannerSettingsHelperTest, OperatesOnOrigins) {
GURL url(kTestURL);
GURL otherURL(kSameOriginTestURL);
site_engagement::SiteEngagementService* service =
site_engagement::SiteEngagementService::Get(browser_context());
// By default the banner should not be shown.
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
// Add engagement such that the banner should show.
service->ResetBaseScoreForURL(url, 4);
EXPECT_TRUE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
// The banner should show as settings are per-origin.
EXPECT_TRUE(AppBannerSettingsHelper::HasSufficientEngagement(
service->GetScore(otherURL)));
base::Time reference_time = GetReferenceTime();
base::Time one_week_ago = reference_time - base::Days(5);
// If url is blocked, otherURL will also be reported as blocked.
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), otherURL, kTestPackageName, reference_time));
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_BLOCK, one_week_ago);
EXPECT_TRUE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), otherURL, kTestPackageName, reference_time));
// If url is ignored, otherURL will also be reported as ignored.
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyIgnored(
web_contents(), otherURL, kTestPackageName, reference_time));
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, kTestPackageName,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_week_ago);
EXPECT_TRUE(AppBannerSettingsHelper::WasBannerRecentlyIgnored(
web_contents(), otherURL, kTestPackageName, reference_time));
}
TEST_F(AppBannerSettingsHelperTest, ShouldShowWithHigherTotal) {
base::AutoReset<double> total_engagement =
AppBannerSettingsHelper::ScopeTotalEngagementForTesting(10);
GURL url(kTestURL);
site_engagement::SiteEngagementService* service =
site_engagement::SiteEngagementService::Get(browser_context());
// By default the banner should not be shown.
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
// Add engagement such that the banner should show.
service->ResetBaseScoreForURL(url, 2);
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
service->ResetBaseScoreForURL(url, 4);
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
service->ResetBaseScoreForURL(url, 6);
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
service->ResetBaseScoreForURL(url, 8);
EXPECT_FALSE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
service->ResetBaseScoreForURL(url, 10);
EXPECT_TRUE(
AppBannerSettingsHelper::HasSufficientEngagement(service->GetScore(url)));
}
TEST_F(AppBannerSettingsHelperTest, NulloptSingleBannerEvent) {
GURL url(kTestURL);
std::string url_same_origin1(kSameOriginTestURL);
std::string url_same_origin2(kSameOriginTestURL1);
std::string url_same_origin3(kSameOriginTestURL2);
NavigateAndCommit(url);
base::Time reference_time = GetReferenceTime();
base::Time one_day_ago = reference_time - base::Days(1);
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, url.spec(),
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_day_ago);
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, url_same_origin1,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_day_ago);
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, url_same_origin2,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_day_ago);
absl::optional<base::Time> event_time =
AppBannerSettingsHelper::GetSingleBannerEvent(
web_contents(), url, url_same_origin2,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW);
EXPECT_TRUE(event_time.has_value());
EXPECT_FALSE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), url, url_same_origin2, reference_time));
AppBannerSettingsHelper::RecordBannerEvent(
web_contents(), url, url_same_origin3,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW, one_day_ago);
event_time = AppBannerSettingsHelper::GetSingleBannerEvent(
web_contents(), url, url_same_origin3,
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_SHOW);
// if exceed kMaxAppsPerSite 3, we will ge nullopt
EXPECT_FALSE(event_time.has_value());
EXPECT_TRUE(AppBannerSettingsHelper::WasBannerRecentlyBlocked(
web_contents(), url, url_same_origin3, reference_time));
}
} // namespace webapps
|
