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
313
314
315
316
317
318
319
320
321
|
// 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 "base/strings/stringprintf.h"
#include "base/test/simple_test_clock.h"
#include "base/time/time.h"
#include "content/browser/background_sync/background_sync_base_browsertest.h"
#include "content/browser/background_sync/background_sync_manager.h"
#include "content/public/common/content_features.h"
#include "content/public/test/background_sync_test_util.h"
#include "content/public/test/browser_test.h"
namespace {
constexpr base::TimeDelta kMinGapBetweenPeriodicSyncEvents = base::Seconds(5);
} // namespace
namespace content {
class PeriodicBackgroundSyncBrowserTest : public BackgroundSyncBaseBrowserTest {
public:
PeriodicBackgroundSyncBrowserTest() {}
PeriodicBackgroundSyncBrowserTest(const PeriodicBackgroundSyncBrowserTest&) =
delete;
PeriodicBackgroundSyncBrowserTest& operator=(
const PeriodicBackgroundSyncBrowserTest&) = delete;
~PeriodicBackgroundSyncBrowserTest() override {}
bool Register(const std::string& tag, int min_interval_ms);
bool RegisterFromIFrame(const std::string& tag, int min_interval_ms);
bool RegisterNoMinInterval(const std::string& tag);
bool RegisterFromServiceWorker(const std::string& tag, int min_interval_ms);
std::string RegisterFromCrossOriginFrame(const std::string& frame_url);
bool RegisterFromServiceWorkerNoMinInterval(const std::string& tag);
bool HasTag(const std::string& tag);
bool HasTagFromServiceWorker(const std::string& tag);
bool Unregister(const std::string& tag);
bool UnregisterFromServiceWorker(const std::string& tag);
int GetNumPeriodicSyncEvents();
protected:
base::SimpleTestClock clock_;
};
bool PeriodicBackgroundSyncBrowserTest::Register(const std::string& tag,
int min_interval_ms) {
std::string script_result = RunScript(base::StringPrintf(
"%s('%s', %d);", "registerPeriodicSync", tag.c_str(), min_interval_ms));
return script_result == BuildExpectedResult(tag, "registered");
}
bool PeriodicBackgroundSyncBrowserTest::RegisterFromIFrame(
const std::string& tag,
int min_interval_ms) {
std::string script_result = RunScript(
base::StringPrintf("%s('%s', %d);", "registerPeriodicSyncFromIFrame",
tag.c_str(), min_interval_ms));
return script_result == BuildExpectedResult(tag, "registered");
}
std::string PeriodicBackgroundSyncBrowserTest::RegisterFromCrossOriginFrame(
const std::string& frame_url) {
// Start a second https server to use as a second origin.
net::EmbeddedTestServer alt_server(net::EmbeddedTestServer::TYPE_HTTPS);
alt_server.ServeFilesFromSourceDirectory(GetTestDataFilePath());
EXPECT_TRUE(alt_server.Start());
GURL url = alt_server.GetURL(frame_url);
return RunScript(BuildScriptString("registerPeriodicSyncFromCrossOriginFrame",
url.spec()));
}
bool PeriodicBackgroundSyncBrowserTest::RegisterNoMinInterval(
const std::string& tag) {
std::string script_result = RunScript(
base::StringPrintf("%s('%s');", "registerPeriodicSync", tag.c_str()));
return script_result == BuildExpectedResult(tag, "registered");
}
bool PeriodicBackgroundSyncBrowserTest::RegisterFromServiceWorker(
const std::string& tag,
int min_interval_ms) {
std::string script_result = RunScript(base::StringPrintf(
"%s('%s', %d);", "registerPeriodicSyncFromServiceWorker", tag.c_str(),
min_interval_ms));
return script_result == BuildExpectedResult(tag, "register sent to SW");
}
bool PeriodicBackgroundSyncBrowserTest::RegisterFromServiceWorkerNoMinInterval(
const std::string& tag) {
std::string script_result = RunScript(
BuildScriptString("registerPeriodicSyncFromServiceWorker", tag));
return script_result == BuildExpectedResult(tag, "register sent to SW");
}
bool PeriodicBackgroundSyncBrowserTest::HasTag(const std::string& tag) {
std::string script_result =
RunScript(BuildScriptString("hasPeriodicSyncTag", tag));
return script_result == BuildExpectedResult(tag, "found");
}
bool PeriodicBackgroundSyncBrowserTest::HasTagFromServiceWorker(
const std::string& tag) {
std::string script_result =
RunScript(BuildScriptString("hasPeriodicSyncTagFromServiceWorker", tag));
return (script_result == "ok - hasTag sent to SW");
}
bool PeriodicBackgroundSyncBrowserTest::Unregister(const std::string& tag) {
std::string script_result = RunScript(BuildScriptString("unregister", tag));
return script_result == BuildExpectedResult(tag, "unregistered");
}
bool PeriodicBackgroundSyncBrowserTest::UnregisterFromServiceWorker(
const std::string& tag) {
std::string script_result =
RunScript(BuildScriptString("unregisterFromServiceWorker", tag));
return script_result == BuildExpectedResult(tag, "unregister sent to SW");
}
int PeriodicBackgroundSyncBrowserTest::GetNumPeriodicSyncEvents() {
std::string script_result = RunScript("getNumPeriodicSyncEvents()");
int num_periodic_sync_events = -1;
bool converted =
base::StringToInt(PopConsoleString(), &num_periodic_sync_events);
DCHECK(converted);
return num_periodic_sync_events;
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
RegisterFromControlledDocument) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL)); // Control the page.
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 1000));
EXPECT_TRUE(Unregister("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
RegisterNoMinInterval) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(RegisterNoMinInterval("foo"));
EXPECT_TRUE(Unregister("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
RegisterFromIFrameWithTopLevelFrameForOrigin) {
GURL url = https_server()->GetURL(kEmptyURL);
std::string script_result = RunScript(
BuildScriptString("registerPeriodicSyncFromLocalFrame", url.spec()));
// This succeeds because there's a top level frame for the origin.
EXPECT_EQ(BuildExpectedResult("iframe", "registered periodicSync"),
script_result);
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
RegisterFromIFrameWithoutTopLevelFrameForOrigin) {
std::string script_result =
RegisterFromCrossOriginFrame(kRegisterPeriodicSyncFromIFrameURL);
// This fails because there's no top level frame open for the origin.
EXPECT_EQ(BuildExpectedResult("frame", "failed to register periodicSync"),
script_result);
}
// Verify that Register works in a service worker
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
RegisterFromServiceWorker) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
EXPECT_TRUE(RegisterFromServiceWorker("foo_sw", /* min_interval_ms= */ 10));
EXPECT_TRUE(PopConsole("ok - foo_sw registered in SW"));
EXPECT_TRUE(Unregister("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
RegisterFromServiceWorkerNoMinInterval) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
EXPECT_TRUE(RegisterFromServiceWorkerNoMinInterval("foo_sw"));
EXPECT_TRUE(PopConsole("ok - foo_sw registered in SW"));
EXPECT_TRUE(Unregister("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest, FindATag) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL)); // Control the page.
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 1000));
EXPECT_TRUE(HasTag("foo"));
EXPECT_TRUE(Unregister("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
FindATagFromServiceWorker) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL)); // Control the page.
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 1000));
EXPECT_TRUE(HasTagFromServiceWorker("foo"));
EXPECT_TRUE(PopConsole("ok - foo found in SW"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
UnregisterFromServiceWorker) {
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
EXPECT_TRUE(RegisterNoMinInterval("foo"));
EXPECT_TRUE(HasTag("foo"));
EXPECT_TRUE(UnregisterFromServiceWorker("foo"));
EXPECT_TRUE(PopConsole("ok - foo unregistered in SW"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
FirePeriodicSyncOnConnectivity) {
SetTestClock(&clock_);
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
// Prevent firing by going offline.
background_sync_test_util::SetOnline(web_contents(), false);
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 10));
EXPECT_TRUE(HasTag("foo"));
int initial_periodic_sync_events = GetNumPeriodicSyncEvents();
ASSERT_EQ(initial_periodic_sync_events, 0);
clock_.Advance(kMinGapBetweenPeriodicSyncEvents);
EXPECT_EQ(GetNumPeriodicSyncEvents(), initial_periodic_sync_events);
// Resume firing by going online.
background_sync_test_util::SetOnline(web_contents(), true);
EXPECT_TRUE(PopConsole("foo fired"));
EXPECT_EQ(GetNumPeriodicSyncEvents(), initial_periodic_sync_events + 1);
EXPECT_TRUE(HasTag("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest, MultipleEventsFired) {
SetTestClock(&clock_);
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 10));
clock_.Advance(kMinGapBetweenPeriodicSyncEvents);
EXPECT_TRUE(PopConsole("foo fired"));
EXPECT_TRUE(HasTag("foo"));
clock_.Advance(kMinGapBetweenPeriodicSyncEvents);
EXPECT_TRUE(PopConsole("foo fired"));
EXPECT_TRUE(HasTag("foo"));
EXPECT_TRUE(Unregister("foo"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest,
MultipleMinIntervalsAndTags) {
SetTestClock(&clock_);
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 10));
EXPECT_TRUE(Register("foo", /* min_interval_ms= */ 200));
EXPECT_TRUE(HasTag("foo"));
EXPECT_TRUE(Register("bar", /* min_interval_ms= */ 50));
EXPECT_TRUE(HasTag("bar"));
clock_.Advance(kMinGapBetweenPeriodicSyncEvents);
// Ordering is important here.
EXPECT_TRUE(PopConsole("bar fired"));
EXPECT_TRUE(PopConsole("foo fired"));
EXPECT_TRUE(Unregister("foo"));
EXPECT_FALSE(HasTag("foo"));
EXPECT_TRUE(HasTag("bar"));
clock_.Advance(kMinGapBetweenPeriodicSyncEvents);
EXPECT_TRUE(PopConsole("bar fired"));
EXPECT_TRUE(Unregister("bar"));
}
IN_PROC_BROWSER_TEST_F(PeriodicBackgroundSyncBrowserTest, WaitUntil) {
SetTestClock(&clock_);
EXPECT_TRUE(RegisterServiceWorker());
EXPECT_TRUE(LoadTestPage(kDefaultTestURL));
background_sync_test_util::SetOnline(web_contents(), false);
EXPECT_TRUE(Register("delay", /* min_interval_ms= */ 10));
ASSERT_TRUE(HasTag("delay"));
clock_.Advance(kMinGapBetweenPeriodicSyncEvents);
background_sync_test_util::SetOnline(web_contents(), true);
base::RunLoop().RunUntilIdle();
int num_periodicsync_events_fired = GetNumPeriodicSyncEvents();
// Complete the task.
EXPECT_TRUE(CompleteDelayedSyncEvent());
EXPECT_TRUE(PopConsole("ok - delay completed"));
EXPECT_EQ(GetNumPeriodicSyncEvents(), num_periodicsync_events_fired + 1);
EXPECT_TRUE(HasTag("delay"));
EXPECT_TRUE(Unregister("delay"));
}
} // namespace content
|
