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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
content / browser / service_worker / service_worker_context_core_unittest.cc [blame]
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/service_worker/service_worker_context_core.h"
#include <memory>
#include "base/containers/contains.h"
#include "base/functional/callback_helpers.h"
#include "base/test/bind.h"
#include "content/browser/service_worker/embedded_worker_test_helper.h"
#include "content/browser/service_worker/service_worker_client.h"
#include "content/browser/service_worker/service_worker_context_core_observer.h"
#include "content/browser/service_worker/service_worker_context_wrapper.h"
#include "content/browser/service_worker/service_worker_registration.h"
#include "content/browser/service_worker/service_worker_test_utils.h"
#include "content/browser/service_worker/service_worker_version.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/test_utils.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"
#include "third_party/blink/public/mojom/service_worker/service_worker_registration_options.mojom.h"
namespace content {
class ServiceWorkerContextCoreTest : public testing::Test,
public ServiceWorkerContextCoreObserver {
public:
ServiceWorkerContextCoreTest()
: task_environment_(BrowserTaskEnvironment::IO_MAINLOOP) {}
ServiceWorkerContextCoreTest(const ServiceWorkerContextCoreTest&) = delete;
ServiceWorkerContextCoreTest& operator=(const ServiceWorkerContextCoreTest&) =
delete;
void SetUp() override {
helper_ = std::make_unique<EmbeddedWorkerTestHelper>(base::FilePath());
}
void TearDown() override {
if (is_observing_context_) {
helper_->context_wrapper()->RemoveObserver(this);
helper_.reset();
}
}
ServiceWorkerContextCore* context() { return helper_->context(); }
// Runs until |registration| has an active version and it is activated.
void RunUntilActivatedVersion(ServiceWorkerRegistration* registration) {
if (registration->active_version() &&
registration->active_version()->status() ==
ServiceWorkerVersion::ACTIVATED)
return;
if (!is_observing_context_) {
helper_->context_wrapper()->AddObserver(this);
is_observing_context_ = true;
}
base::RunLoop loop;
scope_for_wait_for_activated_ = registration->scope();
quit_closure_for_wait_for_activated_ = loop.QuitClosure();
loop.Run();
}
// Registers `script` and waits for the service worker to become activated.
void RegisterServiceWorker(
const GURL& script,
const blink::StorageKey& key,
blink::mojom::ServiceWorkerRegistrationOptions options,
scoped_refptr<ServiceWorkerRegistration>* result) {
base::RunLoop loop;
blink::ServiceWorkerStatusCode status;
int64_t registration_id;
context()->RegisterServiceWorker(
script, key, options, blink::mojom::FetchClientSettingsObject::New(),
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status,
const std::string& /* status_message */,
int64_t result_registration_id) {
status = result_status;
registration_id = result_registration_id;
loop.Quit();
}),
/*requesting_frame_id=*/GlobalRenderFrameHostId(),
PolicyContainerPolicies());
loop.Run();
EXPECT_EQ(blink::ServiceWorkerStatusCode::kOk, status);
scoped_refptr<ServiceWorkerRegistration> registration =
context()->GetLiveRegistration(registration_id);
ASSERT_TRUE(registration);
RunUntilActivatedVersion(registration.get());
EXPECT_TRUE(registration->active_version());
*result = registration;
}
// Wrapper for ServiceWorkerRegistry::FindRegistrationForScope.
blink::ServiceWorkerStatusCode FindRegistrationForScope(
const GURL& scope,
const blink::StorageKey& key) {
base::RunLoop loop;
blink::ServiceWorkerStatusCode status;
context()->registry()->FindRegistrationForScope(
scope, key,
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status,
scoped_refptr<ServiceWorkerRegistration> result_registration) {
status = result_status;
loop.Quit();
}));
loop.Run();
return status;
}
// Wrapper for ServiceWorkerContextCore::UnregisterServiceWorker.
blink::ServiceWorkerStatusCode Unregister(const GURL& scope,
const blink::StorageKey& key) {
base::RunLoop loop;
blink::ServiceWorkerStatusCode status;
context()->UnregisterServiceWorker(
scope, key, /*is_immediate=*/false,
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status) {
status = result_status;
loop.Quit();
}));
loop.Run();
return status;
}
// Wrapper for ServiceWorkerContextCore::DeleteForStorageKey.
blink::ServiceWorkerStatusCode DeleteForStorageKey(
const blink::StorageKey& key) {
blink::ServiceWorkerStatusCode status;
base::RunLoop loop;
context()->DeleteForStorageKey(
key, base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status) {
status = result_status;
loop.Quit();
}));
loop.Run();
return status;
}
ServiceWorkerClient* CreateControllee() {
ScopedServiceWorkerClient service_worker_client =
CreateServiceWorkerClient(helper_->context());
ServiceWorkerClient* service_worker_client_ptr =
service_worker_client.get();
service_worker_client_keep_alive_.push_back(
std::move(service_worker_client));
return service_worker_client_ptr;
}
protected:
// ServiceWorkerContextCoreObserver overrides:
void OnVersionStateChanged(int64_t version_id,
const GURL& scope,
const blink::StorageKey& key,
ServiceWorkerVersion::Status status) override {
if (status == ServiceWorkerVersion::ACTIVATED &&
scope == scope_for_wait_for_activated_ &&
quit_closure_for_wait_for_activated_) {
std::move(quit_closure_for_wait_for_activated_).Run();
}
}
private:
BrowserTaskEnvironment task_environment_;
std::unique_ptr<EmbeddedWorkerTestHelper> helper_;
std::vector<ScopedServiceWorkerClient> service_worker_client_keep_alive_;
GURL scope_for_wait_for_activated_;
base::OnceClosure quit_closure_for_wait_for_activated_;
bool is_observing_context_ = false;
};
TEST_F(ServiceWorkerContextCoreTest, FailureInfo) {
const int64_t kVersionId = 55; // dummy value
EXPECT_EQ(0, context()->GetVersionFailureCount(kVersionId));
context()->UpdateVersionFailureCount(kVersionId,
blink::ServiceWorkerStatusCode::kOk);
context()->UpdateVersionFailureCount(
kVersionId, blink::ServiceWorkerStatusCode::kErrorDisallowed);
EXPECT_EQ(0, context()->GetVersionFailureCount(kVersionId));
context()->UpdateVersionFailureCount(
kVersionId, blink::ServiceWorkerStatusCode::kErrorNetwork);
EXPECT_EQ(1, context()->GetVersionFailureCount(kVersionId));
EXPECT_EQ(blink::ServiceWorkerStatusCode::kErrorNetwork,
context()->failure_counts_[kVersionId].last_failure);
context()->UpdateVersionFailureCount(
kVersionId, blink::ServiceWorkerStatusCode::kErrorAbort);
EXPECT_EQ(2, context()->GetVersionFailureCount(kVersionId));
EXPECT_EQ(blink::ServiceWorkerStatusCode::kErrorAbort,
context()->failure_counts_[kVersionId].last_failure);
context()->UpdateVersionFailureCount(kVersionId,
blink::ServiceWorkerStatusCode::kOk);
EXPECT_EQ(0, context()->GetVersionFailureCount(kVersionId));
EXPECT_FALSE(base::Contains(context()->failure_counts_, kVersionId));
}
TEST_F(ServiceWorkerContextCoreTest, DeleteForStorageKey) {
const GURL script("https://www.example.com/a/sw.js");
const GURL scope("https://www.example.com/a");
const url::Origin origin = url::Origin::Create(scope);
const blink::StorageKey key = blink::StorageKey::CreateFirstParty(origin);
// Register a service worker.
blink::mojom::ServiceWorkerRegistrationOptions options;
options.scope = scope;
scoped_refptr<ServiceWorkerRegistration> registration;
RegisterServiceWorker(scope, key, options, ®istration);
// Delete for key.
EXPECT_EQ(blink::ServiceWorkerStatusCode::kOk, DeleteForStorageKey(key));
// The registration should be deleted.
EXPECT_EQ(blink::ServiceWorkerStatusCode::kErrorNotFound,
FindRegistrationForScope(scope, key));
}
TEST_F(ServiceWorkerContextCoreTest, DeleteForStorageKeyAbortsQueuedJobs) {
const GURL script("https://www.example.com/a/sw.js");
const GURL scope("https://www.example.com/a");
const url::Origin origin = url::Origin::Create(scope);
const blink::StorageKey key = blink::StorageKey::CreateFirstParty(origin);
// Register a service worker.
blink::mojom::ServiceWorkerRegistrationOptions options;
options.scope = scope;
scoped_refptr<ServiceWorkerRegistration> registration;
RegisterServiceWorker(scope, key, options, ®istration);
// Queue a register job.
base::RunLoop register_job_loop;
blink::ServiceWorkerStatusCode register_job_status;
context()->RegisterServiceWorker(
script, key, options, blink::mojom::FetchClientSettingsObject::New(),
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status,
const std::string& /* status_message */,
int64_t result_registration_id) {
register_job_status = result_status;
register_job_loop.Quit();
}),
/*requesting_frame_id=*/GlobalRenderFrameHostId(),
PolicyContainerPolicies());
EXPECT_EQ(blink::ServiceWorkerStatusCode::kOk, DeleteForStorageKey(key));
// DeleteForStorageKey must abort pending jobs.
register_job_loop.Run();
EXPECT_EQ(blink::ServiceWorkerStatusCode::kErrorAbort, register_job_status);
}
TEST_F(ServiceWorkerContextCoreTest,
DeleteUninstallingForOriginAbortsQueuedJobs) {
const GURL script("https://www.example.com/a/sw.js");
const GURL scope("https://www.example.com/a");
const url::Origin origin = url::Origin::Create(scope);
const blink::StorageKey key = blink::StorageKey::CreateFirstParty(origin);
// Register a service worker.
blink::mojom::ServiceWorkerRegistrationOptions options;
options.scope = scope;
scoped_refptr<ServiceWorkerRegistration> registration;
RegisterServiceWorker(scope, key, options, ®istration);
// Add a controlled client.
ServiceWorkerClient* service_worker_client = CreateControllee();
service_worker_client->UpdateUrls(scope, origin, key);
service_worker_client->SetControllerRegistration(
registration,
/*notify_controllerchange=*/false);
// Unregister, which will wait to clear until the controlled client unloads.
EXPECT_EQ(blink::ServiceWorkerStatusCode::kOk, Unregister(scope, key));
// Queue an Update job.
context()->UpdateServiceWorkerWithoutExecutionContext(
registration.get(),
/*force_bypass_cache=*/false);
// Queue a register job.
base::RunLoop register_job_loop;
blink::ServiceWorkerStatusCode register_job_status;
context()->RegisterServiceWorker(
script, key, options, blink::mojom::FetchClientSettingsObject::New(),
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status,
const std::string& /* status_message */,
int64_t result_registration_id) {
register_job_status = result_status;
register_job_loop.Quit();
}),
/*requesting_frame_id=*/GlobalRenderFrameHostId(),
PolicyContainerPolicies());
EXPECT_EQ(blink::ServiceWorkerStatusCode::kOk, DeleteForStorageKey(key));
// DeleteForStorageKey must abort pending jobs.
register_job_loop.Run();
EXPECT_EQ(blink::ServiceWorkerStatusCode::kErrorAbort, register_job_status);
}
// Tests that DeleteForStorageKey() doesn't get stuck forever even upon an error
// when trying to unregister.
TEST_F(ServiceWorkerContextCoreTest, DeleteForStorageKey_UnregisterFail) {
const GURL script("https://www.example.com/a/sw.js");
const GURL scope("https://www.example.com/a");
const url::Origin origin = url::Origin::Create(scope);
const blink::StorageKey key = blink::StorageKey::CreateFirstParty(origin);
// Register a service worker.
blink::mojom::ServiceWorkerRegistrationOptions options;
options.scope = scope;
scoped_refptr<ServiceWorkerRegistration> registration;
RegisterServiceWorker(scope, key, options, ®istration);
// Start DeleteForStorageKey().
base::RunLoop loop;
blink::ServiceWorkerStatusCode status;
context()->DeleteForStorageKey(
key, base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status) {
status = result_status;
loop.Quit();
}));
// Disable storage before it finishes. This causes the Unregister job to
// complete with an error.
context()->registry()->DisableStorageForTesting(base::DoNothing());
loop.Run();
// The operation should still complete.
EXPECT_EQ(blink::ServiceWorkerStatusCode::kErrorFailed, status);
}
} // namespace content